wil6210.h 26.4 KB
Newer Older
1
/*
2
 * Copyright (c) 2012-2015 Qualcomm Atheros, Inc.
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef __WIL6210_H__
#define __WIL6210_H__

#include <linux/netdevice.h>
#include <linux/wireless.h>
#include <net/cfg80211.h>
23
#include <linux/timex.h>
24
#include <linux/types.h>
25
26
#include "wil_platform.h"

27
extern bool no_fw_recovery;
28
extern unsigned int mtu_max;
29
extern unsigned short rx_ring_overflow_thrsh;
30
extern int agg_wsize;
31
extern u32 vring_idle_trsh;
32
extern bool rx_align_2;
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
33
extern bool debug_fw;
34
35

#define WIL_NAME "wil6210"
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
36
#define WIL_FW_NAME "wil6210.fw" /* code */
37
#define WIL_FW2_NAME "wil6210.brd" /* board & radio parameters */
38

39
#define WIL_MAX_BUS_REQUEST_KBPS 800000 /* ~6.1Gbps */
40
41
42
43
44
45
46
47
48
49
50
51

/**
 * extract bits [@b0:@b1] (inclusive) from the value @x
 * it should be @b0 <= @b1, or result is incorrect
 */
static inline u32 WIL_GET_BITS(u32 x, int b0, int b1)
{
	return (x >> b0) & ((1 << (b1 - b0 + 1)) - 1);
}

#define WIL6210_MEM_SIZE (2*1024*1024UL)

52
#define WIL_TX_Q_LEN_DEFAULT		(4000)
Vladimir Shulman's avatar
Vladimir Shulman committed
53
54
#define WIL_RX_RING_SIZE_ORDER_DEFAULT	(10)
#define WIL_TX_RING_SIZE_ORDER_DEFAULT	(10)
55
56
#define WIL_BCAST_RING_SIZE_ORDER_DEFAULT	(7)
#define WIL_BCAST_MCS0_LIMIT		(1024) /* limit for MCS0 frame size */
57
58
59
/* limit ring size in range [32..32k] */
#define WIL_RING_SIZE_ORDER_MIN	(5)
#define WIL_RING_SIZE_ORDER_MAX	(15)
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
60
61
62
#define WIL6210_MAX_TX_RINGS	(24) /* HW limit */
#define WIL6210_MAX_CID		(8) /* HW limit */
#define WIL6210_NAPI_BUDGET	(16) /* arbitrary */
63
64
65
66
#define WIL_MAX_AMPDU_SIZE	(64 * 1024) /* FW/HW limit */
#define WIL_MAX_AGG_WSIZE	(32) /* FW/HW limit */
/* Hardware offload block adds the following:
 * 26 bytes - 3-address QoS data header
67
 *  8 bytes - IV + EIV (for GCMP)
68
 *  8 bytes - SNAP
69
 * 16 bytes - MIC (for GCMP)
70
71
72
 *  4 bytes - CRC
 */
#define WIL_MAX_MPDU_OVERHEAD	(62)
73
74
75
76
77
78
79
80
81

/* Calculate MAC buffer size for the firmware. It includes all overhead,
 * as it will go over the air, and need to be 8 byte aligned
 */
static inline u32 wil_mtu2macbuf(u32 mtu)
{
	return ALIGN(mtu + WIL_MAX_MPDU_OVERHEAD, 8);
}

82
83
84
85
/* MTU for Ethernet need to take into account 8-byte SNAP header
 * to be added when encapsulating Ethernet frame into 802.11
 */
#define WIL_MAX_ETH_MTU		(IEEE80211_MAX_DATA_LEN_DMG - 8)
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
86
87
/* Max supported by wil6210 value for interrupt threshold is 5sec. */
#define WIL6210_ITR_TRSH_MAX (5000000)
88
89
#define WIL6210_ITR_TX_INTERFRAME_TIMEOUT_DEFAULT (13) /* usec */
#define WIL6210_ITR_RX_INTERFRAME_TIMEOUT_DEFAULT (13) /* usec */
90
91
#define WIL6210_ITR_TX_MAX_BURST_DURATION_DEFAULT (500) /* usec */
#define WIL6210_ITR_RX_MAX_BURST_DURATION_DEFAULT (500) /* usec */
92
93
#define WIL6210_FW_RECOVERY_RETRIES	(5) /* try to recover this many times */
#define WIL6210_FW_RECOVERY_TO	msecs_to_jiffies(5000)
94
#define WIL6210_SCAN_TO		msecs_to_jiffies(10000)
95
96
97
#define WIL6210_RX_HIGH_TRSH_INIT		(0)
#define WIL6210_RX_HIGH_TRSH_DEFAULT \
				(1 << (WIL_RX_RING_SIZE_ORDER_DEFAULT - 3))
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/* Hardware definitions begin */

/*
 * Mapping
 * RGF File      | Host addr    |  FW addr
 *               |              |
 * user_rgf      | 0x000000     | 0x880000
 *  dma_rgf      | 0x001000     | 0x881000
 * pcie_rgf      | 0x002000     | 0x882000
 *               |              |
 */

/* Where various structures placed in host address space */
#define WIL6210_FW_HOST_OFF      (0x880000UL)

#define HOSTADDR(fwaddr)        (fwaddr - WIL6210_FW_HOST_OFF)

/*
 * Interrupt control registers block
 *
 * each interrupt controlled by the same bit in all registers
 */
struct RGF_ICR {
	u32 ICC; /* Cause Control, RW: 0 - W1C, 1 - COR */
	u32 ICR; /* Cause, W1C/COR depending on ICC */
	u32 ICM; /* Cause masked (ICR & ~IMV), W1C/COR depending on ICC */
	u32 ICS; /* Cause Set, WO */
	u32 IMV; /* Mask, RW+S/C */
	u32 IMS; /* Mask Set, write 1 to set */
	u32 IMC; /* Mask Clear, write 1 to clear */
} __packed;

/* registers - FW addresses */
131
#define RGF_USER_USAGE_1		(0x880004)
132
#define RGF_USER_USAGE_6		(0x880018)
133
134
#define RGF_USER_HW_MACHINE_STATE	(0x8801dc)
	#define HW_MACHINE_BOOT_DONE	(0x3fffffd)
135
#define RGF_USER_USER_CPU_0		(0x8801e0)
136
	#define BIT_USER_USER_CPU_MAN_RST	BIT(1) /* user_cpu_man_rst */
137
#define RGF_USER_MAC_CPU_0		(0x8801fc)
138
	#define BIT_USER_MAC_CPU_MAN_RST	BIT(1) /* mac_cpu_man_rst */
139
#define RGF_USER_USER_SCRATCH_PAD	(0x8802bc)
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
140
#define RGF_USER_BL			(0x880A3C) /* Boot Loader */
141
#define RGF_USER_FW_REV_ID		(0x880a8c) /* chip revision */
142
#define RGF_USER_CLKS_CTL_0		(0x880abc)
143
	#define BIT_USER_CLKS_CAR_AHB_SW_SEL	BIT(1) /* ref clk/PLL */
144
	#define BIT_USER_CLKS_RST_PWGD	BIT(11) /* reset on "power good" */
145
146
147
148
#define RGF_USER_CLKS_CTL_SW_RST_VEC_0	(0x880b04)
#define RGF_USER_CLKS_CTL_SW_RST_VEC_1	(0x880b08)
#define RGF_USER_CLKS_CTL_SW_RST_VEC_2	(0x880b0c)
#define RGF_USER_CLKS_CTL_SW_RST_VEC_3	(0x880b10)
149
#define RGF_USER_CLKS_CTL_SW_RST_MASK_0	(0x880b14)
150
151
	#define BIT_HPAL_PERST_FROM_PAD	BIT(6)
	#define BIT_CAR_PERST_RST	BIT(7)
152
153
#define RGF_USER_USER_ICR		(0x880b4c) /* struct RGF_ICR */
	#define BIT_USER_USER_ICR_SW_INT_2	BIT(18)
154
#define RGF_USER_CLKS_CTL_EXT_SW_RST_VEC_0	(0x880c18)
155
#define RGF_USER_CLKS_CTL_EXT_SW_RST_VEC_1	(0x880c2c)
156
157
#define RGF_USER_SPARROW_M_4			(0x880c50) /* Sparrow */
	#define BIT_SPARROW_M_4_SEL_SLEEP_OR_REF	BIT(2)
158
159
160
161
162
163

#define RGF_DMA_EP_TX_ICR		(0x881bb4) /* struct RGF_ICR */
	#define BIT_DMA_EP_TX_ICR_TX_DONE	BIT(0)
	#define BIT_DMA_EP_TX_ICR_TX_DONE_N(n)	BIT(n+1) /* n = [0..23] */
#define RGF_DMA_EP_RX_ICR		(0x881bd0) /* struct RGF_ICR */
	#define BIT_DMA_EP_RX_ICR_RX_DONE	BIT(0)
164
	#define BIT_DMA_EP_RX_ICR_RX_HTRSH	BIT(1)
165
166
167
#define RGF_DMA_EP_MISC_ICR		(0x881bec) /* struct RGF_ICR */
	#define BIT_DMA_EP_MISC_ICR_RX_HTRSH	BIT(0)
	#define BIT_DMA_EP_MISC_ICR_TX_NO_ACT	BIT(1)
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
168
	#define BIT_DMA_EP_MISC_ICR_FW_INT(n)	BIT(28+n) /* n = [0..3] */
169

170
/* Legacy interrupt moderation control (before Sparrow v2)*/
171
172
#define RGF_DMA_ITR_CNT_TRSH		(0x881c5c)
#define RGF_DMA_ITR_CNT_DATA		(0x881c60)
173
#define RGF_DMA_ITR_CNT_CRL		(0x881c64)
174
175
176
177
178
179
	#define BIT_DMA_ITR_CNT_CRL_EN		BIT(0)
	#define BIT_DMA_ITR_CNT_CRL_EXT_TICK	BIT(1)
	#define BIT_DMA_ITR_CNT_CRL_FOREVER	BIT(2)
	#define BIT_DMA_ITR_CNT_CRL_CLR		BIT(3)
	#define BIT_DMA_ITR_CNT_CRL_REACH_TRSH	BIT(4)

180
181
182
183
184
185
186
/* Offload control (Sparrow B0+) */
#define RGF_DMA_OFUL_NID_0		(0x881cd4)
	#define BIT_DMA_OFUL_NID_0_RX_EXT_TR_EN		BIT(0)
	#define BIT_DMA_OFUL_NID_0_TX_EXT_TR_EN		BIT(1)
	#define BIT_DMA_OFUL_NID_0_RX_EXT_A3_SRC	BIT(2)
	#define BIT_DMA_OFUL_NID_0_TX_EXT_A3_SRC	BIT(3)

187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
/* New (sparrow v2+) interrupt moderation control */
#define RGF_DMA_ITR_TX_DESQ_NO_MOD		(0x881d40)
#define RGF_DMA_ITR_TX_CNT_TRSH			(0x881d34)
#define RGF_DMA_ITR_TX_CNT_DATA			(0x881d38)
#define RGF_DMA_ITR_TX_CNT_CTL			(0x881d3c)
	#define BIT_DMA_ITR_TX_CNT_CTL_EN		BIT(0)
	#define BIT_DMA_ITR_TX_CNT_CTL_EXT_TIC_SEL	BIT(1)
	#define BIT_DMA_ITR_TX_CNT_CTL_FOREVER		BIT(2)
	#define BIT_DMA_ITR_TX_CNT_CTL_CLR		BIT(3)
	#define BIT_DMA_ITR_TX_CNT_CTL_REACHED_TRESH	BIT(4)
	#define BIT_DMA_ITR_TX_CNT_CTL_CROSS_EN		BIT(5)
	#define BIT_DMA_ITR_TX_CNT_CTL_FREE_RUNNIG	BIT(6)
#define RGF_DMA_ITR_TX_IDL_CNT_TRSH			(0x881d60)
#define RGF_DMA_ITR_TX_IDL_CNT_DATA			(0x881d64)
#define RGF_DMA_ITR_TX_IDL_CNT_CTL			(0x881d68)
	#define BIT_DMA_ITR_TX_IDL_CNT_CTL_EN			BIT(0)
	#define BIT_DMA_ITR_TX_IDL_CNT_CTL_EXT_TIC_SEL		BIT(1)
	#define BIT_DMA_ITR_TX_IDL_CNT_CTL_FOREVER		BIT(2)
	#define BIT_DMA_ITR_TX_IDL_CNT_CTL_CLR			BIT(3)
	#define BIT_DMA_ITR_TX_IDL_CNT_CTL_REACHED_TRESH	BIT(4)
#define RGF_DMA_ITR_RX_DESQ_NO_MOD		(0x881d50)
#define RGF_DMA_ITR_RX_CNT_TRSH			(0x881d44)
#define RGF_DMA_ITR_RX_CNT_DATA			(0x881d48)
#define RGF_DMA_ITR_RX_CNT_CTL			(0x881d4c)
	#define BIT_DMA_ITR_RX_CNT_CTL_EN		BIT(0)
	#define BIT_DMA_ITR_RX_CNT_CTL_EXT_TIC_SEL	BIT(1)
	#define BIT_DMA_ITR_RX_CNT_CTL_FOREVER		BIT(2)
	#define BIT_DMA_ITR_RX_CNT_CTL_CLR		BIT(3)
	#define BIT_DMA_ITR_RX_CNT_CTL_REACHED_TRESH	BIT(4)
	#define BIT_DMA_ITR_RX_CNT_CTL_CROSS_EN		BIT(5)
	#define BIT_DMA_ITR_RX_CNT_CTL_FREE_RUNNIG	BIT(6)
#define RGF_DMA_ITR_RX_IDL_CNT_TRSH			(0x881d54)
#define RGF_DMA_ITR_RX_IDL_CNT_DATA			(0x881d58)
#define RGF_DMA_ITR_RX_IDL_CNT_CTL			(0x881d5c)
	#define BIT_DMA_ITR_RX_IDL_CNT_CTL_EN			BIT(0)
	#define BIT_DMA_ITR_RX_IDL_CNT_CTL_EXT_TIC_SEL		BIT(1)
	#define BIT_DMA_ITR_RX_IDL_CNT_CTL_FOREVER		BIT(2)
	#define BIT_DMA_ITR_RX_IDL_CNT_CTL_CLR			BIT(3)
	#define BIT_DMA_ITR_RX_IDL_CNT_CTL_REACHED_TRESH	BIT(4)

227
228
229
230
231
232
233
#define RGF_DMA_PSEUDO_CAUSE		(0x881c68)
#define RGF_DMA_PSEUDO_CAUSE_MASK_SW	(0x881c6c)
#define RGF_DMA_PSEUDO_CAUSE_MASK_FW	(0x881c70)
	#define BIT_DMA_PSEUDO_CAUSE_RX		BIT(0)
	#define BIT_DMA_PSEUDO_CAUSE_TX		BIT(1)
	#define BIT_DMA_PSEUDO_CAUSE_MISC	BIT(2)

234
#define RGF_HP_CTRL			(0x88265c)
235
236
#define RGF_PCIE_LOS_COUNTER_CTL	(0x882dc4)

237
238
239
/* MAC timer, usec, for packet lifetime */
#define RGF_MAC_MTRL_COUNTER_0		(0x886aa8)

240
#define RGF_CAF_ICR			(0x88946c) /* struct RGF_ICR */
241
242
243
244
#define RGF_CAF_OSC_CONTROL		(0x88afa4)
	#define BIT_CAF_OSC_XTAL_EN		BIT(0)
#define RGF_CAF_PLL_LOCK_STATUS		(0x88afec)
	#define BIT_CAF_OSC_DIG_XTAL_STABLE	BIT(0)
245

246
247
248
249
250
251
252
253
#define RGF_USER_JTAG_DEV_ID	(0x880b34) /* device ID */
	#define JTAG_DEV_ID_SPARROW_B0	(0x2632072f)

enum {
	HW_VER_UNKNOWN,
	HW_VER_SPARROW_B0, /* JTAG_DEV_ID_SPARROW_B0 */
};

254
255
256
257
258
259
260
/* popular locations */
#define HOST_MBOX   HOSTADDR(RGF_USER_USER_SCRATCH_PAD)
#define HOST_SW_INT (HOSTADDR(RGF_USER_USER_ICR) + \
	offsetof(struct RGF_ICR, ICS))
#define SW_INT_MBOX BIT_USER_USER_ICR_SW_INT_2

/* ISR register bits */
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
261
262
263
#define ISR_MISC_FW_READY	BIT_DMA_EP_MISC_ICR_FW_INT(0)
#define ISR_MISC_MBOX_EVT	BIT_DMA_EP_MISC_ICR_FW_INT(1)
#define ISR_MISC_FW_ERROR	BIT_DMA_EP_MISC_ICR_FW_INT(3)
264
265

/* Hardware definitions end */
266
267
268
269
270
271
struct fw_map {
	u32 from; /* linker address - from, inclusive */
	u32 to;   /* linker address - to, exclusive */
	u32 host; /* PCI/Host address - BAR0 + 0x880000 */
	const char *name; /* for debugfs */
};
272

273
/* array size should be in sync with actual definition in the wmi.c */
274
extern const struct fw_map fw_mapping[8];
275

276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
/**
 * mk_cidxtid - construct @cidxtid field
 * @cid: CID value
 * @tid: TID value
 *
 * @cidxtid field encoded as bits 0..3 - CID; 4..7 - TID
 */
static inline u8 mk_cidxtid(u8 cid, u8 tid)
{
	return ((tid & 0xf) << 4) | (cid & 0xf);
}

/**
 * parse_cidxtid - parse @cidxtid field
 * @cid: store CID value here
 * @tid: store TID value here
 *
 * @cidxtid field encoded as bits 0..3 - CID; 4..7 - TID
 */
static inline void parse_cidxtid(u8 cidxtid, u8 *cid, u8 *tid)
{
	*cid = cidxtid & 0xf;
	*tid = (cidxtid >> 4) & 0xf;
}

301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
struct wil6210_mbox_ring {
	u32 base;
	u16 entry_size; /* max. size of mbox entry, incl. all headers */
	u16 size;
	u32 tail;
	u32 head;
} __packed;

struct wil6210_mbox_ring_desc {
	__le32 sync;
	__le32 addr;
} __packed;

/* at HOST_OFF_WIL6210_MBOX_CTL */
struct wil6210_mbox_ctl {
	struct wil6210_mbox_ring tx;
	struct wil6210_mbox_ring rx;
} __packed;

struct wil6210_mbox_hdr {
	__le16 seq;
	__le16 len; /* payload, bytes after this header */
	__le16 type;
	u8 flags;
	u8 reserved;
} __packed;

#define WIL_MBOX_HDR_TYPE_WMI (0)

/* max. value for wil6210_mbox_hdr.len */
#define MAX_MBOXITEM_SIZE   (240)

333
334
335
336
337
338
339
340
341
342
343
/**
 * struct wil6210_mbox_hdr_wmi - WMI header
 *
 * @mid: MAC ID
 *	00 - default, created by FW
 *	01..0f - WiFi ports, driver to create
 *	10..fe - debug
 *	ff - broadcast
 * @id: command/event ID
 * @timestamp: FW fills for events, free-running msec timer
 */
344
struct wil6210_mbox_hdr_wmi {
345
346
	u8 mid;
	u8 reserved;
347
	__le16 id;
348
	__le32 timestamp;
349
350
351
352
353
354
355
356
357
358
359
} __packed;

struct pending_wmi_event {
	struct list_head list;
	struct {
		struct wil6210_mbox_hdr hdr;
		struct wil6210_mbox_hdr_wmi wmi;
		u8 data[0];
	} __packed event;
};

360
361
362
363
364
365
enum { /* for wil_ctx.mapped_as */
	wil_mapped_as_none = 0,
	wil_mapped_as_single = 1,
	wil_mapped_as_page = 2,
};

366
367
368
369
370
/**
 * struct wil_ctx - software context for Vring descriptor
 */
struct wil_ctx {
	struct sk_buff *skb;
371
	u8 nr_frags;
372
	u8 mapped_as;
373
374
};

375
376
377
378
379
380
381
382
383
union vring_desc;

struct vring {
	dma_addr_t pa;
	volatile union vring_desc *va; /* vring_desc[size], WriteBack by DMA */
	u16 size; /* number of vring_desc elements */
	u32 swtail;
	u32 swhead;
	u32 hwtail; /* write here to inform hw */
384
	struct wil_ctx *ctx; /* ctx[size] - software context */
385
386
};

387
388
389
390
/**
 * Additional data for Tx Vring
 */
struct vring_tx_data {
391
	bool dot1x_open;
392
	int enabled;
393
	cycles_t idle, last_idle, begin;
394
395
	u8 agg_wsize; /* agreed aggregation window, 0 - no agg */
	u16 agg_timeout;
396
	u8 agg_amsdu;
397
	bool addba_in_progress; /* if set, agg_xxx is for request in progress */
398
	spinlock_t lock;
399
400
};

401
402
enum { /* for wil6210_priv.status */
	wil_status_fwready = 0,
403
	wil_status_fwconnecting,
404
405
	wil_status_fwconnected,
	wil_status_dontscan,
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
406
	wil_status_reset_done,
407
	wil_status_irqen, /* FIXME: interrupts enabled - for debug */
408
	wil_status_napi_en, /* NAPI enabled protected by wil->mutex */
409
	wil_status_last /* keep last */
410
411
412
413
};

struct pci_dev;

Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
414
415
416
417
418
419
420
421
422
423
424
425
426
/**
 * struct tid_ampdu_rx - TID aggregation information (Rx).
 *
 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
 * @reorder_time: jiffies when skb was added
 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
 * @reorder_timer: releases expired frames from the reorder buffer.
 * @last_rx: jiffies of last rx activity
 * @head_seq_num: head sequence number in reordering buffer.
 * @stored_mpdu_num: number of MPDUs in reordering buffer
 * @ssn: Starting Sequence Number expected to be aggregated.
 * @buf_size: buffer size for incoming A-MPDUs
 * @timeout: reset timer value (in TUs).
427
428
429
430
 * @ssn_last_drop: SSN of the last dropped frame
 * @total: total number of processed incoming frames
 * @drop_dup: duplicate frames dropped for this reorder buffer
 * @drop_old: old frames dropped for this reorder buffer
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
431
 * @dialog_token: dialog token for aggregation session
432
 * @first_time: true when this buffer used 1-st time
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
433
434
435
436
437
438
439
440
441
442
443
444
 */
struct wil_tid_ampdu_rx {
	struct sk_buff **reorder_buf;
	unsigned long *reorder_time;
	struct timer_list session_timer;
	struct timer_list reorder_timer;
	unsigned long last_rx;
	u16 head_seq_num;
	u16 stored_mpdu_num;
	u16 ssn;
	u16 buf_size;
	u16 timeout;
445
	u16 ssn_last_drop;
446
447
448
	unsigned long long total; /* frames processed */
	unsigned long long drop_dup;
	unsigned long long drop_old;
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
449
	u8 dialog_token;
450
	bool first_time; /* is it 1-st time this buffer used? */
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
451
452
};

453
454
455
456
457
enum wil_sta_status {
	wil_sta_unused = 0,
	wil_sta_conn_pending = 1,
	wil_sta_connected = 2,
};
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
458
459

#define WIL_STA_TID_NUM (16)
460
#define WIL_MCS_MAX (12) /* Maximum MCS supported */
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
461

462
463
464
465
466
467
468
469
struct wil_net_stats {
	unsigned long	rx_packets;
	unsigned long	tx_packets;
	unsigned long	rx_bytes;
	unsigned long	tx_bytes;
	unsigned long	tx_errors;
	unsigned long	rx_dropped;
	u16 last_mcs_rx;
470
	u64 rx_per_mcs[WIL_MCS_MAX + 1];
471
472
};

473
474
475
476
477
478
479
480
481
482
483
/**
 * struct wil_sta_info - data for peer
 *
 * Peer identified by its CID (connection ID)
 * NIC performs beam forming for each peer;
 * if no beam forming done, frame exchange is not
 * possible.
 */
struct wil_sta_info {
	u8 addr[ETH_ALEN];
	enum wil_sta_status status;
484
	struct wil_net_stats stats;
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
485
486
	/* Rx BACK */
	struct wil_tid_ampdu_rx *tid_rx[WIL_STA_TID_NUM];
487
	spinlock_t tid_rx_lock; /* guarding tid_rx array */
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
488
489
	unsigned long tid_rx_timer_expired[BITS_TO_LONGS(WIL_STA_TID_NUM)];
	unsigned long tid_rx_stop_requested[BITS_TO_LONGS(WIL_STA_TID_NUM)];
490
491
};

492
493
494
495
496
497
enum {
	fw_recovery_idle = 0,
	fw_recovery_pending = 1,
	fw_recovery_running = 2,
};

498
499
500
501
enum {
	hw_capability_last
};

502
503
504
505
506
507
508
509
510
511
struct wil_back_rx {
	struct list_head list;
	/* request params, converted to CPU byte order - what we asked for */
	u8 cidxtid;
	u8 dialog_token;
	u16 ba_param_set;
	u16 ba_timeout;
	u16 ba_seq_ctrl;
};

512
513
514
515
516
517
518
519
struct wil_back_tx {
	struct list_head list;
	/* request params, converted to CPU byte order - what we asked for */
	u8 ringid;
	u8 agg_wsize;
	u16 agg_timeout;
};

520
521
522
523
524
525
struct wil_probe_client_req {
	struct list_head list;
	u64 cookie;
	u8 cid;
};

526
527
528
529
530
531
532
533
534
535
536
struct pmc_ctx {
	/* alloc, free, and read operations must own the lock */
	struct mutex		lock;
	struct vring_tx_desc	*pring_va;
	dma_addr_t		pring_pa;
	struct desc_alloc_info  *descriptors;
	int			last_cmd_status;
	int			num_descriptors;
	int			descriptor_size;
};

537
538
539
540
541
struct wil6210_priv {
	struct pci_dev *pdev;
	int n_msi;
	struct wireless_dev *wdev;
	void __iomem *csr;
542
	DECLARE_BITMAP(status, wil_status_last);
543
	u32 fw_version;
544
	u32 hw_version;
545
	const char *hw_name;
546
	DECLARE_BITMAP(hw_capabilities, hw_capability_last);
547
	u8 n_mids; /* number of additional MIDs as reported by FW */
548
549
	u32 recovery_count; /* num of FW recovery attempts in a short time */
	u32 recovery_state; /* FW recovery state machine */
550
	unsigned long last_fw_recovery; /* jiffies of last fw recovery */
551
	wait_queue_head_t wq; /* for all wait_event() use */
552
553
	/* profile */
	u32 monitor_flags;
554
	u32 privacy; /* secure connection? */
555
556
	u8 hidden_ssid; /* relevant in AP mode */
	u16 channel; /* relevant in AP mode */
557
	int sinfo_gen;
558
	u32 ap_isolate; /* no intra-BSS communication */
559
560
561
562
563
	/* interrupt moderation */
	u32 tx_max_burst_duration;
	u32 tx_interframe_timeout;
	u32 rx_max_burst_duration;
	u32 rx_interframe_timeout;
564
565
566
567
568
569
	/* cached ISR registers */
	u32 isr_misc;
	/* mailbox related */
	struct mutex wmi_mutex;
	struct wil6210_mbox_ctl mbox_ctl;
	struct completion wmi_ready;
570
	struct completion wmi_call;
571
572
573
574
575
576
	u16 wmi_seq;
	u16 reply_id; /**< wait for this WMI event */
	void *reply_buf;
	u16 reply_size;
	struct workqueue_struct *wmi_wq; /* for deferred calls */
	struct work_struct wmi_event_worker;
577
	struct workqueue_struct *wq_service;
578
	struct work_struct connect_worker;
579
	struct work_struct disconnect_worker;
580
	struct work_struct fw_error_worker;	/* for FW error recovery */
581
	struct timer_list connect_timer;
582
	struct timer_list scan_timer; /* detect scan timeout */
583
584
585
586
587
588
589
590
	int pending_connect_cid;
	struct list_head pending_wmi_ev;
	/*
	 * protect pending_wmi_ev
	 * - fill in IRQ from wil6210_irq_misc,
	 * - consumed in thread by wmi_event_worker
	 */
	spinlock_t wmi_ev_lock;
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
591
592
	struct napi_struct napi_rx;
	struct napi_struct napi_tx;
593
594
595
596
	/* BACK */
	struct list_head back_rx_pending;
	struct mutex back_rx_mutex; /* protect @back_rx_pending */
	struct work_struct back_rx_worker;
597
598
599
	struct list_head back_tx_pending;
	struct mutex back_tx_mutex; /* protect @back_tx_pending */
	struct work_struct back_tx_worker;
600
601
602
603
	/* keep alive */
	struct list_head probe_client_pending;
	struct mutex probe_client_mutex; /* protect @probe_client_pending */
	struct work_struct probe_client_worker;
604
605
606
	/* DMA related */
	struct vring vring_rx;
	struct vring vring_tx[WIL6210_MAX_TX_RINGS];
607
	struct vring_tx_data vring_tx_data[WIL6210_MAX_TX_RINGS];
608
609
	u8 vring2cid_tid[WIL6210_MAX_TX_RINGS][2]; /* [0] - CID, [1] - TID */
	struct wil_sta_info sta[WIL6210_MAX_CID];
610
	int bcast_vring;
611
612
613
614
615
	/* scan */
	struct cfg80211_scan_request *scan_request;

	struct mutex mutex; /* for wil6210_priv access in wil_{up|down} */
	/* statistics */
616
	atomic_t isr_count_rx, isr_count_tx;
617
618
	/* debugfs */
	struct dentry *debug;
619
	struct debugfs_blob_wrapper blobs[ARRAY_SIZE(fw_mapping)];
620
621
622

	void *platform_handle;
	struct wil_platform_ops platform_ops;
623
624

	struct pmc_ctx pmc;
625
626
627
628
629
630
631
632
633
634
};

#define wil_to_wiphy(i) (i->wdev->wiphy)
#define wil_to_dev(i) (wiphy_dev(wil_to_wiphy(i)))
#define wiphy_to_wil(w) (struct wil6210_priv *)(wiphy_priv(w))
#define wil_to_wdev(i) (i->wdev)
#define wdev_to_wil(w) (struct wil6210_priv *)(wdev_priv(w))
#define wil_to_ndev(i) (wil_to_wdev(i)->netdev)
#define ndev_to_wil(n) (wdev_to_wil(n->ieee80211_ptr))

635
__printf(2, 3)
636
void wil_dbg_trace(struct wil6210_priv *wil, const char *fmt, ...);
637
__printf(2, 3)
638
void wil_err(struct wil6210_priv *wil, const char *fmt, ...);
639
__printf(2, 3)
640
641
void wil_err_ratelimited(struct wil6210_priv *wil, const char *fmt, ...);
__printf(2, 3)
642
void wil_info(struct wil6210_priv *wil, const char *fmt, ...);
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
643
644
645
646
#define wil_dbg(wil, fmt, arg...) do { \
	netdev_dbg(wil_to_ndev(wil), fmt, ##arg); \
	wil_dbg_trace(wil, fmt, ##arg); \
} while (0)
647

648
649
650
651
#define wil_dbg_irq(wil, fmt, arg...) wil_dbg(wil, "DBG[ IRQ]" fmt, ##arg)
#define wil_dbg_txrx(wil, fmt, arg...) wil_dbg(wil, "DBG[TXRX]" fmt, ##arg)
#define wil_dbg_wmi(wil, fmt, arg...) wil_dbg(wil, "DBG[ WMI]" fmt, ##arg)
#define wil_dbg_misc(wil, fmt, arg...) wil_dbg(wil, "DBG[MISC]" fmt, ##arg)
652

653
#if defined(CONFIG_DYNAMIC_DEBUG)
654
#define wil_hex_dump_txrx(prefix_str, prefix_type, rowsize,	\
655
			  groupsize, buf, len, ascii)		\
656
			  print_hex_dump_debug("DBG[TXRX]" prefix_str,\
657
658
659
					 prefix_type, rowsize,	\
					 groupsize, buf, len, ascii)

660
#define wil_hex_dump_wmi(prefix_str, prefix_type, rowsize,	\
661
			 groupsize, buf, len, ascii)		\
662
			 print_hex_dump_debug("DBG[ WMI]" prefix_str,\
663
664
					prefix_type, rowsize,	\
					groupsize, buf, len, ascii)
665
666
667
668
669
670
671
672
673
674
675
676
677
#else /* defined(CONFIG_DYNAMIC_DEBUG) */
static inline
void wil_hex_dump_txrx(const char *prefix_str, int prefix_type, int rowsize,
		       int groupsize, const void *buf, size_t len, bool ascii)
{
}

static inline
void wil_hex_dump_wmi(const char *prefix_str, int prefix_type, int rowsize,
		      int groupsize, const void *buf, size_t len, bool ascii)
{
}
#endif /* defined(CONFIG_DYNAMIC_DEBUG) */
678
679
680
681
682
683

void wil_memcpy_fromio_32(void *dst, const volatile void __iomem *src,
			  size_t count);
void wil_memcpy_toio_32(volatile void __iomem *dst, const void *src,
			size_t count);

684
void *wil_if_alloc(struct device *dev);
685
686
687
688
689
void wil_if_free(struct wil6210_priv *wil);
int wil_if_add(struct wil6210_priv *wil);
void wil_if_remove(struct wil6210_priv *wil);
int wil_priv_init(struct wil6210_priv *wil);
void wil_priv_deinit(struct wil6210_priv *wil);
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
690
int wil_reset(struct wil6210_priv *wil, bool no_fw);
691
void wil_fw_error_recovery(struct wil6210_priv *wil);
692
void wil_set_recovery_state(struct wil6210_priv *wil, int state);
693
int wil_up(struct wil6210_priv *wil);
694
int __wil_up(struct wil6210_priv *wil);
695
int wil_down(struct wil6210_priv *wil);
696
int __wil_down(struct wil6210_priv *wil);
697
void wil_mbox_ring_le2cpus(struct wil6210_mbox_ring *r);
698
int wil_find_cid(struct wil6210_priv *wil, const u8 *mac);
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
699
void wil_set_ethtoolops(struct net_device *ndev);
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715

void __iomem *wmi_buffer(struct wil6210_priv *wil, __le32 ptr);
void __iomem *wmi_addr(struct wil6210_priv *wil, u32 ptr);
int wmi_read_hdr(struct wil6210_priv *wil, __le32 ptr,
		 struct wil6210_mbox_hdr *hdr);
int wmi_send(struct wil6210_priv *wil, u16 cmdid, void *buf, u16 len);
void wmi_recv_cmd(struct wil6210_priv *wil);
int wmi_call(struct wil6210_priv *wil, u16 cmdid, void *buf, u16 len,
	     u16 reply_id, void *reply, u8 reply_size, int to_msec);
void wmi_event_worker(struct work_struct *work);
void wmi_event_flush(struct wil6210_priv *wil);
int wmi_set_ssid(struct wil6210_priv *wil, u8 ssid_len, const void *ssid);
int wmi_get_ssid(struct wil6210_priv *wil, u8 *ssid_len, void *ssid);
int wmi_set_channel(struct wil6210_priv *wil, int channel);
int wmi_get_channel(struct wil6210_priv *wil, int *channel);
int wmi_del_cipher_key(struct wil6210_priv *wil, u8 key_index,
716
		       const void *mac_addr, int key_usage);
717
int wmi_add_cipher_key(struct wil6210_priv *wil, u8 key_index,
718
719
		       const void *mac_addr, int key_len, const void *key,
		       int key_usage);
720
721
int wmi_echo(struct wil6210_priv *wil);
int wmi_set_ie(struct wil6210_priv *wil, u8 type, u16 ie_len, const void *ie);
722
int wmi_rx_chain_add(struct wil6210_priv *wil, struct vring *vring);
723
int wmi_p2p_cfg(struct wil6210_priv *wil, int channel);
724
int wmi_rxon(struct wil6210_priv *wil, bool on);
725
int wmi_get_temperature(struct wil6210_priv *wil, u32 *t_m, u32 *t_r);
726
int wmi_disconnect_sta(struct wil6210_priv *wil, const u8 *mac, u16 reason);
727
int wmi_addba(struct wil6210_priv *wil, u8 ringid, u8 size, u16 timeout);
728
729
int wmi_delba_tx(struct wil6210_priv *wil, u8 ringid, u16 reason);
int wmi_delba_rx(struct wil6210_priv *wil, u8 cidxtid, u16 reason);
730
731
732
733
734
735
736
int wmi_addba_rx_resp(struct wil6210_priv *wil, u8 cid, u8 tid, u8 token,
		      u16 status, bool amsdu, u16 agg_wsize, u16 timeout);
int wil_addba_rx_request(struct wil6210_priv *wil, u8 cidxtid,
			 u8 dialog_token, __le16 ba_param_set,
			 __le16 ba_timeout, __le16 ba_seq_ctrl);
void wil_back_rx_worker(struct work_struct *work);
void wil_back_rx_flush(struct wil6210_priv *wil);
737
int wil_addba_tx_request(struct wil6210_priv *wil, u8 ringid, u16 wsize);
738
739
void wil_back_tx_worker(struct work_struct *work);
void wil_back_tx_flush(struct wil6210_priv *wil);
740

741
void wil6210_clear_irq(struct wil6210_priv *wil);
742
743
int wil6210_init_irq(struct wil6210_priv *wil, int irq);
void wil6210_fini_irq(struct wil6210_priv *wil, int irq);
744
745
void wil_mask_irq(struct wil6210_priv *wil);
void wil_unmask_irq(struct wil6210_priv *wil);
746
void wil_configure_interrupt_moderation(struct wil6210_priv *wil);
747
748
void wil_disable_irq(struct wil6210_priv *wil);
void wil_enable_irq(struct wil6210_priv *wil);
749
750
751
int wil_cfg80211_mgmt_tx(struct wiphy *wiphy, struct wireless_dev *wdev,
			 struct cfg80211_mgmt_tx_params *params,
			 u64 *cookie);
752
753
754

int wil6210_debugfs_init(struct wil6210_priv *wil);
void wil6210_debugfs_remove(struct wil6210_priv *wil);
755
756
int wil_cid_fill_sinfo(struct wil6210_priv *wil, int cid,
		       struct station_info *sinfo);
757
758
759
760
761

struct wireless_dev *wil_cfg80211_init(struct device *dev);
void wil_wdev_free(struct wil6210_priv *wil);

int wmi_set_mac_address(struct wil6210_priv *wil, void *addr);
Hamad Kadmany's avatar
Hamad Kadmany committed
762
763
int wmi_pcp_start(struct wil6210_priv *wil, int bi, u8 wmi_nettype,
		  u8 chan, u8 hidden_ssid);
764
int wmi_pcp_stop(struct wil6210_priv *wil);
765
void wil6210_disconnect(struct wil6210_priv *wil, const u8 *bssid,
766
			u16 reason_code, bool from_event);
767
768
void wil_probe_client_flush(struct wil6210_priv *wil);
void wil_probe_client_worker(struct work_struct *work);
769

770
int wil_rx_init(struct wil6210_priv *wil, u16 size);
771
772
773
774
775
776
void wil_rx_fini(struct wil6210_priv *wil);

/* TX API */
int wil_vring_init_tx(struct wil6210_priv *wil, int id, int size,
		      int cid, int tid);
void wil_vring_fini_tx(struct wil6210_priv *wil, int id);
777
778
779
int wil_vring_init_bcast(struct wil6210_priv *wil, int id, int size);
int wil_bcast_init(struct wil6210_priv *wil);
void wil_bcast_fini(struct wil6210_priv *wil);
780
781

netdev_tx_t wil_start_xmit(struct sk_buff *skb, struct net_device *ndev);
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
782
783
int wil_tx_complete(struct wil6210_priv *wil, int ringid);
void wil6210_unmask_irq_tx(struct wil6210_priv *wil);
784
785

/* RX API */
Vladimir Kondratiev's avatar
Vladimir Kondratiev committed
786
787
void wil_rx_handle(struct wil6210_priv *wil, int *quota);
void wil6210_unmask_irq_rx(struct wil6210_priv *wil);
788
789
790

int wil_iftype_nl2wmi(enum nl80211_iftype type);

791
int wil_ioctl(struct wil6210_priv *wil, void __user *data, int cmd);
792
int wil_request_firmware(struct wil6210_priv *wil, const char *name);
793

794
#endif /* __WIL6210_H__ */