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.
9 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of version 2 of the GNU General Public License as
13 * published by the Free Software Foundation.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
25 * The full GNU General Public License is included in this distribution
26 * in the file called COPYING.
28 * Contact Information:
29 * Intel Linux Wireless <ilw@linux.intel.com>
30 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
34 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
35 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
36 * All rights reserved.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
42 * * Redistributions of source code must retain the above copyright
43 * notice, this list of conditions and the following disclaimer.
44 * * Redistributions in binary form must reproduce the above copyright
45 * notice, this list of conditions and the following disclaimer in
46 * the documentation and/or other materials provided with the
48 * * Neither the name Intel Corporation nor the names of its
49 * contributors may be used to endorse or promote products derived
50 * from this software without specific prior written permission.
52 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
53 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
54 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
55 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
56 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
57 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
58 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
59 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
60 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
61 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
62 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
64 *****************************************************************************/
69 #include "fw-api-rs.h"
70 #include "fw-api-tx.h"
71 #include "fw-api-sta.h"
72 #include "fw-api-mac.h"
73 #include "fw-api-power.h"
74 #include "fw-api-d3.h"
75 #include "fw-api-coex.h"
76 #include "fw-api-scan.h"
77 #include "fw-api-stats.h"
79 /* Tx queue numbers */
81 IWL_MVM_OFFCHANNEL_QUEUE
= 8,
82 IWL_MVM_CMD_QUEUE
= 9,
85 enum iwl_mvm_tx_fifo
{
86 IWL_MVM_TX_FIFO_BK
= 0,
90 IWL_MVM_TX_FIFO_MCAST
= 5,
91 IWL_MVM_TX_FIFO_CMD
= 7,
94 #define IWL_MVM_STATION_COUNT 16
96 #define IWL_MVM_TDLS_STA_COUNT 4
103 INIT_COMPLETE_NOTIF
= 0x4,
105 /* PHY context commands */
106 PHY_CONTEXT_CMD
= 0x8,
108 ANTENNA_COUPLING_NOTIFICATION
= 0xa,
110 /* UMAC scan commands */
113 SCAN_ABORT_UMAC
= 0xe,
114 SCAN_COMPLETE_UMAC
= 0xf,
124 MGMT_MCAST_KEY
= 0x1f,
126 /* scheduler config */
127 SCD_QUEUE_CFG
= 0x1d,
133 SHARED_MEM_CFG
= 0x25,
136 TDLS_CHANNEL_SWITCH_CMD
= 0x27,
137 TDLS_CHANNEL_SWITCH_NOTIFICATION
= 0xaa,
138 TDLS_CONFIG_CMD
= 0xa7,
140 /* MAC and Binding commands */
141 MAC_CONTEXT_CMD
= 0x28,
142 TIME_EVENT_CMD
= 0x29, /* both CMD and response */
143 TIME_EVENT_NOTIFICATION
= 0x2a,
144 BINDING_CONTEXT_CMD
= 0x2b,
145 TIME_QUOTA_CMD
= 0x2c,
146 NON_QOS_TX_COUNTER_CMD
= 0x2d,
151 TEMPERATURE_NOTIFICATION
= 0x62,
152 CALIBRATION_CFG_CMD
= 0x65,
153 CALIBRATION_RES_NOTIFICATION
= 0x66,
154 CALIBRATION_COMPLETE_NOTIFICATION
= 0x67,
155 RADIO_VERSION_NOTIFICATION
= 0x68,
158 SCAN_OFFLOAD_REQUEST_CMD
= 0x51,
159 SCAN_OFFLOAD_ABORT_CMD
= 0x52,
161 SCAN_OFFLOAD_COMPLETE
= 0x6D,
162 SCAN_OFFLOAD_UPDATE_PROFILES_CMD
= 0x6E,
163 SCAN_OFFLOAD_CONFIG_CMD
= 0x6f,
164 MATCH_FOUND_NOTIFICATION
= 0xd9,
165 SCAN_ITERATION_COMPLETE
= 0xe7,
168 PHY_CONFIGURATION_CMD
= 0x6a,
169 CALIB_RES_NOTIF_PHY_DB
= 0x6b,
170 /* PHY_DB_CMD = 0x6c, */
172 /* Power - legacy power table command */
173 POWER_TABLE_CMD
= 0x77,
174 PSM_UAPSD_AP_MISBEHAVING_NOTIFICATION
= 0x78,
177 /* Thermal Throttling*/
178 REPLY_THERMAL_MNG_BACKOFF
= 0x7e,
181 SCAN_REQUEST_CMD
= 0x80,
182 SCAN_ABORT_CMD
= 0x81,
183 SCAN_START_NOTIFICATION
= 0x82,
184 SCAN_RESULTS_NOTIFICATION
= 0x83,
185 SCAN_COMPLETE_NOTIFICATION
= 0x84,
188 NVM_ACCESS_CMD
= 0x88,
190 SET_CALIB_DEFAULT_CMD
= 0x8e,
192 BEACON_NOTIFICATION
= 0x90,
193 BEACON_TEMPLATE_CMD
= 0x91,
194 TX_ANT_CONFIGURATION_CMD
= 0x98,
195 STATISTICS_CMD
= 0x9c,
196 STATISTICS_NOTIFICATION
= 0x9d,
197 EOSP_NOTIFICATION
= 0x9e,
198 REDUCE_TX_POWER_CMD
= 0x9f,
200 /* RF-KILL commands and notifications */
201 CARD_STATE_CMD
= 0xa0,
202 CARD_STATE_NOTIFICATION
= 0xa1,
204 MISSED_BEACONS_NOTIFICATION
= 0xa2,
206 /* Power - new power table command */
207 MAC_PM_POWER_TABLE
= 0xa9,
209 MFUART_LOAD_NOTIFICATION
= 0xb1,
211 REPLY_RX_PHY_CMD
= 0xc0,
212 REPLY_RX_MPDU_CMD
= 0xc1,
218 BT_COEX_PRIO_TABLE
= 0xcc,
219 BT_COEX_PROT_ENV
= 0xcd,
220 BT_PROFILE_NOTIFICATION
= 0xce,
222 BT_COEX_UPDATE_SW_BOOST
= 0x5a,
223 BT_COEX_UPDATE_CORUN_LUT
= 0x5b,
224 BT_COEX_UPDATE_REDUCED_TXP
= 0x5c,
227 REPLY_SF_CFG_CMD
= 0xd1,
228 REPLY_BEACON_FILTERING_CMD
= 0xd2,
230 /* DTS measurements */
231 CMD_DTS_MEASUREMENT_TRIGGER
= 0xdc,
232 DTS_MEASUREMENT_NOTIFICATION
= 0xdd,
234 REPLY_DEBUG_CMD
= 0xf0,
235 DEBUG_LOG_MSG
= 0xf7,
237 BCAST_FILTER_CMD
= 0xcf,
238 MCAST_FILTER_CMD
= 0xd0,
240 /* D3 commands/notifications */
241 D3_CONFIG_CMD
= 0xd3,
242 PROT_OFFLOAD_CONFIG_CMD
= 0xd4,
243 OFFLOADS_QUERY_CMD
= 0xd5,
244 REMOTE_WAKE_CONFIG_CMD
= 0xd6,
247 /* for WoWLAN in particular */
248 WOWLAN_PATTERNS
= 0xe0,
249 WOWLAN_CONFIGURATION
= 0xe1,
250 WOWLAN_TSC_RSC_PARAM
= 0xe2,
251 WOWLAN_TKIP_PARAM
= 0xe3,
252 WOWLAN_KEK_KCK_MATERIAL
= 0xe4,
253 WOWLAN_GET_STATUSES
= 0xe5,
254 WOWLAN_TX_POWER_PER_DB
= 0xe6,
256 /* and for NetDetect */
257 SCAN_OFFLOAD_PROFILES_QUERY_CMD
= 0x56,
258 SCAN_OFFLOAD_HOTSPOTS_CONFIG_CMD
= 0x58,
259 SCAN_OFFLOAD_HOTSPOTS_QUERY_CMD
= 0x59,
265 * struct iwl_cmd_response - generic response struct for most commands
266 * @status: status of the command asked, changes for each one
268 struct iwl_cmd_response
{
273 * struct iwl_tx_ant_cfg_cmd
274 * @valid: valid antenna configuration
276 struct iwl_tx_ant_cfg_cmd
{
281 * struct iwl_reduce_tx_power_cmd - TX power reduction command
282 * REDUCE_TX_POWER_CMD = 0x9f
283 * @flags: (reserved for future implementation)
284 * @mac_context_id: id of the mac ctx for which we are reducing TX power.
285 * @pwr_restriction: TX power restriction in dBms.
287 struct iwl_reduce_tx_power_cmd
{
290 __le16 pwr_restriction
;
291 } __packed
; /* TX_REDUCED_POWER_API_S_VER_1 */
294 * Calibration control struct.
295 * Sent as part of the phy configuration command.
296 * @flow_trigger: bitmap for which calibrations to perform according to
298 * @event_trigger: bitmap for which calibrations to perform according to
301 struct iwl_calib_ctrl
{
303 __le32 event_trigger
;
306 /* This enum defines the bitmap of various calibrations to enable in both
307 * init ucode and runtime ucode through CALIBRATION_CFG_CMD.
310 IWL_CALIB_CFG_XTAL_IDX
= BIT(0),
311 IWL_CALIB_CFG_TEMPERATURE_IDX
= BIT(1),
312 IWL_CALIB_CFG_VOLTAGE_READ_IDX
= BIT(2),
313 IWL_CALIB_CFG_PAPD_IDX
= BIT(3),
314 IWL_CALIB_CFG_TX_PWR_IDX
= BIT(4),
315 IWL_CALIB_CFG_DC_IDX
= BIT(5),
316 IWL_CALIB_CFG_BB_FILTER_IDX
= BIT(6),
317 IWL_CALIB_CFG_LO_LEAKAGE_IDX
= BIT(7),
318 IWL_CALIB_CFG_TX_IQ_IDX
= BIT(8),
319 IWL_CALIB_CFG_TX_IQ_SKEW_IDX
= BIT(9),
320 IWL_CALIB_CFG_RX_IQ_IDX
= BIT(10),
321 IWL_CALIB_CFG_RX_IQ_SKEW_IDX
= BIT(11),
322 IWL_CALIB_CFG_SENSITIVITY_IDX
= BIT(12),
323 IWL_CALIB_CFG_CHAIN_NOISE_IDX
= BIT(13),
324 IWL_CALIB_CFG_DISCONNECTED_ANT_IDX
= BIT(14),
325 IWL_CALIB_CFG_ANT_COUPLING_IDX
= BIT(15),
326 IWL_CALIB_CFG_DAC_IDX
= BIT(16),
327 IWL_CALIB_CFG_ABS_IDX
= BIT(17),
328 IWL_CALIB_CFG_AGC_IDX
= BIT(18),
332 * Phy configuration command.
334 struct iwl_phy_cfg_cmd
{
336 struct iwl_calib_ctrl calib_control
;
339 #define PHY_CFG_RADIO_TYPE (BIT(0) | BIT(1))
340 #define PHY_CFG_RADIO_STEP (BIT(2) | BIT(3))
341 #define PHY_CFG_RADIO_DASH (BIT(4) | BIT(5))
342 #define PHY_CFG_PRODUCT_NUMBER (BIT(6) | BIT(7))
343 #define PHY_CFG_TX_CHAIN_A BIT(8)
344 #define PHY_CFG_TX_CHAIN_B BIT(9)
345 #define PHY_CFG_TX_CHAIN_C BIT(10)
346 #define PHY_CFG_RX_CHAIN_A BIT(12)
347 #define PHY_CFG_RX_CHAIN_B BIT(13)
348 #define PHY_CFG_RX_CHAIN_C BIT(14)
351 /* Target of the NVM_ACCESS_CMD */
353 NVM_ACCESS_TARGET_CACHE
= 0,
354 NVM_ACCESS_TARGET_OTP
= 1,
355 NVM_ACCESS_TARGET_EEPROM
= 2,
358 /* Section types for NVM_ACCESS_CMD */
360 NVM_SECTION_TYPE_SW
= 1,
361 NVM_SECTION_TYPE_REGULATORY
= 3,
362 NVM_SECTION_TYPE_CALIBRATION
= 4,
363 NVM_SECTION_TYPE_PRODUCTION
= 5,
364 NVM_SECTION_TYPE_MAC_OVERRIDE
= 11,
365 NVM_MAX_NUM_SECTIONS
= 12,
369 * struct iwl_nvm_access_cmd_ver2 - Request the device to send an NVM section
370 * @op_code: 0 - read, 1 - write
371 * @target: NVM_ACCESS_TARGET_*
372 * @type: NVM_SECTION_TYPE_*
373 * @offset: offset in bytes into the section
374 * @length: in bytes, to read/write
375 * @data: if write operation, the data to write. On read its empty
377 struct iwl_nvm_access_cmd
{
384 } __packed
; /* NVM_ACCESS_CMD_API_S_VER_2 */
387 * struct iwl_nvm_access_resp_ver2 - response to NVM_ACCESS_CMD
388 * @offset: offset in bytes into the section
389 * @length: in bytes, either how much was written or read
390 * @type: NVM_SECTION_TYPE_*
391 * @status: 0 for success, fail otherwise
392 * @data: if read operation, the data returned. Empty on write.
394 struct iwl_nvm_access_resp
{
400 } __packed
; /* NVM_ACCESS_CMD_RESP_API_S_VER_2 */
404 /* alive response is_valid values */
405 #define ALIVE_RESP_UCODE_OK BIT(0)
406 #define ALIVE_RESP_RFKILL BIT(1)
408 /* alive response ver_type values */
418 /* alive response ver_subtype values */
420 FW_SUBTYPE_FULL_FEATURE
= 0,
421 FW_SUBTYPE_BOOTSRAP
= 1, /* Not valid */
422 FW_SUBTYPE_REDUCED
= 2,
423 FW_SUBTYPE_ALIVE_ONLY
= 3,
424 FW_SUBTYPE_WOWLAN
= 4,
425 FW_SUBTYPE_AP_SUBTYPE
= 5,
426 FW_SUBTYPE_WIPAN
= 6,
427 FW_SUBTYPE_INITIALIZE
= 9
430 #define IWL_ALIVE_STATUS_ERR 0xDEAD
431 #define IWL_ALIVE_STATUS_OK 0xCAFE
433 #define IWL_ALIVE_FLG_RFKILL BIT(0)
435 struct mvm_alive_resp
{
449 __le32 error_event_table_ptr
; /* SRAM address for error log */
450 __le32 log_event_table_ptr
; /* SRAM address for event log */
451 __le32 cpu_register_ptr
;
452 __le32 dbgm_config_ptr
;
453 __le32 alive_counter_ptr
;
454 __le32 scd_base_ptr
; /* SRAM address for SCD */
455 } __packed
; /* ALIVE_RES_API_S_VER_1 */
457 struct mvm_alive_resp_ver2
{
471 __le32 error_event_table_ptr
; /* SRAM address for error log */
472 __le32 log_event_table_ptr
; /* SRAM address for LMAC event log */
473 __le32 cpu_register_ptr
;
474 __le32 dbgm_config_ptr
;
475 __le32 alive_counter_ptr
;
476 __le32 scd_base_ptr
; /* SRAM address for SCD */
477 __le32 st_fwrd_addr
; /* pointer to Store and forward */
479 u8 umac_minor
; /* UMAC version: minor */
480 u8 umac_major
; /* UMAC version: major */
481 __le16 umac_id
; /* UMAC version: id */
482 __le32 error_info_addr
; /* SRAM address for UMAC error log */
483 __le32 dbg_print_buff_addr
;
484 } __packed
; /* ALIVE_RES_API_S_VER_2 */
486 /* Error response/notification */
488 FW_ERR_UNKNOWN_CMD
= 0x0,
489 FW_ERR_INVALID_CMD_PARAM
= 0x1,
490 FW_ERR_SERVICE
= 0x2,
491 FW_ERR_ARC_MEMORY
= 0x3,
492 FW_ERR_ARC_CODE
= 0x4,
493 FW_ERR_WATCH_DOG
= 0x5,
494 FW_ERR_WEP_GRP_KEY_INDX
= 0x10,
495 FW_ERR_WEP_KEY_SIZE
= 0x11,
496 FW_ERR_OBSOLETE_FUNC
= 0x12,
497 FW_ERR_UNEXPECTED
= 0xFE,
502 * struct iwl_error_resp - FW error indication
503 * ( REPLY_ERROR = 0x2 )
504 * @error_type: one of FW_ERR_*
505 * @cmd_id: the command ID for which the error occured
506 * @bad_cmd_seq_num: sequence number of the erroneous command
507 * @error_service: which service created the error, applicable only if
508 * error_type = 2, otherwise 0
509 * @timestamp: TSF in usecs.
511 struct iwl_error_resp
{
515 __le16 bad_cmd_seq_num
;
516 __le32 error_service
;
521 /* Common PHY, MAC and Bindings definitions */
523 #define MAX_MACS_IN_BINDING (3)
524 #define MAX_BINDINGS (4)
525 #define AUX_BINDING_INDEX (3)
528 /* Used to extract ID and color from the context dword */
529 #define FW_CTXT_ID_POS (0)
530 #define FW_CTXT_ID_MSK (0xff << FW_CTXT_ID_POS)
531 #define FW_CTXT_COLOR_POS (8)
532 #define FW_CTXT_COLOR_MSK (0xff << FW_CTXT_COLOR_POS)
533 #define FW_CTXT_INVALID (0xffffffff)
535 #define FW_CMD_ID_AND_COLOR(_id, _color) ((_id << FW_CTXT_ID_POS) |\
536 (_color << FW_CTXT_COLOR_POS))
538 /* Possible actions on PHYs, MACs and Bindings */
540 FW_CTXT_ACTION_STUB
= 0,
542 FW_CTXT_ACTION_MODIFY
,
543 FW_CTXT_ACTION_REMOVE
,
545 }; /* COMMON_CONTEXT_ACTION_API_E_VER_1 */
549 /* Time Event types, according to MAC type */
550 enum iwl_time_event_type
{
551 /* BSS Station Events */
552 TE_BSS_STA_AGGRESSIVE_ASSOC
,
554 TE_BSS_EAP_DHCP_PROT
,
557 /* P2P Device Events */
558 TE_P2P_DEVICE_DISCOVERABLE
,
559 TE_P2P_DEVICE_LISTEN
,
560 TE_P2P_DEVICE_ACTION_SCAN
,
561 TE_P2P_DEVICE_FULL_SCAN
,
563 /* P2P Client Events */
564 TE_P2P_CLIENT_AGGRESSIVE_ASSOC
,
566 TE_P2P_CLIENT_QUIET_PERIOD
,
569 TE_P2P_GO_ASSOC_PROT
,
570 TE_P2P_GO_REPETITIVE_NOA
,
573 /* WiDi Sync Events */
576 /* Channel Switch NoA */
577 TE_CHANNEL_SWITCH_PERIOD
,
580 }; /* MAC_EVENT_TYPE_API_E_VER_1 */
584 /* Time event - defines for command API v1 */
587 * @TE_V1_FRAG_NONE: fragmentation of the time event is NOT allowed.
588 * @TE_V1_FRAG_SINGLE: fragmentation of the time event is allowed, but only
589 * the first fragment is scheduled.
590 * @TE_V1_FRAG_DUAL: fragmentation of the time event is allowed, but only
591 * the first 2 fragments are scheduled.
592 * @TE_V1_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
593 * number of fragments are valid.
595 * Other than the constant defined above, specifying a fragmentation value 'x'
596 * means that the event can be fragmented but only the first 'x' will be
601 TE_V1_FRAG_SINGLE
= 1,
603 TE_V1_FRAG_ENDLESS
= 0xffffffff
606 /* If a Time Event can be fragmented, this is the max number of fragments */
607 #define TE_V1_FRAG_MAX_MSK 0x0fffffff
608 /* Repeat the time event endlessly (until removed) */
609 #define TE_V1_REPEAT_ENDLESS 0xffffffff
610 /* If a Time Event has bounded repetitions, this is the maximal value */
611 #define TE_V1_REPEAT_MAX_MSK_V1 0x0fffffff
613 /* Time Event dependencies: none, on another TE, or in a specific time */
615 TE_V1_INDEPENDENT
= 0,
616 TE_V1_DEP_OTHER
= BIT(0),
617 TE_V1_DEP_TSF
= BIT(1),
618 TE_V1_EVENT_SOCIOPATHIC
= BIT(2),
619 }; /* MAC_EVENT_DEPENDENCY_POLICY_API_E_VER_2 */
622 * @TE_V1_NOTIF_NONE: no notifications
623 * @TE_V1_NOTIF_HOST_EVENT_START: request/receive notification on event start
624 * @TE_V1_NOTIF_HOST_EVENT_END:request/receive notification on event end
625 * @TE_V1_NOTIF_INTERNAL_EVENT_START: internal FW use
626 * @TE_V1_NOTIF_INTERNAL_EVENT_END: internal FW use.
627 * @TE_V1_NOTIF_HOST_FRAG_START: request/receive notification on frag start
628 * @TE_V1_NOTIF_HOST_FRAG_END:request/receive notification on frag end
629 * @TE_V1_NOTIF_INTERNAL_FRAG_START: internal FW use.
630 * @TE_V1_NOTIF_INTERNAL_FRAG_END: internal FW use.
632 * Supported Time event notifications configuration.
633 * A notification (both event and fragment) includes a status indicating weather
634 * the FW was able to schedule the event or not. For fragment start/end
635 * notification the status is always success. There is no start/end fragment
636 * notification for monolithic events.
639 TE_V1_NOTIF_NONE
= 0,
640 TE_V1_NOTIF_HOST_EVENT_START
= BIT(0),
641 TE_V1_NOTIF_HOST_EVENT_END
= BIT(1),
642 TE_V1_NOTIF_INTERNAL_EVENT_START
= BIT(2),
643 TE_V1_NOTIF_INTERNAL_EVENT_END
= BIT(3),
644 TE_V1_NOTIF_HOST_FRAG_START
= BIT(4),
645 TE_V1_NOTIF_HOST_FRAG_END
= BIT(5),
646 TE_V1_NOTIF_INTERNAL_FRAG_START
= BIT(6),
647 TE_V1_NOTIF_INTERNAL_FRAG_END
= BIT(7),
648 }; /* MAC_EVENT_ACTION_API_E_VER_2 */
650 /* Time event - defines for command API */
653 * @TE_V2_FRAG_NONE: fragmentation of the time event is NOT allowed.
654 * @TE_V2_FRAG_SINGLE: fragmentation of the time event is allowed, but only
655 * the first fragment is scheduled.
656 * @TE_V2_FRAG_DUAL: fragmentation of the time event is allowed, but only
657 * the first 2 fragments are scheduled.
658 * @TE_V2_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
659 * number of fragments are valid.
661 * Other than the constant defined above, specifying a fragmentation value 'x'
662 * means that the event can be fragmented but only the first 'x' will be
667 TE_V2_FRAG_SINGLE
= 1,
669 TE_V2_FRAG_MAX
= 0xfe,
670 TE_V2_FRAG_ENDLESS
= 0xff
673 /* Repeat the time event endlessly (until removed) */
674 #define TE_V2_REPEAT_ENDLESS 0xff
675 /* If a Time Event has bounded repetitions, this is the maximal value */
676 #define TE_V2_REPEAT_MAX 0xfe
678 #define TE_V2_PLACEMENT_POS 12
679 #define TE_V2_ABSENCE_POS 15
681 /* Time event policy values
682 * A notification (both event and fragment) includes a status indicating weather
683 * the FW was able to schedule the event or not. For fragment start/end
684 * notification the status is always success. There is no start/end fragment
685 * notification for monolithic events.
687 * @TE_V2_DEFAULT_POLICY: independent, social, present, unoticable
688 * @TE_V2_NOTIF_HOST_EVENT_START: request/receive notification on event start
689 * @TE_V2_NOTIF_HOST_EVENT_END:request/receive notification on event end
690 * @TE_V2_NOTIF_INTERNAL_EVENT_START: internal FW use
691 * @TE_V2_NOTIF_INTERNAL_EVENT_END: internal FW use.
692 * @TE_V2_NOTIF_HOST_FRAG_START: request/receive notification on frag start
693 * @TE_V2_NOTIF_HOST_FRAG_END:request/receive notification on frag end
694 * @TE_V2_NOTIF_INTERNAL_FRAG_START: internal FW use.
695 * @TE_V2_NOTIF_INTERNAL_FRAG_END: internal FW use.
696 * @TE_V2_DEP_OTHER: depends on another time event
697 * @TE_V2_DEP_TSF: depends on a specific time
698 * @TE_V2_EVENT_SOCIOPATHIC: can't co-exist with other events of tha same MAC
699 * @TE_V2_ABSENCE: are we present or absent during the Time Event.
702 TE_V2_DEFAULT_POLICY
= 0x0,
704 /* notifications (event start/stop, fragment start/stop) */
705 TE_V2_NOTIF_HOST_EVENT_START
= BIT(0),
706 TE_V2_NOTIF_HOST_EVENT_END
= BIT(1),
707 TE_V2_NOTIF_INTERNAL_EVENT_START
= BIT(2),
708 TE_V2_NOTIF_INTERNAL_EVENT_END
= BIT(3),
710 TE_V2_NOTIF_HOST_FRAG_START
= BIT(4),
711 TE_V2_NOTIF_HOST_FRAG_END
= BIT(5),
712 TE_V2_NOTIF_INTERNAL_FRAG_START
= BIT(6),
713 TE_V2_NOTIF_INTERNAL_FRAG_END
= BIT(7),
714 T2_V2_START_IMMEDIATELY
= BIT(11),
716 TE_V2_NOTIF_MSK
= 0xff,
718 /* placement characteristics */
719 TE_V2_DEP_OTHER
= BIT(TE_V2_PLACEMENT_POS
),
720 TE_V2_DEP_TSF
= BIT(TE_V2_PLACEMENT_POS
+ 1),
721 TE_V2_EVENT_SOCIOPATHIC
= BIT(TE_V2_PLACEMENT_POS
+ 2),
723 /* are we present or absent during the Time Event. */
724 TE_V2_ABSENCE
= BIT(TE_V2_ABSENCE_POS
),
728 * struct iwl_time_event_cmd_api - configuring Time Events
729 * with struct MAC_TIME_EVENT_DATA_API_S_VER_2 (see also
730 * with version 1. determined by IWL_UCODE_TLV_FLAGS)
731 * ( TIME_EVENT_CMD = 0x29 )
732 * @id_and_color: ID and color of the relevant MAC
733 * @action: action to perform, one of FW_CTXT_ACTION_*
734 * @id: this field has two meanings, depending on the action:
735 * If the action is ADD, then it means the type of event to add.
736 * For all other actions it is the unique event ID assigned when the
737 * event was added by the FW.
738 * @apply_time: When to start the Time Event (in GP2)
739 * @max_delay: maximum delay to event's start (apply time), in TU
740 * @depends_on: the unique ID of the event we depend on (if any)
741 * @interval: interval between repetitions, in TU
742 * @duration: duration of event in TU
743 * @repeat: how many repetitions to do, can be TE_REPEAT_ENDLESS
744 * @max_frags: maximal number of fragments the Time Event can be divided to
745 * @policy: defines whether uCode shall notify the host or other uCode modules
746 * on event and/or fragment start and/or end
747 * using one of TE_INDEPENDENT, TE_DEP_OTHER, TE_DEP_TSF
748 * TE_EVENT_SOCIOPATHIC
749 * using TE_ABSENCE and using TE_NOTIF_*
751 struct iwl_time_event_cmd
{
752 /* COMMON_INDEX_HDR_API_S_VER_1 */
756 /* MAC_TIME_EVENT_DATA_API_S_VER_2 */
765 } __packed
; /* MAC_TIME_EVENT_CMD_API_S_VER_2 */
768 * struct iwl_time_event_resp - response structure to iwl_time_event_cmd
769 * @status: bit 0 indicates success, all others specify errors
770 * @id: the Time Event type
771 * @unique_id: the unique ID assigned (in ADD) or given (others) to the TE
772 * @id_and_color: ID and color of the relevant MAC
774 struct iwl_time_event_resp
{
779 } __packed
; /* MAC_TIME_EVENT_RSP_API_S_VER_1 */
782 * struct iwl_time_event_notif - notifications of time event start/stop
783 * ( TIME_EVENT_NOTIFICATION = 0x2a )
784 * @timestamp: action timestamp in GP2
785 * @session_id: session's unique id
786 * @unique_id: unique id of the Time Event itself
787 * @id_and_color: ID and color of the relevant MAC
788 * @action: one of TE_NOTIF_START or TE_NOTIF_END
789 * @status: true if scheduled, false otherwise (not executed)
791 struct iwl_time_event_notif
{
798 } __packed
; /* MAC_TIME_EVENT_NTFY_API_S_VER_1 */
801 /* Bindings and Time Quota */
804 * struct iwl_binding_cmd - configuring bindings
805 * ( BINDING_CONTEXT_CMD = 0x2b )
806 * @id_and_color: ID and color of the relevant Binding
807 * @action: action to perform, one of FW_CTXT_ACTION_*
808 * @macs: array of MAC id and colors which belong to the binding
809 * @phy: PHY id and color which belongs to the binding
811 struct iwl_binding_cmd
{
812 /* COMMON_INDEX_HDR_API_S_VER_1 */
815 /* BINDING_DATA_API_S_VER_1 */
816 __le32 macs
[MAX_MACS_IN_BINDING
];
818 } __packed
; /* BINDING_CMD_API_S_VER_1 */
820 /* The maximal number of fragments in the FW's schedule session */
821 #define IWL_MVM_MAX_QUOTA 128
824 * struct iwl_time_quota_data - configuration of time quota per binding
825 * @id_and_color: ID and color of the relevant Binding
826 * @quota: absolute time quota in TU. The scheduler will try to divide the
827 * remainig quota (after Time Events) according to this quota.
828 * @max_duration: max uninterrupted context duration in TU
830 struct iwl_time_quota_data
{
834 } __packed
; /* TIME_QUOTA_DATA_API_S_VER_1 */
837 * struct iwl_time_quota_cmd - configuration of time quota between bindings
838 * ( TIME_QUOTA_CMD = 0x2c )
839 * @quotas: allocations per binding
841 struct iwl_time_quota_cmd
{
842 struct iwl_time_quota_data quotas
[MAX_BINDINGS
];
843 } __packed
; /* TIME_QUOTA_ALLOCATION_CMD_API_S_VER_1 */
848 /* Supported bands */
849 #define PHY_BAND_5 (0)
850 #define PHY_BAND_24 (1)
852 /* Supported channel width, vary if there is VHT support */
853 #define PHY_VHT_CHANNEL_MODE20 (0x0)
854 #define PHY_VHT_CHANNEL_MODE40 (0x1)
855 #define PHY_VHT_CHANNEL_MODE80 (0x2)
856 #define PHY_VHT_CHANNEL_MODE160 (0x3)
859 * Control channel position:
860 * For legacy set bit means upper channel, otherwise lower.
861 * For VHT - bit-2 marks if the control is lower/upper relative to center-freq
862 * bits-1:0 mark the distance from the center freq. for 20Mhz, offset is 0.
865 * 40Mhz |_______|_______|
866 * 80Mhz |_______|_______|_______|_______|
867 * 160Mhz |_______|_______|_______|_______|_______|_______|_______|_______|
868 * code 011 010 001 000 | 100 101 110 111
870 #define PHY_VHT_CTRL_POS_1_BELOW (0x0)
871 #define PHY_VHT_CTRL_POS_2_BELOW (0x1)
872 #define PHY_VHT_CTRL_POS_3_BELOW (0x2)
873 #define PHY_VHT_CTRL_POS_4_BELOW (0x3)
874 #define PHY_VHT_CTRL_POS_1_ABOVE (0x4)
875 #define PHY_VHT_CTRL_POS_2_ABOVE (0x5)
876 #define PHY_VHT_CTRL_POS_3_ABOVE (0x6)
877 #define PHY_VHT_CTRL_POS_4_ABOVE (0x7)
881 * @channel: channel number
882 * @width: PHY_[VHT|LEGACY]_CHANNEL_*
883 * @ctrl channel: PHY_[VHT|LEGACY]_CTRL_*
885 struct iwl_fw_channel_info
{
892 #define PHY_RX_CHAIN_DRIVER_FORCE_POS (0)
893 #define PHY_RX_CHAIN_DRIVER_FORCE_MSK \
894 (0x1 << PHY_RX_CHAIN_DRIVER_FORCE_POS)
895 #define PHY_RX_CHAIN_VALID_POS (1)
896 #define PHY_RX_CHAIN_VALID_MSK \
897 (0x7 << PHY_RX_CHAIN_VALID_POS)
898 #define PHY_RX_CHAIN_FORCE_SEL_POS (4)
899 #define PHY_RX_CHAIN_FORCE_SEL_MSK \
900 (0x7 << PHY_RX_CHAIN_FORCE_SEL_POS)
901 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
902 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_MSK \
903 (0x7 << PHY_RX_CHAIN_FORCE_MIMO_SEL_POS)
904 #define PHY_RX_CHAIN_CNT_POS (10)
905 #define PHY_RX_CHAIN_CNT_MSK \
906 (0x3 << PHY_RX_CHAIN_CNT_POS)
907 #define PHY_RX_CHAIN_MIMO_CNT_POS (12)
908 #define PHY_RX_CHAIN_MIMO_CNT_MSK \
909 (0x3 << PHY_RX_CHAIN_MIMO_CNT_POS)
910 #define PHY_RX_CHAIN_MIMO_FORCE_POS (14)
911 #define PHY_RX_CHAIN_MIMO_FORCE_MSK \
912 (0x1 << PHY_RX_CHAIN_MIMO_FORCE_POS)
914 /* TODO: fix the value, make it depend on firmware at runtime? */
915 #define NUM_PHY_CTX 3
917 /* TODO: complete missing documentation */
919 * struct iwl_phy_context_cmd - config of the PHY context
920 * ( PHY_CONTEXT_CMD = 0x8 )
921 * @id_and_color: ID and color of the relevant Binding
922 * @action: action to perform, one of FW_CTXT_ACTION_*
923 * @apply_time: 0 means immediate apply and context switch.
924 * other value means apply new params after X usecs
925 * @tx_param_color: ???
929 * @acquisition_data: ???
930 * @dsp_cfg_flags: set to 0
932 struct iwl_phy_context_cmd
{
933 /* COMMON_INDEX_HDR_API_S_VER_1 */
936 /* PHY_CONTEXT_DATA_API_S_VER_1 */
938 __le32 tx_param_color
;
939 struct iwl_fw_channel_info ci
;
942 __le32 acquisition_data
;
943 __le32 dsp_cfg_flags
;
944 } __packed
; /* PHY_CONTEXT_CMD_API_VER_1 */
949 * Command requests the firmware to create a time event for a certain duration
950 * and remain on the given channel. This is done by using the Aux framework in
952 * The command was first used for Hot Spot issues - but can be used regardless
955 * ( HOT_SPOT_CMD 0x53 )
957 * @id_and_color: ID and color of the MAC
958 * @action: action to perform, one of FW_CTXT_ACTION_*
959 * @event_unique_id: If the action FW_CTXT_ACTION_REMOVE then the
960 * event_unique_id should be the id of the time event assigned by ucode.
961 * Otherwise ignore the event_unique_id.
962 * @sta_id_and_color: station id and color, resumed during "Remain On Channel"
964 * @channel_info: channel info
965 * @node_addr: Our MAC Address
966 * @reserved: reserved for alignment
967 * @apply_time: GP2 value to start (should always be the current GP2 value)
968 * @apply_time_max_delay: Maximum apply time delay value in TU. Defines max
969 * time by which start of the event is allowed to be postponed.
970 * @duration: event duration in TU To calculate event duration:
971 * timeEventDuration = min(duration, remainingQuota)
973 struct iwl_hs20_roc_req
{
974 /* COMMON_INDEX_HDR_API_S_VER_1 hdr */
977 __le32 event_unique_id
;
978 __le32 sta_id_and_color
;
979 struct iwl_fw_channel_info channel_info
;
980 u8 node_addr
[ETH_ALEN
];
983 __le32 apply_time_max_delay
;
985 } __packed
; /* HOT_SPOT_CMD_API_S_VER_1 */
988 * values for AUX ROC result values
990 enum iwl_mvm_hot_spot
{
991 HOT_SPOT_RSP_STATUS_OK
,
992 HOT_SPOT_RSP_STATUS_TOO_MANY_EVENTS
,
993 HOT_SPOT_MAX_NUM_OF_SESSIONS
,
997 * Aux ROC command response
999 * In response to iwl_hs20_roc_req the FW sends this command to notify the
1000 * driver the uid of the timevent.
1002 * ( HOT_SPOT_CMD 0x53 )
1004 * @event_unique_id: Unique ID of time event assigned by ucode
1005 * @status: Return status 0 is success, all the rest used for specific errors
1007 struct iwl_hs20_roc_res
{
1008 __le32 event_unique_id
;
1010 } __packed
; /* HOT_SPOT_RSP_API_S_VER_1 */
1012 #define IWL_RX_INFO_PHY_CNT 8
1013 #define IWL_RX_INFO_ENERGY_ANT_ABC_IDX 1
1014 #define IWL_RX_INFO_ENERGY_ANT_A_MSK 0x000000ff
1015 #define IWL_RX_INFO_ENERGY_ANT_B_MSK 0x0000ff00
1016 #define IWL_RX_INFO_ENERGY_ANT_C_MSK 0x00ff0000
1017 #define IWL_RX_INFO_ENERGY_ANT_A_POS 0
1018 #define IWL_RX_INFO_ENERGY_ANT_B_POS 8
1019 #define IWL_RX_INFO_ENERGY_ANT_C_POS 16
1021 #define IWL_RX_INFO_AGC_IDX 1
1022 #define IWL_RX_INFO_RSSI_AB_IDX 2
1023 #define IWL_OFDM_AGC_A_MSK 0x0000007f
1024 #define IWL_OFDM_AGC_A_POS 0
1025 #define IWL_OFDM_AGC_B_MSK 0x00003f80
1026 #define IWL_OFDM_AGC_B_POS 7
1027 #define IWL_OFDM_AGC_CODE_MSK 0x3fe00000
1028 #define IWL_OFDM_AGC_CODE_POS 20
1029 #define IWL_OFDM_RSSI_INBAND_A_MSK 0x00ff
1030 #define IWL_OFDM_RSSI_A_POS 0
1031 #define IWL_OFDM_RSSI_ALLBAND_A_MSK 0xff00
1032 #define IWL_OFDM_RSSI_ALLBAND_A_POS 8
1033 #define IWL_OFDM_RSSI_INBAND_B_MSK 0xff0000
1034 #define IWL_OFDM_RSSI_B_POS 16
1035 #define IWL_OFDM_RSSI_ALLBAND_B_MSK 0xff000000
1036 #define IWL_OFDM_RSSI_ALLBAND_B_POS 24
1039 * struct iwl_rx_phy_info - phy info
1040 * (REPLY_RX_PHY_CMD = 0xc0)
1041 * @non_cfg_phy_cnt: non configurable DSP phy data byte count
1042 * @cfg_phy_cnt: configurable DSP phy data byte count
1043 * @stat_id: configurable DSP phy data set ID
1045 * @system_timestamp: GP2 at on air rise
1046 * @timestamp: TSF at on air rise
1047 * @beacon_time_stamp: beacon at on-air rise
1048 * @phy_flags: general phy flags: band, modulation, ...
1049 * @channel: channel number
1050 * @non_cfg_phy_buf: for various implementations of non_cfg_phy
1051 * @rate_n_flags: RATE_MCS_*
1052 * @byte_count: frame's byte-count
1053 * @frame_time: frame's time on the air, based on byte count and frame rate
1055 * @mac_active_msk: what MACs were active when the frame was received
1057 * Before each Rx, the device sends this data. It contains PHY information
1058 * about the reception of the packet.
1060 struct iwl_rx_phy_info
{
1065 __le32 system_timestamp
;
1067 __le32 beacon_time_stamp
;
1070 __le32 non_cfg_phy
[IWL_RX_INFO_PHY_CNT
];
1071 __le32 rate_n_flags
;
1073 __le16 mac_active_msk
;
1077 struct iwl_rx_mpdu_res_start
{
1083 * enum iwl_rx_phy_flags - to parse %iwl_rx_phy_info phy_flags
1084 * @RX_RES_PHY_FLAGS_BAND_24: true if the packet was received on 2.4 band
1085 * @RX_RES_PHY_FLAGS_MOD_CCK:
1086 * @RX_RES_PHY_FLAGS_SHORT_PREAMBLE: true if packet's preamble was short
1087 * @RX_RES_PHY_FLAGS_NARROW_BAND:
1088 * @RX_RES_PHY_FLAGS_ANTENNA: antenna on which the packet was received
1089 * @RX_RES_PHY_FLAGS_AGG: set if the packet was part of an A-MPDU
1090 * @RX_RES_PHY_FLAGS_OFDM_HT: The frame was an HT frame
1091 * @RX_RES_PHY_FLAGS_OFDM_GF: The frame used GF preamble
1092 * @RX_RES_PHY_FLAGS_OFDM_VHT: The frame was a VHT frame
1094 enum iwl_rx_phy_flags
{
1095 RX_RES_PHY_FLAGS_BAND_24
= BIT(0),
1096 RX_RES_PHY_FLAGS_MOD_CCK
= BIT(1),
1097 RX_RES_PHY_FLAGS_SHORT_PREAMBLE
= BIT(2),
1098 RX_RES_PHY_FLAGS_NARROW_BAND
= BIT(3),
1099 RX_RES_PHY_FLAGS_ANTENNA
= (0x7 << 4),
1100 RX_RES_PHY_FLAGS_ANTENNA_POS
= 4,
1101 RX_RES_PHY_FLAGS_AGG
= BIT(7),
1102 RX_RES_PHY_FLAGS_OFDM_HT
= BIT(8),
1103 RX_RES_PHY_FLAGS_OFDM_GF
= BIT(9),
1104 RX_RES_PHY_FLAGS_OFDM_VHT
= BIT(10),
1108 * enum iwl_mvm_rx_status - written by fw for each Rx packet
1109 * @RX_MPDU_RES_STATUS_CRC_OK: CRC is fine
1110 * @RX_MPDU_RES_STATUS_OVERRUN_OK: there was no RXE overflow
1111 * @RX_MPDU_RES_STATUS_SRC_STA_FOUND:
1112 * @RX_MPDU_RES_STATUS_KEY_VALID:
1113 * @RX_MPDU_RES_STATUS_KEY_PARAM_OK:
1114 * @RX_MPDU_RES_STATUS_ICV_OK: ICV is fine, if not, the packet is destroyed
1115 * @RX_MPDU_RES_STATUS_MIC_OK: used for CCM alg only. TKIP MIC is checked
1117 * @RX_MPDU_RES_STATUS_TTAK_OK: TTAK is fine
1118 * @RX_MPDU_RES_STATUS_MNG_FRAME_REPLAY_ERR: valid for alg = CCM_CMAC or
1119 * alg = CCM only. Checks replay attack for 11w frames. Relevant only if
1120 * %RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME is set.
1121 * @RX_MPDU_RES_STATUS_SEC_NO_ENC: this frame is not encrypted
1122 * @RX_MPDU_RES_STATUS_SEC_WEP_ENC: this frame is encrypted using WEP
1123 * @RX_MPDU_RES_STATUS_SEC_CCM_ENC: this frame is encrypted using CCM
1124 * @RX_MPDU_RES_STATUS_SEC_TKIP_ENC: this frame is encrypted using TKIP
1125 * @RX_MPDU_RES_STATUS_SEC_CCM_CMAC_ENC: this frame is encrypted using CCM_CMAC
1126 * @RX_MPDU_RES_STATUS_SEC_ENC_ERR: this frame couldn't be decrypted
1127 * @RX_MPDU_RES_STATUS_SEC_ENC_MSK: bitmask of the encryption algorithm
1128 * @RX_MPDU_RES_STATUS_DEC_DONE: this frame has been successfully decrypted
1129 * @RX_MPDU_RES_STATUS_PROTECT_FRAME_BIT_CMP:
1130 * @RX_MPDU_RES_STATUS_EXT_IV_BIT_CMP:
1131 * @RX_MPDU_RES_STATUS_KEY_ID_CMP_BIT:
1132 * @RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME: this frame is an 11w management frame
1133 * @RX_MPDU_RES_STATUS_HASH_INDEX_MSK:
1134 * @RX_MPDU_RES_STATUS_STA_ID_MSK:
1135 * @RX_MPDU_RES_STATUS_RRF_KILL:
1136 * @RX_MPDU_RES_STATUS_FILTERING_MSK:
1137 * @RX_MPDU_RES_STATUS2_FILTERING_MSK:
1139 enum iwl_mvm_rx_status
{
1140 RX_MPDU_RES_STATUS_CRC_OK
= BIT(0),
1141 RX_MPDU_RES_STATUS_OVERRUN_OK
= BIT(1),
1142 RX_MPDU_RES_STATUS_SRC_STA_FOUND
= BIT(2),
1143 RX_MPDU_RES_STATUS_KEY_VALID
= BIT(3),
1144 RX_MPDU_RES_STATUS_KEY_PARAM_OK
= BIT(4),
1145 RX_MPDU_RES_STATUS_ICV_OK
= BIT(5),
1146 RX_MPDU_RES_STATUS_MIC_OK
= BIT(6),
1147 RX_MPDU_RES_STATUS_TTAK_OK
= BIT(7),
1148 RX_MPDU_RES_STATUS_MNG_FRAME_REPLAY_ERR
= BIT(7),
1149 RX_MPDU_RES_STATUS_SEC_NO_ENC
= (0 << 8),
1150 RX_MPDU_RES_STATUS_SEC_WEP_ENC
= (1 << 8),
1151 RX_MPDU_RES_STATUS_SEC_CCM_ENC
= (2 << 8),
1152 RX_MPDU_RES_STATUS_SEC_TKIP_ENC
= (3 << 8),
1153 RX_MPDU_RES_STATUS_SEC_EXT_ENC
= (4 << 8),
1154 RX_MPDU_RES_STATUS_SEC_CCM_CMAC_ENC
= (6 << 8),
1155 RX_MPDU_RES_STATUS_SEC_ENC_ERR
= (7 << 8),
1156 RX_MPDU_RES_STATUS_SEC_ENC_MSK
= (7 << 8),
1157 RX_MPDU_RES_STATUS_DEC_DONE
= BIT(11),
1158 RX_MPDU_RES_STATUS_PROTECT_FRAME_BIT_CMP
= BIT(12),
1159 RX_MPDU_RES_STATUS_EXT_IV_BIT_CMP
= BIT(13),
1160 RX_MPDU_RES_STATUS_KEY_ID_CMP_BIT
= BIT(14),
1161 RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME
= BIT(15),
1162 RX_MPDU_RES_STATUS_HASH_INDEX_MSK
= (0x3F0000),
1163 RX_MPDU_RES_STATUS_STA_ID_MSK
= (0x1f000000),
1164 RX_MPDU_RES_STATUS_RRF_KILL
= BIT(29),
1165 RX_MPDU_RES_STATUS_FILTERING_MSK
= (0xc00000),
1166 RX_MPDU_RES_STATUS2_FILTERING_MSK
= (0xc0000000),
1170 * struct iwl_radio_version_notif - information on the radio version
1171 * ( RADIO_VERSION_NOTIFICATION = 0x68 )
1176 struct iwl_radio_version_notif
{
1177 __le32 radio_flavor
;
1180 } __packed
; /* RADIO_VERSION_NOTOFICATION_S_VER_1 */
1182 enum iwl_card_state_flags
{
1183 CARD_ENABLED
= 0x00,
1184 HW_CARD_DISABLED
= 0x01,
1185 SW_CARD_DISABLED
= 0x02,
1186 CT_KILL_CARD_DISABLED
= 0x04,
1187 HALT_CARD_DISABLED
= 0x08,
1188 CARD_DISABLED_MSK
= 0x0f,
1189 CARD_IS_RX_ON
= 0x10,
1193 * struct iwl_radio_version_notif - information on the radio version
1194 * ( CARD_STATE_NOTIFICATION = 0xa1 )
1195 * @flags: %iwl_card_state_flags
1197 struct iwl_card_state_notif
{
1199 } __packed
; /* CARD_STATE_NTFY_API_S_VER_1 */
1202 * struct iwl_missed_beacons_notif - information on missed beacons
1203 * ( MISSED_BEACONS_NOTIFICATION = 0xa2 )
1204 * @mac_id: interface ID
1205 * @consec_missed_beacons_since_last_rx: number of consecutive missed
1206 * beacons since last RX.
1207 * @consec_missed_beacons: number of consecutive missed beacons
1208 * @num_expected_beacons:
1209 * @num_recvd_beacons:
1211 struct iwl_missed_beacons_notif
{
1213 __le32 consec_missed_beacons_since_last_rx
;
1214 __le32 consec_missed_beacons
;
1215 __le32 num_expected_beacons
;
1216 __le32 num_recvd_beacons
;
1217 } __packed
; /* MISSED_BEACON_NTFY_API_S_VER_3 */
1220 * struct iwl_mfuart_load_notif - mfuart image version & status
1221 * ( MFUART_LOAD_NOTIFICATION = 0xb1 )
1222 * @installed_ver: installed image version
1223 * @external_ver: external image version
1224 * @status: MFUART loading status
1225 * @duration: MFUART loading time
1227 struct iwl_mfuart_load_notif
{
1228 __le32 installed_ver
;
1229 __le32 external_ver
;
1232 } __packed
; /*MFU_LOADER_NTFY_API_S_VER_1*/
1235 * struct iwl_set_calib_default_cmd - set default value for calibration.
1236 * ( SET_CALIB_DEFAULT_CMD = 0x8e )
1237 * @calib_index: the calibration to set value for
1239 * @data: the value to set for the calibration result
1241 struct iwl_set_calib_default_cmd
{
1245 } __packed
; /* PHY_CALIB_OVERRIDE_VALUES_S */
1247 #define MAX_PORT_ID_NUM 2
1248 #define MAX_MCAST_FILTERING_ADDRESSES 256
1251 * struct iwl_mcast_filter_cmd - configure multicast filter.
1252 * @filter_own: Set 1 to filter out multicast packets sent by station itself
1253 * @port_id: Multicast MAC addresses array specifier. This is a strange way
1254 * to identify network interface adopted in host-device IF.
1255 * It is used by FW as index in array of addresses. This array has
1256 * MAX_PORT_ID_NUM members.
1257 * @count: Number of MAC addresses in the array
1258 * @pass_all: Set 1 to pass all multicast packets.
1259 * @bssid: current association BSSID.
1260 * @addr_list: Place holder for array of MAC addresses.
1261 * IMPORTANT: add padding if necessary to ensure DWORD alignment.
1263 struct iwl_mcast_filter_cmd
{
1271 } __packed
; /* MCAST_FILTERING_CMD_API_S_VER_1 */
1273 #define MAX_BCAST_FILTERS 8
1274 #define MAX_BCAST_FILTER_ATTRS 2
1277 * enum iwl_mvm_bcast_filter_attr_offset - written by fw for each Rx packet
1278 * @BCAST_FILTER_OFFSET_PAYLOAD_START: offset is from payload start.
1279 * @BCAST_FILTER_OFFSET_IP_END: offset is from ip header end (i.e.
1280 * start of ip payload).
1282 enum iwl_mvm_bcast_filter_attr_offset
{
1283 BCAST_FILTER_OFFSET_PAYLOAD_START
= 0,
1284 BCAST_FILTER_OFFSET_IP_END
= 1,
1288 * struct iwl_fw_bcast_filter_attr - broadcast filter attribute
1289 * @offset_type: &enum iwl_mvm_bcast_filter_attr_offset.
1290 * @offset: starting offset of this pattern.
1291 * @val: value to match - big endian (MSB is the first
1292 * byte to match from offset pos).
1293 * @mask: mask to match (big endian).
1295 struct iwl_fw_bcast_filter_attr
{
1301 } __packed
; /* BCAST_FILTER_ATT_S_VER_1 */
1304 * enum iwl_mvm_bcast_filter_frame_type - filter frame type
1305 * @BCAST_FILTER_FRAME_TYPE_ALL: consider all frames.
1306 * @BCAST_FILTER_FRAME_TYPE_IPV4: consider only ipv4 frames
1308 enum iwl_mvm_bcast_filter_frame_type
{
1309 BCAST_FILTER_FRAME_TYPE_ALL
= 0,
1310 BCAST_FILTER_FRAME_TYPE_IPV4
= 1,
1314 * struct iwl_fw_bcast_filter - broadcast filter
1315 * @discard: discard frame (1) or let it pass (0).
1316 * @frame_type: &enum iwl_mvm_bcast_filter_frame_type.
1317 * @num_attrs: number of valid attributes in this filter.
1318 * @attrs: attributes of this filter. a filter is considered matched
1319 * only when all its attributes are matched (i.e. AND relationship)
1321 struct iwl_fw_bcast_filter
{
1326 struct iwl_fw_bcast_filter_attr attrs
[MAX_BCAST_FILTER_ATTRS
];
1327 } __packed
; /* BCAST_FILTER_S_VER_1 */
1330 * struct iwl_fw_bcast_mac - per-mac broadcast filtering configuration.
1331 * @default_discard: default action for this mac (discard (1) / pass (0)).
1332 * @attached_filters: bitmap of relevant filters for this mac.
1334 struct iwl_fw_bcast_mac
{
1337 __le16 attached_filters
;
1338 } __packed
; /* BCAST_MAC_CONTEXT_S_VER_1 */
1341 * struct iwl_bcast_filter_cmd - broadcast filtering configuration
1342 * @disable: enable (0) / disable (1)
1343 * @max_bcast_filters: max number of filters (MAX_BCAST_FILTERS)
1344 * @max_macs: max number of macs (NUM_MAC_INDEX_DRIVER)
1345 * @filters: broadcast filters
1346 * @macs: broadcast filtering configuration per-mac
1348 struct iwl_bcast_filter_cmd
{
1350 u8 max_bcast_filters
;
1353 struct iwl_fw_bcast_filter filters
[MAX_BCAST_FILTERS
];
1354 struct iwl_fw_bcast_mac macs
[NUM_MAC_INDEX_DRIVER
];
1355 } __packed
; /* BCAST_FILTERING_HCMD_API_S_VER_1 */
1358 * enum iwl_mvm_marker_id - maker ids
1360 * The ids for different type of markers to insert into the usniffer logs
1362 enum iwl_mvm_marker_id
{
1363 MARKER_ID_TX_FRAME_LATENCY
= 1,
1364 }; /* MARKER_ID_API_E_VER_1 */
1367 * struct iwl_mvm_marker - mark info into the usniffer logs
1369 * (MARKER_CMD = 0xcb)
1371 * Mark the UTC time stamp into the usniffer logs together with additional
1372 * metadata, so the usniffer output can be parsed.
1373 * In the command response the ucode will return the GP2 time.
1375 * @dw_len: The amount of dwords following this byte including this byte.
1376 * @marker_id: A unique marker id (iwl_mvm_marker_id).
1377 * @reserved: reserved.
1378 * @timestamp: in milliseconds since 1970-01-01 00:00:00 UTC
1379 * @metadata: additional meta data that will be written to the unsiffer log
1381 struct iwl_mvm_marker
{
1387 } __packed
; /* MARKER_API_S_VER_1 */
1389 /***********************************
1391 ***********************************/
1392 /* Smart Fifo state */
1394 SF_LONG_DELAY_ON
= 0, /* should never be called by driver */
1401 /* Smart Fifo possible scenario */
1402 enum iwl_sf_scenario
{
1403 SF_SCENARIO_SINGLE_UNICAST
,
1404 SF_SCENARIO_AGG_UNICAST
,
1405 SF_SCENARIO_MULTICAST
,
1406 SF_SCENARIO_BA_RESP
,
1407 SF_SCENARIO_TX_RESP
,
1411 #define SF_TRANSIENT_STATES_NUMBER 2 /* SF_LONG_DELAY_ON and SF_FULL_ON */
1412 #define SF_NUM_TIMEOUT_TYPES 2 /* Aging timer and Idle timer */
1414 /* smart FIFO default values */
1415 #define SF_W_MARK_SISO 6144
1416 #define SF_W_MARK_MIMO2 8192
1417 #define SF_W_MARK_MIMO3 6144
1418 #define SF_W_MARK_LEGACY 4096
1419 #define SF_W_MARK_SCAN 4096
1421 /* SF Scenarios timers for FULL_ON state (aligned to 32 uSec) */
1422 #define SF_SINGLE_UNICAST_IDLE_TIMER 320 /* 300 uSec */
1423 #define SF_SINGLE_UNICAST_AGING_TIMER 2016 /* 2 mSec */
1424 #define SF_AGG_UNICAST_IDLE_TIMER 320 /* 300 uSec */
1425 #define SF_AGG_UNICAST_AGING_TIMER 2016 /* 2 mSec */
1426 #define SF_MCAST_IDLE_TIMER 2016 /* 2 mSec */
1427 #define SF_MCAST_AGING_TIMER 10016 /* 10 mSec */
1428 #define SF_BA_IDLE_TIMER 320 /* 300 uSec */
1429 #define SF_BA_AGING_TIMER 2016 /* 2 mSec */
1430 #define SF_TX_RE_IDLE_TIMER 320 /* 300 uSec */
1431 #define SF_TX_RE_AGING_TIMER 2016 /* 2 mSec */
1433 #define SF_LONG_DELAY_AGING_TIMER 1000000 /* 1 Sec */
1435 #define SF_CFG_DUMMY_NOTIF_OFF BIT(16)
1438 * Smart Fifo configuration command.
1439 * @state: smart fifo state, types listed in enum %iwl_sf_sate.
1440 * @watermark: Minimum allowed availabe free space in RXF for transient state.
1441 * @long_delay_timeouts: aging and idle timer values for each scenario
1442 * in long delay state.
1443 * @full_on_timeouts: timer values for each scenario in full on state.
1445 struct iwl_sf_cfg_cmd
{
1447 __le32 watermark
[SF_TRANSIENT_STATES_NUMBER
];
1448 __le32 long_delay_timeouts
[SF_NUM_SCENARIO
][SF_NUM_TIMEOUT_TYPES
];
1449 __le32 full_on_timeouts
[SF_NUM_SCENARIO
][SF_NUM_TIMEOUT_TYPES
];
1450 } __packed
; /* SF_CFG_API_S_VER_2 */
1452 /* DTS measurements */
1454 enum iwl_dts_measurement_flags
{
1455 DTS_TRIGGER_CMD_FLAGS_TEMP
= BIT(0),
1456 DTS_TRIGGER_CMD_FLAGS_VOLT
= BIT(1),
1460 * iwl_dts_measurement_cmd - request DTS temperature and/or voltage measurements
1462 * @flags: indicates which measurements we want as specified in &enum
1463 * iwl_dts_measurement_flags
1465 struct iwl_dts_measurement_cmd
{
1467 } __packed
; /* TEMPERATURE_MEASUREMENT_TRIGGER_CMD_S */
1470 * iwl_dts_measurement_notif - notification received with the measurements
1472 * @temp: the measured temperature
1473 * @voltage: the measured voltage
1475 struct iwl_dts_measurement_notif
{
1478 } __packed
; /* TEMPERATURE_MEASUREMENT_TRIGGER_NTFY_S */
1480 /***********************************
1482 ***********************************/
1484 /* Type of TDLS request */
1485 enum iwl_tdls_channel_switch_type
{
1486 TDLS_SEND_CHAN_SW_REQ
= 0,
1487 TDLS_SEND_CHAN_SW_RESP_AND_MOVE_CH
,
1489 }; /* TDLS_STA_CHANNEL_SWITCH_CMD_TYPE_API_E_VER_1 */
1492 * Switch timing sub-element in a TDLS channel-switch command
1493 * @frame_timestamp: GP2 timestamp of channel-switch request/response packet
1494 * received from peer
1495 * @max_offchan_duration: What amount of microseconds out of a DTIM is given
1496 * to the TDLS off-channel communication. For instance if the DTIM is
1497 * 200TU and the TDLS peer is to be given 25% of the time, the value
1498 * given will be 50TU, or 50 * 1024 if translated into microseconds.
1499 * @switch_time: switch time the peer sent in its channel switch timing IE
1500 * @switch_timout: switch timeout the peer sent in its channel switch timing IE
1502 struct iwl_tdls_channel_switch_timing
{
1503 __le32 frame_timestamp
; /* GP2 time of peer packet Rx */
1504 __le32 max_offchan_duration
; /* given in micro-seconds */
1505 __le32 switch_time
; /* given in micro-seconds */
1506 __le32 switch_timeout
; /* given in micro-seconds */
1507 } __packed
; /* TDLS_STA_CHANNEL_SWITCH_TIMING_DATA_API_S_VER_1 */
1509 #define IWL_TDLS_CH_SW_FRAME_MAX_SIZE 200
1512 * TDLS channel switch frame template
1514 * A template representing a TDLS channel-switch request or response frame
1516 * @switch_time_offset: offset to the channel switch timing IE in the template
1517 * @tx_cmd: Tx parameters for the frame
1520 struct iwl_tdls_channel_switch_frame
{
1521 __le32 switch_time_offset
;
1522 struct iwl_tx_cmd tx_cmd
;
1523 u8 data
[IWL_TDLS_CH_SW_FRAME_MAX_SIZE
];
1524 } __packed
; /* TDLS_STA_CHANNEL_SWITCH_FRAME_API_S_VER_1 */
1527 * TDLS channel switch command
1529 * The command is sent to initiate a channel switch and also in response to
1530 * incoming TDLS channel-switch request/response packets from remote peers.
1532 * @switch_type: see &enum iwl_tdls_channel_switch_type
1533 * @peer_sta_id: station id of TDLS peer
1534 * @ci: channel we switch to
1535 * @timing: timing related data for command
1536 * @frame: channel-switch request/response template, depending to switch_type
1538 struct iwl_tdls_channel_switch_cmd
{
1541 struct iwl_fw_channel_info ci
;
1542 struct iwl_tdls_channel_switch_timing timing
;
1543 struct iwl_tdls_channel_switch_frame frame
;
1544 } __packed
; /* TDLS_STA_CHANNEL_SWITCH_CMD_API_S_VER_1 */
1547 * TDLS channel switch start notification
1549 * @status: non-zero on success
1550 * @offchannel_duration: duration given in microseconds
1551 * @sta_id: peer currently performing the channel-switch with
1553 struct iwl_tdls_channel_switch_notif
{
1555 __le32 offchannel_duration
;
1557 } __packed
; /* TDLS_STA_CHANNEL_SWITCH_NTFY_API_S_VER_1 */
1562 * @sta_id: station id of the TDLS peer
1563 * @tx_to_peer_tid: TID reserved vs. the peer for FW based Tx
1564 * @tx_to_peer_ssn: initial SSN the FW should use for Tx on its TID vs the peer
1565 * @is_initiator: 1 if the peer is the TDLS link initiator, 0 otherwise
1567 struct iwl_tdls_sta_info
{
1570 __le16 tx_to_peer_ssn
;
1571 __le32 is_initiator
;
1572 } __packed
; /* TDLS_STA_INFO_VER_1 */
1575 * TDLS basic config command
1577 * @id_and_color: MAC id and color being configured
1578 * @tdls_peer_count: amount of currently connected TDLS peers
1579 * @tx_to_ap_tid: TID reverved vs. the AP for FW based Tx
1580 * @tx_to_ap_ssn: initial SSN the FW should use for Tx on its TID vs. the AP
1581 * @sta_info: per-station info. Only the first tdls_peer_count entries are set
1582 * @pti_req_data_offset: offset of network-level data for the PTI template
1583 * @pti_req_tx_cmd: Tx parameters for PTI request template
1584 * @pti_req_template: PTI request template data
1586 struct iwl_tdls_config_cmd
{
1587 __le32 id_and_color
; /* mac id and color */
1590 __le16 tx_to_ap_ssn
;
1591 struct iwl_tdls_sta_info sta_info
[IWL_MVM_TDLS_STA_COUNT
];
1593 __le32 pti_req_data_offset
;
1594 struct iwl_tx_cmd pti_req_tx_cmd
;
1595 u8 pti_req_template
[0];
1596 } __packed
; /* TDLS_CONFIG_CMD_API_S_VER_1 */
1599 * TDLS per-station config information from FW
1601 * @sta_id: station id of the TDLS peer
1602 * @tx_to_peer_last_seq: last sequence number used by FW during FW-based Tx to
1605 struct iwl_tdls_config_sta_info_res
{
1607 __le16 tx_to_peer_last_seq
;
1608 } __packed
; /* TDLS_STA_INFO_RSP_VER_1 */
1611 * TDLS config information from FW
1613 * @tx_to_ap_last_seq: last sequence number used by FW during FW-based Tx to AP
1614 * @sta_info: per-station TDLS config information
1616 struct iwl_tdls_config_res
{
1617 __le32 tx_to_ap_last_seq
;
1618 struct iwl_tdls_config_sta_info_res sta_info
[IWL_MVM_TDLS_STA_COUNT
];
1619 } __packed
; /* TDLS_CONFIG_RSP_API_S_VER_1 */
1621 #define TX_FIFO_MAX_NUM 8
1622 #define RX_FIFO_MAX_NUM 2
1625 * Shared memory configuration information from the FW
1627 * @shared_mem_addr: shared memory addr (pre 8000 HW set to 0x0 as MARBH is not
1629 * @shared_mem_size: shared memory size
1630 * @sample_buff_addr: internal sample (mon/adc) buff addr (pre 8000 HW set to
1631 * 0x0 as accessible only via DBGM RDAT)
1632 * @sample_buff_size: internal sample buff size
1633 * @txfifo_addr: start addr of TXF0 (excluding the context table 0.5KB), (pre
1634 * 8000 HW set to 0x0 as not accessible)
1635 * @txfifo_size: size of TXF0 ... TXF7
1636 * @rxfifo_size: RXF1, RXF2 sizes. If there is no RXF2, it'll have a value of 0
1637 * @page_buff_addr: used by UMAC and performance debug (page miss analysis),
1638 * when paging is not supported this should be 0
1639 * @page_buff_size: size of %page_buff_addr
1641 struct iwl_shared_mem_cfg
{
1642 __le32 shared_mem_addr
;
1643 __le32 shared_mem_size
;
1644 __le32 sample_buff_addr
;
1645 __le32 sample_buff_size
;
1647 __le32 txfifo_size
[TX_FIFO_MAX_NUM
];
1648 __le32 rxfifo_size
[RX_FIFO_MAX_NUM
];
1649 __le32 page_buff_addr
;
1650 __le32 page_buff_size
;
1651 } __packed
; /* SHARED_MEM_ALLOC_API_S_VER_1 */
1653 #endif /* __fw_api_h__ */