?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
x86/xen: resume timer irqs early
[linux/fpc-iii.git] / drivers / net / wireless / iwlwifi / mvm / fw-api.h
blob66264cc5a0168d296ddac86be6617cd56f1d84d5
1 /******************************************************************************
2 *
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.
5 *
6 * GPL LICENSE SUMMARY
7 *
8 * Copyright(c) 2012 - 2013 Intel Corporation. All rights reserved.
9 *
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.
13 *
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.
18 *
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,
22 * USA
23 *
24 * The full GNU General Public License is included in this distribution
25 * in the file called COPYING.
26 *
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30 *
31 * BSD LICENSE
32 *
33 * Copyright(c) 2012 - 2013 Intel Corporation. All rights reserved.
34 * All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 *
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
45 * distribution.
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.
49 *
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.
61 *
62 *****************************************************************************/
63
64 #ifndef __fw_api_h__
65 #define __fw_api_h__
66
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"
74
75 /* queue and FIFO numbers by usage */
76 enum {
77 IWL_MVM_OFFCHANNEL_QUEUE = 8,
78 IWL_MVM_CMD_QUEUE = 9,
79 IWL_MVM_AUX_QUEUE = 15,
80 IWL_MVM_FIRST_AGG_QUEUE = 16,
81 IWL_MVM_NUM_QUEUES = 20,
82 IWL_MVM_LAST_AGG_QUEUE = IWL_MVM_NUM_QUEUES - 1,
83 IWL_MVM_CMD_FIFO = 7
84 };
85
86 #define IWL_MVM_STATION_COUNT 16
87
88 /* commands */
89 enum {
90 MVM_ALIVE = 0x1,
91 REPLY_ERROR = 0x2,
92
93 INIT_COMPLETE_NOTIF = 0x4,
94
95 /* PHY context commands */
96 PHY_CONTEXT_CMD = 0x8,
97 DBG_CFG = 0x9,
98
99 /* station table */
100 ADD_STA = 0x18,
101 REMOVE_STA = 0x19,
102
103 /* TX */
104 TX_CMD = 0x1c,
105 TXPATH_FLUSH = 0x1e,
106 MGMT_MCAST_KEY = 0x1f,
107
108 /* global key */
109 WEP_KEY = 0x20,
110
111 /* MAC and Binding commands */
112 MAC_CONTEXT_CMD = 0x28,
113 TIME_EVENT_CMD = 0x29, /* both CMD and response */
114 TIME_EVENT_NOTIFICATION = 0x2a,
115 BINDING_CONTEXT_CMD = 0x2b,
116 TIME_QUOTA_CMD = 0x2c,
117
118 LQ_CMD = 0x4e,
119
120 /* Calibration */
121 TEMPERATURE_NOTIFICATION = 0x62,
122 CALIBRATION_CFG_CMD = 0x65,
123 CALIBRATION_RES_NOTIFICATION = 0x66,
124 CALIBRATION_COMPLETE_NOTIFICATION = 0x67,
125 RADIO_VERSION_NOTIFICATION = 0x68,
126
127 /* Scan offload */
128 SCAN_OFFLOAD_REQUEST_CMD = 0x51,
129 SCAN_OFFLOAD_ABORT_CMD = 0x52,
130 SCAN_OFFLOAD_COMPLETE = 0x6D,
131 SCAN_OFFLOAD_UPDATE_PROFILES_CMD = 0x6E,
132 SCAN_OFFLOAD_CONFIG_CMD = 0x6f,
133
134 /* Phy */
135 PHY_CONFIGURATION_CMD = 0x6a,
136 CALIB_RES_NOTIF_PHY_DB = 0x6b,
137 /* PHY_DB_CMD = 0x6c, */
138
139 /* Power - legacy power table command */
140 POWER_TABLE_CMD = 0x77,
141
142 /* Thermal Throttling*/
143 REPLY_THERMAL_MNG_BACKOFF = 0x7e,
144
145 /* Scanning */
146 SCAN_REQUEST_CMD = 0x80,
147 SCAN_ABORT_CMD = 0x81,
148 SCAN_START_NOTIFICATION = 0x82,
149 SCAN_RESULTS_NOTIFICATION = 0x83,
150 SCAN_COMPLETE_NOTIFICATION = 0x84,
151
152 /* NVM */
153 NVM_ACCESS_CMD = 0x88,
154
155 SET_CALIB_DEFAULT_CMD = 0x8e,
156
157 BEACON_NOTIFICATION = 0x90,
158 BEACON_TEMPLATE_CMD = 0x91,
159 TX_ANT_CONFIGURATION_CMD = 0x98,
160 BT_CONFIG = 0x9b,
161 STATISTICS_NOTIFICATION = 0x9d,
162 REDUCE_TX_POWER_CMD = 0x9f,
163
164 /* RF-KILL commands and notifications */
165 CARD_STATE_CMD = 0xa0,
166 CARD_STATE_NOTIFICATION = 0xa1,
167
168 MISSED_BEACONS_NOTIFICATION = 0xa2,
169
170 /* Power - new power table command */
171 MAC_PM_POWER_TABLE = 0xa9,
172
173 REPLY_RX_PHY_CMD = 0xc0,
174 REPLY_RX_MPDU_CMD = 0xc1,
175 BA_NOTIF = 0xc5,
176
177 /* BT Coex */
178 BT_COEX_PRIO_TABLE = 0xcc,
179 BT_COEX_PROT_ENV = 0xcd,
180 BT_PROFILE_NOTIFICATION = 0xce,
181
182 REPLY_BEACON_FILTERING_CMD = 0xd2,
183
184 REPLY_DEBUG_CMD = 0xf0,
185 DEBUG_LOG_MSG = 0xf7,
186
187 MCAST_FILTER_CMD = 0xd0,
188
189 /* D3 commands/notifications */
190 D3_CONFIG_CMD = 0xd3,
191 PROT_OFFLOAD_CONFIG_CMD = 0xd4,
192 OFFLOADS_QUERY_CMD = 0xd5,
193 REMOTE_WAKE_CONFIG_CMD = 0xd6,
194
195 /* for WoWLAN in particular */
196 WOWLAN_PATTERNS = 0xe0,
197 WOWLAN_CONFIGURATION = 0xe1,
198 WOWLAN_TSC_RSC_PARAM = 0xe2,
199 WOWLAN_TKIP_PARAM = 0xe3,
200 WOWLAN_KEK_KCK_MATERIAL = 0xe4,
201 WOWLAN_GET_STATUSES = 0xe5,
202 WOWLAN_TX_POWER_PER_DB = 0xe6,
203
204 /* and for NetDetect */
205 NET_DETECT_CONFIG_CMD = 0x54,
206 NET_DETECT_PROFILES_QUERY_CMD = 0x56,
207 NET_DETECT_PROFILES_CMD = 0x57,
208 NET_DETECT_HOTSPOTS_CMD = 0x58,
209 NET_DETECT_HOTSPOTS_QUERY_CMD = 0x59,
210
211 REPLY_MAX = 0xff,
212 };
213
214 /**
215 * struct iwl_cmd_response - generic response struct for most commands
216 * @status: status of the command asked, changes for each one
217 */
218 struct iwl_cmd_response {
219 __le32 status;
220 };
221
222 /*
223 * struct iwl_tx_ant_cfg_cmd
224 * @valid: valid antenna configuration
225 */
226 struct iwl_tx_ant_cfg_cmd {
227 __le32 valid;
228 } __packed;
229
230 /**
231 * struct iwl_reduce_tx_power_cmd - TX power reduction command
232 * REDUCE_TX_POWER_CMD = 0x9f
233 * @flags: (reserved for future implementation)
234 * @mac_context_id: id of the mac ctx for which we are reducing TX power.
235 * @pwr_restriction: TX power restriction in dBms.
236 */
237 struct iwl_reduce_tx_power_cmd {
238 u8 flags;
239 u8 mac_context_id;
240 __le16 pwr_restriction;
241 } __packed; /* TX_REDUCED_POWER_API_S_VER_1 */
242
243 /*
244 * Calibration control struct.
245 * Sent as part of the phy configuration command.
246 * @flow_trigger: bitmap for which calibrations to perform according to
247 * flow triggers.
248 * @event_trigger: bitmap for which calibrations to perform according to
249 * event triggers.
250 */
251 struct iwl_calib_ctrl {
252 __le32 flow_trigger;
253 __le32 event_trigger;
254 } __packed;
255
256 /* This enum defines the bitmap of various calibrations to enable in both
257 * init ucode and runtime ucode through CALIBRATION_CFG_CMD.
258 */
259 enum iwl_calib_cfg {
260 IWL_CALIB_CFG_XTAL_IDX = BIT(0),
261 IWL_CALIB_CFG_TEMPERATURE_IDX = BIT(1),
262 IWL_CALIB_CFG_VOLTAGE_READ_IDX = BIT(2),
263 IWL_CALIB_CFG_PAPD_IDX = BIT(3),
264 IWL_CALIB_CFG_TX_PWR_IDX = BIT(4),
265 IWL_CALIB_CFG_DC_IDX = BIT(5),
266 IWL_CALIB_CFG_BB_FILTER_IDX = BIT(6),
267 IWL_CALIB_CFG_LO_LEAKAGE_IDX = BIT(7),
268 IWL_CALIB_CFG_TX_IQ_IDX = BIT(8),
269 IWL_CALIB_CFG_TX_IQ_SKEW_IDX = BIT(9),
270 IWL_CALIB_CFG_RX_IQ_IDX = BIT(10),
271 IWL_CALIB_CFG_RX_IQ_SKEW_IDX = BIT(11),
272 IWL_CALIB_CFG_SENSITIVITY_IDX = BIT(12),
273 IWL_CALIB_CFG_CHAIN_NOISE_IDX = BIT(13),
274 IWL_CALIB_CFG_DISCONNECTED_ANT_IDX = BIT(14),
275 IWL_CALIB_CFG_ANT_COUPLING_IDX = BIT(15),
276 IWL_CALIB_CFG_DAC_IDX = BIT(16),
277 IWL_CALIB_CFG_ABS_IDX = BIT(17),
278 IWL_CALIB_CFG_AGC_IDX = BIT(18),
279 };
280
281 /*
282 * Phy configuration command.
283 */
284 struct iwl_phy_cfg_cmd {
285 __le32 phy_cfg;
286 struct iwl_calib_ctrl calib_control;
287 } __packed;
288
289 #define PHY_CFG_RADIO_TYPE (BIT(0) | BIT(1))
290 #define PHY_CFG_RADIO_STEP (BIT(2) | BIT(3))
291 #define PHY_CFG_RADIO_DASH (BIT(4) | BIT(5))
292 #define PHY_CFG_PRODUCT_NUMBER (BIT(6) | BIT(7))
293 #define PHY_CFG_TX_CHAIN_A BIT(8)
294 #define PHY_CFG_TX_CHAIN_B BIT(9)
295 #define PHY_CFG_TX_CHAIN_C BIT(10)
296 #define PHY_CFG_RX_CHAIN_A BIT(12)
297 #define PHY_CFG_RX_CHAIN_B BIT(13)
298 #define PHY_CFG_RX_CHAIN_C BIT(14)
299
300
301 /* Target of the NVM_ACCESS_CMD */
302 enum {
303 NVM_ACCESS_TARGET_CACHE = 0,
304 NVM_ACCESS_TARGET_OTP = 1,
305 NVM_ACCESS_TARGET_EEPROM = 2,
306 };
307
308 /* Section types for NVM_ACCESS_CMD */
309 enum {
310 NVM_SECTION_TYPE_HW = 0,
311 NVM_SECTION_TYPE_SW,
312 NVM_SECTION_TYPE_PAPD,
313 NVM_SECTION_TYPE_BT,
314 NVM_SECTION_TYPE_CALIBRATION,
315 NVM_SECTION_TYPE_PRODUCTION,
316 NVM_SECTION_TYPE_POST_FCS_CALIB,
317 NVM_NUM_OF_SECTIONS,
318 };
319
320 /**
321 * struct iwl_nvm_access_cmd_ver2 - Request the device to send an NVM section
322 * @op_code: 0 - read, 1 - write
323 * @target: NVM_ACCESS_TARGET_*
324 * @type: NVM_SECTION_TYPE_*
325 * @offset: offset in bytes into the section
326 * @length: in bytes, to read/write
327 * @data: if write operation, the data to write. On read its empty
328 */
329 struct iwl_nvm_access_cmd {
330 u8 op_code;
331 u8 target;
332 __le16 type;
333 __le16 offset;
334 __le16 length;
335 u8 data[];
336 } __packed; /* NVM_ACCESS_CMD_API_S_VER_2 */
337
338 /**
339 * struct iwl_nvm_access_resp_ver2 - response to NVM_ACCESS_CMD
340 * @offset: offset in bytes into the section
341 * @length: in bytes, either how much was written or read
342 * @type: NVM_SECTION_TYPE_*
343 * @status: 0 for success, fail otherwise
344 * @data: if read operation, the data returned. Empty on write.
345 */
346 struct iwl_nvm_access_resp {
347 __le16 offset;
348 __le16 length;
349 __le16 type;
350 __le16 status;
351 u8 data[];
352 } __packed; /* NVM_ACCESS_CMD_RESP_API_S_VER_2 */
353
354 /* MVM_ALIVE 0x1 */
355
356 /* alive response is_valid values */
357 #define ALIVE_RESP_UCODE_OK BIT(0)
358 #define ALIVE_RESP_RFKILL BIT(1)
359
360 /* alive response ver_type values */
361 enum {
362 FW_TYPE_HW = 0,
363 FW_TYPE_PROT = 1,
364 FW_TYPE_AP = 2,
365 FW_TYPE_WOWLAN = 3,
366 FW_TYPE_TIMING = 4,
367 FW_TYPE_WIPAN = 5
368 };
369
370 /* alive response ver_subtype values */
371 enum {
372 FW_SUBTYPE_FULL_FEATURE = 0,
373 FW_SUBTYPE_BOOTSRAP = 1, /* Not valid */
374 FW_SUBTYPE_REDUCED = 2,
375 FW_SUBTYPE_ALIVE_ONLY = 3,
376 FW_SUBTYPE_WOWLAN = 4,
377 FW_SUBTYPE_AP_SUBTYPE = 5,
378 FW_SUBTYPE_WIPAN = 6,
379 FW_SUBTYPE_INITIALIZE = 9
380 };
381
382 #define IWL_ALIVE_STATUS_ERR 0xDEAD
383 #define IWL_ALIVE_STATUS_OK 0xCAFE
384
385 #define IWL_ALIVE_FLG_RFKILL BIT(0)
386
387 struct mvm_alive_resp {
388 __le16 status;
389 __le16 flags;
390 u8 ucode_minor;
391 u8 ucode_major;
392 __le16 id;
393 u8 api_minor;
394 u8 api_major;
395 u8 ver_subtype;
396 u8 ver_type;
397 u8 mac;
398 u8 opt;
399 __le16 reserved2;
400 __le32 timestamp;
401 __le32 error_event_table_ptr; /* SRAM address for error log */
402 __le32 log_event_table_ptr; /* SRAM address for event log */
403 __le32 cpu_register_ptr;
404 __le32 dbgm_config_ptr;
405 __le32 alive_counter_ptr;
406 __le32 scd_base_ptr; /* SRAM address for SCD */
407 } __packed; /* ALIVE_RES_API_S_VER_1 */
408
409 /* Error response/notification */
410 enum {
411 FW_ERR_UNKNOWN_CMD = 0x0,
412 FW_ERR_INVALID_CMD_PARAM = 0x1,
413 FW_ERR_SERVICE = 0x2,
414 FW_ERR_ARC_MEMORY = 0x3,
415 FW_ERR_ARC_CODE = 0x4,
416 FW_ERR_WATCH_DOG = 0x5,
417 FW_ERR_WEP_GRP_KEY_INDX = 0x10,
418 FW_ERR_WEP_KEY_SIZE = 0x11,
419 FW_ERR_OBSOLETE_FUNC = 0x12,
420 FW_ERR_UNEXPECTED = 0xFE,
421 FW_ERR_FATAL = 0xFF
422 };
423
424 /**
425 * struct iwl_error_resp - FW error indication
426 * ( REPLY_ERROR = 0x2 )
427 * @error_type: one of FW_ERR_*
428 * @cmd_id: the command ID for which the error occured
429 * @bad_cmd_seq_num: sequence number of the erroneous command
430 * @error_service: which service created the error, applicable only if
431 * error_type = 2, otherwise 0
432 * @timestamp: TSF in usecs.
433 */
434 struct iwl_error_resp {
435 __le32 error_type;
436 u8 cmd_id;
437 u8 reserved1;
438 __le16 bad_cmd_seq_num;
439 __le32 error_service;
440 __le64 timestamp;
441 } __packed;
442
443
444 /* Common PHY, MAC and Bindings definitions */
445
446 #define MAX_MACS_IN_BINDING (3)
447 #define MAX_BINDINGS (4)
448 #define AUX_BINDING_INDEX (3)
449 #define MAX_PHYS (4)
450
451 /* Used to extract ID and color from the context dword */
452 #define FW_CTXT_ID_POS (0)
453 #define FW_CTXT_ID_MSK (0xff << FW_CTXT_ID_POS)
454 #define FW_CTXT_COLOR_POS (8)
455 #define FW_CTXT_COLOR_MSK (0xff << FW_CTXT_COLOR_POS)
456 #define FW_CTXT_INVALID (0xffffffff)
457
458 #define FW_CMD_ID_AND_COLOR(_id, _color) ((_id << FW_CTXT_ID_POS) |\
459 (_color << FW_CTXT_COLOR_POS))
460
461 /* Possible actions on PHYs, MACs and Bindings */
462 enum {
463 FW_CTXT_ACTION_STUB = 0,
464 FW_CTXT_ACTION_ADD,
465 FW_CTXT_ACTION_MODIFY,
466 FW_CTXT_ACTION_REMOVE,
467 FW_CTXT_ACTION_NUM
468 }; /* COMMON_CONTEXT_ACTION_API_E_VER_1 */
469
470 /* Time Events */
471
472 /* Time Event types, according to MAC type */
473 enum iwl_time_event_type {
474 /* BSS Station Events */
475 TE_BSS_STA_AGGRESSIVE_ASSOC,
476 TE_BSS_STA_ASSOC,
477 TE_BSS_EAP_DHCP_PROT,
478 TE_BSS_QUIET_PERIOD,
479
480 /* P2P Device Events */
481 TE_P2P_DEVICE_DISCOVERABLE,
482 TE_P2P_DEVICE_LISTEN,
483 TE_P2P_DEVICE_ACTION_SCAN,
484 TE_P2P_DEVICE_FULL_SCAN,
485
486 /* P2P Client Events */
487 TE_P2P_CLIENT_AGGRESSIVE_ASSOC,
488 TE_P2P_CLIENT_ASSOC,
489 TE_P2P_CLIENT_QUIET_PERIOD,
490
491 /* P2P GO Events */
492 TE_P2P_GO_ASSOC_PROT,
493 TE_P2P_GO_REPETITIVE_NOA,
494 TE_P2P_GO_CT_WINDOW,
495
496 /* WiDi Sync Events */
497 TE_WIDI_TX_SYNC,
498
499 TE_MAX
500 }; /* MAC_EVENT_TYPE_API_E_VER_1 */
501
502
503
504 /* Time event - defines for command API v1 */
505
506 /*
507 * @TE_V1_FRAG_NONE: fragmentation of the time event is NOT allowed.
508 * @TE_V1_FRAG_SINGLE: fragmentation of the time event is allowed, but only
509 * the first fragment is scheduled.
510 * @TE_V1_FRAG_DUAL: fragmentation of the time event is allowed, but only
511 * the first 2 fragments are scheduled.
512 * @TE_V1_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
513 * number of fragments are valid.
514 *
515 * Other than the constant defined above, specifying a fragmentation value 'x'
516 * means that the event can be fragmented but only the first 'x' will be
517 * scheduled.
518 */
519 enum {
520 TE_V1_FRAG_NONE = 0,
521 TE_V1_FRAG_SINGLE = 1,
522 TE_V1_FRAG_DUAL = 2,
523 TE_V1_FRAG_ENDLESS = 0xffffffff
524 };
525
526 /* If a Time Event can be fragmented, this is the max number of fragments */
527 #define TE_V1_FRAG_MAX_MSK 0x0fffffff
528 /* Repeat the time event endlessly (until removed) */
529 #define TE_V1_REPEAT_ENDLESS 0xffffffff
530 /* If a Time Event has bounded repetitions, this is the maximal value */
531 #define TE_V1_REPEAT_MAX_MSK_V1 0x0fffffff
532
533 /* Time Event dependencies: none, on another TE, or in a specific time */
534 enum {
535 TE_V1_INDEPENDENT = 0,
536 TE_V1_DEP_OTHER = BIT(0),
537 TE_V1_DEP_TSF = BIT(1),
538 TE_V1_EVENT_SOCIOPATHIC = BIT(2),
539 }; /* MAC_EVENT_DEPENDENCY_POLICY_API_E_VER_2 */
540
541 /*
542 * @TE_V1_NOTIF_NONE: no notifications
543 * @TE_V1_NOTIF_HOST_EVENT_START: request/receive notification on event start
544 * @TE_V1_NOTIF_HOST_EVENT_END:request/receive notification on event end
545 * @TE_V1_NOTIF_INTERNAL_EVENT_START: internal FW use
546 * @TE_V1_NOTIF_INTERNAL_EVENT_END: internal FW use.
547 * @TE_V1_NOTIF_HOST_FRAG_START: request/receive notification on frag start
548 * @TE_V1_NOTIF_HOST_FRAG_END:request/receive notification on frag end
549 * @TE_V1_NOTIF_INTERNAL_FRAG_START: internal FW use.
550 * @TE_V1_NOTIF_INTERNAL_FRAG_END: internal FW use.
551 *
552 * Supported Time event notifications configuration.
553 * A notification (both event and fragment) includes a status indicating weather
554 * the FW was able to schedule the event or not. For fragment start/end
555 * notification the status is always success. There is no start/end fragment
556 * notification for monolithic events.
557 */
558 enum {
559 TE_V1_NOTIF_NONE = 0,
560 TE_V1_NOTIF_HOST_EVENT_START = BIT(0),
561 TE_V1_NOTIF_HOST_EVENT_END = BIT(1),
562 TE_V1_NOTIF_INTERNAL_EVENT_START = BIT(2),
563 TE_V1_NOTIF_INTERNAL_EVENT_END = BIT(3),
564 TE_V1_NOTIF_HOST_FRAG_START = BIT(4),
565 TE_V1_NOTIF_HOST_FRAG_END = BIT(5),
566 TE_V1_NOTIF_INTERNAL_FRAG_START = BIT(6),
567 TE_V1_NOTIF_INTERNAL_FRAG_END = BIT(7),
568 }; /* MAC_EVENT_ACTION_API_E_VER_2 */
569
570
571 /**
572 * struct iwl_time_event_cmd_api_v1 - configuring Time Events
573 * with struct MAC_TIME_EVENT_DATA_API_S_VER_1 (see also
574 * with version 2. determined by IWL_UCODE_TLV_FLAGS)
575 * ( TIME_EVENT_CMD = 0x29 )
576 * @id_and_color: ID and color of the relevant MAC
577 * @action: action to perform, one of FW_CTXT_ACTION_*
578 * @id: this field has two meanings, depending on the action:
579 * If the action is ADD, then it means the type of event to add.
580 * For all other actions it is the unique event ID assigned when the
581 * event was added by the FW.
582 * @apply_time: When to start the Time Event (in GP2)
583 * @max_delay: maximum delay to event's start (apply time), in TU
584 * @depends_on: the unique ID of the event we depend on (if any)
585 * @interval: interval between repetitions, in TU
586 * @interval_reciprocal: 2^32 / interval
587 * @duration: duration of event in TU
588 * @repeat: how many repetitions to do, can be TE_REPEAT_ENDLESS
589 * @dep_policy: one of TE_V1_INDEPENDENT, TE_V1_DEP_OTHER, TE_V1_DEP_TSF
590 * and TE_V1_EVENT_SOCIOPATHIC
591 * @is_present: 0 or 1, are we present or absent during the Time Event
592 * @max_frags: maximal number of fragments the Time Event can be divided to
593 * @notify: notifications using TE_V1_NOTIF_* (whom to notify when)
594 */
595 struct iwl_time_event_cmd_v1 {
596 /* COMMON_INDEX_HDR_API_S_VER_1 */
597 __le32 id_and_color;
598 __le32 action;
599 __le32 id;
600 /* MAC_TIME_EVENT_DATA_API_S_VER_1 */
601 __le32 apply_time;
602 __le32 max_delay;
603 __le32 dep_policy;
604 __le32 depends_on;
605 __le32 is_present;
606 __le32 max_frags;
607 __le32 interval;
608 __le32 interval_reciprocal;
609 __le32 duration;
610 __le32 repeat;
611 __le32 notify;
612 } __packed; /* MAC_TIME_EVENT_CMD_API_S_VER_1 */
613
614
615 /* Time event - defines for command API v2 */
616
617 /*
618 * @TE_V2_FRAG_NONE: fragmentation of the time event is NOT allowed.
619 * @TE_V2_FRAG_SINGLE: fragmentation of the time event is allowed, but only
620 * the first fragment is scheduled.
621 * @TE_V2_FRAG_DUAL: fragmentation of the time event is allowed, but only
622 * the first 2 fragments are scheduled.
623 * @TE_V2_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
624 * number of fragments are valid.
625 *
626 * Other than the constant defined above, specifying a fragmentation value 'x'
627 * means that the event can be fragmented but only the first 'x' will be
628 * scheduled.
629 */
630 enum {
631 TE_V2_FRAG_NONE = 0,
632 TE_V2_FRAG_SINGLE = 1,
633 TE_V2_FRAG_DUAL = 2,
634 TE_V2_FRAG_MAX = 0xfe,
635 TE_V2_FRAG_ENDLESS = 0xff
636 };
637
638 /* Repeat the time event endlessly (until removed) */
639 #define TE_V2_REPEAT_ENDLESS 0xff
640 /* If a Time Event has bounded repetitions, this is the maximal value */
641 #define TE_V2_REPEAT_MAX 0xfe
642
643 #define TE_V2_PLACEMENT_POS 12
644 #define TE_V2_ABSENCE_POS 15
645
646 /* Time event policy values (for time event cmd api v2)
647 * A notification (both event and fragment) includes a status indicating weather
648 * the FW was able to schedule the event or not. For fragment start/end
649 * notification the status is always success. There is no start/end fragment
650 * notification for monolithic events.
651 *
652 * @TE_V2_DEFAULT_POLICY: independent, social, present, unoticable
653 * @TE_V2_NOTIF_HOST_EVENT_START: request/receive notification on event start
654 * @TE_V2_NOTIF_HOST_EVENT_END:request/receive notification on event end
655 * @TE_V2_NOTIF_INTERNAL_EVENT_START: internal FW use
656 * @TE_V2_NOTIF_INTERNAL_EVENT_END: internal FW use.
657 * @TE_V2_NOTIF_HOST_FRAG_START: request/receive notification on frag start
658 * @TE_V2_NOTIF_HOST_FRAG_END:request/receive notification on frag end
659 * @TE_V2_NOTIF_INTERNAL_FRAG_START: internal FW use.
660 * @TE_V2_NOTIF_INTERNAL_FRAG_END: internal FW use.
661 * @TE_V2_DEP_OTHER: depends on another time event
662 * @TE_V2_DEP_TSF: depends on a specific time
663 * @TE_V2_EVENT_SOCIOPATHIC: can't co-exist with other events of tha same MAC
664 * @TE_V2_ABSENCE: are we present or absent during the Time Event.
665 */
666 enum {
667 TE_V2_DEFAULT_POLICY = 0x0,
668
669 /* notifications (event start/stop, fragment start/stop) */
670 TE_V2_NOTIF_HOST_EVENT_START = BIT(0),
671 TE_V2_NOTIF_HOST_EVENT_END = BIT(1),
672 TE_V2_NOTIF_INTERNAL_EVENT_START = BIT(2),
673 TE_V2_NOTIF_INTERNAL_EVENT_END = BIT(3),
674
675 TE_V2_NOTIF_HOST_FRAG_START = BIT(4),
676 TE_V2_NOTIF_HOST_FRAG_END = BIT(5),
677 TE_V2_NOTIF_INTERNAL_FRAG_START = BIT(6),
678 TE_V2_NOTIF_INTERNAL_FRAG_END = BIT(7),
679
680 TE_V2_NOTIF_MSK = 0xff,
681
682 /* placement characteristics */
683 TE_V2_DEP_OTHER = BIT(TE_V2_PLACEMENT_POS),
684 TE_V2_DEP_TSF = BIT(TE_V2_PLACEMENT_POS + 1),
685 TE_V2_EVENT_SOCIOPATHIC = BIT(TE_V2_PLACEMENT_POS + 2),
686
687 /* are we present or absent during the Time Event. */
688 TE_V2_ABSENCE = BIT(TE_V2_ABSENCE_POS),
689 };
690
691 /**
692 * struct iwl_time_event_cmd_api_v2 - configuring Time Events
693 * with struct MAC_TIME_EVENT_DATA_API_S_VER_2 (see also
694 * with version 1. determined by IWL_UCODE_TLV_FLAGS)
695 * ( TIME_EVENT_CMD = 0x29 )
696 * @id_and_color: ID and color of the relevant MAC
697 * @action: action to perform, one of FW_CTXT_ACTION_*
698 * @id: this field has two meanings, depending on the action:
699 * If the action is ADD, then it means the type of event to add.
700 * For all other actions it is the unique event ID assigned when the
701 * event was added by the FW.
702 * @apply_time: When to start the Time Event (in GP2)
703 * @max_delay: maximum delay to event's start (apply time), in TU
704 * @depends_on: the unique ID of the event we depend on (if any)
705 * @interval: interval between repetitions, in TU
706 * @duration: duration of event in TU
707 * @repeat: how many repetitions to do, can be TE_REPEAT_ENDLESS
708 * @max_frags: maximal number of fragments the Time Event can be divided to
709 * @policy: defines whether uCode shall notify the host or other uCode modules
710 * on event and/or fragment start and/or end
711 * using one of TE_INDEPENDENT, TE_DEP_OTHER, TE_DEP_TSF
712 * TE_EVENT_SOCIOPATHIC
713 * using TE_ABSENCE and using TE_NOTIF_*
714 */
715 struct iwl_time_event_cmd_v2 {
716 /* COMMON_INDEX_HDR_API_S_VER_1 */
717 __le32 id_and_color;
718 __le32 action;
719 __le32 id;
720 /* MAC_TIME_EVENT_DATA_API_S_VER_2 */
721 __le32 apply_time;
722 __le32 max_delay;
723 __le32 depends_on;
724 __le32 interval;
725 __le32 duration;
726 u8 repeat;
727 u8 max_frags;
728 __le16 policy;
729 } __packed; /* MAC_TIME_EVENT_CMD_API_S_VER_2 */
730
731 /**
732 * struct iwl_time_event_resp - response structure to iwl_time_event_cmd
733 * @status: bit 0 indicates success, all others specify errors
734 * @id: the Time Event type
735 * @unique_id: the unique ID assigned (in ADD) or given (others) to the TE
736 * @id_and_color: ID and color of the relevant MAC
737 */
738 struct iwl_time_event_resp {
739 __le32 status;
740 __le32 id;
741 __le32 unique_id;
742 __le32 id_and_color;
743 } __packed; /* MAC_TIME_EVENT_RSP_API_S_VER_1 */
744
745 /**
746 * struct iwl_time_event_notif - notifications of time event start/stop
747 * ( TIME_EVENT_NOTIFICATION = 0x2a )
748 * @timestamp: action timestamp in GP2
749 * @session_id: session's unique id
750 * @unique_id: unique id of the Time Event itself
751 * @id_and_color: ID and color of the relevant MAC
752 * @action: one of TE_NOTIF_START or TE_NOTIF_END
753 * @status: true if scheduled, false otherwise (not executed)
754 */
755 struct iwl_time_event_notif {
756 __le32 timestamp;
757 __le32 session_id;
758 __le32 unique_id;
759 __le32 id_and_color;
760 __le32 action;
761 __le32 status;
762 } __packed; /* MAC_TIME_EVENT_NTFY_API_S_VER_1 */
763
764
765 /* Bindings and Time Quota */
766
767 /**
768 * struct iwl_binding_cmd - configuring bindings
769 * ( BINDING_CONTEXT_CMD = 0x2b )
770 * @id_and_color: ID and color of the relevant Binding
771 * @action: action to perform, one of FW_CTXT_ACTION_*
772 * @macs: array of MAC id and colors which belong to the binding
773 * @phy: PHY id and color which belongs to the binding
774 */
775 struct iwl_binding_cmd {
776 /* COMMON_INDEX_HDR_API_S_VER_1 */
777 __le32 id_and_color;
778 __le32 action;
779 /* BINDING_DATA_API_S_VER_1 */
780 __le32 macs[MAX_MACS_IN_BINDING];
781 __le32 phy;
782 } __packed; /* BINDING_CMD_API_S_VER_1 */
783
784 /* The maximal number of fragments in the FW's schedule session */
785 #define IWL_MVM_MAX_QUOTA 128
786
787 /**
788 * struct iwl_time_quota_data - configuration of time quota per binding
789 * @id_and_color: ID and color of the relevant Binding
790 * @quota: absolute time quota in TU. The scheduler will try to divide the
791 * remainig quota (after Time Events) according to this quota.
792 * @max_duration: max uninterrupted context duration in TU
793 */
794 struct iwl_time_quota_data {
795 __le32 id_and_color;
796 __le32 quota;
797 __le32 max_duration;
798 } __packed; /* TIME_QUOTA_DATA_API_S_VER_1 */
799
800 /**
801 * struct iwl_time_quota_cmd - configuration of time quota between bindings
802 * ( TIME_QUOTA_CMD = 0x2c )
803 * @quotas: allocations per binding
804 */
805 struct iwl_time_quota_cmd {
806 struct iwl_time_quota_data quotas[MAX_BINDINGS];
807 } __packed; /* TIME_QUOTA_ALLOCATION_CMD_API_S_VER_1 */
808
809
810 /* PHY context */
811
812 /* Supported bands */
813 #define PHY_BAND_5 (0)
814 #define PHY_BAND_24 (1)
815
816 /* Supported channel width, vary if there is VHT support */
817 #define PHY_VHT_CHANNEL_MODE20 (0x0)
818 #define PHY_VHT_CHANNEL_MODE40 (0x1)
819 #define PHY_VHT_CHANNEL_MODE80 (0x2)
820 #define PHY_VHT_CHANNEL_MODE160 (0x3)
821
822 /*
823 * Control channel position:
824 * For legacy set bit means upper channel, otherwise lower.
825 * For VHT - bit-2 marks if the control is lower/upper relative to center-freq
826 * bits-1:0 mark the distance from the center freq. for 20Mhz, offset is 0.
827 * center_freq
828 * |
829 * 40Mhz |_______|_______|
830 * 80Mhz |_______|_______|_______|_______|
831 * 160Mhz |_______|_______|_______|_______|_______|_______|_______|_______|
832 * code 011 010 001 000 | 100 101 110 111
833 */
834 #define PHY_VHT_CTRL_POS_1_BELOW (0x0)
835 #define PHY_VHT_CTRL_POS_2_BELOW (0x1)
836 #define PHY_VHT_CTRL_POS_3_BELOW (0x2)
837 #define PHY_VHT_CTRL_POS_4_BELOW (0x3)
838 #define PHY_VHT_CTRL_POS_1_ABOVE (0x4)
839 #define PHY_VHT_CTRL_POS_2_ABOVE (0x5)
840 #define PHY_VHT_CTRL_POS_3_ABOVE (0x6)
841 #define PHY_VHT_CTRL_POS_4_ABOVE (0x7)
842
843 /*
844 * @band: PHY_BAND_*
845 * @channel: channel number
846 * @width: PHY_[VHT|LEGACY]_CHANNEL_*
847 * @ctrl channel: PHY_[VHT|LEGACY]_CTRL_*
848 */
849 struct iwl_fw_channel_info {
850 u8 band;
851 u8 channel;
852 u8 width;
853 u8 ctrl_pos;
854 } __packed;
855
856 #define PHY_RX_CHAIN_DRIVER_FORCE_POS (0)
857 #define PHY_RX_CHAIN_DRIVER_FORCE_MSK \
858 (0x1 << PHY_RX_CHAIN_DRIVER_FORCE_POS)
859 #define PHY_RX_CHAIN_VALID_POS (1)
860 #define PHY_RX_CHAIN_VALID_MSK \
861 (0x7 << PHY_RX_CHAIN_VALID_POS)
862 #define PHY_RX_CHAIN_FORCE_SEL_POS (4)
863 #define PHY_RX_CHAIN_FORCE_SEL_MSK \
864 (0x7 << PHY_RX_CHAIN_FORCE_SEL_POS)
865 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
866 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_MSK \
867 (0x7 << PHY_RX_CHAIN_FORCE_MIMO_SEL_POS)
868 #define PHY_RX_CHAIN_CNT_POS (10)
869 #define PHY_RX_CHAIN_CNT_MSK \
870 (0x3 << PHY_RX_CHAIN_CNT_POS)
871 #define PHY_RX_CHAIN_MIMO_CNT_POS (12)
872 #define PHY_RX_CHAIN_MIMO_CNT_MSK \
873 (0x3 << PHY_RX_CHAIN_MIMO_CNT_POS)
874 #define PHY_RX_CHAIN_MIMO_FORCE_POS (14)
875 #define PHY_RX_CHAIN_MIMO_FORCE_MSK \
876 (0x1 << PHY_RX_CHAIN_MIMO_FORCE_POS)
877
878 /* TODO: fix the value, make it depend on firmware at runtime? */
879 #define NUM_PHY_CTX 3
880
881 /* TODO: complete missing documentation */
882 /**
883 * struct iwl_phy_context_cmd - config of the PHY context
884 * ( PHY_CONTEXT_CMD = 0x8 )
885 * @id_and_color: ID and color of the relevant Binding
886 * @action: action to perform, one of FW_CTXT_ACTION_*
887 * @apply_time: 0 means immediate apply and context switch.
888 * other value means apply new params after X usecs
889 * @tx_param_color: ???
890 * @channel_info:
891 * @txchain_info: ???
892 * @rxchain_info: ???
893 * @acquisition_data: ???
894 * @dsp_cfg_flags: set to 0
895 */
896 struct iwl_phy_context_cmd {
897 /* COMMON_INDEX_HDR_API_S_VER_1 */
898 __le32 id_and_color;
899 __le32 action;
900 /* PHY_CONTEXT_DATA_API_S_VER_1 */
901 __le32 apply_time;
902 __le32 tx_param_color;
903 struct iwl_fw_channel_info ci;
904 __le32 txchain_info;
905 __le32 rxchain_info;
906 __le32 acquisition_data;
907 __le32 dsp_cfg_flags;
908 } __packed; /* PHY_CONTEXT_CMD_API_VER_1 */
909
910 #define IWL_RX_INFO_PHY_CNT 8
911 #define IWL_RX_INFO_ENERGY_ANT_ABC_IDX 1
912 #define IWL_RX_INFO_ENERGY_ANT_A_MSK 0x000000ff
913 #define IWL_RX_INFO_ENERGY_ANT_B_MSK 0x0000ff00
914 #define IWL_RX_INFO_ENERGY_ANT_C_MSK 0x00ff0000
915 #define IWL_RX_INFO_ENERGY_ANT_A_POS 0
916 #define IWL_RX_INFO_ENERGY_ANT_B_POS 8
917 #define IWL_RX_INFO_ENERGY_ANT_C_POS 16
918
919 #define IWL_RX_INFO_AGC_IDX 1
920 #define IWL_RX_INFO_RSSI_AB_IDX 2
921 #define IWL_OFDM_AGC_A_MSK 0x0000007f
922 #define IWL_OFDM_AGC_A_POS 0
923 #define IWL_OFDM_AGC_B_MSK 0x00003f80
924 #define IWL_OFDM_AGC_B_POS 7
925 #define IWL_OFDM_AGC_CODE_MSK 0x3fe00000
926 #define IWL_OFDM_AGC_CODE_POS 20
927 #define IWL_OFDM_RSSI_INBAND_A_MSK 0x00ff
928 #define IWL_OFDM_RSSI_A_POS 0
929 #define IWL_OFDM_RSSI_ALLBAND_A_MSK 0xff00
930 #define IWL_OFDM_RSSI_ALLBAND_A_POS 8
931 #define IWL_OFDM_RSSI_INBAND_B_MSK 0xff0000
932 #define IWL_OFDM_RSSI_B_POS 16
933 #define IWL_OFDM_RSSI_ALLBAND_B_MSK 0xff000000
934 #define IWL_OFDM_RSSI_ALLBAND_B_POS 24
935
936 /**
937 * struct iwl_rx_phy_info - phy info
938 * (REPLY_RX_PHY_CMD = 0xc0)
939 * @non_cfg_phy_cnt: non configurable DSP phy data byte count
940 * @cfg_phy_cnt: configurable DSP phy data byte count
941 * @stat_id: configurable DSP phy data set ID
942 * @reserved1:
943 * @system_timestamp: GP2 at on air rise
944 * @timestamp: TSF at on air rise
945 * @beacon_time_stamp: beacon at on-air rise
946 * @phy_flags: general phy flags: band, modulation, ...
947 * @channel: channel number
948 * @non_cfg_phy_buf: for various implementations of non_cfg_phy
949 * @rate_n_flags: RATE_MCS_*
950 * @byte_count: frame's byte-count
951 * @frame_time: frame's time on the air, based on byte count and frame rate
952 * calculation
953 * @mac_active_msk: what MACs were active when the frame was received
954 *
955 * Before each Rx, the device sends this data. It contains PHY information
956 * about the reception of the packet.
957 */
958 struct iwl_rx_phy_info {
959 u8 non_cfg_phy_cnt;
960 u8 cfg_phy_cnt;
961 u8 stat_id;
962 u8 reserved1;
963 __le32 system_timestamp;
964 __le64 timestamp;
965 __le32 beacon_time_stamp;
966 __le16 phy_flags;
967 __le16 channel;
968 __le32 non_cfg_phy[IWL_RX_INFO_PHY_CNT];
969 __le32 rate_n_flags;
970 __le32 byte_count;
971 __le16 mac_active_msk;
972 __le16 frame_time;
973 } __packed;
974
975 struct iwl_rx_mpdu_res_start {
976 __le16 byte_count;
977 __le16 reserved;
978 } __packed;
979
980 /**
981 * enum iwl_rx_phy_flags - to parse %iwl_rx_phy_info phy_flags
982 * @RX_RES_PHY_FLAGS_BAND_24: true if the packet was received on 2.4 band
983 * @RX_RES_PHY_FLAGS_MOD_CCK:
984 * @RX_RES_PHY_FLAGS_SHORT_PREAMBLE: true if packet's preamble was short
985 * @RX_RES_PHY_FLAGS_NARROW_BAND:
986 * @RX_RES_PHY_FLAGS_ANTENNA: antenna on which the packet was received
987 * @RX_RES_PHY_FLAGS_AGG: set if the packet was part of an A-MPDU
988 * @RX_RES_PHY_FLAGS_OFDM_HT: The frame was an HT frame
989 * @RX_RES_PHY_FLAGS_OFDM_GF: The frame used GF preamble
990 * @RX_RES_PHY_FLAGS_OFDM_VHT: The frame was a VHT frame
991 */
992 enum iwl_rx_phy_flags {
993 RX_RES_PHY_FLAGS_BAND_24 = BIT(0),
994 RX_RES_PHY_FLAGS_MOD_CCK = BIT(1),
995 RX_RES_PHY_FLAGS_SHORT_PREAMBLE = BIT(2),
996 RX_RES_PHY_FLAGS_NARROW_BAND = BIT(3),
997 RX_RES_PHY_FLAGS_ANTENNA = (0x7 << 4),
998 RX_RES_PHY_FLAGS_ANTENNA_POS = 4,
999 RX_RES_PHY_FLAGS_AGG = BIT(7),
1000 RX_RES_PHY_FLAGS_OFDM_HT = BIT(8),
1001 RX_RES_PHY_FLAGS_OFDM_GF = BIT(9),
1002 RX_RES_PHY_FLAGS_OFDM_VHT = BIT(10),
1003 };
1004
1005 /**
1006 * enum iwl_mvm_rx_status - written by fw for each Rx packet
1007 * @RX_MPDU_RES_STATUS_CRC_OK: CRC is fine
1008 * @RX_MPDU_RES_STATUS_OVERRUN_OK: there was no RXE overflow
1009 * @RX_MPDU_RES_STATUS_SRC_STA_FOUND:
1010 * @RX_MPDU_RES_STATUS_KEY_VALID:
1011 * @RX_MPDU_RES_STATUS_KEY_PARAM_OK:
1012 * @RX_MPDU_RES_STATUS_ICV_OK: ICV is fine, if not, the packet is destroyed
1013 * @RX_MPDU_RES_STATUS_MIC_OK: used for CCM alg only. TKIP MIC is checked
1014 * in the driver.
1015 * @RX_MPDU_RES_STATUS_TTAK_OK: TTAK is fine
1016 * @RX_MPDU_RES_STATUS_MNG_FRAME_REPLAY_ERR: valid for alg = CCM_CMAC or
1017 * alg = CCM only. Checks replay attack for 11w frames. Relevant only if
1018 * %RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME is set.
1019 * @RX_MPDU_RES_STATUS_SEC_NO_ENC: this frame is not encrypted
1020 * @RX_MPDU_RES_STATUS_SEC_WEP_ENC: this frame is encrypted using WEP
1021 * @RX_MPDU_RES_STATUS_SEC_CCM_ENC: this frame is encrypted using CCM
1022 * @RX_MPDU_RES_STATUS_SEC_TKIP_ENC: this frame is encrypted using TKIP
1023 * @RX_MPDU_RES_STATUS_SEC_CCM_CMAC_ENC: this frame is encrypted using CCM_CMAC
1024 * @RX_MPDU_RES_STATUS_SEC_ENC_ERR: this frame couldn't be decrypted
1025 * @RX_MPDU_RES_STATUS_SEC_ENC_MSK: bitmask of the encryption algorithm
1026 * @RX_MPDU_RES_STATUS_DEC_DONE: this frame has been successfully decrypted
1027 * @RX_MPDU_RES_STATUS_PROTECT_FRAME_BIT_CMP:
1028 * @RX_MPDU_RES_STATUS_EXT_IV_BIT_CMP:
1029 * @RX_MPDU_RES_STATUS_KEY_ID_CMP_BIT:
1030 * @RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME: this frame is an 11w management frame
1031 * @RX_MPDU_RES_STATUS_HASH_INDEX_MSK:
1032 * @RX_MPDU_RES_STATUS_STA_ID_MSK:
1033 * @RX_MPDU_RES_STATUS_RRF_KILL:
1034 * @RX_MPDU_RES_STATUS_FILTERING_MSK:
1035 * @RX_MPDU_RES_STATUS2_FILTERING_MSK:
1036 */
1037 enum iwl_mvm_rx_status {
1038 RX_MPDU_RES_STATUS_CRC_OK = BIT(0),
1039 RX_MPDU_RES_STATUS_OVERRUN_OK = BIT(1),
1040 RX_MPDU_RES_STATUS_SRC_STA_FOUND = BIT(2),
1041 RX_MPDU_RES_STATUS_KEY_VALID = BIT(3),
1042 RX_MPDU_RES_STATUS_KEY_PARAM_OK = BIT(4),
1043 RX_MPDU_RES_STATUS_ICV_OK = BIT(5),
1044 RX_MPDU_RES_STATUS_MIC_OK = BIT(6),
1045 RX_MPDU_RES_STATUS_TTAK_OK = BIT(7),
1046 RX_MPDU_RES_STATUS_MNG_FRAME_REPLAY_ERR = BIT(7),
1047 RX_MPDU_RES_STATUS_SEC_NO_ENC = (0 << 8),
1048 RX_MPDU_RES_STATUS_SEC_WEP_ENC = (1 << 8),
1049 RX_MPDU_RES_STATUS_SEC_CCM_ENC = (2 << 8),
1050 RX_MPDU_RES_STATUS_SEC_TKIP_ENC = (3 << 8),
1051 RX_MPDU_RES_STATUS_SEC_CCM_CMAC_ENC = (6 << 8),
1052 RX_MPDU_RES_STATUS_SEC_ENC_ERR = (7 << 8),
1053 RX_MPDU_RES_STATUS_SEC_ENC_MSK = (7 << 8),
1054 RX_MPDU_RES_STATUS_DEC_DONE = BIT(11),
1055 RX_MPDU_RES_STATUS_PROTECT_FRAME_BIT_CMP = BIT(12),
1056 RX_MPDU_RES_STATUS_EXT_IV_BIT_CMP = BIT(13),
1057 RX_MPDU_RES_STATUS_KEY_ID_CMP_BIT = BIT(14),
1058 RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME = BIT(15),
1059 RX_MPDU_RES_STATUS_HASH_INDEX_MSK = (0x3F0000),
1060 RX_MPDU_RES_STATUS_STA_ID_MSK = (0x1f000000),
1061 RX_MPDU_RES_STATUS_RRF_KILL = BIT(29),
1062 RX_MPDU_RES_STATUS_FILTERING_MSK = (0xc00000),
1063 RX_MPDU_RES_STATUS2_FILTERING_MSK = (0xc0000000),
1064 };
1065
1066 /**
1067 * struct iwl_radio_version_notif - information on the radio version
1068 * ( RADIO_VERSION_NOTIFICATION = 0x68 )
1069 * @radio_flavor:
1070 * @radio_step:
1071 * @radio_dash:
1072 */
1073 struct iwl_radio_version_notif {
1074 __le32 radio_flavor;
1075 __le32 radio_step;
1076 __le32 radio_dash;
1077 } __packed; /* RADIO_VERSION_NOTOFICATION_S_VER_1 */
1078
1079 enum iwl_card_state_flags {
1080 CARD_ENABLED = 0x00,
1081 HW_CARD_DISABLED = 0x01,
1082 SW_CARD_DISABLED = 0x02,
1083 CT_KILL_CARD_DISABLED = 0x04,
1084 HALT_CARD_DISABLED = 0x08,
1085 CARD_DISABLED_MSK = 0x0f,
1086 CARD_IS_RX_ON = 0x10,
1087 };
1088
1089 /**
1090 * struct iwl_radio_version_notif - information on the radio version
1091 * ( CARD_STATE_NOTIFICATION = 0xa1 )
1092 * @flags: %iwl_card_state_flags
1093 */
1094 struct iwl_card_state_notif {
1095 __le32 flags;
1096 } __packed; /* CARD_STATE_NTFY_API_S_VER_1 */
1097
1098 /**
1099 * struct iwl_missed_beacons_notif - information on missed beacons
1100 * ( MISSED_BEACONS_NOTIFICATION = 0xa2 )
1101 * @mac_id: interface ID
1102 * @consec_missed_beacons_since_last_rx: number of consecutive missed
1103 * beacons since last RX.
1104 * @consec_missed_beacons: number of consecutive missed beacons
1105 * @num_expected_beacons:
1106 * @num_recvd_beacons:
1107 */
1108 struct iwl_missed_beacons_notif {
1109 __le32 mac_id;
1110 __le32 consec_missed_beacons_since_last_rx;
1111 __le32 consec_missed_beacons;
1112 __le32 num_expected_beacons;
1113 __le32 num_recvd_beacons;
1114 } __packed; /* MISSED_BEACON_NTFY_API_S_VER_3 */
1115
1116 /**
1117 * struct iwl_set_calib_default_cmd - set default value for calibration.
1118 * ( SET_CALIB_DEFAULT_CMD = 0x8e )
1119 * @calib_index: the calibration to set value for
1120 * @length: of data
1121 * @data: the value to set for the calibration result
1122 */
1123 struct iwl_set_calib_default_cmd {
1124 __le16 calib_index;
1125 __le16 length;
1126 u8 data[0];
1127 } __packed; /* PHY_CALIB_OVERRIDE_VALUES_S */
1128
1129 #define MAX_PORT_ID_NUM 2
1130
1131 /**
1132 * struct iwl_mcast_filter_cmd - configure multicast filter.
1133 * @filter_own: Set 1 to filter out multicast packets sent by station itself
1134 * @port_id: Multicast MAC addresses array specifier. This is a strange way
1135 * to identify network interface adopted in host-device IF.
1136 * It is used by FW as index in array of addresses. This array has
1137 * MAX_PORT_ID_NUM members.
1138 * @count: Number of MAC addresses in the array
1139 * @pass_all: Set 1 to pass all multicast packets.
1140 * @bssid: current association BSSID.
1141 * @addr_list: Place holder for array of MAC addresses.
1142 * IMPORTANT: add padding if necessary to ensure DWORD alignment.
1143 */
1144 struct iwl_mcast_filter_cmd {
1145 u8 filter_own;
1146 u8 port_id;
1147 u8 count;
1148 u8 pass_all;
1149 u8 bssid[6];
1150 u8 reserved[2];
1151 u8 addr_list[0];
1152 } __packed; /* MCAST_FILTERING_CMD_API_S_VER_1 */
1153
1154 struct mvm_statistics_dbg {
1155 __le32 burst_check;
1156 __le32 burst_count;
1157 __le32 wait_for_silence_timeout_cnt;
1158 __le32 reserved[3];
1159 } __packed; /* STATISTICS_DEBUG_API_S_VER_2 */
1160
1161 struct mvm_statistics_div {
1162 __le32 tx_on_a;
1163 __le32 tx_on_b;
1164 __le32 exec_time;
1165 __le32 probe_time;
1166 __le32 rssi_ant;
1167 __le32 reserved2;
1168 } __packed; /* STATISTICS_SLOW_DIV_API_S_VER_2 */
1169
1170 struct mvm_statistics_general_common {
1171 __le32 temperature; /* radio temperature */
1172 __le32 temperature_m; /* radio voltage */
1173 struct mvm_statistics_dbg dbg;
1174 __le32 sleep_time;
1175 __le32 slots_out;
1176 __le32 slots_idle;
1177 __le32 ttl_timestamp;
1178 struct mvm_statistics_div div;
1179 __le32 rx_enable_counter;
1180 /*
1181 * num_of_sos_states:
1182 * count the number of times we have to re-tune
1183 * in order to get out of bad PHY status
1184 */
1185 __le32 num_of_sos_states;
1186 } __packed; /* STATISTICS_GENERAL_API_S_VER_5 */
1187
1188 struct mvm_statistics_rx_non_phy {
1189 __le32 bogus_cts; /* CTS received when not expecting CTS */
1190 __le32 bogus_ack; /* ACK received when not expecting ACK */
1191 __le32 non_bssid_frames; /* number of frames with BSSID that
1192 * doesn't belong to the STA BSSID */
1193 __le32 filtered_frames; /* count frames that were dumped in the
1194 * filtering process */
1195 __le32 non_channel_beacons; /* beacons with our bss id but not on
1196 * our serving channel */
1197 __le32 channel_beacons; /* beacons with our bss id and in our
1198 * serving channel */
1199 __le32 num_missed_bcon; /* number of missed beacons */
1200 __le32 adc_rx_saturation_time; /* count in 0.8us units the time the
1201 * ADC was in saturation */
1202 __le32 ina_detection_search_time;/* total time (in 0.8us) searched
1203 * for INA */
1204 __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */
1205 __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */
1206 __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */
1207 __le32 interference_data_flag; /* flag for interference data
1208 * availability. 1 when data is
1209 * available. */
1210 __le32 channel_load; /* counts RX Enable time in uSec */
1211 __le32 dsp_false_alarms; /* DSP false alarm (both OFDM
1212 * and CCK) counter */
1213 __le32 beacon_rssi_a;
1214 __le32 beacon_rssi_b;
1215 __le32 beacon_rssi_c;
1216 __le32 beacon_energy_a;
1217 __le32 beacon_energy_b;
1218 __le32 beacon_energy_c;
1219 __le32 num_bt_kills;
1220 __le32 mac_id;
1221 __le32 directed_data_mpdu;
1222 } __packed; /* STATISTICS_RX_NON_PHY_API_S_VER_3 */
1223
1224 struct mvm_statistics_rx_phy {
1225 __le32 ina_cnt;
1226 __le32 fina_cnt;
1227 __le32 plcp_err;
1228 __le32 crc32_err;
1229 __le32 overrun_err;
1230 __le32 early_overrun_err;
1231 __le32 crc32_good;
1232 __le32 false_alarm_cnt;
1233 __le32 fina_sync_err_cnt;
1234 __le32 sfd_timeout;
1235 __le32 fina_timeout;
1236 __le32 unresponded_rts;
1237 __le32 rxe_frame_limit_overrun;
1238 __le32 sent_ack_cnt;
1239 __le32 sent_cts_cnt;
1240 __le32 sent_ba_rsp_cnt;
1241 __le32 dsp_self_kill;
1242 __le32 mh_format_err;
1243 __le32 re_acq_main_rssi_sum;
1244 __le32 reserved;
1245 } __packed; /* STATISTICS_RX_PHY_API_S_VER_2 */
1246
1247 struct mvm_statistics_rx_ht_phy {
1248 __le32 plcp_err;
1249 __le32 overrun_err;
1250 __le32 early_overrun_err;
1251 __le32 crc32_good;
1252 __le32 crc32_err;
1253 __le32 mh_format_err;
1254 __le32 agg_crc32_good;
1255 __le32 agg_mpdu_cnt;
1256 __le32 agg_cnt;
1257 __le32 unsupport_mcs;
1258 } __packed; /* STATISTICS_HT_RX_PHY_API_S_VER_1 */
1259
1260 #define MAX_CHAINS 3
1261
1262 struct mvm_statistics_tx_non_phy_agg {
1263 __le32 ba_timeout;
1264 __le32 ba_reschedule_frames;
1265 __le32 scd_query_agg_frame_cnt;
1266 __le32 scd_query_no_agg;
1267 __le32 scd_query_agg;
1268 __le32 scd_query_mismatch;
1269 __le32 frame_not_ready;
1270 __le32 underrun;
1271 __le32 bt_prio_kill;
1272 __le32 rx_ba_rsp_cnt;
1273 __s8 txpower[MAX_CHAINS];
1274 __s8 reserved;
1275 __le32 reserved2;
1276 } __packed; /* STATISTICS_TX_NON_PHY_AGG_API_S_VER_1 */
1277
1278 struct mvm_statistics_tx_channel_width {
1279 __le32 ext_cca_narrow_ch20[1];
1280 __le32 ext_cca_narrow_ch40[2];
1281 __le32 ext_cca_narrow_ch80[3];
1282 __le32 ext_cca_narrow_ch160[4];
1283 __le32 last_tx_ch_width_indx;
1284 __le32 rx_detected_per_ch_width[4];
1285 __le32 success_per_ch_width[4];
1286 __le32 fail_per_ch_width[4];
1287 }; /* STATISTICS_TX_CHANNEL_WIDTH_API_S_VER_1 */
1288
1289 struct mvm_statistics_tx {
1290 __le32 preamble_cnt;
1291 __le32 rx_detected_cnt;
1292 __le32 bt_prio_defer_cnt;
1293 __le32 bt_prio_kill_cnt;
1294 __le32 few_bytes_cnt;
1295 __le32 cts_timeout;
1296 __le32 ack_timeout;
1297 __le32 expected_ack_cnt;
1298 __le32 actual_ack_cnt;
1299 __le32 dump_msdu_cnt;
1300 __le32 burst_abort_next_frame_mismatch_cnt;
1301 __le32 burst_abort_missing_next_frame_cnt;
1302 __le32 cts_timeout_collision;
1303 __le32 ack_or_ba_timeout_collision;
1304 struct mvm_statistics_tx_non_phy_agg agg;
1305 struct mvm_statistics_tx_channel_width channel_width;
1306 } __packed; /* STATISTICS_TX_API_S_VER_4 */
1307
1308
1309 struct mvm_statistics_bt_activity {
1310 __le32 hi_priority_tx_req_cnt;
1311 __le32 hi_priority_tx_denied_cnt;
1312 __le32 lo_priority_tx_req_cnt;
1313 __le32 lo_priority_tx_denied_cnt;
1314 __le32 hi_priority_rx_req_cnt;
1315 __le32 hi_priority_rx_denied_cnt;
1316 __le32 lo_priority_rx_req_cnt;
1317 __le32 lo_priority_rx_denied_cnt;
1318 } __packed; /* STATISTICS_BT_ACTIVITY_API_S_VER_1 */
1319
1320 struct mvm_statistics_general {
1321 struct mvm_statistics_general_common common;
1322 __le32 beacon_filtered;
1323 __le32 missed_beacons;
1324 __s8 beacon_filter_average_energy;
1325 __s8 beacon_filter_reason;
1326 __s8 beacon_filter_current_energy;
1327 __s8 beacon_filter_reserved;
1328 __le32 beacon_filter_delta_time;
1329 struct mvm_statistics_bt_activity bt_activity;
1330 } __packed; /* STATISTICS_GENERAL_API_S_VER_5 */
1331
1332 struct mvm_statistics_rx {
1333 struct mvm_statistics_rx_phy ofdm;
1334 struct mvm_statistics_rx_phy cck;
1335 struct mvm_statistics_rx_non_phy general;
1336 struct mvm_statistics_rx_ht_phy ofdm_ht;
1337 } __packed; /* STATISTICS_RX_API_S_VER_3 */
1338
1339 /*
1340 * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
1341 *
1342 * By default, uCode issues this notification after receiving a beacon
1343 * while associated. To disable this behavior, set DISABLE_NOTIF flag in the
1344 * REPLY_STATISTICS_CMD 0x9c, above.
1345 *
1346 * Statistics counters continue to increment beacon after beacon, but are
1347 * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
1348 * 0x9c with CLEAR_STATS bit set (see above).
1349 *
1350 * uCode also issues this notification during scans. uCode clears statistics
1351 * appropriately so that each notification contains statistics for only the
1352 * one channel that has just been scanned.
1353 */
1354
1355 struct iwl_notif_statistics { /* STATISTICS_NTFY_API_S_VER_8 */
1356 __le32 flag;
1357 struct mvm_statistics_rx rx;
1358 struct mvm_statistics_tx tx;
1359 struct mvm_statistics_general general;
1360 } __packed;
1361
1362 #endif /* __fw_api_h__ */
Linux with added FPC-III support