Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

cfg80211: Add kdoc for struct regulatory_request

As regulatory_request gets bigger there will be more questions
of what things means, so clarify documenation for it and
keep track of the special alpha2 codes we use internally
and on the userspace regulatory agents.

Signed-off-by: Luis R. Rodriguez <lrodriguez@atheros.com>
Signed-off-by: John W. Linville <linville@tuxdriver.com>

authored by

Luis R. Rodriguez and committed by
John W. Linville
5166ccd2 b219cee1

+19 -3
+19 -3
net/wireless/reg.c
··· 42 42 #include "core.h" 43 43 #include "reg.h" 44 44 45 - /* 46 - * wiphy is set if this request's initiator is 47 - * REGDOM_SET_BY_COUNTRY_IE or _DRIVER 45 + /** 46 + * struct regulatory_request - receipt of last regulatory request 47 + * 48 + * @wiphy: this is set if this request's initiator is 49 + * %REGDOM_SET_BY_COUNTRY_IE or %REGDOM_SET_BY_DRIVER. This 50 + * can be used by the wireless core to deal with conflicts 51 + * and potentially inform users of which devices specifically 52 + * cased the conflicts. 53 + * @initiator: indicates who sent this request, could be any of 54 + * of those set in reg_set_by, %REGDOM_SET_BY_* 55 + * @alpha2: the ISO / IEC 3166 alpha2 country code of the requested 56 + * regulatory domain. We have a few special codes: 57 + * 00 - World regulatory domain 58 + * 99 - built by driver but a specific alpha2 cannot be determined 59 + * 98 - result of an intersection between two regulatory domains 60 + * @intersect: indicates whether the wireless core should intersect 61 + * the requested regulatory domain with the presently set regulatory 62 + * domain. 48 63 */ 49 64 struct regulatory_request { 50 65 struct wiphy *wiphy; ··· 68 53 bool intersect; 69 54 }; 70 55 56 + /* Receipt of information from last regulatory request */ 71 57 static struct regulatory_request *last_request; 72 58 73 59 /* To trigger userspace events */