History

wifi: nl80211: cleanup nl80211.h kernel-doc

Fix all of the kernel-doc issues in nl80211.h.

Jeff Johnson committed 2 years ago

Commit b8cf4f41 parent ec3a97d1 file · +40 −28Browse files

Showing the changes to include/uapi (1 of 1 file). Show all

Unified · Split

include/uapi/linux/nl80211.h+40−28
@@ -413,8 +413,8 @@ · 412 unmodified lines
413413 * are like for %NL80211_CMD_SET_BEACON, and additionally parameters that
414414 * do not change are used, these include %NL80211_ATTR_BEACON_INTERVAL,
415415 * %NL80211_ATTR_DTIM_PERIOD, %NL80211_ATTR_SSID,
416− * %NL80211_ATTR_HIDDEN_SSID, %NL80211_ATTR_CIPHERS_PAIRWISE,
417− * %NL80211_ATTR_CIPHER_GROUP, %NL80211_ATTR_WPA_VERSIONS,
416+ * %NL80211_ATTR_HIDDEN_SSID, %NL80211_ATTR_CIPHER_SUITES_PAIRWISE,
417+ * %NL80211_ATTR_CIPHER_SUITE_GROUP, %NL80211_ATTR_WPA_VERSIONS,
418418 * %NL80211_ATTR_AKM_SUITES, %NL80211_ATTR_PRIVACY,
419419 * %NL80211_ATTR_AUTH_TYPE, %NL80211_ATTR_INACTIVITY_TIMEOUT,
420420 * %NL80211_ATTR_ACL_POLICY and %NL80211_ATTR_MAC_ADDRS.
@@ -451,11 +451,6 @@ · 30 unmodified lines
451451 * %NL80211_ATTR_MAC via %NL80211_ATTR_MPATH_NEXT_HOP.
452452 * @NL80211_CMD_DEL_MPATH: Delete a mesh path to the destination given by
453453 * %NL80211_ATTR_MAC.
454− * @NL80211_CMD_NEW_PATH: Add a mesh path with given attributes to the
455− * interface identified by %NL80211_ATTR_IFINDEX.
456− * @NL80211_CMD_DEL_PATH: Remove a mesh path identified by %NL80211_ATTR_MAC
457− * or, if no MAC address given, all mesh paths, on the interface identified
458− * by %NL80211_ATTR_IFINDEX.
459454 * @NL80211_CMD_SET_BSS: Set BSS attributes for BSS identified by
460455 * %NL80211_ATTR_IFINDEX.
461456 *
@@ -1120,7 +1115,7 @@ · 658 unmodified lines
11201115 * current configuration is not changed. If it is present but
11211116 * set to zero, the configuration is changed to don't-care
11221117 * (i.e. the device can decide what to do).
1123− * @NL80211_CMD_NAN_FUNC_MATCH: Notification sent when a match is reported.
1118+ * @NL80211_CMD_NAN_MATCH: Notification sent when a match is reported.
11241119 * This will contain a %NL80211_ATTR_NAN_MATCH nested attribute and
11251120 * %NL80211_ATTR_COOKIE.
11261121 *
@@ -1862,12 +1857,6 @@ enum nl80211_commands { · 735 unmodified lines
18621857 * that protected APs should be used. This is also used with NEW_BEACON to
18631858 * indicate that the BSS is to use protection.
18641859 *
1865− * @NL80211_ATTR_CIPHERS_PAIRWISE: Used with CONNECT, ASSOCIATE, and NEW_BEACON
1866− * to indicate which unicast key ciphers will be used with the connection
1867− * (an array of u32).
1868− * @NL80211_ATTR_CIPHER_GROUP: Used with CONNECT, ASSOCIATE, and NEW_BEACON to
1869− * indicate which group key cipher will be used with the connection (a
1870− * u32).
18711860 * @NL80211_ATTR_WPA_VERSIONS: Used with CONNECT, ASSOCIATE, and NEW_BEACON to
18721861 * indicate which WPA version(s) the AP we want to associate with is using
18731862 * (a u32 with flags from &enum nl80211_wpa_versions).
@@ -1898,6 +1887,7 @@ enum nl80211_commands { · 24 unmodified lines
18981887 * with %NL80211_KEY_* sub-attributes
18991888 *
19001889 * @NL80211_ATTR_PID: Process ID of a network namespace.
1890+ * @NL80211_ATTR_NETNS_FD: File descriptor of a network namespace.
19011891 *
19021892 * @NL80211_ATTR_GENERATION: Used to indicate consistent snapshots for
19031893 * dumps. This number increases whenever the object list being
@@ -1952,6 +1942,7 @@ enum nl80211_commands { · 48 unmodified lines
19521942 *
19531943 * @NL80211_ATTR_ACK: Flag attribute indicating that the frame was
19541944 * acknowledged by the recipient.
1945+ * @NL80211_ATTR_ACK_SIGNAL: Station's ack signal strength (s32)
19551946 *
19561947 * @NL80211_ATTR_PS_STATE: powersave state, using &enum nl80211_ps_state values.
19571948 *
@@ -2149,6 +2140,9 @@ enum nl80211_commands { · 191 unmodified lines
21492140 * @NL80211_ATTR_DISABLE_HE: Force HE capable interfaces to disable
21502141 * this feature during association. This is a flag attribute.
21512142 * Currently only supported in mac80211 drivers.
2143+ * @NL80211_ATTR_DISABLE_EHT: Force EHT capable interfaces to disable
2144+ * this feature during association. This is a flag attribute.
2145+ * Currently only supported in mac80211 drivers.
21522146 * @NL80211_ATTR_HT_CAPABILITY_MASK: Specify which bits of the
21532147 * ATTR_HT_CAPABILITY to which attention should be paid.
21542148 * Currently, only mac80211 NICs support this feature.
@@ -2158,6 +2152,12 @@ enum nl80211_commands { · 3 unmodified lines
21582152 * All values are treated as suggestions and may be ignored
21592153 * by the driver as required. The actual values may be seen in
21602154 * the station debugfs ht_caps file.
2155+ * @NL80211_ATTR_VHT_CAPABILITY_MASK: Specify which bits of the
2156+ * ATTR_VHT_CAPABILITY to which attention should be paid.
2157+ * Currently, only mac80211 NICs support this feature.
2158+ * All values are treated as suggestions and may be ignored
2159+ * by the driver as required. The actual values may be seen in
2160+ * the station debugfs vht_caps file.
21612161 *
21622162 * @NL80211_ATTR_DFS_REGION: region for regulatory rules which this country
21632163 * abides to when initiating radiation on DFS channels. A country maps
@@ -3565,7 +3565,7 @@ enum nl80211_sta_flags { · 1401 unmodified lines
35653565 * enum nl80211_sta_p2p_ps_status - station support of P2P PS
35663566 *
35673567 * @NL80211_P2P_PS_UNSUPPORTED: station doesn't support P2P PS mechanism
3568− * @@NL80211_P2P_PS_SUPPORTED: station supports P2P PS mechanism
3568+ * @NL80211_P2P_PS_SUPPORTED: station supports P2P PS mechanism
35693569 * @NUM_NL80211_P2P_PS_STATUS: number of values
35703570 */
35713571 enum nl80211_sta_p2p_ps_status {
@@ -3603,9 +3603,9 @@ enum nl80211_he_gi { · 31 unmodified lines
36033603
36043604 /**
36053605 * enum nl80211_he_ltf - HE long training field
3606− * @NL80211_RATE_INFO_HE_1xLTF: 3.2 usec
3607− * @NL80211_RATE_INFO_HE_2xLTF: 6.4 usec
3608− * @NL80211_RATE_INFO_HE_4xLTF: 12.8 usec
3606+ * @NL80211_RATE_INFO_HE_1XLTF: 3.2 usec
3607+ * @NL80211_RATE_INFO_HE_2XLTF: 6.4 usec
3608+ * @NL80211_RATE_INFO_HE_4XLTF: 12.8 usec
36093609 */
36103610 enum nl80211_he_ltf {
36113611 NL80211_RATE_INFO_HE_1XLTF,
@@ -3720,7 +3720,7 @@ enum nl80211_eht_ru_alloc { · 108 unmodified lines
37203720 * @NL80211_RATE_INFO_HE_GI: HE guard interval identifier
37213721 * (u8, see &enum nl80211_he_gi)
37223722 * @NL80211_RATE_INFO_HE_DCM: HE DCM value (u8, 0/1)
3723− * @NL80211_RATE_INFO_RU_ALLOC: HE RU allocation, if not present then
3723+ * @NL80211_RATE_INFO_HE_RU_ALLOC: HE RU allocation, if not present then
37243724 * non-OFDMA was used (u8, see &enum nl80211_he_ru_alloc)
37253725 * @NL80211_RATE_INFO_320_MHZ_WIDTH: 320 MHz bitrate
37263726 * @NL80211_RATE_INFO_EHT_MCS: EHT MCS index (u8, 0-15)
@@ -3852,8 +3852,8 @@ enum nl80211_sta_bss_param { · 125 unmodified lines
38523852 * Contains a nested array of signal strength attributes (u8, dBm)
38533853 * @NL80211_STA_INFO_CHAIN_SIGNAL_AVG: per-chain signal strength average
38543854 * Same format as NL80211_STA_INFO_CHAIN_SIGNAL.
3855− * @NL80211_STA_EXPECTED_THROUGHPUT: expected throughput considering also the
3856− * 802.11 header (u32, kbps)
3855+ * @NL80211_STA_INFO_EXPECTED_THROUGHPUT: expected throughput considering also
3856+ * the 802.11 header (u32, kbps)
38573857 * @NL80211_STA_INFO_RX_DROP_MISC: RX packets dropped for unspecified reasons
38583858 * (u64)
38593859 * @NL80211_STA_INFO_BEACON_RX: number of beacons received from this peer (u64)
@@ -4179,7 +4179,7 @@ enum nl80211_band_attr { · 319 unmodified lines
41794179 * @NL80211_WMMR_CW_MAX: Maximum contention window slot.
41804180 * @NL80211_WMMR_AIFSN: Arbitration Inter Frame Space.
41814181 * @NL80211_WMMR_TXOP: Maximum allowed tx operation time.
4182− * @nl80211_WMMR_MAX: highest possible wmm rule.
4182+ * @NL80211_WMMR_MAX: highest possible wmm rule.
41834183 * @__NL80211_WMMR_LAST: Internal use.
41844184 */
41854185 enum nl80211_wmm_rule {
@@ -4203,6 +4203,7 @@ enum nl80211_wmm_rule { · 17 unmodified lines
42034203 * @NL80211_FREQUENCY_ATTR_NO_IR: no mechanisms that initiate radiation
42044204 * are permitted on this channel, this includes sending probe
42054205 * requests, or modes of operation that require beaconing.
4206+ * @__NL80211_FREQUENCY_ATTR_NO_IBSS: obsolete, same as _NO_IR
42064207 * @NL80211_FREQUENCY_ATTR_RADAR: Radar detection is mandatory
42074208 * on this channel in current regulatory domain.
42084209 * @NL80211_FREQUENCY_ATTR_MAX_TX_POWER: Maximum transmission power in mBm
@@ -4357,7 +4358,7 @@ enum nl80211_bitrate_attr { · 148 unmodified lines
43574358 };
43584359
43594360 /**
4360− * enum nl80211_initiator - Indicates the initiator of a reg domain request
4361+ * enum nl80211_reg_initiator - Indicates the initiator of a reg domain request
43614362 * @NL80211_REGDOM_SET_BY_CORE: Core queried CRDA for a dynamic world
43624363 * regulatory domain.
43634364 * @NL80211_REGDOM_SET_BY_USER: User asked the wireless core to set the
@@ -4509,6 +4510,7 @@ enum nl80211_sched_scan_match_attr { · 145 unmodified lines
45094510 * @NL80211_RRF_NO_IR: no mechanisms that initiate radiation are allowed,
45104511 * this includes probe requests or modes of operation that require
45114512 * beaconing.
4513+ * @__NL80211_RRF_NO_IBSS: obsolete, same as NO_IR
45124514 * @NL80211_RRF_AUTO_BW: maximum available bandwidth should be calculated
45134515 * base on contiguous rules and wider channels will be allowed to cross
45144516 * multiple contiguous/overlapping frequency ranges.
@@ -4707,8 +4709,8 @@ enum nl80211_mntr_flags { · 192 unmodified lines
47074709 * alternate between Active and Doze states, but may not wake up
47084710 * for neighbor's beacons.
47094711 *
4710− * @__NL80211_MESH_POWER_AFTER_LAST - internal use
4711− * @NL80211_MESH_POWER_MAX - highest possible power save level
4712+ * @__NL80211_MESH_POWER_AFTER_LAST: internal use
4713+ * @NL80211_MESH_POWER_MAX: highest possible power save level
47124714 */
47134715
47144716 enum nl80211_mesh_power_mode {
@@ -5728,7 +5730,7 @@ struct nl80211_pattern_support { · 1013 unmodified lines
57285730 * "TCP connection wakeup" for more details. This is a nested attribute
57295731 * containing the exact information for establishing and keeping alive
57305732 * the TCP connection.
5731− * @NL80211_WOWLAN_TRIG_TCP_WAKEUP_MATCH: For wakeup reporting only, the
5733+ * @NL80211_WOWLAN_TRIG_WAKEUP_TCP_MATCH: For wakeup reporting only, the
57325734 * wakeup packet was received on the TCP connection
57335735 * @NL80211_WOWLAN_TRIG_WAKEUP_TCP_CONNLOST: For wakeup reporting only, the
57345736 * TCP connection was lost or failed to be established
@@ -6404,6 +6406,7 @@ enum nl80211_feature_flags { · 669 unmodified lines
64046406 * receiving control port frames over nl80211 instead of the netdevice.
64056407 * @NL80211_EXT_FEATURE_ACK_SIGNAL_SUPPORT: This driver/device supports
64066408 * (average) ACK signal strength reporting.
6409+ * @NL80211_EXT_FEATURE_DATA_ACK_SIGNAL_SUPPORT: Backward-compatible ID
64076410 * @NL80211_EXT_FEATURE_TXQS: Driver supports FQ-CoDel-enabled intermediate
64086411 * TXQs.
64096412 * @NL80211_EXT_FEATURE_SCAN_RANDOM_SN: Driver/device supports randomizing the
@@ -6787,6 +6790,8 @@ enum nl80211_acl_policy { · 377 unmodified lines
67876790 * @NL80211_SMPS_STATIC: static SMPS (use a single antenna)
67886791 * @NL80211_SMPS_DYNAMIC: dynamic smps (start with a single antenna and
67896792 * turn on other antennas after CTS/RTS).
6793+ * @__NL80211_SMPS_AFTER_LAST: internal
6794+ * @NL80211_SMPS_MAX: highest used enumeration
67906795 */
67916796 enum nl80211_smps_mode {
67926797 NL80211_SMPS_OFF,
@@ -7008,6 +7013,8 @@ enum nl80211_bss_select_attr { · 215 unmodified lines
70087013 * @NL80211_NAN_FUNC_PUBLISH: function is publish
70097014 * @NL80211_NAN_FUNC_SUBSCRIBE: function is subscribe
70107015 * @NL80211_NAN_FUNC_FOLLOW_UP: function is follow-up
7016+ * @__NL80211_NAN_FUNC_TYPE_AFTER_LAST: internal use
7017+ * @NL80211_NAN_FUNC_MAX_TYPE: internal use
70117018 */
70127019 enum nl80211_nan_function_type {
70137020 NL80211_NAN_FUNC_PUBLISH,
@@ -7168,7 +7175,7 @@ enum nl80211_nan_match_attributes { · 154 unmodified lines
71687175 };
71697176
71707177 /**
7171− * nl80211_external_auth_action - Action to perform with external
7178+ * enum nl80211_external_auth_action - Action to perform with external
71727179 * authentication request. Used by NL80211_ATTR_EXTERNAL_AUTH_ACTION.
71737180 * @NL80211_EXTERNAL_AUTH_START: Start the authentication.
71747181 * @NL80211_EXTERNAL_AUTH_ABORT: Abort the ongoing authentication.
@@ -7186,7 +7193,7 @@ enum nl80211_external_auth_action { · 11 unmodified lines
71867193 * @NL80211_FTM_RESP_ATTR_LCI: The content of Measurement Report Element
71877194 * (9.4.2.22 in 802.11-2016) with type 8 - LCI (9.4.2.22.10),
71887195 * i.e. starting with the measurement token
7189− * @NL80211_FTM_RESP_ATTR_CIVIC: The content of Measurement Report Element
7196+ * @NL80211_FTM_RESP_ATTR_CIVICLOC: The content of Measurement Report Element
71907197 * (9.4.2.22 in 802.11-2016) with type 11 - Civic (Section 9.4.2.22.13),
71917198 * i.e. starting with the measurement token
71927199 * @__NL80211_FTM_RESP_ATTR_LAST: Internal
@@ -7829,6 +7836,7 @@ enum nl80211_sae_pwe_mechanism { · 636 unmodified lines
78297836 *
78307837 * @NL80211_SAR_TYPE_POWER: power limitation specified in 0.25dBm unit
78317838 *
7839+ * @NUM_NL80211_SAR_TYPE: internal
78327840 */
78337841 enum nl80211_sar_type {
78347842 NL80211_SAR_TYPE_POWER,
@@ -7842,6 +7850,8 @@ enum nl80211_sar_type { · 7 unmodified lines
78427850 /**
78437851 * enum nl80211_sar_attrs - Attributes for SAR spec
78447852 *
7853+ * @__NL80211_SAR_ATTR_INVALID: Invalid
7854+ *
78457855 * @NL80211_SAR_ATTR_TYPE: the SAR type as defined in &enum nl80211_sar_type.
78467856 *
78477857 * @NL80211_SAR_ATTR_SPECS: Nested array of SAR power
@@ -7873,6 +7883,8 @@ enum nl80211_sar_attrs { · 25 unmodified lines
78737883 /**
78747884 * enum nl80211_sar_specs_attrs - Attributes for SAR power limit specs
78757885 *
7886+ * @__NL80211_SAR_ATTR_SPECS_INVALID: Invalid
7887+ *
78767888 * @NL80211_SAR_ATTR_SPECS_POWER: Required (s32)value to specify the actual
78777889 * power limit value in units of 0.25 dBm if type is
78787890 * NL80211_SAR_TYPE_POWER. (i.e., a value of 44 represents 11 dBm).

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t