rt2x00reg.h revision 78e256c9a3717bcae2e9ed05c9ec7bed7bf2c55d 
1/*
2	Copyright (C) 2004 - 2009 Ivo van Doorn <IvDoorn@gmail.com>
3	<http://rt2x00.serialmonkey.com>
4
5	This program is free software; you can redistribute it and/or modify
6	it under the terms of the GNU General Public License as published by
7	the Free Software Foundation; either version 2 of the License, or
8	(at your option) any later version.
9
10	This program is distributed in the hope that it will be useful,
11	but WITHOUT ANY WARRANTY; without even the implied warranty of
12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13	GNU General Public License for more details.
14
15	You should have received a copy of the GNU General Public License
16	along with this program; if not, write to the
17	Free Software Foundation, Inc.,
18	59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 */
20
21/*
22	Module: rt2x00
23	Abstract: rt2x00 generic register information.
24 */
25
26#ifndef RT2X00REG_H
27#define RT2X00REG_H
28
29/*
30 * RX crypto status
31 */
32enum rx_crypto {
33	RX_CRYPTO_SUCCESS = 0,
34	RX_CRYPTO_FAIL_ICV = 1,
35	RX_CRYPTO_FAIL_MIC = 2,
36	RX_CRYPTO_FAIL_KEY = 3,
37};
38
39/*
40 * Antenna values
41 */
42enum antenna {
43	ANTENNA_SW_DIVERSITY = 0,
44	ANTENNA_A = 1,
45	ANTENNA_B = 2,
46	ANTENNA_HW_DIVERSITY = 3,
47};
48
49/*
50 * Led mode values.
51 */
52enum led_mode {
53	LED_MODE_DEFAULT = 0,
54	LED_MODE_TXRX_ACTIVITY = 1,
55	LED_MODE_SIGNAL_STRENGTH = 2,
56	LED_MODE_ASUS = 3,
57	LED_MODE_ALPHA = 4,
58};
59
60/*
61 * TSF sync values
62 */
63enum tsf_sync {
64	TSF_SYNC_NONE = 0,
65	TSF_SYNC_INFRA = 1,
66	TSF_SYNC_BEACON = 2,
67};
68
69/*
70 * Device states
71 */
72enum dev_state {
73	STATE_DEEP_SLEEP = 0,
74	STATE_SLEEP = 1,
75	STATE_STANDBY = 2,
76	STATE_AWAKE = 3,
77
78/*
79 * Additional device states, these values are
80 * not strict since they are not directly passed
81 * into the device.
82 */
83	STATE_RADIO_ON,
84	STATE_RADIO_OFF,
85	STATE_RADIO_RX_ON,
86	STATE_RADIO_RX_OFF,
87	STATE_RADIO_RX_ON_LINK,
88	STATE_RADIO_RX_OFF_LINK,
89	STATE_RADIO_IRQ_ON,
90	STATE_RADIO_IRQ_OFF,
91	STATE_RADIO_IRQ_ON_ISR,
92	STATE_RADIO_IRQ_OFF_ISR,
93};
94
95/*
96 * IFS backoff values
97 */
98enum ifs {
99	IFS_BACKOFF = 0,
100	IFS_SIFS = 1,
101	IFS_NEW_BACKOFF = 2,
102	IFS_NONE = 3,
103};
104
105/*
106 * IFS backoff values for HT devices
107 */
108enum txop {
109	TXOP_HTTXOP = 0,
110	TXOP_PIFS = 1,
111	TXOP_SIFS = 2,
112	TXOP_BACKOFF = 3,
113};
114
115/*
116 * Cipher types for hardware encryption
117 */
118enum cipher {
119	CIPHER_NONE = 0,
120	CIPHER_WEP64 = 1,
121	CIPHER_WEP128 = 2,
122	CIPHER_TKIP = 3,
123	CIPHER_AES = 4,
124/*
125 * The following fields were added by rt61pci and rt73usb.
126 */
127	CIPHER_CKIP64 = 5,
128	CIPHER_CKIP128 = 6,
129	CIPHER_TKIP_NO_MIC = 7, /* Don't send to device */
130
131/*
132 * Max cipher type.
133 * Note that CIPHER_NONE isn't counted, and CKIP64 and CKIP128
134 * are excluded due to limitations in mac80211.
135 */
136	CIPHER_MAX = 4,
137};
138
139/*
140 * Rate modulations
141 */
142enum rate_modulation {
143	RATE_MODE_CCK = 0,
144	RATE_MODE_OFDM = 1,
145	RATE_MODE_HT_MIX = 2,
146	RATE_MODE_HT_GREENFIELD = 3,
147};
148
149/*
150 * Firmware validation error codes
151 */
152enum firmware_errors {
153	FW_OK,
154	FW_BAD_CRC,
155	FW_BAD_LENGTH,
156	FW_BAD_VERSION,
157};
158
159/*
160 * Register handlers.
161 * We store the position of a register field inside a field structure,
162 * This will simplify the process of setting and reading a certain field
163 * inside the register while making sure the process remains byte order safe.
164 */
165struct rt2x00_field8 {
166	u8 bit_offset;
167	u8 bit_mask;
168};
169
170struct rt2x00_field16 {
171	u16 bit_offset;
172	u16 bit_mask;
173};
174
175struct rt2x00_field32 {
176	u32 bit_offset;
177	u32 bit_mask;
178};
179
180/*
181 * Power of two check, this will check
182 * if the mask that has been given contains and contiguous set of bits.
183 * Note that we cannot use the is_power_of_2() function since this
184 * check must be done at compile-time.
185 */
186#define is_power_of_two(x)	( !((x) & ((x)-1)) )
187#define low_bit_mask(x)		( ((x)-1) & ~(x) )
188#define is_valid_mask(x)	is_power_of_two(1LU + (x) + low_bit_mask(x))
189
190/*
191 * Macros to find first set bit in a variable.
192 * These macros behave the same as the __ffs() functions but
193 * the most important difference that this is done during
194 * compile-time rather then run-time.
195 */
196#define compile_ffs2(__x) \
197	__builtin_choose_expr(((__x) & 0x1), 0, 1)
198
199#define compile_ffs4(__x) \
200	__builtin_choose_expr(((__x) & 0x3), \
201			      (compile_ffs2((__x))), \
202			      (compile_ffs2((__x) >> 2) + 2))
203
204#define compile_ffs8(__x) \
205	__builtin_choose_expr(((__x) & 0xf), \
206			      (compile_ffs4((__x))), \
207			      (compile_ffs4((__x) >> 4) + 4))
208
209#define compile_ffs16(__x) \
210	__builtin_choose_expr(((__x) & 0xff), \
211			      (compile_ffs8((__x))), \
212			      (compile_ffs8((__x) >> 8) + 8))
213
214#define compile_ffs32(__x) \
215	__builtin_choose_expr(((__x) & 0xffff), \
216			      (compile_ffs16((__x))), \
217			      (compile_ffs16((__x) >> 16) + 16))
218
219/*
220 * This macro will check the requirements for the FIELD{8,16,32} macros
221 * The mask should be a constant non-zero contiguous set of bits which
222 * does not exceed the given typelimit.
223 */
224#define FIELD_CHECK(__mask, __type)			\
225	BUILD_BUG_ON(!(__mask) ||			\
226		     !is_valid_mask(__mask) ||		\
227		     (__mask) != (__type)(__mask))	\
228
229#define FIELD8(__mask)				\
230({						\
231	FIELD_CHECK(__mask, u8);		\
232	(struct rt2x00_field8) {		\
233		compile_ffs8(__mask), (__mask)	\
234	};					\
235})
236
237#define FIELD16(__mask)				\
238({						\
239	FIELD_CHECK(__mask, u16);		\
240	(struct rt2x00_field16) {		\
241		compile_ffs16(__mask), (__mask)	\
242	};					\
243})
244
245#define FIELD32(__mask)				\
246({						\
247	FIELD_CHECK(__mask, u32);		\
248	(struct rt2x00_field32) {		\
249		compile_ffs32(__mask), (__mask)	\
250	};					\
251})
252
253#define SET_FIELD(__reg, __type, __field, __value)\
254({						\
255	typecheck(__type, __field);		\
256	*(__reg) &= ~((__field).bit_mask);	\
257	*(__reg) |= ((__value) <<		\
258	    ((__field).bit_offset)) &		\
259	    ((__field).bit_mask);		\
260})
261
262#define GET_FIELD(__reg, __type, __field)	\
263({						\
264	typecheck(__type, __field);		\
265	((__reg) & ((__field).bit_mask)) >>	\
266	    ((__field).bit_offset);		\
267})
268
269#define rt2x00_set_field32(__reg, __field, __value) \
270	SET_FIELD(__reg, struct rt2x00_field32, __field, __value)
271#define rt2x00_get_field32(__reg, __field) \
272	GET_FIELD(__reg, struct rt2x00_field32, __field)
273
274#define rt2x00_set_field16(__reg, __field, __value) \
275	SET_FIELD(__reg, struct rt2x00_field16, __field, __value)
276#define rt2x00_get_field16(__reg, __field) \
277	GET_FIELD(__reg, struct rt2x00_field16, __field)
278
279#define rt2x00_set_field8(__reg, __field, __value) \
280	SET_FIELD(__reg, struct rt2x00_field8, __field, __value)
281#define rt2x00_get_field8(__reg, __field) \
282	GET_FIELD(__reg, struct rt2x00_field8, __field)
283
284#endif /* RT2X00REG_H */
285