1/*
2	Copyright (C) 2009 Ivo van Doorn <IvDoorn@gmail.com>
3	Copyright (C) 2009 Mattias Nissler <mattias.nissler@gmx.de>
4	Copyright (C) 2009 Felix Fietkau <nbd@openwrt.org>
5	Copyright (C) 2009 Xose Vazquez Perez <xose.vazquez@gmail.com>
6	Copyright (C) 2009 Axel Kollhofer <rain_maker@root-forum.org>
7	<http://rt2x00.serialmonkey.com>
8
9	This program is free software; you can redistribute it and/or modify
10	it under the terms of the GNU General Public License as published by
11	the Free Software Foundation; either version 2 of the License, or
12	(at your option) any later version.
13
14	This program is distributed in the hope that it will be useful,
15	but WITHOUT ANY WARRANTY; without even the implied warranty of
16	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17	GNU General Public License for more details.
18
19	You should have received a copy of the GNU General Public License
20	along with this program; if not, see <http://www.gnu.org/licenses/>.
21 */
22
23/*
24	Module: rt2800usb
25	Abstract: Data structures and registers for the rt2800usb module.
26	Supported chipsets: RT2800U.
27 */
28
29#ifndef RT2800USB_H
30#define RT2800USB_H
31
32/*
33 * 8051 firmware image.
34 */
35#define FIRMWARE_RT2870			"rt2870.bin"
36#define FIRMWARE_IMAGE_BASE		0x3000
37
38/*
39 * DMA descriptor defines.
40 */
41#define TXINFO_DESC_SIZE		(1 * sizeof(__le32))
42#define RXINFO_DESC_SIZE		(1 * sizeof(__le32))
43
44/*
45 * TX Info structure
46 */
47
48/*
49 * Word0
50 * WIV: Wireless Info Valid. 1: Driver filled WI,  0: DMA needs to copy WI
51 * QSEL: Select on-chip FIFO ID for 2nd-stage output scheduler.
52 *       0:MGMT, 1:HCCA 2:EDCA
53 * USB_DMA_NEXT_VALID: Used ONLY in USB bulk Aggregation, NextValid
54 * DMA_TX_BURST: used ONLY in USB bulk Aggregation.
55 *               Force USB DMA transmit frame from current selected endpoint
56 */
57#define TXINFO_W0_USB_DMA_TX_PKT_LEN	FIELD32(0x0000ffff)
58#define TXINFO_W0_WIV			FIELD32(0x01000000)
59#define TXINFO_W0_QSEL			FIELD32(0x06000000)
60#define TXINFO_W0_SW_USE_LAST_ROUND	FIELD32(0x08000000)
61#define TXINFO_W0_USB_DMA_NEXT_VALID	FIELD32(0x40000000)
62#define TXINFO_W0_USB_DMA_TX_BURST	FIELD32(0x80000000)
63
64/*
65 * RX Info structure
66 */
67
68/*
69 * Word 0
70 */
71
72#define RXINFO_W0_USB_DMA_RX_PKT_LEN	FIELD32(0x0000ffff)
73
74/*
75 * RX descriptor format for RX Ring.
76 */
77
78/*
79 * Word0
80 * UNICAST_TO_ME: This RX frame is unicast to me.
81 * MULTICAST: This is a multicast frame.
82 * BROADCAST: This is a broadcast frame.
83 * MY_BSS: this frame belongs to the same BSSID.
84 * CRC_ERROR: CRC error.
85 * CIPHER_ERROR: 0: decryption okay, 1:ICV error, 2:MIC error, 3:KEY not valid.
86 * AMSDU: rx with 802.3 header, not 802.11 header.
87 */
88
89#define RXD_W0_BA			FIELD32(0x00000001)
90#define RXD_W0_DATA			FIELD32(0x00000002)
91#define RXD_W0_NULLDATA			FIELD32(0x00000004)
92#define RXD_W0_FRAG			FIELD32(0x00000008)
93#define RXD_W0_UNICAST_TO_ME		FIELD32(0x00000010)
94#define RXD_W0_MULTICAST		FIELD32(0x00000020)
95#define RXD_W0_BROADCAST		FIELD32(0x00000040)
96#define RXD_W0_MY_BSS			FIELD32(0x00000080)
97#define RXD_W0_CRC_ERROR		FIELD32(0x00000100)
98#define RXD_W0_CIPHER_ERROR		FIELD32(0x00000600)
99#define RXD_W0_AMSDU			FIELD32(0x00000800)
100#define RXD_W0_HTC			FIELD32(0x00001000)
101#define RXD_W0_RSSI			FIELD32(0x00002000)
102#define RXD_W0_L2PAD			FIELD32(0x00004000)
103#define RXD_W0_AMPDU			FIELD32(0x00008000)
104#define RXD_W0_DECRYPTED		FIELD32(0x00010000)
105#define RXD_W0_PLCP_RSSI		FIELD32(0x00020000)
106#define RXD_W0_CIPHER_ALG		FIELD32(0x00040000)
107#define RXD_W0_LAST_AMSDU		FIELD32(0x00080000)
108#define RXD_W0_PLCP_SIGNAL		FIELD32(0xfff00000)
109
110#endif /* RT2800USB_H */
111