wl1271: Add config structure for TX path parameters
[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 struct acx_rx_timeout {
318         struct acx_header header;
319
320         u16 ps_poll_timeout;
321         u16 upsd_timeout;
322 } __attribute__ ((packed));
323
324 struct acx_rts_threshold {
325         struct acx_header header;
326
327         u16 threshold;
328         u8 pad[2];
329 } __attribute__ ((packed));
330
331 struct acx_beacon_filter_option {
332         struct acx_header header;
333
334         u8 enable;
335
336         /*
337          * The number of beacons without the unicast TIM
338          * bit set that the firmware buffers before
339          * signaling the host about ready frames.
340          * When set to 0 and the filter is enabled, beacons
341          * without the unicast TIM bit set are dropped.
342          */
343         u8 max_num_beacons;
344         u8 pad[2];
345 } __attribute__ ((packed));
346
347 /*
348  * ACXBeaconFilterEntry (not 221)
349  * Byte Offset     Size (Bytes)    Definition
350  * ===========     ============    ==========
351  * 0                            1               IE identifier
352  * 1               1               Treatment bit mask
353  *
354  * ACXBeaconFilterEntry (221)
355  * Byte Offset     Size (Bytes)    Definition
356  * ===========     ============    ==========
357  * 0               1               IE identifier
358  * 1               1               Treatment bit mask
359  * 2               3               OUI
360  * 5               1               Type
361  * 6               2               Version
362  *
363  *
364  * Treatment bit mask - The information element handling:
365  * bit 0 - The information element is compared and transferred
366  * in case of change.
367  * bit 1 - The information element is transferred to the host
368  * with each appearance or disappearance.
369  * Note that both bits can be set at the same time.
370  */
371 #define BEACON_FILTER_TABLE_MAX_IE_NUM                 (32)
372 #define BEACON_FILTER_TABLE_MAX_VENDOR_SPECIFIC_IE_NUM (6)
373 #define BEACON_FILTER_TABLE_IE_ENTRY_SIZE              (2)
374 #define BEACON_FILTER_TABLE_EXTRA_VENDOR_SPECIFIC_IE_SIZE (6)
375 #define BEACON_FILTER_TABLE_MAX_SIZE ((BEACON_FILTER_TABLE_MAX_IE_NUM * \
376                             BEACON_FILTER_TABLE_IE_ENTRY_SIZE) + \
377                            (BEACON_FILTER_TABLE_MAX_VENDOR_SPECIFIC_IE_NUM * \
378                             BEACON_FILTER_TABLE_EXTRA_VENDOR_SPECIFIC_IE_SIZE))
379
380 #define BEACON_RULE_PASS_ON_CHANGE                     BIT(0)
381 #define BEACON_RULE_PASS_ON_APPEARANCE                 BIT(1)
382
383 #define BEACON_FILTER_IE_ID_CHANNEL_SWITCH_ANN         (37)
384
385 struct acx_beacon_filter_ie_table {
386         struct acx_header header;
387
388         u8 num_ie;
389         u8 table[BEACON_FILTER_TABLE_MAX_SIZE];
390         u8 pad[3];
391 } __attribute__ ((packed));
392
393 #define SYNCH_FAIL_DEFAULT_THRESHOLD    5     /* number of beacons */
394 #define NO_BEACON_DEFAULT_TIMEOUT       (100) /* TU */
395
396 struct acx_conn_monit_params {
397        struct acx_header header;
398
399        u32 synch_fail_thold; /* number of beacons missed */
400        u32 bss_lose_timeout; /* number of TU's from synch fail */
401 };
402
403 enum {
404         SG_ENABLE = 0,
405         SG_DISABLE,
406         SG_SENSE_NO_ACTIVITY,
407         SG_SENSE_ACTIVE
408 };
409
410 struct acx_bt_wlan_coex {
411         struct acx_header header;
412
413         /*
414          * 0 -> PTA enabled
415          * 1 -> PTA disabled
416          * 2 -> sense no active mode, i.e.
417          *      an interrupt is sent upon
418          *      BT activity.
419          * 3 -> PTA is switched on in response
420          *      to the interrupt sending.
421          */
422         u8 enable;
423         u8 pad[3];
424 } __attribute__ ((packed));
425
426 struct acx_smart_reflex_state {
427         struct acx_header header;
428
429         u8 enable;
430         u8 padding[3];
431 };
432
433 struct smart_reflex_err_table {
434         u8 len;
435         s8 upper_limit;
436         s8 values[14];
437 };
438
439 struct acx_smart_reflex_config_params {
440         struct acx_header header;
441
442         struct smart_reflex_err_table error_table[3];
443 };
444
445 #define PTA_ANTENNA_TYPE_DEF              (0)
446 #define PTA_BT_HP_MAXTIME_DEF             (2000)
447 #define PTA_WLAN_HP_MAX_TIME_DEF          (5000)
448 #define PTA_SENSE_DISABLE_TIMER_DEF       (1350)
449 #define PTA_PROTECTIVE_RX_TIME_DEF        (1500)
450 #define PTA_PROTECTIVE_TX_TIME_DEF        (1500)
451 #define PTA_TIMEOUT_NEXT_BT_LP_PACKET_DEF (3000)
452 #define PTA_SIGNALING_TYPE_DEF            (1)
453 #define PTA_AFH_LEVERAGE_ON_DEF           (0)
454 #define PTA_NUMBER_QUIET_CYCLE_DEF        (0)
455 #define PTA_MAX_NUM_CTS_DEF               (3)
456 #define PTA_NUMBER_OF_WLAN_PACKETS_DEF    (2)
457 #define PTA_NUMBER_OF_BT_PACKETS_DEF      (2)
458 #define PTA_PROTECTIVE_RX_TIME_FAST_DEF   (1500)
459 #define PTA_PROTECTIVE_TX_TIME_FAST_DEF   (3000)
460 #define PTA_CYCLE_TIME_FAST_DEF           (8700)
461 #define PTA_RX_FOR_AVALANCHE_DEF          (5)
462 #define PTA_ELP_HP_DEF                    (0)
463 #define PTA_ANTI_STARVE_PERIOD_DEF        (500)
464 #define PTA_ANTI_STARVE_NUM_CYCLE_DEF     (4)
465 #define PTA_ALLOW_PA_SD_DEF               (1)
466 #define PTA_TIME_BEFORE_BEACON_DEF        (6300)
467 #define PTA_HPDM_MAX_TIME_DEF             (1600)
468 #define PTA_TIME_OUT_NEXT_WLAN_DEF        (2550)
469 #define PTA_AUTO_MODE_NO_CTS_DEF          (0)
470 #define PTA_BT_HP_RESPECTED_DEF           (3)
471 #define PTA_WLAN_RX_MIN_RATE_DEF          (24)
472 #define PTA_ACK_MODE_DEF                  (1)
473
474 struct acx_bt_wlan_coex_param {
475         struct acx_header header;
476
477         u32 per_threshold;
478         u32 max_scan_compensation_time;
479         u16 nfs_sample_interval;
480         u8 load_ratio;
481         u8 auto_ps_mode;
482         u8 probe_req_compensation;
483         u8 scan_window_compensation;
484         u8 antenna_config;
485         u8 beacon_miss_threshold;
486         u32 rate_adaptation_threshold;
487         s8 rate_adaptation_snr;
488         u8 padding[3];
489 } __attribute__ ((packed));
490
491 struct acx_energy_detection {
492         struct acx_header header;
493
494         /* The RX Clear Channel Assessment threshold in the PHY */
495         u16 rx_cca_threshold;
496         u8 tx_energy_detection;
497         u8 pad;
498 } __attribute__ ((packed));
499
500 #define BCN_RX_TIMEOUT_DEF_VALUE        10000
501 #define BROADCAST_RX_TIMEOUT_DEF_VALUE  20000
502 #define RX_BROADCAST_IN_PS_DEF_VALUE    1
503 #define CONSECUTIVE_PS_POLL_FAILURE_DEF 4
504
505 struct acx_beacon_broadcast {
506         struct acx_header header;
507
508         u16 beacon_rx_timeout;
509         u16 broadcast_timeout;
510
511         /* Enables receiving of broadcast packets in PS mode */
512         u8 rx_broadcast_in_ps;
513
514         /* Consecutive PS Poll failures before updating the host */
515         u8 ps_poll_threshold;
516         u8 pad[2];
517 } __attribute__ ((packed));
518
519 struct acx_event_mask {
520         struct acx_header header;
521
522         u32 event_mask;
523         u32 high_event_mask; /* Unused */
524 } __attribute__ ((packed));
525
526 #define CFG_RX_FCS              BIT(2)
527 #define CFG_RX_ALL_GOOD         BIT(3)
528 #define CFG_UNI_FILTER_EN       BIT(4)
529 #define CFG_BSSID_FILTER_EN     BIT(5)
530 #define CFG_MC_FILTER_EN        BIT(6)
531 #define CFG_MC_ADDR0_EN         BIT(7)
532 #define CFG_MC_ADDR1_EN         BIT(8)
533 #define CFG_BC_REJECT_EN        BIT(9)
534 #define CFG_SSID_FILTER_EN      BIT(10)
535 #define CFG_RX_INT_FCS_ERROR    BIT(11)
536 #define CFG_RX_INT_ENCRYPTED    BIT(12)
537 #define CFG_RX_WR_RX_STATUS     BIT(13)
538 #define CFG_RX_FILTER_NULTI     BIT(14)
539 #define CFG_RX_RESERVE          BIT(15)
540 #define CFG_RX_TIMESTAMP_TSF    BIT(16)
541
542 #define CFG_RX_RSV_EN           BIT(0)
543 #define CFG_RX_RCTS_ACK         BIT(1)
544 #define CFG_RX_PRSP_EN          BIT(2)
545 #define CFG_RX_PREQ_EN          BIT(3)
546 #define CFG_RX_MGMT_EN          BIT(4)
547 #define CFG_RX_FCS_ERROR        BIT(5)
548 #define CFG_RX_DATA_EN          BIT(6)
549 #define CFG_RX_CTL_EN           BIT(7)
550 #define CFG_RX_CF_EN            BIT(8)
551 #define CFG_RX_BCN_EN           BIT(9)
552 #define CFG_RX_AUTH_EN          BIT(10)
553 #define CFG_RX_ASSOC_EN         BIT(11)
554
555 #define SCAN_PASSIVE            BIT(0)
556 #define SCAN_5GHZ_BAND          BIT(1)
557 #define SCAN_TRIGGERED          BIT(2)
558 #define SCAN_PRIORITY_HIGH      BIT(3)
559
560 /* When set, disable HW encryption */
561 #define DF_ENCRYPTION_DISABLE      0x01
562 #define DF_SNIFF_MODE_ENABLE       0x80
563
564 struct acx_feature_config {
565         struct acx_header header;
566
567         u32 options;
568         u32 data_flow_options;
569 } __attribute__ ((packed));
570
571 struct acx_current_tx_power {
572         struct acx_header header;
573
574         u8  current_tx_power;
575         u8  padding[3];
576 } __attribute__ ((packed));
577
578 enum acx_wake_up_event {
579         WAKE_UP_EVENT_BEACON_BITMAP     = 0x01, /* Wake on every Beacon*/
580         WAKE_UP_EVENT_DTIM_BITMAP       = 0x02, /* Wake on every DTIM*/
581         WAKE_UP_EVENT_N_DTIM_BITMAP     = 0x04, /* Wake on every Nth DTIM */
582         WAKE_UP_EVENT_N_BEACONS_BITMAP  = 0x08, /* Wake on every Nth Beacon */
583         WAKE_UP_EVENT_BITS_MASK         = 0x0F
584 };
585
586 struct acx_wake_up_condition {
587         struct acx_header header;
588
589         u8 wake_up_event; /* Only one bit can be set */
590         u8 listen_interval;
591         u8 pad[2];
592 } __attribute__ ((packed));
593
594 struct acx_aid {
595         struct acx_header header;
596
597         /*
598          * To be set when associated with an AP.
599          */
600         u16 aid;
601         u8 pad[2];
602 } __attribute__ ((packed));
603
604 enum acx_preamble_type {
605         ACX_PREAMBLE_LONG = 0,
606         ACX_PREAMBLE_SHORT = 1
607 };
608
609 struct acx_preamble {
610         struct acx_header header;
611
612         /*
613          * When set, the WiLink transmits the frames with a short preamble and
614          * when cleared, the WiLink transmits the frames with a long preamble.
615          */
616         u8 preamble;
617         u8 padding[3];
618 } __attribute__ ((packed));
619
620 enum acx_ctsprotect_type {
621         CTSPROTECT_DISABLE = 0,
622         CTSPROTECT_ENABLE = 1
623 };
624
625 struct acx_ctsprotect {
626         struct acx_header header;
627         u8 ctsprotect;
628         u8 padding[3];
629 } __attribute__ ((packed));
630
631 struct acx_tx_statistics {
632         u32 internal_desc_overflow;
633 }  __attribute__ ((packed));
634
635 struct acx_rx_statistics {
636         u32 out_of_mem;
637         u32 hdr_overflow;
638         u32 hw_stuck;
639         u32 dropped;
640         u32 fcs_err;
641         u32 xfr_hint_trig;
642         u32 path_reset;
643         u32 reset_counter;
644 } __attribute__ ((packed));
645
646 struct acx_dma_statistics {
647         u32 rx_requested;
648         u32 rx_errors;
649         u32 tx_requested;
650         u32 tx_errors;
651 }  __attribute__ ((packed));
652
653 struct acx_isr_statistics {
654         /* host command complete */
655         u32 cmd_cmplt;
656
657         /* fiqisr() */
658         u32 fiqs;
659
660         /* (INT_STS_ND & INT_TRIG_RX_HEADER) */
661         u32 rx_headers;
662
663         /* (INT_STS_ND & INT_TRIG_RX_CMPLT) */
664         u32 rx_completes;
665
666         /* (INT_STS_ND & INT_TRIG_NO_RX_BUF) */
667         u32 rx_mem_overflow;
668
669         /* (INT_STS_ND & INT_TRIG_S_RX_RDY) */
670         u32 rx_rdys;
671
672         /* irqisr() */
673         u32 irqs;
674
675         /* (INT_STS_ND & INT_TRIG_TX_PROC) */
676         u32 tx_procs;
677
678         /* (INT_STS_ND & INT_TRIG_DECRYPT_DONE) */
679         u32 decrypt_done;
680
681         /* (INT_STS_ND & INT_TRIG_DMA0) */
682         u32 dma0_done;
683
684         /* (INT_STS_ND & INT_TRIG_DMA1) */
685         u32 dma1_done;
686
687         /* (INT_STS_ND & INT_TRIG_TX_EXC_CMPLT) */
688         u32 tx_exch_complete;
689
690         /* (INT_STS_ND & INT_TRIG_COMMAND) */
691         u32 commands;
692
693         /* (INT_STS_ND & INT_TRIG_RX_PROC) */
694         u32 rx_procs;
695
696         /* (INT_STS_ND & INT_TRIG_PM_802) */
697         u32 hw_pm_mode_changes;
698
699         /* (INT_STS_ND & INT_TRIG_ACKNOWLEDGE) */
700         u32 host_acknowledges;
701
702         /* (INT_STS_ND & INT_TRIG_PM_PCI) */
703         u32 pci_pm;
704
705         /* (INT_STS_ND & INT_TRIG_ACM_WAKEUP) */
706         u32 wakeups;
707
708         /* (INT_STS_ND & INT_TRIG_LOW_RSSI) */
709         u32 low_rssi;
710 } __attribute__ ((packed));
711
712 struct acx_wep_statistics {
713         /* WEP address keys configured */
714         u32 addr_key_count;
715
716         /* default keys configured */
717         u32 default_key_count;
718
719         u32 reserved;
720
721         /* number of times that WEP key not found on lookup */
722         u32 key_not_found;
723
724         /* number of times that WEP key decryption failed */
725         u32 decrypt_fail;
726
727         /* WEP packets decrypted */
728         u32 packets;
729
730         /* WEP decrypt interrupts */
731         u32 interrupt;
732 } __attribute__ ((packed));
733
734 #define ACX_MISSED_BEACONS_SPREAD 10
735
736 struct acx_pwr_statistics {
737         /* the amount of enters into power save mode (both PD & ELP) */
738         u32 ps_enter;
739
740         /* the amount of enters into ELP mode */
741         u32 elp_enter;
742
743         /* the amount of missing beacon interrupts to the host */
744         u32 missing_bcns;
745
746         /* the amount of wake on host-access times */
747         u32 wake_on_host;
748
749         /* the amount of wake on timer-expire */
750         u32 wake_on_timer_exp;
751
752         /* the number of packets that were transmitted with PS bit set */
753         u32 tx_with_ps;
754
755         /* the number of packets that were transmitted with PS bit clear */
756         u32 tx_without_ps;
757
758         /* the number of received beacons */
759         u32 rcvd_beacons;
760
761         /* the number of entering into PowerOn (power save off) */
762         u32 power_save_off;
763
764         /* the number of entries into power save mode */
765         u16 enable_ps;
766
767         /*
768          * the number of exits from power save, not including failed PS
769          * transitions
770          */
771         u16 disable_ps;
772
773         /*
774          * the number of times the TSF counter was adjusted because
775          * of drift
776          */
777         u32 fix_tsf_ps;
778
779         /* Gives statistics about the spread continuous missed beacons.
780          * The 16 LSB are dedicated for the PS mode.
781          * The 16 MSB are dedicated for the PS mode.
782          * cont_miss_bcns_spread[0] - single missed beacon.
783          * cont_miss_bcns_spread[1] - two continuous missed beacons.
784          * cont_miss_bcns_spread[2] - three continuous missed beacons.
785          * ...
786          * cont_miss_bcns_spread[9] - ten and more continuous missed beacons.
787         */
788         u32 cont_miss_bcns_spread[ACX_MISSED_BEACONS_SPREAD];
789
790         /* the number of beacons in awake mode */
791         u32 rcvd_awake_beacons;
792 } __attribute__ ((packed));
793
794 struct acx_mic_statistics {
795         u32 rx_pkts;
796         u32 calc_failure;
797 } __attribute__ ((packed));
798
799 struct acx_aes_statistics {
800         u32 encrypt_fail;
801         u32 decrypt_fail;
802         u32 encrypt_packets;
803         u32 decrypt_packets;
804         u32 encrypt_interrupt;
805         u32 decrypt_interrupt;
806 } __attribute__ ((packed));
807
808 struct acx_event_statistics {
809         u32 heart_beat;
810         u32 calibration;
811         u32 rx_mismatch;
812         u32 rx_mem_empty;
813         u32 rx_pool;
814         u32 oom_late;
815         u32 phy_transmit_error;
816         u32 tx_stuck;
817 } __attribute__ ((packed));
818
819 struct acx_ps_statistics {
820         u32 pspoll_timeouts;
821         u32 upsd_timeouts;
822         u32 upsd_max_sptime;
823         u32 upsd_max_apturn;
824         u32 pspoll_max_apturn;
825         u32 pspoll_utilization;
826         u32 upsd_utilization;
827 } __attribute__ ((packed));
828
829 struct acx_rxpipe_statistics {
830         u32 rx_prep_beacon_drop;
831         u32 descr_host_int_trig_rx_data;
832         u32 beacon_buffer_thres_host_int_trig_rx_data;
833         u32 missed_beacon_host_int_trig_rx_data;
834         u32 tx_xfr_host_int_trig_rx_data;
835 } __attribute__ ((packed));
836
837 struct acx_statistics {
838         struct acx_header header;
839
840         struct acx_tx_statistics tx;
841         struct acx_rx_statistics rx;
842         struct acx_dma_statistics dma;
843         struct acx_isr_statistics isr;
844         struct acx_wep_statistics wep;
845         struct acx_pwr_statistics pwr;
846         struct acx_aes_statistics aes;
847         struct acx_mic_statistics mic;
848         struct acx_event_statistics event;
849         struct acx_ps_statistics ps;
850         struct acx_rxpipe_statistics rxpipe;
851 } __attribute__ ((packed));
852
853 struct acx_rate_class {
854         u32 enabled_rates;
855         u8 short_retry_limit;
856         u8 long_retry_limit;
857         u8 aflags;
858         u8 reserved;
859 };
860
861 struct acx_rate_policy {
862         struct acx_header header;
863
864         u32 rate_class_cnt;
865         struct acx_rate_class rate_class[CONF_TX_MAX_RATE_CLASSES];
866 } __attribute__ ((packed));
867
868 struct acx_ac_cfg {
869         struct acx_header header;
870         u8 ac;
871         u8 cw_min;
872         u16 cw_max;
873         u8 aifsn;
874         u8 reserved;
875         u16 tx_op_limit;
876 } __attribute__ ((packed));
877
878 struct acx_tid_config {
879         struct acx_header header;
880         u8 queue_id;
881         u8 channel_type;
882         u8 tsid;
883         u8 ps_scheme;
884         u8 ack_policy;
885         u8 padding[3];
886         u32 apsd_conf[2];
887 } __attribute__ ((packed));
888
889 struct acx_frag_threshold {
890         struct acx_header header;
891         u16 frag_threshold;
892         u8 padding[2];
893 } __attribute__ ((packed));
894
895 struct acx_tx_config_options {
896         struct acx_header header;
897         u16 tx_compl_timeout;     /* msec */
898         u16 tx_compl_threshold;   /* number of packets */
899 } __attribute__ ((packed));
900
901 #define ACX_RX_MEM_BLOCKS     64
902 #define ACX_TX_MIN_MEM_BLOCKS 64
903 #define ACX_TX_DESCRIPTORS    32
904 #define ACX_NUM_SSID_PROFILES 1
905
906 struct wl1271_acx_config_memory {
907         struct acx_header header;
908
909         u8 rx_mem_block_num;
910         u8 tx_min_mem_block_num;
911         u8 num_stations;
912         u8 num_ssid_profiles;
913         u32 total_tx_descriptors;
914 } __attribute__ ((packed));
915
916 struct wl1271_acx_mem_map {
917         struct acx_header header;
918
919         void *code_start;
920         void *code_end;
921
922         void *wep_defkey_start;
923         void *wep_defkey_end;
924
925         void *sta_table_start;
926         void *sta_table_end;
927
928         void *packet_template_start;
929         void *packet_template_end;
930
931         /* Address of the TX result interface (control block) */
932         u32 tx_result;
933         u32 tx_result_queue_start;
934
935         void *queue_memory_start;
936         void *queue_memory_end;
937
938         u32 packet_memory_pool_start;
939         u32 packet_memory_pool_end;
940
941         void *debug_buffer1_start;
942         void *debug_buffer1_end;
943
944         void *debug_buffer2_start;
945         void *debug_buffer2_end;
946
947         /* Number of blocks FW allocated for TX packets */
948         u32 num_tx_mem_blocks;
949
950         /* Number of blocks FW allocated for RX packets */
951         u32 num_rx_mem_blocks;
952
953         /* the following 4 fields are valid in SLAVE mode only */
954         u8 *tx_cbuf;
955         u8 *rx_cbuf;
956         void *rx_ctrl;
957         void *tx_ctrl;
958 } __attribute__ ((packed));
959
960 struct wl1271_acx_rx_config_opt {
961         struct acx_header header;
962
963         u16 mblk_threshold;
964         u16 threshold;
965         u16 timeout;
966         u8 queue_type;
967         u8 reserved;
968 } __attribute__ ((packed));
969
970 enum {
971         ACX_WAKE_UP_CONDITIONS      = 0x0002,
972         ACX_MEM_CFG                 = 0x0003,
973         ACX_SLOT                    = 0x0004,
974         ACX_AC_CFG                  = 0x0007,
975         ACX_MEM_MAP                 = 0x0008,
976         ACX_AID                     = 0x000A,
977         /* ACX_FW_REV is missing in the ref driver, but seems to work */
978         ACX_FW_REV                  = 0x000D,
979         ACX_MEDIUM_USAGE            = 0x000F,
980         ACX_RX_CFG                  = 0x0010,
981         ACX_TX_QUEUE_CFG            = 0x0011, /* FIXME: only used by wl1251 */
982         ACX_STATISTICS              = 0x0013, /* Debug API */
983         ACX_PWR_CONSUMPTION_STATISTICS = 0x0014,
984         ACX_FEATURE_CFG             = 0x0015,
985         ACX_TID_CFG                 = 0x001A,
986         ACX_PS_RX_STREAMING         = 0x001B,
987         ACX_BEACON_FILTER_OPT       = 0x001F,
988         ACX_NOISE_HIST              = 0x0021,
989         ACX_HDK_VERSION             = 0x0022, /* ??? */
990         ACX_PD_THRESHOLD            = 0x0023,
991         ACX_TX_CONFIG_OPT           = 0x0024,
992         ACX_CCA_THRESHOLD           = 0x0025,
993         ACX_EVENT_MBOX_MASK         = 0x0026,
994         ACX_CONN_MONIT_PARAMS       = 0x002D,
995         ACX_CONS_TX_FAILURE         = 0x002F,
996         ACX_BCN_DTIM_OPTIONS        = 0x0031,
997         ACX_SG_ENABLE               = 0x0032,
998         ACX_SG_CFG                  = 0x0033,
999         ACX_BEACON_FILTER_TABLE     = 0x0038,
1000         ACX_ARP_IP_FILTER           = 0x0039,
1001         ACX_ROAMING_STATISTICS_TBL  = 0x003B,
1002         ACX_RATE_POLICY             = 0x003D,
1003         ACX_CTS_PROTECTION          = 0x003E,
1004         ACX_SLEEP_AUTH              = 0x003F,
1005         ACX_PREAMBLE_TYPE           = 0x0040,
1006         ACX_ERROR_CNT               = 0x0041,
1007         ACX_IBSS_FILTER             = 0x0044,
1008         ACX_SERVICE_PERIOD_TIMEOUT  = 0x0045,
1009         ACX_TSF_INFO                = 0x0046,
1010         ACX_CONFIG_PS_WMM           = 0x0049,
1011         ACX_ENABLE_RX_DATA_FILTER   = 0x004A,
1012         ACX_SET_RX_DATA_FILTER      = 0x004B,
1013         ACX_GET_DATA_FILTER_STATISTICS = 0x004C,
1014         ACX_RX_CONFIG_OPT           = 0x004E,
1015         ACX_FRAG_CFG                = 0x004F,
1016         ACX_BET_ENABLE              = 0x0050,
1017         ACX_RSSI_SNR_TRIGGER        = 0x0051,
1018         ACX_RSSI_SNR_WEIGHTS        = 0x0051,
1019         ACX_KEEP_ALIVE_MODE         = 0x0052,
1020         ACX_SET_KEEP_ALIVE_CONFIG   = 0x0054,
1021         ACX_BA_SESSION_RESPONDER_POLICY = 0x0055,
1022         ACX_BA_SESSION_INITIATOR_POLICY = 0x0056,
1023         ACX_PEER_HT_CAP             = 0x0057,
1024         ACX_HT_BSS_OPERATION        = 0x0058,
1025         ACX_COEX_ACTIVITY           = 0x0059,
1026         ACX_SET_SMART_REFLEX_DEBUG  = 0x005A,
1027         ACX_SET_SMART_REFLEX_STATE  = 0x005B,
1028         ACX_SET_SMART_REFLEX_PARAMS = 0x005F,
1029         DOT11_RX_MSDU_LIFE_TIME     = 0x1004,
1030         DOT11_CUR_TX_PWR            = 0x100D,
1031         DOT11_RX_DOT11_MODE         = 0x1012,
1032         DOT11_RTS_THRESHOLD         = 0x1013,
1033         DOT11_GROUP_ADDRESS_TBL     = 0x1014,
1034
1035         MAX_DOT11_IE = DOT11_GROUP_ADDRESS_TBL,
1036
1037         MAX_IE = 0xFFFF
1038 };
1039
1040
1041 int wl1271_acx_wake_up_conditions(struct wl1271 *wl, u8 wake_up_event,
1042                                   u8 listen_interval);
1043 int wl1271_acx_sleep_auth(struct wl1271 *wl, u8 sleep_auth);
1044 int wl1271_acx_fw_version(struct wl1271 *wl, char *buf, size_t len);
1045 int wl1271_acx_tx_power(struct wl1271 *wl, int power);
1046 int wl1271_acx_feature_cfg(struct wl1271 *wl);
1047 int wl1271_acx_mem_map(struct wl1271 *wl,
1048                        struct acx_header *mem_map, size_t len);
1049 int wl1271_acx_rx_msdu_life_time(struct wl1271 *wl);
1050 int wl1271_acx_rx_config(struct wl1271 *wl, u32 config, u32 filter);
1051 int wl1271_acx_pd_threshold(struct wl1271 *wl);
1052 int wl1271_acx_slot(struct wl1271 *wl, enum acx_slot_type slot_time);
1053 int wl1271_acx_group_address_tbl(struct wl1271 *wl, bool enable,
1054                                  void *mc_list, u32 mc_list_len);
1055 int wl1271_acx_service_period_timeout(struct wl1271 *wl);
1056 int wl1271_acx_rts_threshold(struct wl1271 *wl, u16 rts_threshold);
1057 int wl1271_acx_beacon_filter_opt(struct wl1271 *wl, bool enable_filter);
1058 int wl1271_acx_beacon_filter_table(struct wl1271 *wl);
1059 int wl1271_acx_conn_monit_params(struct wl1271 *wl);
1060 int wl1271_acx_sg_enable(struct wl1271 *wl);
1061 int wl1271_acx_sg_cfg(struct wl1271 *wl);
1062 int wl1271_acx_cca_threshold(struct wl1271 *wl);
1063 int wl1271_acx_bcn_dtim_options(struct wl1271 *wl);
1064 int wl1271_acx_aid(struct wl1271 *wl, u16 aid);
1065 int wl1271_acx_event_mbox_mask(struct wl1271 *wl, u32 event_mask);
1066 int wl1271_acx_set_preamble(struct wl1271 *wl, enum acx_preamble_type preamble);
1067 int wl1271_acx_cts_protect(struct wl1271 *wl,
1068                             enum acx_ctsprotect_type ctsprotect);
1069 int wl1271_acx_statistics(struct wl1271 *wl, struct acx_statistics *stats);
1070 int wl1271_acx_rate_policies(struct wl1271 *wl, u32 enabled_rates);
1071 int wl1271_acx_ac_cfg(struct wl1271 *wl);
1072 int wl1271_acx_tid_cfg(struct wl1271 *wl);
1073 int wl1271_acx_frag_threshold(struct wl1271 *wl);
1074 int wl1271_acx_tx_config_options(struct wl1271 *wl);
1075 int wl1271_acx_mem_cfg(struct wl1271 *wl);
1076 int wl1271_acx_init_mem_config(struct wl1271 *wl);
1077 int wl1271_acx_init_rx_interrupt(struct wl1271 *wl);
1078 int wl1271_acx_smart_reflex(struct wl1271 *wl);
1079
1080 #endif /* __WL1271_ACX_H__ */