History

wifi: nl80211: fix nl80211 uapi comment style issues

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.

Jeff Johnson committed 2 years ago

Commit ec3a97d1 parent 1c7b9631 file · +83 −83Browse files

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

Unified · Split

include/uapi/linux/nl80211.h+83−83
@@ -442,11 +442,11 @@ · 441 unmodified lines
442442 * stations connected and using at least that link as one of its links.
443443 *
444444 * @NL80211_CMD_GET_MPATH: Get mesh path attributes for mesh path to
445− * destination %NL80211_ATTR_MAC on the interface identified by
446− * %NL80211_ATTR_IFINDEX.
445+ * destination %NL80211_ATTR_MAC on the interface identified by
446+ * %NL80211_ATTR_IFINDEX.
447447 * @NL80211_CMD_SET_MPATH: Set mesh path attributes for mesh path to
448− * destination %NL80211_ATTR_MAC on the interface identified by
449− * %NL80211_ATTR_IFINDEX.
448+ * destination %NL80211_ATTR_MAC on the interface identified by
449+ * %NL80211_ATTR_IFINDEX.
450450 * @NL80211_CMD_NEW_MPATH: Create a new mesh path for the destination given by
451451 * %NL80211_ATTR_MAC via %NL80211_ATTR_MPATH_NEXT_HOP.
452452 * @NL80211_CMD_DEL_MPATH: Delete a mesh path to the destination given by
@@ -476,15 +476,15 @@ · 23 unmodified lines
476476 * after being queried by the kernel. CRDA replies by sending a regulatory
477477 * domain structure which consists of %NL80211_ATTR_REG_ALPHA set to our
478478 * current alpha2 if it found a match. It also provides
479− * NL80211_ATTR_REG_RULE_FLAGS, and a set of regulatory rules. Each
480− * regulatory rule is a nested set of attributes given by
481− * %NL80211_ATTR_REG_RULE_FREQ_[START|END] and
482− * %NL80211_ATTR_FREQ_RANGE_MAX_BW with an attached power rule given by
483− * %NL80211_ATTR_REG_RULE_POWER_MAX_ANT_GAIN and
484− * %NL80211_ATTR_REG_RULE_POWER_MAX_EIRP.
479+ * NL80211_ATTR_REG_RULE_FLAGS, and a set of regulatory rules. Each
480+ * regulatory rule is a nested set of attributes given by
481+ * %NL80211_ATTR_REG_RULE_FREQ_[START|END] and
482+ * %NL80211_ATTR_FREQ_RANGE_MAX_BW with an attached power rule given by
483+ * %NL80211_ATTR_REG_RULE_POWER_MAX_ANT_GAIN and
484+ * %NL80211_ATTR_REG_RULE_POWER_MAX_EIRP.
485485 * @NL80211_CMD_REQ_SET_REG: ask the wireless core to set the regulatory domain
486− * to the specified ISO/IEC 3166-1 alpha2 country code. The core will
487− * store this as a valid request and then query userspace for it.
486+ * to the specified ISO/IEC 3166-1 alpha2 country code. The core will
487+ * store this as a valid request and then query userspace for it.
488488 *
489489 * @NL80211_CMD_GET_MESH_CONFIG: Get mesh networking properties for the
490490 * interface identified by %NL80211_ATTR_IFINDEX
@@ -574,31 +574,31 @@ · 83 unmodified lines
574574 * @NL80211_CMD_FLUSH_PMKSA: Flush all PMKSA cache entries.
575575 *
576576 * @NL80211_CMD_REG_CHANGE: indicates to userspace the regulatory domain
577− * has been changed and provides details of the request information
578− * that caused the change such as who initiated the regulatory request
579− * (%NL80211_ATTR_REG_INITIATOR), the wiphy_idx
580− * (%NL80211_ATTR_REG_ALPHA2) on which the request was made from if
581− * the initiator was %NL80211_REGDOM_SET_BY_COUNTRY_IE or
582− * %NL80211_REGDOM_SET_BY_DRIVER, the type of regulatory domain
583− * set (%NL80211_ATTR_REG_TYPE), if the type of regulatory domain is
584− * %NL80211_REG_TYPE_COUNTRY the alpha2 to which we have moved on
585− * to (%NL80211_ATTR_REG_ALPHA2).
577+ * has been changed and provides details of the request information
578+ * that caused the change such as who initiated the regulatory request
579+ * (%NL80211_ATTR_REG_INITIATOR), the wiphy_idx
580+ * (%NL80211_ATTR_REG_ALPHA2) on which the request was made from if
581+ * the initiator was %NL80211_REGDOM_SET_BY_COUNTRY_IE or
582+ * %NL80211_REGDOM_SET_BY_DRIVER, the type of regulatory domain
583+ * set (%NL80211_ATTR_REG_TYPE), if the type of regulatory domain is
584+ * %NL80211_REG_TYPE_COUNTRY the alpha2 to which we have moved on
585+ * to (%NL80211_ATTR_REG_ALPHA2).
586586 * @NL80211_CMD_REG_BEACON_HINT: indicates to userspace that an AP beacon
587− * has been found while world roaming thus enabling active scan or
588− * any mode of operation that initiates TX (beacons) on a channel
589− * where we would not have been able to do either before. As an example
590− * if you are world roaming (regulatory domain set to world or if your
591− * driver is using a custom world roaming regulatory domain) and while
592− * doing a passive scan on the 5 GHz band you find an AP there (if not
593− * on a DFS channel) you will now be able to actively scan for that AP
594− * or use AP mode on your card on that same channel. Note that this will
595− * never be used for channels 1-11 on the 2 GHz band as they are always
596− * enabled world wide. This beacon hint is only sent if your device had
597− * either disabled active scanning or beaconing on a channel. We send to
598− * userspace the wiphy on which we removed a restriction from
599− * (%NL80211_ATTR_WIPHY) and the channel on which this occurred
600− * before (%NL80211_ATTR_FREQ_BEFORE) and after (%NL80211_ATTR_FREQ_AFTER)
601− * the beacon hint was processed.
587+ * has been found while world roaming thus enabling active scan or
588+ * any mode of operation that initiates TX (beacons) on a channel
589+ * where we would not have been able to do either before. As an example
590+ * if you are world roaming (regulatory domain set to world or if your
591+ * driver is using a custom world roaming regulatory domain) and while
592+ * doing a passive scan on the 5 GHz band you find an AP there (if not
593+ * on a DFS channel) you will now be able to actively scan for that AP
594+ * or use AP mode on your card on that same channel. Note that this will
595+ * never be used for channels 1-11 on the 2 GHz band as they are always
596+ * enabled world wide. This beacon hint is only sent if your device had
597+ * either disabled active scanning or beaconing on a channel. We send to
598+ * userspace the wiphy on which we removed a restriction from
599+ * (%NL80211_ATTR_WIPHY) and the channel on which this occurred
600+ * before (%NL80211_ATTR_FREQ_BEFORE) and after (%NL80211_ATTR_FREQ_AFTER)
601+ * the beacon hint was processed.
602602 *
603603 * @NL80211_CMD_AUTHENTICATE: authentication request and notification.
604604 * This command is used both as a command (request to authenticate) and
@@ -1715,21 +1715,21 @@ enum nl80211_commands { · 1110 unmodified lines
17151715 * (see &enum nl80211_plink_action).
17161716 * @NL80211_ATTR_MPATH_NEXT_HOP: MAC address of the next hop for a mesh path.
17171717 * @NL80211_ATTR_MPATH_INFO: information about a mesh_path, part of mesh path
1718− * info given for %NL80211_CMD_GET_MPATH, nested attribute described at
1718+ * info given for %NL80211_CMD_GET_MPATH, nested attribute described at
17191719 * &enum nl80211_mpath_info.
17201720 *
17211721 * @NL80211_ATTR_MNTR_FLAGS: flags, nested element with NLA_FLAG attributes of
17221722 * &enum nl80211_mntr_flags.
17231723 *
17241724 * @NL80211_ATTR_REG_ALPHA2: an ISO-3166-alpha2 country code for which the
1725− * current regulatory domain should be set to or is already set to.
1726− * For example, 'CR', for Costa Rica. This attribute is used by the kernel
1727− * to query the CRDA to retrieve one regulatory domain. This attribute can
1728− * also be used by userspace to query the kernel for the currently set
1729− * regulatory domain. We chose an alpha2 as that is also used by the
1730− * IEEE-802.11 country information element to identify a country.
1731− * Users can also simply ask the wireless core to set regulatory domain
1732− * to a specific alpha2.
1725+ * current regulatory domain should be set to or is already set to.
1726+ * For example, 'CR', for Costa Rica. This attribute is used by the kernel
1727+ * to query the CRDA to retrieve one regulatory domain. This attribute can
1728+ * also be used by userspace to query the kernel for the currently set
1729+ * regulatory domain. We chose an alpha2 as that is also used by the
1730+ * IEEE-802.11 country information element to identify a country.
1731+ * Users can also simply ask the wireless core to set regulatory domain
1732+ * to a specific alpha2.
17331733 * @NL80211_ATTR_REG_RULES: a nested array of regulatory domain regulatory
17341734 * rules.
17351735 *
@@ -1772,9 +1772,9 @@ enum nl80211_commands { · 36 unmodified lines
17721772 * @NL80211_ATTR_BSS: scan result BSS
17731773 *
17741774 * @NL80211_ATTR_REG_INITIATOR: indicates who requested the regulatory domain
1775− * currently in effect. This could be any of the %NL80211_REGDOM_SET_BY_*
1775+ * currently in effect. This could be any of the %NL80211_REGDOM_SET_BY_*
17761776 * @NL80211_ATTR_REG_TYPE: indicates the type of the regulatory domain currently
1777− * set. This can be one of the nl80211_reg_type (%NL80211_REGDOM_TYPE_*)
1777+ * set. This can be one of the nl80211_reg_type (%NL80211_REGDOM_TYPE_*)
17781778 *
17791779 * @NL80211_ATTR_SUPPORTED_COMMANDS: wiphy attribute that specifies
17801780 * an array of command numbers (i.e. a mapping index to command number)
@@ -1793,15 +1793,15 @@ enum nl80211_commands { · 12 unmodified lines
17931793 * a u32
17941794 *
17951795 * @NL80211_ATTR_FREQ_BEFORE: A channel which has suffered a regulatory change
1796− * due to considerations from a beacon hint. This attribute reflects
1797− * the state of the channel _before_ the beacon hint processing. This
1798− * attributes consists of a nested attribute containing
1799− * NL80211_FREQUENCY_ATTR_*
1796+ * due to considerations from a beacon hint. This attribute reflects
1797+ * the state of the channel _before_ the beacon hint processing. This
1798+ * attributes consists of a nested attribute containing
1799+ * NL80211_FREQUENCY_ATTR_*
18001800 * @NL80211_ATTR_FREQ_AFTER: A channel which has suffered a regulatory change
1801− * due to considerations from a beacon hint. This attribute reflects
1802− * the state of the channel _after_ the beacon hint processing. This
1803− * attributes consists of a nested attribute containing
1804− * NL80211_FREQUENCY_ATTR_*
1801+ * due to considerations from a beacon hint. This attribute reflects
1802+ * the state of the channel _after_ the beacon hint processing. This
1803+ * attributes consists of a nested attribute containing
1804+ * NL80211_FREQUENCY_ATTR_*
18051805 *
18061806 * @NL80211_ATTR_CIPHER_SUITES: a set of u32 values indicating the supported
18071807 * cipher suites
@@ -2416,7 +2416,7 @@ enum nl80211_commands { · 608 unmodified lines
24162416 * scheduled scan is started. Or the delay before a WoWLAN
24172417 * net-detect scan is started, counting from the moment the
24182418 * system is suspended. This value is a u32, in seconds.
2419−
2419+ *
24202420 * @NL80211_ATTR_REG_INDOOR: flag attribute, if set indicates that the device
24212421 * is operating in an indoor environment.
24222422 *
@@ -3823,7 +3823,7 @@ enum nl80211_sta_bss_param { · 1400 unmodified lines
38233823 * (u64, to this station)
38243824 * @NL80211_STA_INFO_SIGNAL: signal strength of last received PPDU (u8, dBm)
38253825 * @NL80211_STA_INFO_TX_BITRATE: current unicast tx rate, nested attribute
3826− * containing info as possible, see &enum nl80211_rate_info
3826+ * containing info as possible, see &enum nl80211_rate_info
38273827 * @NL80211_STA_INFO_RX_PACKETS: total received packet (MSDUs and MMPDUs)
38283828 * (u32, from this station)
38293829 * @NL80211_STA_INFO_TX_PACKETS: total transmitted packets (MSDUs and MMPDUs)
@@ -4039,7 +4039,7 @@ enum nl80211_mpath_flags { · 209 unmodified lines
40394039 * @NL80211_MPATH_INFO_METRIC: metric (cost) of this mesh path
40404040 * @NL80211_MPATH_INFO_EXPTIME: expiration time for the path, in msec from now
40414041 * @NL80211_MPATH_INFO_FLAGS: mesh path flags, enumerated in
4042− * &enum nl80211_mpath_flags;
4042+ * &enum nl80211_mpath_flags;
40434043 * @NL80211_MPATH_INFO_DISCOVERY_TIMEOUT: total path discovery timeout, in msec
40444044 * @NL80211_MPATH_INFO_DISCOVERY_RETRIES: mesh path discovery retries
40454045 * @NL80211_MPATH_INFO_HOP_COUNT: hop count to destination
@@ -4201,8 +4201,8 @@ enum nl80211_wmm_rule { · 155 unmodified lines
42014201 * @NL80211_FREQUENCY_ATTR_DISABLED: Channel is disabled in current
42024202 * regulatory domain.
42034203 * @NL80211_FREQUENCY_ATTR_NO_IR: no mechanisms that initiate radiation
4204− * are permitted on this channel, this includes sending probe
4205− * requests, or modes of operation that require beaconing.
4204+ * are permitted on this channel, this includes sending probe
4205+ * requests, or modes of operation that require beaconing.
42064206 * @NL80211_FREQUENCY_ATTR_RADAR: Radar detection is mandatory
42074207 * on this channel in current regulatory domain.
42084208 * @NL80211_FREQUENCY_ATTR_MAX_TX_POWER: Maximum transmission power in mBm
@@ -4359,14 +4359,14 @@ enum nl80211_bitrate_attr { · 150 unmodified lines
43594359 /**
43604360 * enum nl80211_initiator - Indicates the initiator of a reg domain request
43614361 * @NL80211_REGDOM_SET_BY_CORE: Core queried CRDA for a dynamic world
4362− * regulatory domain.
4362+ * regulatory domain.
43634363 * @NL80211_REGDOM_SET_BY_USER: User asked the wireless core to set the
4364− * regulatory domain.
4364+ * regulatory domain.
43654365 * @NL80211_REGDOM_SET_BY_DRIVER: a wireless drivers has hinted to the
4366− * wireless core it thinks its knows the regulatory domain we should be in.
4366+ * wireless core it thinks its knows the regulatory domain we should be in.
43674367 * @NL80211_REGDOM_SET_BY_COUNTRY_IE: the wireless core has received an
4368− * 802.11 country information element with regulatory information it
4369− * thinks we should consider. cfg80211 only processes the country
4368+ * 802.11 country information element with regulatory information it
4369+ * thinks we should consider. cfg80211 only processes the country
43704370 * code from the IE, and relies on the regulatory domain information
43714371 * structure passed by userspace (CRDA) from our wireless-regdb.
43724372 * If a channel is enabled but the country code indicates it should
@@ -4385,11 +4385,11 @@ enum nl80211_reg_initiator { · 12 unmodified lines
43854385 * to a specific country. When this is set you can count on the
43864386 * ISO / IEC 3166 alpha2 country code being valid.
43874387 * @NL80211_REGDOM_TYPE_WORLD: the regulatory set domain is the world regulatory
4388− * domain.
4388+ * domain.
43894389 * @NL80211_REGDOM_TYPE_CUSTOM_WORLD: the regulatory domain set is a custom
4390− * driver specific world regulatory domain. These do not apply system-wide
4391− * and are only applicable to the individual devices which have requested
4392− * them to be applied.
4390+ * driver specific world regulatory domain. These do not apply system-wide
4391+ * and are only applicable to the individual devices which have requested
4392+ * them to be applied.
43934393 * @NL80211_REGDOM_TYPE_INTERSECTION: the regulatory domain set is the product
43944394 * of an intersection between two regulatory domains -- the previously
43954395 * set regulatory domain on the system and the last accepted regulatory
@@ -4406,21 +4406,21 @@ enum nl80211_reg_type { · 10 unmodified lines
44064406 * enum nl80211_reg_rule_attr - regulatory rule attributes
44074407 * @__NL80211_REG_RULE_ATTR_INVALID: attribute number 0 is reserved
44084408 * @NL80211_ATTR_REG_RULE_FLAGS: a set of flags which specify additional
4409− * considerations for a given frequency range. These are the
4410− * &enum nl80211_reg_rule_flags.
4409+ * considerations for a given frequency range. These are the
4410+ * &enum nl80211_reg_rule_flags.
44114411 * @NL80211_ATTR_FREQ_RANGE_START: starting frequencry for the regulatory
4412− * rule in KHz. This is not a center of frequency but an actual regulatory
4413− * band edge.
4412+ * rule in KHz. This is not a center of frequency but an actual regulatory
4413+ * band edge.
44144414 * @NL80211_ATTR_FREQ_RANGE_END: ending frequency for the regulatory rule
4415− * in KHz. This is not a center a frequency but an actual regulatory
4416− * band edge.
4415+ * in KHz. This is not a center a frequency but an actual regulatory
4416+ * band edge.
44174417 * @NL80211_ATTR_FREQ_RANGE_MAX_BW: maximum allowed bandwidth for this
44184418 * frequency range, in KHz.
44194419 * @NL80211_ATTR_POWER_RULE_MAX_ANT_GAIN: the maximum allowed antenna gain
4420− * for a given frequency range. The value is in mBi (100 * dBi).
4421− * If you don't have one then don't send this.
4420+ * for a given frequency range. The value is in mBi (100 * dBi).
4421+ * If you don't have one then don't send this.
44224422 * @NL80211_ATTR_POWER_RULE_MAX_EIRP: the maximum allowed EIRP for
4423− * a given frequency range. The value is in mBm (100 * dBm).
4423+ * a given frequency range. The value is in mBm (100 * dBm).
44244424 * @NL80211_ATTR_DFS_CAC_TIME: DFS CAC time in milliseconds.
44254425 * If not present or 0 default CAC time will be used.
44264426 * @NL80211_ATTR_POWER_RULE_PSD: power spectral density (in dBm).
@@ -4507,8 +4507,8 @@ enum nl80211_sched_scan_match_attr { · 80 unmodified lines
45074507 * @NL80211_RRF_PTP_ONLY: this is only for Point To Point links
45084508 * @NL80211_RRF_PTMP_ONLY: this is only for Point To Multi Point links
45094509 * @NL80211_RRF_NO_IR: no mechanisms that initiate radiation are allowed,
4510− * this includes probe requests or modes of operation that require
4511− * beaconing.
4510+ * this includes probe requests or modes of operation that require
4511+ * beaconing.
45124512 * @NL80211_RRF_AUTO_BW: maximum available bandwidth should be calculated
45134513 * base on contiguous rules and wider channels will be allowed to cross
45144514 * multiple contiguous/overlapping frequency ranges.
@@ -4522,9 +4522,9 @@ enum nl80211_sched_scan_match_attr { · 7 unmodified lines
45224522 * @NL80211_RRF_NO_EHT: EHT operation not allowed
45234523 * @NL80211_RRF_PSD: Ruleset has power spectral density value
45244524 * @NL80211_RRF_DFS_CONCURRENT: Operation on this channel is allowed for
4525− peer-to-peer or adhoc communication under the control of a DFS master
4526− which operates on the same channel (FCC-594280 D01 Section B.3).
4527− Should be used together with %NL80211_RRF_DFS only.
4525+ * peer-to-peer or adhoc communication under the control of a DFS master
4526+ * which operates on the same channel (FCC-594280 D01 Section B.3).
4527+ * Should be used together with %NL80211_RRF_DFS only.
45284528 * @NL80211_RRF_NO_6GHZ_VLP_CLIENT: Client connection to VLP AP not allowed
45294529 * @NL80211_RRF_NO_6GHZ_AFC_CLIENT: Client connection to AFC AP not allowed
45304530 */