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