xref: /openwifi/driver/sdr.h (revision abdb610f56e6ff7bc54e8ad29637bde718951d91)
1 // Author: Xianjun Jiao, Michael Mehari, Wei Liu
2 // SPDX-FileCopyrightText: 2019 UGent
3 // SPDX-License-Identifier: AGPL-3.0-or-later
4 
5 #ifndef OPENWIFI_SDR
6 #define OPENWIFI_SDR
7 
8 #include "pre_def.h"
9 
10 // -------------------for leds--------------------------------
11 struct gpio_led_data { //please always align with the leds-gpio.c in linux kernel
12 	struct led_classdev cdev;
13 	struct gpio_desc *gpiod;
14 	u8 can_sleep;
15 	u8 blinking;
16 	gpio_blink_set_t platform_gpio_blink_set;
17 };
18 
19 struct gpio_leds_priv { //please always align with the leds-gpio.c in linux kernel
20 	int num_leds;
21 	struct gpio_led_data leds[];
22 };
23 
24 struct openwifi_rf_ops {
25 	char *name;
26 //	void (*init)(struct ieee80211_hw *);
27 //	void (*stop)(struct ieee80211_hw *);
28 	void (*set_chan)(struct ieee80211_hw *, struct ieee80211_conf *);
29 //	u8 (*calc_rssi)(u8 agc, u8 sq);
30 };
31 
32 struct openwifi_buffer_descriptor {
33 	// u32 num_dma_byte;
34     // u32 sn;
35     // u32 hw_queue_idx;
36     // u32 retry_limit;
37     // u32 need_ack;
38     struct sk_buff *skb_linked;
39     dma_addr_t dma_mapping_addr;
40     // u32 reserved;
41 } __packed;
42 
43 struct openwifi_ring {
44 	struct openwifi_buffer_descriptor *bds;
45     u32 bd_wr_idx;
46 	u32 bd_rd_idx;
47     u32 stop_flag; // track the stop/wake status between tx interrupt and openwifi_tx
48 	// u32 num_dma_symbol_request;
49 	// u32 reserved;
50 } __packed;
51 
52 struct openwifi_vif {
53 	struct ieee80211_hw *dev;
54 
55 	int idx; // this vif's idx on the dev
56 
57 	/* beaconing */
58 	struct delayed_work beacon_work;
59 	bool enable_beacon;
60 };
61 
62 union u32_byte4 {
63 	u32 a;
64 	u8 c[4];
65 };
66 union u16_byte2 {
67 	u16 a;
68 	u8 c[2];
69 };
70 
71 #define MAX_NUM_LED 4
72 #define OPENWIFI_LED_MAX_NAME_LEN 32
73 
74 // ------------ software reg definition ------------
75 #define MAX_NUM_DRV_REG            8
76 #define DRV_TX_REG_IDX_RATE        0
77 #define DRV_TX_REG_IDX_FREQ_BW_CFG 1
78 #define DRV_TX_REG_IDX_PRINT_CFG   (MAX_NUM_DRV_REG-1)
79 
80 #define DRV_RX_REG_IDX_FREQ_BW_CFG 1
81 #define DRV_RX_REG_IDX_EXTRA_FO    2
82 #define DRV_RX_REG_IDX_PRINT_CFG   (MAX_NUM_DRV_REG-1)
83 
84 #define DRV_XPU_REG_IDX_LBT_TH     0
85 #define DRV_XPU_REG_IDX_GIT_REV    (MAX_NUM_DRV_REG-1)
86 
87 // ------end of software reg definition ------------
88 
89 #define MAX_NUM_VIF 4
90 
91 #define LEN_PHY_HEADER 16
92 #define LEN_PHY_CRC 4
93 
94 #define RING_ROOM_THRESHOLD 4
95 #define NUM_TX_BD 64 // !!! should align to the fifo size in tx_bit_intf.v
96 
97 #ifdef USE_NEW_RX_INTERRUPT
98 #define NUM_RX_BD 8
99 #else
100 #define NUM_RX_BD 16
101 #endif
102 
103 #define TX_BD_BUF_SIZE (8192)
104 #define RX_BD_BUF_SIZE (8192)
105 
106 #define NUM_BIT_MAX_NUM_HW_QUEUE 2
107 #define MAX_NUM_HW_QUEUE 4 // number of queue in FPGA
108 #define MAX_NUM_SW_QUEUE 4 // number of queue in Linux, depends on the number we report by dev->queues in openwifi_dev_probe
109 #define NUM_BIT_MAX_PHY_TX_SN 10 // decrease 12 to 10 to reserve 2 bits storing related linux prio idx
110 #define MAX_PHY_TX_SN ((1<<NUM_BIT_MAX_PHY_TX_SN)-1)
111 
112 #define AD9361_RADIO_OFF_TX_ATT 89750 //please align with ad9361.c
113 #define AD9361_RADIO_ON_TX_ATT 000    //please align with rf_init.sh
114 
115 #define SDR_SUPPORTED_FILTERS	\
116 	(FIF_ALLMULTI |				\
117 	FIF_BCN_PRBRESP_PROMISC |	\
118 	FIF_CONTROL |				\
119 	FIF_OTHER_BSS |				\
120 	FIF_PSPOLL |				\
121 	FIF_PROBE_REQ)
122 
123 #define HIGH_PRIORITY_DISCARD_FLAG ((~0x040)<<16) // don't force drop OTHER_BSS by high priority discard
124 //#define HIGH_PRIORITY_DISCARD_FLAG ((~0x140)<<16) // don't force drop OTHER_BSS and PROB_REQ by high priority discard
125 
126 /* 5G chan 36 - chan 64*/
127 #define SDR_5GHZ_CH36_64	\
128 	REG_RULE(5150-10, 5350+10, 80, 0, 20, 0)
129 /* 5G chan 36 - chan 48*/
130 #define SDR_5GHZ_CH36_48	\
131 	REG_RULE(5150-10, 5270+10, 80, 0, 20, 0)
132 
133 /*
134  *Only these channels all allow active
135  *scan on all world regulatory domains
136  */
137 #define SDR_2GHZ_CH01_13	REG_RULE(2412-10, 2472+10, 40, 0, 20, NL80211_RRF_NO_CCK) // disable 11b
138 #define SDR_2GHZ_CH01_14	REG_RULE(2412-10, 2484+10, 40, 0, 20, NL80211_RRF_NO_CCK) // disable 11b
139 
140 // regulatory.h alpha2
141 //  *	00 - World regulatory domain
142 //  *	99 - built by driver but a specific alpha2 cannot be determined
143 //  *	98 - result of an intersection between two regulatory domains
144 //  *	97 - regulatory domain has not yet been configured
145 static const struct ieee80211_regdomain sdr_regd = { // for wiphy_apply_custom_regulatory
146 	.n_reg_rules = 2,
147 	.alpha2 = "99",
148 	.dfs_region = NL80211_DFS_ETSI,
149 	.reg_rules = {
150 		//SDR_2GHZ_CH01_13,
151 		//SDR_5GHZ_CH36_48, //Avoid radar!
152 		SDR_2GHZ_CH01_14,
153 		SDR_5GHZ_CH36_64,
154 		}
155 };
156 
157 #define CHAN2G(_channel, _freq, _flags) { \
158 	.band			= NL80211_BAND_2GHZ, \
159 	.hw_value		= (_channel), \
160 	.center_freq		= (_freq), \
161 	.flags			= (_flags), \
162 	.max_antenna_gain	= 0, \
163 	.max_power		= 0, \
164 }
165 
166 #define CHAN5G(_channel, _freq, _flags) { \
167 	.band			= NL80211_BAND_5GHZ, \
168 	.hw_value		= (_channel), \
169 	.center_freq		= (_freq), \
170 	.flags			= (_flags), \
171 	.max_antenna_gain	= 0, \
172 	.max_power		= 0, \
173 }
174 
175 static const struct ieee80211_rate openwifi_5GHz_rates[] = {
176 	{ .bitrate = 10,  .hw_value = 0,  .flags = 0},
177 	{ .bitrate = 20,  .hw_value = 1,  .flags = 0},
178 	{ .bitrate = 55,  .hw_value = 2,  .flags = 0},
179 	{ .bitrate = 110, .hw_value = 3,  .flags = 0},
180 	{ .bitrate = 60,  .hw_value = 4,  .flags = IEEE80211_RATE_MANDATORY_A},
181 	{ .bitrate = 90,  .hw_value = 5,  .flags = IEEE80211_RATE_MANDATORY_A},
182 	{ .bitrate = 120, .hw_value = 6,  .flags = IEEE80211_RATE_MANDATORY_A},
183 	{ .bitrate = 180, .hw_value = 7,  .flags = IEEE80211_RATE_MANDATORY_A},
184 	{ .bitrate = 240, .hw_value = 8,  .flags = IEEE80211_RATE_MANDATORY_A},
185 	{ .bitrate = 360, .hw_value = 9,  .flags = IEEE80211_RATE_MANDATORY_A},
186 	{ .bitrate = 480, .hw_value = 10, .flags = IEEE80211_RATE_MANDATORY_A},
187 	{ .bitrate = 540, .hw_value = 11, .flags = IEEE80211_RATE_MANDATORY_A},
188 };
189 
190 static const struct ieee80211_rate openwifi_2GHz_rates[] = {
191 	{ .bitrate = 10,  .hw_value = 0,  .flags = 0},
192 	{ .bitrate = 20,  .hw_value = 1,  .flags = 0},
193 	{ .bitrate = 55,  .hw_value = 2,  .flags = 0},
194 	{ .bitrate = 110, .hw_value = 3,  .flags = 0},
195 	{ .bitrate = 60,  .hw_value = 4,  .flags = IEEE80211_RATE_MANDATORY_G|IEEE80211_RATE_ERP_G},
196 	{ .bitrate = 90,  .hw_value = 5,  .flags = IEEE80211_RATE_MANDATORY_G|IEEE80211_RATE_ERP_G},
197 	{ .bitrate = 120, .hw_value = 6,  .flags = IEEE80211_RATE_MANDATORY_G|IEEE80211_RATE_ERP_G},
198 	{ .bitrate = 180, .hw_value = 7,  .flags = IEEE80211_RATE_MANDATORY_G|IEEE80211_RATE_ERP_G},
199 	{ .bitrate = 240, .hw_value = 8,  .flags = IEEE80211_RATE_MANDATORY_G|IEEE80211_RATE_ERP_G},
200 	{ .bitrate = 360, .hw_value = 9,  .flags = IEEE80211_RATE_MANDATORY_G|IEEE80211_RATE_ERP_G},
201 	{ .bitrate = 480, .hw_value = 10, .flags = IEEE80211_RATE_MANDATORY_G|IEEE80211_RATE_ERP_G},
202 	{ .bitrate = 540, .hw_value = 11, .flags = IEEE80211_RATE_MANDATORY_G|IEEE80211_RATE_ERP_G},
203 };
204 
205 static const struct ieee80211_channel openwifi_2GHz_channels[] = {
206 	CHAN2G(1, 2412, 0),
207 	CHAN2G(2, 2417, 0),
208 	CHAN2G(3, 2422, 0),
209 	CHAN2G(4, 2427, 0),
210 	CHAN2G(5, 2432, 0),
211 	CHAN2G(6, 2437, 0),
212 	CHAN2G(7, 2442, 0),
213 	CHAN2G(8, 2447, 0),
214 	CHAN2G(9, 2452, 0),
215 	CHAN2G(10, 2457, 0),
216 	CHAN2G(11, 2462, 0),
217 	CHAN2G(12, 2467, 0),
218 	CHAN2G(13, 2472, 0),
219 	CHAN2G(14, 2484, 0),
220 };
221 
222 static const struct ieee80211_channel openwifi_5GHz_channels[] = {
223 	CHAN5G(36, 5180, 0),
224 	CHAN5G(38, 5190, 0),
225 	CHAN5G(40, 5200, 0),
226 	CHAN5G(42, 5210, 0),
227 	CHAN5G(44, 5220, 0),
228 	CHAN5G(46, 5230, 0),
229 	CHAN5G(48, 5240, 0),
230 	CHAN5G(52, 5260, IEEE80211_CHAN_RADAR),
231 	CHAN5G(56, 5280, IEEE80211_CHAN_RADAR),
232 	CHAN5G(60, 5300, IEEE80211_CHAN_RADAR),
233 	CHAN5G(64, 5320, IEEE80211_CHAN_RADAR),
234 	// CHAN5G(100, 5500, 0),
235 	// CHAN5G(104, 5520, 0),
236 	// CHAN5G(108, 5540, 0),
237 	// CHAN5G(112, 5560, 0),
238 	// CHAN5G(116, 5580, 0),
239 	// CHAN5G(120, 5600, 0),
240 	// CHAN5G(124, 5620, 0),
241 	// CHAN5G(128, 5640, 0),
242 	// CHAN5G(132, 5660, 0),
243 	// CHAN5G(136, 5680, 0),
244 	// CHAN5G(140, 5700, 0),
245 	// CHAN5G(144, 5720, 0),
246 	// CHAN5G(149, 5745, 0),
247 	// CHAN5G(153, 5765, 0),
248 	// CHAN5G(157, 5785, 0),
249 	// CHAN5G(161, 5805, 0),
250 	// CHAN5G(165, 5825, 0),
251 	// CHAN5G(169, 5845, 0),
252 };
253 
254 static const struct ieee80211_iface_limit openwifi_if_limits[] = {
255 	{ .max = 2048,	.types = BIT(NL80211_IFTYPE_STATION) },
256 	{ .max = 4,	.types =
257 #ifdef CONFIG_MAC80211_MESH
258 				 BIT(NL80211_IFTYPE_MESH_POINT) |
259 #endif
260 				 BIT(NL80211_IFTYPE_AP) },
261 };
262 
263 static const struct ieee80211_iface_combination openwifi_if_comb = {
264 	.limits = openwifi_if_limits,
265 	.n_limits = ARRAY_SIZE(openwifi_if_limits),
266 	.max_interfaces = 2048,
267 	.num_different_channels = 1,
268 	.radar_detect_widths =	BIT(NL80211_CHAN_WIDTH_20_NOHT) |
269 					BIT(NL80211_CHAN_WIDTH_20) |
270 					BIT(NL80211_CHAN_WIDTH_40) |
271 					BIT(NL80211_CHAN_WIDTH_80),
272 };
273 
274 static const u8  wifi_rate_table_mapping[24] =     { 0,  0,  0,   0,  0,  0,   0,   0,  10,   8,   6,   4,  11,   9,   7,  5,   0,    1,   2,   3,   4,   5,   6,   7};
275 static const u16 wifi_rate_table[24] =             { 0,  0,  0,   0,  0,  0,   0,   0, 480, 240, 120,  60, 540, 360, 180, 90,  65,  130, 195, 260, 390, 520, 585, 650};
276 static const u16 wifi_rate_all[20] =               {10, 20, 55, 110, 60, 90, 120, 180, 240, 360, 480, 540,  65, 130, 195, 260, 390, 520, 585, 650};
277 static const u8  wifi_mcs_table_11b_force_up[16] = {11, 11, 11,  11, 11, 15,  10,  14,   9,  13,   8,  12,   0,   0,   0,  0};
278 static const u16 wifi_n_dbps_table[16] =           {24, 24, 24,  24, 24, 36,  48,  72,  96, 144, 192, 216,   0,   0,   0,  0};
279 static const u16 wifi_n_dbps_ht_table[16] =        {26, 26, 26,  26, 26, 52,  78, 104, 156, 208, 234, 260,   0,   0,   0,  0};
280 // static const u8 wifi_mcs_table[8] =             {6,9,12,18,24,36,48,54};
281 // static const u8 wifi_mcs_table_phy_tx[8]    =   {11,15,10,14,9,13,8,12};
282 
283 // ===== copy from adi-linux/drivers/iio/frequency/cf_axi_dds.c =====
284 struct cf_axi_dds_state {
285 	struct device			*dev_spi;
286 	struct clk			*clk;
287 	struct cf_axi_dds_chip_info	*chip_info;
288 	struct gpio_desc		*plddrbypass_gpio;
289 	struct gpio_desc		*interpolation_gpio;
290 
291 	bool				standalone;
292 	bool				dp_disable;
293 	bool				enable;
294 	bool				pl_dma_fifo_en;
295 	enum fifo_ctrl			gpio_dma_fifo_ctrl;
296 
297 	struct iio_info			iio_info;
298 	size_t				regs_size;
299 	void __iomem			*regs;
300 	void __iomem			*slave_regs;
301 	void __iomem			*master_regs;
302 	u64				dac_clk;
303 	unsigned int			ddr_dds_interp_en;
304 	unsigned int			cached_freq[16];
305 	unsigned int			version;
306 	unsigned int			have_slave_channels;
307 	unsigned int			interpolation_factor;
308 	struct notifier_block		clk_nb;
309 };
310 // ===== end of copy from adi-linux/drivers/iio/frequency/cf_axi_dds.c =====
311 
312 #define RX_DMA_CYCLIC_MODE
313 struct openwifi_priv {
314 	struct platform_device *pdev;
315 	struct ieee80211_vif *vif[MAX_NUM_VIF];
316 
317 	const struct openwifi_rf_ops *rf;
318 	enum openwifi_fpga_type fpga_type;
319 
320 	struct cf_axi_dds_state *dds_st;  //axi_ad9361 hdl ref design module, dac channel
321 	struct axiadc_state *adc_st;      //axi_ad9361 hdl ref design module, adc channel
322 	struct ad9361_rf_phy *ad9361_phy; //ad9361 chip
323 	struct ctrl_outs_control ctrl_out;
324 
325 	int rx_freq_offset_to_lo_MHz;
326 	int tx_freq_offset_to_lo_MHz;
327 	u32 rf_bw;
328 	u32 actual_rx_lo;
329 
330 	struct ieee80211_rate rates_2GHz[12];
331 	struct ieee80211_rate rates_5GHz[12];
332 	struct ieee80211_channel channels_2GHz[14];
333 	struct ieee80211_channel channels_5GHz[11];
334 	struct ieee80211_supported_band band_2GHz;
335 	struct ieee80211_supported_band band_5GHz;
336 	bool rfkill_off;
337 
338 	int rssi_correction; // dynamic RSSI correction according to current channel in _rf_set_channel()
339 
340 	enum rx_intf_mode rx_intf_cfg;
341 	enum tx_intf_mode tx_intf_cfg;
342 	enum openofdm_rx_mode openofdm_rx_cfg;
343 	enum openofdm_tx_mode openofdm_tx_cfg;
344 	enum xpu_mode xpu_cfg;
345 
346 	int irq_rx;
347 	int irq_tx;
348 
349 	// u32 call_counter;
350 	u8 *rx_cyclic_buf;
351 	dma_addr_t rx_cyclic_buf_dma_mapping_addr;
352 	struct dma_chan *rx_chan;
353 	struct dma_async_tx_descriptor *rxd;
354 	dma_cookie_t rx_cookie;
355 
356 	struct openwifi_ring tx_ring[MAX_NUM_SW_QUEUE];
357 	struct scatterlist tx_sg;
358 	struct dma_chan *tx_chan;
359 	struct dma_async_tx_descriptor *txd;
360 	dma_cookie_t tx_cookie;
361 	// struct completion tx_dma_complete;
362 	// bool openwifi_tx_first_time_run;
363 
364 	// int phy_tx_sn;
365 	u32 slice_idx;
366 	u32 dest_mac_addr_queue_map[MAX_NUM_HW_QUEUE];
367 	u8 mac_addr[ETH_ALEN];
368 	u16 seqno;
369 
370 	bool use_short_slot;
371 	u8 band;
372 	u16 channel;
373 
374 	u32 drv_rx_reg_val[MAX_NUM_DRV_REG];
375 	u32 drv_tx_reg_val[MAX_NUM_DRV_REG];
376 	u32 drv_xpu_reg_val[MAX_NUM_DRV_REG];
377 	int last_auto_fpga_lbt_th;
378 	// u8 num_led;
379 	// struct led_classdev *led[MAX_NUM_LED];//zc706 has 4 user leds. please find openwifi_dev_probe to see how we get them.
380 	// char led_name[MAX_NUM_LED][OPENWIFI_LED_MAX_NAME_LEN];
381 
382 	spinlock_t lock;
383 };
384 
385 #endif /* OPENWIFI_SDR */
386