ar9170: hardware and eeprom header files
[linux-2.6.git] / drivers / net / wireless / ar9170 / hw.h
blobad205f82f60a7aed2e3d298874d7685a0920542f
1 /*
2 * Atheros AR9170 driver
4 * Hardware-specific definitions
6 * Copyright 2008, Johannes Berg <johannes@sipsolutions.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; see the file COPYING. If not, see
20 * http://www.gnu.org/licenses/.
22 * This file incorporates work covered by the following copyright and
23 * permission notice:
24 * Copyright (c) 2007-2008 Atheros Communications, Inc.
26 * Permission to use, copy, modify, and/or distribute this software for any
27 * purpose with or without fee is hereby granted, provided that the above
28 * copyright notice and this permission notice appear in all copies.
30 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
31 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
32 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
33 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
34 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
35 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
36 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
38 #ifndef __AR9170_HW_H
39 #define __AR9170_HW_H
41 #define AR9170_MAX_CMD_LEN 64
43 enum ar9170_cmd {
44 AR9170_CMD_RREG = 0x00,
45 AR9170_CMD_WREG = 0x01,
46 AR9170_CMD_RMEM = 0x02,
47 AR9170_CMD_WMEM = 0x03,
48 AR9170_CMD_BITAND = 0x04,
49 AR9170_CMD_BITOR = 0x05,
50 AR9170_CMD_EKEY = 0x28,
51 AR9170_CMD_DKEY = 0x29,
52 AR9170_CMD_FREQUENCY = 0x30,
53 AR9170_CMD_RF_INIT = 0x31,
54 AR9170_CMD_SYNTH = 0x32,
55 AR9170_CMD_FREQ_START = 0x33,
56 AR9170_CMD_ECHO = 0x80,
57 AR9170_CMD_TALLY = 0x81,
58 AR9170_CMD_TALLY_APD = 0x82,
59 AR9170_CMD_CONFIG = 0x83,
60 AR9170_CMD_RESET = 0x90,
61 AR9170_CMD_DKRESET = 0x91,
62 AR9170_CMD_DKTX_STATUS = 0x92,
63 AR9170_CMD_FDC = 0xA0,
64 AR9170_CMD_WREEPROM = 0xB0,
65 AR9170_CMD_WFLASH = 0xB0,
66 AR9170_CMD_FLASH_ERASE = 0xB1,
67 AR9170_CMD_FLASH_PROG = 0xB2,
68 AR9170_CMD_FLASH_CHKSUM = 0xB3,
69 AR9170_CMD_FLASH_READ = 0xB4,
70 AR9170_CMD_FW_DL_INIT = 0xB5,
71 AR9170_CMD_MEM_WREEPROM = 0xBB,
74 /* endpoints */
75 #define AR9170_EP_TX 1
76 #define AR9170_EP_RX 2
77 #define AR9170_EP_IRQ 3
78 #define AR9170_EP_CMD 4
80 #define AR9170_EEPROM_START 0x1600
82 #define AR9170_GPIO_REG_BASE 0x1d0100
83 #define AR9170_GPIO_REG_PORT_TYPE AR9170_GPIO_REG_BASE
84 #define AR9170_GPIO_REG_DATA (AR9170_GPIO_REG_BASE + 4)
85 #define AR9170_NUM_LEDS 2
88 #define AR9170_USB_REG_BASE 0x1e1000
89 #define AR9170_USB_REG_DMA_CTL (AR9170_USB_REG_BASE + 0x108)
90 #define AR9170_DMA_CTL_ENABLE_TO_DEVICE 0x1
91 #define AR9170_DMA_CTL_ENABLE_FROM_DEVICE 0x2
92 #define AR9170_DMA_CTL_HIGH_SPEED 0x4
93 #define AR9170_DMA_CTL_PACKET_MODE 0x8
95 #define AR9170_USB_REG_MAX_AGG_UPLOAD (AR9170_USB_REG_BASE + 0x110)
96 #define AR9170_USB_REG_UPLOAD_TIME_CTL (AR9170_USB_REG_BASE + 0x114)
100 #define AR9170_MAC_REG_BASE 0x1c3000
102 #define AR9170_MAC_REG_TSF_L (AR9170_MAC_REG_BASE + 0x514)
103 #define AR9170_MAC_REG_TSF_H (AR9170_MAC_REG_BASE + 0x518)
105 #define AR9170_MAC_REG_ATIM_WINDOW (AR9170_MAC_REG_BASE + 0x51C)
106 #define AR9170_MAC_REG_BCN_PERIOD (AR9170_MAC_REG_BASE + 0x520)
107 #define AR9170_MAC_REG_PRETBTT (AR9170_MAC_REG_BASE + 0x524)
109 #define AR9170_MAC_REG_MAC_ADDR_L (AR9170_MAC_REG_BASE + 0x610)
110 #define AR9170_MAC_REG_MAC_ADDR_H (AR9170_MAC_REG_BASE + 0x614)
111 #define AR9170_MAC_REG_BSSID_L (AR9170_MAC_REG_BASE + 0x618)
112 #define AR9170_MAC_REG_BSSID_H (AR9170_MAC_REG_BASE + 0x61c)
114 #define AR9170_MAC_REG_GROUP_HASH_TBL_L (AR9170_MAC_REG_BASE + 0x624)
115 #define AR9170_MAC_REG_GROUP_HASH_TBL_H (AR9170_MAC_REG_BASE + 0x628)
117 #define AR9170_MAC_REG_RX_TIMEOUT (AR9170_MAC_REG_BASE + 0x62C)
119 #define AR9170_MAC_REG_BASIC_RATE (AR9170_MAC_REG_BASE + 0x630)
120 #define AR9170_MAC_REG_MANDATORY_RATE (AR9170_MAC_REG_BASE + 0x634)
121 #define AR9170_MAC_REG_RTS_CTS_RATE (AR9170_MAC_REG_BASE + 0x638)
122 #define AR9170_MAC_REG_BACKOFF_PROTECT (AR9170_MAC_REG_BASE + 0x63c)
123 #define AR9170_MAC_REG_RX_THRESHOLD (AR9170_MAC_REG_BASE + 0x640)
124 #define AR9170_MAC_REG_RX_PE_DELAY (AR9170_MAC_REG_BASE + 0x64C)
126 #define AR9170_MAC_REG_DYNAMIC_SIFS_ACK (AR9170_MAC_REG_BASE + 0x658)
127 #define AR9170_MAC_REG_SNIFFER (AR9170_MAC_REG_BASE + 0x674)
128 #define AR9170_MAC_REG_SNIFFER_ENABLE_PROMISC BIT(0)
129 #define AR9170_MAC_REG_SNIFFER_DEFAULTS 0x02000000
130 #define AR9170_MAC_REG_ENCRYPTION (AR9170_MAC_REG_BASE + 0x678)
131 #define AR9170_MAC_REG_ENCRYPTION_RX_SOFTWARE BIT(3)
132 #define AR9170_MAC_REG_ENCRYPTION_DEFAULTS 0x70
134 #define AR9170_MAC_REG_MISC_680 (AR9170_MAC_REG_BASE + 0x680)
135 #define AR9170_MAC_REG_TX_UNDERRUN (AR9170_MAC_REG_BASE + 0x688)
137 #define AR9170_MAC_REG_FRAMETYPE_FILTER (AR9170_MAC_REG_BASE + 0x68c)
138 #define AR9170_MAC_REG_FTF_ASSOC_REQ BIT(0)
139 #define AR9170_MAC_REG_FTF_ASSOC_RESP BIT(1)
140 #define AR9170_MAC_REG_FTF_REASSOC_REQ BIT(2)
141 #define AR9170_MAC_REG_FTF_REASSOC_RESP BIT(3)
142 #define AR9170_MAC_REG_FTF_PRB_REQ BIT(4)
143 #define AR9170_MAC_REG_FTF_PRB_RESP BIT(5)
144 #define AR9170_MAC_REG_FTF_BIT6 BIT(6)
145 #define AR9170_MAC_REG_FTF_BIT7 BIT(7)
146 #define AR9170_MAC_REG_FTF_BEACON BIT(8)
147 #define AR9170_MAC_REG_FTF_ATIM BIT(9)
148 #define AR9170_MAC_REG_FTF_DEASSOC BIT(10)
149 #define AR9170_MAC_REG_FTF_AUTH BIT(11)
150 #define AR9170_MAC_REG_FTF_DEAUTH BIT(12)
151 #define AR9170_MAC_REG_FTF_BIT13 BIT(13)
152 #define AR9170_MAC_REG_FTF_BIT14 BIT(14)
153 #define AR9170_MAC_REG_FTF_BIT15 BIT(15)
154 #define AR9170_MAC_REG_FTF_BAR BIT(24)
155 #define AR9170_MAC_REG_FTF_BIT25 BIT(25)
156 #define AR9170_MAC_REG_FTF_PSPOLL BIT(26)
157 #define AR9170_MAC_REG_FTF_RTS BIT(27)
158 #define AR9170_MAC_REG_FTF_CTS BIT(28)
159 #define AR9170_MAC_REG_FTF_ACK BIT(29)
160 #define AR9170_MAC_REG_FTF_CFE BIT(30)
161 #define AR9170_MAC_REG_FTF_CFE_ACK BIT(31)
162 #define AR9170_MAC_REG_FTF_DEFAULTS 0x0500ffff
163 #define AR9170_MAC_REG_FTF_MONITOR 0xfd00ffff
165 #define AR9170_MAC_REG_RX_TOTAL (AR9170_MAC_REG_BASE + 0x6A0)
166 #define AR9170_MAC_REG_RX_CRC32 (AR9170_MAC_REG_BASE + 0x6A4)
167 #define AR9170_MAC_REG_RX_CRC16 (AR9170_MAC_REG_BASE + 0x6A8)
168 #define AR9170_MAC_REG_RX_ERR_DECRYPTION_UNI (AR9170_MAC_REG_BASE + 0x6AC)
169 #define AR9170_MAC_REG_RX_OVERRUN (AR9170_MAC_REG_BASE + 0x6B0)
170 #define AR9170_MAC_REG_RX_ERR_DECRYPTION_MUL (AR9170_MAC_REG_BASE + 0x6BC)
171 #define AR9170_MAC_REG_TX_RETRY (AR9170_MAC_REG_BASE + 0x6CC)
172 #define AR9170_MAC_REG_TX_TOTAL (AR9170_MAC_REG_BASE + 0x6F4)
175 #define AR9170_MAC_REG_ACK_EXTENSION (AR9170_MAC_REG_BASE + 0x690)
176 #define AR9170_MAC_REG_EIFS_AND_SIFS (AR9170_MAC_REG_BASE + 0x698)
178 #define AR9170_MAC_REG_SLOT_TIME (AR9170_MAC_REG_BASE + 0x6F0)
180 #define AR9170_MAC_REG_POWERMANAGEMENT (AR9170_MAC_REG_BASE + 0x700)
181 #define AR9170_MAC_REG_POWERMGT_IBSS 0xe0
182 #define AR9170_MAC_REG_POWERMGT_AP 0xa1
183 #define AR9170_MAC_REG_POWERMGT_STA 0x2
184 #define AR9170_MAC_REG_POWERMGT_AP_WDS 0x3
185 #define AR9170_MAC_REG_POWERMGT_DEFAULTS (0xf << 24)
187 #define AR9170_MAC_REG_ROLL_CALL_TBL_L (AR9170_MAC_REG_BASE + 0x704)
188 #define AR9170_MAC_REG_ROLL_CALL_TBL_H (AR9170_MAC_REG_BASE + 0x708)
190 #define AR9170_MAC_REG_AC0_CW (AR9170_MAC_REG_BASE + 0xB00)
191 #define AR9170_MAC_REG_AC1_CW (AR9170_MAC_REG_BASE + 0xB04)
192 #define AR9170_MAC_REG_AC2_CW (AR9170_MAC_REG_BASE + 0xB08)
193 #define AR9170_MAC_REG_AC3_CW (AR9170_MAC_REG_BASE + 0xB0C)
194 #define AR9170_MAC_REG_AC4_CW (AR9170_MAC_REG_BASE + 0xB10)
195 #define AR9170_MAC_REG_AC1_AC0_AIFS (AR9170_MAC_REG_BASE + 0xB14)
196 #define AR9170_MAC_REG_AC3_AC2_AIFS (AR9170_MAC_REG_BASE + 0xB18)
198 #define AR9170_MAC_REG_RETRY_MAX (AR9170_MAC_REG_BASE + 0xB28)
200 #define AR9170_MAC_REG_FCS_SELECT (AR9170_MAC_REG_BASE + 0xBB0)
201 #define AR9170_MAC_FCS_SWFCS 0x1
202 #define AR9170_MAC_FCS_FIFO_PROT 0x4
205 #define AR9170_MAC_REG_TXOP_NOT_ENOUGH_IND (AR9170_MAC_REG_BASE + 0xB30)
207 #define AR9170_MAC_REG_AC1_AC0_TXOP (AR9170_MAC_REG_BASE + 0xB44)
208 #define AR9170_MAC_REG_AC3_AC2_TXOP (AR9170_MAC_REG_BASE + 0xB48)
210 #define AR9170_MAC_REG_ACK_TABLE (AR9170_MAC_REG_BASE + 0xC00)
211 #define AR9170_MAC_REG_AMPDU_RX_THRESH (AR9170_MAC_REG_BASE + 0xC50)
213 #define AR9170_MAC_REG_TXRX_MPI (AR9170_MAC_REG_BASE + 0xD7C)
214 #define AR9170_MAC_TXRX_MPI_TX_MPI_MASK 0x0000000f
215 #define AR9170_MAC_TXRX_MPI_TX_TO_MASK 0x0000fff0
216 #define AR9170_MAC_TXRX_MPI_RX_MPI_MASK 0x000f0000
217 #define AR9170_MAC_TXRX_MPI_RX_TO_MASK 0xfff00000
219 #define AR9170_MAC_REG_BCN_ADDR (AR9170_MAC_REG_BASE + 0xD84)
220 #define AR9170_MAC_REG_BCN_LENGTH (AR9170_MAC_REG_BASE + 0xD88)
221 #define AR9170_MAC_REG_BCN_PLCP (AR9170_MAC_REG_BASE + 0xD90)
222 #define AR9170_MAC_REG_BCN_CTRL (AR9170_MAC_REG_BASE + 0xD94)
223 #define AR9170_MAC_REG_BCN_HT1 (AR9170_MAC_REG_BASE + 0xDA0)
224 #define AR9170_MAC_REG_BCN_HT2 (AR9170_MAC_REG_BASE + 0xDA4)
227 #define AR9170_PWR_REG_BASE 0x1D4000
229 #define AR9170_PWR_REG_CLOCK_SEL (AR9170_PWR_REG_BASE + 0x008)
230 #define AR9170_PWR_CLK_AHB_40MHZ 0
231 #define AR9170_PWR_CLK_AHB_20_22MHZ 1
232 #define AR9170_PWR_CLK_AHB_40_44MHZ 2
233 #define AR9170_PWR_CLK_AHB_80_88MHZ 3
234 #define AR9170_PWR_CLK_DAC_160_INV_DLY 0x70
237 /* put beacon here in memory */
238 #define AR9170_BEACON_BUFFER_ADDRESS 0x117900
241 struct ar9170_tx_control {
242 __le16 length;
243 __le16 mac_control;
244 __le32 phy_control;
245 u8 frame_data[0];
246 } __packed;
248 /* these are either-or */
249 #define AR9170_TX_MAC_PROT_RTS 0x0001
250 #define AR9170_TX_MAC_PROT_CTS 0x0002
252 #define AR9170_TX_MAC_NO_ACK 0x0004
253 /* if unset, MAC will only do SIFS space before frame */
254 #define AR9170_TX_MAC_BACKOFF 0x0008
255 #define AR9170_TX_MAC_BURST 0x0010
256 #define AR9170_TX_MAC_AGGR 0x0020
258 /* encryption is a two-bit field */
259 #define AR9170_TX_MAC_ENCR_NONE 0x0000
260 #define AR9170_TX_MAC_ENCR_RC4 0x0040
261 #define AR9170_TX_MAC_ENCR_CENC 0x0080
262 #define AR9170_TX_MAC_ENCR_AES 0x00c0
264 #define AR9170_TX_MAC_MMIC 0x0100
265 #define AR9170_TX_MAC_HW_DURATION 0x0200
266 #define AR9170_TX_MAC_QOS_SHIFT 10
267 #define AR9170_TX_MAC_QOS_MASK (3 << AR9170_TX_MAC_QOS_SHIFT)
268 #define AR9170_TX_MAC_AGGR_QOS_BIT1 0x0400
269 #define AR9170_TX_MAC_AGGR_QOS_BIT2 0x0800
270 #define AR9170_TX_MAC_DISABLE_TXOP 0x1000
271 #define AR9170_TX_MAC_TXOP_RIFS 0x2000
272 #define AR9170_TX_MAC_IMM_AMPDU 0x4000
273 #define AR9170_TX_MAC_RATE_PROBE 0x8000
275 /* either-or */
276 #define AR9170_TX_PHY_MOD_CCK 0x00000000
277 #define AR9170_TX_PHY_MOD_OFDM 0x00000001
278 #define AR9170_TX_PHY_MOD_HT 0x00000002
280 /* depends on modulation */
281 #define AR9170_TX_PHY_SHORT_PREAMBLE 0x00000004
282 #define AR9170_TX_PHY_GREENFIELD 0x00000004
284 #define AR9170_TX_PHY_BW_SHIFT 3
285 #define AR9170_TX_PHY_BW_MASK (3 << AR9170_TX_PHY_BW_SHIFT)
286 #define AR9170_TX_PHY_BW_20MHZ 0
287 #define AR9170_TX_PHY_BW_40MHZ 2
288 #define AR9170_TX_PHY_BW_40MHZ_DUP 3
290 #define AR9170_TX_PHY_TX_HEAVY_CLIP_SHIFT 6
291 #define AR9170_TX_PHY_TX_HEAVY_CLIP_MASK (7 << AR9170_TX_PHY_TX_HEAVY_CLIP_SHIFT)
293 #define AR9170_TX_PHY_TX_PWR_SHIFT 9
294 #define AR9170_TX_PHY_TX_PWR_MASK (0x3f << AR9170_TX_PHY_TX_PWR_SHIFT)
296 /* not part of the hw-spec */
297 #define AR9170_TX_PHY_QOS_SHIFT 25
298 #define AR9170_TX_PHY_QOS_MASK (3 << AR9170_TX_PHY_QOS_SHIFT)
300 #define AR9170_TX_PHY_TXCHAIN_SHIFT 15
301 #define AR9170_TX_PHY_TXCHAIN_MASK (7 << AR9170_TX_PHY_TXCHAIN_SHIFT)
302 #define AR9170_TX_PHY_TXCHAIN_1 1
303 /* use for cck, ofdm 6/9/12/18/24 and HT if capable */
304 #define AR9170_TX_PHY_TXCHAIN_2 5
306 #define AR9170_TX_PHY_MCS_SHIFT 18
307 #define AR9170_TX_PHY_MCS_MASK (0x7f << AR9170_TX_PHY_MCS_SHIFT)
309 #define AR9170_TX_PHY_SHORT_GI 0x80000000
311 struct ar9170_rx_head {
312 u8 plcp[12];
315 struct ar9170_rx_tail {
316 union {
317 struct {
318 u8 rssi_ant0, rssi_ant1, rssi_ant2,
319 rssi_ant0x, rssi_ant1x, rssi_ant2x,
320 rssi_combined;
322 u8 rssi[7];
325 u8 evm_stream0[6], evm_stream1[6];
326 u8 phy_err;
327 u8 SAidx, DAidx;
328 u8 error;
329 u8 status;
332 #define AR9170_ENC_ALG_NONE 0x0
333 #define AR9170_ENC_ALG_WEP64 0x1
334 #define AR9170_ENC_ALG_TKIP 0x2
335 #define AR9170_ENC_ALG_AESCCMP 0x4
336 #define AR9170_ENC_ALG_WEP128 0x5
337 #define AR9170_ENC_ALG_WEP256 0x6
338 #define AR9170_ENC_ALG_CENC 0x7
340 #define AR9170_RX_ENC_SOFTWARE 0x8
342 static inline u8 ar9170_get_decrypt_type(struct ar9170_rx_tail *t)
344 return (t->SAidx & 0xc0) >> 4 |
345 (t->DAidx & 0xc0) >> 6;
348 #define AR9170_RX_STATUS_MODULATION_MASK 0x03
349 #define AR9170_RX_STATUS_MODULATION_CCK 0x00
350 #define AR9170_RX_STATUS_MODULATION_OFDM 0x01
351 #define AR9170_RX_STATUS_MODULATION_HT 0x02
352 #define AR9170_RX_STATUS_MODULATION_DUPOFDM 0x03
354 /* depends on modulation */
355 #define AR9170_RX_STATUS_SHORT_PREAMBLE 0x08
356 #define AR9170_RX_STATUS_GREENFIELD 0x08
358 #define AR9170_RX_STATUS_MPDU_MASK 0x30
359 #define AR9170_RX_STATUS_MPDU_SINGLE 0x00
360 #define AR9170_RX_STATUS_MPDU_FIRST 0x10
361 #define AR9170_RX_STATUS_MPDU_MIDDLE 0x20
362 #define AR9170_RX_STATUS_MPDU_LAST 0x30
365 #define AR9170_RX_ERROR_RXTO 0x01
366 #define AR9170_RX_ERROR_OVERRUN 0x02
367 #define AR9170_RX_ERROR_DECRYPT 0x04
368 #define AR9170_RX_ERROR_FCS 0x08
369 #define AR9170_RX_ERROR_WRONG_RA 0x10
370 #define AR9170_RX_ERROR_PLCP 0x20
371 #define AR9170_RX_ERROR_MMIC 0x40
373 struct ar9170_cmd_tx_status {
374 __le16 unkn;
375 u8 dst[ETH_ALEN];
376 __le32 rate;
377 __le16 status;
378 } __packed;
380 #define AR9170_TX_STATUS_COMPLETE 0x00
381 #define AR9170_TX_STATUS_RETRY 0x01
382 #define AR9170_TX_STATUS_FAILED 0x02
384 struct ar9170_cmd_ba_failed_count {
385 __le16 failed;
386 __le16 rate;
387 } __packed;
389 struct ar9170_cmd_response {
390 u8 flag;
391 u8 type;
393 union {
394 struct ar9170_cmd_tx_status tx_status;
395 struct ar9170_cmd_ba_failed_count ba_fail_cnt;
396 u8 data[0];
398 } __packed;
400 /* mac80211 queue to HW/FW map */
401 static const u8 ar9170_qos_hwmap[4] = { 3, 2, 0, 1 };
403 /* HW/FW queue to mac80211 map */
404 static const u8 ar9170_qos_mac80211map[4] = { 2, 3, 1, 0 };
406 #endif /* __AR9170_HW_H */