bcmdhd/include/bcmwifi_channels.h

8  *      Unless you and Broadcom execute a separate written software license
14  *      As a special exception, the copyright holders of this software give you
18  * the license of that module.  An independent module is a module which is not
29 /* A chanspec holds the channel number, band, bandwidth and primary 20MHz sub-band */
48 #define CH_MIN_6G_CHANNEL                 1u    /* Min 20MHz channel in 6G band */
49 #define CH_MAX_6G_CHANNEL               253u    /* Max 20MHz channel in 6G band */
67 #define INVCHANNEL                      255u    /* error value for a bad channel */
69 /* length of channel vector bitmap is the MAXCHANNEL we want to handle rounded up to a byte */
171 /* pass a 80MHz channel number (uint8) to get respective LL, UU, LU, UL */
238 /* pass a center channel and get channel offset from it by 10MHz */
249 /* pass a 160MHz center channel to get 20MHz subband channel numbers */
259 /* get lowest 20MHz sideband of a given chspec
260  * (works with 20, 40, 80, 160)
268 /* get upper most 20MHz sideband of a given chspec
269  * (works with 20, 40, 80, 160)
277 /* call this with chspec and a valid 20MHz sideband of this channel to get the next 20MHz sideband
278  * (works with 20, 40, 80, 160)
296 /* get lowest 20MHz sideband of a given chspec
297  * (works with 20, 40, 80)
303 /* get upper most 20MHz sideband of a given chspec
304  * (works with 20, 40, 80, 160)
311 /* call this with chspec and a valid 20MHz sideband of this channel to get the next 20MHz sideband
312  * (works with 20, 40, 80, 160)
321 /* Iterator for 20MHz side bands of a chanspec: (chanspec_t chspec, uint8 channel)
322  * 'chspec' chanspec_t of interest (used in loop, better to pass a resolved value than a macro)
323  * 'channel' must be a variable (not an expression).
340 /* given a chanspec of any bw, tests if primary20 SB is in lower 20, 40, 80 respectively */
341 #define IS_CTL_IN_L20(chspec) !((chspec) & WL_CHANSPEC_CTL_SB_U) /* CTL SB is in low 20 of any 40 */
385 #define CHANSPEC_STR_LEN    20
453  * given a channel number.
496  * Return the bandwidth string for a given chanspec
513 chanspec_t wf_chspec_aton(const char *a);
516  * Verify the chanspec fields are valid for a chanspec_t
521  * Verify the chanspec specifies a valid channel according to 802.11.
526  * Verify that the channel is a valid 20MHz channel according to 802.11.
531  * Verify that the center channel is a valid 40MHz center channel according to 802.11.
536  * Verify that the center channel is a valid 80MHz center channel according to 802.11.
541  * Verify that the center channel is a valid 160MHz center channel according to 802.11.
546  * Verify that the center channel is a valid 240MHz center channel according to 802.11.
551  * Verify that the center channel is a valid 320MHz center channel according to 802.11.
556  * Create a 20MHz chanspec for the given band.
561  * Returns the chanspec for a 40MHz channel given the primary 20MHz channel number,
568  * Returns the chanspec for a 40MHz channel given the primary 20MHz channel number,
569  * the sub-band for the primary 20MHz channel, and the band.
575  * Returns the chanspec for an 80MHz channel given the primary 20MHz channel number,
582  * Returns the chanspec for an 160MHz channel given the primary 20MHz channel number,
589  * Returns the chanspec for an 240MHz channel given the primary 20MHz channel number,
596  * Returns the chanspec for an 320MHz channel given the primary 20MHz channel number,
603  * Returns the chanspec for an 80+80MHz channel given the primary 20MHz channel number,
610  * Returns the chanspec for an 160+160MHz channel given the primary 20MHz channel number,
616  * Returns the chanspec given the primary 20MHz channel number,
619  * The channel width must be 20, 40, 80, or 160 MHz.
625  * Returns the chanspec given the primary 20MHz channel number,
632  * Returns the chanspec given the index of primary 20MHz channel within whole
635  * The channel width must be 20, 40, 80, or 160 MHz.
641  * Returns the chanspec for an 160+160MHz channel given the index of primary 20MHz
649  * Return the primary 20MHz channel.
657  * Return the primary 20MHz chanspec of a given chanspec
665  * Return the primary 40MHz chanspec for a 40MHz or wider channel
670  * Return the channel number for a given frequency and base frequency
683  *	primary_channel - primary 20Mhz channel
706  *    primary_20mhz - Primary 20 MHz channel
756  * does not contain the primary 20MHz channel.
790  * For 20/40/80MHz chanspec, set ch[0] to be the center freq, and chan[1]=-1
821  * Initialize a chanspec iteration structure.
824  * in the set. A call to wf_chanspec_iter_next() will advance the interation
837  * @param iter  pointer to a wf_chanspec_iter_t structure to initialize
842  * @return a success value, FALSE on error, or TRUE if OK
849  * @param iter    pointer to a wf_chanspec_iter_t structure
853  * @return a success value, TRUE if there was another chanspec in the iteration, FALSE if not
860  * @param iter  pointer to a wf_chanspec_iter_t structure
866 /* Populates array with all 20MHz side bands of a given chanspec_t in the following order:
871  * Works with 20, 40, 80 and 160MHz chspec
878  * (Overlap: At least one 20MHz subband is common between the two chanspecs provided)