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