2 * Copyright (c) 2012 Qualcomm Atheros, Inc.
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.
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.
20 #include <linux/netdevice.h>
21 #include <linux/wireless.h>
22 #include <net/cfg80211.h>
23 #include <linux/timex.h>
25 #define WIL_NAME "wil6210"
29 #define WIL_BOARD_MARLON (1)
30 #define WIL_BOARD_SPARROW (2)
31 const char * const name
;
35 * extract bits [@b0:@b1] (inclusive) from the value @x
36 * it should be @b0 <= @b1, or result is incorrect
38 static inline u32
WIL_GET_BITS(u32 x
, int b0
, int b1
)
40 return (x
>> b0
) & ((1 << (b1
- b0
+ 1)) - 1);
43 #define WIL6210_MEM_SIZE (2*1024*1024UL)
45 #define WIL6210_RX_RING_SIZE (128)
46 #define WIL6210_TX_RING_SIZE (512)
47 #define WIL6210_MAX_TX_RINGS (24) /* HW limit */
48 #define WIL6210_MAX_CID (8) /* HW limit */
49 #define WIL6210_NAPI_BUDGET (16) /* arbitrary */
50 #define WIL6210_ITR_TRSH (10000) /* arbitrary - about 15 IRQs/msec */
51 #define WIL6210_FW_RECOVERY_RETRIES (5) /* try to recover this many times */
52 #define WIL6210_FW_RECOVERY_TO msecs_to_jiffies(5000)
53 #define WIL6210_SCAN_TO msecs_to_jiffies(10000)
55 /* Hardware definitions begin */
59 * RGF File | Host addr | FW addr
61 * user_rgf | 0x000000 | 0x880000
62 * dma_rgf | 0x001000 | 0x881000
63 * pcie_rgf | 0x002000 | 0x882000
67 /* Where various structures placed in host address space */
68 #define WIL6210_FW_HOST_OFF (0x880000UL)
70 #define HOSTADDR(fwaddr) (fwaddr - WIL6210_FW_HOST_OFF)
73 * Interrupt control registers block
75 * each interrupt controlled by the same bit in all registers
78 u32 ICC
; /* Cause Control, RW: 0 - W1C, 1 - COR */
79 u32 ICR
; /* Cause, W1C/COR depending on ICC */
80 u32 ICM
; /* Cause masked (ICR & ~IMV), W1C/COR depending on ICC */
81 u32 ICS
; /* Cause Set, WO */
82 u32 IMV
; /* Mask, RW+S/C */
83 u32 IMS
; /* Mask Set, write 1 to set */
84 u32 IMC
; /* Mask Clear, write 1 to clear */
87 /* registers - FW addresses */
88 #define RGF_USER_USAGE_1 (0x880004)
89 #define RGF_USER_HW_MACHINE_STATE (0x8801dc)
90 #define HW_MACHINE_BOOT_DONE (0x3fffffd)
91 #define RGF_USER_USER_CPU_0 (0x8801e0)
92 #define RGF_USER_MAC_CPU_0 (0x8801fc)
93 #define RGF_USER_USER_SCRATCH_PAD (0x8802bc)
94 #define RGF_USER_FW_REV_ID (0x880a8c) /* chip revision */
95 #define RGF_USER_CLKS_CTL_0 (0x880abc)
96 #define BIT_USER_CLKS_RST_PWGD BIT(11) /* reset on "power good" */
97 #define RGF_USER_CLKS_CTL_SW_RST_VEC_0 (0x880b04)
98 #define RGF_USER_CLKS_CTL_SW_RST_VEC_1 (0x880b08)
99 #define RGF_USER_CLKS_CTL_SW_RST_VEC_2 (0x880b0c)
100 #define RGF_USER_CLKS_CTL_SW_RST_VEC_3 (0x880b10)
101 #define RGF_USER_CLKS_CTL_SW_RST_MASK_0 (0x880b14)
102 #define RGF_USER_USER_ICR (0x880b4c) /* struct RGF_ICR */
103 #define BIT_USER_USER_ICR_SW_INT_2 BIT(18)
104 #define RGF_USER_CLKS_CTL_EXT_SW_RST_VEC_0 (0x880c18)
106 #define RGF_DMA_EP_TX_ICR (0x881bb4) /* struct RGF_ICR */
107 #define BIT_DMA_EP_TX_ICR_TX_DONE BIT(0)
108 #define BIT_DMA_EP_TX_ICR_TX_DONE_N(n) BIT(n+1) /* n = [0..23] */
109 #define RGF_DMA_EP_RX_ICR (0x881bd0) /* struct RGF_ICR */
110 #define BIT_DMA_EP_RX_ICR_RX_DONE BIT(0)
111 #define RGF_DMA_EP_MISC_ICR (0x881bec) /* struct RGF_ICR */
112 #define BIT_DMA_EP_MISC_ICR_RX_HTRSH BIT(0)
113 #define BIT_DMA_EP_MISC_ICR_TX_NO_ACT BIT(1)
114 #define BIT_DMA_EP_MISC_ICR_FW_INT(n) BIT(28+n) /* n = [0..3] */
116 /* Interrupt moderation control */
117 #define RGF_DMA_ITR_CNT_TRSH (0x881c5c)
118 #define RGF_DMA_ITR_CNT_DATA (0x881c60)
119 #define RGF_DMA_ITR_CNT_CRL (0x881c64)
120 #define BIT_DMA_ITR_CNT_CRL_EN BIT(0)
121 #define BIT_DMA_ITR_CNT_CRL_EXT_TICK BIT(1)
122 #define BIT_DMA_ITR_CNT_CRL_FOREVER BIT(2)
123 #define BIT_DMA_ITR_CNT_CRL_CLR BIT(3)
124 #define BIT_DMA_ITR_CNT_CRL_REACH_TRSH BIT(4)
126 #define RGF_DMA_PSEUDO_CAUSE (0x881c68)
127 #define RGF_DMA_PSEUDO_CAUSE_MASK_SW (0x881c6c)
128 #define RGF_DMA_PSEUDO_CAUSE_MASK_FW (0x881c70)
129 #define BIT_DMA_PSEUDO_CAUSE_RX BIT(0)
130 #define BIT_DMA_PSEUDO_CAUSE_TX BIT(1)
131 #define BIT_DMA_PSEUDO_CAUSE_MISC BIT(2)
133 #define RGF_HP_CTRL (0x88265c)
134 #define RGF_PCIE_LOS_COUNTER_CTL (0x882dc4)
136 /* popular locations */
137 #define HOST_MBOX HOSTADDR(RGF_USER_USER_SCRATCH_PAD)
138 #define HOST_SW_INT (HOSTADDR(RGF_USER_USER_ICR) + \
139 offsetof(struct RGF_ICR, ICS))
140 #define SW_INT_MBOX BIT_USER_USER_ICR_SW_INT_2
142 /* ISR register bits */
143 #define ISR_MISC_FW_READY BIT_DMA_EP_MISC_ICR_FW_INT(0)
144 #define ISR_MISC_MBOX_EVT BIT_DMA_EP_MISC_ICR_FW_INT(1)
145 #define ISR_MISC_FW_ERROR BIT_DMA_EP_MISC_ICR_FW_INT(3)
147 /* Hardware definitions end */
149 u32 from
; /* linker address - from, inclusive */
150 u32 to
; /* linker address - to, exclusive */
151 u32 host
; /* PCI/Host address - BAR0 + 0x880000 */
152 const char *name
; /* for debugfs */
154 /* array size should be in sync with actual definition in the wmi.c */
155 extern const struct fw_map fw_mapping
[7];
158 * mk_cidxtid - construct @cidxtid field
162 * @cidxtid field encoded as bits 0..3 - CID; 4..7 - TID
164 static inline u8
mk_cidxtid(u8 cid
, u8 tid
)
166 return ((tid
& 0xf) << 4) | (cid
& 0xf);
170 * parse_cidxtid - parse @cidxtid field
171 * @cid: store CID value here
172 * @tid: store TID value here
174 * @cidxtid field encoded as bits 0..3 - CID; 4..7 - TID
176 static inline void parse_cidxtid(u8 cidxtid
, u8
*cid
, u8
*tid
)
178 *cid
= cidxtid
& 0xf;
179 *tid
= (cidxtid
>> 4) & 0xf;
182 struct wil6210_mbox_ring
{
184 u16 entry_size
; /* max. size of mbox entry, incl. all headers */
190 struct wil6210_mbox_ring_desc
{
195 /* at HOST_OFF_WIL6210_MBOX_CTL */
196 struct wil6210_mbox_ctl
{
197 struct wil6210_mbox_ring tx
;
198 struct wil6210_mbox_ring rx
;
201 struct wil6210_mbox_hdr
{
203 __le16 len
; /* payload, bytes after this header */
209 #define WIL_MBOX_HDR_TYPE_WMI (0)
211 /* max. value for wil6210_mbox_hdr.len */
212 #define MAX_MBOXITEM_SIZE (240)
215 * struct wil6210_mbox_hdr_wmi - WMI header
218 * 00 - default, created by FW
219 * 01..0f - WiFi ports, driver to create
222 * @id: command/event ID
223 * @timestamp: FW fills for events, free-running msec timer
225 struct wil6210_mbox_hdr_wmi
{
232 struct pending_wmi_event
{
233 struct list_head list
;
235 struct wil6210_mbox_hdr hdr
;
236 struct wil6210_mbox_hdr_wmi wmi
;
241 enum { /* for wil_ctx.mapped_as */
242 wil_mapped_as_none
= 0,
243 wil_mapped_as_single
= 1,
244 wil_mapped_as_page
= 2,
248 * struct wil_ctx - software context for Vring descriptor
260 volatile union vring_desc
*va
; /* vring_desc[size], WriteBack by DMA */
261 u16 size
; /* number of vring_desc elements */
264 u32 hwtail
; /* write here to inform hw */
265 struct wil_ctx
*ctx
; /* ctx[size] - software context */
269 * Additional data for Tx Vring
271 struct vring_tx_data
{
273 cycles_t idle
, last_idle
, begin
;
276 enum { /* for wil6210_priv.status */
277 wil_status_fwready
= 0,
278 wil_status_fwconnecting
,
279 wil_status_fwconnected
,
281 wil_status_reset_done
,
282 wil_status_irqen
, /* FIXME: interrupts enabled - for debug */
283 wil_status_napi_en
, /* NAPI enabled protected by wil->mutex */
289 * struct tid_ampdu_rx - TID aggregation information (Rx).
291 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
292 * @reorder_time: jiffies when skb was added
293 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
294 * @reorder_timer: releases expired frames from the reorder buffer.
295 * @last_rx: jiffies of last rx activity
296 * @head_seq_num: head sequence number in reordering buffer.
297 * @stored_mpdu_num: number of MPDUs in reordering buffer
298 * @ssn: Starting Sequence Number expected to be aggregated.
299 * @buf_size: buffer size for incoming A-MPDUs
300 * @timeout: reset timer value (in TUs).
301 * @dialog_token: dialog token for aggregation session
302 * @rcu_head: RCU head used for freeing this struct
303 * @reorder_lock: serializes access to reorder buffer, see below.
305 * This structure's lifetime is managed by RCU, assignments to
306 * the array holding it must hold the aggregation mutex.
308 * The @reorder_lock is used to protect the members of this
309 * struct, except for @timeout, @buf_size and @dialog_token,
310 * which are constant across the lifetime of the struct (the
311 * dialog token being used only for debugging).
313 struct wil_tid_ampdu_rx
{
314 spinlock_t reorder_lock
; /* see above */
315 struct sk_buff
**reorder_buf
;
316 unsigned long *reorder_time
;
317 struct timer_list session_timer
;
318 struct timer_list reorder_timer
;
319 unsigned long last_rx
;
327 bool first_time
; /* is it 1-st time this buffer used? */
330 struct wil6210_stats
{
334 u16 bf_mcs
; /* last BF, used for Tx */
341 enum wil_sta_status
{
343 wil_sta_conn_pending
= 1,
344 wil_sta_connected
= 2,
347 #define WIL_STA_TID_NUM (16)
349 struct wil_net_stats
{
350 unsigned long rx_packets
;
351 unsigned long tx_packets
;
352 unsigned long rx_bytes
;
353 unsigned long tx_bytes
;
354 unsigned long tx_errors
;
355 unsigned long rx_dropped
;
360 * struct wil_sta_info - data for peer
362 * Peer identified by its CID (connection ID)
363 * NIC performs beam forming for each peer;
364 * if no beam forming done, frame exchange is not
367 struct wil_sta_info
{
369 enum wil_sta_status status
;
370 struct wil_net_stats stats
;
371 bool data_port_open
; /* can send any data, not only EAPOL */
373 struct wil_tid_ampdu_rx
*tid_rx
[WIL_STA_TID_NUM
];
374 unsigned long tid_rx_timer_expired
[BITS_TO_LONGS(WIL_STA_TID_NUM
)];
375 unsigned long tid_rx_stop_requested
[BITS_TO_LONGS(WIL_STA_TID_NUM
)];
378 struct wil6210_priv
{
379 struct pci_dev
*pdev
;
381 struct wireless_dev
*wdev
;
386 struct wil_board
*board
;
387 u8 n_mids
; /* number of additional MIDs as reported by FW */
388 int recovery_count
; /* num of FW recovery attempts in a short time */
389 unsigned long last_fw_recovery
; /* jiffies of last fw recovery */
392 u32 secure_pcp
; /* create secure PCP? */
394 /* cached ISR registers */
396 /* mailbox related */
397 struct mutex wmi_mutex
;
398 struct wil6210_mbox_ctl mbox_ctl
;
399 struct completion wmi_ready
;
401 u16 reply_id
; /**< wait for this WMI event */
404 struct workqueue_struct
*wmi_wq
; /* for deferred calls */
405 struct work_struct wmi_event_worker
;
406 struct workqueue_struct
*wmi_wq_conn
; /* for connect worker */
407 struct work_struct connect_worker
;
408 struct work_struct disconnect_worker
;
409 struct work_struct fw_error_worker
; /* for FW error recovery */
410 struct timer_list connect_timer
;
411 struct timer_list scan_timer
; /* detect scan timeout */
412 int pending_connect_cid
;
413 struct list_head pending_wmi_ev
;
415 * protect pending_wmi_ev
416 * - fill in IRQ from wil6210_irq_misc,
417 * - consumed in thread by wmi_event_worker
419 spinlock_t wmi_ev_lock
;
420 struct napi_struct napi_rx
;
421 struct napi_struct napi_tx
;
423 struct vring vring_rx
;
424 struct vring vring_tx
[WIL6210_MAX_TX_RINGS
];
425 struct vring_tx_data vring_tx_data
[WIL6210_MAX_TX_RINGS
];
426 u8 vring2cid_tid
[WIL6210_MAX_TX_RINGS
][2]; /* [0] - CID, [1] - TID */
427 struct wil_sta_info sta
[WIL6210_MAX_CID
];
429 struct cfg80211_scan_request
*scan_request
;
431 struct mutex mutex
; /* for wil6210_priv access in wil_{up|down} */
433 struct wil6210_stats stats
;
434 atomic_t isr_count_rx
, isr_count_tx
;
436 struct dentry
*debug
;
437 struct debugfs_blob_wrapper blobs
[ARRAY_SIZE(fw_mapping
)];
440 #define wil_to_wiphy(i) (i->wdev->wiphy)
441 #define wil_to_dev(i) (wiphy_dev(wil_to_wiphy(i)))
442 #define wiphy_to_wil(w) (struct wil6210_priv *)(wiphy_priv(w))
443 #define wil_to_wdev(i) (i->wdev)
444 #define wdev_to_wil(w) (struct wil6210_priv *)(wdev_priv(w))
445 #define wil_to_ndev(i) (wil_to_wdev(i)->netdev)
446 #define ndev_to_wil(n) (wdev_to_wil(n->ieee80211_ptr))
448 int wil_dbg_trace(struct wil6210_priv
*wil
, const char *fmt
, ...);
449 int wil_err(struct wil6210_priv
*wil
, const char *fmt
, ...);
450 int wil_info(struct wil6210_priv
*wil
, const char *fmt
, ...);
451 #define wil_dbg(wil, fmt, arg...) do { \
452 netdev_dbg(wil_to_ndev(wil), fmt, ##arg); \
453 wil_dbg_trace(wil, fmt, ##arg); \
456 #define wil_dbg_irq(wil, fmt, arg...) wil_dbg(wil, "DBG[ IRQ]" fmt, ##arg)
457 #define wil_dbg_txrx(wil, fmt, arg...) wil_dbg(wil, "DBG[TXRX]" fmt, ##arg)
458 #define wil_dbg_wmi(wil, fmt, arg...) wil_dbg(wil, "DBG[ WMI]" fmt, ##arg)
459 #define wil_dbg_misc(wil, fmt, arg...) wil_dbg(wil, "DBG[MISC]" fmt, ##arg)
461 #define wil_hex_dump_txrx(prefix_str, prefix_type, rowsize, \
462 groupsize, buf, len, ascii) \
463 print_hex_dump_debug("DBG[TXRX]" prefix_str,\
464 prefix_type, rowsize, \
465 groupsize, buf, len, ascii)
467 #define wil_hex_dump_wmi(prefix_str, prefix_type, rowsize, \
468 groupsize, buf, len, ascii) \
469 print_hex_dump_debug("DBG[ WMI]" prefix_str,\
470 prefix_type, rowsize, \
471 groupsize, buf, len, ascii)
473 void wil_memcpy_fromio_32(void *dst
, const volatile void __iomem
*src
,
475 void wil_memcpy_toio_32(volatile void __iomem
*dst
, const void *src
,
478 void *wil_if_alloc(struct device
*dev
, void __iomem
*csr
);
479 void wil_if_free(struct wil6210_priv
*wil
);
480 int wil_if_add(struct wil6210_priv
*wil
);
481 void wil_if_remove(struct wil6210_priv
*wil
);
482 int wil_priv_init(struct wil6210_priv
*wil
);
483 void wil_priv_deinit(struct wil6210_priv
*wil
);
484 int wil_reset(struct wil6210_priv
*wil
);
485 void wil_fw_error_recovery(struct wil6210_priv
*wil
);
486 void wil_link_on(struct wil6210_priv
*wil
);
487 void wil_link_off(struct wil6210_priv
*wil
);
488 int wil_up(struct wil6210_priv
*wil
);
489 int wil_down(struct wil6210_priv
*wil
);
490 void wil_mbox_ring_le2cpus(struct wil6210_mbox_ring
*r
);
491 int wil_find_cid(struct wil6210_priv
*wil
, const u8
*mac
);
493 void __iomem
*wmi_buffer(struct wil6210_priv
*wil
, __le32 ptr
);
494 void __iomem
*wmi_addr(struct wil6210_priv
*wil
, u32 ptr
);
495 int wmi_read_hdr(struct wil6210_priv
*wil
, __le32 ptr
,
496 struct wil6210_mbox_hdr
*hdr
);
497 int wmi_send(struct wil6210_priv
*wil
, u16 cmdid
, void *buf
, u16 len
);
498 void wmi_recv_cmd(struct wil6210_priv
*wil
);
499 int wmi_call(struct wil6210_priv
*wil
, u16 cmdid
, void *buf
, u16 len
,
500 u16 reply_id
, void *reply
, u8 reply_size
, int to_msec
);
501 void wmi_event_worker(struct work_struct
*work
);
502 void wmi_event_flush(struct wil6210_priv
*wil
);
503 int wmi_set_ssid(struct wil6210_priv
*wil
, u8 ssid_len
, const void *ssid
);
504 int wmi_get_ssid(struct wil6210_priv
*wil
, u8
*ssid_len
, void *ssid
);
505 int wmi_set_channel(struct wil6210_priv
*wil
, int channel
);
506 int wmi_get_channel(struct wil6210_priv
*wil
, int *channel
);
507 int wmi_del_cipher_key(struct wil6210_priv
*wil
, u8 key_index
,
508 const void *mac_addr
);
509 int wmi_add_cipher_key(struct wil6210_priv
*wil
, u8 key_index
,
510 const void *mac_addr
, int key_len
, const void *key
);
511 int wmi_echo(struct wil6210_priv
*wil
);
512 int wmi_set_ie(struct wil6210_priv
*wil
, u8 type
, u16 ie_len
, const void *ie
);
513 int wmi_rx_chain_add(struct wil6210_priv
*wil
, struct vring
*vring
);
514 int wmi_p2p_cfg(struct wil6210_priv
*wil
, int channel
);
515 int wmi_rxon(struct wil6210_priv
*wil
, bool on
);
516 int wmi_get_temperature(struct wil6210_priv
*wil
, u32
*t_m
, u32
*t_r
);
517 int wmi_disconnect_sta(struct wil6210_priv
*wil
, const u8
*mac
, u16 reason
);
519 void wil6210_clear_irq(struct wil6210_priv
*wil
);
520 int wil6210_init_irq(struct wil6210_priv
*wil
, int irq
);
521 void wil6210_fini_irq(struct wil6210_priv
*wil
, int irq
);
522 void wil6210_disable_irq(struct wil6210_priv
*wil
);
523 void wil6210_enable_irq(struct wil6210_priv
*wil
);
524 int wil_cfg80211_mgmt_tx(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
525 struct cfg80211_mgmt_tx_params
*params
,
528 int wil6210_debugfs_init(struct wil6210_priv
*wil
);
529 void wil6210_debugfs_remove(struct wil6210_priv
*wil
);
530 int wil_cid_fill_sinfo(struct wil6210_priv
*wil
, int cid
,
531 struct station_info
*sinfo
);
533 struct wireless_dev
*wil_cfg80211_init(struct device
*dev
);
534 void wil_wdev_free(struct wil6210_priv
*wil
);
536 int wmi_set_mac_address(struct wil6210_priv
*wil
, void *addr
);
537 int wmi_pcp_start(struct wil6210_priv
*wil
, int bi
, u8 wmi_nettype
, u8 chan
);
538 int wmi_pcp_stop(struct wil6210_priv
*wil
);
539 void wil6210_disconnect(struct wil6210_priv
*wil
, const u8
*bssid
);
541 int wil_rx_init(struct wil6210_priv
*wil
);
542 void wil_rx_fini(struct wil6210_priv
*wil
);
545 int wil_vring_init_tx(struct wil6210_priv
*wil
, int id
, int size
,
547 void wil_vring_fini_tx(struct wil6210_priv
*wil
, int id
);
549 netdev_tx_t
wil_start_xmit(struct sk_buff
*skb
, struct net_device
*ndev
);
550 int wil_tx_complete(struct wil6210_priv
*wil
, int ringid
);
551 void wil6210_unmask_irq_tx(struct wil6210_priv
*wil
);
554 void wil_rx_handle(struct wil6210_priv
*wil
, int *quota
);
555 void wil6210_unmask_irq_rx(struct wil6210_priv
*wil
);
557 int wil_iftype_nl2wmi(enum nl80211_iftype type
);
559 #endif /* __WIL6210_H__ */