1 /*
2 * Copyright (c) 2012-2016 Qualcomm Atheros, Inc.
3 *
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
7 *
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 */
16
17 #ifndef __WIL6210_H__
18 #define __WIL6210_H__
19
20 #include <linux/etherdevice.h>
21 #include <linux/netdevice.h>
22 #include <linux/wireless.h>
23 #include <net/cfg80211.h>
24 #include <linux/timex.h>
25 #include <linux/types.h>
26 #include "wmi.h"
27 #include "wil_platform.h"
28
29 extern bool no_fw_recovery;
30 extern unsigned int mtu_max;
31 extern unsigned short rx_ring_overflow_thrsh;
32 extern int agg_wsize;
33 extern u32 vring_idle_trsh;
34 extern bool rx_align_2;
35 extern bool debug_fw;
36
37 #define WIL_NAME "wil6210"
38 #define WIL_FW_NAME "wil6210.fw" /* code */
39 #define WIL_FW2_NAME "wil6210.brd" /* board & radio parameters */
40
41 #define WIL_MAX_BUS_REQUEST_KBPS 800000 /* ~6.1Gbps */
42
43 /**
44 * extract bits [@b0:@b1] (inclusive) from the value @x
45 * it should be @b0 <= @b1, or result is incorrect
46 */
WIL_GET_BITS(u32 x,int b0,int b1)47 static inline u32 WIL_GET_BITS(u32 x, int b0, int b1)
48 {
49 return (x >> b0) & ((1 << (b1 - b0 + 1)) - 1);
50 }
51
52 #define WIL6210_MEM_SIZE (2*1024*1024UL)
53
54 #define WIL_TX_Q_LEN_DEFAULT (4000)
55 #define WIL_RX_RING_SIZE_ORDER_DEFAULT (10)
56 #define WIL_TX_RING_SIZE_ORDER_DEFAULT (12)
57 #define WIL_BCAST_RING_SIZE_ORDER_DEFAULT (7)
58 #define WIL_BCAST_MCS0_LIMIT (1024) /* limit for MCS0 frame size */
59 /* limit ring size in range [32..32k] */
60 #define WIL_RING_SIZE_ORDER_MIN (5)
61 #define WIL_RING_SIZE_ORDER_MAX (15)
62 #define WIL6210_MAX_TX_RINGS (24) /* HW limit */
63 #define WIL6210_MAX_CID (8) /* HW limit */
64 #define WIL6210_NAPI_BUDGET (16) /* arbitrary */
65 #define WIL_MAX_AMPDU_SIZE (64 * 1024) /* FW/HW limit */
66 #define WIL_MAX_AGG_WSIZE (32) /* FW/HW limit */
67 /* Hardware offload block adds the following:
68 * 26 bytes - 3-address QoS data header
69 * 8 bytes - IV + EIV (for GCMP)
70 * 8 bytes - SNAP
71 * 16 bytes - MIC (for GCMP)
72 * 4 bytes - CRC
73 */
74 #define WIL_MAX_MPDU_OVERHEAD (62)
75
76 /* Calculate MAC buffer size for the firmware. It includes all overhead,
77 * as it will go over the air, and need to be 8 byte aligned
78 */
wil_mtu2macbuf(u32 mtu)79 static inline u32 wil_mtu2macbuf(u32 mtu)
80 {
81 return ALIGN(mtu + WIL_MAX_MPDU_OVERHEAD, 8);
82 }
83
84 /* MTU for Ethernet need to take into account 8-byte SNAP header
85 * to be added when encapsulating Ethernet frame into 802.11
86 */
87 #define WIL_MAX_ETH_MTU (IEEE80211_MAX_DATA_LEN_DMG - 8)
88 /* Max supported by wil6210 value for interrupt threshold is 5sec. */
89 #define WIL6210_ITR_TRSH_MAX (5000000)
90 #define WIL6210_ITR_TX_INTERFRAME_TIMEOUT_DEFAULT (13) /* usec */
91 #define WIL6210_ITR_RX_INTERFRAME_TIMEOUT_DEFAULT (13) /* usec */
92 #define WIL6210_ITR_TX_MAX_BURST_DURATION_DEFAULT (500) /* usec */
93 #define WIL6210_ITR_RX_MAX_BURST_DURATION_DEFAULT (500) /* usec */
94 #define WIL6210_FW_RECOVERY_RETRIES (5) /* try to recover this many times */
95 #define WIL6210_FW_RECOVERY_TO msecs_to_jiffies(5000)
96 #define WIL6210_SCAN_TO msecs_to_jiffies(10000)
97 #define WIL6210_DISCONNECT_TO_MS (2000)
98 #define WIL6210_RX_HIGH_TRSH_INIT (0)
99 #define WIL6210_RX_HIGH_TRSH_DEFAULT \
100 (1 << (WIL_RX_RING_SIZE_ORDER_DEFAULT - 3))
101 /* Hardware definitions begin */
102
103 /*
104 * Mapping
105 * RGF File | Host addr | FW addr
106 * | |
107 * user_rgf | 0x000000 | 0x880000
108 * dma_rgf | 0x001000 | 0x881000
109 * pcie_rgf | 0x002000 | 0x882000
110 * | |
111 */
112
113 /* Where various structures placed in host address space */
114 #define WIL6210_FW_HOST_OFF (0x880000UL)
115
116 #define HOSTADDR(fwaddr) (fwaddr - WIL6210_FW_HOST_OFF)
117
118 /*
119 * Interrupt control registers block
120 *
121 * each interrupt controlled by the same bit in all registers
122 */
123 struct RGF_ICR {
124 u32 ICC; /* Cause Control, RW: 0 - W1C, 1 - COR */
125 u32 ICR; /* Cause, W1C/COR depending on ICC */
126 u32 ICM; /* Cause masked (ICR & ~IMV), W1C/COR depending on ICC */
127 u32 ICS; /* Cause Set, WO */
128 u32 IMV; /* Mask, RW+S/C */
129 u32 IMS; /* Mask Set, write 1 to set */
130 u32 IMC; /* Mask Clear, write 1 to clear */
131 } __packed;
132
133 /* registers - FW addresses */
134 #define RGF_USER_USAGE_1 (0x880004)
135 #define RGF_USER_USAGE_6 (0x880018)
136 #define BIT_USER_OOB_MODE BIT(31)
137 #define RGF_USER_HW_MACHINE_STATE (0x8801dc)
138 #define HW_MACHINE_BOOT_DONE (0x3fffffd)
139 #define RGF_USER_USER_CPU_0 (0x8801e0)
140 #define BIT_USER_USER_CPU_MAN_RST BIT(1) /* user_cpu_man_rst */
141 #define RGF_USER_MAC_CPU_0 (0x8801fc)
142 #define BIT_USER_MAC_CPU_MAN_RST BIT(1) /* mac_cpu_man_rst */
143 #define RGF_USER_USER_SCRATCH_PAD (0x8802bc)
144 #define RGF_USER_BL (0x880A3C) /* Boot Loader */
145 #define RGF_USER_FW_REV_ID (0x880a8c) /* chip revision */
146 #define RGF_USER_CLKS_CTL_0 (0x880abc)
147 #define BIT_USER_CLKS_CAR_AHB_SW_SEL BIT(1) /* ref clk/PLL */
148 #define BIT_USER_CLKS_RST_PWGD BIT(11) /* reset on "power good" */
149 #define RGF_USER_CLKS_CTL_SW_RST_VEC_0 (0x880b04)
150 #define RGF_USER_CLKS_CTL_SW_RST_VEC_1 (0x880b08)
151 #define RGF_USER_CLKS_CTL_SW_RST_VEC_2 (0x880b0c)
152 #define RGF_USER_CLKS_CTL_SW_RST_VEC_3 (0x880b10)
153 #define RGF_USER_CLKS_CTL_SW_RST_MASK_0 (0x880b14)
154 #define BIT_HPAL_PERST_FROM_PAD BIT(6)
155 #define BIT_CAR_PERST_RST BIT(7)
156 #define RGF_USER_USER_ICR (0x880b4c) /* struct RGF_ICR */
157 #define BIT_USER_USER_ICR_SW_INT_2 BIT(18)
158 #define RGF_USER_CLKS_CTL_EXT_SW_RST_VEC_0 (0x880c18)
159 #define RGF_USER_CLKS_CTL_EXT_SW_RST_VEC_1 (0x880c2c)
160 #define RGF_USER_SPARROW_M_4 (0x880c50) /* Sparrow */
161 #define BIT_SPARROW_M_4_SEL_SLEEP_OR_REF BIT(2)
162
163 #define RGF_DMA_EP_TX_ICR (0x881bb4) /* struct RGF_ICR */
164 #define BIT_DMA_EP_TX_ICR_TX_DONE BIT(0)
165 #define BIT_DMA_EP_TX_ICR_TX_DONE_N(n) BIT(n+1) /* n = [0..23] */
166 #define RGF_DMA_EP_RX_ICR (0x881bd0) /* struct RGF_ICR */
167 #define BIT_DMA_EP_RX_ICR_RX_DONE BIT(0)
168 #define BIT_DMA_EP_RX_ICR_RX_HTRSH BIT(1)
169 #define RGF_DMA_EP_MISC_ICR (0x881bec) /* struct RGF_ICR */
170 #define BIT_DMA_EP_MISC_ICR_RX_HTRSH BIT(0)
171 #define BIT_DMA_EP_MISC_ICR_TX_NO_ACT BIT(1)
172 #define BIT_DMA_EP_MISC_ICR_HALP BIT(27)
173 #define BIT_DMA_EP_MISC_ICR_FW_INT(n) BIT(28+n) /* n = [0..3] */
174
175 /* Legacy interrupt moderation control (before Sparrow v2)*/
176 #define RGF_DMA_ITR_CNT_TRSH (0x881c5c)
177 #define RGF_DMA_ITR_CNT_DATA (0x881c60)
178 #define RGF_DMA_ITR_CNT_CRL (0x881c64)
179 #define BIT_DMA_ITR_CNT_CRL_EN BIT(0)
180 #define BIT_DMA_ITR_CNT_CRL_EXT_TICK BIT(1)
181 #define BIT_DMA_ITR_CNT_CRL_FOREVER BIT(2)
182 #define BIT_DMA_ITR_CNT_CRL_CLR BIT(3)
183 #define BIT_DMA_ITR_CNT_CRL_REACH_TRSH BIT(4)
184
185 /* Offload control (Sparrow B0+) */
186 #define RGF_DMA_OFUL_NID_0 (0x881cd4)
187 #define BIT_DMA_OFUL_NID_0_RX_EXT_TR_EN BIT(0)
188 #define BIT_DMA_OFUL_NID_0_TX_EXT_TR_EN BIT(1)
189 #define BIT_DMA_OFUL_NID_0_RX_EXT_A3_SRC BIT(2)
190 #define BIT_DMA_OFUL_NID_0_TX_EXT_A3_SRC BIT(3)
191
192 /* New (sparrow v2+) interrupt moderation control */
193 #define RGF_DMA_ITR_TX_DESQ_NO_MOD (0x881d40)
194 #define RGF_DMA_ITR_TX_CNT_TRSH (0x881d34)
195 #define RGF_DMA_ITR_TX_CNT_DATA (0x881d38)
196 #define RGF_DMA_ITR_TX_CNT_CTL (0x881d3c)
197 #define BIT_DMA_ITR_TX_CNT_CTL_EN BIT(0)
198 #define BIT_DMA_ITR_TX_CNT_CTL_EXT_TIC_SEL BIT(1)
199 #define BIT_DMA_ITR_TX_CNT_CTL_FOREVER BIT(2)
200 #define BIT_DMA_ITR_TX_CNT_CTL_CLR BIT(3)
201 #define BIT_DMA_ITR_TX_CNT_CTL_REACHED_TRESH BIT(4)
202 #define BIT_DMA_ITR_TX_CNT_CTL_CROSS_EN BIT(5)
203 #define BIT_DMA_ITR_TX_CNT_CTL_FREE_RUNNIG BIT(6)
204 #define RGF_DMA_ITR_TX_IDL_CNT_TRSH (0x881d60)
205 #define RGF_DMA_ITR_TX_IDL_CNT_DATA (0x881d64)
206 #define RGF_DMA_ITR_TX_IDL_CNT_CTL (0x881d68)
207 #define BIT_DMA_ITR_TX_IDL_CNT_CTL_EN BIT(0)
208 #define BIT_DMA_ITR_TX_IDL_CNT_CTL_EXT_TIC_SEL BIT(1)
209 #define BIT_DMA_ITR_TX_IDL_CNT_CTL_FOREVER BIT(2)
210 #define BIT_DMA_ITR_TX_IDL_CNT_CTL_CLR BIT(3)
211 #define BIT_DMA_ITR_TX_IDL_CNT_CTL_REACHED_TRESH BIT(4)
212 #define RGF_DMA_ITR_RX_DESQ_NO_MOD (0x881d50)
213 #define RGF_DMA_ITR_RX_CNT_TRSH (0x881d44)
214 #define RGF_DMA_ITR_RX_CNT_DATA (0x881d48)
215 #define RGF_DMA_ITR_RX_CNT_CTL (0x881d4c)
216 #define BIT_DMA_ITR_RX_CNT_CTL_EN BIT(0)
217 #define BIT_DMA_ITR_RX_CNT_CTL_EXT_TIC_SEL BIT(1)
218 #define BIT_DMA_ITR_RX_CNT_CTL_FOREVER BIT(2)
219 #define BIT_DMA_ITR_RX_CNT_CTL_CLR BIT(3)
220 #define BIT_DMA_ITR_RX_CNT_CTL_REACHED_TRESH BIT(4)
221 #define BIT_DMA_ITR_RX_CNT_CTL_CROSS_EN BIT(5)
222 #define BIT_DMA_ITR_RX_CNT_CTL_FREE_RUNNIG BIT(6)
223 #define RGF_DMA_ITR_RX_IDL_CNT_TRSH (0x881d54)
224 #define RGF_DMA_ITR_RX_IDL_CNT_DATA (0x881d58)
225 #define RGF_DMA_ITR_RX_IDL_CNT_CTL (0x881d5c)
226 #define BIT_DMA_ITR_RX_IDL_CNT_CTL_EN BIT(0)
227 #define BIT_DMA_ITR_RX_IDL_CNT_CTL_EXT_TIC_SEL BIT(1)
228 #define BIT_DMA_ITR_RX_IDL_CNT_CTL_FOREVER BIT(2)
229 #define BIT_DMA_ITR_RX_IDL_CNT_CTL_CLR BIT(3)
230 #define BIT_DMA_ITR_RX_IDL_CNT_CTL_REACHED_TRESH BIT(4)
231
232 #define RGF_DMA_PSEUDO_CAUSE (0x881c68)
233 #define RGF_DMA_PSEUDO_CAUSE_MASK_SW (0x881c6c)
234 #define RGF_DMA_PSEUDO_CAUSE_MASK_FW (0x881c70)
235 #define BIT_DMA_PSEUDO_CAUSE_RX BIT(0)
236 #define BIT_DMA_PSEUDO_CAUSE_TX BIT(1)
237 #define BIT_DMA_PSEUDO_CAUSE_MISC BIT(2)
238
239 #define RGF_HP_CTRL (0x88265c)
240 #define RGF_PCIE_LOS_COUNTER_CTL (0x882dc4)
241
242 /* MAC timer, usec, for packet lifetime */
243 #define RGF_MAC_MTRL_COUNTER_0 (0x886aa8)
244
245 #define RGF_CAF_ICR (0x88946c) /* struct RGF_ICR */
246 #define RGF_CAF_OSC_CONTROL (0x88afa4)
247 #define BIT_CAF_OSC_XTAL_EN BIT(0)
248 #define RGF_CAF_PLL_LOCK_STATUS (0x88afec)
249 #define BIT_CAF_OSC_DIG_XTAL_STABLE BIT(0)
250
251 #define RGF_USER_JTAG_DEV_ID (0x880b34) /* device ID */
252 #define JTAG_DEV_ID_SPARROW_B0 (0x2632072f)
253
254 /* crash codes for FW/Ucode stored here */
255 #define RGF_FW_ASSERT_CODE (0x91f020)
256 #define RGF_UCODE_ASSERT_CODE (0x91f028)
257
258 enum {
259 HW_VER_UNKNOWN,
260 HW_VER_SPARROW_B0, /* JTAG_DEV_ID_SPARROW_B0 */
261 };
262
263 /* popular locations */
264 #define RGF_MBOX RGF_USER_USER_SCRATCH_PAD
265 #define HOST_MBOX HOSTADDR(RGF_MBOX)
266 #define SW_INT_MBOX BIT_USER_USER_ICR_SW_INT_2
267
268 /* ISR register bits */
269 #define ISR_MISC_FW_READY BIT_DMA_EP_MISC_ICR_FW_INT(0)
270 #define ISR_MISC_MBOX_EVT BIT_DMA_EP_MISC_ICR_FW_INT(1)
271 #define ISR_MISC_FW_ERROR BIT_DMA_EP_MISC_ICR_FW_INT(3)
272
273 /* Hardware definitions end */
274 struct fw_map {
275 u32 from; /* linker address - from, inclusive */
276 u32 to; /* linker address - to, exclusive */
277 u32 host; /* PCI/Host address - BAR0 + 0x880000 */
278 const char *name; /* for debugfs */
279 };
280
281 /* array size should be in sync with actual definition in the wmi.c */
282 extern const struct fw_map fw_mapping[8];
283
284 /**
285 * mk_cidxtid - construct @cidxtid field
286 * @cid: CID value
287 * @tid: TID value
288 *
289 * @cidxtid field encoded as bits 0..3 - CID; 4..7 - TID
290 */
mk_cidxtid(u8 cid,u8 tid)291 static inline u8 mk_cidxtid(u8 cid, u8 tid)
292 {
293 return ((tid & 0xf) << 4) | (cid & 0xf);
294 }
295
296 /**
297 * parse_cidxtid - parse @cidxtid field
298 * @cid: store CID value here
299 * @tid: store TID value here
300 *
301 * @cidxtid field encoded as bits 0..3 - CID; 4..7 - TID
302 */
parse_cidxtid(u8 cidxtid,u8 * cid,u8 * tid)303 static inline void parse_cidxtid(u8 cidxtid, u8 *cid, u8 *tid)
304 {
305 *cid = cidxtid & 0xf;
306 *tid = (cidxtid >> 4) & 0xf;
307 }
308
309 struct wil6210_mbox_ring {
310 u32 base;
311 u16 entry_size; /* max. size of mbox entry, incl. all headers */
312 u16 size;
313 u32 tail;
314 u32 head;
315 } __packed;
316
317 struct wil6210_mbox_ring_desc {
318 __le32 sync;
319 __le32 addr;
320 } __packed;
321
322 /* at HOST_OFF_WIL6210_MBOX_CTL */
323 struct wil6210_mbox_ctl {
324 struct wil6210_mbox_ring tx;
325 struct wil6210_mbox_ring rx;
326 } __packed;
327
328 struct wil6210_mbox_hdr {
329 __le16 seq;
330 __le16 len; /* payload, bytes after this header */
331 __le16 type;
332 u8 flags;
333 u8 reserved;
334 } __packed;
335
336 #define WIL_MBOX_HDR_TYPE_WMI (0)
337
338 /* max. value for wil6210_mbox_hdr.len */
339 #define MAX_MBOXITEM_SIZE (240)
340
341 struct pending_wmi_event {
342 struct list_head list;
343 struct {
344 struct wil6210_mbox_hdr hdr;
345 struct wmi_cmd_hdr wmi;
346 u8 data[0];
347 } __packed event;
348 };
349
350 enum { /* for wil_ctx.mapped_as */
351 wil_mapped_as_none = 0,
352 wil_mapped_as_single = 1,
353 wil_mapped_as_page = 2,
354 };
355
356 /**
357 * struct wil_ctx - software context for Vring descriptor
358 */
359 struct wil_ctx {
360 struct sk_buff *skb;
361 u8 nr_frags;
362 u8 mapped_as;
363 };
364
365 union vring_desc;
366
367 struct vring {
368 dma_addr_t pa;
369 volatile union vring_desc *va; /* vring_desc[size], WriteBack by DMA */
370 u16 size; /* number of vring_desc elements */
371 u32 swtail;
372 u32 swhead;
373 u32 hwtail; /* write here to inform hw */
374 struct wil_ctx *ctx; /* ctx[size] - software context */
375 };
376
377 /**
378 * Additional data for Tx Vring
379 */
380 struct vring_tx_data {
381 bool dot1x_open;
382 int enabled;
383 cycles_t idle, last_idle, begin;
384 u8 agg_wsize; /* agreed aggregation window, 0 - no agg */
385 u16 agg_timeout;
386 u8 agg_amsdu;
387 bool addba_in_progress; /* if set, agg_xxx is for request in progress */
388 spinlock_t lock;
389 };
390
391 enum { /* for wil6210_priv.status */
392 wil_status_fwready = 0, /* FW operational */
393 wil_status_fwconnecting,
394 wil_status_fwconnected,
395 wil_status_dontscan,
396 wil_status_mbox_ready, /* MBOX structures ready */
397 wil_status_irqen, /* FIXME: interrupts enabled - for debug */
398 wil_status_napi_en, /* NAPI enabled protected by wil->mutex */
399 wil_status_resetting, /* reset in progress */
400 wil_status_last /* keep last */
401 };
402
403 struct pci_dev;
404
405 /**
406 * struct tid_ampdu_rx - TID aggregation information (Rx).
407 *
408 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
409 * @reorder_time: jiffies when skb was added
410 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
411 * @reorder_timer: releases expired frames from the reorder buffer.
412 * @last_rx: jiffies of last rx activity
413 * @head_seq_num: head sequence number in reordering buffer.
414 * @stored_mpdu_num: number of MPDUs in reordering buffer
415 * @ssn: Starting Sequence Number expected to be aggregated.
416 * @buf_size: buffer size for incoming A-MPDUs
417 * @timeout: reset timer value (in TUs).
418 * @ssn_last_drop: SSN of the last dropped frame
419 * @total: total number of processed incoming frames
420 * @drop_dup: duplicate frames dropped for this reorder buffer
421 * @drop_old: old frames dropped for this reorder buffer
422 * @dialog_token: dialog token for aggregation session
423 * @first_time: true when this buffer used 1-st time
424 */
425 struct wil_tid_ampdu_rx {
426 struct sk_buff **reorder_buf;
427 unsigned long *reorder_time;
428 struct timer_list session_timer;
429 struct timer_list reorder_timer;
430 unsigned long last_rx;
431 u16 head_seq_num;
432 u16 stored_mpdu_num;
433 u16 ssn;
434 u16 buf_size;
435 u16 timeout;
436 u16 ssn_last_drop;
437 unsigned long long total; /* frames processed */
438 unsigned long long drop_dup;
439 unsigned long long drop_old;
440 u8 dialog_token;
441 bool first_time; /* is it 1-st time this buffer used? */
442 };
443
444 /**
445 * struct wil_tid_crypto_rx_single - TID crypto information (Rx).
446 *
447 * @pn: GCMP PN for the session
448 * @key_set: valid key present
449 */
450 struct wil_tid_crypto_rx_single {
451 u8 pn[IEEE80211_GCMP_PN_LEN];
452 bool key_set;
453 };
454
455 struct wil_tid_crypto_rx {
456 struct wil_tid_crypto_rx_single key_id[4];
457 };
458
459 struct wil_p2p_info {
460 struct ieee80211_channel listen_chan;
461 u8 discovery_started;
462 u8 p2p_dev_started;
463 u64 cookie;
464 struct timer_list discovery_timer; /* listen/search duration */
465 struct work_struct discovery_expired_work; /* listen/search expire */
466 };
467
468 enum wil_sta_status {
469 wil_sta_unused = 0,
470 wil_sta_conn_pending = 1,
471 wil_sta_connected = 2,
472 };
473
474 #define WIL_STA_TID_NUM (16)
475 #define WIL_MCS_MAX (12) /* Maximum MCS supported */
476
477 struct wil_net_stats {
478 unsigned long rx_packets;
479 unsigned long tx_packets;
480 unsigned long rx_bytes;
481 unsigned long tx_bytes;
482 unsigned long tx_errors;
483 unsigned long rx_dropped;
484 unsigned long rx_non_data_frame;
485 unsigned long rx_short_frame;
486 unsigned long rx_large_frame;
487 unsigned long rx_replay;
488 u16 last_mcs_rx;
489 u64 rx_per_mcs[WIL_MCS_MAX + 1];
490 };
491
492 /**
493 * struct wil_sta_info - data for peer
494 *
495 * Peer identified by its CID (connection ID)
496 * NIC performs beam forming for each peer;
497 * if no beam forming done, frame exchange is not
498 * possible.
499 */
500 struct wil_sta_info {
501 u8 addr[ETH_ALEN];
502 enum wil_sta_status status;
503 struct wil_net_stats stats;
504 /* Rx BACK */
505 struct wil_tid_ampdu_rx *tid_rx[WIL_STA_TID_NUM];
506 spinlock_t tid_rx_lock; /* guarding tid_rx array */
507 unsigned long tid_rx_timer_expired[BITS_TO_LONGS(WIL_STA_TID_NUM)];
508 unsigned long tid_rx_stop_requested[BITS_TO_LONGS(WIL_STA_TID_NUM)];
509 struct wil_tid_crypto_rx tid_crypto_rx[WIL_STA_TID_NUM];
510 struct wil_tid_crypto_rx group_crypto_rx;
511 };
512
513 enum {
514 fw_recovery_idle = 0,
515 fw_recovery_pending = 1,
516 fw_recovery_running = 2,
517 };
518
519 enum {
520 hw_capability_last
521 };
522
523 struct wil_probe_client_req {
524 struct list_head list;
525 u64 cookie;
526 u8 cid;
527 };
528
529 struct pmc_ctx {
530 /* alloc, free, and read operations must own the lock */
531 struct mutex lock;
532 struct vring_tx_desc *pring_va;
533 dma_addr_t pring_pa;
534 struct desc_alloc_info *descriptors;
535 int last_cmd_status;
536 int num_descriptors;
537 int descriptor_size;
538 };
539
540 struct wil_halp {
541 struct mutex lock; /* protect halp ref_cnt */
542 unsigned int ref_cnt;
543 struct completion comp;
544 };
545
546 struct wil_blob_wrapper {
547 struct wil6210_priv *wil;
548 struct debugfs_blob_wrapper blob;
549 };
550
551 #define WIL_LED_MAX_ID (2)
552 #define WIL_LED_INVALID_ID (0xF)
553 #define WIL_LED_BLINK_ON_SLOW_MS (300)
554 #define WIL_LED_BLINK_OFF_SLOW_MS (300)
555 #define WIL_LED_BLINK_ON_MED_MS (200)
556 #define WIL_LED_BLINK_OFF_MED_MS (200)
557 #define WIL_LED_BLINK_ON_FAST_MS (100)
558 #define WIL_LED_BLINK_OFF_FAST_MS (100)
559 enum {
560 WIL_LED_TIME_SLOW = 0,
561 WIL_LED_TIME_MED,
562 WIL_LED_TIME_FAST,
563 WIL_LED_TIME_LAST,
564 };
565
566 struct blink_on_off_time {
567 u32 on_ms;
568 u32 off_ms;
569 };
570
571 extern struct blink_on_off_time led_blink_time[WIL_LED_TIME_LAST];
572 extern u8 led_id;
573 extern u8 led_polarity;
574
575 struct wil6210_priv {
576 struct pci_dev *pdev;
577 struct wireless_dev *wdev;
578 void __iomem *csr;
579 DECLARE_BITMAP(status, wil_status_last);
580 u8 fw_version[ETHTOOL_FWVERS_LEN];
581 u32 hw_version;
582 const char *hw_name;
583 DECLARE_BITMAP(hw_capabilities, hw_capability_last);
584 DECLARE_BITMAP(fw_capabilities, WMI_FW_CAPABILITY_MAX);
585 u8 n_mids; /* number of additional MIDs as reported by FW */
586 u32 recovery_count; /* num of FW recovery attempts in a short time */
587 u32 recovery_state; /* FW recovery state machine */
588 unsigned long last_fw_recovery; /* jiffies of last fw recovery */
589 wait_queue_head_t wq; /* for all wait_event() use */
590 /* profile */
591 u32 monitor_flags;
592 u32 privacy; /* secure connection? */
593 u8 hidden_ssid; /* relevant in AP mode */
594 u16 channel; /* relevant in AP mode */
595 int sinfo_gen;
596 u32 ap_isolate; /* no intra-BSS communication */
597 /* interrupt moderation */
598 u32 tx_max_burst_duration;
599 u32 tx_interframe_timeout;
600 u32 rx_max_burst_duration;
601 u32 rx_interframe_timeout;
602 /* cached ISR registers */
603 u32 isr_misc;
604 /* mailbox related */
605 struct mutex wmi_mutex;
606 struct wil6210_mbox_ctl mbox_ctl;
607 struct completion wmi_ready;
608 struct completion wmi_call;
609 u16 wmi_seq;
610 u16 reply_id; /**< wait for this WMI event */
611 void *reply_buf;
612 u16 reply_size;
613 struct workqueue_struct *wmi_wq; /* for deferred calls */
614 struct work_struct wmi_event_worker;
615 struct workqueue_struct *wq_service;
616 struct work_struct disconnect_worker;
617 struct work_struct fw_error_worker; /* for FW error recovery */
618 struct timer_list connect_timer;
619 struct timer_list scan_timer; /* detect scan timeout */
620 struct list_head pending_wmi_ev;
621 /*
622 * protect pending_wmi_ev
623 * - fill in IRQ from wil6210_irq_misc,
624 * - consumed in thread by wmi_event_worker
625 */
626 spinlock_t wmi_ev_lock;
627 struct napi_struct napi_rx;
628 struct napi_struct napi_tx;
629 /* keep alive */
630 struct list_head probe_client_pending;
631 struct mutex probe_client_mutex; /* protect @probe_client_pending */
632 struct work_struct probe_client_worker;
633 /* DMA related */
634 struct vring vring_rx;
635 struct vring vring_tx[WIL6210_MAX_TX_RINGS];
636 struct vring_tx_data vring_tx_data[WIL6210_MAX_TX_RINGS];
637 u8 vring2cid_tid[WIL6210_MAX_TX_RINGS][2]; /* [0] - CID, [1] - TID */
638 struct wil_sta_info sta[WIL6210_MAX_CID];
639 int bcast_vring;
640 /* scan */
641 struct cfg80211_scan_request *scan_request;
642
643 struct mutex mutex; /* for wil6210_priv access in wil_{up|down} */
644 /* statistics */
645 atomic_t isr_count_rx, isr_count_tx;
646 /* debugfs */
647 struct dentry *debug;
648 struct wil_blob_wrapper blobs[ARRAY_SIZE(fw_mapping)];
649 u8 discovery_mode;
650
651 void *platform_handle;
652 struct wil_platform_ops platform_ops;
653
654 struct pmc_ctx pmc;
655
656 bool pbss;
657
658 struct wil_p2p_info p2p;
659
660 /* P2P_DEVICE vif */
661 struct wireless_dev *p2p_wdev;
662 struct mutex p2p_wdev_mutex; /* protect @p2p_wdev and @scan_request */
663 struct wireless_dev *radio_wdev;
664
665 /* High Access Latency Policy voting */
666 struct wil_halp halp;
667
668 #ifdef CONFIG_PM
669 #ifdef CONFIG_PM_SLEEP
670 struct notifier_block pm_notify;
671 #endif /* CONFIG_PM_SLEEP */
672 #endif /* CONFIG_PM */
673 };
674
675 #define wil_to_wiphy(i) (i->wdev->wiphy)
676 #define wil_to_dev(i) (wiphy_dev(wil_to_wiphy(i)))
677 #define wiphy_to_wil(w) (struct wil6210_priv *)(wiphy_priv(w))
678 #define wil_to_wdev(i) (i->wdev)
679 #define wdev_to_wil(w) (struct wil6210_priv *)(wdev_priv(w))
680 #define wil_to_ndev(i) (wil_to_wdev(i)->netdev)
681 #define ndev_to_wil(n) (wdev_to_wil(n->ieee80211_ptr))
682
683 __printf(2, 3)
684 void wil_dbg_trace(struct wil6210_priv *wil, const char *fmt, ...);
685 __printf(2, 3)
686 void __wil_err(struct wil6210_priv *wil, const char *fmt, ...);
687 __printf(2, 3)
688 void __wil_err_ratelimited(struct wil6210_priv *wil, const char *fmt, ...);
689 __printf(2, 3)
690 void __wil_info(struct wil6210_priv *wil, const char *fmt, ...);
691 __printf(2, 3)
692 void wil_dbg_ratelimited(const struct wil6210_priv *wil, const char *fmt, ...);
693 #define wil_dbg(wil, fmt, arg...) do { \
694 netdev_dbg(wil_to_ndev(wil), fmt, ##arg); \
695 wil_dbg_trace(wil, fmt, ##arg); \
696 } while (0)
697
698 #define wil_dbg_irq(wil, fmt, arg...) wil_dbg(wil, "DBG[ IRQ]" fmt, ##arg)
699 #define wil_dbg_txrx(wil, fmt, arg...) wil_dbg(wil, "DBG[TXRX]" fmt, ##arg)
700 #define wil_dbg_wmi(wil, fmt, arg...) wil_dbg(wil, "DBG[ WMI]" fmt, ##arg)
701 #define wil_dbg_misc(wil, fmt, arg...) wil_dbg(wil, "DBG[MISC]" fmt, ##arg)
702 #define wil_dbg_pm(wil, fmt, arg...) wil_dbg(wil, "DBG[ PM ]" fmt, ##arg)
703 #define wil_err(wil, fmt, arg...) __wil_err(wil, "%s: " fmt, __func__, ##arg)
704 #define wil_info(wil, fmt, arg...) __wil_info(wil, "%s: " fmt, __func__, ##arg)
705 #define wil_err_ratelimited(wil, fmt, arg...) \
706 __wil_err_ratelimited(wil, "%s: " fmt, __func__, ##arg)
707
708 /* target operations */
709 /* register read */
wil_r(struct wil6210_priv * wil,u32 reg)710 static inline u32 wil_r(struct wil6210_priv *wil, u32 reg)
711 {
712 return readl(wil->csr + HOSTADDR(reg));
713 }
714
715 /* register write. wmb() to make sure it is completed */
wil_w(struct wil6210_priv * wil,u32 reg,u32 val)716 static inline void wil_w(struct wil6210_priv *wil, u32 reg, u32 val)
717 {
718 writel(val, wil->csr + HOSTADDR(reg));
719 wmb(); /* wait for write to propagate to the HW */
720 }
721
722 /* register set = read, OR, write */
wil_s(struct wil6210_priv * wil,u32 reg,u32 val)723 static inline void wil_s(struct wil6210_priv *wil, u32 reg, u32 val)
724 {
725 wil_w(wil, reg, wil_r(wil, reg) | val);
726 }
727
728 /* register clear = read, AND with inverted, write */
wil_c(struct wil6210_priv * wil,u32 reg,u32 val)729 static inline void wil_c(struct wil6210_priv *wil, u32 reg, u32 val)
730 {
731 wil_w(wil, reg, wil_r(wil, reg) & ~val);
732 }
733
734 #if defined(CONFIG_DYNAMIC_DEBUG)
735 #define wil_hex_dump_txrx(prefix_str, prefix_type, rowsize, \
736 groupsize, buf, len, ascii) \
737 print_hex_dump_debug("DBG[TXRX]" prefix_str,\
738 prefix_type, rowsize, \
739 groupsize, buf, len, ascii)
740
741 #define wil_hex_dump_wmi(prefix_str, prefix_type, rowsize, \
742 groupsize, buf, len, ascii) \
743 print_hex_dump_debug("DBG[ WMI]" prefix_str,\
744 prefix_type, rowsize, \
745 groupsize, buf, len, ascii)
746 #else /* defined(CONFIG_DYNAMIC_DEBUG) */
747 static inline
wil_hex_dump_txrx(const char * prefix_str,int prefix_type,int rowsize,int groupsize,const void * buf,size_t len,bool ascii)748 void wil_hex_dump_txrx(const char *prefix_str, int prefix_type, int rowsize,
749 int groupsize, const void *buf, size_t len, bool ascii)
750 {
751 }
752
753 static inline
wil_hex_dump_wmi(const char * prefix_str,int prefix_type,int rowsize,int groupsize,const void * buf,size_t len,bool ascii)754 void wil_hex_dump_wmi(const char *prefix_str, int prefix_type, int rowsize,
755 int groupsize, const void *buf, size_t len, bool ascii)
756 {
757 }
758 #endif /* defined(CONFIG_DYNAMIC_DEBUG) */
759
760 void wil_memcpy_fromio_32(void *dst, const volatile void __iomem *src,
761 size_t count);
762 void wil_memcpy_toio_32(volatile void __iomem *dst, const void *src,
763 size_t count);
764 void wil_memcpy_fromio_halp_vote(struct wil6210_priv *wil, void *dst,
765 const volatile void __iomem *src,
766 size_t count);
767 void wil_memcpy_toio_halp_vote(struct wil6210_priv *wil,
768 volatile void __iomem *dst,
769 const void *src, size_t count);
770
771 void *wil_if_alloc(struct device *dev);
772 void wil_if_free(struct wil6210_priv *wil);
773 int wil_if_add(struct wil6210_priv *wil);
774 void wil_if_remove(struct wil6210_priv *wil);
775 int wil_priv_init(struct wil6210_priv *wil);
776 void wil_priv_deinit(struct wil6210_priv *wil);
777 int wil_reset(struct wil6210_priv *wil, bool no_fw);
778 void wil_fw_error_recovery(struct wil6210_priv *wil);
779 void wil_set_recovery_state(struct wil6210_priv *wil, int state);
780 bool wil_is_recovery_blocked(struct wil6210_priv *wil);
781 int wil_up(struct wil6210_priv *wil);
782 int __wil_up(struct wil6210_priv *wil);
783 int wil_down(struct wil6210_priv *wil);
784 int __wil_down(struct wil6210_priv *wil);
785 void wil_mbox_ring_le2cpus(struct wil6210_mbox_ring *r);
786 int wil_find_cid(struct wil6210_priv *wil, const u8 *mac);
787 void wil_set_ethtoolops(struct net_device *ndev);
788
789 void __iomem *wmi_buffer(struct wil6210_priv *wil, __le32 ptr);
790 void __iomem *wmi_addr(struct wil6210_priv *wil, u32 ptr);
791 int wmi_read_hdr(struct wil6210_priv *wil, __le32 ptr,
792 struct wil6210_mbox_hdr *hdr);
793 int wmi_send(struct wil6210_priv *wil, u16 cmdid, void *buf, u16 len);
794 void wmi_recv_cmd(struct wil6210_priv *wil);
795 int wmi_call(struct wil6210_priv *wil, u16 cmdid, void *buf, u16 len,
796 u16 reply_id, void *reply, u8 reply_size, int to_msec);
797 void wmi_event_worker(struct work_struct *work);
798 void wmi_event_flush(struct wil6210_priv *wil);
799 int wmi_set_ssid(struct wil6210_priv *wil, u8 ssid_len, const void *ssid);
800 int wmi_get_ssid(struct wil6210_priv *wil, u8 *ssid_len, void *ssid);
801 int wmi_set_channel(struct wil6210_priv *wil, int channel);
802 int wmi_get_channel(struct wil6210_priv *wil, int *channel);
803 int wmi_del_cipher_key(struct wil6210_priv *wil, u8 key_index,
804 const void *mac_addr, int key_usage);
805 int wmi_add_cipher_key(struct wil6210_priv *wil, u8 key_index,
806 const void *mac_addr, int key_len, const void *key,
807 int key_usage);
808 int wmi_echo(struct wil6210_priv *wil);
809 int wmi_set_ie(struct wil6210_priv *wil, u8 type, u16 ie_len, const void *ie);
810 int wmi_rx_chain_add(struct wil6210_priv *wil, struct vring *vring);
811 int wmi_rxon(struct wil6210_priv *wil, bool on);
812 int wmi_get_temperature(struct wil6210_priv *wil, u32 *t_m, u32 *t_r);
813 int wmi_disconnect_sta(struct wil6210_priv *wil, const u8 *mac, u16 reason,
814 bool full_disconnect);
815 int wmi_addba(struct wil6210_priv *wil, u8 ringid, u8 size, u16 timeout);
816 int wmi_delba_tx(struct wil6210_priv *wil, u8 ringid, u16 reason);
817 int wmi_delba_rx(struct wil6210_priv *wil, u8 cidxtid, u16 reason);
818 int wmi_addba_rx_resp(struct wil6210_priv *wil, u8 cid, u8 tid, u8 token,
819 u16 status, bool amsdu, u16 agg_wsize, u16 timeout);
820 int wil_addba_rx_request(struct wil6210_priv *wil, u8 cidxtid,
821 u8 dialog_token, __le16 ba_param_set,
822 __le16 ba_timeout, __le16 ba_seq_ctrl);
823 int wil_addba_tx_request(struct wil6210_priv *wil, u8 ringid, u16 wsize);
824
825 void wil6210_clear_irq(struct wil6210_priv *wil);
826 int wil6210_init_irq(struct wil6210_priv *wil, int irq, bool use_msi);
827 void wil6210_fini_irq(struct wil6210_priv *wil, int irq);
828 void wil_mask_irq(struct wil6210_priv *wil);
829 void wil_unmask_irq(struct wil6210_priv *wil);
830 void wil_configure_interrupt_moderation(struct wil6210_priv *wil);
831 void wil_disable_irq(struct wil6210_priv *wil);
832 void wil_enable_irq(struct wil6210_priv *wil);
833 void wil6210_mask_halp(struct wil6210_priv *wil);
834
835 /* P2P */
836 bool wil_p2p_is_social_scan(struct cfg80211_scan_request *request);
837 void wil_p2p_discovery_timer_fn(ulong x);
838 int wil_p2p_search(struct wil6210_priv *wil,
839 struct cfg80211_scan_request *request);
840 int wil_p2p_listen(struct wil6210_priv *wil, unsigned int duration,
841 struct ieee80211_channel *chan, u64 *cookie);
842 u8 wil_p2p_stop_discovery(struct wil6210_priv *wil);
843 int wil_p2p_cancel_listen(struct wil6210_priv *wil, u64 cookie);
844 void wil_p2p_listen_expired(struct work_struct *work);
845 void wil_p2p_search_expired(struct work_struct *work);
846 void wil_p2p_stop_radio_operations(struct wil6210_priv *wil);
847
848 /* WMI for P2P */
849 int wmi_p2p_cfg(struct wil6210_priv *wil, int channel, int bi);
850 int wmi_start_listen(struct wil6210_priv *wil);
851 int wmi_start_search(struct wil6210_priv *wil);
852 int wmi_stop_discovery(struct wil6210_priv *wil);
853
854 int wil_cfg80211_mgmt_tx(struct wiphy *wiphy, struct wireless_dev *wdev,
855 struct cfg80211_mgmt_tx_params *params,
856 u64 *cookie);
857
858 int wil6210_debugfs_init(struct wil6210_priv *wil);
859 void wil6210_debugfs_remove(struct wil6210_priv *wil);
860 int wil_cid_fill_sinfo(struct wil6210_priv *wil, int cid,
861 struct station_info *sinfo);
862
863 struct wireless_dev *wil_cfg80211_init(struct device *dev);
864 void wil_wdev_free(struct wil6210_priv *wil);
865 void wil_p2p_wdev_free(struct wil6210_priv *wil);
866
867 int wmi_set_mac_address(struct wil6210_priv *wil, void *addr);
868 int wmi_pcp_start(struct wil6210_priv *wil, int bi, u8 wmi_nettype,
869 u8 chan, u8 hidden_ssid, u8 is_go);
870 int wmi_pcp_stop(struct wil6210_priv *wil);
871 int wmi_led_cfg(struct wil6210_priv *wil, bool enable);
872 void wil6210_disconnect(struct wil6210_priv *wil, const u8 *bssid,
873 u16 reason_code, bool from_event);
874 void wil_probe_client_flush(struct wil6210_priv *wil);
875 void wil_probe_client_worker(struct work_struct *work);
876
877 int wil_rx_init(struct wil6210_priv *wil, u16 size);
878 void wil_rx_fini(struct wil6210_priv *wil);
879
880 /* TX API */
881 int wil_vring_init_tx(struct wil6210_priv *wil, int id, int size,
882 int cid, int tid);
883 void wil_vring_fini_tx(struct wil6210_priv *wil, int id);
884 int wil_tx_init(struct wil6210_priv *wil, int cid);
885 int wil_vring_init_bcast(struct wil6210_priv *wil, int id, int size);
886 int wil_bcast_init(struct wil6210_priv *wil);
887 void wil_bcast_fini(struct wil6210_priv *wil);
888
889 netdev_tx_t wil_start_xmit(struct sk_buff *skb, struct net_device *ndev);
890 int wil_tx_complete(struct wil6210_priv *wil, int ringid);
891 void wil6210_unmask_irq_tx(struct wil6210_priv *wil);
892
893 /* RX API */
894 void wil_rx_handle(struct wil6210_priv *wil, int *quota);
895 void wil6210_unmask_irq_rx(struct wil6210_priv *wil);
896
897 int wil_iftype_nl2wmi(enum nl80211_iftype type);
898
899 int wil_ioctl(struct wil6210_priv *wil, void __user *data, int cmd);
900 int wil_request_firmware(struct wil6210_priv *wil, const char *name,
901 bool load);
902
903 int wil_can_suspend(struct wil6210_priv *wil, bool is_runtime);
904 int wil_suspend(struct wil6210_priv *wil, bool is_runtime);
905 int wil_resume(struct wil6210_priv *wil, bool is_runtime);
906
907 int wil_fw_copy_crash_dump(struct wil6210_priv *wil, void *dest, u32 size);
908 void wil_fw_core_dump(struct wil6210_priv *wil);
909
910 void wil_halp_vote(struct wil6210_priv *wil);
911 void wil_halp_unvote(struct wil6210_priv *wil);
912 void wil6210_set_halp(struct wil6210_priv *wil);
913 void wil6210_clear_halp(struct wil6210_priv *wil);
914
915 #endif /* __WIL6210_H__ */
916