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