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