2 * This file is part of wl1271
4 * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
5 * Copyright (C) 2008-2009 Nokia Corporation
7 * Contact: Luciano Coelho <luciano.coelho@nokia.com>
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.
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.
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
25 #ifndef __WL1271_ACX_H__
26 #define __WL1271_ACX_H__
29 #include "wl1271_cmd.h"
31 /*************************************************************************
33 Host Interrupt Register (WiLink -> Host)
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)
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 | \
64 #define WL1271_INTR_MASK (WL1271_ACX_INTR_EVENT_A | \
65 WL1271_ACX_INTR_EVENT_B | \
68 /* Target's information element */
70 struct wl1271_cmd_header cmd;
72 /* acx (or information element) header */
75 /* payload length (not including headers */
79 struct acx_error_counter {
80 struct acx_header header;
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.*/
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.*/
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.*/
97 /* the number of missed sequence numbers in the squentially */
98 /* values of frames seq numbers */
100 } __attribute__ ((packed));
102 struct acx_revision {
103 struct acx_header header;
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.
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.
129 } __attribute__ ((packed));
131 enum wl1271_psm_mode {
135 /* Power save mode */
138 /* Extreme low power */
142 struct acx_sleep_auth {
143 struct acx_header header;
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*/
151 } __attribute__ ((packed));
154 HOSTIF_PCI_MASTER_HOST_INDIRECT,
155 HOSTIF_PCI_MASTER_HOST_DIRECT,
158 HOSTIF_DONTCARE = 0xFF
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
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
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
181 struct acx_rx_msdu_lifetime {
182 struct acx_header header;
185 * The maximum amount of time, in TU, before the
186 * firmware discards the MSDU.
189 } __attribute__ ((packed));
192 * RX Config Options Table
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)
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
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
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
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
219 * When clear, the WiLink receives frames destined to any MAC
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
225 * 2 FCS - When set, the WiLink includes the FCS with the received
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.
232 * RX Filter Options Table
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
240 * 10 Auth/De auth - When set, the WiLink receives all authentication
241 * and de-authentication frames. When clear, these frames are
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
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
254 * When clear, these frames are discarded.
255 * 4 Management - When set, the WiLink receives all management
257 * When clear, these frames are discarded.
258 * 3 Probe Request - When set, the WiLink receives all probe request
260 * When clear, these frames are discarded.
261 * 2 Probe Response - When set, the WiLink receives all probe
263 * When clear, these frames are discarded.
264 * 1 RTS/CTS/ACK - When set, the WiLink receives all RTS, CTS and ACK
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.
272 struct acx_rx_config {
273 struct acx_header header;
277 } __attribute__ ((packed));
279 struct acx_packet_detection {
280 struct acx_header header;
283 } __attribute__ ((packed));
289 DEFAULT_SLOT_TIME = SLOT_TIME_SHORT,
290 MAX_SLOT_TIMES = 0xFF
293 #define STATION_WONE_INDEX 0
296 struct acx_header header;
298 u8 wone_index; /* Reserved */
301 } __attribute__ ((packed));
304 #define ACX_MC_ADDRESS_GROUP_MAX (8)
305 #define ADDRESS_GROUP_MAX_LEN (ETH_ALEN * ACX_MC_ADDRESS_GROUP_MAX)
307 struct acx_dot11_grp_addr_tbl {
308 struct acx_header header;
313 u8 mac_table[ADDRESS_GROUP_MAX_LEN];
314 } __attribute__ ((packed));
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)
323 struct acx_rx_timeout {
324 struct acx_header header;
327 * The longest time the STA will wait to receive
328 * traffic from the AP after a PS-poll has been
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.
339 } __attribute__ ((packed));
341 #define RTS_THRESHOLD_MIN 0
342 #define RTS_THRESHOLD_MAX 4096
343 #define RTS_THRESHOLD_DEF 2347
345 struct acx_rts_threshold {
346 struct acx_header header;
350 } __attribute__ ((packed));
352 struct acx_beacon_filter_option {
353 struct acx_header header;
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.
366 } __attribute__ ((packed));
369 * ACXBeaconFilterEntry (not 221)
370 * Byte Offset Size (Bytes) Definition
371 * =========== ============ ==========
373 * 1 1 Treatment bit mask
375 * ACXBeaconFilterEntry (221)
376 * Byte Offset Size (Bytes) Definition
377 * =========== ============ ==========
379 * 1 1 Treatment bit mask
385 * Treatment bit mask - The information element handling:
386 * bit 0 - The information element is compared and transferred
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.
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))
401 struct acx_beacon_filter_ie_table {
402 struct acx_header header;
405 u8 table[BEACON_FILTER_TABLE_MAX_SIZE];
407 } __attribute__ ((packed));
412 SG_SENSE_NO_ACTIVITY,
416 struct acx_bt_wlan_coex {
417 struct acx_header header;
422 * 2 -> sense no active mode, i.e.
423 * an interrupt is sent upon
425 * 3 -> PTA is switched on in response
426 * to the interrupt sending.
430 } __attribute__ ((packed));
432 #define PTA_ANTENNA_TYPE_DEF (0)
433 #define PTA_BT_HP_MAXTIME_DEF (2000)
434 #define PTA_WLAN_HP_MAX_TIME_DEF (5000)
435 #define PTA_SENSE_DISABLE_TIMER_DEF (1350)
436 #define PTA_PROTECTIVE_RX_TIME_DEF (1500)
437 #define PTA_PROTECTIVE_TX_TIME_DEF (1500)
438 #define PTA_TIMEOUT_NEXT_BT_LP_PACKET_DEF (3000)
439 #define PTA_SIGNALING_TYPE_DEF (1)
440 #define PTA_AFH_LEVERAGE_ON_DEF (0)
441 #define PTA_NUMBER_QUIET_CYCLE_DEF (0)
442 #define PTA_MAX_NUM_CTS_DEF (3)
443 #define PTA_NUMBER_OF_WLAN_PACKETS_DEF (2)
444 #define PTA_NUMBER_OF_BT_PACKETS_DEF (2)
445 #define PTA_PROTECTIVE_RX_TIME_FAST_DEF (1500)
446 #define PTA_PROTECTIVE_TX_TIME_FAST_DEF (3000)
447 #define PTA_CYCLE_TIME_FAST_DEF (8700)
448 #define PTA_RX_FOR_AVALANCHE_DEF (5)
449 #define PTA_ELP_HP_DEF (0)
450 #define PTA_ANTI_STARVE_PERIOD_DEF (500)
451 #define PTA_ANTI_STARVE_NUM_CYCLE_DEF (4)
452 #define PTA_ALLOW_PA_SD_DEF (1)
453 #define PTA_TIME_BEFORE_BEACON_DEF (6300)
454 #define PTA_HPDM_MAX_TIME_DEF (1600)
455 #define PTA_TIME_OUT_NEXT_WLAN_DEF (2550)
456 #define PTA_AUTO_MODE_NO_CTS_DEF (0)
457 #define PTA_BT_HP_RESPECTED_DEF (3)
458 #define PTA_WLAN_RX_MIN_RATE_DEF (24)
459 #define PTA_ACK_MODE_DEF (1)
461 struct acx_bt_wlan_coex_param {
462 struct acx_header header;
465 * The minimum rate of a received WLAN packet in the STA,
466 * during protective mode, of which a new BT-HP request
467 * during this Rx will always be respected and gain the antenna.
471 /* Max time the BT HP will be respected. */
474 /* Max time the WLAN HP will be respected. */
475 u16 wlan_hp_max_time;
478 * The time between the last BT activity
479 * and the moment when the sense mode returns
482 u16 sense_disable_timer;
484 /* Time before the next BT HP instance */
488 /* range: 10-20000 default: 1500 */
489 u16 rx_time_bt_hp_fast;
490 u16 tx_time_bt_hp_fast;
492 /* range: 2000-65535 default: 8700 */
495 /* range: 0 - 15000 (Msec) default: 1000 */
496 u16 bt_anti_starvation_period;
498 /* range 400-10000(Usec) default: 3000 */
499 u16 next_bt_lp_packet;
501 /* Deafult: worst case for BT DH5 traffic */
504 /* range: 0-50000(Usec) default: 1050 */
505 u16 hp_dm_max_guard_time;
508 * This is to prevent both BT & WLAN antenna
510 * Range: 100-50000(Usec) default:2550
512 u16 next_wlan_packet;
514 /* 0 -> shared antenna */
526 * 1 -> from dedicated GPIO
527 * 2 -> AFH on (from host)
532 * The number of cycles during which no
533 * TX will be sent after 1 cycle of RX
534 * transaction in protective mode
539 * The maximum number of CTSs that will
540 * be sent for receiving RX packet in
546 * The number of WLAN packets
547 * transferred in common mode before
553 * The number of BT packets
554 * transferred in common mode before
559 /* range: 1-255 default: 5 */
560 u8 missed_rx_avalanche;
562 /* range: 0-1 default: 1 */
565 /* range: 0 - 15 default: 4 */
566 u8 bt_anti_starvation_cycles;
568 u8 ack_mode_dual_ant;
571 * Allow PA_SD assertion/de-assertion
572 * during enabled BT activity.
577 * Enable/Disable PTA in auto mode:
578 * Support Both Active & P.S modes
580 u8 pta_auto_mode_enable;
582 /* range: 0 - 20 default: 1 */
583 u8 bt_hp_respected_num;
584 } __attribute__ ((packed));
586 #define CCA_THRSH_ENABLE_ENERGY_D 0x140A
587 #define CCA_THRSH_DISABLE_ENERGY_D 0xFFEF
589 struct acx_energy_detection {
590 struct acx_header header;
592 /* The RX Clear Channel Assessment threshold in the PHY */
593 u16 rx_cca_threshold;
594 u8 tx_energy_detection;
596 } __attribute__ ((packed));
598 #define BCN_RX_TIMEOUT_DEF_VALUE 10000
599 #define BROADCAST_RX_TIMEOUT_DEF_VALUE 20000
600 #define RX_BROADCAST_IN_PS_DEF_VALUE 1
601 #define CONSECUTIVE_PS_POLL_FAILURE_DEF 4
603 struct acx_beacon_broadcast {
604 struct acx_header header;
606 u16 beacon_rx_timeout;
607 u16 broadcast_timeout;
609 /* Enables receiving of broadcast packets in PS mode */
610 u8 rx_broadcast_in_ps;
612 /* Consecutive PS Poll failures before updating the host */
613 u8 ps_poll_threshold;
615 } __attribute__ ((packed));
617 struct acx_event_mask {
618 struct acx_header header;
621 u32 high_event_mask; /* Unused */
622 } __attribute__ ((packed));
624 #define CFG_RX_FCS BIT(2)
625 #define CFG_RX_ALL_GOOD BIT(3)
626 #define CFG_UNI_FILTER_EN BIT(4)
627 #define CFG_BSSID_FILTER_EN BIT(5)
628 #define CFG_MC_FILTER_EN BIT(6)
629 #define CFG_MC_ADDR0_EN BIT(7)
630 #define CFG_MC_ADDR1_EN BIT(8)
631 #define CFG_BC_REJECT_EN BIT(9)
632 #define CFG_SSID_FILTER_EN BIT(10)
633 #define CFG_RX_INT_FCS_ERROR BIT(11)
634 #define CFG_RX_INT_ENCRYPTED BIT(12)
635 #define CFG_RX_WR_RX_STATUS BIT(13)
636 #define CFG_RX_FILTER_NULTI BIT(14)
637 #define CFG_RX_RESERVE BIT(15)
638 #define CFG_RX_TIMESTAMP_TSF BIT(16)
640 #define CFG_RX_RSV_EN BIT(0)
641 #define CFG_RX_RCTS_ACK BIT(1)
642 #define CFG_RX_PRSP_EN BIT(2)
643 #define CFG_RX_PREQ_EN BIT(3)
644 #define CFG_RX_MGMT_EN BIT(4)
645 #define CFG_RX_FCS_ERROR BIT(5)
646 #define CFG_RX_DATA_EN BIT(6)
647 #define CFG_RX_CTL_EN BIT(7)
648 #define CFG_RX_CF_EN BIT(8)
649 #define CFG_RX_BCN_EN BIT(9)
650 #define CFG_RX_AUTH_EN BIT(10)
651 #define CFG_RX_ASSOC_EN BIT(11)
653 #define SCAN_PASSIVE BIT(0)
654 #define SCAN_5GHZ_BAND BIT(1)
655 #define SCAN_TRIGGERED BIT(2)
656 #define SCAN_PRIORITY_HIGH BIT(3)
658 struct acx_feature_config {
659 struct acx_header header;
662 u32 data_flow_options;
663 } __attribute__ ((packed));
665 struct acx_current_tx_power {
666 struct acx_header header;
670 } __attribute__ ((packed));
672 enum acx_wake_up_event {
673 WAKE_UP_EVENT_BEACON_BITMAP = 0x01, /* Wake on every Beacon*/
674 WAKE_UP_EVENT_DTIM_BITMAP = 0x02, /* Wake on every DTIM*/
675 WAKE_UP_EVENT_N_DTIM_BITMAP = 0x04, /* Wake on every Nth DTIM */
676 WAKE_UP_EVENT_N_BEACONS_BITMAP = 0x08, /* Wake on every Nth Beacon */
677 WAKE_UP_EVENT_BITS_MASK = 0x0F
680 struct acx_wake_up_condition {
681 struct acx_header header;
683 u8 wake_up_event; /* Only one bit can be set */
686 } __attribute__ ((packed));
689 struct acx_header header;
692 * To be set when associated with an AP.
696 } __attribute__ ((packed));
698 enum acx_preamble_type {
699 ACX_PREAMBLE_LONG = 0,
700 ACX_PREAMBLE_SHORT = 1
703 struct acx_preamble {
704 struct acx_header header;
707 * When set, the WiLink transmits the frames with a short preamble and
708 * when cleared, the WiLink transmits the frames with a long preamble.
712 } __attribute__ ((packed));
714 enum acx_ctsprotect_type {
715 CTSPROTECT_DISABLE = 0,
716 CTSPROTECT_ENABLE = 1
719 struct acx_ctsprotect {
720 struct acx_header header;
723 } __attribute__ ((packed));
725 struct acx_tx_statistics {
726 u32 internal_desc_overflow;
727 } __attribute__ ((packed));
729 struct acx_rx_statistics {
738 } __attribute__ ((packed));
740 struct acx_dma_statistics {
745 } __attribute__ ((packed));
747 struct acx_isr_statistics {
748 /* host command complete */
754 /* (INT_STS_ND & INT_TRIG_RX_HEADER) */
757 /* (INT_STS_ND & INT_TRIG_RX_CMPLT) */
760 /* (INT_STS_ND & INT_TRIG_NO_RX_BUF) */
763 /* (INT_STS_ND & INT_TRIG_S_RX_RDY) */
769 /* (INT_STS_ND & INT_TRIG_TX_PROC) */
772 /* (INT_STS_ND & INT_TRIG_DECRYPT_DONE) */
775 /* (INT_STS_ND & INT_TRIG_DMA0) */
778 /* (INT_STS_ND & INT_TRIG_DMA1) */
781 /* (INT_STS_ND & INT_TRIG_TX_EXC_CMPLT) */
782 u32 tx_exch_complete;
784 /* (INT_STS_ND & INT_TRIG_COMMAND) */
787 /* (INT_STS_ND & INT_TRIG_RX_PROC) */
790 /* (INT_STS_ND & INT_TRIG_PM_802) */
791 u32 hw_pm_mode_changes;
793 /* (INT_STS_ND & INT_TRIG_ACKNOWLEDGE) */
794 u32 host_acknowledges;
796 /* (INT_STS_ND & INT_TRIG_PM_PCI) */
799 /* (INT_STS_ND & INT_TRIG_ACM_WAKEUP) */
802 /* (INT_STS_ND & INT_TRIG_LOW_RSSI) */
804 } __attribute__ ((packed));
806 struct acx_wep_statistics {
807 /* WEP address keys configured */
810 /* default keys configured */
811 u32 default_key_count;
815 /* number of times that WEP key not found on lookup */
818 /* number of times that WEP key decryption failed */
821 /* WEP packets decrypted */
824 /* WEP decrypt interrupts */
826 } __attribute__ ((packed));
828 #define ACX_MISSED_BEACONS_SPREAD 10
830 struct acx_pwr_statistics {
831 /* the amount of enters into power save mode (both PD & ELP) */
834 /* the amount of enters into ELP mode */
837 /* the amount of missing beacon interrupts to the host */
840 /* the amount of wake on host-access times */
843 /* the amount of wake on timer-expire */
844 u32 wake_on_timer_exp;
846 /* the number of packets that were transmitted with PS bit set */
849 /* the number of packets that were transmitted with PS bit clear */
852 /* the number of received beacons */
855 /* the number of entering into PowerOn (power save off) */
858 /* the number of entries into power save mode */
862 * the number of exits from power save, not including failed PS
868 * the number of times the TSF counter was adjusted because
873 /* Gives statistics about the spread continuous missed beacons.
874 * The 16 LSB are dedicated for the PS mode.
875 * The 16 MSB are dedicated for the PS mode.
876 * cont_miss_bcns_spread[0] - single missed beacon.
877 * cont_miss_bcns_spread[1] - two continuous missed beacons.
878 * cont_miss_bcns_spread[2] - three continuous missed beacons.
880 * cont_miss_bcns_spread[9] - ten and more continuous missed beacons.
882 u32 cont_miss_bcns_spread[ACX_MISSED_BEACONS_SPREAD];
884 /* the number of beacons in awake mode */
885 u32 rcvd_awake_beacons;
886 } __attribute__ ((packed));
888 struct acx_mic_statistics {
891 } __attribute__ ((packed));
893 struct acx_aes_statistics {
898 u32 encrypt_interrupt;
899 u32 decrypt_interrupt;
900 } __attribute__ ((packed));
902 struct acx_event_statistics {
909 u32 phy_transmit_error;
911 } __attribute__ ((packed));
913 struct acx_ps_statistics {
918 u32 pspoll_max_apturn;
919 u32 pspoll_utilization;
920 u32 upsd_utilization;
921 } __attribute__ ((packed));
923 struct acx_rxpipe_statistics {
924 u32 rx_prep_beacon_drop;
925 u32 descr_host_int_trig_rx_data;
926 u32 beacon_buffer_thres_host_int_trig_rx_data;
927 u32 missed_beacon_host_int_trig_rx_data;
928 u32 tx_xfr_host_int_trig_rx_data;
929 } __attribute__ ((packed));
931 struct acx_statistics {
932 struct acx_header header;
934 struct acx_tx_statistics tx;
935 struct acx_rx_statistics rx;
936 struct acx_dma_statistics dma;
937 struct acx_isr_statistics isr;
938 struct acx_wep_statistics wep;
939 struct acx_pwr_statistics pwr;
940 struct acx_aes_statistics aes;
941 struct acx_mic_statistics mic;
942 struct acx_event_statistics event;
943 struct acx_ps_statistics ps;
944 struct acx_rxpipe_statistics rxpipe;
945 } __attribute__ ((packed));
947 #define ACX_MAX_RATE_CLASSES 8
948 #define ACX_RATE_MASK_UNSPECIFIED 0
949 #define ACX_RATE_MASK_ALL 0x1eff
950 #define ACX_RATE_RETRY_LIMIT 10
952 struct acx_rate_class {
954 u8 short_retry_limit;
960 struct acx_rate_policy {
961 struct acx_header header;
964 struct acx_rate_class rate_class[ACX_MAX_RATE_CLASSES];
965 } __attribute__ ((packed));
967 #define WL1271_ACX_AC_COUNT 4
970 struct acx_header header;
977 } __attribute__ ((packed));
980 WL1271_ACX_AC_BE = 0,
981 WL1271_ACX_AC_BK = 1,
982 WL1271_ACX_AC_VI = 2,
983 WL1271_ACX_AC_VO = 3,
984 WL1271_ACX_AC_CTS2SELF = 4,
985 WL1271_ACX_AC_ANY_TID = 0x1F,
986 WL1271_ACX_AC_INVALID = 0xFF,
989 enum wl1271_acx_ps_scheme {
990 WL1271_ACX_PS_SCHEME_LEGACY = 0,
991 WL1271_ACX_PS_SCHEME_UPSD_TRIGGER = 1,
992 WL1271_ACX_PS_SCHEME_LEGACY_PSPOLL = 2,
993 WL1271_ACX_PS_SCHEME_SAPSD = 3,
996 enum wl1271_acx_ack_policy {
997 WL1271_ACX_ACK_POLICY_LEGACY = 0,
998 WL1271_ACX_ACK_POLICY_NO_ACK = 1,
999 WL1271_ACX_ACK_POLICY_BLOCK = 2,
1002 #define WL1271_ACX_TID_COUNT 7
1004 struct acx_tid_config {
1005 struct acx_header header;
1013 } __attribute__ ((packed));
1015 struct acx_frag_threshold {
1016 struct acx_header header;
1019 } __attribute__ ((packed));
1021 #define WL1271_ACX_TX_COMPL_TIMEOUT 5
1022 #define WL1271_ACX_TX_COMPL_THRESHOLD 5
1024 struct acx_tx_config_options {
1025 struct acx_header header;
1026 u16 tx_compl_timeout; /* msec */
1027 u16 tx_compl_threshold; /* number of packets */
1028 } __attribute__ ((packed));
1030 #define ACX_RX_MEM_BLOCKS 64
1031 #define ACX_TX_MIN_MEM_BLOCKS 64
1032 #define ACX_TX_DESCRIPTORS 32
1033 #define ACX_NUM_SSID_PROFILES 1
1035 struct wl1271_acx_config_memory {
1036 struct acx_header header;
1038 u8 rx_mem_block_num;
1039 u8 tx_min_mem_block_num;
1041 u8 num_ssid_profiles;
1042 u32 total_tx_descriptors;
1043 } __attribute__ ((packed));
1045 struct wl1271_acx_mem_map {
1046 struct acx_header header;
1051 void *wep_defkey_start;
1052 void *wep_defkey_end;
1054 void *sta_table_start;
1055 void *sta_table_end;
1057 void *packet_template_start;
1058 void *packet_template_end;
1060 /* Address of the TX result interface (control block) */
1062 u32 tx_result_queue_start;
1064 void *queue_memory_start;
1065 void *queue_memory_end;
1067 u32 packet_memory_pool_start;
1068 u32 packet_memory_pool_end;
1070 void *debug_buffer1_start;
1071 void *debug_buffer1_end;
1073 void *debug_buffer2_start;
1074 void *debug_buffer2_end;
1076 /* Number of blocks FW allocated for TX packets */
1077 u32 num_tx_mem_blocks;
1079 /* Number of blocks FW allocated for RX packets */
1080 u32 num_rx_mem_blocks;
1082 /* the following 4 fields are valid in SLAVE mode only */
1087 } __attribute__ ((packed));
1089 enum wl1271_acx_rx_queue_type {
1090 RX_QUEUE_TYPE_RX_LOW_PRIORITY, /* All except the high priority */
1091 RX_QUEUE_TYPE_RX_HIGH_PRIORITY, /* Management and voice packets */
1093 RX_QUEUE_TYPE_MAX = USHORT_MAX
1096 #define WL1271_RX_INTR_THRESHOLD_DEF 0 /* no pacing, send interrupt on
1098 #define WL1271_RX_INTR_THRESHOLD_MIN 0
1099 #define WL1271_RX_INTR_THRESHOLD_MAX 15
1101 #define WL1271_RX_INTR_TIMEOUT_DEF 5
1102 #define WL1271_RX_INTR_TIMEOUT_MIN 1
1103 #define WL1271_RX_INTR_TIMEOUT_MAX 100
1105 struct wl1271_acx_rx_config_opt {
1106 struct acx_header header;
1113 } __attribute__ ((packed));
1116 ACX_WAKE_UP_CONDITIONS = 0x0002,
1117 ACX_MEM_CFG = 0x0003,
1119 ACX_AC_CFG = 0x0007,
1120 ACX_MEM_MAP = 0x0008,
1122 /* ACX_FW_REV is missing in the ref driver, but seems to work */
1123 ACX_FW_REV = 0x000D,
1124 ACX_MEDIUM_USAGE = 0x000F,
1125 ACX_RX_CFG = 0x0010,
1126 ACX_TX_QUEUE_CFG = 0x0011, /* FIXME: only used by wl1251 */
1127 ACX_STATISTICS = 0x0013, /* Debug API */
1128 ACX_PWR_CONSUMPTION_STATISTICS = 0x0014,
1129 ACX_FEATURE_CFG = 0x0015,
1130 ACX_TID_CFG = 0x001A,
1131 ACX_PS_RX_STREAMING = 0x001B,
1132 ACX_BEACON_FILTER_OPT = 0x001F,
1133 ACX_NOISE_HIST = 0x0021,
1134 ACX_HDK_VERSION = 0x0022, /* ??? */
1135 ACX_PD_THRESHOLD = 0x0023,
1136 ACX_TX_CONFIG_OPT = 0x0024,
1137 ACX_CCA_THRESHOLD = 0x0025,
1138 ACX_EVENT_MBOX_MASK = 0x0026,
1139 ACX_CONN_MONIT_PARAMS = 0x002D,
1140 ACX_CONS_TX_FAILURE = 0x002F,
1141 ACX_BCN_DTIM_OPTIONS = 0x0031,
1142 ACX_SG_ENABLE = 0x0032,
1143 ACX_SG_CFG = 0x0033,
1144 ACX_BEACON_FILTER_TABLE = 0x0038,
1145 ACX_ARP_IP_FILTER = 0x0039,
1146 ACX_ROAMING_STATISTICS_TBL = 0x003B,
1147 ACX_RATE_POLICY = 0x003D,
1148 ACX_CTS_PROTECTION = 0x003E,
1149 ACX_SLEEP_AUTH = 0x003F,
1150 ACX_PREAMBLE_TYPE = 0x0040,
1151 ACX_ERROR_CNT = 0x0041,
1152 ACX_IBSS_FILTER = 0x0044,
1153 ACX_SERVICE_PERIOD_TIMEOUT = 0x0045,
1154 ACX_TSF_INFO = 0x0046,
1155 ACX_CONFIG_PS_WMM = 0x0049,
1156 ACX_ENABLE_RX_DATA_FILTER = 0x004A,
1157 ACX_SET_RX_DATA_FILTER = 0x004B,
1158 ACX_GET_DATA_FILTER_STATISTICS = 0x004C,
1159 ACX_RX_CONFIG_OPT = 0x004E,
1160 ACX_FRAG_CFG = 0x004F,
1161 ACX_BET_ENABLE = 0x0050,
1162 ACX_RSSI_SNR_TRIGGER = 0x0051,
1163 ACX_RSSI_SNR_WEIGHTS = 0x0051,
1164 ACX_KEEP_ALIVE_MODE = 0x0052,
1165 ACX_SET_KEEP_ALIVE_CONFIG = 0x0054,
1166 ACX_BA_SESSION_RESPONDER_POLICY = 0x0055,
1167 ACX_BA_SESSION_INITIATOR_POLICY = 0x0056,
1168 ACX_PEER_HT_CAP = 0x0057,
1169 ACX_HT_BSS_OPERATION = 0x0058,
1170 ACX_COEX_ACTIVITY = 0x0059,
1171 DOT11_RX_MSDU_LIFE_TIME = 0x1004,
1172 DOT11_CUR_TX_PWR = 0x100D,
1173 DOT11_RX_DOT11_MODE = 0x1012,
1174 DOT11_RTS_THRESHOLD = 0x1013,
1175 DOT11_GROUP_ADDRESS_TBL = 0x1014,
1177 MAX_DOT11_IE = DOT11_GROUP_ADDRESS_TBL,
1183 int wl1271_acx_wake_up_conditions(struct wl1271 *wl, u8 wake_up_event,
1184 u8 listen_interval);
1185 int wl1271_acx_sleep_auth(struct wl1271 *wl, u8 sleep_auth);
1186 int wl1271_acx_fw_version(struct wl1271 *wl, char *buf, size_t len);
1187 int wl1271_acx_tx_power(struct wl1271 *wl, int power);
1188 int wl1271_acx_feature_cfg(struct wl1271 *wl);
1189 int wl1271_acx_mem_map(struct wl1271 *wl,
1190 struct acx_header *mem_map, size_t len);
1191 int wl1271_acx_rx_msdu_life_time(struct wl1271 *wl, u32 life_time);
1192 int wl1271_acx_rx_config(struct wl1271 *wl, u32 config, u32 filter);
1193 int wl1271_acx_pd_threshold(struct wl1271 *wl);
1194 int wl1271_acx_slot(struct wl1271 *wl, enum acx_slot_type slot_time);
1195 int wl1271_acx_group_address_tbl(struct wl1271 *wl, bool enable,
1196 void *mc_list, u32 mc_list_len);
1197 int wl1271_acx_service_period_timeout(struct wl1271 *wl);
1198 int wl1271_acx_rts_threshold(struct wl1271 *wl, u16 rts_threshold);
1199 int wl1271_acx_beacon_filter_opt(struct wl1271 *wl);
1200 int wl1271_acx_beacon_filter_table(struct wl1271 *wl);
1201 int wl1271_acx_sg_enable(struct wl1271 *wl);
1202 int wl1271_acx_sg_cfg(struct wl1271 *wl);
1203 int wl1271_acx_cca_threshold(struct wl1271 *wl);
1204 int wl1271_acx_bcn_dtim_options(struct wl1271 *wl);
1205 int wl1271_acx_aid(struct wl1271 *wl, u16 aid);
1206 int wl1271_acx_event_mbox_mask(struct wl1271 *wl, u32 event_mask);
1207 int wl1271_acx_set_preamble(struct wl1271 *wl, enum acx_preamble_type preamble);
1208 int wl1271_acx_cts_protect(struct wl1271 *wl,
1209 enum acx_ctsprotect_type ctsprotect);
1210 int wl1271_acx_statistics(struct wl1271 *wl, struct acx_statistics *stats);
1211 int wl1271_acx_rate_policies(struct wl1271 *wl, u32 enabled_rates);
1212 int wl1271_acx_ac_cfg(struct wl1271 *wl);
1213 int wl1271_acx_tid_cfg(struct wl1271 *wl);
1214 int wl1271_acx_frag_threshold(struct wl1271 *wl);
1215 int wl1271_acx_tx_config_options(struct wl1271 *wl);
1216 int wl1271_acx_mem_cfg(struct wl1271 *wl);
1217 int wl1271_acx_init_mem_config(struct wl1271 *wl);
1218 int wl1271_acx_init_rx_interrupt(struct wl1271 *wl);
1220 #endif /* __WL1271_ACX_H__ */