Commit 87cd646f authored by Johannes Berg's avatar Johannes Berg
Browse files

wifi: cfg80211: reg: describe return values in kernel-doc 



Describe the function return values in kernel-doc.

Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
Signed-off-by: default avatarGregory Greenman <gregory.greenman@intel.com>
Link: https://lore.kernel.org/r/20230920211508.8b1e45c8bab8.I6dbae4f6dfe8f5352bc44565cc5131e73dd1873f@changeid


Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
parent e865c827

net/wireless/reg.c

+13 −3
Original line number Diff line number Diff line
@@ -1283,7 +1283,9 @@ static bool is_valid_rd(const struct ieee80211_regdomain *rd) 
 * 60 GHz band.

 * This resolution can be lowered and should be considered as we add

 * regulatory rule support for other "bands".

 **/

 *

 * Returns: whether or not the frequency is in the range

 */

static bool freq_in_rule_band(const struct ieee80211_freq_range *freq_range,

			      u32 freq_khz)

{
@@ -1492,6 +1494,8 @@ static void add_rule(struct ieee80211_reg_rule *rule, 
 * Returns a pointer to the regulatory domain structure which will hold the

 * resulting intersection of rules between rd1 and rd2. We will

 * kzalloc() this structure for you.

 *

 * Returns: the intersected regdomain

 */

static struct ieee80211_regdomain *

regdom_intersect(const struct ieee80211_regdomain *rd1,
@@ -2673,6 +2677,9 @@ static void reg_set_request_processed(void) 
 *

 * The wireless subsystem can use this function to process

 * a regulatory request issued by the regulatory core.

 *

 * Returns: %REG_REQ_OK or %REG_REQ_IGNORE, indicating if the

 *	hint was processed or ignored

 */

static enum reg_request_treatment

reg_process_hint_core(struct regulatory_request *core_request)
@@ -2729,6 +2736,9 @@ __reg_process_hint_user(struct regulatory_request *user_request) 
 *

 * The wireless subsystem can use this function to process

 * a regulatory request initiated by userspace.

 *

 * Returns: %REG_REQ_OK or %REG_REQ_IGNORE, indicating if the

 *	hint was processed or ignored

 */

static enum reg_request_treatment

reg_process_hint_user(struct regulatory_request *user_request)
@@ -2784,7 +2794,7 @@ __reg_process_hint_driver(struct regulatory_request *driver_request) 
 * The wireless subsystem can use this function to process

 * a regulatory request issued by an 802.11 driver.

 *

 * Returns one of the different reg request treatment values.

 * Returns: one of the different reg request treatment values.

 */

static enum reg_request_treatment

reg_process_hint_driver(struct wiphy *wiphy,
@@ -2888,7 +2898,7 @@ __reg_process_hint_country_ie(struct wiphy *wiphy, 
 * The wireless subsystem can use this function to process

 * a regulatory request issued by a country Information Element.

 *

 * Returns one of the different reg request treatment values.

 * Returns: one of the different reg request treatment values.

 */

static enum reg_request_treatment

reg_process_hint_country_ie(struct wiphy *wiphy,