wil6210: fix for HW bug in interrupt setup logic
[firefly-linux-kernel-4.4.55.git] / drivers / net / wireless / ath / wil6210 / wil6210.h
1 /*
2  * Copyright (c) 2012 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/netdevice.h>
21 #include <linux/wireless.h>
22 #include <net/cfg80211.h>
23
24 #define WIL_NAME "wil6210"
25
26 /**
27  * extract bits [@b0:@b1] (inclusive) from the value @x
28  * it should be @b0 <= @b1, or result is incorrect
29  */
30 static inline u32 WIL_GET_BITS(u32 x, int b0, int b1)
31 {
32         return (x >> b0) & ((1 << (b1 - b0 + 1)) - 1);
33 }
34
35 #define WIL6210_MEM_SIZE (2*1024*1024UL)
36
37 #define WIL6210_RX_RING_SIZE    (128)
38 #define WIL6210_TX_RING_SIZE    (128)
39 #define WIL6210_MAX_TX_RINGS    (24) /* HW limit */
40 #define WIL6210_MAX_CID         (8) /* HW limit */
41 #define WIL6210_NAPI_BUDGET     (16) /* arbitrary */
42 #define WIL6210_ITR_TRSH        (10000) /* arbitrary - about 15 IRQs/msec */
43
44 /* Hardware definitions begin */
45
46 /*
47  * Mapping
48  * RGF File      | Host addr    |  FW addr
49  *               |              |
50  * user_rgf      | 0x000000     | 0x880000
51  *  dma_rgf      | 0x001000     | 0x881000
52  * pcie_rgf      | 0x002000     | 0x882000
53  *               |              |
54  */
55
56 /* Where various structures placed in host address space */
57 #define WIL6210_FW_HOST_OFF      (0x880000UL)
58
59 #define HOSTADDR(fwaddr)        (fwaddr - WIL6210_FW_HOST_OFF)
60
61 /*
62  * Interrupt control registers block
63  *
64  * each interrupt controlled by the same bit in all registers
65  */
66 struct RGF_ICR {
67         u32 ICC; /* Cause Control, RW: 0 - W1C, 1 - COR */
68         u32 ICR; /* Cause, W1C/COR depending on ICC */
69         u32 ICM; /* Cause masked (ICR & ~IMV), W1C/COR depending on ICC */
70         u32 ICS; /* Cause Set, WO */
71         u32 IMV; /* Mask, RW+S/C */
72         u32 IMS; /* Mask Set, write 1 to set */
73         u32 IMC; /* Mask Clear, write 1 to clear */
74 } __packed;
75
76 /* registers - FW addresses */
77 #define RGF_FW_REV_ID                   (0x880a8c) /* chip revision */
78 #define RGF_USER_SERIAL_BAUD_RATE       (0x880050)
79 #define RGF_LOS_COUNTER_CTL             (0x882dc4)
80 #define RGF_USER_USER_SCRATCH_PAD       (0x8802bc)
81 #define RGF_USER_USER_ICR               (0x880b4c) /* struct RGF_ICR */
82         #define BIT_USER_USER_ICR_SW_INT_2      BIT(18)
83 #define RGF_USER_CLKS_CTL_SW_RST_MASK_0 (0x880b14)
84 #define RGF_USER_MAC_CPU_0              (0x8801fc)
85 #define RGF_USER_USER_CPU_0             (0x8801e0)
86 #define RGF_USER_CLKS_CTL_SW_RST_VEC_0  (0x880b04)
87 #define RGF_USER_CLKS_CTL_SW_RST_VEC_1  (0x880b08)
88 #define RGF_USER_CLKS_CTL_SW_RST_VEC_2  (0x880b0c)
89 #define RGF_USER_CLKS_CTL_SW_RST_VEC_3  (0x880b10)
90
91 #define RGF_DMA_PSEUDO_CAUSE            (0x881c68)
92 #define RGF_DMA_PSEUDO_CAUSE_MASK_SW    (0x881c6c)
93 #define RGF_DMA_PSEUDO_CAUSE_MASK_FW    (0x881c70)
94         #define BIT_DMA_PSEUDO_CAUSE_RX         BIT(0)
95         #define BIT_DMA_PSEUDO_CAUSE_TX         BIT(1)
96         #define BIT_DMA_PSEUDO_CAUSE_MISC       BIT(2)
97
98 #define RGF_DMA_EP_TX_ICR               (0x881bb4) /* struct RGF_ICR */
99         #define BIT_DMA_EP_TX_ICR_TX_DONE       BIT(0)
100         #define BIT_DMA_EP_TX_ICR_TX_DONE_N(n)  BIT(n+1) /* n = [0..23] */
101 #define RGF_DMA_EP_RX_ICR               (0x881bd0) /* struct RGF_ICR */
102         #define BIT_DMA_EP_RX_ICR_RX_DONE       BIT(0)
103 #define RGF_DMA_EP_MISC_ICR             (0x881bec) /* struct RGF_ICR */
104         #define BIT_DMA_EP_MISC_ICR_RX_HTRSH    BIT(0)
105         #define BIT_DMA_EP_MISC_ICR_TX_NO_ACT   BIT(1)
106         #define BIT_DMA_EP_MISC_ICR_FW_INT(n)   BIT(28+n) /* n = [0..3] */
107
108 /* Interrupt moderation control */
109 #define RGF_DMA_ITR_CNT_TRSH            (0x881c5c)
110 #define RGF_DMA_ITR_CNT_DATA            (0x881c60)
111 #define RGF_DMA_ITR_CNT_CRL             (0x881C64)
112         #define BIT_DMA_ITR_CNT_CRL_EN          BIT(0)
113         #define BIT_DMA_ITR_CNT_CRL_EXT_TICK    BIT(1)
114         #define BIT_DMA_ITR_CNT_CRL_FOREVER     BIT(2)
115         #define BIT_DMA_ITR_CNT_CRL_CLR         BIT(3)
116         #define BIT_DMA_ITR_CNT_CRL_REACH_TRSH  BIT(4)
117
118 /* popular locations */
119 #define HOST_MBOX   HOSTADDR(RGF_USER_USER_SCRATCH_PAD)
120 #define HOST_SW_INT (HOSTADDR(RGF_USER_USER_ICR) + \
121         offsetof(struct RGF_ICR, ICS))
122 #define SW_INT_MBOX BIT_USER_USER_ICR_SW_INT_2
123
124 /* ISR register bits */
125 #define ISR_MISC_FW_READY       BIT_DMA_EP_MISC_ICR_FW_INT(0)
126 #define ISR_MISC_MBOX_EVT       BIT_DMA_EP_MISC_ICR_FW_INT(1)
127 #define ISR_MISC_FW_ERROR       BIT_DMA_EP_MISC_ICR_FW_INT(3)
128
129 /* Hardware definitions end */
130
131 /**
132  * mk_cidxtid - construct @cidxtid field
133  * @cid: CID value
134  * @tid: TID value
135  *
136  * @cidxtid field encoded as bits 0..3 - CID; 4..7 - TID
137  */
138 static inline u8 mk_cidxtid(u8 cid, u8 tid)
139 {
140         return ((tid & 0xf) << 4) | (cid & 0xf);
141 }
142
143 /**
144  * parse_cidxtid - parse @cidxtid field
145  * @cid: store CID value here
146  * @tid: store TID value here
147  *
148  * @cidxtid field encoded as bits 0..3 - CID; 4..7 - TID
149  */
150 static inline void parse_cidxtid(u8 cidxtid, u8 *cid, u8 *tid)
151 {
152         *cid = cidxtid & 0xf;
153         *tid = (cidxtid >> 4) & 0xf;
154 }
155
156 struct wil6210_mbox_ring {
157         u32 base;
158         u16 entry_size; /* max. size of mbox entry, incl. all headers */
159         u16 size;
160         u32 tail;
161         u32 head;
162 } __packed;
163
164 struct wil6210_mbox_ring_desc {
165         __le32 sync;
166         __le32 addr;
167 } __packed;
168
169 /* at HOST_OFF_WIL6210_MBOX_CTL */
170 struct wil6210_mbox_ctl {
171         struct wil6210_mbox_ring tx;
172         struct wil6210_mbox_ring rx;
173 } __packed;
174
175 struct wil6210_mbox_hdr {
176         __le16 seq;
177         __le16 len; /* payload, bytes after this header */
178         __le16 type;
179         u8 flags;
180         u8 reserved;
181 } __packed;
182
183 #define WIL_MBOX_HDR_TYPE_WMI (0)
184
185 /* max. value for wil6210_mbox_hdr.len */
186 #define MAX_MBOXITEM_SIZE   (240)
187
188 /**
189  * struct wil6210_mbox_hdr_wmi - WMI header
190  *
191  * @mid: MAC ID
192  *      00 - default, created by FW
193  *      01..0f - WiFi ports, driver to create
194  *      10..fe - debug
195  *      ff - broadcast
196  * @id: command/event ID
197  * @timestamp: FW fills for events, free-running msec timer
198  */
199 struct wil6210_mbox_hdr_wmi {
200         u8 mid;
201         u8 reserved;
202         __le16 id;
203         __le32 timestamp;
204 } __packed;
205
206 struct pending_wmi_event {
207         struct list_head list;
208         struct {
209                 struct wil6210_mbox_hdr hdr;
210                 struct wil6210_mbox_hdr_wmi wmi;
211                 u8 data[0];
212         } __packed event;
213 };
214
215 enum { /* for wil_ctx.mapped_as */
216         wil_mapped_as_none = 0,
217         wil_mapped_as_single = 1,
218         wil_mapped_as_page = 2,
219 };
220
221 /**
222  * struct wil_ctx - software context for Vring descriptor
223  */
224 struct wil_ctx {
225         struct sk_buff *skb;
226         u8 nr_frags;
227         u8 mapped_as;
228 };
229
230 union vring_desc;
231
232 struct vring {
233         dma_addr_t pa;
234         volatile union vring_desc *va; /* vring_desc[size], WriteBack by DMA */
235         u16 size; /* number of vring_desc elements */
236         u32 swtail;
237         u32 swhead;
238         u32 hwtail; /* write here to inform hw */
239         struct wil_ctx *ctx; /* ctx[size] - software context */
240 };
241
242 enum { /* for wil6210_priv.status */
243         wil_status_fwready = 0,
244         wil_status_fwconnecting,
245         wil_status_fwconnected,
246         wil_status_dontscan,
247         wil_status_reset_done,
248         wil_status_irqen, /* FIXME: interrupts enabled - for debug */
249 };
250
251 struct pci_dev;
252
253 /**
254  * struct tid_ampdu_rx - TID aggregation information (Rx).
255  *
256  * @reorder_buf: buffer to reorder incoming aggregated MPDUs
257  * @reorder_time: jiffies when skb was added
258  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
259  * @reorder_timer: releases expired frames from the reorder buffer.
260  * @last_rx: jiffies of last rx activity
261  * @head_seq_num: head sequence number in reordering buffer.
262  * @stored_mpdu_num: number of MPDUs in reordering buffer
263  * @ssn: Starting Sequence Number expected to be aggregated.
264  * @buf_size: buffer size for incoming A-MPDUs
265  * @timeout: reset timer value (in TUs).
266  * @dialog_token: dialog token for aggregation session
267  * @rcu_head: RCU head used for freeing this struct
268  * @reorder_lock: serializes access to reorder buffer, see below.
269  *
270  * This structure's lifetime is managed by RCU, assignments to
271  * the array holding it must hold the aggregation mutex.
272  *
273  * The @reorder_lock is used to protect the members of this
274  * struct, except for @timeout, @buf_size and @dialog_token,
275  * which are constant across the lifetime of the struct (the
276  * dialog token being used only for debugging).
277  */
278 struct wil_tid_ampdu_rx {
279         spinlock_t reorder_lock; /* see above */
280         struct sk_buff **reorder_buf;
281         unsigned long *reorder_time;
282         struct timer_list session_timer;
283         struct timer_list reorder_timer;
284         unsigned long last_rx;
285         u16 head_seq_num;
286         u16 stored_mpdu_num;
287         u16 ssn;
288         u16 buf_size;
289         u16 timeout;
290         u8 dialog_token;
291 };
292
293 struct wil6210_stats {
294         u64 tsf;
295         u32 snr;
296         u16 last_mcs_rx;
297         u16 bf_mcs; /* last BF, used for Tx */
298         u16 my_rx_sector;
299         u16 my_tx_sector;
300         u16 peer_rx_sector;
301         u16 peer_tx_sector;
302 };
303
304 enum wil_sta_status {
305         wil_sta_unused = 0,
306         wil_sta_conn_pending = 1,
307         wil_sta_connected = 2,
308 };
309
310 #define WIL_STA_TID_NUM (16)
311
312 struct wil_net_stats {
313         unsigned long   rx_packets;
314         unsigned long   tx_packets;
315         unsigned long   rx_bytes;
316         unsigned long   tx_bytes;
317         unsigned long   tx_errors;
318         unsigned long   rx_dropped;
319         u16 last_mcs_rx;
320 };
321
322 /**
323  * struct wil_sta_info - data for peer
324  *
325  * Peer identified by its CID (connection ID)
326  * NIC performs beam forming for each peer;
327  * if no beam forming done, frame exchange is not
328  * possible.
329  */
330 struct wil_sta_info {
331         u8 addr[ETH_ALEN];
332         enum wil_sta_status status;
333         struct wil_net_stats stats;
334         bool data_port_open; /* can send any data, not only EAPOL */
335         /* Rx BACK */
336         struct wil_tid_ampdu_rx *tid_rx[WIL_STA_TID_NUM];
337         unsigned long tid_rx_timer_expired[BITS_TO_LONGS(WIL_STA_TID_NUM)];
338         unsigned long tid_rx_stop_requested[BITS_TO_LONGS(WIL_STA_TID_NUM)];
339 };
340
341 struct wil6210_priv {
342         struct pci_dev *pdev;
343         int n_msi;
344         struct wireless_dev *wdev;
345         void __iomem *csr;
346         ulong status;
347         u32 fw_version;
348         u32 hw_version;
349         u8 n_mids; /* number of additional MIDs as reported by FW */
350         /* profile */
351         u32 monitor_flags;
352         u32 secure_pcp; /* create secure PCP? */
353         int sinfo_gen;
354         /* cached ISR registers */
355         u32 isr_misc;
356         /* mailbox related */
357         struct mutex wmi_mutex;
358         struct wil6210_mbox_ctl mbox_ctl;
359         struct completion wmi_ready;
360         u16 wmi_seq;
361         u16 reply_id; /**< wait for this WMI event */
362         void *reply_buf;
363         u16 reply_size;
364         struct workqueue_struct *wmi_wq; /* for deferred calls */
365         struct work_struct wmi_event_worker;
366         struct workqueue_struct *wmi_wq_conn; /* for connect worker */
367         struct work_struct connect_worker;
368         struct work_struct disconnect_worker;
369         struct timer_list connect_timer;
370         int pending_connect_cid;
371         struct list_head pending_wmi_ev;
372         /*
373          * protect pending_wmi_ev
374          * - fill in IRQ from wil6210_irq_misc,
375          * - consumed in thread by wmi_event_worker
376          */
377         spinlock_t wmi_ev_lock;
378         struct napi_struct napi_rx;
379         struct napi_struct napi_tx;
380         /* DMA related */
381         struct vring vring_rx;
382         struct vring vring_tx[WIL6210_MAX_TX_RINGS];
383         u8 vring2cid_tid[WIL6210_MAX_TX_RINGS][2]; /* [0] - CID, [1] - TID */
384         struct wil_sta_info sta[WIL6210_MAX_CID];
385         /* scan */
386         struct cfg80211_scan_request *scan_request;
387
388         struct mutex mutex; /* for wil6210_priv access in wil_{up|down} */
389         /* statistics */
390         struct wil6210_stats stats;
391         /* debugfs */
392         struct dentry *debug;
393         struct debugfs_blob_wrapper fw_code_blob;
394         struct debugfs_blob_wrapper fw_data_blob;
395         struct debugfs_blob_wrapper fw_peri_blob;
396         struct debugfs_blob_wrapper uc_code_blob;
397         struct debugfs_blob_wrapper uc_data_blob;
398         struct debugfs_blob_wrapper rgf_blob;
399 };
400
401 #define wil_to_wiphy(i) (i->wdev->wiphy)
402 #define wil_to_dev(i) (wiphy_dev(wil_to_wiphy(i)))
403 #define wiphy_to_wil(w) (struct wil6210_priv *)(wiphy_priv(w))
404 #define wil_to_wdev(i) (i->wdev)
405 #define wdev_to_wil(w) (struct wil6210_priv *)(wdev_priv(w))
406 #define wil_to_ndev(i) (wil_to_wdev(i)->netdev)
407 #define ndev_to_wil(n) (wdev_to_wil(n->ieee80211_ptr))
408
409 int wil_dbg_trace(struct wil6210_priv *wil, const char *fmt, ...);
410 int wil_err(struct wil6210_priv *wil, const char *fmt, ...);
411 int wil_info(struct wil6210_priv *wil, const char *fmt, ...);
412 #define wil_dbg(wil, fmt, arg...) do { \
413         netdev_dbg(wil_to_ndev(wil), fmt, ##arg); \
414         wil_dbg_trace(wil, fmt, ##arg); \
415 } while (0)
416
417 #define wil_dbg_irq(wil, fmt, arg...) wil_dbg(wil, "DBG[ IRQ]" fmt, ##arg)
418 #define wil_dbg_txrx(wil, fmt, arg...) wil_dbg(wil, "DBG[TXRX]" fmt, ##arg)
419 #define wil_dbg_wmi(wil, fmt, arg...) wil_dbg(wil, "DBG[ WMI]" fmt, ##arg)
420 #define wil_dbg_misc(wil, fmt, arg...) wil_dbg(wil, "DBG[MISC]" fmt, ##arg)
421
422 #define wil_hex_dump_txrx(prefix_str, prefix_type, rowsize,     \
423                           groupsize, buf, len, ascii)           \
424                           print_hex_dump_debug("DBG[TXRX]" prefix_str,\
425                                          prefix_type, rowsize,  \
426                                          groupsize, buf, len, ascii)
427
428 #define wil_hex_dump_wmi(prefix_str, prefix_type, rowsize,      \
429                          groupsize, buf, len, ascii)            \
430                          print_hex_dump_debug("DBG[ WMI]" prefix_str,\
431                                         prefix_type, rowsize,   \
432                                         groupsize, buf, len, ascii)
433
434 void wil_memcpy_fromio_32(void *dst, const volatile void __iomem *src,
435                           size_t count);
436 void wil_memcpy_toio_32(volatile void __iomem *dst, const void *src,
437                         size_t count);
438
439 void *wil_if_alloc(struct device *dev, void __iomem *csr);
440 void wil_if_free(struct wil6210_priv *wil);
441 int wil_if_add(struct wil6210_priv *wil);
442 void wil_if_remove(struct wil6210_priv *wil);
443 int wil_priv_init(struct wil6210_priv *wil);
444 void wil_priv_deinit(struct wil6210_priv *wil);
445 int wil_reset(struct wil6210_priv *wil);
446 void wil_link_on(struct wil6210_priv *wil);
447 void wil_link_off(struct wil6210_priv *wil);
448 int wil_up(struct wil6210_priv *wil);
449 int wil_down(struct wil6210_priv *wil);
450 void wil_mbox_ring_le2cpus(struct wil6210_mbox_ring *r);
451 int wil_find_cid(struct wil6210_priv *wil, const u8 *mac);
452
453 void __iomem *wmi_buffer(struct wil6210_priv *wil, __le32 ptr);
454 void __iomem *wmi_addr(struct wil6210_priv *wil, u32 ptr);
455 int wmi_read_hdr(struct wil6210_priv *wil, __le32 ptr,
456                  struct wil6210_mbox_hdr *hdr);
457 int wmi_send(struct wil6210_priv *wil, u16 cmdid, void *buf, u16 len);
458 void wmi_recv_cmd(struct wil6210_priv *wil);
459 int wmi_call(struct wil6210_priv *wil, u16 cmdid, void *buf, u16 len,
460              u16 reply_id, void *reply, u8 reply_size, int to_msec);
461 void wmi_event_worker(struct work_struct *work);
462 void wmi_event_flush(struct wil6210_priv *wil);
463 int wmi_set_ssid(struct wil6210_priv *wil, u8 ssid_len, const void *ssid);
464 int wmi_get_ssid(struct wil6210_priv *wil, u8 *ssid_len, void *ssid);
465 int wmi_set_channel(struct wil6210_priv *wil, int channel);
466 int wmi_get_channel(struct wil6210_priv *wil, int *channel);
467 int wmi_del_cipher_key(struct wil6210_priv *wil, u8 key_index,
468                        const void *mac_addr);
469 int wmi_add_cipher_key(struct wil6210_priv *wil, u8 key_index,
470                        const void *mac_addr, int key_len, const void *key);
471 int wmi_echo(struct wil6210_priv *wil);
472 int wmi_set_ie(struct wil6210_priv *wil, u8 type, u16 ie_len, const void *ie);
473 int wmi_rx_chain_add(struct wil6210_priv *wil, struct vring *vring);
474 int wmi_p2p_cfg(struct wil6210_priv *wil, int channel);
475 int wmi_rxon(struct wil6210_priv *wil, bool on);
476 int wmi_get_temperature(struct wil6210_priv *wil, u32 *t_m, u32 *t_r);
477 int wmi_disconnect_sta(struct wil6210_priv *wil, const u8 *mac, u16 reason);
478
479 void wil6210_clear_irq(struct wil6210_priv *wil);
480 int wil6210_init_irq(struct wil6210_priv *wil, int irq);
481 void wil6210_fini_irq(struct wil6210_priv *wil, int irq);
482 void wil6210_disable_irq(struct wil6210_priv *wil);
483 void wil6210_enable_irq(struct wil6210_priv *wil);
484
485 int wil6210_debugfs_init(struct wil6210_priv *wil);
486 void wil6210_debugfs_remove(struct wil6210_priv *wil);
487
488 struct wireless_dev *wil_cfg80211_init(struct device *dev);
489 void wil_wdev_free(struct wil6210_priv *wil);
490
491 int wmi_set_mac_address(struct wil6210_priv *wil, void *addr);
492 int wmi_pcp_start(struct wil6210_priv *wil, int bi, u8 wmi_nettype, u8 chan);
493 int wmi_pcp_stop(struct wil6210_priv *wil);
494 void wil6210_disconnect(struct wil6210_priv *wil, void *bssid);
495
496 int wil_rx_init(struct wil6210_priv *wil);
497 void wil_rx_fini(struct wil6210_priv *wil);
498
499 /* TX API */
500 int wil_vring_init_tx(struct wil6210_priv *wil, int id, int size,
501                       int cid, int tid);
502 void wil_vring_fini_tx(struct wil6210_priv *wil, int id);
503
504 netdev_tx_t wil_start_xmit(struct sk_buff *skb, struct net_device *ndev);
505 int wil_tx_complete(struct wil6210_priv *wil, int ringid);
506 void wil6210_unmask_irq_tx(struct wil6210_priv *wil);
507
508 /* RX API */
509 void wil_rx_handle(struct wil6210_priv *wil, int *quota);
510 void wil6210_unmask_irq_rx(struct wil6210_priv *wil);
511
512 int wil_iftype_nl2wmi(enum nl80211_iftype type);
513
514 #endif /* __WIL6210_H__ */