Commit 1dcf396b authored by Dmitry Antipov's avatar Dmitry Antipov Committed by Johannes Berg
Browse files

wifi: cfg80211: improve documentation for flag fields 



Fix and hopefully improve documentation for 'flag' fields of
a few types by adding references to relevant enumerations.

Signed-off-by: default avatarDmitry Antipov <dmantipov@yandex.ru>
Link: https://lore.kernel.org/r/20230713132957.275859-1-dmantipov@yandex.ru


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

include/net/cfg80211.h

+6 −6
Original line number Diff line number Diff line
@@ -263,7 +263,7 @@ enum ieee80211_privacy { 
 * are only for driver use when pointers to this structure are

 * passed around.

 *

 * @flags: rate-specific flags

 * @flags: rate-specific flags from &enum ieee80211_rate_flags

 * @bitrate: bitrate in units of 100 Kbps

 * @hw_value: driver/hardware value for this rate

 * @hw_value_short: driver/hardware value for this rate when
@@ -1353,7 +1353,7 @@ struct cfg80211_unsol_bcast_probe_resp { 
 * @twt_responder: Enable Target Wait Time

 * @he_required: stations must support HE

 * @sae_h2e_required: stations must support direct H2E technique in SAE

 * @flags: flags, as defined in enum cfg80211_ap_settings_flags

 * @flags: flags, as defined in &enum nl80211_ap_settings_flags

 * @he_obss_pd: OBSS Packet Detection settings

 * @he_oper: HE operation IE (or %NULL if HE isn't enabled)

 * @fils_discovery: FILS discovery transmission parameters
@@ -2156,7 +2156,7 @@ enum mpath_info_flags { 
 * @sn: target sequence number

 * @metric: metric (cost) of this mesh path

 * @exptime: expiration time for the mesh path from now, in msecs

 * @flags: mesh path flags

 * @flags: mesh path flags from &enum mesh_path_flags

 * @discovery_timeout: total mesh path discovery timeout, in msecs

 * @discovery_retries: mesh path discovery retries

 * @generation: generation number for nl80211 dumps.
@@ -2496,7 +2496,7 @@ struct cfg80211_scan_6ghz_params { 
 *	the actual dwell time may be shorter.

 * @duration_mandatory: if set, the scan duration must be as specified by the

 *	%duration field.

 * @flags: bit field of flags controlling operation

 * @flags: control flags from &enum nl80211_scan_flags

 * @rates: bitmap of rates to advertise for each band

 * @wiphy: the wiphy this was for

 * @scan_start: time (in jiffies) when the scan started
@@ -2616,7 +2616,7 @@ struct cfg80211_bss_select_adjust { 
 * @scan_width: channel width for scanning

 * @ie: optional information element(s) to add into Probe Request or %NULL

 * @ie_len: length of ie in octets

 * @flags: bit field of flags controlling operation

 * @flags: control flags from &enum nl80211_scan_flags

 * @match_sets: sets of parameters to be matched for a scan result

 *	entry to be considered valid and to be passed to the host

 *	(others are filtered out).
@@ -8118,7 +8118,7 @@ void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr, 
 * @link_id: the ID of the link the frame was received	on

 * @buf: Management frame (header + body)

 * @len: length of the frame data

 * @flags: flags, as defined in enum nl80211_rxmgmt_flags

 * @flags: flags, as defined in &enum nl80211_rxmgmt_flags

 * @rx_tstamp: Hardware timestamp of frame RX in nanoseconds

 * @ack_tstamp: Hardware timestamp of ack TX in nanoseconds

 */