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