wl1271: Add connection monitoring configuration
[linux-2.6.git] / drivers / net / wireless / wl12xx / wl1271_acx.h
1 /*
2  * This file is part of wl1271
3  *
4  * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
5  * Copyright (C) 2008-2009 Nokia Corporation
6  *
7  * Contact: Luciano Coelho <luciano.coelho@nokia.com>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * version 2 as published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21  * 02110-1301 USA
22  *
23  */
24
25 #ifndef __WL1271_ACX_H__
26 #define __WL1271_ACX_H__
27
28 #include "wl1271.h"
29 #include "wl1271_cmd.h"
30
31 /*************************************************************************
32
33     Host Interrupt Register (WiLink -> Host)
34
35 **************************************************************************/
36 /* HW Initiated interrupt Watchdog timer expiration */
37 #define WL1271_ACX_INTR_WATCHDOG           BIT(0)
38 /* Init sequence is done (masked interrupt, detection through polling only ) */
39 #define WL1271_ACX_INTR_INIT_COMPLETE      BIT(1)
40 /* Event was entered to Event MBOX #A*/
41 #define WL1271_ACX_INTR_EVENT_A            BIT(2)
42 /* Event was entered to Event MBOX #B*/
43 #define WL1271_ACX_INTR_EVENT_B            BIT(3)
44 /* Command processing completion*/
45 #define WL1271_ACX_INTR_CMD_COMPLETE       BIT(4)
46 /* Signaling the host on HW wakeup */
47 #define WL1271_ACX_INTR_HW_AVAILABLE       BIT(5)
48 /* The MISC bit is used for aggregation of RX, TxComplete and TX rate update */
49 #define WL1271_ACX_INTR_DATA               BIT(6)
50 /* Trace meassge on MBOX #A */
51 #define WL1271_ACX_INTR_TRACE_A            BIT(7)
52 /* Trace meassge on MBOX #B */
53 #define WL1271_ACX_INTR_TRACE_B            BIT(8)
54
55 #define WL1271_ACX_INTR_ALL                0xFFFFFFFF
56 #define WL1271_ACX_ALL_EVENTS_VECTOR       (WL1271_ACX_INTR_WATCHDOG      | \
57                                             WL1271_ACX_INTR_INIT_COMPLETE | \
58                                             WL1271_ACX_INTR_EVENT_A       | \
59                                             WL1271_ACX_INTR_EVENT_B       | \
60                                             WL1271_ACX_INTR_CMD_COMPLETE  | \
61                                             WL1271_ACX_INTR_HW_AVAILABLE  | \
62                                             WL1271_ACX_INTR_DATA)
63
64 #define WL1271_INTR_MASK                   (WL1271_ACX_INTR_EVENT_A |   \
65                                             WL1271_ACX_INTR_EVENT_B | \
66                                             WL1271_ACX_INTR_DATA)
67
68 /* Target's information element */
69 struct acx_header {
70         struct wl1271_cmd_header cmd;
71
72         /* acx (or information element) header */
73         u16 id;
74
75         /* payload length (not including headers */
76         u16 len;
77 };
78
79 struct acx_error_counter {
80         struct acx_header header;
81
82         /* The number of PLCP errors since the last time this */
83         /* information element was interrogated. This field is */
84         /* automatically cleared when it is interrogated.*/
85         u32 PLCP_error;
86
87         /* The number of FCS errors since the last time this */
88         /* information element was interrogated. This field is */
89         /* automatically cleared when it is interrogated.*/
90         u32 FCS_error;
91
92         /* The number of MPDUs without PLCP header errors received*/
93         /* since the last time this information element was interrogated. */
94         /* This field is automatically cleared when it is interrogated.*/
95         u32 valid_frame;
96
97         /* the number of missed sequence numbers in the squentially */
98         /* values of frames seq numbers */
99         u32 seq_num_miss;
100 } __attribute__ ((packed));
101
102 struct acx_revision {
103         struct acx_header header;
104
105         /*
106          * The WiLink firmware version, an ASCII string x.x.x.x,
107          * that uniquely identifies the current firmware.
108          * The left most digit is incremented each time a
109          * significant change is made to the firmware, such as
110          * code redesign or new platform support.
111          * The second digit is incremented when major enhancements
112          * are added or major fixes are made.
113          * The third digit is incremented for each GA release.
114          * The fourth digit is incremented for each build.
115          * The first two digits identify a firmware release version,
116          * in other words, a unique set of features.
117          * The first three digits identify a GA release.
118          */
119         char fw_version[20];
120
121         /*
122          * This 4 byte field specifies the WiLink hardware version.
123          * bits 0  - 15: Reserved.
124          * bits 16 - 23: Version ID - The WiLink version ID
125          *              (1 = first spin, 2 = second spin, and so on).
126          * bits 24 - 31: Chip ID - The WiLink chip ID.
127          */
128         u32 hw_version;
129 } __attribute__ ((packed));
130
131 enum wl1271_psm_mode {
132         /* Active mode */
133         WL1271_PSM_CAM = 0,
134
135         /* Power save mode */
136         WL1271_PSM_PS = 1,
137
138         /* Extreme low power */
139         WL1271_PSM_ELP = 2,
140 };
141
142 struct acx_sleep_auth {
143         struct acx_header header;
144
145         /* The sleep level authorization of the device. */
146         /* 0 - Always active*/
147         /* 1 - Power down mode: light / fast sleep*/
148         /* 2 - ELP mode: Deep / Max sleep*/
149         u8  sleep_auth;
150         u8  padding[3];
151 } __attribute__ ((packed));
152
153 enum {
154         HOSTIF_PCI_MASTER_HOST_INDIRECT,
155         HOSTIF_PCI_MASTER_HOST_DIRECT,
156         HOSTIF_SLAVE,
157         HOSTIF_PKT_RING,
158         HOSTIF_DONTCARE = 0xFF
159 };
160
161 #define DEFAULT_UCAST_PRIORITY          0
162 #define DEFAULT_RX_Q_PRIORITY           0
163 #define DEFAULT_NUM_STATIONS            1
164 #define DEFAULT_RXQ_PRIORITY            0 /* low 0 .. 15 high  */
165 #define DEFAULT_RXQ_TYPE                0x07    /* All frames, Data/Ctrl/Mgmt */
166 #define TRACE_BUFFER_MAX_SIZE           256
167
168 #define  DP_RX_PACKET_RING_CHUNK_SIZE 1600
169 #define  DP_TX_PACKET_RING_CHUNK_SIZE 1600
170 #define  DP_RX_PACKET_RING_CHUNK_NUM 2
171 #define  DP_TX_PACKET_RING_CHUNK_NUM 2
172 #define  DP_TX_COMPLETE_TIME_OUT 20
173
174 #define TX_MSDU_LIFETIME_MIN       0
175 #define TX_MSDU_LIFETIME_MAX       3000
176 #define TX_MSDU_LIFETIME_DEF       512
177 #define RX_MSDU_LIFETIME_MIN       0
178 #define RX_MSDU_LIFETIME_MAX       0xFFFFFFFF
179 #define RX_MSDU_LIFETIME_DEF       512000
180
181 struct acx_rx_msdu_lifetime {
182         struct acx_header header;
183
184         /*
185          * The maximum amount of time, in TU, before the
186          * firmware discards the MSDU.
187          */
188         u32 lifetime;
189 } __attribute__ ((packed));
190
191 /*
192  * RX Config Options Table
193  * Bit          Definition
194  * ===          ==========
195  * 31:14                Reserved
196  * 13           Copy RX Status - when set, write three receive status words
197  *              to top of rx'd MPDUs.
198  *              When cleared, do not write three status words (added rev 1.5)
199  * 12           Reserved
200  * 11           RX Complete upon FCS error - when set, give rx complete
201  *              interrupt for FCS errors, after the rx filtering, e.g. unicast
202  *              frames not to us with FCS error will not generate an interrupt.
203  * 10           SSID Filter Enable - When set, the WiLink discards all beacon,
204  *              probe request, and probe response frames with an SSID that does
205  *              not match the SSID specified by the host in the START/JOIN
206  *              command.
207  *              When clear, the WiLink receives frames with any SSID.
208  * 9            Broadcast Filter Enable - When set, the WiLink discards all
209  *              broadcast frames. When clear, the WiLink receives all received
210  *              broadcast frames.
211  * 8:6          Reserved
212  * 5            BSSID Filter Enable - When set, the WiLink discards any frames
213  *              with a BSSID that does not match the BSSID specified by the
214  *              host.
215  *              When clear, the WiLink receives frames from any BSSID.
216  * 4            MAC Addr Filter - When set, the WiLink discards any frames
217  *              with a destination address that does not match the MAC address
218  *              of the adaptor.
219  *              When clear, the WiLink receives frames destined to any MAC
220  *              address.
221  * 3            Promiscuous - When set, the WiLink receives all valid frames
222  *              (i.e., all frames that pass the FCS check).
223  *              When clear, only frames that pass the other filters specified
224  *              are received.
225  * 2            FCS - When set, the WiLink includes the FCS with the received
226  *              frame.
227  *              When cleared, the FCS is discarded.
228  * 1            PLCP header - When set, write all data from baseband to frame
229  *              buffer including PHY header.
230  * 0            Reserved - Always equal to 0.
231  *
232  * RX Filter Options Table
233  * Bit          Definition
234  * ===          ==========
235  * 31:12                Reserved - Always equal to 0.
236  * 11           Association - When set, the WiLink receives all association
237  *              related frames (association request/response, reassocation
238  *              request/response, and disassociation). When clear, these frames
239  *              are discarded.
240  * 10           Auth/De auth - When set, the WiLink receives all authentication
241  *              and de-authentication frames. When clear, these frames are
242  *              discarded.
243  * 9            Beacon - When set, the WiLink receives all beacon frames.
244  *              When clear, these frames are discarded.
245  * 8            Contention Free - When set, the WiLink receives all contention
246  *              free frames.
247  *              When clear, these frames are discarded.
248  * 7            Control - When set, the WiLink receives all control frames.
249  *              When clear, these frames are discarded.
250  * 6            Data - When set, the WiLink receives all data frames.
251  *              When clear, these frames are discarded.
252  * 5            FCS Error - When set, the WiLink receives frames that have FCS
253  *              errors.
254  *              When clear, these frames are discarded.
255  * 4            Management - When set, the WiLink receives all management
256  *              frames.
257  *              When clear, these frames are discarded.
258  * 3            Probe Request - When set, the WiLink receives all probe request
259  *              frames.
260  *              When clear, these frames are discarded.
261  * 2            Probe Response - When set, the WiLink receives all probe
262  *              response frames.
263  *              When clear, these frames are discarded.
264  * 1            RTS/CTS/ACK - When set, the WiLink receives all RTS, CTS and ACK
265  *              frames.
266  *              When clear, these frames are discarded.
267  * 0            Rsvd Type/Sub Type - When set, the WiLink receives all frames
268  *              that have reserved frame types and sub types as defined by the
269  *              802.11 specification.
270  *              When clear, these frames are discarded.
271  */
272 struct acx_rx_config {
273         struct acx_header header;
274
275         u32 config_options;
276         u32 filter_options;
277 } __attribute__ ((packed));
278
279 struct acx_packet_detection {
280         struct acx_header header;
281
282         u32 threshold;
283 } __attribute__ ((packed));
284
285
286 enum acx_slot_type {
287         SLOT_TIME_LONG = 0,
288         SLOT_TIME_SHORT = 1,
289         DEFAULT_SLOT_TIME = SLOT_TIME_SHORT,
290         MAX_SLOT_TIMES = 0xFF
291 };
292
293 #define STATION_WONE_INDEX 0
294
295 struct acx_slot {
296         struct acx_header header;
297
298         u8 wone_index; /* Reserved */
299         u8 slot_time;
300         u8 reserved[6];
301 } __attribute__ ((packed));
302
303
304 #define ACX_MC_ADDRESS_GROUP_MAX        (8)
305 #define ADDRESS_GROUP_MAX_LEN           (ETH_ALEN * ACX_MC_ADDRESS_GROUP_MAX)
306
307 struct acx_dot11_grp_addr_tbl {
308         struct acx_header header;
309
310         u8 enabled;
311         u8 num_groups;
312         u8 pad[2];
313         u8 mac_table[ADDRESS_GROUP_MAX_LEN];
314 } __attribute__ ((packed));
315
316 #define  RX_TIMEOUT_PS_POLL_MIN    0
317 #define  RX_TIMEOUT_PS_POLL_MAX    (200000)
318 #define  RX_TIMEOUT_PS_POLL_DEF    (15)
319 #define  RX_TIMEOUT_UPSD_MIN       0
320 #define  RX_TIMEOUT_UPSD_MAX       (200000)
321 #define  RX_TIMEOUT_UPSD_DEF       (15)
322
323 struct acx_rx_timeout {
324         struct acx_header header;
325
326         /*
327          * The longest time the STA will wait to receive
328          * traffic from the AP after a PS-poll has been
329          * transmitted.
330          */
331         u16 ps_poll_timeout;
332
333         /*
334          * The longest time the STA will wait to receive
335          * traffic from the AP after a frame has been sent
336          * from an UPSD enabled queue.
337          */
338         u16 upsd_timeout;
339 } __attribute__ ((packed));
340
341 #define RTS_THRESHOLD_MIN              0
342 #define RTS_THRESHOLD_MAX              4096
343 #define RTS_THRESHOLD_DEF              2347
344
345 struct acx_rts_threshold {
346         struct acx_header header;
347
348         u16 threshold;
349         u8 pad[2];
350 } __attribute__ ((packed));
351
352 struct acx_beacon_filter_option {
353         struct acx_header header;
354
355         u8 enable;
356
357         /*
358          * The number of beacons without the unicast TIM
359          * bit set that the firmware buffers before
360          * signaling the host about ready frames.
361          * When set to 0 and the filter is enabled, beacons
362          * without the unicast TIM bit set are dropped.
363          */
364         u8 max_num_beacons;
365         u8 pad[2];
366 } __attribute__ ((packed));
367
368 /*
369  * ACXBeaconFilterEntry (not 221)
370  * Byte Offset     Size (Bytes)    Definition
371  * ===========     ============    ==========
372  * 0                            1               IE identifier
373  * 1               1               Treatment bit mask
374  *
375  * ACXBeaconFilterEntry (221)
376  * Byte Offset     Size (Bytes)    Definition
377  * ===========     ============    ==========
378  * 0               1               IE identifier
379  * 1               1               Treatment bit mask
380  * 2               3               OUI
381  * 5               1               Type
382  * 6               2               Version
383  *
384  *
385  * Treatment bit mask - The information element handling:
386  * bit 0 - The information element is compared and transferred
387  * in case of change.
388  * bit 1 - The information element is transferred to the host
389  * with each appearance or disappearance.
390  * Note that both bits can be set at the same time.
391  */
392 #define BEACON_FILTER_TABLE_MAX_IE_NUM                 (32)
393 #define BEACON_FILTER_TABLE_MAX_VENDOR_SPECIFIC_IE_NUM (6)
394 #define BEACON_FILTER_TABLE_IE_ENTRY_SIZE              (2)
395 #define BEACON_FILTER_TABLE_EXTRA_VENDOR_SPECIFIC_IE_SIZE (6)
396 #define BEACON_FILTER_TABLE_MAX_SIZE ((BEACON_FILTER_TABLE_MAX_IE_NUM * \
397                             BEACON_FILTER_TABLE_IE_ENTRY_SIZE) + \
398                            (BEACON_FILTER_TABLE_MAX_VENDOR_SPECIFIC_IE_NUM * \
399                             BEACON_FILTER_TABLE_EXTRA_VENDOR_SPECIFIC_IE_SIZE))
400
401 struct acx_beacon_filter_ie_table {
402         struct acx_header header;
403
404         u8 num_ie;
405         u8 table[BEACON_FILTER_TABLE_MAX_SIZE];
406         u8 pad[3];
407 } __attribute__ ((packed));
408
409 #define SYNCH_FAIL_DEFAULT_THRESHOLD    5     /* number of beacons */
410 #define NO_BEACON_DEFAULT_TIMEOUT       (100) /* TU */
411
412 struct acx_conn_monit_params {
413        struct acx_header header;
414
415        u32 synch_fail_thold; /* number of beacons missed */
416        u32 bss_lose_timeout; /* number of TU's from synch fail */
417 };
418
419 enum {
420         SG_ENABLE = 0,
421         SG_DISABLE,
422         SG_SENSE_NO_ACTIVITY,
423         SG_SENSE_ACTIVE
424 };
425
426 struct acx_bt_wlan_coex {
427         struct acx_header header;
428
429         /*
430          * 0 -> PTA enabled
431          * 1 -> PTA disabled
432          * 2 -> sense no active mode, i.e.
433          *      an interrupt is sent upon
434          *      BT activity.
435          * 3 -> PTA is switched on in response
436          *      to the interrupt sending.
437          */
438         u8 enable;
439         u8 pad[3];
440 } __attribute__ ((packed));
441
442 #define PTA_ANTENNA_TYPE_DEF              (0)
443 #define PTA_BT_HP_MAXTIME_DEF             (2000)
444 #define PTA_WLAN_HP_MAX_TIME_DEF          (5000)
445 #define PTA_SENSE_DISABLE_TIMER_DEF       (1350)
446 #define PTA_PROTECTIVE_RX_TIME_DEF        (1500)
447 #define PTA_PROTECTIVE_TX_TIME_DEF        (1500)
448 #define PTA_TIMEOUT_NEXT_BT_LP_PACKET_DEF (3000)
449 #define PTA_SIGNALING_TYPE_DEF            (1)
450 #define PTA_AFH_LEVERAGE_ON_DEF           (0)
451 #define PTA_NUMBER_QUIET_CYCLE_DEF        (0)
452 #define PTA_MAX_NUM_CTS_DEF               (3)
453 #define PTA_NUMBER_OF_WLAN_PACKETS_DEF    (2)
454 #define PTA_NUMBER_OF_BT_PACKETS_DEF      (2)
455 #define PTA_PROTECTIVE_RX_TIME_FAST_DEF   (1500)
456 #define PTA_PROTECTIVE_TX_TIME_FAST_DEF   (3000)
457 #define PTA_CYCLE_TIME_FAST_DEF           (8700)
458 #define PTA_RX_FOR_AVALANCHE_DEF          (5)
459 #define PTA_ELP_HP_DEF                    (0)
460 #define PTA_ANTI_STARVE_PERIOD_DEF        (500)
461 #define PTA_ANTI_STARVE_NUM_CYCLE_DEF     (4)
462 #define PTA_ALLOW_PA_SD_DEF               (1)
463 #define PTA_TIME_BEFORE_BEACON_DEF        (6300)
464 #define PTA_HPDM_MAX_TIME_DEF             (1600)
465 #define PTA_TIME_OUT_NEXT_WLAN_DEF        (2550)
466 #define PTA_AUTO_MODE_NO_CTS_DEF          (0)
467 #define PTA_BT_HP_RESPECTED_DEF           (3)
468 #define PTA_WLAN_RX_MIN_RATE_DEF          (24)
469 #define PTA_ACK_MODE_DEF                  (1)
470
471 struct acx_bt_wlan_coex_param {
472         struct acx_header header;
473
474         /*
475          * The minimum rate of a received WLAN packet in the STA,
476          * during protective mode, of which a new BT-HP request
477          * during this Rx will always be respected and gain the antenna.
478          */
479         u32 min_rate;
480
481         /* Max time the BT HP will be respected. */
482         u16 bt_hp_max_time;
483
484         /* Max time the WLAN HP will be respected. */
485         u16 wlan_hp_max_time;
486
487         /*
488          * The time between the last BT activity
489          * and the moment when the sense mode returns
490          * to SENSE_INACTIVE.
491          */
492         u16 sense_disable_timer;
493
494         /* Time before the next BT HP instance */
495         u16 rx_time_bt_hp;
496         u16 tx_time_bt_hp;
497
498         /* range: 10-20000    default: 1500 */
499         u16 rx_time_bt_hp_fast;
500         u16 tx_time_bt_hp_fast;
501
502         /* range: 2000-65535  default: 8700 */
503         u16 wlan_cycle_fast;
504
505         /* range: 0 - 15000 (Msec) default: 1000 */
506         u16 bt_anti_starvation_period;
507
508         /* range 400-10000(Usec) default: 3000 */
509         u16 next_bt_lp_packet;
510
511         /* Deafult: worst case for BT DH5 traffic */
512         u16 wake_up_beacon;
513
514         /* range: 0-50000(Usec) default: 1050 */
515         u16 hp_dm_max_guard_time;
516
517         /*
518          * This is to prevent both BT & WLAN antenna
519          * starvation.
520          * Range: 100-50000(Usec) default:2550
521          */
522         u16 next_wlan_packet;
523
524         /* 0 -> shared antenna */
525         u8 antenna_type;
526
527         /*
528          * 0 -> TI legacy
529          * 1 -> Palau
530          */
531         u8 signal_type;
532
533         /*
534          * BT AFH status
535          * 0 -> no AFH
536          * 1 -> from dedicated GPIO
537          * 2 -> AFH on (from host)
538          */
539         u8 afh_leverage_on;
540
541         /*
542          * The number of cycles during which no
543          * TX will be sent after 1 cycle of RX
544          * transaction in protective mode
545          */
546         u8 quiet_cycle_num;
547
548         /*
549          * The maximum number of CTSs that will
550          * be sent for receiving RX packet in
551          * protective mode
552          */
553         u8 max_cts;
554
555         /*
556          * The number of WLAN packets
557          * transferred in common mode before
558          * switching to BT.
559          */
560         u8 wlan_packets_num;
561
562         /*
563          * The number of BT packets
564          * transferred in common mode before
565          * switching to WLAN.
566          */
567         u8 bt_packets_num;
568
569         /* range: 1-255  default: 5 */
570         u8 missed_rx_avalanche;
571
572         /* range: 0-1    default: 1 */
573         u8 wlan_elp_hp;
574
575         /* range: 0 - 15  default: 4 */
576         u8 bt_anti_starvation_cycles;
577
578         u8 ack_mode_dual_ant;
579
580         /*
581          * Allow PA_SD assertion/de-assertion
582          * during enabled BT activity.
583          */
584         u8 pa_sd_enable;
585
586         /*
587          * Enable/Disable PTA in auto mode:
588          * Support Both Active & P.S modes
589          */
590         u8 pta_auto_mode_enable;
591
592         /* range: 0 - 20  default: 1 */
593         u8 bt_hp_respected_num;
594 } __attribute__ ((packed));
595
596 #define CCA_THRSH_ENABLE_ENERGY_D       0x140A
597 #define CCA_THRSH_DISABLE_ENERGY_D      0xFFEF
598
599 struct acx_energy_detection {
600         struct acx_header header;
601
602         /* The RX Clear Channel Assessment threshold in the PHY */
603         u16 rx_cca_threshold;
604         u8 tx_energy_detection;
605         u8 pad;
606 } __attribute__ ((packed));
607
608 #define BCN_RX_TIMEOUT_DEF_VALUE        10000
609 #define BROADCAST_RX_TIMEOUT_DEF_VALUE  20000
610 #define RX_BROADCAST_IN_PS_DEF_VALUE    1
611 #define CONSECUTIVE_PS_POLL_FAILURE_DEF 4
612
613 struct acx_beacon_broadcast {
614         struct acx_header header;
615
616         u16 beacon_rx_timeout;
617         u16 broadcast_timeout;
618
619         /* Enables receiving of broadcast packets in PS mode */
620         u8 rx_broadcast_in_ps;
621
622         /* Consecutive PS Poll failures before updating the host */
623         u8 ps_poll_threshold;
624         u8 pad[2];
625 } __attribute__ ((packed));
626
627 struct acx_event_mask {
628         struct acx_header header;
629
630         u32 event_mask;
631         u32 high_event_mask; /* Unused */
632 } __attribute__ ((packed));
633
634 #define CFG_RX_FCS              BIT(2)
635 #define CFG_RX_ALL_GOOD         BIT(3)
636 #define CFG_UNI_FILTER_EN       BIT(4)
637 #define CFG_BSSID_FILTER_EN     BIT(5)
638 #define CFG_MC_FILTER_EN        BIT(6)
639 #define CFG_MC_ADDR0_EN         BIT(7)
640 #define CFG_MC_ADDR1_EN         BIT(8)
641 #define CFG_BC_REJECT_EN        BIT(9)
642 #define CFG_SSID_FILTER_EN      BIT(10)
643 #define CFG_RX_INT_FCS_ERROR    BIT(11)
644 #define CFG_RX_INT_ENCRYPTED    BIT(12)
645 #define CFG_RX_WR_RX_STATUS     BIT(13)
646 #define CFG_RX_FILTER_NULTI     BIT(14)
647 #define CFG_RX_RESERVE          BIT(15)
648 #define CFG_RX_TIMESTAMP_TSF    BIT(16)
649
650 #define CFG_RX_RSV_EN           BIT(0)
651 #define CFG_RX_RCTS_ACK         BIT(1)
652 #define CFG_RX_PRSP_EN          BIT(2)
653 #define CFG_RX_PREQ_EN          BIT(3)
654 #define CFG_RX_MGMT_EN          BIT(4)
655 #define CFG_RX_FCS_ERROR        BIT(5)
656 #define CFG_RX_DATA_EN          BIT(6)
657 #define CFG_RX_CTL_EN           BIT(7)
658 #define CFG_RX_CF_EN            BIT(8)
659 #define CFG_RX_BCN_EN           BIT(9)
660 #define CFG_RX_AUTH_EN          BIT(10)
661 #define CFG_RX_ASSOC_EN         BIT(11)
662
663 #define SCAN_PASSIVE            BIT(0)
664 #define SCAN_5GHZ_BAND          BIT(1)
665 #define SCAN_TRIGGERED          BIT(2)
666 #define SCAN_PRIORITY_HIGH      BIT(3)
667
668 struct acx_feature_config {
669         struct acx_header header;
670
671         u32 options;
672         u32 data_flow_options;
673 } __attribute__ ((packed));
674
675 struct acx_current_tx_power {
676         struct acx_header header;
677
678         u8  current_tx_power;
679         u8  padding[3];
680 } __attribute__ ((packed));
681
682 enum acx_wake_up_event {
683         WAKE_UP_EVENT_BEACON_BITMAP     = 0x01, /* Wake on every Beacon*/
684         WAKE_UP_EVENT_DTIM_BITMAP       = 0x02, /* Wake on every DTIM*/
685         WAKE_UP_EVENT_N_DTIM_BITMAP     = 0x04, /* Wake on every Nth DTIM */
686         WAKE_UP_EVENT_N_BEACONS_BITMAP  = 0x08, /* Wake on every Nth Beacon */
687         WAKE_UP_EVENT_BITS_MASK         = 0x0F
688 };
689
690 struct acx_wake_up_condition {
691         struct acx_header header;
692
693         u8 wake_up_event; /* Only one bit can be set */
694         u8 listen_interval;
695         u8 pad[2];
696 } __attribute__ ((packed));
697
698 struct acx_aid {
699         struct acx_header header;
700
701         /*
702          * To be set when associated with an AP.
703          */
704         u16 aid;
705         u8 pad[2];
706 } __attribute__ ((packed));
707
708 enum acx_preamble_type {
709         ACX_PREAMBLE_LONG = 0,
710         ACX_PREAMBLE_SHORT = 1
711 };
712
713 struct acx_preamble {
714         struct acx_header header;
715
716         /*
717          * When set, the WiLink transmits the frames with a short preamble and
718          * when cleared, the WiLink transmits the frames with a long preamble.
719          */
720         u8 preamble;
721         u8 padding[3];
722 } __attribute__ ((packed));
723
724 enum acx_ctsprotect_type {
725         CTSPROTECT_DISABLE = 0,
726         CTSPROTECT_ENABLE = 1
727 };
728
729 struct acx_ctsprotect {
730         struct acx_header header;
731         u8 ctsprotect;
732         u8 padding[3];
733 } __attribute__ ((packed));
734
735 struct acx_tx_statistics {
736         u32 internal_desc_overflow;
737 }  __attribute__ ((packed));
738
739 struct acx_rx_statistics {
740         u32 out_of_mem;
741         u32 hdr_overflow;
742         u32 hw_stuck;
743         u32 dropped;
744         u32 fcs_err;
745         u32 xfr_hint_trig;
746         u32 path_reset;
747         u32 reset_counter;
748 } __attribute__ ((packed));
749
750 struct acx_dma_statistics {
751         u32 rx_requested;
752         u32 rx_errors;
753         u32 tx_requested;
754         u32 tx_errors;
755 }  __attribute__ ((packed));
756
757 struct acx_isr_statistics {
758         /* host command complete */
759         u32 cmd_cmplt;
760
761         /* fiqisr() */
762         u32 fiqs;
763
764         /* (INT_STS_ND & INT_TRIG_RX_HEADER) */
765         u32 rx_headers;
766
767         /* (INT_STS_ND & INT_TRIG_RX_CMPLT) */
768         u32 rx_completes;
769
770         /* (INT_STS_ND & INT_TRIG_NO_RX_BUF) */
771         u32 rx_mem_overflow;
772
773         /* (INT_STS_ND & INT_TRIG_S_RX_RDY) */
774         u32 rx_rdys;
775
776         /* irqisr() */
777         u32 irqs;
778
779         /* (INT_STS_ND & INT_TRIG_TX_PROC) */
780         u32 tx_procs;
781
782         /* (INT_STS_ND & INT_TRIG_DECRYPT_DONE) */
783         u32 decrypt_done;
784
785         /* (INT_STS_ND & INT_TRIG_DMA0) */
786         u32 dma0_done;
787
788         /* (INT_STS_ND & INT_TRIG_DMA1) */
789         u32 dma1_done;
790
791         /* (INT_STS_ND & INT_TRIG_TX_EXC_CMPLT) */
792         u32 tx_exch_complete;
793
794         /* (INT_STS_ND & INT_TRIG_COMMAND) */
795         u32 commands;
796
797         /* (INT_STS_ND & INT_TRIG_RX_PROC) */
798         u32 rx_procs;
799
800         /* (INT_STS_ND & INT_TRIG_PM_802) */
801         u32 hw_pm_mode_changes;
802
803         /* (INT_STS_ND & INT_TRIG_ACKNOWLEDGE) */
804         u32 host_acknowledges;
805
806         /* (INT_STS_ND & INT_TRIG_PM_PCI) */
807         u32 pci_pm;
808
809         /* (INT_STS_ND & INT_TRIG_ACM_WAKEUP) */
810         u32 wakeups;
811
812         /* (INT_STS_ND & INT_TRIG_LOW_RSSI) */
813         u32 low_rssi;
814 } __attribute__ ((packed));
815
816 struct acx_wep_statistics {
817         /* WEP address keys configured */
818         u32 addr_key_count;
819
820         /* default keys configured */
821         u32 default_key_count;
822
823         u32 reserved;
824
825         /* number of times that WEP key not found on lookup */
826         u32 key_not_found;
827
828         /* number of times that WEP key decryption failed */
829         u32 decrypt_fail;
830
831         /* WEP packets decrypted */
832         u32 packets;
833
834         /* WEP decrypt interrupts */
835         u32 interrupt;
836 } __attribute__ ((packed));
837
838 #define ACX_MISSED_BEACONS_SPREAD 10
839
840 struct acx_pwr_statistics {
841         /* the amount of enters into power save mode (both PD & ELP) */
842         u32 ps_enter;
843
844         /* the amount of enters into ELP mode */
845         u32 elp_enter;
846
847         /* the amount of missing beacon interrupts to the host */
848         u32 missing_bcns;
849
850         /* the amount of wake on host-access times */
851         u32 wake_on_host;
852
853         /* the amount of wake on timer-expire */
854         u32 wake_on_timer_exp;
855
856         /* the number of packets that were transmitted with PS bit set */
857         u32 tx_with_ps;
858
859         /* the number of packets that were transmitted with PS bit clear */
860         u32 tx_without_ps;
861
862         /* the number of received beacons */
863         u32 rcvd_beacons;
864
865         /* the number of entering into PowerOn (power save off) */
866         u32 power_save_off;
867
868         /* the number of entries into power save mode */
869         u16 enable_ps;
870
871         /*
872          * the number of exits from power save, not including failed PS
873          * transitions
874          */
875         u16 disable_ps;
876
877         /*
878          * the number of times the TSF counter was adjusted because
879          * of drift
880          */
881         u32 fix_tsf_ps;
882
883         /* Gives statistics about the spread continuous missed beacons.
884          * The 16 LSB are dedicated for the PS mode.
885          * The 16 MSB are dedicated for the PS mode.
886          * cont_miss_bcns_spread[0] - single missed beacon.
887          * cont_miss_bcns_spread[1] - two continuous missed beacons.
888          * cont_miss_bcns_spread[2] - three continuous missed beacons.
889          * ...
890          * cont_miss_bcns_spread[9] - ten and more continuous missed beacons.
891         */
892         u32 cont_miss_bcns_spread[ACX_MISSED_BEACONS_SPREAD];
893
894         /* the number of beacons in awake mode */
895         u32 rcvd_awake_beacons;
896 } __attribute__ ((packed));
897
898 struct acx_mic_statistics {
899         u32 rx_pkts;
900         u32 calc_failure;
901 } __attribute__ ((packed));
902
903 struct acx_aes_statistics {
904         u32 encrypt_fail;
905         u32 decrypt_fail;
906         u32 encrypt_packets;
907         u32 decrypt_packets;
908         u32 encrypt_interrupt;
909         u32 decrypt_interrupt;
910 } __attribute__ ((packed));
911
912 struct acx_event_statistics {
913         u32 heart_beat;
914         u32 calibration;
915         u32 rx_mismatch;
916         u32 rx_mem_empty;
917         u32 rx_pool;
918         u32 oom_late;
919         u32 phy_transmit_error;
920         u32 tx_stuck;
921 } __attribute__ ((packed));
922
923 struct acx_ps_statistics {
924         u32 pspoll_timeouts;
925         u32 upsd_timeouts;
926         u32 upsd_max_sptime;
927         u32 upsd_max_apturn;
928         u32 pspoll_max_apturn;
929         u32 pspoll_utilization;
930         u32 upsd_utilization;
931 } __attribute__ ((packed));
932
933 struct acx_rxpipe_statistics {
934         u32 rx_prep_beacon_drop;
935         u32 descr_host_int_trig_rx_data;
936         u32 beacon_buffer_thres_host_int_trig_rx_data;
937         u32 missed_beacon_host_int_trig_rx_data;
938         u32 tx_xfr_host_int_trig_rx_data;
939 } __attribute__ ((packed));
940
941 struct acx_statistics {
942         struct acx_header header;
943
944         struct acx_tx_statistics tx;
945         struct acx_rx_statistics rx;
946         struct acx_dma_statistics dma;
947         struct acx_isr_statistics isr;
948         struct acx_wep_statistics wep;
949         struct acx_pwr_statistics pwr;
950         struct acx_aes_statistics aes;
951         struct acx_mic_statistics mic;
952         struct acx_event_statistics event;
953         struct acx_ps_statistics ps;
954         struct acx_rxpipe_statistics rxpipe;
955 } __attribute__ ((packed));
956
957 #define ACX_MAX_RATE_CLASSES       8
958 #define ACX_RATE_MASK_UNSPECIFIED  0
959 #define ACX_RATE_MASK_ALL          0x1eff
960 #define ACX_RATE_RETRY_LIMIT       10
961
962 struct acx_rate_class {
963         u32 enabled_rates;
964         u8 short_retry_limit;
965         u8 long_retry_limit;
966         u8 aflags;
967         u8 reserved;
968 };
969
970 struct acx_rate_policy {
971         struct acx_header header;
972
973         u32 rate_class_cnt;
974         struct acx_rate_class rate_class[ACX_MAX_RATE_CLASSES];
975 } __attribute__ ((packed));
976
977 #define WL1271_ACX_AC_COUNT 4
978
979 struct acx_ac_cfg {
980         struct acx_header header;
981         u8 ac;
982         u8 cw_min;
983         u16 cw_max;
984         u8 aifsn;
985         u8 reserved;
986         u16 tx_op_limit;
987 } __attribute__ ((packed));
988
989 enum wl1271_acx_ac {
990         WL1271_ACX_AC_BE = 0,
991         WL1271_ACX_AC_BK = 1,
992         WL1271_ACX_AC_VI = 2,
993         WL1271_ACX_AC_VO = 3,
994         WL1271_ACX_AC_CTS2SELF = 4,
995         WL1271_ACX_AC_ANY_TID = 0x1F,
996         WL1271_ACX_AC_INVALID = 0xFF,
997 };
998
999 enum wl1271_acx_ps_scheme {
1000         WL1271_ACX_PS_SCHEME_LEGACY = 0,
1001         WL1271_ACX_PS_SCHEME_UPSD_TRIGGER = 1,
1002         WL1271_ACX_PS_SCHEME_LEGACY_PSPOLL = 2,
1003         WL1271_ACX_PS_SCHEME_SAPSD = 3,
1004 };
1005
1006 enum wl1271_acx_ack_policy {
1007         WL1271_ACX_ACK_POLICY_LEGACY = 0,
1008         WL1271_ACX_ACK_POLICY_NO_ACK = 1,
1009         WL1271_ACX_ACK_POLICY_BLOCK = 2,
1010 };
1011
1012 #define WL1271_ACX_TID_COUNT 7
1013
1014 struct acx_tid_config {
1015         struct acx_header header;
1016         u8 queue_id;
1017         u8 channel_type;
1018         u8 tsid;
1019         u8 ps_scheme;
1020         u8 ack_policy;
1021         u8 padding[3];
1022         u32 apsd_conf[2];
1023 } __attribute__ ((packed));
1024
1025 struct acx_frag_threshold {
1026         struct acx_header header;
1027         u16 frag_threshold;
1028         u8 padding[2];
1029 } __attribute__ ((packed));
1030
1031 #define WL1271_ACX_TX_COMPL_TIMEOUT   5
1032 #define WL1271_ACX_TX_COMPL_THRESHOLD 5
1033
1034 struct acx_tx_config_options {
1035         struct acx_header header;
1036         u16 tx_compl_timeout;     /* msec */
1037         u16 tx_compl_threshold;   /* number of packets */
1038 } __attribute__ ((packed));
1039
1040 #define ACX_RX_MEM_BLOCKS     64
1041 #define ACX_TX_MIN_MEM_BLOCKS 64
1042 #define ACX_TX_DESCRIPTORS    32
1043 #define ACX_NUM_SSID_PROFILES 1
1044
1045 struct wl1271_acx_config_memory {
1046         struct acx_header header;
1047
1048         u8 rx_mem_block_num;
1049         u8 tx_min_mem_block_num;
1050         u8 num_stations;
1051         u8 num_ssid_profiles;
1052         u32 total_tx_descriptors;
1053 } __attribute__ ((packed));
1054
1055 struct wl1271_acx_mem_map {
1056         struct acx_header header;
1057
1058         void *code_start;
1059         void *code_end;
1060
1061         void *wep_defkey_start;
1062         void *wep_defkey_end;
1063
1064         void *sta_table_start;
1065         void *sta_table_end;
1066
1067         void *packet_template_start;
1068         void *packet_template_end;
1069
1070         /* Address of the TX result interface (control block) */
1071         u32 tx_result;
1072         u32 tx_result_queue_start;
1073
1074         void *queue_memory_start;
1075         void *queue_memory_end;
1076
1077         u32 packet_memory_pool_start;
1078         u32 packet_memory_pool_end;
1079
1080         void *debug_buffer1_start;
1081         void *debug_buffer1_end;
1082
1083         void *debug_buffer2_start;
1084         void *debug_buffer2_end;
1085
1086         /* Number of blocks FW allocated for TX packets */
1087         u32 num_tx_mem_blocks;
1088
1089         /* Number of blocks FW allocated for RX packets */
1090         u32 num_rx_mem_blocks;
1091
1092         /* the following 4 fields are valid in SLAVE mode only */
1093         u8 *tx_cbuf;
1094         u8 *rx_cbuf;
1095         void *rx_ctrl;
1096         void *tx_ctrl;
1097 } __attribute__ ((packed));
1098
1099 enum wl1271_acx_rx_queue_type {
1100         RX_QUEUE_TYPE_RX_LOW_PRIORITY,    /* All except the high priority */
1101         RX_QUEUE_TYPE_RX_HIGH_PRIORITY,   /* Management and voice packets */
1102         RX_QUEUE_TYPE_NUM,
1103         RX_QUEUE_TYPE_MAX = USHORT_MAX
1104 };
1105
1106 #define WL1271_RX_INTR_THRESHOLD_DEF  0       /* no pacing, send interrupt on
1107                                                * every event */
1108 #define WL1271_RX_INTR_THRESHOLD_MIN  0
1109 #define WL1271_RX_INTR_THRESHOLD_MAX  15
1110
1111 #define WL1271_RX_INTR_TIMEOUT_DEF    5
1112 #define WL1271_RX_INTR_TIMEOUT_MIN    1
1113 #define WL1271_RX_INTR_TIMEOUT_MAX    100
1114
1115 struct wl1271_acx_rx_config_opt {
1116         struct acx_header header;
1117
1118         u16 mblk_threshold;
1119         u16 threshold;
1120         u16 timeout;
1121         u8 queue_type;
1122         u8 reserved;
1123 } __attribute__ ((packed));
1124
1125 enum {
1126         ACX_WAKE_UP_CONDITIONS      = 0x0002,
1127         ACX_MEM_CFG                 = 0x0003,
1128         ACX_SLOT                    = 0x0004,
1129         ACX_AC_CFG                  = 0x0007,
1130         ACX_MEM_MAP                 = 0x0008,
1131         ACX_AID                     = 0x000A,
1132         /* ACX_FW_REV is missing in the ref driver, but seems to work */
1133         ACX_FW_REV                  = 0x000D,
1134         ACX_MEDIUM_USAGE            = 0x000F,
1135         ACX_RX_CFG                  = 0x0010,
1136         ACX_TX_QUEUE_CFG            = 0x0011, /* FIXME: only used by wl1251 */
1137         ACX_STATISTICS              = 0x0013, /* Debug API */
1138         ACX_PWR_CONSUMPTION_STATISTICS = 0x0014,
1139         ACX_FEATURE_CFG             = 0x0015,
1140         ACX_TID_CFG                 = 0x001A,
1141         ACX_PS_RX_STREAMING         = 0x001B,
1142         ACX_BEACON_FILTER_OPT       = 0x001F,
1143         ACX_NOISE_HIST              = 0x0021,
1144         ACX_HDK_VERSION             = 0x0022, /* ??? */
1145         ACX_PD_THRESHOLD            = 0x0023,
1146         ACX_TX_CONFIG_OPT           = 0x0024,
1147         ACX_CCA_THRESHOLD           = 0x0025,
1148         ACX_EVENT_MBOX_MASK         = 0x0026,
1149         ACX_CONN_MONIT_PARAMS       = 0x002D,
1150         ACX_CONS_TX_FAILURE         = 0x002F,
1151         ACX_BCN_DTIM_OPTIONS        = 0x0031,
1152         ACX_SG_ENABLE               = 0x0032,
1153         ACX_SG_CFG                  = 0x0033,
1154         ACX_BEACON_FILTER_TABLE     = 0x0038,
1155         ACX_ARP_IP_FILTER           = 0x0039,
1156         ACX_ROAMING_STATISTICS_TBL  = 0x003B,
1157         ACX_RATE_POLICY             = 0x003D,
1158         ACX_CTS_PROTECTION          = 0x003E,
1159         ACX_SLEEP_AUTH              = 0x003F,
1160         ACX_PREAMBLE_TYPE           = 0x0040,
1161         ACX_ERROR_CNT               = 0x0041,
1162         ACX_IBSS_FILTER             = 0x0044,
1163         ACX_SERVICE_PERIOD_TIMEOUT  = 0x0045,
1164         ACX_TSF_INFO                = 0x0046,
1165         ACX_CONFIG_PS_WMM           = 0x0049,
1166         ACX_ENABLE_RX_DATA_FILTER   = 0x004A,
1167         ACX_SET_RX_DATA_FILTER      = 0x004B,
1168         ACX_GET_DATA_FILTER_STATISTICS = 0x004C,
1169         ACX_RX_CONFIG_OPT           = 0x004E,
1170         ACX_FRAG_CFG                = 0x004F,
1171         ACX_BET_ENABLE              = 0x0050,
1172         ACX_RSSI_SNR_TRIGGER        = 0x0051,
1173         ACX_RSSI_SNR_WEIGHTS        = 0x0051,
1174         ACX_KEEP_ALIVE_MODE         = 0x0052,
1175         ACX_SET_KEEP_ALIVE_CONFIG   = 0x0054,
1176         ACX_BA_SESSION_RESPONDER_POLICY = 0x0055,
1177         ACX_BA_SESSION_INITIATOR_POLICY = 0x0056,
1178         ACX_PEER_HT_CAP             = 0x0057,
1179         ACX_HT_BSS_OPERATION        = 0x0058,
1180         ACX_COEX_ACTIVITY           = 0x0059,
1181         DOT11_RX_MSDU_LIFE_TIME     = 0x1004,
1182         DOT11_CUR_TX_PWR            = 0x100D,
1183         DOT11_RX_DOT11_MODE         = 0x1012,
1184         DOT11_RTS_THRESHOLD         = 0x1013,
1185         DOT11_GROUP_ADDRESS_TBL     = 0x1014,
1186
1187         MAX_DOT11_IE = DOT11_GROUP_ADDRESS_TBL,
1188
1189         MAX_IE = 0xFFFF
1190 };
1191
1192
1193 int wl1271_acx_wake_up_conditions(struct wl1271 *wl, u8 wake_up_event,
1194                                   u8 listen_interval);
1195 int wl1271_acx_sleep_auth(struct wl1271 *wl, u8 sleep_auth);
1196 int wl1271_acx_fw_version(struct wl1271 *wl, char *buf, size_t len);
1197 int wl1271_acx_tx_power(struct wl1271 *wl, int power);
1198 int wl1271_acx_feature_cfg(struct wl1271 *wl);
1199 int wl1271_acx_mem_map(struct wl1271 *wl,
1200                        struct acx_header *mem_map, size_t len);
1201 int wl1271_acx_rx_msdu_life_time(struct wl1271 *wl, u32 life_time);
1202 int wl1271_acx_rx_config(struct wl1271 *wl, u32 config, u32 filter);
1203 int wl1271_acx_pd_threshold(struct wl1271 *wl);
1204 int wl1271_acx_slot(struct wl1271 *wl, enum acx_slot_type slot_time);
1205 int wl1271_acx_group_address_tbl(struct wl1271 *wl, bool enable,
1206                                  void *mc_list, u32 mc_list_len);
1207 int wl1271_acx_service_period_timeout(struct wl1271 *wl);
1208 int wl1271_acx_rts_threshold(struct wl1271 *wl, u16 rts_threshold);
1209 int wl1271_acx_beacon_filter_opt(struct wl1271 *wl);
1210 int wl1271_acx_beacon_filter_table(struct wl1271 *wl);
1211 int wl1271_acx_conn_monit_params(struct wl1271 *wl);
1212 int wl1271_acx_sg_enable(struct wl1271 *wl);
1213 int wl1271_acx_sg_cfg(struct wl1271 *wl);
1214 int wl1271_acx_cca_threshold(struct wl1271 *wl);
1215 int wl1271_acx_bcn_dtim_options(struct wl1271 *wl);
1216 int wl1271_acx_aid(struct wl1271 *wl, u16 aid);
1217 int wl1271_acx_event_mbox_mask(struct wl1271 *wl, u32 event_mask);
1218 int wl1271_acx_set_preamble(struct wl1271 *wl, enum acx_preamble_type preamble);
1219 int wl1271_acx_cts_protect(struct wl1271 *wl,
1220                             enum acx_ctsprotect_type ctsprotect);
1221 int wl1271_acx_statistics(struct wl1271 *wl, struct acx_statistics *stats);
1222 int wl1271_acx_rate_policies(struct wl1271 *wl, u32 enabled_rates);
1223 int wl1271_acx_ac_cfg(struct wl1271 *wl);
1224 int wl1271_acx_tid_cfg(struct wl1271 *wl);
1225 int wl1271_acx_frag_threshold(struct wl1271 *wl);
1226 int wl1271_acx_tx_config_options(struct wl1271 *wl);
1227 int wl1271_acx_mem_cfg(struct wl1271 *wl);
1228 int wl1271_acx_init_mem_config(struct wl1271 *wl);
1229 int wl1271_acx_init_rx_interrupt(struct wl1271 *wl);
1230
1231 #endif /* __WL1271_ACX_H__ */