1 /******************************************************************************
3 * This file is provided under a dual BSD/GPLv2 license. When using or
4 * redistributing this file, you may do so under either license.
8 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of version 2 of the GNU General Public License as
12 * published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
24 * The full GNU General Public License is included in this distribution
25 * in the file called COPYING.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
40 * * Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * * Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in
44 * the documentation and/or other materials provided with the
46 * * Neither the name Intel Corporation nor the names of its
47 * contributors may be used to endorse or promote products derived
48 * from this software without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62 *****************************************************************************/
67 #include "fw-api-rs.h"
68 #include "fw-api-tx.h"
69 #include "fw-api-sta.h"
70 #include "fw-api-mac.h"
71 #include "fw-api-power.h"
72 #include "fw-api-d3.h"
73 #include "fw-api-bt-coex.h"
75 /* maximal number of Tx queues in any platform */
76 #define IWL_MVM_MAX_QUEUES 20
78 /* Tx queue numbers */
80 IWL_MVM_OFFCHANNEL_QUEUE = 8,
81 IWL_MVM_CMD_QUEUE = 9,
84 #define IWL_MVM_CMD_FIFO 7
86 #define IWL_MVM_STATION_COUNT 16
93 INIT_COMPLETE_NOTIF = 0x4,
95 /* PHY context commands */
96 PHY_CONTEXT_CMD = 0x8,
107 MGMT_MCAST_KEY = 0x1f,
112 /* MAC and Binding commands */
113 MAC_CONTEXT_CMD = 0x28,
114 TIME_EVENT_CMD = 0x29, /* both CMD and response */
115 TIME_EVENT_NOTIFICATION = 0x2a,
116 BINDING_CONTEXT_CMD = 0x2b,
117 TIME_QUOTA_CMD = 0x2c,
118 NON_QOS_TX_COUNTER_CMD = 0x2d,
123 TEMPERATURE_NOTIFICATION = 0x62,
124 CALIBRATION_CFG_CMD = 0x65,
125 CALIBRATION_RES_NOTIFICATION = 0x66,
126 CALIBRATION_COMPLETE_NOTIFICATION = 0x67,
127 RADIO_VERSION_NOTIFICATION = 0x68,
130 SCAN_OFFLOAD_REQUEST_CMD = 0x51,
131 SCAN_OFFLOAD_ABORT_CMD = 0x52,
132 SCAN_OFFLOAD_COMPLETE = 0x6D,
133 SCAN_OFFLOAD_UPDATE_PROFILES_CMD = 0x6E,
134 SCAN_OFFLOAD_CONFIG_CMD = 0x6f,
135 MATCH_FOUND_NOTIFICATION = 0xd9,
138 PHY_CONFIGURATION_CMD = 0x6a,
139 CALIB_RES_NOTIF_PHY_DB = 0x6b,
140 /* PHY_DB_CMD = 0x6c, */
142 /* Power - legacy power table command */
143 POWER_TABLE_CMD = 0x77,
144 PSM_UAPSD_AP_MISBEHAVING_NOTIFICATION = 0x78,
146 /* Thermal Throttling*/
147 REPLY_THERMAL_MNG_BACKOFF = 0x7e,
150 SCAN_REQUEST_CMD = 0x80,
151 SCAN_ABORT_CMD = 0x81,
152 SCAN_START_NOTIFICATION = 0x82,
153 SCAN_RESULTS_NOTIFICATION = 0x83,
154 SCAN_COMPLETE_NOTIFICATION = 0x84,
157 NVM_ACCESS_CMD = 0x88,
159 SET_CALIB_DEFAULT_CMD = 0x8e,
161 BEACON_NOTIFICATION = 0x90,
162 BEACON_TEMPLATE_CMD = 0x91,
163 TX_ANT_CONFIGURATION_CMD = 0x98,
165 STATISTICS_NOTIFICATION = 0x9d,
166 EOSP_NOTIFICATION = 0x9e,
167 REDUCE_TX_POWER_CMD = 0x9f,
169 /* RF-KILL commands and notifications */
170 CARD_STATE_CMD = 0xa0,
171 CARD_STATE_NOTIFICATION = 0xa1,
173 MISSED_BEACONS_NOTIFICATION = 0xa2,
175 /* Power - new power table command */
176 MAC_PM_POWER_TABLE = 0xa9,
178 REPLY_RX_PHY_CMD = 0xc0,
179 REPLY_RX_MPDU_CMD = 0xc1,
183 BT_COEX_PRIO_TABLE = 0xcc,
184 BT_COEX_PROT_ENV = 0xcd,
185 BT_PROFILE_NOTIFICATION = 0xce,
188 REPLY_SF_CFG_CMD = 0xd1,
189 REPLY_BEACON_FILTERING_CMD = 0xd2,
191 REPLY_DEBUG_CMD = 0xf0,
192 DEBUG_LOG_MSG = 0xf7,
194 BCAST_FILTER_CMD = 0xcf,
195 MCAST_FILTER_CMD = 0xd0,
197 /* D3 commands/notifications */
198 D3_CONFIG_CMD = 0xd3,
199 PROT_OFFLOAD_CONFIG_CMD = 0xd4,
200 OFFLOADS_QUERY_CMD = 0xd5,
201 REMOTE_WAKE_CONFIG_CMD = 0xd6,
204 /* for WoWLAN in particular */
205 WOWLAN_PATTERNS = 0xe0,
206 WOWLAN_CONFIGURATION = 0xe1,
207 WOWLAN_TSC_RSC_PARAM = 0xe2,
208 WOWLAN_TKIP_PARAM = 0xe3,
209 WOWLAN_KEK_KCK_MATERIAL = 0xe4,
210 WOWLAN_GET_STATUSES = 0xe5,
211 WOWLAN_TX_POWER_PER_DB = 0xe6,
213 /* and for NetDetect */
214 NET_DETECT_CONFIG_CMD = 0x54,
215 NET_DETECT_PROFILES_QUERY_CMD = 0x56,
216 NET_DETECT_PROFILES_CMD = 0x57,
217 NET_DETECT_HOTSPOTS_CMD = 0x58,
218 NET_DETECT_HOTSPOTS_QUERY_CMD = 0x59,
224 * struct iwl_cmd_response - generic response struct for most commands
225 * @status: status of the command asked, changes for each one
227 struct iwl_cmd_response {
232 * struct iwl_tx_ant_cfg_cmd
233 * @valid: valid antenna configuration
235 struct iwl_tx_ant_cfg_cmd {
240 * struct iwl_reduce_tx_power_cmd - TX power reduction command
241 * REDUCE_TX_POWER_CMD = 0x9f
242 * @flags: (reserved for future implementation)
243 * @mac_context_id: id of the mac ctx for which we are reducing TX power.
244 * @pwr_restriction: TX power restriction in dBms.
246 struct iwl_reduce_tx_power_cmd {
249 __le16 pwr_restriction;
250 } __packed; /* TX_REDUCED_POWER_API_S_VER_1 */
253 * Calibration control struct.
254 * Sent as part of the phy configuration command.
255 * @flow_trigger: bitmap for which calibrations to perform according to
257 * @event_trigger: bitmap for which calibrations to perform according to
260 struct iwl_calib_ctrl {
262 __le32 event_trigger;
265 /* This enum defines the bitmap of various calibrations to enable in both
266 * init ucode and runtime ucode through CALIBRATION_CFG_CMD.
269 IWL_CALIB_CFG_XTAL_IDX = BIT(0),
270 IWL_CALIB_CFG_TEMPERATURE_IDX = BIT(1),
271 IWL_CALIB_CFG_VOLTAGE_READ_IDX = BIT(2),
272 IWL_CALIB_CFG_PAPD_IDX = BIT(3),
273 IWL_CALIB_CFG_TX_PWR_IDX = BIT(4),
274 IWL_CALIB_CFG_DC_IDX = BIT(5),
275 IWL_CALIB_CFG_BB_FILTER_IDX = BIT(6),
276 IWL_CALIB_CFG_LO_LEAKAGE_IDX = BIT(7),
277 IWL_CALIB_CFG_TX_IQ_IDX = BIT(8),
278 IWL_CALIB_CFG_TX_IQ_SKEW_IDX = BIT(9),
279 IWL_CALIB_CFG_RX_IQ_IDX = BIT(10),
280 IWL_CALIB_CFG_RX_IQ_SKEW_IDX = BIT(11),
281 IWL_CALIB_CFG_SENSITIVITY_IDX = BIT(12),
282 IWL_CALIB_CFG_CHAIN_NOISE_IDX = BIT(13),
283 IWL_CALIB_CFG_DISCONNECTED_ANT_IDX = BIT(14),
284 IWL_CALIB_CFG_ANT_COUPLING_IDX = BIT(15),
285 IWL_CALIB_CFG_DAC_IDX = BIT(16),
286 IWL_CALIB_CFG_ABS_IDX = BIT(17),
287 IWL_CALIB_CFG_AGC_IDX = BIT(18),
291 * Phy configuration command.
293 struct iwl_phy_cfg_cmd {
295 struct iwl_calib_ctrl calib_control;
298 #define PHY_CFG_RADIO_TYPE (BIT(0) | BIT(1))
299 #define PHY_CFG_RADIO_STEP (BIT(2) | BIT(3))
300 #define PHY_CFG_RADIO_DASH (BIT(4) | BIT(5))
301 #define PHY_CFG_PRODUCT_NUMBER (BIT(6) | BIT(7))
302 #define PHY_CFG_TX_CHAIN_A BIT(8)
303 #define PHY_CFG_TX_CHAIN_B BIT(9)
304 #define PHY_CFG_TX_CHAIN_C BIT(10)
305 #define PHY_CFG_RX_CHAIN_A BIT(12)
306 #define PHY_CFG_RX_CHAIN_B BIT(13)
307 #define PHY_CFG_RX_CHAIN_C BIT(14)
309 #define NVM_MAX_NUM_SECTIONS 11
311 /* Target of the NVM_ACCESS_CMD */
313 NVM_ACCESS_TARGET_CACHE = 0,
314 NVM_ACCESS_TARGET_OTP = 1,
315 NVM_ACCESS_TARGET_EEPROM = 2,
318 /* Section types for NVM_ACCESS_CMD */
320 NVM_SECTION_TYPE_SW = 1,
321 NVM_SECTION_TYPE_CALIBRATION = 4,
322 NVM_SECTION_TYPE_PRODUCTION = 5,
326 * struct iwl_nvm_access_cmd_ver2 - Request the device to send an NVM section
327 * @op_code: 0 - read, 1 - write
328 * @target: NVM_ACCESS_TARGET_*
329 * @type: NVM_SECTION_TYPE_*
330 * @offset: offset in bytes into the section
331 * @length: in bytes, to read/write
332 * @data: if write operation, the data to write. On read its empty
334 struct iwl_nvm_access_cmd {
341 } __packed; /* NVM_ACCESS_CMD_API_S_VER_2 */
344 * struct iwl_nvm_access_resp_ver2 - response to NVM_ACCESS_CMD
345 * @offset: offset in bytes into the section
346 * @length: in bytes, either how much was written or read
347 * @type: NVM_SECTION_TYPE_*
348 * @status: 0 for success, fail otherwise
349 * @data: if read operation, the data returned. Empty on write.
351 struct iwl_nvm_access_resp {
357 } __packed; /* NVM_ACCESS_CMD_RESP_API_S_VER_2 */
361 /* alive response is_valid values */
362 #define ALIVE_RESP_UCODE_OK BIT(0)
363 #define ALIVE_RESP_RFKILL BIT(1)
365 /* alive response ver_type values */
375 /* alive response ver_subtype values */
377 FW_SUBTYPE_FULL_FEATURE = 0,
378 FW_SUBTYPE_BOOTSRAP = 1, /* Not valid */
379 FW_SUBTYPE_REDUCED = 2,
380 FW_SUBTYPE_ALIVE_ONLY = 3,
381 FW_SUBTYPE_WOWLAN = 4,
382 FW_SUBTYPE_AP_SUBTYPE = 5,
383 FW_SUBTYPE_WIPAN = 6,
384 FW_SUBTYPE_INITIALIZE = 9
387 #define IWL_ALIVE_STATUS_ERR 0xDEAD
388 #define IWL_ALIVE_STATUS_OK 0xCAFE
390 #define IWL_ALIVE_FLG_RFKILL BIT(0)
392 struct mvm_alive_resp {
406 __le32 error_event_table_ptr; /* SRAM address for error log */
407 __le32 log_event_table_ptr; /* SRAM address for event log */
408 __le32 cpu_register_ptr;
409 __le32 dbgm_config_ptr;
410 __le32 alive_counter_ptr;
411 __le32 scd_base_ptr; /* SRAM address for SCD */
412 } __packed; /* ALIVE_RES_API_S_VER_1 */
414 struct mvm_alive_resp_ver2 {
428 __le32 error_event_table_ptr; /* SRAM address for error log */
429 __le32 log_event_table_ptr; /* SRAM address for LMAC event log */
430 __le32 cpu_register_ptr;
431 __le32 dbgm_config_ptr;
432 __le32 alive_counter_ptr;
433 __le32 scd_base_ptr; /* SRAM address for SCD */
434 __le32 st_fwrd_addr; /* pointer to Store and forward */
436 u8 umac_minor; /* UMAC version: minor */
437 u8 umac_major; /* UMAC version: major */
438 __le16 umac_id; /* UMAC version: id */
439 __le32 error_info_addr; /* SRAM address for UMAC error log */
440 __le32 dbg_print_buff_addr;
441 } __packed; /* ALIVE_RES_API_S_VER_2 */
443 /* Error response/notification */
445 FW_ERR_UNKNOWN_CMD = 0x0,
446 FW_ERR_INVALID_CMD_PARAM = 0x1,
447 FW_ERR_SERVICE = 0x2,
448 FW_ERR_ARC_MEMORY = 0x3,
449 FW_ERR_ARC_CODE = 0x4,
450 FW_ERR_WATCH_DOG = 0x5,
451 FW_ERR_WEP_GRP_KEY_INDX = 0x10,
452 FW_ERR_WEP_KEY_SIZE = 0x11,
453 FW_ERR_OBSOLETE_FUNC = 0x12,
454 FW_ERR_UNEXPECTED = 0xFE,
459 * struct iwl_error_resp - FW error indication
460 * ( REPLY_ERROR = 0x2 )
461 * @error_type: one of FW_ERR_*
462 * @cmd_id: the command ID for which the error occured
463 * @bad_cmd_seq_num: sequence number of the erroneous command
464 * @error_service: which service created the error, applicable only if
465 * error_type = 2, otherwise 0
466 * @timestamp: TSF in usecs.
468 struct iwl_error_resp {
472 __le16 bad_cmd_seq_num;
473 __le32 error_service;
478 /* Common PHY, MAC and Bindings definitions */
480 #define MAX_MACS_IN_BINDING (3)
481 #define MAX_BINDINGS (4)
482 #define AUX_BINDING_INDEX (3)
485 /* Used to extract ID and color from the context dword */
486 #define FW_CTXT_ID_POS (0)
487 #define FW_CTXT_ID_MSK (0xff << FW_CTXT_ID_POS)
488 #define FW_CTXT_COLOR_POS (8)
489 #define FW_CTXT_COLOR_MSK (0xff << FW_CTXT_COLOR_POS)
490 #define FW_CTXT_INVALID (0xffffffff)
492 #define FW_CMD_ID_AND_COLOR(_id, _color) ((_id << FW_CTXT_ID_POS) |\
493 (_color << FW_CTXT_COLOR_POS))
495 /* Possible actions on PHYs, MACs and Bindings */
497 FW_CTXT_ACTION_STUB = 0,
499 FW_CTXT_ACTION_MODIFY,
500 FW_CTXT_ACTION_REMOVE,
502 }; /* COMMON_CONTEXT_ACTION_API_E_VER_1 */
506 /* Time Event types, according to MAC type */
507 enum iwl_time_event_type {
508 /* BSS Station Events */
509 TE_BSS_STA_AGGRESSIVE_ASSOC,
511 TE_BSS_EAP_DHCP_PROT,
514 /* P2P Device Events */
515 TE_P2P_DEVICE_DISCOVERABLE,
516 TE_P2P_DEVICE_LISTEN,
517 TE_P2P_DEVICE_ACTION_SCAN,
518 TE_P2P_DEVICE_FULL_SCAN,
520 /* P2P Client Events */
521 TE_P2P_CLIENT_AGGRESSIVE_ASSOC,
523 TE_P2P_CLIENT_QUIET_PERIOD,
526 TE_P2P_GO_ASSOC_PROT,
527 TE_P2P_GO_REPETITIVE_NOA,
530 /* WiDi Sync Events */
534 }; /* MAC_EVENT_TYPE_API_E_VER_1 */
538 /* Time event - defines for command API v1 */
541 * @TE_V1_FRAG_NONE: fragmentation of the time event is NOT allowed.
542 * @TE_V1_FRAG_SINGLE: fragmentation of the time event is allowed, but only
543 * the first fragment is scheduled.
544 * @TE_V1_FRAG_DUAL: fragmentation of the time event is allowed, but only
545 * the first 2 fragments are scheduled.
546 * @TE_V1_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
547 * number of fragments are valid.
549 * Other than the constant defined above, specifying a fragmentation value 'x'
550 * means that the event can be fragmented but only the first 'x' will be
555 TE_V1_FRAG_SINGLE = 1,
557 TE_V1_FRAG_ENDLESS = 0xffffffff
560 /* If a Time Event can be fragmented, this is the max number of fragments */
561 #define TE_V1_FRAG_MAX_MSK 0x0fffffff
562 /* Repeat the time event endlessly (until removed) */
563 #define TE_V1_REPEAT_ENDLESS 0xffffffff
564 /* If a Time Event has bounded repetitions, this is the maximal value */
565 #define TE_V1_REPEAT_MAX_MSK_V1 0x0fffffff
567 /* Time Event dependencies: none, on another TE, or in a specific time */
569 TE_V1_INDEPENDENT = 0,
570 TE_V1_DEP_OTHER = BIT(0),
571 TE_V1_DEP_TSF = BIT(1),
572 TE_V1_EVENT_SOCIOPATHIC = BIT(2),
573 }; /* MAC_EVENT_DEPENDENCY_POLICY_API_E_VER_2 */
576 * @TE_V1_NOTIF_NONE: no notifications
577 * @TE_V1_NOTIF_HOST_EVENT_START: request/receive notification on event start
578 * @TE_V1_NOTIF_HOST_EVENT_END:request/receive notification on event end
579 * @TE_V1_NOTIF_INTERNAL_EVENT_START: internal FW use
580 * @TE_V1_NOTIF_INTERNAL_EVENT_END: internal FW use.
581 * @TE_V1_NOTIF_HOST_FRAG_START: request/receive notification on frag start
582 * @TE_V1_NOTIF_HOST_FRAG_END:request/receive notification on frag end
583 * @TE_V1_NOTIF_INTERNAL_FRAG_START: internal FW use.
584 * @TE_V1_NOTIF_INTERNAL_FRAG_END: internal FW use.
586 * Supported Time event notifications configuration.
587 * A notification (both event and fragment) includes a status indicating weather
588 * the FW was able to schedule the event or not. For fragment start/end
589 * notification the status is always success. There is no start/end fragment
590 * notification for monolithic events.
593 TE_V1_NOTIF_NONE = 0,
594 TE_V1_NOTIF_HOST_EVENT_START = BIT(0),
595 TE_V1_NOTIF_HOST_EVENT_END = BIT(1),
596 TE_V1_NOTIF_INTERNAL_EVENT_START = BIT(2),
597 TE_V1_NOTIF_INTERNAL_EVENT_END = BIT(3),
598 TE_V1_NOTIF_HOST_FRAG_START = BIT(4),
599 TE_V1_NOTIF_HOST_FRAG_END = BIT(5),
600 TE_V1_NOTIF_INTERNAL_FRAG_START = BIT(6),
601 TE_V1_NOTIF_INTERNAL_FRAG_END = BIT(7),
602 }; /* MAC_EVENT_ACTION_API_E_VER_2 */
606 * struct iwl_time_event_cmd_api_v1 - configuring Time Events
607 * with struct MAC_TIME_EVENT_DATA_API_S_VER_1 (see also
608 * with version 2. determined by IWL_UCODE_TLV_FLAGS)
609 * ( TIME_EVENT_CMD = 0x29 )
610 * @id_and_color: ID and color of the relevant MAC
611 * @action: action to perform, one of FW_CTXT_ACTION_*
612 * @id: this field has two meanings, depending on the action:
613 * If the action is ADD, then it means the type of event to add.
614 * For all other actions it is the unique event ID assigned when the
615 * event was added by the FW.
616 * @apply_time: When to start the Time Event (in GP2)
617 * @max_delay: maximum delay to event's start (apply time), in TU
618 * @depends_on: the unique ID of the event we depend on (if any)
619 * @interval: interval between repetitions, in TU
620 * @interval_reciprocal: 2^32 / interval
621 * @duration: duration of event in TU
622 * @repeat: how many repetitions to do, can be TE_REPEAT_ENDLESS
623 * @dep_policy: one of TE_V1_INDEPENDENT, TE_V1_DEP_OTHER, TE_V1_DEP_TSF
624 * and TE_V1_EVENT_SOCIOPATHIC
625 * @is_present: 0 or 1, are we present or absent during the Time Event
626 * @max_frags: maximal number of fragments the Time Event can be divided to
627 * @notify: notifications using TE_V1_NOTIF_* (whom to notify when)
629 struct iwl_time_event_cmd_v1 {
630 /* COMMON_INDEX_HDR_API_S_VER_1 */
634 /* MAC_TIME_EVENT_DATA_API_S_VER_1 */
642 __le32 interval_reciprocal;
646 } __packed; /* MAC_TIME_EVENT_CMD_API_S_VER_1 */
649 /* Time event - defines for command API v2 */
652 * @TE_V2_FRAG_NONE: fragmentation of the time event is NOT allowed.
653 * @TE_V2_FRAG_SINGLE: fragmentation of the time event is allowed, but only
654 * the first fragment is scheduled.
655 * @TE_V2_FRAG_DUAL: fragmentation of the time event is allowed, but only
656 * the first 2 fragments are scheduled.
657 * @TE_V2_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
658 * number of fragments are valid.
660 * Other than the constant defined above, specifying a fragmentation value 'x'
661 * means that the event can be fragmented but only the first 'x' will be
666 TE_V2_FRAG_SINGLE = 1,
668 TE_V2_FRAG_MAX = 0xfe,
669 TE_V2_FRAG_ENDLESS = 0xff
672 /* Repeat the time event endlessly (until removed) */
673 #define TE_V2_REPEAT_ENDLESS 0xff
674 /* If a Time Event has bounded repetitions, this is the maximal value */
675 #define TE_V2_REPEAT_MAX 0xfe
677 #define TE_V2_PLACEMENT_POS 12
678 #define TE_V2_ABSENCE_POS 15
680 /* Time event policy values (for time event cmd api v2)
681 * A notification (both event and fragment) includes a status indicating weather
682 * the FW was able to schedule the event or not. For fragment start/end
683 * notification the status is always success. There is no start/end fragment
684 * notification for monolithic events.
686 * @TE_V2_DEFAULT_POLICY: independent, social, present, unoticable
687 * @TE_V2_NOTIF_HOST_EVENT_START: request/receive notification on event start
688 * @TE_V2_NOTIF_HOST_EVENT_END:request/receive notification on event end
689 * @TE_V2_NOTIF_INTERNAL_EVENT_START: internal FW use
690 * @TE_V2_NOTIF_INTERNAL_EVENT_END: internal FW use.
691 * @TE_V2_NOTIF_HOST_FRAG_START: request/receive notification on frag start
692 * @TE_V2_NOTIF_HOST_FRAG_END:request/receive notification on frag end
693 * @TE_V2_NOTIF_INTERNAL_FRAG_START: internal FW use.
694 * @TE_V2_NOTIF_INTERNAL_FRAG_END: internal FW use.
695 * @TE_V2_DEP_OTHER: depends on another time event
696 * @TE_V2_DEP_TSF: depends on a specific time
697 * @TE_V2_EVENT_SOCIOPATHIC: can't co-exist with other events of tha same MAC
698 * @TE_V2_ABSENCE: are we present or absent during the Time Event.
701 TE_V2_DEFAULT_POLICY = 0x0,
703 /* notifications (event start/stop, fragment start/stop) */
704 TE_V2_NOTIF_HOST_EVENT_START = BIT(0),
705 TE_V2_NOTIF_HOST_EVENT_END = BIT(1),
706 TE_V2_NOTIF_INTERNAL_EVENT_START = BIT(2),
707 TE_V2_NOTIF_INTERNAL_EVENT_END = BIT(3),
709 TE_V2_NOTIF_HOST_FRAG_START = BIT(4),
710 TE_V2_NOTIF_HOST_FRAG_END = BIT(5),
711 TE_V2_NOTIF_INTERNAL_FRAG_START = BIT(6),
712 TE_V2_NOTIF_INTERNAL_FRAG_END = BIT(7),
714 TE_V2_NOTIF_MSK = 0xff,
716 /* placement characteristics */
717 TE_V2_DEP_OTHER = BIT(TE_V2_PLACEMENT_POS),
718 TE_V2_DEP_TSF = BIT(TE_V2_PLACEMENT_POS + 1),
719 TE_V2_EVENT_SOCIOPATHIC = BIT(TE_V2_PLACEMENT_POS + 2),
721 /* are we present or absent during the Time Event. */
722 TE_V2_ABSENCE = BIT(TE_V2_ABSENCE_POS),
726 * struct iwl_time_event_cmd_api_v2 - configuring Time Events
727 * with struct MAC_TIME_EVENT_DATA_API_S_VER_2 (see also
728 * with version 1. determined by IWL_UCODE_TLV_FLAGS)
729 * ( TIME_EVENT_CMD = 0x29 )
730 * @id_and_color: ID and color of the relevant MAC
731 * @action: action to perform, one of FW_CTXT_ACTION_*
732 * @id: this field has two meanings, depending on the action:
733 * If the action is ADD, then it means the type of event to add.
734 * For all other actions it is the unique event ID assigned when the
735 * event was added by the FW.
736 * @apply_time: When to start the Time Event (in GP2)
737 * @max_delay: maximum delay to event's start (apply time), in TU
738 * @depends_on: the unique ID of the event we depend on (if any)
739 * @interval: interval between repetitions, in TU
740 * @duration: duration of event in TU
741 * @repeat: how many repetitions to do, can be TE_REPEAT_ENDLESS
742 * @max_frags: maximal number of fragments the Time Event can be divided to
743 * @policy: defines whether uCode shall notify the host or other uCode modules
744 * on event and/or fragment start and/or end
745 * using one of TE_INDEPENDENT, TE_DEP_OTHER, TE_DEP_TSF
746 * TE_EVENT_SOCIOPATHIC
747 * using TE_ABSENCE and using TE_NOTIF_*
749 struct iwl_time_event_cmd_v2 {
750 /* COMMON_INDEX_HDR_API_S_VER_1 */
754 /* MAC_TIME_EVENT_DATA_API_S_VER_2 */
763 } __packed; /* MAC_TIME_EVENT_CMD_API_S_VER_2 */
766 * struct iwl_time_event_resp - response structure to iwl_time_event_cmd
767 * @status: bit 0 indicates success, all others specify errors
768 * @id: the Time Event type
769 * @unique_id: the unique ID assigned (in ADD) or given (others) to the TE
770 * @id_and_color: ID and color of the relevant MAC
772 struct iwl_time_event_resp {
777 } __packed; /* MAC_TIME_EVENT_RSP_API_S_VER_1 */
780 * struct iwl_time_event_notif - notifications of time event start/stop
781 * ( TIME_EVENT_NOTIFICATION = 0x2a )
782 * @timestamp: action timestamp in GP2
783 * @session_id: session's unique id
784 * @unique_id: unique id of the Time Event itself
785 * @id_and_color: ID and color of the relevant MAC
786 * @action: one of TE_NOTIF_START or TE_NOTIF_END
787 * @status: true if scheduled, false otherwise (not executed)
789 struct iwl_time_event_notif {
796 } __packed; /* MAC_TIME_EVENT_NTFY_API_S_VER_1 */
799 /* Bindings and Time Quota */
802 * struct iwl_binding_cmd - configuring bindings
803 * ( BINDING_CONTEXT_CMD = 0x2b )
804 * @id_and_color: ID and color of the relevant Binding
805 * @action: action to perform, one of FW_CTXT_ACTION_*
806 * @macs: array of MAC id and colors which belong to the binding
807 * @phy: PHY id and color which belongs to the binding
809 struct iwl_binding_cmd {
810 /* COMMON_INDEX_HDR_API_S_VER_1 */
813 /* BINDING_DATA_API_S_VER_1 */
814 __le32 macs[MAX_MACS_IN_BINDING];
816 } __packed; /* BINDING_CMD_API_S_VER_1 */
818 /* The maximal number of fragments in the FW's schedule session */
819 #define IWL_MVM_MAX_QUOTA 128
822 * struct iwl_time_quota_data - configuration of time quota per binding
823 * @id_and_color: ID and color of the relevant Binding
824 * @quota: absolute time quota in TU. The scheduler will try to divide the
825 * remainig quota (after Time Events) according to this quota.
826 * @max_duration: max uninterrupted context duration in TU
828 struct iwl_time_quota_data {
832 } __packed; /* TIME_QUOTA_DATA_API_S_VER_1 */
835 * struct iwl_time_quota_cmd - configuration of time quota between bindings
836 * ( TIME_QUOTA_CMD = 0x2c )
837 * @quotas: allocations per binding
839 struct iwl_time_quota_cmd {
840 struct iwl_time_quota_data quotas[MAX_BINDINGS];
841 } __packed; /* TIME_QUOTA_ALLOCATION_CMD_API_S_VER_1 */
846 /* Supported bands */
847 #define PHY_BAND_5 (0)
848 #define PHY_BAND_24 (1)
850 /* Supported channel width, vary if there is VHT support */
851 #define PHY_VHT_CHANNEL_MODE20 (0x0)
852 #define PHY_VHT_CHANNEL_MODE40 (0x1)
853 #define PHY_VHT_CHANNEL_MODE80 (0x2)
854 #define PHY_VHT_CHANNEL_MODE160 (0x3)
857 * Control channel position:
858 * For legacy set bit means upper channel, otherwise lower.
859 * For VHT - bit-2 marks if the control is lower/upper relative to center-freq
860 * bits-1:0 mark the distance from the center freq. for 20Mhz, offset is 0.
863 * 40Mhz |_______|_______|
864 * 80Mhz |_______|_______|_______|_______|
865 * 160Mhz |_______|_______|_______|_______|_______|_______|_______|_______|
866 * code 011 010 001 000 | 100 101 110 111
868 #define PHY_VHT_CTRL_POS_1_BELOW (0x0)
869 #define PHY_VHT_CTRL_POS_2_BELOW (0x1)
870 #define PHY_VHT_CTRL_POS_3_BELOW (0x2)
871 #define PHY_VHT_CTRL_POS_4_BELOW (0x3)
872 #define PHY_VHT_CTRL_POS_1_ABOVE (0x4)
873 #define PHY_VHT_CTRL_POS_2_ABOVE (0x5)
874 #define PHY_VHT_CTRL_POS_3_ABOVE (0x6)
875 #define PHY_VHT_CTRL_POS_4_ABOVE (0x7)
879 * @channel: channel number
880 * @width: PHY_[VHT|LEGACY]_CHANNEL_*
881 * @ctrl channel: PHY_[VHT|LEGACY]_CTRL_*
883 struct iwl_fw_channel_info {
890 #define PHY_RX_CHAIN_DRIVER_FORCE_POS (0)
891 #define PHY_RX_CHAIN_DRIVER_FORCE_MSK \
892 (0x1 << PHY_RX_CHAIN_DRIVER_FORCE_POS)
893 #define PHY_RX_CHAIN_VALID_POS (1)
894 #define PHY_RX_CHAIN_VALID_MSK \
895 (0x7 << PHY_RX_CHAIN_VALID_POS)
896 #define PHY_RX_CHAIN_FORCE_SEL_POS (4)
897 #define PHY_RX_CHAIN_FORCE_SEL_MSK \
898 (0x7 << PHY_RX_CHAIN_FORCE_SEL_POS)
899 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
900 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_MSK \
901 (0x7 << PHY_RX_CHAIN_FORCE_MIMO_SEL_POS)
902 #define PHY_RX_CHAIN_CNT_POS (10)
903 #define PHY_RX_CHAIN_CNT_MSK \
904 (0x3 << PHY_RX_CHAIN_CNT_POS)
905 #define PHY_RX_CHAIN_MIMO_CNT_POS (12)
906 #define PHY_RX_CHAIN_MIMO_CNT_MSK \
907 (0x3 << PHY_RX_CHAIN_MIMO_CNT_POS)
908 #define PHY_RX_CHAIN_MIMO_FORCE_POS (14)
909 #define PHY_RX_CHAIN_MIMO_FORCE_MSK \
910 (0x1 << PHY_RX_CHAIN_MIMO_FORCE_POS)
912 /* TODO: fix the value, make it depend on firmware at runtime? */
913 #define NUM_PHY_CTX 3
915 /* TODO: complete missing documentation */
917 * struct iwl_phy_context_cmd - config of the PHY context
918 * ( PHY_CONTEXT_CMD = 0x8 )
919 * @id_and_color: ID and color of the relevant Binding
920 * @action: action to perform, one of FW_CTXT_ACTION_*
921 * @apply_time: 0 means immediate apply and context switch.
922 * other value means apply new params after X usecs
923 * @tx_param_color: ???
927 * @acquisition_data: ???
928 * @dsp_cfg_flags: set to 0
930 struct iwl_phy_context_cmd {
931 /* COMMON_INDEX_HDR_API_S_VER_1 */
934 /* PHY_CONTEXT_DATA_API_S_VER_1 */
936 __le32 tx_param_color;
937 struct iwl_fw_channel_info ci;
940 __le32 acquisition_data;
941 __le32 dsp_cfg_flags;
942 } __packed; /* PHY_CONTEXT_CMD_API_VER_1 */
944 #define IWL_RX_INFO_PHY_CNT 8
945 #define IWL_RX_INFO_ENERGY_ANT_ABC_IDX 1
946 #define IWL_RX_INFO_ENERGY_ANT_A_MSK 0x000000ff
947 #define IWL_RX_INFO_ENERGY_ANT_B_MSK 0x0000ff00
948 #define IWL_RX_INFO_ENERGY_ANT_C_MSK 0x00ff0000
949 #define IWL_RX_INFO_ENERGY_ANT_A_POS 0
950 #define IWL_RX_INFO_ENERGY_ANT_B_POS 8
951 #define IWL_RX_INFO_ENERGY_ANT_C_POS 16
953 #define IWL_RX_INFO_AGC_IDX 1
954 #define IWL_RX_INFO_RSSI_AB_IDX 2
955 #define IWL_OFDM_AGC_A_MSK 0x0000007f
956 #define IWL_OFDM_AGC_A_POS 0
957 #define IWL_OFDM_AGC_B_MSK 0x00003f80
958 #define IWL_OFDM_AGC_B_POS 7
959 #define IWL_OFDM_AGC_CODE_MSK 0x3fe00000
960 #define IWL_OFDM_AGC_CODE_POS 20
961 #define IWL_OFDM_RSSI_INBAND_A_MSK 0x00ff
962 #define IWL_OFDM_RSSI_A_POS 0
963 #define IWL_OFDM_RSSI_ALLBAND_A_MSK 0xff00
964 #define IWL_OFDM_RSSI_ALLBAND_A_POS 8
965 #define IWL_OFDM_RSSI_INBAND_B_MSK 0xff0000
966 #define IWL_OFDM_RSSI_B_POS 16
967 #define IWL_OFDM_RSSI_ALLBAND_B_MSK 0xff000000
968 #define IWL_OFDM_RSSI_ALLBAND_B_POS 24
971 * struct iwl_rx_phy_info - phy info
972 * (REPLY_RX_PHY_CMD = 0xc0)
973 * @non_cfg_phy_cnt: non configurable DSP phy data byte count
974 * @cfg_phy_cnt: configurable DSP phy data byte count
975 * @stat_id: configurable DSP phy data set ID
977 * @system_timestamp: GP2 at on air rise
978 * @timestamp: TSF at on air rise
979 * @beacon_time_stamp: beacon at on-air rise
980 * @phy_flags: general phy flags: band, modulation, ...
981 * @channel: channel number
982 * @non_cfg_phy_buf: for various implementations of non_cfg_phy
983 * @rate_n_flags: RATE_MCS_*
984 * @byte_count: frame's byte-count
985 * @frame_time: frame's time on the air, based on byte count and frame rate
987 * @mac_active_msk: what MACs were active when the frame was received
989 * Before each Rx, the device sends this data. It contains PHY information
990 * about the reception of the packet.
992 struct iwl_rx_phy_info {
997 __le32 system_timestamp;
999 __le32 beacon_time_stamp;
1002 __le32 non_cfg_phy[IWL_RX_INFO_PHY_CNT];
1003 __le32 rate_n_flags;
1005 __le16 mac_active_msk;
1009 struct iwl_rx_mpdu_res_start {
1015 * enum iwl_rx_phy_flags - to parse %iwl_rx_phy_info phy_flags
1016 * @RX_RES_PHY_FLAGS_BAND_24: true if the packet was received on 2.4 band
1017 * @RX_RES_PHY_FLAGS_MOD_CCK:
1018 * @RX_RES_PHY_FLAGS_SHORT_PREAMBLE: true if packet's preamble was short
1019 * @RX_RES_PHY_FLAGS_NARROW_BAND:
1020 * @RX_RES_PHY_FLAGS_ANTENNA: antenna on which the packet was received
1021 * @RX_RES_PHY_FLAGS_AGG: set if the packet was part of an A-MPDU
1022 * @RX_RES_PHY_FLAGS_OFDM_HT: The frame was an HT frame
1023 * @RX_RES_PHY_FLAGS_OFDM_GF: The frame used GF preamble
1024 * @RX_RES_PHY_FLAGS_OFDM_VHT: The frame was a VHT frame
1026 enum iwl_rx_phy_flags {
1027 RX_RES_PHY_FLAGS_BAND_24 = BIT(0),
1028 RX_RES_PHY_FLAGS_MOD_CCK = BIT(1),
1029 RX_RES_PHY_FLAGS_SHORT_PREAMBLE = BIT(2),
1030 RX_RES_PHY_FLAGS_NARROW_BAND = BIT(3),
1031 RX_RES_PHY_FLAGS_ANTENNA = (0x7 << 4),
1032 RX_RES_PHY_FLAGS_ANTENNA_POS = 4,
1033 RX_RES_PHY_FLAGS_AGG = BIT(7),
1034 RX_RES_PHY_FLAGS_OFDM_HT = BIT(8),
1035 RX_RES_PHY_FLAGS_OFDM_GF = BIT(9),
1036 RX_RES_PHY_FLAGS_OFDM_VHT = BIT(10),
1040 * enum iwl_mvm_rx_status - written by fw for each Rx packet
1041 * @RX_MPDU_RES_STATUS_CRC_OK: CRC is fine
1042 * @RX_MPDU_RES_STATUS_OVERRUN_OK: there was no RXE overflow
1043 * @RX_MPDU_RES_STATUS_SRC_STA_FOUND:
1044 * @RX_MPDU_RES_STATUS_KEY_VALID:
1045 * @RX_MPDU_RES_STATUS_KEY_PARAM_OK:
1046 * @RX_MPDU_RES_STATUS_ICV_OK: ICV is fine, if not, the packet is destroyed
1047 * @RX_MPDU_RES_STATUS_MIC_OK: used for CCM alg only. TKIP MIC is checked
1049 * @RX_MPDU_RES_STATUS_TTAK_OK: TTAK is fine
1050 * @RX_MPDU_RES_STATUS_MNG_FRAME_REPLAY_ERR: valid for alg = CCM_CMAC or
1051 * alg = CCM only. Checks replay attack for 11w frames. Relevant only if
1052 * %RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME is set.
1053 * @RX_MPDU_RES_STATUS_SEC_NO_ENC: this frame is not encrypted
1054 * @RX_MPDU_RES_STATUS_SEC_WEP_ENC: this frame is encrypted using WEP
1055 * @RX_MPDU_RES_STATUS_SEC_CCM_ENC: this frame is encrypted using CCM
1056 * @RX_MPDU_RES_STATUS_SEC_TKIP_ENC: this frame is encrypted using TKIP
1057 * @RX_MPDU_RES_STATUS_SEC_CCM_CMAC_ENC: this frame is encrypted using CCM_CMAC
1058 * @RX_MPDU_RES_STATUS_SEC_ENC_ERR: this frame couldn't be decrypted
1059 * @RX_MPDU_RES_STATUS_SEC_ENC_MSK: bitmask of the encryption algorithm
1060 * @RX_MPDU_RES_STATUS_DEC_DONE: this frame has been successfully decrypted
1061 * @RX_MPDU_RES_STATUS_PROTECT_FRAME_BIT_CMP:
1062 * @RX_MPDU_RES_STATUS_EXT_IV_BIT_CMP:
1063 * @RX_MPDU_RES_STATUS_KEY_ID_CMP_BIT:
1064 * @RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME: this frame is an 11w management frame
1065 * @RX_MPDU_RES_STATUS_HASH_INDEX_MSK:
1066 * @RX_MPDU_RES_STATUS_STA_ID_MSK:
1067 * @RX_MPDU_RES_STATUS_RRF_KILL:
1068 * @RX_MPDU_RES_STATUS_FILTERING_MSK:
1069 * @RX_MPDU_RES_STATUS2_FILTERING_MSK:
1071 enum iwl_mvm_rx_status {
1072 RX_MPDU_RES_STATUS_CRC_OK = BIT(0),
1073 RX_MPDU_RES_STATUS_OVERRUN_OK = BIT(1),
1074 RX_MPDU_RES_STATUS_SRC_STA_FOUND = BIT(2),
1075 RX_MPDU_RES_STATUS_KEY_VALID = BIT(3),
1076 RX_MPDU_RES_STATUS_KEY_PARAM_OK = BIT(4),
1077 RX_MPDU_RES_STATUS_ICV_OK = BIT(5),
1078 RX_MPDU_RES_STATUS_MIC_OK = BIT(6),
1079 RX_MPDU_RES_STATUS_TTAK_OK = BIT(7),
1080 RX_MPDU_RES_STATUS_MNG_FRAME_REPLAY_ERR = BIT(7),
1081 RX_MPDU_RES_STATUS_SEC_NO_ENC = (0 << 8),
1082 RX_MPDU_RES_STATUS_SEC_WEP_ENC = (1 << 8),
1083 RX_MPDU_RES_STATUS_SEC_CCM_ENC = (2 << 8),
1084 RX_MPDU_RES_STATUS_SEC_TKIP_ENC = (3 << 8),
1085 RX_MPDU_RES_STATUS_SEC_EXT_ENC = (4 << 8),
1086 RX_MPDU_RES_STATUS_SEC_CCM_CMAC_ENC = (6 << 8),
1087 RX_MPDU_RES_STATUS_SEC_ENC_ERR = (7 << 8),
1088 RX_MPDU_RES_STATUS_SEC_ENC_MSK = (7 << 8),
1089 RX_MPDU_RES_STATUS_DEC_DONE = BIT(11),
1090 RX_MPDU_RES_STATUS_PROTECT_FRAME_BIT_CMP = BIT(12),
1091 RX_MPDU_RES_STATUS_EXT_IV_BIT_CMP = BIT(13),
1092 RX_MPDU_RES_STATUS_KEY_ID_CMP_BIT = BIT(14),
1093 RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME = BIT(15),
1094 RX_MPDU_RES_STATUS_HASH_INDEX_MSK = (0x3F0000),
1095 RX_MPDU_RES_STATUS_STA_ID_MSK = (0x1f000000),
1096 RX_MPDU_RES_STATUS_RRF_KILL = BIT(29),
1097 RX_MPDU_RES_STATUS_FILTERING_MSK = (0xc00000),
1098 RX_MPDU_RES_STATUS2_FILTERING_MSK = (0xc0000000),
1102 * struct iwl_radio_version_notif - information on the radio version
1103 * ( RADIO_VERSION_NOTIFICATION = 0x68 )
1108 struct iwl_radio_version_notif {
1109 __le32 radio_flavor;
1112 } __packed; /* RADIO_VERSION_NOTOFICATION_S_VER_1 */
1114 enum iwl_card_state_flags {
1115 CARD_ENABLED = 0x00,
1116 HW_CARD_DISABLED = 0x01,
1117 SW_CARD_DISABLED = 0x02,
1118 CT_KILL_CARD_DISABLED = 0x04,
1119 HALT_CARD_DISABLED = 0x08,
1120 CARD_DISABLED_MSK = 0x0f,
1121 CARD_IS_RX_ON = 0x10,
1125 * struct iwl_radio_version_notif - information on the radio version
1126 * ( CARD_STATE_NOTIFICATION = 0xa1 )
1127 * @flags: %iwl_card_state_flags
1129 struct iwl_card_state_notif {
1131 } __packed; /* CARD_STATE_NTFY_API_S_VER_1 */
1134 * struct iwl_missed_beacons_notif - information on missed beacons
1135 * ( MISSED_BEACONS_NOTIFICATION = 0xa2 )
1136 * @mac_id: interface ID
1137 * @consec_missed_beacons_since_last_rx: number of consecutive missed
1138 * beacons since last RX.
1139 * @consec_missed_beacons: number of consecutive missed beacons
1140 * @num_expected_beacons:
1141 * @num_recvd_beacons:
1143 struct iwl_missed_beacons_notif {
1145 __le32 consec_missed_beacons_since_last_rx;
1146 __le32 consec_missed_beacons;
1147 __le32 num_expected_beacons;
1148 __le32 num_recvd_beacons;
1149 } __packed; /* MISSED_BEACON_NTFY_API_S_VER_3 */
1152 * struct iwl_set_calib_default_cmd - set default value for calibration.
1153 * ( SET_CALIB_DEFAULT_CMD = 0x8e )
1154 * @calib_index: the calibration to set value for
1156 * @data: the value to set for the calibration result
1158 struct iwl_set_calib_default_cmd {
1162 } __packed; /* PHY_CALIB_OVERRIDE_VALUES_S */
1164 #define MAX_PORT_ID_NUM 2
1165 #define MAX_MCAST_FILTERING_ADDRESSES 256
1168 * struct iwl_mcast_filter_cmd - configure multicast filter.
1169 * @filter_own: Set 1 to filter out multicast packets sent by station itself
1170 * @port_id: Multicast MAC addresses array specifier. This is a strange way
1171 * to identify network interface adopted in host-device IF.
1172 * It is used by FW as index in array of addresses. This array has
1173 * MAX_PORT_ID_NUM members.
1174 * @count: Number of MAC addresses in the array
1175 * @pass_all: Set 1 to pass all multicast packets.
1176 * @bssid: current association BSSID.
1177 * @addr_list: Place holder for array of MAC addresses.
1178 * IMPORTANT: add padding if necessary to ensure DWORD alignment.
1180 struct iwl_mcast_filter_cmd {
1188 } __packed; /* MCAST_FILTERING_CMD_API_S_VER_1 */
1190 #define MAX_BCAST_FILTERS 8
1191 #define MAX_BCAST_FILTER_ATTRS 2
1194 * enum iwl_mvm_bcast_filter_attr_offset - written by fw for each Rx packet
1195 * @BCAST_FILTER_OFFSET_PAYLOAD_START: offset is from payload start.
1196 * @BCAST_FILTER_OFFSET_IP_END: offset is from ip header end (i.e.
1197 * start of ip payload).
1199 enum iwl_mvm_bcast_filter_attr_offset {
1200 BCAST_FILTER_OFFSET_PAYLOAD_START = 0,
1201 BCAST_FILTER_OFFSET_IP_END = 1,
1205 * struct iwl_fw_bcast_filter_attr - broadcast filter attribute
1206 * @offset_type: &enum iwl_mvm_bcast_filter_attr_offset.
1207 * @offset: starting offset of this pattern.
1208 * @val: value to match - big endian (MSB is the first
1209 * byte to match from offset pos).
1210 * @mask: mask to match (big endian).
1212 struct iwl_fw_bcast_filter_attr {
1218 } __packed; /* BCAST_FILTER_ATT_S_VER_1 */
1221 * enum iwl_mvm_bcast_filter_frame_type - filter frame type
1222 * @BCAST_FILTER_FRAME_TYPE_ALL: consider all frames.
1223 * @BCAST_FILTER_FRAME_TYPE_IPV4: consider only ipv4 frames
1225 enum iwl_mvm_bcast_filter_frame_type {
1226 BCAST_FILTER_FRAME_TYPE_ALL = 0,
1227 BCAST_FILTER_FRAME_TYPE_IPV4 = 1,
1231 * struct iwl_fw_bcast_filter - broadcast filter
1232 * @discard: discard frame (1) or let it pass (0).
1233 * @frame_type: &enum iwl_mvm_bcast_filter_frame_type.
1234 * @num_attrs: number of valid attributes in this filter.
1235 * @attrs: attributes of this filter. a filter is considered matched
1236 * only when all its attributes are matched (i.e. AND relationship)
1238 struct iwl_fw_bcast_filter {
1243 struct iwl_fw_bcast_filter_attr attrs[MAX_BCAST_FILTER_ATTRS];
1244 } __packed; /* BCAST_FILTER_S_VER_1 */
1247 * struct iwl_fw_bcast_mac - per-mac broadcast filtering configuration.
1248 * @default_discard: default action for this mac (discard (1) / pass (0)).
1249 * @attached_filters: bitmap of relevant filters for this mac.
1251 struct iwl_fw_bcast_mac {
1254 __le16 attached_filters;
1255 } __packed; /* BCAST_MAC_CONTEXT_S_VER_1 */
1258 * struct iwl_bcast_filter_cmd - broadcast filtering configuration
1259 * @disable: enable (0) / disable (1)
1260 * @max_bcast_filters: max number of filters (MAX_BCAST_FILTERS)
1261 * @max_macs: max number of macs (NUM_MAC_INDEX_DRIVER)
1262 * @filters: broadcast filters
1263 * @macs: broadcast filtering configuration per-mac
1265 struct iwl_bcast_filter_cmd {
1267 u8 max_bcast_filters;
1270 struct iwl_fw_bcast_filter filters[MAX_BCAST_FILTERS];
1271 struct iwl_fw_bcast_mac macs[NUM_MAC_INDEX_DRIVER];
1272 } __packed; /* BCAST_FILTERING_HCMD_API_S_VER_1 */
1274 struct mvm_statistics_dbg {
1277 __le32 wait_for_silence_timeout_cnt;
1279 } __packed; /* STATISTICS_DEBUG_API_S_VER_2 */
1281 struct mvm_statistics_div {
1288 } __packed; /* STATISTICS_SLOW_DIV_API_S_VER_2 */
1290 struct mvm_statistics_general_common {
1291 __le32 temperature; /* radio temperature */
1292 __le32 temperature_m; /* radio voltage */
1293 struct mvm_statistics_dbg dbg;
1297 __le32 ttl_timestamp;
1298 struct mvm_statistics_div div;
1299 __le32 rx_enable_counter;
1301 * num_of_sos_states:
1302 * count the number of times we have to re-tune
1303 * in order to get out of bad PHY status
1305 __le32 num_of_sos_states;
1306 } __packed; /* STATISTICS_GENERAL_API_S_VER_5 */
1308 struct mvm_statistics_rx_non_phy {
1309 __le32 bogus_cts; /* CTS received when not expecting CTS */
1310 __le32 bogus_ack; /* ACK received when not expecting ACK */
1311 __le32 non_bssid_frames; /* number of frames with BSSID that
1312 * doesn't belong to the STA BSSID */
1313 __le32 filtered_frames; /* count frames that were dumped in the
1314 * filtering process */
1315 __le32 non_channel_beacons; /* beacons with our bss id but not on
1316 * our serving channel */
1317 __le32 channel_beacons; /* beacons with our bss id and in our
1318 * serving channel */
1319 __le32 num_missed_bcon; /* number of missed beacons */
1320 __le32 adc_rx_saturation_time; /* count in 0.8us units the time the
1321 * ADC was in saturation */
1322 __le32 ina_detection_search_time;/* total time (in 0.8us) searched
1324 __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */
1325 __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */
1326 __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */
1327 __le32 interference_data_flag; /* flag for interference data
1328 * availability. 1 when data is
1330 __le32 channel_load; /* counts RX Enable time in uSec */
1331 __le32 dsp_false_alarms; /* DSP false alarm (both OFDM
1332 * and CCK) counter */
1333 __le32 beacon_rssi_a;
1334 __le32 beacon_rssi_b;
1335 __le32 beacon_rssi_c;
1336 __le32 beacon_energy_a;
1337 __le32 beacon_energy_b;
1338 __le32 beacon_energy_c;
1339 __le32 num_bt_kills;
1341 __le32 directed_data_mpdu;
1342 } __packed; /* STATISTICS_RX_NON_PHY_API_S_VER_3 */
1344 struct mvm_statistics_rx_phy {
1350 __le32 early_overrun_err;
1352 __le32 false_alarm_cnt;
1353 __le32 fina_sync_err_cnt;
1355 __le32 fina_timeout;
1356 __le32 unresponded_rts;
1357 __le32 rxe_frame_limit_overrun;
1358 __le32 sent_ack_cnt;
1359 __le32 sent_cts_cnt;
1360 __le32 sent_ba_rsp_cnt;
1361 __le32 dsp_self_kill;
1362 __le32 mh_format_err;
1363 __le32 re_acq_main_rssi_sum;
1365 } __packed; /* STATISTICS_RX_PHY_API_S_VER_2 */
1367 struct mvm_statistics_rx_ht_phy {
1370 __le32 early_overrun_err;
1373 __le32 mh_format_err;
1374 __le32 agg_crc32_good;
1375 __le32 agg_mpdu_cnt;
1377 __le32 unsupport_mcs;
1378 } __packed; /* STATISTICS_HT_RX_PHY_API_S_VER_1 */
1380 #define MAX_CHAINS 3
1382 struct mvm_statistics_tx_non_phy_agg {
1384 __le32 ba_reschedule_frames;
1385 __le32 scd_query_agg_frame_cnt;
1386 __le32 scd_query_no_agg;
1387 __le32 scd_query_agg;
1388 __le32 scd_query_mismatch;
1389 __le32 frame_not_ready;
1391 __le32 bt_prio_kill;
1392 __le32 rx_ba_rsp_cnt;
1393 __s8 txpower[MAX_CHAINS];
1396 } __packed; /* STATISTICS_TX_NON_PHY_AGG_API_S_VER_1 */
1398 struct mvm_statistics_tx_channel_width {
1399 __le32 ext_cca_narrow_ch20[1];
1400 __le32 ext_cca_narrow_ch40[2];
1401 __le32 ext_cca_narrow_ch80[3];
1402 __le32 ext_cca_narrow_ch160[4];
1403 __le32 last_tx_ch_width_indx;
1404 __le32 rx_detected_per_ch_width[4];
1405 __le32 success_per_ch_width[4];
1406 __le32 fail_per_ch_width[4];
1407 }; /* STATISTICS_TX_CHANNEL_WIDTH_API_S_VER_1 */
1409 struct mvm_statistics_tx {
1410 __le32 preamble_cnt;
1411 __le32 rx_detected_cnt;
1412 __le32 bt_prio_defer_cnt;
1413 __le32 bt_prio_kill_cnt;
1414 __le32 few_bytes_cnt;
1417 __le32 expected_ack_cnt;
1418 __le32 actual_ack_cnt;
1419 __le32 dump_msdu_cnt;
1420 __le32 burst_abort_next_frame_mismatch_cnt;
1421 __le32 burst_abort_missing_next_frame_cnt;
1422 __le32 cts_timeout_collision;
1423 __le32 ack_or_ba_timeout_collision;
1424 struct mvm_statistics_tx_non_phy_agg agg;
1425 struct mvm_statistics_tx_channel_width channel_width;
1426 } __packed; /* STATISTICS_TX_API_S_VER_4 */
1429 struct mvm_statistics_bt_activity {
1430 __le32 hi_priority_tx_req_cnt;
1431 __le32 hi_priority_tx_denied_cnt;
1432 __le32 lo_priority_tx_req_cnt;
1433 __le32 lo_priority_tx_denied_cnt;
1434 __le32 hi_priority_rx_req_cnt;
1435 __le32 hi_priority_rx_denied_cnt;
1436 __le32 lo_priority_rx_req_cnt;
1437 __le32 lo_priority_rx_denied_cnt;
1438 } __packed; /* STATISTICS_BT_ACTIVITY_API_S_VER_1 */
1440 struct mvm_statistics_general {
1441 struct mvm_statistics_general_common common;
1442 __le32 beacon_filtered;
1443 __le32 missed_beacons;
1444 __s8 beacon_filter_average_energy;
1445 __s8 beacon_filter_reason;
1446 __s8 beacon_filter_current_energy;
1447 __s8 beacon_filter_reserved;
1448 __le32 beacon_filter_delta_time;
1449 struct mvm_statistics_bt_activity bt_activity;
1450 } __packed; /* STATISTICS_GENERAL_API_S_VER_5 */
1452 struct mvm_statistics_rx {
1453 struct mvm_statistics_rx_phy ofdm;
1454 struct mvm_statistics_rx_phy cck;
1455 struct mvm_statistics_rx_non_phy general;
1456 struct mvm_statistics_rx_ht_phy ofdm_ht;
1457 } __packed; /* STATISTICS_RX_API_S_VER_3 */
1460 * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
1462 * By default, uCode issues this notification after receiving a beacon
1463 * while associated. To disable this behavior, set DISABLE_NOTIF flag in the
1464 * REPLY_STATISTICS_CMD 0x9c, above.
1466 * Statistics counters continue to increment beacon after beacon, but are
1467 * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
1468 * 0x9c with CLEAR_STATS bit set (see above).
1470 * uCode also issues this notification during scans. uCode clears statistics
1471 * appropriately so that each notification contains statistics for only the
1472 * one channel that has just been scanned.
1475 struct iwl_notif_statistics { /* STATISTICS_NTFY_API_S_VER_8 */
1477 struct mvm_statistics_rx rx;
1478 struct mvm_statistics_tx tx;
1479 struct mvm_statistics_general general;
1482 /***********************************
1484 ***********************************/
1485 /* Smart Fifo state */
1487 SF_LONG_DELAY_ON = 0, /* should never be called by driver */
1494 /* Smart Fifo possible scenario */
1495 enum iwl_sf_scenario {
1496 SF_SCENARIO_SINGLE_UNICAST,
1497 SF_SCENARIO_AGG_UNICAST,
1498 SF_SCENARIO_MULTICAST,
1499 SF_SCENARIO_BA_RESP,
1500 SF_SCENARIO_TX_RESP,
1504 #define SF_TRANSIENT_STATES_NUMBER 2 /* SF_LONG_DELAY_ON and SF_FULL_ON */
1505 #define SF_NUM_TIMEOUT_TYPES 2 /* Aging timer and Idle timer */
1507 /* smart FIFO default values */
1508 #define SF_W_MARK_SISO 4096
1509 #define SF_W_MARK_MIMO2 8192
1510 #define SF_W_MARK_MIMO3 6144
1511 #define SF_W_MARK_LEGACY 4096
1512 #define SF_W_MARK_SCAN 4096
1514 /* SF Scenarios timers for FULL_ON state (aligned to 32 uSec) */
1515 #define SF_SINGLE_UNICAST_IDLE_TIMER 320 /* 300 uSec */
1516 #define SF_SINGLE_UNICAST_AGING_TIMER 2016 /* 2 mSec */
1517 #define SF_AGG_UNICAST_IDLE_TIMER 320 /* 300 uSec */
1518 #define SF_AGG_UNICAST_AGING_TIMER 2016 /* 2 mSec */
1519 #define SF_MCAST_IDLE_TIMER 2016 /* 2 mSec */
1520 #define SF_MCAST_AGING_TIMER 10016 /* 10 mSec */
1521 #define SF_BA_IDLE_TIMER 320 /* 300 uSec */
1522 #define SF_BA_AGING_TIMER 2016 /* 2 mSec */
1523 #define SF_TX_RE_IDLE_TIMER 320 /* 300 uSec */
1524 #define SF_TX_RE_AGING_TIMER 2016 /* 2 mSec */
1526 #define SF_LONG_DELAY_AGING_TIMER 1000000 /* 1 Sec */
1529 * Smart Fifo configuration command.
1530 * @state: smart fifo state, types listed in iwl_sf_sate.
1531 * @watermark: Minimum allowed availabe free space in RXF for transient state.
1532 * @long_delay_timeouts: aging and idle timer values for each scenario
1533 * in long delay state.
1534 * @full_on_timeouts: timer values for each scenario in full on state.
1536 struct iwl_sf_cfg_cmd {
1537 enum iwl_sf_state state;
1538 __le32 watermark[SF_TRANSIENT_STATES_NUMBER];
1539 __le32 long_delay_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES];
1540 __le32 full_on_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES];
1541 } __packed; /* SF_CFG_API_S_VER_2 */
1543 #endif /* __fw_api_h__ */