wifi: nl80211: fix nl80211 uapi comment style issues
authorJeff Johnson <quic_jjohnson@quicinc.com>
Tue, 19 Mar 2024 18:26:24 +0000 (11:26 -0700)
committerJohannes Berg <johannes.berg@intel.com>
Mon, 25 Mar 2024 14:36:55 +0000 (15:36 +0100)
Currently kernel-doc raises "warning: bad line:" for several comments
that have invalid multi-line comment style; they are missing the
leading '*'. And checkpatch.pl raises "WARNING: please, no space
before tabs" for a large number of comments which have space then tab
after the leading '*'.

Fix those issues.

Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
Link: https://msgid.link/20240319-kdoc-nl80211-v1-2-549e09d52866@quicinc.com
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
include/uapi/linux/nl80211.h

index 9397c61a48dcddb3ec2bc5f6f637b1eda53e1a05..4de84fbfd4fa14f61b3db27e291c56ef9cba0151 100644 (file)
  *     stations connected and using at least that link as one of its links.
  *
  * @NL80211_CMD_GET_MPATH: Get mesh path attributes for mesh path to
- *     destination %NL80211_ATTR_MAC on the interface identified by
- *     %NL80211_ATTR_IFINDEX.
+ *     destination %NL80211_ATTR_MAC on the interface identified by
+ *     %NL80211_ATTR_IFINDEX.
  * @NL80211_CMD_SET_MPATH:  Set mesh path attributes for mesh path to
- *     destination %NL80211_ATTR_MAC on the interface identified by
- *     %NL80211_ATTR_IFINDEX.
+ *     destination %NL80211_ATTR_MAC on the interface identified by
+ *     %NL80211_ATTR_IFINDEX.
  * @NL80211_CMD_NEW_MPATH: Create a new mesh path for the destination given by
  *     %NL80211_ATTR_MAC via %NL80211_ATTR_MPATH_NEXT_HOP.
  * @NL80211_CMD_DEL_MPATH: Delete a mesh path to the destination given by
  *     after being queried by the kernel. CRDA replies by sending a regulatory
  *     domain structure which consists of %NL80211_ATTR_REG_ALPHA set to our
  *     current alpha2 if it found a match. It also provides
- *     NL80211_ATTR_REG_RULE_FLAGS, and a set of regulatory rules. Each
- *     regulatory rule is a nested set of attributes  given by
- *     %NL80211_ATTR_REG_RULE_FREQ_[START|END] and
- *     %NL80211_ATTR_FREQ_RANGE_MAX_BW with an attached power rule given by
- *     %NL80211_ATTR_REG_RULE_POWER_MAX_ANT_GAIN and
- *     %NL80211_ATTR_REG_RULE_POWER_MAX_EIRP.
+ *     NL80211_ATTR_REG_RULE_FLAGS, and a set of regulatory rules. Each
+ *     regulatory rule is a nested set of attributes  given by
+ *     %NL80211_ATTR_REG_RULE_FREQ_[START|END] and
+ *     %NL80211_ATTR_FREQ_RANGE_MAX_BW with an attached power rule given by
+ *     %NL80211_ATTR_REG_RULE_POWER_MAX_ANT_GAIN and
+ *     %NL80211_ATTR_REG_RULE_POWER_MAX_EIRP.
  * @NL80211_CMD_REQ_SET_REG: ask the wireless core to set the regulatory domain
- *     to the specified ISO/IEC 3166-1 alpha2 country code. The core will
- *     store this as a valid request and then query userspace for it.
+ *     to the specified ISO/IEC 3166-1 alpha2 country code. The core will
+ *     store this as a valid request and then query userspace for it.
  *
  * @NL80211_CMD_GET_MESH_CONFIG: Get mesh networking properties for the
  *     interface identified by %NL80211_ATTR_IFINDEX
  * @NL80211_CMD_FLUSH_PMKSA: Flush all PMKSA cache entries.
  *
  * @NL80211_CMD_REG_CHANGE: indicates to userspace the regulatory domain
- *     has been changed and provides details of the request information
- *     that caused the change such as who initiated the regulatory request
- *     (%NL80211_ATTR_REG_INITIATOR), the wiphy_idx
- *     (%NL80211_ATTR_REG_ALPHA2) on which the request was made from if
- *     the initiator was %NL80211_REGDOM_SET_BY_COUNTRY_IE or
- *     %NL80211_REGDOM_SET_BY_DRIVER, the type of regulatory domain
- *     set (%NL80211_ATTR_REG_TYPE), if the type of regulatory domain is
- *     %NL80211_REG_TYPE_COUNTRY the alpha2 to which we have moved on
- *     to (%NL80211_ATTR_REG_ALPHA2).
+ *     has been changed and provides details of the request information
+ *     that caused the change such as who initiated the regulatory request
+ *     (%NL80211_ATTR_REG_INITIATOR), the wiphy_idx
+ *     (%NL80211_ATTR_REG_ALPHA2) on which the request was made from if
+ *     the initiator was %NL80211_REGDOM_SET_BY_COUNTRY_IE or
+ *     %NL80211_REGDOM_SET_BY_DRIVER, the type of regulatory domain
+ *     set (%NL80211_ATTR_REG_TYPE), if the type of regulatory domain is
+ *     %NL80211_REG_TYPE_COUNTRY the alpha2 to which we have moved on
+ *     to (%NL80211_ATTR_REG_ALPHA2).
  * @NL80211_CMD_REG_BEACON_HINT: indicates to userspace that an AP beacon
- *     has been found while world roaming thus enabling active scan or
- *     any mode of operation that initiates TX (beacons) on a channel
- *     where we would not have been able to do either before. As an example
- *     if you are world roaming (regulatory domain set to world or if your
- *     driver is using a custom world roaming regulatory domain) and while
- *     doing a passive scan on the 5 GHz band you find an AP there (if not
- *     on a DFS channel) you will now be able to actively scan for that AP
- *     or use AP mode on your card on that same channel. Note that this will
- *     never be used for channels 1-11 on the 2 GHz band as they are always
- *     enabled world wide. This beacon hint is only sent if your device had
- *     either disabled active scanning or beaconing on a channel. We send to
- *     userspace the wiphy on which we removed a restriction from
- *     (%NL80211_ATTR_WIPHY) and the channel on which this occurred
- *     before (%NL80211_ATTR_FREQ_BEFORE) and after (%NL80211_ATTR_FREQ_AFTER)
- *     the beacon hint was processed.
+ *     has been found while world roaming thus enabling active scan or
+ *     any mode of operation that initiates TX (beacons) on a channel
+ *     where we would not have been able to do either before. As an example
+ *     if you are world roaming (regulatory domain set to world or if your
+ *     driver is using a custom world roaming regulatory domain) and while
+ *     doing a passive scan on the 5 GHz band you find an AP there (if not
+ *     on a DFS channel) you will now be able to actively scan for that AP
+ *     or use AP mode on your card on that same channel. Note that this will
+ *     never be used for channels 1-11 on the 2 GHz band as they are always
+ *     enabled world wide. This beacon hint is only sent if your device had
+ *     either disabled active scanning or beaconing on a channel. We send to
+ *     userspace the wiphy on which we removed a restriction from
+ *     (%NL80211_ATTR_WIPHY) and the channel on which this occurred
+ *     before (%NL80211_ATTR_FREQ_BEFORE) and after (%NL80211_ATTR_FREQ_AFTER)
+ *     the beacon hint was processed.
  *
  * @NL80211_CMD_AUTHENTICATE: authentication request and notification.
  *     This command is used both as a command (request to authenticate) and
@@ -1715,21 +1715,21 @@ enum nl80211_commands {
  *     (see &enum nl80211_plink_action).
  * @NL80211_ATTR_MPATH_NEXT_HOP: MAC address of the next hop for a mesh path.
  * @NL80211_ATTR_MPATH_INFO: information about a mesh_path, part of mesh path
- *     info given for %NL80211_CMD_GET_MPATH, nested attribute described at
+ *     info given for %NL80211_CMD_GET_MPATH, nested attribute described at
  *     &enum nl80211_mpath_info.
  *
  * @NL80211_ATTR_MNTR_FLAGS: flags, nested element with NLA_FLAG attributes of
  *      &enum nl80211_mntr_flags.
  *
  * @NL80211_ATTR_REG_ALPHA2: an ISO-3166-alpha2 country code for which the
- *     current regulatory domain should be set to or is already set to.
- *     For example, 'CR', for Costa Rica. This attribute is used by the kernel
- *     to query the CRDA to retrieve one regulatory domain. This attribute can
- *     also be used by userspace to query the kernel for the currently set
- *     regulatory domain. We chose an alpha2 as that is also used by the
- *     IEEE-802.11 country information element to identify a country.
- *     Users can also simply ask the wireless core to set regulatory domain
- *     to a specific alpha2.
+ *     current regulatory domain should be set to or is already set to.
+ *     For example, 'CR', for Costa Rica. This attribute is used by the kernel
+ *     to query the CRDA to retrieve one regulatory domain. This attribute can
+ *     also be used by userspace to query the kernel for the currently set
+ *     regulatory domain. We chose an alpha2 as that is also used by the
+ *     IEEE-802.11 country information element to identify a country.
+ *     Users can also simply ask the wireless core to set regulatory domain
+ *     to a specific alpha2.
  * @NL80211_ATTR_REG_RULES: a nested array of regulatory domain regulatory
  *     rules.
  *
@@ -1772,9 +1772,9 @@ enum nl80211_commands {
  * @NL80211_ATTR_BSS: scan result BSS
  *
  * @NL80211_ATTR_REG_INITIATOR: indicates who requested the regulatory domain
- *     currently in effect. This could be any of the %NL80211_REGDOM_SET_BY_*
+ *     currently in effect. This could be any of the %NL80211_REGDOM_SET_BY_*
  * @NL80211_ATTR_REG_TYPE: indicates the type of the regulatory domain currently
- *     set. This can be one of the nl80211_reg_type (%NL80211_REGDOM_TYPE_*)
+ *     set. This can be one of the nl80211_reg_type (%NL80211_REGDOM_TYPE_*)
  *
  * @NL80211_ATTR_SUPPORTED_COMMANDS: wiphy attribute that specifies
  *     an array of command numbers (i.e. a mapping index to command number)
@@ -1793,15 +1793,15 @@ enum nl80211_commands {
  *     a u32
  *
  * @NL80211_ATTR_FREQ_BEFORE: A channel which has suffered a regulatory change
- *     due to considerations from a beacon hint. This attribute reflects
- *     the state of the channel _before_ the beacon hint processing. This
- *     attributes consists of a nested attribute containing
- *     NL80211_FREQUENCY_ATTR_*
+ *     due to considerations from a beacon hint. This attribute reflects
+ *     the state of the channel _before_ the beacon hint processing. This
+ *     attributes consists of a nested attribute containing
+ *     NL80211_FREQUENCY_ATTR_*
  * @NL80211_ATTR_FREQ_AFTER: A channel which has suffered a regulatory change
- *     due to considerations from a beacon hint. This attribute reflects
- *     the state of the channel _after_ the beacon hint processing. This
- *     attributes consists of a nested attribute containing
- *     NL80211_FREQUENCY_ATTR_*
+ *     due to considerations from a beacon hint. This attribute reflects
+ *     the state of the channel _after_ the beacon hint processing. This
+ *     attributes consists of a nested attribute containing
+ *     NL80211_FREQUENCY_ATTR_*
  *
  * @NL80211_ATTR_CIPHER_SUITES: a set of u32 values indicating the supported
  *     cipher suites
@@ -2416,7 +2416,7 @@ enum nl80211_commands {
  *     scheduled scan is started.  Or the delay before a WoWLAN
  *     net-detect scan is started, counting from the moment the
  *     system is suspended.  This value is a u32, in seconds.
-
+ *
  * @NL80211_ATTR_REG_INDOOR: flag attribute, if set indicates that the device
  *      is operating in an indoor environment.
  *
@@ -3823,7 +3823,7 @@ enum nl80211_sta_bss_param {
  *     (u64, to this station)
  * @NL80211_STA_INFO_SIGNAL: signal strength of last received PPDU (u8, dBm)
  * @NL80211_STA_INFO_TX_BITRATE: current unicast tx rate, nested attribute
- *     containing info as possible, see &enum nl80211_rate_info
+ *     containing info as possible, see &enum nl80211_rate_info
  * @NL80211_STA_INFO_RX_PACKETS: total received packet (MSDUs and MMPDUs)
  *     (u32, from this station)
  * @NL80211_STA_INFO_TX_PACKETS: total transmitted packets (MSDUs and MMPDUs)
@@ -4039,7 +4039,7 @@ enum nl80211_mpath_flags {
  * @NL80211_MPATH_INFO_METRIC: metric (cost) of this mesh path
  * @NL80211_MPATH_INFO_EXPTIME: expiration time for the path, in msec from now
  * @NL80211_MPATH_INFO_FLAGS: mesh path flags, enumerated in
- *     &enum nl80211_mpath_flags;
+ *     &enum nl80211_mpath_flags;
  * @NL80211_MPATH_INFO_DISCOVERY_TIMEOUT: total path discovery timeout, in msec
  * @NL80211_MPATH_INFO_DISCOVERY_RETRIES: mesh path discovery retries
  * @NL80211_MPATH_INFO_HOP_COUNT: hop count to destination
@@ -4201,8 +4201,8 @@ enum nl80211_wmm_rule {
  * @NL80211_FREQUENCY_ATTR_DISABLED: Channel is disabled in current
  *     regulatory domain.
  * @NL80211_FREQUENCY_ATTR_NO_IR: no mechanisms that initiate radiation
- *     are permitted on this channel, this includes sending probe
- *     requests, or modes of operation that require beaconing.
+ *     are permitted on this channel, this includes sending probe
+ *     requests, or modes of operation that require beaconing.
  * @NL80211_FREQUENCY_ATTR_RADAR: Radar detection is mandatory
  *     on this channel in current regulatory domain.
  * @NL80211_FREQUENCY_ATTR_MAX_TX_POWER: Maximum transmission power in mBm
@@ -4359,14 +4359,14 @@ enum nl80211_bitrate_attr {
 /**
  * enum nl80211_initiator - Indicates the initiator of a reg domain request
  * @NL80211_REGDOM_SET_BY_CORE: Core queried CRDA for a dynamic world
- *     regulatory domain.
+ *     regulatory domain.
  * @NL80211_REGDOM_SET_BY_USER: User asked the wireless core to set the
- *     regulatory domain.
+ *     regulatory domain.
  * @NL80211_REGDOM_SET_BY_DRIVER: a wireless drivers has hinted to the
- *     wireless core it thinks its knows the regulatory domain we should be in.
+ *     wireless core it thinks its knows the regulatory domain we should be in.
  * @NL80211_REGDOM_SET_BY_COUNTRY_IE: the wireless core has received an
- *     802.11 country information element with regulatory information it
- *     thinks we should consider. cfg80211 only processes the country
+ *     802.11 country information element with regulatory information it
+ *     thinks we should consider. cfg80211 only processes the country
  *     code from the IE, and relies on the regulatory domain information
  *     structure passed by userspace (CRDA) from our wireless-regdb.
  *     If a channel is enabled but the country code indicates it should
@@ -4385,11 +4385,11 @@ enum nl80211_reg_initiator {
  *     to a specific country. When this is set you can count on the
  *     ISO / IEC 3166 alpha2 country code being valid.
  * @NL80211_REGDOM_TYPE_WORLD: the regulatory set domain is the world regulatory
- *     domain.
+ *     domain.
  * @NL80211_REGDOM_TYPE_CUSTOM_WORLD: the regulatory domain set is a custom
- *     driver specific world regulatory domain. These do not apply system-wide
- *     and are only applicable to the individual devices which have requested
- *     them to be applied.
+ *     driver specific world regulatory domain. These do not apply system-wide
+ *     and are only applicable to the individual devices which have requested
+ *     them to be applied.
  * @NL80211_REGDOM_TYPE_INTERSECTION: the regulatory domain set is the product
  *     of an intersection between two regulatory domains -- the previously
  *     set regulatory domain on the system and the last accepted regulatory
@@ -4406,21 +4406,21 @@ enum nl80211_reg_type {
  * enum nl80211_reg_rule_attr - regulatory rule attributes
  * @__NL80211_REG_RULE_ATTR_INVALID: attribute number 0 is reserved
  * @NL80211_ATTR_REG_RULE_FLAGS: a set of flags which specify additional
- *     considerations for a given frequency range. These are the
- *     &enum nl80211_reg_rule_flags.
+ *     considerations for a given frequency range. These are the
+ *     &enum nl80211_reg_rule_flags.
  * @NL80211_ATTR_FREQ_RANGE_START: starting frequencry for the regulatory
- *     rule in KHz. This is not a center of frequency but an actual regulatory
- *     band edge.
+ *     rule in KHz. This is not a center of frequency but an actual regulatory
+ *     band edge.
  * @NL80211_ATTR_FREQ_RANGE_END: ending frequency for the regulatory rule
- *     in KHz. This is not a center a frequency but an actual regulatory
- *     band edge.
+ *     in KHz. This is not a center a frequency but an actual regulatory
+ *     band edge.
  * @NL80211_ATTR_FREQ_RANGE_MAX_BW: maximum allowed bandwidth for this
  *     frequency range, in KHz.
  * @NL80211_ATTR_POWER_RULE_MAX_ANT_GAIN: the maximum allowed antenna gain
- *     for a given frequency range. The value is in mBi (100 * dBi).
- *     If you don't have one then don't send this.
+ *     for a given frequency range. The value is in mBi (100 * dBi).
+ *     If you don't have one then don't send this.
  * @NL80211_ATTR_POWER_RULE_MAX_EIRP: the maximum allowed EIRP for
- *     a given frequency range. The value is in mBm (100 * dBm).
+ *     a given frequency range. The value is in mBm (100 * dBm).
  * @NL80211_ATTR_DFS_CAC_TIME: DFS CAC time in milliseconds.
  *     If not present or 0 default CAC time will be used.
  * @NL80211_ATTR_POWER_RULE_PSD: power spectral density (in dBm).
@@ -4507,8 +4507,8 @@ enum nl80211_sched_scan_match_attr {
  * @NL80211_RRF_PTP_ONLY: this is only for Point To Point links
  * @NL80211_RRF_PTMP_ONLY: this is only for Point To Multi Point links
  * @NL80211_RRF_NO_IR: no mechanisms that initiate radiation are allowed,
- *     this includes probe requests or modes of operation that require
- *     beaconing.
+ *     this includes probe requests or modes of operation that require
+ *     beaconing.
  * @NL80211_RRF_AUTO_BW: maximum available bandwidth should be calculated
  *     base on contiguous rules and wider channels will be allowed to cross
  *     multiple contiguous/overlapping frequency ranges.
@@ -4522,9 +4522,9 @@ enum nl80211_sched_scan_match_attr {
  * @NL80211_RRF_NO_EHT: EHT operation not allowed
  * @NL80211_RRF_PSD: Ruleset has power spectral density value
  * @NL80211_RRF_DFS_CONCURRENT: Operation on this channel is allowed for
      peer-to-peer or adhoc communication under the control of a DFS master
      which operates on the same channel (FCC-594280 D01 Section B.3).
      Should be used together with %NL80211_RRF_DFS only.
*     peer-to-peer or adhoc communication under the control of a DFS master
*     which operates on the same channel (FCC-594280 D01 Section B.3).
*     Should be used together with %NL80211_RRF_DFS only.
  * @NL80211_RRF_NO_6GHZ_VLP_CLIENT: Client connection to VLP AP not allowed
  * @NL80211_RRF_NO_6GHZ_AFC_CLIENT: Client connection to AFC AP not allowed
  */