wlcore: Always pass DMA-able buffers to mmc functions
[sfrench/cifs-2.6.git] / 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 /*
35  * We always allocate this number of mac addresses. If we don't
36  * have enough allocated addresses, the LAA bit is used
37  */
38 #define WLCORE_NUM_MAC_ADDRESSES 3
39
40 /* wl12xx/wl18xx maximum transmission power (in dBm) */
41 #define WLCORE_MAX_TXPWR        25
42
43 /* forward declaration */
44 struct wl1271_tx_hw_descr;
45 enum wl_rx_buf_align;
46 struct wl1271_rx_descriptor;
47
48 struct wlcore_ops {
49         int (*setup)(struct wl1271 *wl);
50         int (*identify_chip)(struct wl1271 *wl);
51         int (*identify_fw)(struct wl1271 *wl);
52         int (*boot)(struct wl1271 *wl);
53         int (*plt_init)(struct wl1271 *wl);
54         int (*trigger_cmd)(struct wl1271 *wl, int cmd_box_addr,
55                            void *buf, size_t len);
56         int (*ack_event)(struct wl1271 *wl);
57         int (*wait_for_event)(struct wl1271 *wl, enum wlcore_wait_event event,
58                               bool *timeout);
59         int (*process_mailbox_events)(struct wl1271 *wl);
60         u32 (*calc_tx_blocks)(struct wl1271 *wl, u32 len, u32 spare_blks);
61         void (*set_tx_desc_blocks)(struct wl1271 *wl,
62                                    struct wl1271_tx_hw_descr *desc,
63                                    u32 blks, u32 spare_blks);
64         void (*set_tx_desc_data_len)(struct wl1271 *wl,
65                                      struct wl1271_tx_hw_descr *desc,
66                                      struct sk_buff *skb);
67         enum wl_rx_buf_align (*get_rx_buf_align)(struct wl1271 *wl,
68                                                  u32 rx_desc);
69         int (*prepare_read)(struct wl1271 *wl, u32 rx_desc, u32 len);
70         u32 (*get_rx_packet_len)(struct wl1271 *wl, void *rx_data,
71                                  u32 data_len);
72         int (*tx_delayed_compl)(struct wl1271 *wl);
73         void (*tx_immediate_compl)(struct wl1271 *wl);
74         int (*hw_init)(struct wl1271 *wl);
75         int (*init_vif)(struct wl1271 *wl, struct wl12xx_vif *wlvif);
76         u32 (*sta_get_ap_rate_mask)(struct wl1271 *wl,
77                                     struct wl12xx_vif *wlvif);
78         int (*get_pg_ver)(struct wl1271 *wl, s8 *ver);
79         int (*get_mac)(struct wl1271 *wl);
80         void (*set_tx_desc_csum)(struct wl1271 *wl,
81                                  struct wl1271_tx_hw_descr *desc,
82                                  struct sk_buff *skb);
83         void (*set_rx_csum)(struct wl1271 *wl,
84                             struct wl1271_rx_descriptor *desc,
85                             struct sk_buff *skb);
86         u32 (*ap_get_mimo_wide_rate_mask)(struct wl1271 *wl,
87                                           struct wl12xx_vif *wlvif);
88         int (*debugfs_init)(struct wl1271 *wl, struct dentry *rootdir);
89         int (*handle_static_data)(struct wl1271 *wl,
90                                   struct wl1271_static_data *static_data);
91         int (*scan_start)(struct wl1271 *wl, struct wl12xx_vif *wlvif,
92                           struct cfg80211_scan_request *req);
93         int (*scan_stop)(struct wl1271 *wl, struct wl12xx_vif *wlvif);
94         int (*sched_scan_start)(struct wl1271 *wl, struct wl12xx_vif *wlvif,
95                                 struct cfg80211_sched_scan_request *req,
96                                 struct ieee80211_sched_scan_ies *ies);
97         void (*sched_scan_stop)(struct wl1271 *wl, struct wl12xx_vif *wlvif);
98         int (*get_spare_blocks)(struct wl1271 *wl, bool is_gem);
99         int (*set_key)(struct wl1271 *wl, enum set_key_cmd cmd,
100                        struct ieee80211_vif *vif,
101                        struct ieee80211_sta *sta,
102                        struct ieee80211_key_conf *key_conf);
103         int (*channel_switch)(struct wl1271 *wl,
104                               struct wl12xx_vif *wlvif,
105                               struct ieee80211_channel_switch *ch_switch);
106         u32 (*pre_pkt_send)(struct wl1271 *wl, u32 buf_offset, u32 last_len);
107         void (*sta_rc_update)(struct wl1271 *wl, struct wl12xx_vif *wlvif,
108                               struct ieee80211_sta *sta, u32 changed);
109         int (*set_peer_cap)(struct wl1271 *wl,
110                             struct ieee80211_sta_ht_cap *ht_cap,
111                             bool allow_ht_operation,
112                             u32 rate_set, u8 hlid);
113         bool (*lnk_high_prio)(struct wl1271 *wl, u8 hlid,
114                               struct wl1271_link *lnk);
115         bool (*lnk_low_prio)(struct wl1271 *wl, u8 hlid,
116                              struct wl1271_link *lnk);
117 };
118
119 enum wlcore_partitions {
120         PART_DOWN,
121         PART_WORK,
122         PART_BOOT,
123         PART_DRPW,
124         PART_TOP_PRCM_ELP_SOC,
125         PART_PHY_INIT,
126
127         PART_TABLE_LEN,
128 };
129
130 struct wlcore_partition {
131         u32 size;
132         u32 start;
133 };
134
135 struct wlcore_partition_set {
136         struct wlcore_partition mem;
137         struct wlcore_partition reg;
138         struct wlcore_partition mem2;
139         struct wlcore_partition mem3;
140 };
141
142 enum wlcore_registers {
143         /* register addresses, used with partition translation */
144         REG_ECPU_CONTROL,
145         REG_INTERRUPT_NO_CLEAR,
146         REG_INTERRUPT_ACK,
147         REG_COMMAND_MAILBOX_PTR,
148         REG_EVENT_MAILBOX_PTR,
149         REG_INTERRUPT_TRIG,
150         REG_INTERRUPT_MASK,
151         REG_PC_ON_RECOVERY,
152         REG_CHIP_ID_B,
153         REG_CMD_MBOX_ADDRESS,
154
155         /* data access memory addresses, used with partition translation */
156         REG_SLV_MEM_DATA,
157         REG_SLV_REG_DATA,
158
159         /* raw data access memory addresses */
160         REG_RAW_FW_STATUS_ADDR,
161
162         REG_TABLE_LEN,
163 };
164
165 struct wl1271_stats {
166         void *fw_stats;
167         unsigned long fw_stats_update;
168         size_t fw_stats_len;
169
170         unsigned int retry_count;
171         unsigned int excessive_retries;
172 };
173
174 struct wl1271 {
175         bool initialized;
176         struct ieee80211_hw *hw;
177         bool mac80211_registered;
178
179         struct device *dev;
180         struct platform_device *pdev;
181
182         void *if_priv;
183
184         struct wl1271_if_operations *if_ops;
185
186         void (*set_power)(bool enable);
187         int irq;
188
189         spinlock_t wl_lock;
190
191         enum wlcore_state state;
192         enum wl12xx_fw_type fw_type;
193         bool plt;
194         enum plt_mode plt_mode;
195         u8 fem_manuf;
196         u8 last_vif_count;
197         struct mutex mutex;
198
199         unsigned long flags;
200
201         struct wlcore_partition_set curr_part;
202
203         struct wl1271_chip chip;
204
205         int cmd_box_addr;
206
207         u8 *fw;
208         size_t fw_len;
209         void *nvs;
210         size_t nvs_len;
211
212         s8 hw_pg_ver;
213
214         /* address read from the fuse ROM */
215         u32 fuse_oui_addr;
216         u32 fuse_nic_addr;
217
218         /* we have up to 2 MAC addresses */
219         struct mac_address addresses[WLCORE_NUM_MAC_ADDRESSES];
220         int channel;
221         u8 system_hlid;
222
223         unsigned long links_map[BITS_TO_LONGS(WL12XX_MAX_LINKS)];
224         unsigned long roles_map[BITS_TO_LONGS(WL12XX_MAX_ROLES)];
225         unsigned long roc_map[BITS_TO_LONGS(WL12XX_MAX_ROLES)];
226         unsigned long rate_policies_map[
227                         BITS_TO_LONGS(WL12XX_MAX_RATE_POLICIES)];
228         unsigned long klv_templates_map[
229                         BITS_TO_LONGS(WLCORE_MAX_KLV_TEMPLATES)];
230
231         u8 session_ids[WL12XX_MAX_LINKS];
232
233         struct list_head wlvif_list;
234
235         u8 sta_count;
236         u8 ap_count;
237
238         struct wl1271_acx_mem_map *target_mem_map;
239
240         /* Accounting for allocated / available TX blocks on HW */
241         u32 tx_blocks_freed;
242         u32 tx_blocks_available;
243         u32 tx_allocated_blocks;
244         u32 tx_results_count;
245
246         /* Accounting for allocated / available Tx packets in HW */
247         u32 tx_pkts_freed[NUM_TX_QUEUES];
248         u32 tx_allocated_pkts[NUM_TX_QUEUES];
249
250         /* Transmitted TX packets counter for chipset interface */
251         u32 tx_packets_count;
252
253         /* Time-offset between host and chipset clocks */
254         s64 time_offset;
255
256         /* Frames scheduled for transmission, not handled yet */
257         int tx_queue_count[NUM_TX_QUEUES];
258         unsigned long queue_stop_reasons[
259                                 NUM_TX_QUEUES * WLCORE_NUM_MAC_ADDRESSES];
260
261         /* Frames received, not handled yet by mac80211 */
262         struct sk_buff_head deferred_rx_queue;
263
264         /* Frames sent, not returned yet to mac80211 */
265         struct sk_buff_head deferred_tx_queue;
266
267         struct work_struct tx_work;
268         struct workqueue_struct *freezable_wq;
269
270         /* Pending TX frames */
271         unsigned long tx_frames_map[BITS_TO_LONGS(WLCORE_MAX_TX_DESCRIPTORS)];
272         struct sk_buff *tx_frames[WLCORE_MAX_TX_DESCRIPTORS];
273         int tx_frames_cnt;
274
275         /* FW Rx counter */
276         u32 rx_counter;
277
278         /* Intermediate buffer, used for packet aggregation */
279         u8 *aggr_buf;
280         u32 aggr_buf_size;
281
282         /* Reusable dummy packet template */
283         struct sk_buff *dummy_packet;
284
285         /* Network stack work  */
286         struct work_struct netstack_work;
287
288         /* FW log buffer */
289         u8 *fwlog;
290
291         /* Number of valid bytes in the FW log buffer */
292         ssize_t fwlog_size;
293
294         /* Sysfs FW log entry readers wait queue */
295         wait_queue_head_t fwlog_waitq;
296
297         /* Hardware recovery work */
298         struct work_struct recovery_work;
299         bool watchdog_recovery;
300
301         /* Reg domain last configuration */
302         u32 reg_ch_conf_last[2];
303         /* Reg domain pending configuration */
304         u32 reg_ch_conf_pending[2];
305
306         /* Pointer that holds DMA-friendly block for the mailbox */
307         void *mbox;
308
309         /* The mbox event mask */
310         u32 event_mask;
311
312         /* Mailbox pointers */
313         u32 mbox_size;
314         u32 mbox_ptr[2];
315
316         /* Are we currently scanning */
317         struct wl12xx_vif *scan_wlvif;
318         struct wl1271_scan scan;
319         struct delayed_work scan_complete_work;
320
321         struct ieee80211_vif *roc_vif;
322         struct delayed_work roc_complete_work;
323
324         struct wl12xx_vif *sched_vif;
325
326         /* The current band */
327         enum ieee80211_band band;
328
329         struct completion *elp_compl;
330         struct delayed_work elp_work;
331
332         /* in dBm */
333         int power_level;
334
335         struct wl1271_stats stats;
336
337         __le32 *buffer_32;
338         u32 buffer_cmd;
339         u32 buffer_busyword[WL1271_BUSY_WORD_CNT];
340
341         struct wl_fw_status_1 *fw_status_1;
342         struct wl_fw_status_2 *fw_status_2;
343         struct wl1271_tx_hw_res_if *tx_res_if;
344
345         /* Current chipset configuration */
346         struct wlcore_conf conf;
347
348         bool sg_enabled;
349
350         bool enable_11a;
351
352         int recovery_count;
353
354         /* Most recently reported noise in dBm */
355         s8 noise;
356
357         /* bands supported by this instance of wl12xx */
358         struct ieee80211_supported_band bands[WLCORE_NUM_BANDS];
359
360         /*
361          * wowlan trigger was configured during suspend.
362          * (currently, only "ANY" trigger is supported)
363          */
364         bool wow_enabled;
365         bool irq_wake_enabled;
366
367         /*
368          * AP-mode - links indexed by HLID. The global and broadcast links
369          * are always active.
370          */
371         struct wl1271_link links[WL12XX_MAX_LINKS];
372
373         /* number of currently active links */
374         int active_link_count;
375
376         /* Fast/slow links bitmap according to FW */
377         u32 fw_fast_lnk_map;
378
379         /* AP-mode - a bitmap of links currently in PS mode according to FW */
380         u32 ap_fw_ps_map;
381
382         /* AP-mode - a bitmap of links currently in PS mode in mac80211 */
383         unsigned long ap_ps_map;
384
385         /* Quirks of specific hardware revisions */
386         unsigned int quirks;
387
388         /* Platform limitations */
389         unsigned int platform_quirks;
390
391         /* number of currently active RX BA sessions */
392         int ba_rx_session_count;
393
394         /* AP-mode - number of currently connected stations */
395         int active_sta_count;
396
397         /* last wlvif we transmitted from */
398         struct wl12xx_vif *last_wlvif;
399
400         /* work to fire when Tx is stuck */
401         struct delayed_work tx_watchdog_work;
402
403         struct wlcore_ops *ops;
404         /* pointer to the lower driver partition table */
405         const struct wlcore_partition_set *ptable;
406         /* pointer to the lower driver register table */
407         const int *rtable;
408         /* name of the firmwares to load - for PLT, single role, multi-role */
409         const char *plt_fw_name;
410         const char *sr_fw_name;
411         const char *mr_fw_name;
412
413         u8 scan_templ_id_2_4;
414         u8 scan_templ_id_5;
415         u8 sched_scan_templ_id_2_4;
416         u8 sched_scan_templ_id_5;
417         u8 max_channels_5;
418
419         /* per-chip-family private structure */
420         void *priv;
421
422         /* number of TX descriptors the HW supports. */
423         u32 num_tx_desc;
424         /* number of RX descriptors the HW supports. */
425         u32 num_rx_desc;
426
427         /* translate HW Tx rates to standard rate-indices */
428         const u8 **band_rate_to_idx;
429
430         /* size of table for HW rates that can be received from chip */
431         u8 hw_tx_rate_tbl_size;
432
433         /* this HW rate and below are considered HT rates for this chip */
434         u8 hw_min_ht_rate;
435
436         /* HW HT (11n) capabilities */
437         struct ieee80211_sta_ht_cap ht_cap[WLCORE_NUM_BANDS];
438
439         /* size of the private FW status data */
440         size_t fw_status_priv_len;
441
442         /* RX Data filter rule state - enabled/disabled */
443         bool rx_filter_enabled[WL1271_MAX_RX_FILTERS];
444
445         /* size of the private static data */
446         size_t static_data_priv_len;
447
448         /* the current channel type */
449         enum nl80211_channel_type channel_type;
450
451         /* mutex for protecting the tx_flush function */
452         struct mutex flush_mutex;
453
454         /* sleep auth value currently configured to FW */
455         int sleep_auth;
456
457         /* the number of allocated MAC addresses in this chip */
458         int num_mac_addr;
459
460         /* minimum FW version required for the driver to work in single-role */
461         unsigned int min_sr_fw_ver[NUM_FW_VER];
462
463         /* minimum FW version required for the driver to work in multi-role */
464         unsigned int min_mr_fw_ver[NUM_FW_VER];
465
466         struct completion nvs_loading_complete;
467
468         /* number of concurrent channels the HW supports */
469         u32 num_channels;
470 };
471
472 int __devinit wlcore_probe(struct wl1271 *wl, struct platform_device *pdev);
473 int __devexit wlcore_remove(struct platform_device *pdev);
474 struct ieee80211_hw *wlcore_alloc_hw(size_t priv_size, u32 aggr_buf_size,
475                                      u32 mbox_size);
476 int wlcore_free_hw(struct wl1271 *wl);
477 int wlcore_set_key(struct wl1271 *wl, enum set_key_cmd cmd,
478                    struct ieee80211_vif *vif,
479                    struct ieee80211_sta *sta,
480                    struct ieee80211_key_conf *key_conf);
481 void wlcore_regdomain_config(struct wl1271 *wl);
482
483 static inline void
484 wlcore_set_ht_cap(struct wl1271 *wl, enum ieee80211_band band,
485                   struct ieee80211_sta_ht_cap *ht_cap)
486 {
487         memcpy(&wl->ht_cap[band], ht_cap, sizeof(*ht_cap));
488 }
489
490 /* Tell wlcore not to care about this element when checking the version */
491 #define WLCORE_FW_VER_IGNORE    -1
492
493 static inline void
494 wlcore_set_min_fw_ver(struct wl1271 *wl, unsigned int chip,
495                       unsigned int iftype_sr, unsigned int major_sr,
496                       unsigned int subtype_sr, unsigned int minor_sr,
497                       unsigned int iftype_mr, unsigned int major_mr,
498                       unsigned int subtype_mr, unsigned int minor_mr)
499 {
500         wl->min_sr_fw_ver[FW_VER_CHIP] = chip;
501         wl->min_sr_fw_ver[FW_VER_IF_TYPE] = iftype_sr;
502         wl->min_sr_fw_ver[FW_VER_MAJOR] = major_sr;
503         wl->min_sr_fw_ver[FW_VER_SUBTYPE] = subtype_sr;
504         wl->min_sr_fw_ver[FW_VER_MINOR] = minor_sr;
505
506         wl->min_mr_fw_ver[FW_VER_CHIP] = chip;
507         wl->min_mr_fw_ver[FW_VER_IF_TYPE] = iftype_mr;
508         wl->min_mr_fw_ver[FW_VER_MAJOR] = major_mr;
509         wl->min_mr_fw_ver[FW_VER_SUBTYPE] = subtype_mr;
510         wl->min_mr_fw_ver[FW_VER_MINOR] = minor_mr;
511 }
512
513 /* Firmware image load chunk size */
514 #define CHUNK_SIZE      16384
515
516 /* Quirks */
517
518 /* Each RX/TX transaction requires an end-of-transaction transfer */
519 #define WLCORE_QUIRK_END_OF_TRANSACTION         BIT(0)
520
521 /* the first start_role(sta) sometimes doesn't work on wl12xx */
522 #define WLCORE_QUIRK_START_STA_FAILS            BIT(1)
523
524 /* wl127x and SPI don't support SDIO block size alignment */
525 #define WLCORE_QUIRK_TX_BLOCKSIZE_ALIGN         BIT(2)
526
527 /* means aggregated Rx packets are aligned to a SDIO block */
528 #define WLCORE_QUIRK_RX_BLOCKSIZE_ALIGN         BIT(3)
529
530 /* Older firmwares did not implement the FW logger over bus feature */
531 #define WLCORE_QUIRK_FWLOG_NOT_IMPLEMENTED      BIT(4)
532
533 /* Older firmwares use an old NVS format */
534 #define WLCORE_QUIRK_LEGACY_NVS                 BIT(5)
535
536 /* pad only the last frame in the aggregate buffer */
537 #define WLCORE_QUIRK_TX_PAD_LAST_FRAME          BIT(7)
538
539 /* extra header space is required for TKIP */
540 #define WLCORE_QUIRK_TKIP_HEADER_SPACE          BIT(8)
541
542 /* Some firmwares not support sched scans while connected */
543 #define WLCORE_QUIRK_NO_SCHED_SCAN_WHILE_CONN   BIT(9)
544
545 /* separate probe response templates for one-shot and sched scans */
546 #define WLCORE_QUIRK_DUAL_PROBE_TMPL            BIT(10)
547
548 /* Firmware requires reg domain configuration for active calibration */
549 #define WLCORE_QUIRK_REGDOMAIN_CONF             BIT(11)
550
551 /* The FW only support a zero session id for AP */
552 #define WLCORE_QUIRK_AP_ZERO_SESSION_ID         BIT(12)
553
554 /* TODO: move all these common registers and values elsewhere */
555 #define HW_ACCESS_ELP_CTRL_REG          0x1FFFC
556
557 /* ELP register commands */
558 #define ELPCTRL_WAKE_UP             0x1
559 #define ELPCTRL_WAKE_UP_WLAN_READY  0x5
560 #define ELPCTRL_SLEEP               0x0
561 /* ELP WLAN_READY bit */
562 #define ELPCTRL_WLAN_READY          0x2
563
564 /*************************************************************************
565
566     Interrupt Trigger Register (Host -> WiLink)
567
568 **************************************************************************/
569
570 /* Hardware to Embedded CPU Interrupts - first 32-bit register set */
571
572 /*
573  * The host sets this bit to inform the Wlan
574  * FW that a TX packet is in the XFER
575  * Buffer #0.
576  */
577 #define INTR_TRIG_TX_PROC0 BIT(2)
578
579 /*
580  * The host sets this bit to inform the FW
581  * that it read a packet from RX XFER
582  * Buffer #0.
583  */
584 #define INTR_TRIG_RX_PROC0 BIT(3)
585
586 #define INTR_TRIG_DEBUG_ACK BIT(4)
587
588 #define INTR_TRIG_STATE_CHANGED BIT(5)
589
590 /* Hardware to Embedded CPU Interrupts - second 32-bit register set */
591
592 /*
593  * The host sets this bit to inform the FW
594  * that it read a packet from RX XFER
595  * Buffer #1.
596  */
597 #define INTR_TRIG_RX_PROC1 BIT(17)
598
599 /*
600  * The host sets this bit to inform the Wlan
601  * hardware that a TX packet is in the XFER
602  * Buffer #1.
603  */
604 #define INTR_TRIG_TX_PROC1 BIT(18)
605
606 #define ACX_SLV_SOFT_RESET_BIT  BIT(1)
607 #define SOFT_RESET_MAX_TIME     1000000
608 #define SOFT_RESET_STALL_TIME   1000
609
610 #define ECPU_CONTROL_HALT       0x00000101
611
612 #define WELP_ARM_COMMAND_VAL    0x4
613
614 #endif /* __WLCORE_H__ */