2 * This file is part of wl1271
4 * Copyright (C) 2009 Nokia Corporation
6 * Contact: Luciano Coelho <luciano.coelho@nokia.com>
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
24 #ifndef __WL1271_CONF_H__
25 #define __WL1271_CONF_H__
28 CONF_HW_BIT_RATE_1MBPS = BIT(0),
29 CONF_HW_BIT_RATE_2MBPS = BIT(1),
30 CONF_HW_BIT_RATE_5_5MBPS = BIT(2),
31 CONF_HW_BIT_RATE_6MBPS = BIT(3),
32 CONF_HW_BIT_RATE_9MBPS = BIT(4),
33 CONF_HW_BIT_RATE_11MBPS = BIT(5),
34 CONF_HW_BIT_RATE_12MBPS = BIT(6),
35 CONF_HW_BIT_RATE_18MBPS = BIT(7),
36 CONF_HW_BIT_RATE_22MBPS = BIT(8),
37 CONF_HW_BIT_RATE_24MBPS = BIT(9),
38 CONF_HW_BIT_RATE_36MBPS = BIT(10),
39 CONF_HW_BIT_RATE_48MBPS = BIT(11),
40 CONF_HW_BIT_RATE_54MBPS = BIT(12),
41 CONF_HW_BIT_RATE_MCS_0 = BIT(13),
42 CONF_HW_BIT_RATE_MCS_1 = BIT(14),
43 CONF_HW_BIT_RATE_MCS_2 = BIT(15),
44 CONF_HW_BIT_RATE_MCS_3 = BIT(16),
45 CONF_HW_BIT_RATE_MCS_4 = BIT(17),
46 CONF_HW_BIT_RATE_MCS_5 = BIT(18),
47 CONF_HW_BIT_RATE_MCS_6 = BIT(19),
48 CONF_HW_BIT_RATE_MCS_7 = BIT(20)
52 CONF_HW_RATE_INDEX_1MBPS = 0,
53 CONF_HW_RATE_INDEX_2MBPS = 1,
54 CONF_HW_RATE_INDEX_5_5MBPS = 2,
55 CONF_HW_RATE_INDEX_6MBPS = 3,
56 CONF_HW_RATE_INDEX_9MBPS = 4,
57 CONF_HW_RATE_INDEX_11MBPS = 5,
58 CONF_HW_RATE_INDEX_12MBPS = 6,
59 CONF_HW_RATE_INDEX_18MBPS = 7,
60 CONF_HW_RATE_INDEX_22MBPS = 8,
61 CONF_HW_RATE_INDEX_24MBPS = 9,
62 CONF_HW_RATE_INDEX_36MBPS = 10,
63 CONF_HW_RATE_INDEX_48MBPS = 11,
64 CONF_HW_RATE_INDEX_54MBPS = 12,
65 CONF_HW_RATE_INDEX_MAX = CONF_HW_RATE_INDEX_54MBPS,
69 CONF_HW_RXTX_RATE_MCS7 = 0,
70 CONF_HW_RXTX_RATE_MCS6,
71 CONF_HW_RXTX_RATE_MCS5,
72 CONF_HW_RXTX_RATE_MCS4,
73 CONF_HW_RXTX_RATE_MCS3,
74 CONF_HW_RXTX_RATE_MCS2,
75 CONF_HW_RXTX_RATE_MCS1,
76 CONF_HW_RXTX_RATE_MCS0,
87 CONF_HW_RXTX_RATE_5_5,
90 CONF_HW_RXTX_RATE_MAX,
91 CONF_HW_RXTX_RATE_UNSUPPORTED = 0xff
102 * PER threshold in PPM of the BT voice
104 * Range: 0 - 10000000
106 CONF_SG_BT_PER_THRESHOLD = 0,
109 * Number of consequent RX_ACTIVE activities to override BT voice
110 * frames to ensure WLAN connection
114 CONF_SG_HV3_MAX_OVERRIDE,
117 * Defines the PER threshold of the BT voice
121 CONF_SG_BT_NFS_SAMPLE_INTERVAL,
124 * Defines the load ratio of BT
128 CONF_SG_BT_LOAD_RATIO,
131 * Defines whether the SG will force WLAN host to enter/exit PSM
133 * Range: 1 - SG can force, 0 - host handles PSM
135 CONF_SG_AUTO_PS_MODE,
138 * Compensation percentage of probe requests when scan initiated
139 * during BT voice/ACL link.
143 CONF_SG_AUTO_SCAN_PROBE_REQ,
146 * Compensation percentage of probe requests when active scan initiated
151 CONF_SG_ACTIVE_SCAN_DURATION_FACTOR_HV3,
154 * Defines antenna configuration (single/dual antenna)
156 * Range: 0 - single antenna, 1 - dual antenna
158 CONF_SG_ANTENNA_CONFIGURATION,
161 * The threshold (percent) of max consequtive beacon misses before
162 * increasing priority of beacon reception.
166 CONF_SG_BEACON_MISS_PERCENT,
169 * The rate threshold below which receiving a data frame from the AP
170 * will increase the priority of the data frame above BT traffic.
172 * Range: 0,2, 5(=5.5), 6, 9, 11, 12, 18, 24, 36, 48, 54
174 CONF_SG_RATE_ADAPT_THRESH,
177 * Not used currently.
181 CONF_SG_RATE_ADAPT_SNR,
184 * Configure the min and max time BT gains the antenna
185 * in WLAN PSM / BT master basic rate
187 * Range: 0 - 255 (ms)
189 CONF_SG_WLAN_PS_BT_ACL_MASTER_MIN_BR,
190 CONF_SG_WLAN_PS_BT_ACL_MASTER_MAX_BR,
193 * The time after it expires no new WLAN trigger frame is trasmitted
194 * in WLAN PSM / BT master basic rate
196 * Range: 0 - 255 (ms)
198 CONF_SG_WLAN_PS_MAX_BT_ACL_MASTER_BR,
201 * Configure the min and max time BT gains the antenna
202 * in WLAN PSM / BT slave basic rate
204 * Range: 0 - 255 (ms)
206 CONF_SG_WLAN_PS_BT_ACL_SLAVE_MIN_BR,
207 CONF_SG_WLAN_PS_BT_ACL_SLAVE_MAX_BR,
210 * The time after it expires no new WLAN trigger frame is trasmitted
211 * in WLAN PSM / BT slave basic rate
213 * Range: 0 - 255 (ms)
215 CONF_SG_WLAN_PS_MAX_BT_ACL_SLAVE_BR,
218 * Configure the min and max time BT gains the antenna
219 * in WLAN PSM / BT master EDR
221 * Range: 0 - 255 (ms)
223 CONF_SG_WLAN_PS_BT_ACL_MASTER_MIN_EDR,
224 CONF_SG_WLAN_PS_BT_ACL_MASTER_MAX_EDR,
227 * The time after it expires no new WLAN trigger frame is trasmitted
228 * in WLAN PSM / BT master EDR
230 * Range: 0 - 255 (ms)
232 CONF_SG_WLAN_PS_MAX_BT_ACL_MASTER_EDR,
235 * Configure the min and max time BT gains the antenna
236 * in WLAN PSM / BT slave EDR
238 * Range: 0 - 255 (ms)
240 CONF_SG_WLAN_PS_BT_ACL_SLAVE_MIN_EDR,
241 CONF_SG_WLAN_PS_BT_ACL_SLAVE_MAX_EDR,
244 * The time after it expires no new WLAN trigger frame is trasmitted
245 * in WLAN PSM / BT slave EDR
247 * Range: 0 - 255 (ms)
249 CONF_SG_WLAN_PS_MAX_BT_ACL_SLAVE_EDR,
252 * RX guard time before the beginning of a new BT voice frame during
253 * which no new WLAN trigger frame is transmitted.
255 * Range: 0 - 100000 (us)
260 * TX guard time before the beginning of a new BT voice frame during
261 * which no new WLAN frame is transmitted.
263 * Range: 0 - 100000 (us)
269 * Enable adaptive RXT/TXT algorithm. If disabled, the host values
272 * Range: 0 - disable, 1 - enable
274 CONF_SG_ADAPTIVE_RXT_TXT,
277 * The used WLAN legacy service period during active BT ACL link
279 * Range: 0 - 255 (ms)
281 CONF_SG_PS_POLL_TIMEOUT,
284 * The used WLAN UPSD service period during active BT ACL link
286 * Range: 0 - 255 (ms)
288 CONF_SG_UPSD_TIMEOUT,
291 * Configure the min and max time BT gains the antenna
292 * in WLAN Active / BT master EDR
294 * Range: 0 - 255 (ms)
296 CONF_SG_WLAN_ACTIVE_BT_ACL_MASTER_MIN_EDR,
297 CONF_SG_WLAN_ACTIVE_BT_ACL_MASTER_MAX_EDR,
300 * The maximum time WLAN can gain the antenna for
301 * in WLAN Active / BT master EDR
303 * Range: 0 - 255 (ms)
305 CONF_SG_WLAN_ACTIVE_MAX_BT_ACL_MASTER_EDR,
308 * Configure the min and max time BT gains the antenna
309 * in WLAN Active / BT slave EDR
311 * Range: 0 - 255 (ms)
313 CONF_SG_WLAN_ACTIVE_BT_ACL_SLAVE_MIN_EDR,
314 CONF_SG_WLAN_ACTIVE_BT_ACL_SLAVE_MAX_EDR,
317 * The maximum time WLAN can gain the antenna for
318 * in WLAN Active / BT slave EDR
320 * Range: 0 - 255 (ms)
322 CONF_SG_WLAN_ACTIVE_MAX_BT_ACL_SLAVE_EDR,
325 * Configure the min and max time BT gains the antenna
326 * in WLAN Active / BT basic rate
328 * Range: 0 - 255 (ms)
330 CONF_SG_WLAN_ACTIVE_BT_ACL_MIN_BR,
331 CONF_SG_WLAN_ACTIVE_BT_ACL_MAX_BR,
334 * The maximum time WLAN can gain the antenna for
335 * in WLAN Active / BT basic rate
337 * Range: 0 - 255 (ms)
339 CONF_SG_WLAN_ACTIVE_MAX_BT_ACL_BR,
342 * Compensation percentage of WLAN passive scan window if initiated
345 * Range: 0 - 1000 (%)
347 CONF_SG_PASSIVE_SCAN_DURATION_FACTOR_HV3,
350 * Compensation percentage of WLAN passive scan window if initiated
353 * Range: 0 - 1000 (%)
355 CONF_SG_PASSIVE_SCAN_DURATION_FACTOR_A2DP,
358 * Fixed time ensured for BT traffic to gain the antenna during WLAN
363 CONF_SG_PASSIVE_SCAN_A2DP_BT_TIME,
366 * Fixed time ensured for WLAN traffic to gain the antenna during WLAN
371 CONF_SG_PASSIVE_SCAN_A2DP_WLAN_TIME,
374 * Number of consequent BT voice frames not interrupted by WLAN
378 CONF_SG_HV3_MAX_SERVED,
381 * Protection time of the DHCP procedure.
383 * Range: 0 - 100000 (ms)
388 * Compensation percentage of WLAN active scan window if initiated
391 * Range: 0 - 1000 (%)
393 CONF_SG_ACTIVE_SCAN_DURATION_FACTOR_A2DP,
394 CONF_SG_TEMP_PARAM_1,
395 CONF_SG_TEMP_PARAM_2,
396 CONF_SG_TEMP_PARAM_3,
397 CONF_SG_TEMP_PARAM_4,
398 CONF_SG_TEMP_PARAM_5,
400 CONF_SG_PARAMS_ALL = 0xff
403 struct conf_sg_settings {
404 u32 params[CONF_SG_PARAMS_MAX];
408 enum conf_rx_queue_type {
409 CONF_RX_QUEUE_TYPE_LOW_PRIORITY, /* All except the high priority */
410 CONF_RX_QUEUE_TYPE_HIGH_PRIORITY, /* Management and voice packets */
413 struct conf_rx_settings {
415 * The maximum amount of time, in TU, before the
416 * firmware discards the MSDU.
418 * Range: 0 - 0xFFFFFFFF
420 u32 rx_msdu_life_time;
423 * Packet detection threshold in the PHY.
425 * FIXME: details unknown.
427 u32 packet_detection_threshold;
430 * The longest time the STA will wait to receive traffic from the AP
431 * after a PS-poll has been transmitted.
437 * The longest time the STA will wait to receive traffic from the AP
438 * after a frame has been sent from an UPSD enabled queue.
445 * The number of octets in an MPDU, below which an RTS/CTS
446 * handshake is not performed.
453 * The RX Clear Channel Assessment threshold in the PHY
454 * (the energy threshold).
456 * Range: ENABLE_ENERGY_D == 0x140A
457 * DISABLE_ENERGY_D == 0xFFEF
459 u16 rx_cca_threshold;
462 * Occupied Rx mem-blocks number which requires interrupting the host
463 * (0 = no buffering, 0xffff = disabled).
467 u16 irq_blk_threshold;
470 * Rx packets number which requires interrupting the host
471 * (0 = no buffering).
475 u16 irq_pkt_threshold;
478 * Max time in msec the FW may delay RX-Complete interrupt.
487 * Range: RX_QUEUE_TYPE_RX_LOW_PRIORITY, RX_QUEUE_TYPE_RX_HIGH_PRIORITY,
492 #define CONF_TX_MAX_RATE_CLASSES 8
494 #define CONF_TX_RATE_MASK_UNSPECIFIED 0
495 #define CONF_TX_RATE_MASK_BASIC (CONF_HW_BIT_RATE_1MBPS | \
496 CONF_HW_BIT_RATE_2MBPS)
497 #define CONF_TX_RATE_RETRY_LIMIT 10
499 struct conf_tx_rate_class {
502 * The rates enabled for this rate class.
504 * Range: CONF_HW_BIT_RATE_* bit mask
509 * The dot11 short retry limit used for TX retries.
513 u8 short_retry_limit;
516 * The dot11 long retry limit used for TX retries.
523 * Flags controlling the attributes of TX transmission.
525 * Range: bit 0: Truncate - when set, FW attempts to send a frame stop
526 * when the total valid per-rate attempts have
527 * been exhausted; otherwise transmissions
528 * will continue at the lowest available rate
529 * until the appropriate one of the
530 * short_retry_limit, long_retry_limit,
531 * dot11_max_transmit_msdu_life_time, or
532 * max_tx_life_time, is exhausted.
533 * 1: Preamble Override - indicates if the preamble type
534 * should be used in TX.
535 * 2: Preamble Type - the type of the preamble to be used by
536 * the policy (0 - long preamble, 1 - short preamble.
541 #define CONF_TX_MAX_AC_COUNT 4
543 /* Slot number setting to start transmission at PIFS interval */
544 #define CONF_TX_AIFS_PIFS 1
545 /* Slot number setting to start transmission at DIFS interval normal
547 #define CONF_TX_AIFS_DIFS 2
551 CONF_TX_AC_BE = 0, /* best effort / legacy */
552 CONF_TX_AC_BK = 1, /* background */
553 CONF_TX_AC_VI = 2, /* video */
554 CONF_TX_AC_VO = 3, /* voice */
555 CONF_TX_AC_CTS2SELF = 4, /* fictious AC, follows AC_VO */
556 CONF_TX_AC_ANY_TID = 0x1f
559 struct conf_tx_ac_category {
561 * The AC class identifier.
563 * Range: enum conf_tx_ac
568 * The contention window minimum size (in slots) for the access
576 * The contention window maximum size (in slots) for the access
584 * The AIF value (in slots) for the access class.
591 * The TX Op Limit (in microseconds) for the access class.
598 #define CONF_TX_MAX_TID_COUNT 7
601 CONF_CHANNEL_TYPE_DCF = 0, /* DC/LEGACY*/
602 CONF_CHANNEL_TYPE_EDCF = 1, /* EDCA*/
603 CONF_CHANNEL_TYPE_HCCA = 2, /* HCCA*/
607 CONF_PS_SCHEME_LEGACY = 0,
608 CONF_PS_SCHEME_UPSD_TRIGGER = 1,
609 CONF_PS_SCHEME_LEGACY_PSPOLL = 2,
610 CONF_PS_SCHEME_SAPSD = 3,
614 CONF_ACK_POLICY_LEGACY = 0,
615 CONF_ACK_POLICY_NO_ACK = 1,
616 CONF_ACK_POLICY_BLOCK = 2,
629 struct conf_tx_settings {
631 * The TX ED value for TELEC Enable/Disable.
635 u8 tx_energy_detection;
638 * Configuration for rate classes for TX (currently only one
639 * rate class supported.)
641 struct conf_tx_rate_class rc_conf;
644 * Configuration for access categories for TX rate control.
647 struct conf_tx_ac_category ac_conf[CONF_TX_MAX_AC_COUNT];
650 * Configuration for TID parameters.
653 struct conf_tx_tid tid_conf[CONF_TX_MAX_TID_COUNT];
656 * The TX fragmentation threshold.
663 * Max time in msec the FW may delay frame TX-Complete interrupt.
667 u16 tx_compl_timeout;
670 * Completed TX packet count which requires to issue the TX-Complete
675 u16 tx_compl_threshold;
678 * The rate used for control messages and scanning on the 2.4GHz band
680 * Range: CONF_HW_BIT_RATE_* bit mask
685 * The rate used for control messages and scanning on the 5GHz band
687 * Range: CONF_HW_BIT_RATE_* bit mask
693 CONF_WAKE_UP_EVENT_BEACON = 0x01, /* Wake on every Beacon*/
694 CONF_WAKE_UP_EVENT_DTIM = 0x02, /* Wake on every DTIM*/
695 CONF_WAKE_UP_EVENT_N_DTIM = 0x04, /* Wake every Nth DTIM */
696 CONF_WAKE_UP_EVENT_N_BEACONS = 0x08, /* Wake every Nth beacon */
697 CONF_WAKE_UP_EVENT_BITS_MASK = 0x0F
700 #define CONF_MAX_BCN_FILT_IE_COUNT 32
702 #define CONF_BCN_RULE_PASS_ON_CHANGE BIT(0)
703 #define CONF_BCN_RULE_PASS_ON_APPEARANCE BIT(1)
705 #define CONF_BCN_IE_OUI_LEN 3
706 #define CONF_BCN_IE_VER_LEN 2
708 struct conf_bcn_filt_rule {
710 * IE number to which to associate a rule.
717 * Rule to associate with the specific ie.
719 * Range: CONF_BCN_RULE_PASS_ON_*
724 * OUI for the vendor specifie IE (221)
726 u8 oui[CONF_BCN_IE_OUI_LEN];
729 * Type for the vendor specifie IE (221)
734 * Version for the vendor specifie IE (221)
736 u8 version[CONF_BCN_IE_VER_LEN];
739 #define CONF_MAX_RSSI_SNR_TRIGGERS 8
742 CONF_TRIG_METRIC_RSSI_BEACON = 0,
743 CONF_TRIG_METRIC_RSSI_DATA,
744 CONF_TRIG_METRIC_SNR_BEACON,
745 CONF_TRIG_METRIC_SNR_DATA
749 CONF_TRIG_EVENT_TYPE_LEVEL = 0,
750 CONF_TRIG_EVENT_TYPE_EDGE
754 CONF_TRIG_EVENT_DIR_LOW = 0,
755 CONF_TRIG_EVENT_DIR_HIGH,
756 CONF_TRIG_EVENT_DIR_BIDIR
759 struct conf_sig_weights {
762 * RSSI from beacons average weight.
766 u8 rssi_bcn_avg_weight;
769 * RSSI from data average weight.
773 u8 rssi_pkt_avg_weight;
776 * SNR from beacons average weight.
780 u8 snr_bcn_avg_weight;
783 * SNR from data average weight.
787 u8 snr_pkt_avg_weight;
790 enum conf_bcn_filt_mode {
791 CONF_BCN_FILT_MODE_DISABLED = 0,
792 CONF_BCN_FILT_MODE_ENABLED = 1
796 CONF_BET_MODE_DISABLE = 0,
797 CONF_BET_MODE_ENABLE = 1,
800 struct conf_conn_settings {
802 * Firmware wakeup conditions configuration. The host may set only
805 * Range: CONF_WAKE_UP_EVENT_*
810 * Listen interval for beacons or Dtims.
812 * Range: 0 for beacon and Dtim wakeup
814 * 1-255 for x beacons
819 * Enable or disable the beacon filtering.
821 * Range: CONF_BCN_FILT_MODE_*
823 enum conf_bcn_filt_mode bcn_filt_mode;
826 * Configure Beacon filter pass-thru rules.
828 u8 bcn_filt_ie_count;
829 struct conf_bcn_filt_rule bcn_filt_ie[CONF_MAX_BCN_FILT_IE_COUNT];
832 * The number of consequtive beacons to lose, before the firmware
833 * becomes out of synch.
837 u32 synch_fail_thold;
840 * After out-of-synch, the number of TU's to wait without a further
841 * received beacon (or probe response) before issuing the BSS_EVENT_LOSE
846 u32 bss_lose_timeout;
849 * Beacon receive timeout.
853 u32 beacon_rx_timeout;
856 * Broadcast receive timeout.
860 u32 broadcast_timeout;
863 * Enable/disable reception of broadcast packets in power save mode
865 * Range: 1 - enable, 0 - disable
867 u8 rx_broadcast_in_ps;
870 * Consequtive PS Poll failures before sending event to driver
874 u8 ps_poll_threshold;
877 * Configuration of signal average weights.
879 struct conf_sig_weights sig_weights;
882 * Specifies if beacon early termination procedure is enabled or
885 * Range: CONF_BET_MODE_*
890 * Specifies the maximum number of consecutive beacons that may be
891 * early terminated. After this number is reached at least one full
892 * beacon must be correctly received in FW before beacon ET
897 u8 bet_max_consecutive;
900 * Specifies the maximum number of times to try PSM entry if it fails
901 * (if sending the appropriate null-func message fails.)
905 u8 psm_entry_retries;
909 * Specifies the interval of the connection keep-alive null-func
912 * Range: 1000 - 3600000
914 u32 keep_alive_interval;
917 * Maximum listen interval supported by the driver in units of beacons.
921 u8 max_listen_interval;
931 enum single_dual_band_enum {
936 #define CONF_RSSI_AND_PROCESS_COMPENSATION_SIZE 15
937 #define CONF_NUMBER_OF_SUB_BANDS_5 7
938 #define CONF_NUMBER_OF_RATE_GROUPS 6
939 #define CONF_NUMBER_OF_CHANNELS_2_4 14
940 #define CONF_NUMBER_OF_CHANNELS_5 35
942 struct conf_radio_parms {
944 * FEM parameter set to use
951 struct conf_init_settings {
953 * Configure radio parameters.
955 struct conf_radio_parms radioparam;
959 struct conf_itrim_settings {
960 /* enable dco itrim */
963 /* moderation timeout in microsecs from the last TX */
967 struct conf_pm_config_settings {
969 * Host clock settling time
971 * Range: 0 - 30000 us
973 u32 host_clk_settling_time;
976 * Host fast wakeup support
980 bool host_fast_wakeup_support;
983 struct conf_roam_trigger_settings {
985 * The minimum interval between two trigger events.
987 * Range: 0 - 60000 ms
992 * The weight for rssi/beacon average calculation
996 u8 avg_weight_rssi_beacon;
999 * The weight for rssi/data frame average calculation
1003 u8 avg_weight_rssi_data;
1006 * The weight for snr/beacon average calculation
1010 u8 avg_weight_snr_beacon;
1013 * The weight for snr/data frame average calculation
1017 u8 avg_weight_snr_data;
1020 struct conf_drv_settings {
1021 struct conf_sg_settings sg;
1022 struct conf_rx_settings rx;
1023 struct conf_tx_settings tx;
1024 struct conf_conn_settings conn;
1025 struct conf_init_settings init;
1026 struct conf_itrim_settings itrim;
1027 struct conf_pm_config_settings pm_config;
1028 struct conf_roam_trigger_settings roam_trigger;