{cfg,mac}80211.h: fix some kernel-doc warnings

 * cfg80211_get_chandef_type - return old channel type from chandef

 * @chandef: the channel definition

 *

 * Returns the old channel type (NOHT, HT20, HT40+/-) from a given

 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given

 * chandef, which must have a bandwidth allowing this conversion.

 */

static inline enum nl80211_channel_type

 * @chandef1: first channel definition

 * @chandef2: second channel definition

 *

 * Returns %true if the channels defined by the channel definitions are

 * Return: %true if the channels defined by the channel definitions are

 * identical, %false otherwise.

 */

static inline bool

 * @chandef1: first channel definition

 * @chandef2: second channel definition

 *

 * Returns %NULL if the given channel definitions are incompatible,

 * Return: %NULL if the given channel definitions are incompatible,

 * chandef1 or chandef2 otherwise.

 */

const struct cfg80211_chan_def *

/**

 * cfg80211_chandef_valid - check if a channel definition is valid

 * @chandef: the channel definition to check

 * Return: %true if the channel definition is valid. %false otherwise.

 */

bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);

 * cfg80211_chandef_usable - check if secondary channels can be used

 * @wiphy: the wiphy to validate against

 * @chandef: the channel definition to check

 * @prohibited_flags: the regulatory chanenl flags that must not be set

 * @prohibited_flags: the regulatory channel flags that must not be set

 * Return: %true if secondary channels are usable. %false otherwise.

 */

bool cfg80211_chandef_usable(struct wiphy *wiphy,

			     const struct cfg80211_chan_def *chandef,

 *

 * Note that the return value is an RCU-protected pointer, so

 * rcu_read_lock() must be held when calling this function.

 * Returns %NULL if not found.

 * Return: %NULL if not found.

 */

const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);

 * wiphy_priv - return priv from wiphy

 *

 * @wiphy: the wiphy whose priv pointer to return

 * Return: The priv of @wiphy.

 */

static inline void *wiphy_priv(struct wiphy *wiphy)

{

 * priv_to_wiphy - return the wiphy containing the priv

 *

 * @priv: a pointer previously returned by wiphy_priv

 * Return: The wiphy of @priv.

 */

static inline struct wiphy *priv_to_wiphy(void *priv)

{

 * wiphy_dev - get wiphy dev pointer

 *

 * @wiphy: The wiphy whose device struct to look up

 * Return: The dev of @wiphy.

 */

static inline struct device *wiphy_dev(struct wiphy *wiphy)

{

 * wiphy_name - get wiphy name

 *

 * @wiphy: The wiphy whose name to return

 * Return: The name of @wiphy.

 */

static inline const char *wiphy_name(const struct wiphy *wiphy)

{

 * Create a new wiphy and associate the given operations with it.

 * @sizeof_priv bytes are allocated for private use.

 *

 * The returned pointer must be assigned to each netdev's

 * ieee80211_ptr for proper operation.

 * Return: A pointer to the new wiphy. This pointer must be

 * assigned to each netdev's ieee80211_ptr for proper operation.

 */

struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);

 *

 * @wiphy: The wiphy to register.

 *

 * Returns a non-negative wiphy index or a negative error code.

 * Return: A non-negative wiphy index or a negative error code.

 */

extern int wiphy_register(struct wiphy *wiphy);

 * wdev_priv - return wiphy priv from wireless_dev

 *

 * @wdev: The wireless device whose wiphy's priv pointer to return

 * Return: The wiphy priv of @wdev.

 */

static inline void *wdev_priv(struct wireless_dev *wdev)

{

 * ieee80211_channel_to_frequency - convert channel number to frequency

 * @chan: channel number

 * @band: band, necessary due to channel number overlap

 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.

 */

extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);

/**

 * ieee80211_frequency_to_channel - convert frequency to channel number

 * @freq: center frequency

 * Return: The corresponding channel, or 0 if the conversion failed.

 */

extern int ieee80211_frequency_to_channel(int freq);

 * ieee80211_get_channel - get channel struct from wiphy for specified frequency

 * @wiphy: the struct wiphy to get the channel for

 * @freq: the center frequency of the channel

 * Return: The channel struct from @wiphy at @freq.

 */

static inline struct ieee80211_channel *

ieee80211_get_channel(struct wiphy *wiphy, int freq)

 * @basic_rates: bitmap of basic rates

 * @bitrate: the bitrate for which to find the basic rate

 *

 * This function returns the basic rate corresponding to a given

 * bitrate, that is the next lower bitrate contained in the basic

 * rate map, which is, for this function, given as a bitmap of

 * indices of rates in the band's bitrate table.

 * Return: The basic rate corresponding to a given bitrate, that

 * is the next lower bitrate contained in the basic rate map,

 * which is, for this function, given as a bitmap of indices of

 * rates in the band's bitrate table.

 */

struct ieee80211_rate *

ieee80211_get_response_rate(struct ieee80211_supported_band *sband,

/**

 * ieee80211_get_hdrlen_from_skb - get header length from data

 *

 * @skb: the frame

 *

 * Given an skb with a raw 802.11 header at the data pointer this function

 * returns the 802.11 header length in bytes (not including encryption

 * headers). If the data in the sk_buff is too short to contain a valid 802.11

 * header the function returns 0.

 * returns the 802.11 header length.

 *

 * @skb: the frame

 * Return: The 802.11 header length in bytes (not including encryption

 * headers). Or 0 if the data in the sk_buff is too short to contain a valid

 * 802.11 header.

 */

unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);

/**

 * ieee80211_hdrlen - get header length in bytes from frame control

 * @fc: frame control field in little-endian format

 * Return: The header length in bytes.

 */

unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);

 * ieee80211_get_mesh_hdrlen - get mesh extension header length

 * @meshhdr: the mesh extension header, only the flags field

 *	(first byte) will be accessed

 * Returns the length of the extension header, which is always at

 * Return: The length of the extension header, which is always at

 * least 6 bytes and at most 18 if address 5 and 6 are present.

 */

unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);

 * @skb: the 802.11 data frame

 * @addr: the device MAC address

 * @iftype: the virtual interface type

 * Return: 0 on success. Non-zero on error.

 */

int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,

			   enum nl80211_iftype iftype);

 * @iftype: the virtual interface type

 * @bssid: the network bssid (used only for iftype STATION and ADHOC)

 * @qos: build 802.11 QoS data frame

 * Return: 0 on success, or a negative error code.

 */

int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,

			     enum nl80211_iftype iftype, u8 *bssid, bool qos);

/**

 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame

 * @skb: the data frame

 * Return: The 802.1p/1d tag.

 */

unsigned int cfg80211_classify8021d(struct sk_buff *skb);

 * @ies: data consisting of IEs

 * @len: length of data

 *

 * This function will return %NULL if the element ID could

 * not be found or if the element is invalid (claims to be

 * longer than the given data), or a pointer to the first byte

 * of the requested element, that is the byte containing the

 * element ID. There are no checks on the element length

 * other than having to fit into the given data.

 * Return: %NULL if the element ID could not be found or if

 * the element is invalid (claims to be longer than the given

 * data), or a pointer to the first byte of the requested

 * element, that is the byte containing the element ID.

 *

 * Note: There are no checks on the element length other than

 * having to fit into the given data.

 */

const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);

 * @ies: data consisting of IEs

 * @len: length of data

 *

 * This function will return %NULL if the vendor specific element ID

 * could not be found or if the element is invalid (claims to be

 * longer than the given data), or a pointer to the first byte

 * of the requested element, that is the byte containing the

 * element ID. There are no checks on the element length

 * other than having to fit into the given data.

 * Return: %NULL if the vendor specific element ID could not be found or if the

 * element is invalid (claims to be longer than the given data), or a pointer to

 * the first byte of the requested element, that is the byte containing the

 * element ID.

 *

 * Note: There are no checks on the element length other than having to fit into

 * the given data.

 */

const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,

				  const u8 *ies, int len);

 *

 * Drivers should check the return value, its possible you can get

 * an -ENOMEM.

 *

 * Return: 0 on success. -ENOMEM.

 */

extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);

 * it wants to follow we respect that unless a country IE has been received

 * and processed already.

 *

 * When an error occurs, for example if no rule can be found, the return value

 * is encoded using ERR_PTR(). Use IS_ERR() to check and PTR_ERR() to obtain

 * the numeric return value. The numeric return value will be -ERANGE if we

 * determine the given center_freq does not even have a regulatory rule for a

 * frequency range in the center_freq's band. See freq_in_rule_band() for our

 * current definition of a band -- this is purely subjective and right now it's

 * 802.11 specific.

 * Return: A valid pointer, or, when an error occurs, for example if no rule

 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to

 * check and PTR_ERR() to obtain the numeric return value. The numeric return

 * value will be -ERANGE if we determine the given center_freq does not even

 * have a regulatory rule for a frequency range in the center_freq's band.

 * See freq_in_rule_band() for our current definition of a band -- this is

 * purely subjective and right now it's 802.11 specific.

 */

const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,

					       u32 center_freq);

 * This informs cfg80211 that BSS information was found and

 * the BSS should be updated/added.

 *

 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!

 * Return: A referenced struct, must be released with cfg80211_put_bss()!

 * Or %NULL on error.

 */

struct cfg80211_bss * __must_check

cfg80211_inform_bss_frame(struct wiphy *wiphy,

 * This informs cfg80211 that BSS information was found and

 * the BSS should be updated/added.

 *

 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!

 * Return: A referenced struct, must be released with cfg80211_put_bss()!

 * Or %NULL on error.

 */

struct cfg80211_bss * __must_check

cfg80211_inform_bss(struct wiphy *wiphy,

 * the testmode command. Since it is intended for a reply, calling

 * it outside of the @testmode_cmd operation is invalid.

 *

 * The returned skb (or %NULL if any errors happen) is pre-filled

 * with the wiphy index and set up in a way that any data that is

 * put into the skb (with skb_put(), nla_put() or similar) will end

 * up being within the %NL80211_ATTR_TESTDATA attribute, so all that

 * needs to be done with the skb is adding data for the corresponding

 * userspace tool which can then read that data out of the testdata

 * attribute. You must not modify the skb in any other way.

 * The returned skb is pre-filled with the wiphy index and set up in

 * a way that any data that is put into the skb (with skb_put(),

 * nla_put() or similar) will end up being within the

 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done

 * with the skb is adding data for the corresponding userspace tool

 * which can then read that data out of the testdata attribute. You

 * must not modify the skb in any other way.

 *

 * When done, call cfg80211_testmode_reply() with the skb and return

 * its error code as the result of the @testmode_cmd operation.

 *

 * Return: An allocated and pre-filled skb. %NULL if any errors happen.

 */

struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,

						  int approxlen);

 * @skb: The skb, must have been allocated with

 *	cfg80211_testmode_alloc_reply_skb()

 *

 * Returns an error code or 0 on success, since calling this

 * function will usually be the last thing before returning

 * from the @testmode_cmd you should return the error code.

 * Note that this function consumes the skb regardless of the

 * return value.

 * Since calling this function will usually be the last thing

 * before returning from the @testmode_cmd you should return

 * the error code.  Note that this function consumes the skb

 * regardless of the return value.

 *

 * Return: An error code or 0 on success.

 */

int cfg80211_testmode_reply(struct sk_buff *skb);

 * This function allocates and pre-fills an skb for an event on the

 * testmode multicast group.

 *

 * The returned skb (or %NULL if any errors happen) is set up in the

 * same way as with cfg80211_testmode_alloc_reply_skb() but prepared

 * for an event. As there, you should simply add data to it that will

 * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must

 * not modify the skb in any other way.

 * The returned skb is set up in the same way as with

 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As

 * there, you should simply add data to it that will then end up in the

 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb

 * in any other way.

 *

 * When done filling the skb, call cfg80211_testmode_event() with the

 * skb to send the event.

 *

 * Return: An allocated and pre-filled skb. %NULL if any errors happen.

 */

struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,

						  int approxlen, gfp_t gfp);

 * @len: length of the frame data

 * @gfp: context flags

 *

 * Returns %true if a user space application has registered for this frame.

 * This function is called whenever an Action frame is received for a station

 * mode interface, but is not processed in kernel.

 *

 * Return: %true if a user space application has registered for this frame.

 * For action frames, that makes it responsible for rejecting unrecognized

 * action frames; %false otherwise, in which case for action frames the

 * driver is responsible for rejecting the frame.

 *

 * This function is called whenever an Action frame is received for a station

 * mode interface, but is not processed in kernel.

 */

bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,

		      const u8 *buf, size_t len, gfp_t gfp);

 * This function is used in AP mode (only!) to inform userspace that

 * a spurious class 3 frame was received, to be able to deauth the

 * sender.

 * Returns %true if the frame was passed to userspace (or this failed

 * Return: %true if the frame was passed to userspace (or this failed

 * for a reason other than not having a subscription.)

 */

bool cfg80211_rx_spurious_frame(struct net_device *dev,

 * an associated station sent a 4addr frame but that wasn't expected.

 * It is allowed and desirable to send this event only once for each

 * station to avoid event flooding.

 * Returns %true if the frame was passed to userspace (or this failed

 * Return: %true if the frame was passed to userspace (or this failed

 * for a reason other than not having a subscription.)

 */

bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,

 * @wiphy: the wiphy

 * @chandef: the channel definition

 *

 * This function returns true if there is no secondary channel or the secondary

 * channel(s) can be used for beaconing (i.e. is not a radar channel etc.)

 * Return: %true if there is no secondary channel or the secondary channel(s)

 * can be used for beaconing (i.e. is not a radar channel etc.)

 */

bool cfg80211_reg_can_beacon(struct wiphy *wiphy,

			     struct cfg80211_chan_def *chandef);

 * The function finds a given P2P attribute in the (vendor) IEs and

 * copies its contents to the given buffer.

 *

 * The return value is a negative error code (-%EILSEQ or -%ENOENT) if

 * the data is malformed or the attribute can't be found (respectively),

 * or the length of the found attribute (which can be zero).

 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is

 * malformed or the attribute can't be found (respectively), or the

 * length of the found attribute (which can be zero).

 */

int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,

			  enum ieee80211_p2p_attr_id attr,