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 #include "dbg_hexdump.h" 25 26 #define WIL_NAME "wil6210" 27 28 /** 29 * extract bits [@b0:@b1] (inclusive) from the value @x 30 * it should be @b0 <= @b1, or result is incorrect 31 */ 32 static inline u32 WIL_GET_BITS(u32 x, int b0, int b1) 33 { 34 return (x >> b0) & ((1 << (b1 - b0 + 1)) - 1); 35 } 36 37 #define WIL6210_MEM_SIZE (2*1024*1024UL) 38 39 #define WIL6210_TX_QUEUES (4) 40 41 #define WIL6210_RX_RING_SIZE (128) 42 #define WIL6210_TX_RING_SIZE (128) 43 #define WIL6210_MAX_TX_RINGS (24) 44 45 /* Hardware definitions begin */ 46 47 /* 48 * Mapping 49 * RGF File | Host addr | FW addr 50 * | | 51 * user_rgf | 0x000000 | 0x880000 52 * dma_rgf | 0x001000 | 0x881000 53 * pcie_rgf | 0x002000 | 0x882000 54 * | | 55 */ 56 57 /* Where various structures placed in host address space */ 58 #define WIL6210_FW_HOST_OFF (0x880000UL) 59 60 #define HOSTADDR(fwaddr) (fwaddr - WIL6210_FW_HOST_OFF) 61 62 /* 63 * Interrupt control registers block 64 * 65 * each interrupt controlled by the same bit in all registers 66 */ 67 struct RGF_ICR { 68 u32 ICC; /* Cause Control, RW: 0 - W1C, 1 - COR */ 69 u32 ICR; /* Cause, W1C/COR depending on ICC */ 70 u32 ICM; /* Cause masked (ICR & ~IMV), W1C/COR depending on ICC */ 71 u32 ICS; /* Cause Set, WO */ 72 u32 IMV; /* Mask, RW+S/C */ 73 u32 IMS; /* Mask Set, write 1 to set */ 74 u32 IMC; /* Mask Clear, write 1 to clear */ 75 } __packed; 76 77 /* registers - FW addresses */ 78 #define RGF_USER_USER_SCRATCH_PAD (0x8802bc) 79 #define RGF_USER_USER_ICR (0x880b4c) /* struct RGF_ICR */ 80 #define BIT_USER_USER_ICR_SW_INT_2 BIT(18) 81 #define RGF_USER_CLKS_CTL_SW_RST_MASK_0 (0x880b14) 82 #define RGF_USER_MAC_CPU_0 (0x8801fc) 83 #define RGF_USER_USER_CPU_0 (0x8801e0) 84 #define RGF_USER_CLKS_CTL_SW_RST_VEC_0 (0x880b04) 85 #define RGF_USER_CLKS_CTL_SW_RST_VEC_1 (0x880b08) 86 #define RGF_USER_CLKS_CTL_SW_RST_VEC_2 (0x880b0c) 87 #define RGF_USER_CLKS_CTL_SW_RST_VEC_3 (0x880b10) 88 89 #define RGF_DMA_PSEUDO_CAUSE (0x881c68) 90 #define RGF_DMA_PSEUDO_CAUSE_MASK_SW (0x881c6c) 91 #define RGF_DMA_PSEUDO_CAUSE_MASK_FW (0x881c70) 92 #define BIT_DMA_PSEUDO_CAUSE_RX BIT(0) 93 #define BIT_DMA_PSEUDO_CAUSE_TX BIT(1) 94 #define BIT_DMA_PSEUDO_CAUSE_MISC BIT(2) 95 96 #define RGF_DMA_EP_TX_ICR (0x881bb4) /* struct RGF_ICR */ 97 #define BIT_DMA_EP_TX_ICR_TX_DONE BIT(0) 98 #define BIT_DMA_EP_TX_ICR_TX_DONE_N(n) BIT(n+1) /* n = [0..23] */ 99 #define RGF_DMA_EP_RX_ICR (0x881bd0) /* struct RGF_ICR */ 100 #define BIT_DMA_EP_RX_ICR_RX_DONE BIT(0) 101 #define RGF_DMA_EP_MISC_ICR (0x881bec) /* struct RGF_ICR */ 102 #define BIT_DMA_EP_MISC_ICR_RX_HTRSH BIT(0) 103 #define BIT_DMA_EP_MISC_ICR_TX_NO_ACT BIT(1) 104 #define BIT_DMA_EP_MISC_ICR_FW_INT0 BIT(28) 105 #define BIT_DMA_EP_MISC_ICR_FW_INT1 BIT(29) 106 107 /* Interrupt moderation control */ 108 #define RGF_DMA_ITR_CNT_TRSH (0x881c5c) 109 #define RGF_DMA_ITR_CNT_DATA (0x881c60) 110 #define RGF_DMA_ITR_CNT_CRL (0x881C64) 111 #define BIT_DMA_ITR_CNT_CRL_EN BIT(0) 112 #define BIT_DMA_ITR_CNT_CRL_EXT_TICK BIT(1) 113 #define BIT_DMA_ITR_CNT_CRL_FOREVER BIT(2) 114 #define BIT_DMA_ITR_CNT_CRL_CLR BIT(3) 115 #define BIT_DMA_ITR_CNT_CRL_REACH_TRSH BIT(4) 116 117 /* popular locations */ 118 #define HOST_MBOX HOSTADDR(RGF_USER_USER_SCRATCH_PAD) 119 #define HOST_SW_INT (HOSTADDR(RGF_USER_USER_ICR) + \ 120 offsetof(struct RGF_ICR, ICS)) 121 #define SW_INT_MBOX BIT_USER_USER_ICR_SW_INT_2 122 123 /* ISR register bits */ 124 #define ISR_MISC_FW_READY BIT_DMA_EP_MISC_ICR_FW_INT0 125 #define ISR_MISC_MBOX_EVT BIT_DMA_EP_MISC_ICR_FW_INT1 126 127 /* Hardware definitions end */ 128 129 struct wil6210_mbox_ring { 130 u32 base; 131 u16 entry_size; /* max. size of mbox entry, incl. all headers */ 132 u16 size; 133 u32 tail; 134 u32 head; 135 } __packed; 136 137 struct wil6210_mbox_ring_desc { 138 __le32 sync; 139 __le32 addr; 140 } __packed; 141 142 /* at HOST_OFF_WIL6210_MBOX_CTL */ 143 struct wil6210_mbox_ctl { 144 struct wil6210_mbox_ring tx; 145 struct wil6210_mbox_ring rx; 146 } __packed; 147 148 struct wil6210_mbox_hdr { 149 __le16 seq; 150 __le16 len; /* payload, bytes after this header */ 151 __le16 type; 152 u8 flags; 153 u8 reserved; 154 } __packed; 155 156 #define WIL_MBOX_HDR_TYPE_WMI (0) 157 158 /* max. value for wil6210_mbox_hdr.len */ 159 #define MAX_MBOXITEM_SIZE (240) 160 161 struct wil6210_mbox_hdr_wmi { 162 u8 reserved0[2]; 163 __le16 id; 164 __le16 info1; /* bits [0..3] - device_id, rest - unused */ 165 u8 reserved1[2]; 166 } __packed; 167 168 struct pending_wmi_event { 169 struct list_head list; 170 struct { 171 struct wil6210_mbox_hdr hdr; 172 struct wil6210_mbox_hdr_wmi wmi; 173 u8 data[0]; 174 } __packed event; 175 }; 176 177 union vring_desc; 178 179 struct vring { 180 dma_addr_t pa; 181 volatile union vring_desc *va; /* vring_desc[size], WriteBack by DMA */ 182 u16 size; /* number of vring_desc elements */ 183 u32 swtail; 184 u32 swhead; 185 u32 hwtail; /* write here to inform hw */ 186 void **ctx; /* void *ctx[size] - software context */ 187 }; 188 189 enum { /* for wil6210_priv.status */ 190 wil_status_fwready = 0, 191 wil_status_fwconnected, 192 wil_status_dontscan, 193 wil_status_irqen, /* FIXME: interrupts enabled - for debug */ 194 }; 195 196 struct pci_dev; 197 198 struct wil6210_stats { 199 u64 tsf; 200 u32 snr; 201 u16 last_mcs_rx; 202 u16 bf_mcs; /* last BF, used for Tx */ 203 u16 my_rx_sector; 204 u16 my_tx_sector; 205 u16 peer_rx_sector; 206 u16 peer_tx_sector; 207 }; 208 209 struct wil6210_priv { 210 struct pci_dev *pdev; 211 int n_msi; 212 struct wireless_dev *wdev; 213 void __iomem *csr; 214 ulong status; 215 /* profile */ 216 u32 monitor_flags; 217 u32 secure_pcp; /* create secure PCP? */ 218 int sinfo_gen; 219 /* cached ISR registers */ 220 u32 isr_misc; 221 /* mailbox related */ 222 struct mutex wmi_mutex; 223 struct wil6210_mbox_ctl mbox_ctl; 224 struct completion wmi_ready; 225 u16 wmi_seq; 226 u16 reply_id; /**< wait for this WMI event */ 227 void *reply_buf; 228 u16 reply_size; 229 struct workqueue_struct *wmi_wq; /* for deferred calls */ 230 struct work_struct wmi_event_worker; 231 struct workqueue_struct *wmi_wq_conn; /* for connect worker */ 232 struct work_struct wmi_connect_worker; 233 struct work_struct disconnect_worker; 234 struct timer_list connect_timer; 235 int pending_connect_cid; 236 struct list_head pending_wmi_ev; 237 /* 238 * protect pending_wmi_ev 239 * - fill in IRQ from wil6210_irq_misc, 240 * - consumed in thread by wmi_event_worker 241 */ 242 spinlock_t wmi_ev_lock; 243 /* DMA related */ 244 struct vring vring_rx; 245 struct vring vring_tx[WIL6210_MAX_TX_RINGS]; 246 u8 dst_addr[WIL6210_MAX_TX_RINGS][ETH_ALEN]; 247 /* scan */ 248 struct cfg80211_scan_request *scan_request; 249 250 struct mutex mutex; /* for wil6210_priv access in wil_{up|down} */ 251 /* statistics */ 252 struct wil6210_stats stats; 253 /* debugfs */ 254 struct dentry *debug; 255 struct debugfs_blob_wrapper fw_code_blob; 256 struct debugfs_blob_wrapper fw_data_blob; 257 struct debugfs_blob_wrapper fw_peri_blob; 258 struct debugfs_blob_wrapper uc_code_blob; 259 struct debugfs_blob_wrapper uc_data_blob; 260 struct debugfs_blob_wrapper rgf_blob; 261 }; 262 263 #define wil_to_wiphy(i) (i->wdev->wiphy) 264 #define wil_to_dev(i) (wiphy_dev(wil_to_wiphy(i))) 265 #define wiphy_to_wil(w) (struct wil6210_priv *)(wiphy_priv(w)) 266 #define wil_to_wdev(i) (i->wdev) 267 #define wdev_to_wil(w) (struct wil6210_priv *)(wdev_priv(w)) 268 #define wil_to_ndev(i) (wil_to_wdev(i)->netdev) 269 #define ndev_to_wil(n) (wdev_to_wil(n->ieee80211_ptr)) 270 271 #define wil_dbg(wil, fmt, arg...) netdev_dbg(wil_to_ndev(wil), fmt, ##arg) 272 #define wil_info(wil, fmt, arg...) netdev_info(wil_to_ndev(wil), fmt, ##arg) 273 #define wil_err(wil, fmt, arg...) netdev_err(wil_to_ndev(wil), fmt, ##arg) 274 275 #define wil_dbg_IRQ(wil, fmt, arg...) wil_dbg(wil, "DBG[ IRQ]" fmt, ##arg) 276 #define wil_dbg_TXRX(wil, fmt, arg...) wil_dbg(wil, "DBG[TXRX]" fmt, ##arg) 277 #define wil_dbg_WMI(wil, fmt, arg...) wil_dbg(wil, "DBG[ WMI]" fmt, ##arg) 278 279 #define wil_hex_dump_TXRX(prefix_str, prefix_type, rowsize, \ 280 groupsize, buf, len, ascii) \ 281 wil_print_hex_dump_debug("DBG[TXRX]" prefix_str,\ 282 prefix_type, rowsize, \ 283 groupsize, buf, len, ascii) 284 285 #define wil_hex_dump_WMI(prefix_str, prefix_type, rowsize, \ 286 groupsize, buf, len, ascii) \ 287 wil_print_hex_dump_debug("DBG[ WMI]" prefix_str,\ 288 prefix_type, rowsize, \ 289 groupsize, buf, len, ascii) 290 291 void wil_memcpy_fromio_32(void *dst, const volatile void __iomem *src, 292 size_t count); 293 void wil_memcpy_toio_32(volatile void __iomem *dst, const void *src, 294 size_t count); 295 296 void *wil_if_alloc(struct device *dev, void __iomem *csr); 297 void wil_if_free(struct wil6210_priv *wil); 298 int wil_if_add(struct wil6210_priv *wil); 299 void wil_if_remove(struct wil6210_priv *wil); 300 int wil_priv_init(struct wil6210_priv *wil); 301 void wil_priv_deinit(struct wil6210_priv *wil); 302 int wil_reset(struct wil6210_priv *wil); 303 void wil_link_on(struct wil6210_priv *wil); 304 void wil_link_off(struct wil6210_priv *wil); 305 int wil_up(struct wil6210_priv *wil); 306 int wil_down(struct wil6210_priv *wil); 307 void wil_mbox_ring_le2cpus(struct wil6210_mbox_ring *r); 308 309 void __iomem *wmi_buffer(struct wil6210_priv *wil, __le32 ptr); 310 void __iomem *wmi_addr(struct wil6210_priv *wil, u32 ptr); 311 int wmi_read_hdr(struct wil6210_priv *wil, __le32 ptr, 312 struct wil6210_mbox_hdr *hdr); 313 int wmi_send(struct wil6210_priv *wil, u16 cmdid, void *buf, u16 len); 314 void wmi_recv_cmd(struct wil6210_priv *wil); 315 int wmi_call(struct wil6210_priv *wil, u16 cmdid, void *buf, u16 len, 316 u16 reply_id, void *reply, u8 reply_size, int to_msec); 317 void wmi_connect_worker(struct work_struct *work); 318 void wmi_event_worker(struct work_struct *work); 319 void wmi_event_flush(struct wil6210_priv *wil); 320 int wmi_set_ssid(struct wil6210_priv *wil, u8 ssid_len, const void *ssid); 321 int wmi_get_ssid(struct wil6210_priv *wil, u8 *ssid_len, void *ssid); 322 int wmi_set_channel(struct wil6210_priv *wil, int channel); 323 int wmi_get_channel(struct wil6210_priv *wil, int *channel); 324 int wmi_tx_eapol(struct wil6210_priv *wil, struct sk_buff *skb); 325 int wmi_del_cipher_key(struct wil6210_priv *wil, u8 key_index, 326 const void *mac_addr); 327 int wmi_add_cipher_key(struct wil6210_priv *wil, u8 key_index, 328 const void *mac_addr, int key_len, const void *key); 329 int wmi_echo(struct wil6210_priv *wil); 330 int wmi_set_ie(struct wil6210_priv *wil, u8 type, u16 ie_len, const void *ie); 331 332 int wil6210_init_irq(struct wil6210_priv *wil, int irq); 333 void wil6210_fini_irq(struct wil6210_priv *wil, int irq); 334 void wil6210_disable_irq(struct wil6210_priv *wil); 335 void wil6210_enable_irq(struct wil6210_priv *wil); 336 337 int wil6210_debugfs_init(struct wil6210_priv *wil); 338 void wil6210_debugfs_remove(struct wil6210_priv *wil); 339 340 struct wireless_dev *wil_cfg80211_init(struct device *dev); 341 void wil_wdev_free(struct wil6210_priv *wil); 342 343 int wmi_set_mac_address(struct wil6210_priv *wil, void *addr); 344 int wmi_set_bcon(struct wil6210_priv *wil, int bi, u8 wmi_nettype); 345 void wil6210_disconnect(struct wil6210_priv *wil, void *bssid); 346 347 int wil_rx_init(struct wil6210_priv *wil); 348 void wil_rx_fini(struct wil6210_priv *wil); 349 350 /* TX API */ 351 int wil_vring_init_tx(struct wil6210_priv *wil, int id, int size, 352 int cid, int tid); 353 void wil_vring_fini_tx(struct wil6210_priv *wil, int id); 354 355 netdev_tx_t wil_start_xmit(struct sk_buff *skb, struct net_device *ndev); 356 void wil_tx_complete(struct wil6210_priv *wil, int ringid); 357 358 /* RX API */ 359 void wil_rx_handle(struct wil6210_priv *wil); 360 361 int wil_iftype_nl2wmi(enum nl80211_iftype type); 362 363 #endif /* __WIL6210_H__ */ 364