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