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_USER_USER_SCRATCH_PAD       (0x8802bc)
  78 #define RGF_USER_USER_ICR               (0x880b4c) /* struct RGF_ICR */
  79         #define BIT_USER_USER_ICR_SW_INT_2      BIT(18)
  80 #define RGF_USER_CLKS_CTL_SW_RST_MASK_0 (0x880b14)
  81 #define RGF_USER_MAC_CPU_0              (0x8801fc)
  82 #define RGF_USER_USER_CPU_0             (0x8801e0)
  83 #define RGF_USER_CLKS_CTL_SW_RST_VEC_0  (0x880b04)
  84 #define RGF_USER_CLKS_CTL_SW_RST_VEC_1  (0x880b08)
  85 #define RGF_USER_CLKS_CTL_SW_RST_VEC_2  (0x880b0c)
  86 #define RGF_USER_CLKS_CTL_SW_RST_VEC_3  (0x880b10)
  87
  88 #define RGF_DMA_PSEUDO_CAUSE            (0x881c68)
  89 #define RGF_DMA_PSEUDO_CAUSE_MASK_SW    (0x881c6c)
  90 #define RGF_DMA_PSEUDO_CAUSE_MASK_FW    (0x881c70)
  91         #define BIT_DMA_PSEUDO_CAUSE_RX         BIT(0)
  92         #define BIT_DMA_PSEUDO_CAUSE_TX         BIT(1)
  93         #define BIT_DMA_PSEUDO_CAUSE_MISC       BIT(2)
  94
  95 #define RGF_DMA_EP_TX_ICR               (0x881bb4) /* struct RGF_ICR */
  96         #define BIT_DMA_EP_TX_ICR_TX_DONE       BIT(0)
  97         #define BIT_DMA_EP_TX_ICR_TX_DONE_N(n)  BIT(n+1) /* n = [0..23] */
  98 #define RGF_DMA_EP_RX_ICR               (0x881bd0) /* struct RGF_ICR */
  99         #define BIT_DMA_EP_RX_ICR_RX_DONE       BIT(0)
 100 #define RGF_DMA_EP_MISC_ICR             (0x881bec) /* struct RGF_ICR */
 101         #define BIT_DMA_EP_MISC_ICR_RX_HTRSH    BIT(0)
 102         #define BIT_DMA_EP_MISC_ICR_TX_NO_ACT   BIT(1)
 103         #define BIT_DMA_EP_MISC_ICR_FW_INT(n)   BIT(28+n) /* n = [0..3] */
 104
 105 /* Interrupt moderation control */
 106 #define RGF_DMA_ITR_CNT_TRSH            (0x881c5c)
 107 #define RGF_DMA_ITR_CNT_DATA            (0x881c60)
 108 #define RGF_DMA_ITR_CNT_CRL             (0x881C64)
 109         #define BIT_DMA_ITR_CNT_CRL_EN          BIT(0)
 110         #define BIT_DMA_ITR_CNT_CRL_EXT_TICK    BIT(1)
 111         #define BIT_DMA_ITR_CNT_CRL_FOREVER     BIT(2)
 112         #define BIT_DMA_ITR_CNT_CRL_CLR         BIT(3)
 113         #define BIT_DMA_ITR_CNT_CRL_REACH_TRSH  BIT(4)
 114
 115 /* popular locations */
 116 #define HOST_MBOX   HOSTADDR(RGF_USER_USER_SCRATCH_PAD)
 117 #define HOST_SW_INT (HOSTADDR(RGF_USER_USER_ICR) + \
 118         offsetof(struct RGF_ICR, ICS))
 119 #define SW_INT_MBOX BIT_USER_USER_ICR_SW_INT_2
 120
 121 /* ISR register bits */
 122 #define ISR_MISC_FW_READY       BIT_DMA_EP_MISC_ICR_FW_INT(0)
 123 #define ISR_MISC_MBOX_EVT       BIT_DMA_EP_MISC_ICR_FW_INT(1)
 124 #define ISR_MISC_FW_ERROR       BIT_DMA_EP_MISC_ICR_FW_INT(3)
 125
 126 /* Hardware definitions end */
 127
 128 struct wil6210_mbox_ring {
 129         u32 base;
 130         u16 entry_size; /* max. size of mbox entry, incl. all headers */
 131         u16 size;
 132         u32 tail;
 133         u32 head;
 134 } __packed;
 135
 136 struct wil6210_mbox_ring_desc {
 137         __le32 sync;
 138         __le32 addr;
 139 } __packed;
 140
 141 /* at HOST_OFF_WIL6210_MBOX_CTL */
 142 struct wil6210_mbox_ctl {
 143         struct wil6210_mbox_ring tx;
 144         struct wil6210_mbox_ring rx;
 145 } __packed;
 146
 147 struct wil6210_mbox_hdr {
 148         __le16 seq;
 149         __le16 len; /* payload, bytes after this header */
 150         __le16 type;
 151         u8 flags;
 152         u8 reserved;
 153 } __packed;
 154
 155 #define WIL_MBOX_HDR_TYPE_WMI (0)
 156
 157 /* max. value for wil6210_mbox_hdr.len */
 158 #define MAX_MBOXITEM_SIZE   (240)
 159
 160 /**
 161  * struct wil6210_mbox_hdr_wmi - WMI header
 162  *
 163  * @mid: MAC ID
 164  *      00 - default, created by FW
 165  *      01..0f - WiFi ports, driver to create
 166  *      10..fe - debug
 167  *      ff - broadcast
 168  * @id: command/event ID
 169  * @timestamp: FW fills for events, free-running msec timer
 170  */
 171 struct wil6210_mbox_hdr_wmi {
 172         u8 mid;
 173         u8 reserved;
 174         __le16 id;
 175         __le32 timestamp;
 176 } __packed;
 177
 178 struct pending_wmi_event {
 179         struct list_head list;
 180         struct {
 181                 struct wil6210_mbox_hdr hdr;
 182                 struct wil6210_mbox_hdr_wmi wmi;
 183                 u8 data[0];
 184         } __packed event;
 185 };
 186
 187 /**
 188  * struct wil_ctx - software context for Vring descriptor
 189  */
 190 struct wil_ctx {
 191         struct sk_buff *skb;
 192         u8 mapped_as_page:1;
 193 };
 194
 195 union vring_desc;
 196
 197 struct vring {
 198         dma_addr_t pa;
 199         volatile union vring_desc *va; /* vring_desc[size], WriteBack by DMA */
 200         u16 size; /* number of vring_desc elements */
 201         u32 swtail;
 202         u32 swhead;
 203         u32 hwtail; /* write here to inform hw */
 204         struct wil_ctx *ctx; /* ctx[size] - software context */
 205 };
 206
 207 enum { /* for wil6210_priv.status */
 208         wil_status_fwready = 0,
 209         wil_status_fwconnecting,
 210         wil_status_fwconnected,
 211         wil_status_dontscan,
 212         wil_status_reset_done,
 213         wil_status_irqen, /* FIXME: interrupts enabled - for debug */
 214 };
 215
 216 struct pci_dev;
 217
 218 /**
 219  * struct tid_ampdu_rx - TID aggregation information (Rx).
 220  *
 221  * @reorder_buf: buffer to reorder incoming aggregated MPDUs
 222  * @reorder_time: jiffies when skb was added
 223  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
 224  * @reorder_timer: releases expired frames from the reorder buffer.
 225  * @last_rx: jiffies of last rx activity
 226  * @head_seq_num: head sequence number in reordering buffer.
 227  * @stored_mpdu_num: number of MPDUs in reordering buffer
 228  * @ssn: Starting Sequence Number expected to be aggregated.
 229  * @buf_size: buffer size for incoming A-MPDUs
 230  * @timeout: reset timer value (in TUs).
 231  * @dialog_token: dialog token for aggregation session
 232  * @rcu_head: RCU head used for freeing this struct
 233  * @reorder_lock: serializes access to reorder buffer, see below.
 234  *
 235  * This structure's lifetime is managed by RCU, assignments to
 236  * the array holding it must hold the aggregation mutex.
 237  *
 238  * The @reorder_lock is used to protect the members of this
 239  * struct, except for @timeout, @buf_size and @dialog_token,
 240  * which are constant across the lifetime of the struct (the
 241  * dialog token being used only for debugging).
 242  */
 243 struct wil_tid_ampdu_rx {
 244         spinlock_t reorder_lock; /* see above */
 245         struct sk_buff **reorder_buf;
 246         unsigned long *reorder_time;
 247         struct timer_list session_timer;
 248         struct timer_list reorder_timer;
 249         unsigned long last_rx;
 250         u16 head_seq_num;
 251         u16 stored_mpdu_num;
 252         u16 ssn;
 253         u16 buf_size;
 254         u16 timeout;
 255         u8 dialog_token;
 256 };
 257
 258 struct wil6210_stats {
 259         u64 tsf;
 260         u32 snr;
 261         u16 last_mcs_rx;
 262         u16 bf_mcs; /* last BF, used for Tx */
 263         u16 my_rx_sector;
 264         u16 my_tx_sector;
 265         u16 peer_rx_sector;
 266         u16 peer_tx_sector;
 267 };
 268
 269 enum wil_sta_status {
 270         wil_sta_unused = 0,
 271         wil_sta_conn_pending = 1,
 272         wil_sta_connected = 2,
 273 };
 274
 275 #define WIL_STA_TID_NUM (16)
 276
 277 /**
 278  * struct wil_sta_info - data for peer
 279  *
 280  * Peer identified by its CID (connection ID)
 281  * NIC performs beam forming for each peer;
 282  * if no beam forming done, frame exchange is not
 283  * possible.
 284  */
 285 struct wil_sta_info {
 286         u8 addr[ETH_ALEN];
 287         enum wil_sta_status status;
 288         /* Rx BACK */
 289         struct wil_tid_ampdu_rx *tid_rx[WIL_STA_TID_NUM];
 290         unsigned long tid_rx_timer_expired[BITS_TO_LONGS(WIL_STA_TID_NUM)];
 291         unsigned long tid_rx_stop_requested[BITS_TO_LONGS(WIL_STA_TID_NUM)];
 292 };
 293
 294 struct wil6210_priv {
 295         struct pci_dev *pdev;
 296         int n_msi;
 297         struct wireless_dev *wdev;
 298         void __iomem *csr;
 299         ulong status;
 300         u32 fw_version;
 301         u8 n_mids; /* number of additional MIDs as reported by FW */
 302         /* profile */
 303         u32 monitor_flags;
 304         u32 secure_pcp; /* create secure PCP? */
 305         int sinfo_gen;
 306         /* cached ISR registers */
 307         u32 isr_misc;
 308         /* mailbox related */
 309         struct mutex wmi_mutex;
 310         struct wil6210_mbox_ctl mbox_ctl;
 311         struct completion wmi_ready;
 312         u16 wmi_seq;
 313         u16 reply_id; /**< wait for this WMI event */
 314         void *reply_buf;
 315         u16 reply_size;
 316         struct workqueue_struct *wmi_wq; /* for deferred calls */
 317         struct work_struct wmi_event_worker;
 318         struct workqueue_struct *wmi_wq_conn; /* for connect worker */
 319         struct work_struct connect_worker;
 320         struct work_struct disconnect_worker;
 321         struct timer_list connect_timer;
 322         int pending_connect_cid;
 323         struct list_head pending_wmi_ev;
 324         /*
 325          * protect pending_wmi_ev
 326          * - fill in IRQ from wil6210_irq_misc,
 327          * - consumed in thread by wmi_event_worker
 328          */
 329         spinlock_t wmi_ev_lock;
 330         struct napi_struct napi_rx;
 331         struct napi_struct napi_tx;
 332         /* DMA related */
 333         struct vring vring_rx;
 334         struct vring vring_tx[WIL6210_MAX_TX_RINGS];
 335         u8 vring2cid_tid[WIL6210_MAX_TX_RINGS][2]; /* [0] - CID, [1] - TID */
 336         struct wil_sta_info sta[WIL6210_MAX_CID];
 337         /* scan */
 338         struct cfg80211_scan_request *scan_request;
 339
 340         struct mutex mutex; /* for wil6210_priv access in wil_{up|down} */
 341         /* statistics */
 342         struct wil6210_stats stats;
 343         /* debugfs */
 344         struct dentry *debug;
 345         struct debugfs_blob_wrapper fw_code_blob;
 346         struct debugfs_blob_wrapper fw_data_blob;
 347         struct debugfs_blob_wrapper fw_peri_blob;
 348         struct debugfs_blob_wrapper uc_code_blob;
 349         struct debugfs_blob_wrapper uc_data_blob;
 350         struct debugfs_blob_wrapper rgf_blob;
 351 };
 352
 353 #define wil_to_wiphy(i) (i->wdev->wiphy)
 354 #define wil_to_dev(i) (wiphy_dev(wil_to_wiphy(i)))
 355 #define wiphy_to_wil(w) (struct wil6210_priv *)(wiphy_priv(w))
 356 #define wil_to_wdev(i) (i->wdev)
 357 #define wdev_to_wil(w) (struct wil6210_priv *)(wdev_priv(w))
 358 #define wil_to_ndev(i) (wil_to_wdev(i)->netdev)
 359 #define ndev_to_wil(n) (wdev_to_wil(n->ieee80211_ptr))
 360
 361 int wil_dbg_trace(struct wil6210_priv *wil, const char *fmt, ...);
 362 int wil_err(struct wil6210_priv *wil, const char *fmt, ...);
 363 int wil_info(struct wil6210_priv *wil, const char *fmt, ...);
 364 #define wil_dbg(wil, fmt, arg...) do { \
 365         netdev_dbg(wil_to_ndev(wil), fmt, ##arg); \
 366         wil_dbg_trace(wil, fmt, ##arg); \
 367 } while (0)
 368
 369 #define wil_dbg_irq(wil, fmt, arg...) wil_dbg(wil, "DBG[ IRQ]" fmt, ##arg)
 370 #define wil_dbg_txrx(wil, fmt, arg...) wil_dbg(wil, "DBG[TXRX]" fmt, ##arg)
 371 #define wil_dbg_wmi(wil, fmt, arg...) wil_dbg(wil, "DBG[ WMI]" fmt, ##arg)
 372 #define wil_dbg_misc(wil, fmt, arg...) wil_dbg(wil, "DBG[MISC]" fmt, ##arg)
 373
 374 #define wil_hex_dump_txrx(prefix_str, prefix_type, rowsize,     \
 375                           groupsize, buf, len, ascii)           \
 376                           print_hex_dump_debug("DBG[TXRX]" prefix_str,\
 377                                          prefix_type, rowsize,  \
 378                                          groupsize, buf, len, ascii)
 379
 380 #define wil_hex_dump_wmi(prefix_str, prefix_type, rowsize,      \
 381                          groupsize, buf, len, ascii)            \
 382                          print_hex_dump_debug("DBG[ WMI]" prefix_str,\
 383                                         prefix_type, rowsize,   \
 384                                         groupsize, buf, len, ascii)
 385
 386 void wil_memcpy_fromio_32(void *dst, const volatile void __iomem *src,
 387                           size_t count);
 388 void wil_memcpy_toio_32(volatile void __iomem *dst, const void *src,
 389                         size_t count);
 390
 391 void *wil_if_alloc(struct device *dev, void __iomem *csr);
 392 void wil_if_free(struct wil6210_priv *wil);
 393 int wil_if_add(struct wil6210_priv *wil);
 394 void wil_if_remove(struct wil6210_priv *wil);
 395 int wil_priv_init(struct wil6210_priv *wil);
 396 void wil_priv_deinit(struct wil6210_priv *wil);
 397 int wil_reset(struct wil6210_priv *wil);
 398 void wil_link_on(struct wil6210_priv *wil);
 399 void wil_link_off(struct wil6210_priv *wil);
 400 int wil_up(struct wil6210_priv *wil);
 401 int wil_down(struct wil6210_priv *wil);
 402 void wil_mbox_ring_le2cpus(struct wil6210_mbox_ring *r);
 403 int wil_find_cid(struct wil6210_priv *wil, const u8 *mac);
 404
 405 void __iomem *wmi_buffer(struct wil6210_priv *wil, __le32 ptr);
 406 void __iomem *wmi_addr(struct wil6210_priv *wil, u32 ptr);
 407 int wmi_read_hdr(struct wil6210_priv *wil, __le32 ptr,
 408                  struct wil6210_mbox_hdr *hdr);
 409 int wmi_send(struct wil6210_priv *wil, u16 cmdid, void *buf, u16 len);
 410 void wmi_recv_cmd(struct wil6210_priv *wil);
 411 int wmi_call(struct wil6210_priv *wil, u16 cmdid, void *buf, u16 len,
 412              u16 reply_id, void *reply, u8 reply_size, int to_msec);
 413 void wmi_event_worker(struct work_struct *work);
 414 void wmi_event_flush(struct wil6210_priv *wil);
 415 int wmi_set_ssid(struct wil6210_priv *wil, u8 ssid_len, const void *ssid);
 416 int wmi_get_ssid(struct wil6210_priv *wil, u8 *ssid_len, void *ssid);
 417 int wmi_set_channel(struct wil6210_priv *wil, int channel);
 418 int wmi_get_channel(struct wil6210_priv *wil, int *channel);
 419 int wmi_del_cipher_key(struct wil6210_priv *wil, u8 key_index,
 420                        const void *mac_addr);
 421 int wmi_add_cipher_key(struct wil6210_priv *wil, u8 key_index,
 422                        const void *mac_addr, int key_len, const void *key);
 423 int wmi_echo(struct wil6210_priv *wil);
 424 int wmi_set_ie(struct wil6210_priv *wil, u8 type, u16 ie_len, const void *ie);
 425 int wmi_rx_chain_add(struct wil6210_priv *wil, struct vring *vring);
 426 int wmi_p2p_cfg(struct wil6210_priv *wil, int channel);
 427 int wmi_rxon(struct wil6210_priv *wil, bool on);
 428 int wmi_get_temperature(struct wil6210_priv *wil, u32 *t_m, u32 *t_r);
 429
 430 int wil6210_init_irq(struct wil6210_priv *wil, int irq);
 431 void wil6210_fini_irq(struct wil6210_priv *wil, int irq);
 432 void wil6210_disable_irq(struct wil6210_priv *wil);
 433 void wil6210_enable_irq(struct wil6210_priv *wil);
 434
 435 int wil6210_debugfs_init(struct wil6210_priv *wil);
 436 void wil6210_debugfs_remove(struct wil6210_priv *wil);
 437
 438 struct wireless_dev *wil_cfg80211_init(struct device *dev);
 439 void wil_wdev_free(struct wil6210_priv *wil);
 440
 441 int wmi_set_mac_address(struct wil6210_priv *wil, void *addr);
 442 int wmi_pcp_start(struct wil6210_priv *wil, int bi, u8 wmi_nettype, u8 chan);
 443 int wmi_pcp_stop(struct wil6210_priv *wil);
 444 void wil6210_disconnect(struct wil6210_priv *wil, void *bssid);
 445
 446 int wil_rx_init(struct wil6210_priv *wil);
 447 void wil_rx_fini(struct wil6210_priv *wil);
 448
 449 /* TX API */
 450 int wil_vring_init_tx(struct wil6210_priv *wil, int id, int size,
 451                       int cid, int tid);
 452 void wil_vring_fini_tx(struct wil6210_priv *wil, int id);
 453
 454 netdev_tx_t wil_start_xmit(struct sk_buff *skb, struct net_device *ndev);
 455 int wil_tx_complete(struct wil6210_priv *wil, int ringid);
 456 void wil6210_unmask_irq_tx(struct wil6210_priv *wil);
 457
 458 /* RX API */
 459 void wil_rx_handle(struct wil6210_priv *wil, int *quota);
 460 void wil6210_unmask_irq_rx(struct wil6210_priv *wil);
 461
 462 int wil_iftype_nl2wmi(enum nl80211_iftype type);
 463
 464 #endif /* __WIL6210_H__ */