Resync with broadcom drivers 5.100.138.20 and utilities.
[tomato.git] / release / src-rt / include / bcmwifi.h
blobbf9b72dfe50612b69520fa15cef08046d275d946
1 /*
2 * Misc utility routines for WL and Apps
3 * This header file housing the define and function prototype use by
4 * both the wl driver, tools & Apps.
6 * Copyright (C) 2010, Broadcom Corporation. All Rights Reserved.
7 *
8 * Permission to use, copy, modify, and/or distribute this software for any
9 * purpose with or without fee is hereby granted, provided that the above
10 * copyright notice and this permission notice appear in all copies.
12 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
15 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
17 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
18 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 * $Id: bcmwifi.h,v 1.29.16.1 2010-08-25 22:06:55 Exp $
23 #ifndef _bcmwifi_h_
24 #define _bcmwifi_h_
27 /* A chanspec holds the channel number, band, bandwidth and control sideband */
28 typedef uint16 chanspec_t;
30 /* channel defines */
31 #define CH_UPPER_SB 0x01
32 #define CH_LOWER_SB 0x02
33 #define CH_EWA_VALID 0x04
34 #define CH_20MHZ_APART 4
35 #define CH_10MHZ_APART 2
36 #define CH_5MHZ_APART 1 /* 2G band channels are 5 Mhz apart */
37 #define CH_MAX_2G_CHANNEL 14 /* Max channel in 2G band */
38 #define WLC_MAX_2G_CHANNEL CH_MAX_2G_CHANNEL /* legacy define */
39 #define MAXCHANNEL 224 /* max # supported channels. The max channel no is 216,
40 * this is that + 1 rounded up to a multiple of NBBY (8).
41 * DO NOT MAKE it > 255: channels are uint8's all over
43 #define CHSPEC_CTLOVLP(sp1, sp2, sep) ABS(wf_chspec_ctlchan(sp1) - wf_chspec_ctlchan(sp2)) < (sep)
45 #define WL_CHANSPEC_CHAN_MASK 0x00ff
46 #define WL_CHANSPEC_CHAN_SHIFT 0
48 #define WL_CHANSPEC_CTL_SB_MASK 0x0300
49 #define WL_CHANSPEC_CTL_SB_SHIFT 8
50 #define WL_CHANSPEC_CTL_SB_LOWER 0x0100
51 #define WL_CHANSPEC_CTL_SB_UPPER 0x0200
52 #define WL_CHANSPEC_CTL_SB_NONE 0x0300
54 #define WL_CHANSPEC_BW_MASK 0x0C00
55 #define WL_CHANSPEC_BW_SHIFT 10
56 #define WL_CHANSPEC_BW_10 0x0400
57 #define WL_CHANSPEC_BW_20 0x0800
58 #define WL_CHANSPEC_BW_40 0x0C00
60 #define WL_CHANSPEC_BAND_MASK 0xf000
61 #define WL_CHANSPEC_BAND_SHIFT 12
62 #define WL_CHANSPEC_BAND_5G 0x1000
63 #define WL_CHANSPEC_BAND_2G 0x2000
64 #define INVCHANSPEC 255
66 /* used to calculate the chan_freq = chan_factor * 500Mhz + 5 * chan_number */
67 #define WF_CHAN_FACTOR_2_4_G 4814 /* 2.4 GHz band, 2407 MHz */
68 #define WF_CHAN_FACTOR_5_G 10000 /* 5 GHz band, 5000 MHz */
69 #define WF_CHAN_FACTOR_4_G 8000 /* 4.9 GHz band for Japan */
71 /* channel defines */
72 #define LOWER_20_SB(channel) (((channel) > CH_10MHZ_APART) ? ((channel) - CH_10MHZ_APART) : 0)
73 #define UPPER_20_SB(channel) (((channel) < (MAXCHANNEL - CH_10MHZ_APART)) ? \
74 ((channel) + CH_10MHZ_APART) : 0)
75 #define CHSPEC_WLCBANDUNIT(chspec) (CHSPEC_IS5G(chspec) ? BAND_5G_INDEX : BAND_2G_INDEX)
76 #define CH20MHZ_CHSPEC(channel) (chanspec_t)((chanspec_t)(channel) | WL_CHANSPEC_BW_20 | \
77 WL_CHANSPEC_CTL_SB_NONE | (((channel) <= CH_MAX_2G_CHANNEL) ? \
78 WL_CHANSPEC_BAND_2G : WL_CHANSPEC_BAND_5G))
79 #define NEXT_20MHZ_CHAN(channel) (((channel) < (MAXCHANNEL - CH_20MHZ_APART)) ? \
80 ((channel) + CH_20MHZ_APART) : 0)
81 #define CH40MHZ_CHSPEC(channel, ctlsb) (chanspec_t) \
82 ((channel) | (ctlsb) | WL_CHANSPEC_BW_40 | \
83 ((channel) <= CH_MAX_2G_CHANNEL ? WL_CHANSPEC_BAND_2G : \
84 WL_CHANSPEC_BAND_5G))
85 #define CHSPEC_CHANNEL(chspec) ((uint8)((chspec) & WL_CHANSPEC_CHAN_MASK))
86 #define CHSPEC_BAND(chspec) ((chspec) & WL_CHANSPEC_BAND_MASK)
88 #ifdef WL11N_20MHZONLY
90 #define CHSPEC_CTL_SB(chspec) WL_CHANSPEC_CTL_SB_NONE
91 #define CHSPEC_BW(chspec) WL_CHANSPEC_BW_20
92 #define CHSPEC_IS10(chspec) 0
93 #define CHSPEC_IS20(chspec) 1
94 #ifndef CHSPEC_IS40
95 #define CHSPEC_IS40(chspec) 0
96 #endif
98 #else /* !WL11N_20MHZONLY */
100 #define CHSPEC_CTL_SB(chspec) ((chspec) & WL_CHANSPEC_CTL_SB_MASK)
101 #define CHSPEC_BW(chspec) ((chspec) & WL_CHANSPEC_BW_MASK)
102 #define CHSPEC_IS10(chspec) (((chspec) & WL_CHANSPEC_BW_MASK) == WL_CHANSPEC_BW_10)
103 #define CHSPEC_IS20(chspec) (((chspec) & WL_CHANSPEC_BW_MASK) == WL_CHANSPEC_BW_20)
104 #ifndef CHSPEC_IS40
105 #define CHSPEC_IS40(chspec) (((chspec) & WL_CHANSPEC_BW_MASK) == WL_CHANSPEC_BW_40)
106 #endif
108 #endif /* !WL11N_20MHZONLY */
110 #define CHSPEC_IS5G(chspec) (((chspec) & WL_CHANSPEC_BAND_MASK) == WL_CHANSPEC_BAND_5G)
111 #define CHSPEC_IS2G(chspec) (((chspec) & WL_CHANSPEC_BAND_MASK) == WL_CHANSPEC_BAND_2G)
112 #define CHSPEC_SB_NONE(chspec) (((chspec) & WL_CHANSPEC_CTL_SB_MASK) == WL_CHANSPEC_CTL_SB_NONE)
113 #define CHSPEC_SB_UPPER(chspec) (((chspec) & WL_CHANSPEC_CTL_SB_MASK) == WL_CHANSPEC_CTL_SB_UPPER)
114 #define CHSPEC_SB_LOWER(chspec) (((chspec) & WL_CHANSPEC_CTL_SB_MASK) == WL_CHANSPEC_CTL_SB_LOWER)
115 #define CHSPEC_CTL_CHAN(chspec) ((CHSPEC_SB_LOWER(chspec)) ? \
116 (LOWER_20_SB(((chspec) & WL_CHANSPEC_CHAN_MASK))) : \
117 (UPPER_20_SB(((chspec) & WL_CHANSPEC_CHAN_MASK))))
118 #define CHSPEC2WLC_BAND(chspec) (CHSPEC_IS5G(chspec) ? WLC_BAND_5G : WLC_BAND_2G)
120 #define CHANSPEC_STR_LEN 8
122 /* defined rate in 500kbps */
123 #define WLC_MAXRATE 108 /* in 500kbps units */
124 #define WLC_RATE_1M 2 /* in 500kbps units */
125 #define WLC_RATE_2M 4 /* in 500kbps units */
126 #define WLC_RATE_5M5 11 /* in 500kbps units */
127 #define WLC_RATE_11M 22 /* in 500kbps units */
128 #define WLC_RATE_6M 12 /* in 500kbps units */
129 #define WLC_RATE_9M 18 /* in 500kbps units */
130 #define WLC_RATE_12M 24 /* in 500kbps units */
131 #define WLC_RATE_18M 36 /* in 500kbps units */
132 #define WLC_RATE_24M 48 /* in 500kbps units */
133 #define WLC_RATE_36M 72 /* in 500kbps units */
134 #define WLC_RATE_48M 96 /* in 500kbps units */
135 #define WLC_RATE_54M 108 /* in 500kbps units */
137 #define WLC_2G_25MHZ_OFFSET 5 /* 2.4GHz band channel offset */
140 * Convert chanspec to ascii string
141 * @param chspec chanspec format
142 * @param buf ascii string of chanspec
143 * @return pointer to buf with room for at least CHANSPEC_STR_LEN bytes
145 extern char * wf_chspec_ntoa(chanspec_t chspec, char *buf);
148 * Convert ascii string to chanspec
149 * @param a pointer to input string
150 * @return >= 0 if successful or 0 otherwise
152 extern chanspec_t wf_chspec_aton(char *a);
155 * Verify the chanspec is using a legal set of parameters, i.e. that the
156 * chanspec specified a band, bw, ctl_sb and channel and that the
157 * combination could be legal given any set of circumstances.
158 * RETURNS: TRUE is the chanspec is malformed, false if it looks good.
160 extern bool wf_chspec_malformed(chanspec_t chanspec);
163 * This function returns the channel number that control traffic is being sent on, for legacy
164 * channels this is just the channel number, for 40MHZ channels it is the upper or lowre 20MHZ
165 * sideband depending on the chanspec selected
167 extern uint8 wf_chspec_ctlchan(chanspec_t chspec);
170 * This function returns the chanspec that control traffic is being sent on, for legacy
171 * channels this is just the chanspec, for 40MHZ channels it is the upper or lowre 20MHZ
172 * sideband depending on the chanspec selected
174 extern chanspec_t wf_chspec_ctlchspec(chanspec_t chspec);
177 * Return the channel number for a given frequency and base frequency.
178 * The returned channel number is relative to the given base frequency.
179 * If the given base frequency is zero, a base frequency of 5 GHz is assumed for
180 * frequencies from 5 - 6 GHz, and 2.407 GHz is assumed for 2.4 - 2.5 GHz.
182 * Frequency is specified in MHz.
183 * The base frequency is specified as (start_factor * 500 kHz).
184 * Constants WF_CHAN_FACTOR_2_4_G, WF_CHAN_FACTOR_5_G are defined for
185 * 2.4 GHz and 5 GHz bands.
187 * The returned channel will be in the range [1, 14] in the 2.4 GHz band
188 * and [0, 200] otherwise.
189 * -1 is returned if the start_factor is WF_CHAN_FACTOR_2_4_G and the
190 * frequency is not a 2.4 GHz channel, or if the frequency is not and even
191 * multiple of 5 MHz from the base frequency to the base plus 1 GHz.
193 * Reference 802.11 REVma, section 17.3.8.3, and 802.11B section 18.4.6.2
195 extern int wf_mhz2channel(uint freq, uint start_factor);
198 * Return the center frequency in MHz of the given channel and base frequency.
199 * The channel number is interpreted relative to the given base frequency.
201 * The valid channel range is [1, 14] in the 2.4 GHz band and [0, 200] otherwise.
202 * The base frequency is specified as (start_factor * 500 kHz).
203 * Constants WF_CHAN_FACTOR_2_4_G, WF_CHAN_FACTOR_5_G are defined for
204 * 2.4 GHz and 5 GHz bands.
205 * The channel range of [1, 14] is only checked for a start_factor of
206 * WF_CHAN_FACTOR_2_4_G (4814).
207 * Odd start_factors produce channels on .5 MHz boundaries, in which case
208 * the answer is rounded down to an integral MHz.
209 * -1 is returned for an out of range channel.
211 * Reference 802.11 REVma, section 17.3.8.3, and 802.11B section 18.4.6.2
213 extern int wf_channel2mhz(uint channel, uint start_factor);
215 #endif /* _bcmwifi_h_ */