trivial: fix typos s/paramter/parameter/ and s/excute/execute/ in documentation and...
[linux-2.6] / drivers / net / wireless / rtl818x / rtl8187.h
1 /*
2  * Definitions for RTL8187 hardware
3  *
4  * Copyright 2007 Michael Wu <flamingice@sourmilk.net>
5  * Copyright 2007 Andrea Merello <andreamrl@tiscali.it>
6  *
7  * Based on the r8187 driver, which is:
8  * Copyright 2005 Andrea Merello <andreamrl@tiscali.it>, et al.
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License version 2 as
12  * published by the Free Software Foundation.
13  */
14
15 #ifndef RTL8187_H
16 #define RTL8187_H
17
18 #include "rtl818x.h"
19
20 #define RTL8187_EEPROM_TXPWR_BASE       0x05
21 #define RTL8187_EEPROM_MAC_ADDR         0x07
22 #define RTL8187_EEPROM_TXPWR_CHAN_1     0x16    /* 3 channels */
23 #define RTL8187_EEPROM_TXPWR_CHAN_6     0x1B    /* 2 channels */
24 #define RTL8187_EEPROM_TXPWR_CHAN_4     0x3D    /* 2 channels */
25
26 #define RTL8187_REQT_READ       0xC0
27 #define RTL8187_REQT_WRITE      0x40
28 #define RTL8187_REQ_GET_REG     0x05
29 #define RTL8187_REQ_SET_REG     0x05
30
31 #define RTL8187_MAX_RX          0x9C4
32
33 struct rtl8187_rx_info {
34         struct urb *urb;
35         struct ieee80211_hw *dev;
36 };
37
38 struct rtl8187_rx_hdr {
39         __le32 flags;
40         u8 noise;
41         u8 signal;
42         u8 agc;
43         u8 reserved;
44         __le64 mac_time;
45 } __attribute__((packed));
46
47 struct rtl8187b_rx_hdr {
48         __le32 flags;
49         __le64 mac_time;
50         u8 sq;
51         u8 rssi;
52         u8 agc;
53         u8 flags2;
54         __le16 snr_long2end;
55         s8 pwdb_g12;
56         u8 fot;
57 } __attribute__((packed));
58
59 /* {rtl8187,rtl8187b}_tx_info is in skb */
60
61 struct rtl8187_tx_hdr {
62         __le32 flags;
63         __le16 rts_duration;
64         __le16 len;
65         __le32 retry;
66 } __attribute__((packed));
67
68 struct rtl8187b_tx_hdr {
69         __le32 flags;
70         __le16 rts_duration;
71         __le16 len;
72         __le32 unused_1;
73         __le16 unused_2;
74         __le16 tx_duration;
75         __le32 unused_3;
76         __le32 retry;
77         __le32 unused_4[2];
78 } __attribute__((packed));
79
80 enum {
81         DEVICE_RTL8187,
82         DEVICE_RTL8187B
83 };
84
85 struct rtl8187_priv {
86         /* common between rtl818x drivers */
87         struct rtl818x_csr *map;
88         const struct rtl818x_rf_ops *rf;
89         struct ieee80211_vif *vif;
90         int mode;
91         /* The mutex protects the TX loopback state.
92          * Any attempt to set channels concurrently locks the device.
93          */
94         struct mutex conf_mutex;
95
96         /* rtl8187 specific */
97         struct ieee80211_channel channels[14];
98         struct ieee80211_rate rates[12];
99         struct ieee80211_supported_band band;
100         struct usb_device *udev;
101         u32 rx_conf;
102         struct usb_anchor anchored;
103         struct delayed_work work;
104         struct ieee80211_hw *dev;
105         u16 txpwr_base;
106         u8 asic_rev;
107         u8 is_rtl8187b;
108         enum {
109                 RTL8187BvB,
110                 RTL8187BvD,
111                 RTL8187BvE
112         } hw_rev;
113         struct sk_buff_head rx_queue;
114         u8 signal;
115         u8 quality;
116         u8 noise;
117         u8 slot_time;
118         u8 aifsn[4];
119         struct {
120                 __le64 buf;
121                 struct sk_buff_head queue;
122         } b_tx_status; /* This queue is used by both -b and non-b devices */
123         struct mutex io_mutex;
124         union {
125                 u8 bits8;
126                 __le16 bits16;
127                 __le32 bits32;
128         } *io_dmabuf;
129 };
130
131 void rtl8187_write_phy(struct ieee80211_hw *dev, u8 addr, u32 data);
132
133 static inline u8 rtl818x_ioread8_idx(struct rtl8187_priv *priv,
134                                      u8 *addr, u8 idx)
135 {
136         u8 val;
137
138         mutex_lock(&priv->io_mutex);
139         usb_control_msg(priv->udev, usb_rcvctrlpipe(priv->udev, 0),
140                         RTL8187_REQ_GET_REG, RTL8187_REQT_READ,
141                         (unsigned long)addr, idx & 0x03,
142                         &priv->io_dmabuf->bits8, sizeof(val), HZ / 2);
143
144         val = priv->io_dmabuf->bits8;
145         mutex_unlock(&priv->io_mutex);
146
147         return val;
148 }
149
150 static inline u8 rtl818x_ioread8(struct rtl8187_priv *priv, u8 *addr)
151 {
152         return rtl818x_ioread8_idx(priv, addr, 0);
153 }
154
155 static inline u16 rtl818x_ioread16_idx(struct rtl8187_priv *priv,
156                                        __le16 *addr, u8 idx)
157 {
158         __le16 val;
159
160         mutex_lock(&priv->io_mutex);
161         usb_control_msg(priv->udev, usb_rcvctrlpipe(priv->udev, 0),
162                         RTL8187_REQ_GET_REG, RTL8187_REQT_READ,
163                         (unsigned long)addr, idx & 0x03,
164                         &priv->io_dmabuf->bits16, sizeof(val), HZ / 2);
165
166         val = priv->io_dmabuf->bits16;
167         mutex_unlock(&priv->io_mutex);
168
169         return le16_to_cpu(val);
170 }
171
172 static inline u16 rtl818x_ioread16(struct rtl8187_priv *priv, __le16 *addr)
173 {
174         return rtl818x_ioread16_idx(priv, addr, 0);
175 }
176
177 static inline u32 rtl818x_ioread32_idx(struct rtl8187_priv *priv,
178                                        __le32 *addr, u8 idx)
179 {
180         __le32 val;
181
182         mutex_lock(&priv->io_mutex);
183         usb_control_msg(priv->udev, usb_rcvctrlpipe(priv->udev, 0),
184                         RTL8187_REQ_GET_REG, RTL8187_REQT_READ,
185                         (unsigned long)addr, idx & 0x03,
186                         &priv->io_dmabuf->bits32, sizeof(val), HZ / 2);
187
188         val = priv->io_dmabuf->bits32;
189         mutex_unlock(&priv->io_mutex);
190
191         return le32_to_cpu(val);
192 }
193
194 static inline u32 rtl818x_ioread32(struct rtl8187_priv *priv, __le32 *addr)
195 {
196         return rtl818x_ioread32_idx(priv, addr, 0);
197 }
198
199 static inline void rtl818x_iowrite8_idx(struct rtl8187_priv *priv,
200                                         u8 *addr, u8 val, u8 idx)
201 {
202         mutex_lock(&priv->io_mutex);
203
204         priv->io_dmabuf->bits8 = val;
205         usb_control_msg(priv->udev, usb_sndctrlpipe(priv->udev, 0),
206                         RTL8187_REQ_SET_REG, RTL8187_REQT_WRITE,
207                         (unsigned long)addr, idx & 0x03,
208                         &priv->io_dmabuf->bits8, sizeof(val), HZ / 2);
209
210         mutex_unlock(&priv->io_mutex);
211 }
212
213 static inline void rtl818x_iowrite8(struct rtl8187_priv *priv, u8 *addr, u8 val)
214 {
215         rtl818x_iowrite8_idx(priv, addr, val, 0);
216 }
217
218 static inline void rtl818x_iowrite16_idx(struct rtl8187_priv *priv,
219                                          __le16 *addr, u16 val, u8 idx)
220 {
221         mutex_lock(&priv->io_mutex);
222
223         priv->io_dmabuf->bits16 = cpu_to_le16(val);
224         usb_control_msg(priv->udev, usb_sndctrlpipe(priv->udev, 0),
225                         RTL8187_REQ_SET_REG, RTL8187_REQT_WRITE,
226                         (unsigned long)addr, idx & 0x03,
227                         &priv->io_dmabuf->bits16, sizeof(val), HZ / 2);
228
229         mutex_unlock(&priv->io_mutex);
230 }
231
232 static inline void rtl818x_iowrite16(struct rtl8187_priv *priv, __le16 *addr,
233                                      u16 val)
234 {
235         rtl818x_iowrite16_idx(priv, addr, val, 0);
236 }
237
238 static inline void rtl818x_iowrite32_idx(struct rtl8187_priv *priv,
239                                          __le32 *addr, u32 val, u8 idx)
240 {
241         mutex_lock(&priv->io_mutex);
242
243         priv->io_dmabuf->bits32 = cpu_to_le32(val);
244         usb_control_msg(priv->udev, usb_sndctrlpipe(priv->udev, 0),
245                         RTL8187_REQ_SET_REG, RTL8187_REQT_WRITE,
246                         (unsigned long)addr, idx & 0x03,
247                         &priv->io_dmabuf->bits32, sizeof(val), HZ / 2);
248
249         mutex_unlock(&priv->io_mutex);
250 }
251
252 static inline void rtl818x_iowrite32(struct rtl8187_priv *priv, __le32 *addr,
253                                      u32 val)
254 {
255         rtl818x_iowrite32_idx(priv, addr, val, 0);
256 }
257
258 #endif /* RTL8187_H */