Pileus Git - ~andy/linux/blob - drivers/net/wireless/ti/wlcore/wlcore.h

   1 /*
   2  * This file is part of wlcore
   3  *
   4  * Copyright (C) 2011 Texas Instruments Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * version 2 as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  18  * 02110-1301 USA
  19  *
  20  */
  21
  22 #ifndef __WLCORE_H__
  23 #define __WLCORE_H__
  24
  25 #include <linux/platform_device.h>
  26
  27 #include "wlcore_i.h"
  28 #include "event.h"
  29 #include "boot.h"
  30
  31 /* The maximum number of Tx descriptors in all chip families */
  32 #define WLCORE_MAX_TX_DESCRIPTORS 32
  33
  34 /* forward declaration */
  35 struct wl1271_tx_hw_descr;
  36 enum wl_rx_buf_align;
  37 struct wl1271_rx_descriptor;
  38
  39 struct wlcore_ops {
  40         int (*identify_chip)(struct wl1271 *wl);
  41         int (*identify_fw)(struct wl1271 *wl);
  42         int (*boot)(struct wl1271 *wl);
  43         int (*plt_init)(struct wl1271 *wl);
  44         int (*trigger_cmd)(struct wl1271 *wl, int cmd_box_addr,
  45                            void *buf, size_t len);
  46         int (*ack_event)(struct wl1271 *wl);
  47         u32 (*calc_tx_blocks)(struct wl1271 *wl, u32 len, u32 spare_blks);
  48         void (*set_tx_desc_blocks)(struct wl1271 *wl,
  49                                    struct wl1271_tx_hw_descr *desc,
  50                                    u32 blks, u32 spare_blks);
  51         void (*set_tx_desc_data_len)(struct wl1271 *wl,
  52                                      struct wl1271_tx_hw_descr *desc,
  53                                      struct sk_buff *skb);
  54         enum wl_rx_buf_align (*get_rx_buf_align)(struct wl1271 *wl,
  55                                                  u32 rx_desc);
  56         int (*prepare_read)(struct wl1271 *wl, u32 rx_desc, u32 len);
  57         u32 (*get_rx_packet_len)(struct wl1271 *wl, void *rx_data,
  58                                  u32 data_len);
  59         int (*tx_delayed_compl)(struct wl1271 *wl);
  60         void (*tx_immediate_compl)(struct wl1271 *wl);
  61         int (*hw_init)(struct wl1271 *wl);
  62         int (*init_vif)(struct wl1271 *wl, struct wl12xx_vif *wlvif);
  63         u32 (*sta_get_ap_rate_mask)(struct wl1271 *wl,
  64                                     struct wl12xx_vif *wlvif);
  65         int (*get_pg_ver)(struct wl1271 *wl, s8 *ver);
  66         int (*get_mac)(struct wl1271 *wl);
  67         void (*set_tx_desc_csum)(struct wl1271 *wl,
  68                                  struct wl1271_tx_hw_descr *desc,
  69                                  struct sk_buff *skb);
  70         void (*set_rx_csum)(struct wl1271 *wl,
  71                             struct wl1271_rx_descriptor *desc,
  72                             struct sk_buff *skb);
  73         u32 (*ap_get_mimo_wide_rate_mask)(struct wl1271 *wl,
  74                                           struct wl12xx_vif *wlvif);
  75         int (*debugfs_init)(struct wl1271 *wl, struct dentry *rootdir);
  76         int (*handle_static_data)(struct wl1271 *wl,
  77                                   struct wl1271_static_data *static_data);
  78         int (*get_spare_blocks)(struct wl1271 *wl, bool is_gem);
  79         int (*set_key)(struct wl1271 *wl, enum set_key_cmd cmd,
  80                        struct ieee80211_vif *vif,
  81                        struct ieee80211_sta *sta,
  82                        struct ieee80211_key_conf *key_conf);
  83         u32 (*pre_pkt_send)(struct wl1271 *wl, u32 buf_offset, u32 last_len);
  84 };
  85
  86 enum wlcore_partitions {
  87         PART_DOWN,
  88         PART_WORK,
  89         PART_BOOT,
  90         PART_DRPW,
  91         PART_TOP_PRCM_ELP_SOC,
  92         PART_PHY_INIT,
  93
  94         PART_TABLE_LEN,
  95 };
  96
  97 struct wlcore_partition {
  98         u32 size;
  99         u32 start;
 100 };
 101
 102 struct wlcore_partition_set {
 103         struct wlcore_partition mem;
 104         struct wlcore_partition reg;
 105         struct wlcore_partition mem2;
 106         struct wlcore_partition mem3;
 107 };
 108
 109 enum wlcore_registers {
 110         /* register addresses, used with partition translation */
 111         REG_ECPU_CONTROL,
 112         REG_INTERRUPT_NO_CLEAR,
 113         REG_INTERRUPT_ACK,
 114         REG_COMMAND_MAILBOX_PTR,
 115         REG_EVENT_MAILBOX_PTR,
 116         REG_INTERRUPT_TRIG,
 117         REG_INTERRUPT_MASK,
 118         REG_PC_ON_RECOVERY,
 119         REG_CHIP_ID_B,
 120         REG_CMD_MBOX_ADDRESS,
 121
 122         /* data access memory addresses, used with partition translation */
 123         REG_SLV_MEM_DATA,
 124         REG_SLV_REG_DATA,
 125
 126         /* raw data access memory addresses */
 127         REG_RAW_FW_STATUS_ADDR,
 128
 129         REG_TABLE_LEN,
 130 };
 131
 132 struct wl1271_stats {
 133         void *fw_stats;
 134         unsigned long fw_stats_update;
 135         size_t fw_stats_len;
 136
 137         unsigned int retry_count;
 138         unsigned int excessive_retries;
 139 };
 140
 141 struct wl1271 {
 142         struct ieee80211_hw *hw;
 143         bool mac80211_registered;
 144
 145         struct device *dev;
 146
 147         void *if_priv;
 148
 149         struct wl1271_if_operations *if_ops;
 150
 151         void (*set_power)(bool enable);
 152         int irq;
 153
 154         spinlock_t wl_lock;
 155
 156         enum wl1271_state state;
 157         enum wl12xx_fw_type fw_type;
 158         bool plt;
 159         enum plt_mode plt_mode;
 160         u8 fem_manuf;
 161         u8 last_vif_count;
 162         struct mutex mutex;
 163
 164         unsigned long flags;
 165
 166         struct wlcore_partition_set curr_part;
 167
 168         struct wl1271_chip chip;
 169
 170         int cmd_box_addr;
 171
 172         u8 *fw;
 173         size_t fw_len;
 174         void *nvs;
 175         size_t nvs_len;
 176
 177         s8 hw_pg_ver;
 178
 179         /* address read from the fuse ROM */
 180         u32 fuse_oui_addr;
 181         u32 fuse_nic_addr;
 182
 183         /* we have up to 2 MAC addresses */
 184         struct mac_address addresses[2];
 185         int channel;
 186         u8 system_hlid;
 187
 188         unsigned long links_map[BITS_TO_LONGS(WL12XX_MAX_LINKS)];
 189         unsigned long roles_map[BITS_TO_LONGS(WL12XX_MAX_ROLES)];
 190         unsigned long roc_map[BITS_TO_LONGS(WL12XX_MAX_ROLES)];
 191         unsigned long rate_policies_map[
 192                         BITS_TO_LONGS(WL12XX_MAX_RATE_POLICIES)];
 193
 194         struct list_head wlvif_list;
 195
 196         u8 sta_count;
 197         u8 ap_count;
 198
 199         struct wl1271_acx_mem_map *target_mem_map;
 200
 201         /* Accounting for allocated / available TX blocks on HW */
 202         u32 tx_blocks_freed;
 203         u32 tx_blocks_available;
 204         u32 tx_allocated_blocks;
 205         u32 tx_results_count;
 206
 207         /* Accounting for allocated / available Tx packets in HW */
 208         u32 tx_pkts_freed[NUM_TX_QUEUES];
 209         u32 tx_allocated_pkts[NUM_TX_QUEUES];
 210
 211         /* Transmitted TX packets counter for chipset interface */
 212         u32 tx_packets_count;
 213
 214         /* Time-offset between host and chipset clocks */
 215         s64 time_offset;
 216
 217         /* Frames scheduled for transmission, not handled yet */
 218         int tx_queue_count[NUM_TX_QUEUES];
 219         unsigned long queue_stop_reasons[NUM_TX_QUEUES];
 220
 221         /* Frames received, not handled yet by mac80211 */
 222         struct sk_buff_head deferred_rx_queue;
 223
 224         /* Frames sent, not returned yet to mac80211 */
 225         struct sk_buff_head deferred_tx_queue;
 226
 227         struct work_struct tx_work;
 228         struct workqueue_struct *freezable_wq;
 229
 230         /* Pending TX frames */
 231         unsigned long tx_frames_map[BITS_TO_LONGS(WLCORE_MAX_TX_DESCRIPTORS)];
 232         struct sk_buff *tx_frames[WLCORE_MAX_TX_DESCRIPTORS];
 233         int tx_frames_cnt;
 234
 235         /* FW Rx counter */
 236         u32 rx_counter;
 237
 238         /* Intermediate buffer, used for packet aggregation */
 239         u8 *aggr_buf;
 240
 241         /* Reusable dummy packet template */
 242         struct sk_buff *dummy_packet;
 243
 244         /* Network stack work  */
 245         struct work_struct netstack_work;
 246
 247         /* FW log buffer */
 248         u8 *fwlog;
 249
 250         /* Number of valid bytes in the FW log buffer */
 251         ssize_t fwlog_size;
 252
 253         /* Sysfs FW log entry readers wait queue */
 254         wait_queue_head_t fwlog_waitq;
 255
 256         /* Hardware recovery work */
 257         struct work_struct recovery_work;
 258         bool watchdog_recovery;
 259
 260         /* Pointer that holds DMA-friendly block for the mailbox */
 261         struct event_mailbox *mbox;
 262
 263         /* The mbox event mask */
 264         u32 event_mask;
 265
 266         /* Mailbox pointers */
 267         u32 mbox_ptr[2];
 268
 269         /* Are we currently scanning */
 270         struct ieee80211_vif *scan_vif;
 271         struct wl1271_scan scan;
 272         struct delayed_work scan_complete_work;
 273
 274         /* Connection loss work */
 275         struct delayed_work connection_loss_work;
 276
 277         bool sched_scanning;
 278
 279         /* The current band */
 280         enum ieee80211_band band;
 281
 282         struct completion *elp_compl;
 283         struct delayed_work elp_work;
 284
 285         /* in dBm */
 286         int power_level;
 287
 288         struct wl1271_stats stats;
 289
 290         __le32 buffer_32;
 291         u32 buffer_cmd;
 292         u32 buffer_busyword[WL1271_BUSY_WORD_CNT];
 293
 294         struct wl_fw_status_1 *fw_status_1;
 295         struct wl_fw_status_2 *fw_status_2;
 296         struct wl1271_tx_hw_res_if *tx_res_if;
 297
 298         /* Current chipset configuration */
 299         struct wlcore_conf conf;
 300
 301         bool sg_enabled;
 302
 303         bool enable_11a;
 304
 305         /* Most recently reported noise in dBm */
 306         s8 noise;
 307
 308         /* bands supported by this instance of wl12xx */
 309         struct ieee80211_supported_band bands[WLCORE_NUM_BANDS];
 310
 311         /*
 312          * wowlan trigger was configured during suspend.
 313          * (currently, only "ANY" trigger is supported)
 314          */
 315         bool wow_enabled;
 316         bool irq_wake_enabled;
 317
 318         /*
 319          * AP-mode - links indexed by HLID. The global and broadcast links
 320          * are always active.
 321          */
 322         struct wl1271_link links[WL12XX_MAX_LINKS];
 323
 324         /* AP-mode - a bitmap of links currently in PS mode according to FW */
 325         u32 ap_fw_ps_map;
 326
 327         /* AP-mode - a bitmap of links currently in PS mode in mac80211 */
 328         unsigned long ap_ps_map;
 329
 330         /* Quirks of specific hardware revisions */
 331         unsigned int quirks;
 332
 333         /* Platform limitations */
 334         unsigned int platform_quirks;
 335
 336         /* number of currently active RX BA sessions */
 337         int ba_rx_session_count;
 338
 339         /* AP-mode - number of currently connected stations */
 340         int active_sta_count;
 341
 342         /* last wlvif we transmitted from */
 343         struct wl12xx_vif *last_wlvif;
 344
 345         /* work to fire when Tx is stuck */
 346         struct delayed_work tx_watchdog_work;
 347
 348         struct wlcore_ops *ops;
 349         /* pointer to the lower driver partition table */
 350         const struct wlcore_partition_set *ptable;
 351         /* pointer to the lower driver register table */
 352         const int *rtable;
 353         /* name of the firmwares to load - for PLT, single role, multi-role */
 354         const char *plt_fw_name;
 355         const char *sr_fw_name;
 356         const char *mr_fw_name;
 357
 358         /* per-chip-family private structure */
 359         void *priv;
 360
 361         /* number of TX descriptors the HW supports. */
 362         u32 num_tx_desc;
 363         /* number of RX descriptors the HW supports. */
 364         u32 num_rx_desc;
 365
 366         /* translate HW Tx rates to standard rate-indices */
 367         const u8 **band_rate_to_idx;
 368
 369         /* size of table for HW rates that can be received from chip */
 370         u8 hw_tx_rate_tbl_size;
 371
 372         /* this HW rate and below are considered HT rates for this chip */
 373         u8 hw_min_ht_rate;
 374
 375         /* HW HT (11n) capabilities */
 376         struct ieee80211_sta_ht_cap ht_cap[WLCORE_NUM_BANDS];
 377
 378         /* size of the private FW status data */
 379         size_t fw_status_priv_len;
 380
 381         /* RX Data filter rule state - enabled/disabled */
 382         bool rx_filter_enabled[WL1271_MAX_RX_FILTERS];
 383
 384         /* size of the private static data */
 385         size_t static_data_priv_len;
 386
 387         /* the current channel type */
 388         enum nl80211_channel_type channel_type;
 389
 390         /* mutex for protecting the tx_flush function */
 391         struct mutex flush_mutex;
 392
 393         /* sleep auth value currently configured to FW */
 394         int sleep_auth;
 395
 396         /* the minimum FW version required for the driver to work */
 397         unsigned int min_fw_ver[NUM_FW_VER];
 398 };
 399
 400 int __devinit wlcore_probe(struct wl1271 *wl, struct platform_device *pdev);
 401 int __devexit wlcore_remove(struct platform_device *pdev);
 402 struct ieee80211_hw *wlcore_alloc_hw(size_t priv_size);
 403 int wlcore_free_hw(struct wl1271 *wl);
 404 int wlcore_set_key(struct wl1271 *wl, enum set_key_cmd cmd,
 405                    struct ieee80211_vif *vif,
 406                    struct ieee80211_sta *sta,
 407                    struct ieee80211_key_conf *key_conf);
 408
 409 static inline void
 410 wlcore_set_ht_cap(struct wl1271 *wl, enum ieee80211_band band,
 411                   struct ieee80211_sta_ht_cap *ht_cap)
 412 {
 413         memcpy(&wl->ht_cap[band], ht_cap, sizeof(*ht_cap));
 414 }
 415
 416 static inline void
 417 wlcore_set_min_fw_ver(struct wl1271 *wl, unsigned int chip,
 418                       unsigned int iftype, unsigned int major,
 419                       unsigned int subtype, unsigned int minor)
 420 {
 421         wl->min_fw_ver[FW_VER_CHIP] = chip;
 422         wl->min_fw_ver[FW_VER_IF_TYPE] = iftype;
 423         wl->min_fw_ver[FW_VER_MAJOR] = major;
 424         wl->min_fw_ver[FW_VER_SUBTYPE] = subtype;
 425         wl->min_fw_ver[FW_VER_MINOR] = minor;
 426 }
 427
 428 /* Firmware image load chunk size */
 429 #define CHUNK_SIZE      16384
 430
 431 /* Quirks */
 432
 433 /* Each RX/TX transaction requires an end-of-transaction transfer */
 434 #define WLCORE_QUIRK_END_OF_TRANSACTION         BIT(0)
 435
 436 /* wl127x and SPI don't support SDIO block size alignment */
 437 #define WLCORE_QUIRK_TX_BLOCKSIZE_ALIGN         BIT(2)
 438
 439 /* means aggregated Rx packets are aligned to a SDIO block */
 440 #define WLCORE_QUIRK_RX_BLOCKSIZE_ALIGN         BIT(3)
 441
 442 /* Older firmwares did not implement the FW logger over bus feature */
 443 #define WLCORE_QUIRK_FWLOG_NOT_IMPLEMENTED      BIT(4)
 444
 445 /* Older firmwares use an old NVS format */
 446 #define WLCORE_QUIRK_LEGACY_NVS                 BIT(5)
 447
 448 /* Some firmwares may not support ELP */
 449 #define WLCORE_QUIRK_NO_ELP                     BIT(6)
 450
 451 /* pad only the last frame in the aggregate buffer */
 452 #define WLCORE_QUIRK_TX_PAD_LAST_FRAME          BIT(7)
 453
 454 /* extra header space is required for TKIP */
 455 #define WLCORE_QUIRK_TKIP_HEADER_SPACE          BIT(8)
 456
 457 /* Some firmwares not support sched scans while connected */
 458 #define WLCORE_QUIRK_NO_SCHED_SCAN_WHILE_CONN   BIT(9)
 459
 460 /* separate probe response templates for one-shot and sched scans */
 461 #define WLCORE_QUIRK_DUAL_PROBE_TMPL            BIT(10)
 462
 463 /* TODO: move to the lower drivers when all usages are abstracted */
 464 #define CHIP_ID_1271_PG10              (0x4030101)
 465 #define CHIP_ID_1271_PG20              (0x4030111)
 466 #define CHIP_ID_1283_PG10              (0x05030101)
 467 #define CHIP_ID_1283_PG20              (0x05030111)
 468
 469 /* TODO: move all these common registers and values elsewhere */
 470 #define HW_ACCESS_ELP_CTRL_REG          0x1FFFC
 471
 472 /* ELP register commands */
 473 #define ELPCTRL_WAKE_UP             0x1
 474 #define ELPCTRL_WAKE_UP_WLAN_READY  0x5
 475 #define ELPCTRL_SLEEP               0x0
 476 /* ELP WLAN_READY bit */
 477 #define ELPCTRL_WLAN_READY          0x2
 478
 479 /*************************************************************************
 480
 481     Interrupt Trigger Register (Host -> WiLink)
 482
 483 **************************************************************************/
 484
 485 /* Hardware to Embedded CPU Interrupts - first 32-bit register set */
 486
 487 /*
 488  * The host sets this bit to inform the Wlan
 489  * FW that a TX packet is in the XFER
 490  * Buffer #0.
 491  */
 492 #define INTR_TRIG_TX_PROC0 BIT(2)
 493
 494 /*
 495  * The host sets this bit to inform the FW
 496  * that it read a packet from RX XFER
 497  * Buffer #0.
 498  */
 499 #define INTR_TRIG_RX_PROC0 BIT(3)
 500
 501 #define INTR_TRIG_DEBUG_ACK BIT(4)
 502
 503 #define INTR_TRIG_STATE_CHANGED BIT(5)
 504
 505 /* Hardware to Embedded CPU Interrupts - second 32-bit register set */
 506
 507 /*
 508  * The host sets this bit to inform the FW
 509  * that it read a packet from RX XFER
 510  * Buffer #1.
 511  */
 512 #define INTR_TRIG_RX_PROC1 BIT(17)
 513
 514 /*
 515  * The host sets this bit to inform the Wlan
 516  * hardware that a TX packet is in the XFER
 517  * Buffer #1.
 518  */
 519 #define INTR_TRIG_TX_PROC1 BIT(18)
 520
 521 #define ACX_SLV_SOFT_RESET_BIT  BIT(1)
 522 #define SOFT_RESET_MAX_TIME     1000000
 523 #define SOFT_RESET_STALL_TIME   1000
 524
 525 #define ECPU_CONTROL_HALT       0x00000101
 526
 527 #define WELP_ARM_COMMAND_VAL    0x4
 528
 529 #endif /* __WLCORE_H__ */