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