| /* |
| * Copyright (c) 2010 Broadcom Corporation |
| * |
| * Permission to use, copy, modify, and/or distribute this software for any |
| * purpose with or without fee is hereby granted, provided that the above |
| * copyright notice and this permission notice appear in all copies. |
| * |
| * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
| * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
| * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY |
| * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
| * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION |
| * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN |
| * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| */ |
| |
| #ifndef _bcmwifi_h_ |
| #define _bcmwifi_h_ |
| |
| /* A chanspec holds the channel number, band, bandwidth and control sideband */ |
| typedef u16 chanspec_t; |
| |
| /* channel defines */ |
| #define CH_UPPER_SB 0x01 |
| #define CH_LOWER_SB 0x02 |
| #define CH_EWA_VALID 0x04 |
| #define CH_20MHZ_APART 4 |
| #define CH_10MHZ_APART 2 |
| #define CH_5MHZ_APART 1 /* 2G band channels are 5 Mhz apart */ |
| #define CH_MAX_2G_CHANNEL 14 /* Max channel in 2G band */ |
| #define WLC_MAX_2G_CHANNEL CH_MAX_2G_CHANNEL /* legacy define */ |
| #define MAXCHANNEL 224 /* max # supported channels. The max channel no is 216, |
| * this is that + 1 rounded up to a multiple of NBBY (8). |
| * DO NOT MAKE it > 255: channels are u8's all over |
| */ |
| |
| #define WL_CHANSPEC_CHAN_MASK 0x00ff |
| #define WL_CHANSPEC_CHAN_SHIFT 0 |
| |
| #define WL_CHANSPEC_CTL_SB_MASK 0x0300 |
| #define WL_CHANSPEC_CTL_SB_SHIFT 8 |
| #define WL_CHANSPEC_CTL_SB_LOWER 0x0100 |
| #define WL_CHANSPEC_CTL_SB_UPPER 0x0200 |
| #define WL_CHANSPEC_CTL_SB_NONE 0x0300 |
| |
| #define WL_CHANSPEC_BW_MASK 0x0C00 |
| #define WL_CHANSPEC_BW_SHIFT 10 |
| #define WL_CHANSPEC_BW_10 0x0400 |
| #define WL_CHANSPEC_BW_20 0x0800 |
| #define WL_CHANSPEC_BW_40 0x0C00 |
| |
| #define WL_CHANSPEC_BAND_MASK 0xf000 |
| #define WL_CHANSPEC_BAND_SHIFT 12 |
| #define WL_CHANSPEC_BAND_5G 0x1000 |
| #define WL_CHANSPEC_BAND_2G 0x2000 |
| #define INVCHANSPEC 255 |
| |
| /* used to calculate the chan_freq = chan_factor * 500Mhz + 5 * chan_number */ |
| #define WF_CHAN_FACTOR_2_4_G 4814 /* 2.4 GHz band, 2407 MHz */ |
| #define WF_CHAN_FACTOR_5_G 10000 /* 5 GHz band, 5000 MHz */ |
| #define WF_CHAN_FACTOR_4_G 8000 /* 4.9 GHz band for Japan */ |
| |
| /* channel defines */ |
| #define LOWER_20_SB(channel) (((channel) > CH_10MHZ_APART) ? ((channel) - CH_10MHZ_APART) : 0) |
| #define UPPER_20_SB(channel) (((channel) < (MAXCHANNEL - CH_10MHZ_APART)) ? \ |
| ((channel) + CH_10MHZ_APART) : 0) |
| #define CHSPEC_WLCBANDUNIT(chspec) (CHSPEC_IS5G(chspec) ? BAND_5G_INDEX : BAND_2G_INDEX) |
| #define CH20MHZ_CHSPEC(channel) (chanspec_t)((chanspec_t)(channel) | WL_CHANSPEC_BW_20 | \ |
| WL_CHANSPEC_CTL_SB_NONE | (((channel) <= CH_MAX_2G_CHANNEL) ? \ |
| WL_CHANSPEC_BAND_2G : WL_CHANSPEC_BAND_5G)) |
| #define NEXT_20MHZ_CHAN(channel) (((channel) < (MAXCHANNEL - CH_20MHZ_APART)) ? \ |
| ((channel) + CH_20MHZ_APART) : 0) |
| #define CH40MHZ_CHSPEC(channel, ctlsb) (chanspec_t) \ |
| ((channel) | (ctlsb) | WL_CHANSPEC_BW_40 | \ |
| ((channel) <= CH_MAX_2G_CHANNEL ? WL_CHANSPEC_BAND_2G : \ |
| WL_CHANSPEC_BAND_5G)) |
| #define CHSPEC_CHANNEL(chspec) ((u8)((chspec) & WL_CHANSPEC_CHAN_MASK)) |
| #define CHSPEC_BAND(chspec) ((chspec) & WL_CHANSPEC_BAND_MASK) |
| |
| #ifdef WL11N_20MHZONLY |
| |
| #define CHSPEC_CTL_SB(chspec) WL_CHANSPEC_CTL_SB_NONE |
| #define CHSPEC_BW(chspec) WL_CHANSPEC_BW_20 |
| #define CHSPEC_IS10(chspec) 0 |
| #define CHSPEC_IS20(chspec) 1 |
| #ifndef CHSPEC_IS40 |
| #define CHSPEC_IS40(chspec) 0 |
| #endif |
| |
| #else /* !WL11N_20MHZONLY */ |
| |
| #define CHSPEC_CTL_SB(chspec) ((chspec) & WL_CHANSPEC_CTL_SB_MASK) |
| #define CHSPEC_BW(chspec) ((chspec) & WL_CHANSPEC_BW_MASK) |
| #define CHSPEC_IS10(chspec) (((chspec) & WL_CHANSPEC_BW_MASK) == WL_CHANSPEC_BW_10) |
| #define CHSPEC_IS20(chspec) (((chspec) & WL_CHANSPEC_BW_MASK) == WL_CHANSPEC_BW_20) |
| #ifndef CHSPEC_IS40 |
| #define CHSPEC_IS40(chspec) (((chspec) & WL_CHANSPEC_BW_MASK) == WL_CHANSPEC_BW_40) |
| #endif |
| |
| #endif /* !WL11N_20MHZONLY */ |
| |
| #define CHSPEC_IS5G(chspec) (((chspec) & WL_CHANSPEC_BAND_MASK) == WL_CHANSPEC_BAND_5G) |
| #define CHSPEC_IS2G(chspec) (((chspec) & WL_CHANSPEC_BAND_MASK) == WL_CHANSPEC_BAND_2G) |
| #define CHSPEC_SB_NONE(chspec) (((chspec) & WL_CHANSPEC_CTL_SB_MASK) == WL_CHANSPEC_CTL_SB_NONE) |
| #define CHSPEC_SB_UPPER(chspec) (((chspec) & WL_CHANSPEC_CTL_SB_MASK) == WL_CHANSPEC_CTL_SB_UPPER) |
| #define CHSPEC_SB_LOWER(chspec) (((chspec) & WL_CHANSPEC_CTL_SB_MASK) == WL_CHANSPEC_CTL_SB_LOWER) |
| #define CHSPEC_CTL_CHAN(chspec) ((CHSPEC_SB_LOWER(chspec)) ? \ |
| (LOWER_20_SB(((chspec) & WL_CHANSPEC_CHAN_MASK))) : \ |
| (UPPER_20_SB(((chspec) & WL_CHANSPEC_CHAN_MASK)))) |
| #define CHSPEC2WLC_BAND(chspec) (CHSPEC_IS5G(chspec) ? WLC_BAND_5G : WLC_BAND_2G) |
| |
| #define CHANSPEC_STR_LEN 8 |
| |
| /* defined rate in 500kbps */ |
| #define WLC_MAXRATE 108 /* in 500kbps units */ |
| #define WLC_RATE_1M 2 /* in 500kbps units */ |
| #define WLC_RATE_2M 4 /* in 500kbps units */ |
| #define WLC_RATE_5M5 11 /* in 500kbps units */ |
| #define WLC_RATE_11M 22 /* in 500kbps units */ |
| #define WLC_RATE_6M 12 /* in 500kbps units */ |
| #define WLC_RATE_9M 18 /* in 500kbps units */ |
| #define WLC_RATE_12M 24 /* in 500kbps units */ |
| #define WLC_RATE_18M 36 /* in 500kbps units */ |
| #define WLC_RATE_24M 48 /* in 500kbps units */ |
| #define WLC_RATE_36M 72 /* in 500kbps units */ |
| #define WLC_RATE_48M 96 /* in 500kbps units */ |
| #define WLC_RATE_54M 108 /* in 500kbps units */ |
| |
| #define WLC_2G_25MHZ_OFFSET 5 /* 2.4GHz band channel offset */ |
| |
| /* |
| * Verify the chanspec is using a legal set of parameters, i.e. that the |
| * chanspec specified a band, bw, ctl_sb and channel and that the |
| * combination could be legal given any set of circumstances. |
| * RETURNS: true is the chanspec is malformed, false if it looks good. |
| */ |
| extern bool wf_chspec_malformed(chanspec_t chanspec); |
| |
| /* |
| * This function returns the channel number that control traffic is being sent on, for legacy |
| * channels this is just the channel number, for 40MHZ channels it is the upper or lowre 20MHZ |
| * sideband depending on the chanspec selected |
| */ |
| extern u8 wf_chspec_ctlchan(chanspec_t chspec); |
| |
| /* |
| * This function returns the chanspec that control traffic is being sent on, for legacy |
| * channels this is just the chanspec, for 40MHZ channels it is the upper or lowre 20MHZ |
| * sideband depending on the chanspec selected |
| */ |
| extern chanspec_t wf_chspec_ctlchspec(chanspec_t chspec); |
| |
| /* |
| * Return the channel number for a given frequency and base frequency. |
| * The returned channel number is relative to the given base frequency. |
| * If the given base frequency is zero, a base frequency of 5 GHz is assumed for |
| * frequencies from 5 - 6 GHz, and 2.407 GHz is assumed for 2.4 - 2.5 GHz. |
| * |
| * Frequency is specified in MHz. |
| * The base frequency is specified as (start_factor * 500 kHz). |
| * Constants WF_CHAN_FACTOR_2_4_G, WF_CHAN_FACTOR_5_G are defined for |
| * 2.4 GHz and 5 GHz bands. |
| * |
| * The returned channel will be in the range [1, 14] in the 2.4 GHz band |
| * and [0, 200] otherwise. |
| * -1 is returned if the start_factor is WF_CHAN_FACTOR_2_4_G and the |
| * frequency is not a 2.4 GHz channel, or if the frequency is not and even |
| * multiple of 5 MHz from the base frequency to the base plus 1 GHz. |
| * |
| * Reference 802.11 REVma, section 17.3.8.3, and 802.11B section 18.4.6.2 |
| */ |
| extern int wf_mhz2channel(uint freq, uint start_factor); |
| |
| /* |
| * Return the center frequency in MHz of the given channel and base frequency. |
| * The channel number is interpreted relative to the given base frequency. |
| * |
| * The valid channel range is [1, 14] in the 2.4 GHz band and [0, 200] otherwise. |
| * The base frequency is specified as (start_factor * 500 kHz). |
| * Constants WF_CHAN_FACTOR_2_4_G, WF_CHAN_FACTOR_5_G are defined for |
| * 2.4 GHz and 5 GHz bands. |
| * The channel range of [1, 14] is only checked for a start_factor of |
| * WF_CHAN_FACTOR_2_4_G (4814). |
| * Odd start_factors produce channels on .5 MHz boundaries, in which case |
| * the answer is rounded down to an integral MHz. |
| * -1 is returned for an out of range channel. |
| * |
| * Reference 802.11 REVma, section 17.3.8.3, and 802.11B section 18.4.6.2 |
| */ |
| extern int wf_channel2mhz(uint channel, uint start_factor); |
| |
| #endif /* _bcmwifi_h_ */ |
