Linux-libre 4.14.14-gnu
[librecmc/linux-libre.git] / drivers / net / wireless / realtek / rtl818x / rtl8187 / rtl8187.h
1 /*
2  * Definitions for RTL8187 hardware
3  *
4  * Copyright 2007 Michael Wu <flamingice@sourmilk.net>
5  * Copyright 2007 Andrea Merello <andrea.merello@gmail.com>
6  *
7  * Based on the r8187 driver, which is:
8  * Copyright 2005 Andrea Merello <andrea.merello@gmail.com>, 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 <linux/cache.h>
19
20 #include "rtl818x.h"
21 #include "leds.h"
22
23 #define RTL8187_EEPROM_TXPWR_BASE       0x05
24 #define RTL8187_EEPROM_MAC_ADDR         0x07
25 #define RTL8187_EEPROM_TXPWR_CHAN_1     0x16    /* 3 channels */
26 #define RTL8187_EEPROM_TXPWR_CHAN_6     0x1B    /* 2 channels */
27 #define RTL8187_EEPROM_TXPWR_CHAN_4     0x3D    /* 2 channels */
28 #define RTL8187_EEPROM_SELECT_GPIO      0x3B
29
30 #define RTL8187_REQT_READ       0xC0
31 #define RTL8187_REQT_WRITE      0x40
32 #define RTL8187_REQ_GET_REG     0x05
33 #define RTL8187_REQ_SET_REG     0x05
34
35 #define RTL8187_MAX_RX          0x9C4
36
37 #define RFKILL_MASK_8187_89_97  0x2
38 #define RFKILL_MASK_8198        0x4
39
40 #define RETRY_COUNT             7
41
42 struct rtl8187_rx_info {
43         struct urb *urb;
44         struct ieee80211_hw *dev;
45 };
46
47 struct rtl8187_rx_hdr {
48         __le32 flags;
49         u8 noise;
50         u8 signal;
51         u8 agc;
52         u8 reserved;
53         __le64 mac_time;
54 } __packed;
55
56 struct rtl8187b_rx_hdr {
57         __le32 flags;
58         __le64 mac_time;
59         u8 sq;
60         u8 rssi;
61         u8 agc;
62         u8 flags2;
63         __le16 snr_long2end;
64         s8 pwdb_g12;
65         u8 fot;
66 } __packed;
67
68 /* {rtl8187,rtl8187b}_tx_info is in skb */
69
70 struct rtl8187_tx_hdr {
71         __le32 flags;
72         __le16 rts_duration;
73         __le16 len;
74         __le32 retry;
75 } __packed;
76
77 struct rtl8187b_tx_hdr {
78         __le32 flags;
79         __le16 rts_duration;
80         __le16 len;
81         __le32 unused_1;
82         __le16 unused_2;
83         __le16 tx_duration;
84         __le32 unused_3;
85         __le32 retry;
86         __le32 unused_4[2];
87 } __packed;
88
89 enum {
90         DEVICE_RTL8187,
91         DEVICE_RTL8187B
92 };
93
94 struct rtl8187_vif {
95         struct ieee80211_hw *dev;
96
97         /* beaconing */
98         struct delayed_work beacon_work;
99         bool enable_beacon;
100 };
101
102 struct rtl8187_priv {
103         /* common between rtl818x drivers */
104         struct rtl818x_csr *map;
105         const struct rtl818x_rf_ops *rf;
106         struct ieee80211_vif *vif;
107
108         /* The mutex protects the TX loopback state.
109          * Any attempt to set channels concurrently locks the device.
110          */
111         struct mutex conf_mutex;
112
113         /* rtl8187 specific */
114         struct ieee80211_channel channels[14];
115         struct ieee80211_rate rates[12];
116         struct ieee80211_supported_band band;
117         struct usb_device *udev;
118         u32 rx_conf;
119         struct usb_anchor anchored;
120         struct delayed_work work;
121         struct ieee80211_hw *dev;
122 #ifdef CONFIG_RTL8187_LEDS
123         struct rtl8187_led led_radio;
124         struct rtl8187_led led_tx;
125         struct rtl8187_led led_rx;
126         struct delayed_work led_on;
127         struct delayed_work led_off;
128 #endif
129         u16 txpwr_base;
130         u8 asic_rev;
131         u8 is_rtl8187b;
132         enum {
133                 RTL8187BvB,
134                 RTL8187BvD,
135                 RTL8187BvE
136         } hw_rev;
137         struct sk_buff_head rx_queue;
138         u8 signal;
139         u8 noise;
140         u8 slot_time;
141         u8 aifsn[4];
142         u8 rfkill_mask;
143         struct {
144                 union {
145                         __le64 buf;
146                         u8 dummy1[L1_CACHE_BYTES];
147                 } ____cacheline_aligned;
148                 struct sk_buff_head queue;
149         } b_tx_status; /* This queue is used by both -b and non-b devices */
150         struct mutex io_mutex;
151         union {
152                 u8 bits8;
153                 __le16 bits16;
154                 __le32 bits32;
155                 u8 dummy2[L1_CACHE_BYTES];
156         } *io_dmabuf ____cacheline_aligned;
157         bool rfkill_off;
158         u16 seqno;
159 };
160
161 void rtl8187_write_phy(struct ieee80211_hw *dev, u8 addr, u32 data);
162
163 u8 rtl818x_ioread8_idx(struct rtl8187_priv *priv,
164                                 u8 *addr, u8 idx);
165
166 static inline u8 rtl818x_ioread8(struct rtl8187_priv *priv, u8 *addr)
167 {
168         return rtl818x_ioread8_idx(priv, addr, 0);
169 }
170
171 u16 rtl818x_ioread16_idx(struct rtl8187_priv *priv,
172                                 __le16 *addr, u8 idx);
173
174 static inline u16 rtl818x_ioread16(struct rtl8187_priv *priv, __le16 *addr)
175 {
176         return rtl818x_ioread16_idx(priv, addr, 0);
177 }
178
179 u32 rtl818x_ioread32_idx(struct rtl8187_priv *priv,
180                                 __le32 *addr, u8 idx);
181
182 static inline u32 rtl818x_ioread32(struct rtl8187_priv *priv, __le32 *addr)
183 {
184         return rtl818x_ioread32_idx(priv, addr, 0);
185 }
186
187 void rtl818x_iowrite8_idx(struct rtl8187_priv *priv,
188                                 u8 *addr, u8 val, u8 idx);
189
190 static inline void rtl818x_iowrite8(struct rtl8187_priv *priv, u8 *addr, u8 val)
191 {
192         rtl818x_iowrite8_idx(priv, addr, val, 0);
193 }
194
195 void rtl818x_iowrite16_idx(struct rtl8187_priv *priv,
196                                 __le16 *addr, u16 val, u8 idx);
197
198 static inline void rtl818x_iowrite16(struct rtl8187_priv *priv, __le16 *addr,
199                                      u16 val)
200 {
201         rtl818x_iowrite16_idx(priv, addr, val, 0);
202 }
203
204 void rtl818x_iowrite32_idx(struct rtl8187_priv *priv,
205                                 __le32 *addr, u32 val, u8 idx);
206
207 static inline void rtl818x_iowrite32(struct rtl8187_priv *priv, __le32 *addr,
208                                      u32 val)
209 {
210         rtl818x_iowrite32_idx(priv, addr, val, 0);
211 }
212
213 #endif /* RTL8187_H */