Loading...
1/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2/*
3 * Copyright (C) 2005-2014, 2018-2023 Intel Corporation
4 * Copyright (C) 2013-2015 Intel Mobile Communications GmbH
5 * Copyright (C) 2016-2017 Intel Deutschland GmbH
6 */
7#ifndef __iwl_fw_api_debug_h__
8#define __iwl_fw_api_debug_h__
9
10/**
11 * enum iwl_debug_cmds - debug commands
12 */
13enum iwl_debug_cmds {
14 /**
15 * @LMAC_RD_WR:
16 * LMAC memory read/write, using &struct iwl_dbg_mem_access_cmd and
17 * &struct iwl_dbg_mem_access_rsp
18 */
19 LMAC_RD_WR = 0x0,
20 /**
21 * @UMAC_RD_WR:
22 * UMAC memory read/write, using &struct iwl_dbg_mem_access_cmd and
23 * &struct iwl_dbg_mem_access_rsp
24 */
25 UMAC_RD_WR = 0x1,
26 /**
27 * @HOST_EVENT_CFG:
28 * updates the enabled event severities
29 * &struct iwl_dbg_host_event_cfg_cmd
30 */
31 HOST_EVENT_CFG = 0x3,
32 /**
33 * @INVALID_WR_PTR_CMD: invalid write pointer, set in the TFD
34 * when it's not in use
35 */
36 INVALID_WR_PTR_CMD = 0x6,
37 /**
38 * @DBGC_SUSPEND_RESUME:
39 * DBGC suspend/resume commad. Uses a single dword as data:
40 * 0 - resume DBGC recording
41 * 1 - suspend DBGC recording
42 */
43 DBGC_SUSPEND_RESUME = 0x7,
44 /**
45 * @BUFFER_ALLOCATION:
46 * passes DRAM buffers to a DBGC
47 * &struct iwl_buf_alloc_cmd
48 */
49 BUFFER_ALLOCATION = 0x8,
50 /**
51 * @GET_TAS_STATUS:
52 * sends command to fw to get TAS status
53 * the response is &struct iwl_mvm_tas_status_resp
54 */
55 GET_TAS_STATUS = 0xA,
56 /**
57 * @FW_DUMP_COMPLETE_CMD:
58 * sends command to fw once dump collection completed
59 * &struct iwl_dbg_dump_complete_cmd
60 */
61 FW_DUMP_COMPLETE_CMD = 0xB,
62 /**
63 * @FW_CLEAR_BUFFER:
64 * clears the firmware's internal buffer
65 * no payload
66 */
67 FW_CLEAR_BUFFER = 0xD,
68 /**
69 * @MFU_ASSERT_DUMP_NTF:
70 * &struct iwl_mfu_assert_dump_notif
71 */
72 MFU_ASSERT_DUMP_NTF = 0xFE,
73};
74
75/* Error response/notification */
76enum {
77 FW_ERR_UNKNOWN_CMD = 0x0,
78 FW_ERR_INVALID_CMD_PARAM = 0x1,
79 FW_ERR_SERVICE = 0x2,
80 FW_ERR_ARC_MEMORY = 0x3,
81 FW_ERR_ARC_CODE = 0x4,
82 FW_ERR_WATCH_DOG = 0x5,
83 FW_ERR_WEP_GRP_KEY_INDX = 0x10,
84 FW_ERR_WEP_KEY_SIZE = 0x11,
85 FW_ERR_OBSOLETE_FUNC = 0x12,
86 FW_ERR_UNEXPECTED = 0xFE,
87 FW_ERR_FATAL = 0xFF
88};
89
90/** enum iwl_dbg_suspend_resume_cmds - dbgc suspend resume operations
91 * dbgc suspend resume command operations
92 * @DBGC_RESUME_CMD: resume dbgc recording
93 * @DBGC_SUSPEND_CMD: stop dbgc recording
94 */
95enum iwl_dbg_suspend_resume_cmds {
96 DBGC_RESUME_CMD,
97 DBGC_SUSPEND_CMD,
98};
99
100/**
101 * struct iwl_error_resp - FW error indication
102 * ( REPLY_ERROR = 0x2 )
103 * @error_type: one of FW_ERR_*
104 * @cmd_id: the command ID for which the error occurred
105 * @reserved1: reserved
106 * @bad_cmd_seq_num: sequence number of the erroneous command
107 * @error_service: which service created the error, applicable only if
108 * error_type = 2, otherwise 0
109 * @timestamp: TSF in usecs.
110 */
111struct iwl_error_resp {
112 __le32 error_type;
113 u8 cmd_id;
114 u8 reserved1;
115 __le16 bad_cmd_seq_num;
116 __le32 error_service;
117 __le64 timestamp;
118} __packed;
119
120#define TX_FIFO_MAX_NUM_9000 8
121#define TX_FIFO_MAX_NUM 15
122#define RX_FIFO_MAX_NUM 2
123#define TX_FIFO_INTERNAL_MAX_NUM 6
124
125/**
126 * struct iwl_shared_mem_cfg_v2 - Shared memory configuration information
127 *
128 * @shared_mem_addr: shared memory addr (pre 8000 HW set to 0x0 as MARBH is not
129 * accessible)
130 * @shared_mem_size: shared memory size
131 * @sample_buff_addr: internal sample (mon/adc) buff addr (pre 8000 HW set to
132 * 0x0 as accessible only via DBGM RDAT)
133 * @sample_buff_size: internal sample buff size
134 * @txfifo_addr: start addr of TXF0 (excluding the context table 0.5KB), (pre
135 * 8000 HW set to 0x0 as not accessible)
136 * @txfifo_size: size of TXF0 ... TXF7
137 * @rxfifo_size: RXF1, RXF2 sizes. If there is no RXF2, it'll have a value of 0
138 * @page_buff_addr: used by UMAC and performance debug (page miss analysis),
139 * when paging is not supported this should be 0
140 * @page_buff_size: size of %page_buff_addr
141 * @rxfifo_addr: Start address of rxFifo
142 * @internal_txfifo_addr: start address of internalFifo
143 * @internal_txfifo_size: internal fifos' size
144 *
145 * NOTE: on firmware that don't have IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG
146 * set, the last 3 members don't exist.
147 */
148struct iwl_shared_mem_cfg_v2 {
149 __le32 shared_mem_addr;
150 __le32 shared_mem_size;
151 __le32 sample_buff_addr;
152 __le32 sample_buff_size;
153 __le32 txfifo_addr;
154 __le32 txfifo_size[TX_FIFO_MAX_NUM_9000];
155 __le32 rxfifo_size[RX_FIFO_MAX_NUM];
156 __le32 page_buff_addr;
157 __le32 page_buff_size;
158 __le32 rxfifo_addr;
159 __le32 internal_txfifo_addr;
160 __le32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM];
161} __packed; /* SHARED_MEM_ALLOC_API_S_VER_2 */
162
163/**
164 * struct iwl_shared_mem_lmac_cfg - LMAC shared memory configuration
165 *
166 * @txfifo_addr: start addr of TXF0 (excluding the context table 0.5KB)
167 * @txfifo_size: size of TX FIFOs
168 * @rxfifo1_addr: RXF1 addr
169 * @rxfifo1_size: RXF1 size
170 */
171struct iwl_shared_mem_lmac_cfg {
172 __le32 txfifo_addr;
173 __le32 txfifo_size[TX_FIFO_MAX_NUM];
174 __le32 rxfifo1_addr;
175 __le32 rxfifo1_size;
176
177} __packed; /* SHARED_MEM_ALLOC_LMAC_API_S_VER_1 */
178
179/**
180 * struct iwl_shared_mem_cfg - Shared memory configuration information
181 *
182 * @shared_mem_addr: shared memory address
183 * @shared_mem_size: shared memory size
184 * @sample_buff_addr: internal sample (mon/adc) buff addr
185 * @sample_buff_size: internal sample buff size
186 * @rxfifo2_addr: start addr of RXF2
187 * @rxfifo2_size: size of RXF2
188 * @page_buff_addr: used by UMAC and performance debug (page miss analysis),
189 * when paging is not supported this should be 0
190 * @page_buff_size: size of %page_buff_addr
191 * @lmac_num: number of LMACs (1 or 2)
192 * @lmac_smem: per - LMAC smem data
193 * @rxfifo2_control_addr: start addr of RXF2C
194 * @rxfifo2_control_size: size of RXF2C
195 */
196struct iwl_shared_mem_cfg {
197 __le32 shared_mem_addr;
198 __le32 shared_mem_size;
199 __le32 sample_buff_addr;
200 __le32 sample_buff_size;
201 __le32 rxfifo2_addr;
202 __le32 rxfifo2_size;
203 __le32 page_buff_addr;
204 __le32 page_buff_size;
205 __le32 lmac_num;
206 struct iwl_shared_mem_lmac_cfg lmac_smem[3];
207 __le32 rxfifo2_control_addr;
208 __le32 rxfifo2_control_size;
209} __packed; /* SHARED_MEM_ALLOC_API_S_VER_4 */
210
211/**
212 * struct iwl_mfuart_load_notif_v1 - mfuart image version & status
213 * ( MFUART_LOAD_NOTIFICATION = 0xb1 )
214 * @installed_ver: installed image version
215 * @external_ver: external image version
216 * @status: MFUART loading status
217 * @duration: MFUART loading time
218*/
219struct iwl_mfuart_load_notif_v1 {
220 __le32 installed_ver;
221 __le32 external_ver;
222 __le32 status;
223 __le32 duration;
224} __packed; /* MFU_LOADER_NTFY_API_S_VER_1 */
225
226/**
227 * struct iwl_mfuart_load_notif - mfuart image version & status
228 * ( MFUART_LOAD_NOTIFICATION = 0xb1 )
229 * @installed_ver: installed image version
230 * @external_ver: external image version
231 * @status: MFUART loading status
232 * @duration: MFUART loading time
233 * @image_size: MFUART image size in bytes
234*/
235struct iwl_mfuart_load_notif {
236 __le32 installed_ver;
237 __le32 external_ver;
238 __le32 status;
239 __le32 duration;
240 /* image size valid only in v2 of the command */
241 __le32 image_size;
242} __packed; /* MFU_LOADER_NTFY_API_S_VER_2 */
243
244/**
245 * struct iwl_mfu_assert_dump_notif - mfuart dump logs
246 * ( MFU_ASSERT_DUMP_NTF = 0xfe )
247 * @assert_id: mfuart assert id that cause the notif
248 * @curr_reset_num: number of asserts since uptime
249 * @index_num: current chunk id
250 * @parts_num: total number of chunks
251 * @data_size: number of data bytes sent
252 * @data: data buffer
253 */
254struct iwl_mfu_assert_dump_notif {
255 __le32 assert_id;
256 __le32 curr_reset_num;
257 __le16 index_num;
258 __le16 parts_num;
259 __le32 data_size;
260 __le32 data[];
261} __packed; /* MFU_DUMP_ASSERT_API_S_VER_1 */
262
263/**
264 * enum iwl_mvm_marker_id - marker ids
265 *
266 * The ids for different type of markers to insert into the usniffer logs
267 *
268 * @MARKER_ID_TX_FRAME_LATENCY: TX latency marker
269 * @MARKER_ID_SYNC_CLOCK: sync FW time and systime
270 */
271enum iwl_mvm_marker_id {
272 MARKER_ID_TX_FRAME_LATENCY = 1,
273 MARKER_ID_SYNC_CLOCK = 2,
274}; /* MARKER_ID_API_E_VER_2 */
275
276/**
277 * struct iwl_mvm_marker - mark info into the usniffer logs
278 *
279 * (MARKER_CMD = 0xcb)
280 *
281 * Mark the UTC time stamp into the usniffer logs together with additional
282 * metadata, so the usniffer output can be parsed.
283 * In the command response the ucode will return the GP2 time.
284 *
285 * @dw_len: The amount of dwords following this byte including this byte.
286 * @marker_id: A unique marker id (iwl_mvm_marker_id).
287 * @reserved: reserved.
288 * @timestamp: in milliseconds since 1970-01-01 00:00:00 UTC
289 * @metadata: additional meta data that will be written to the unsiffer log
290 */
291struct iwl_mvm_marker {
292 u8 dw_len;
293 u8 marker_id;
294 __le16 reserved;
295 __le64 timestamp;
296 __le32 metadata[];
297} __packed; /* MARKER_API_S_VER_1 */
298
299/**
300 * struct iwl_mvm_marker_rsp - Response to marker cmd
301 *
302 * @gp2: The gp2 clock value in the FW
303 */
304struct iwl_mvm_marker_rsp {
305 __le32 gp2;
306} __packed;
307
308/* Operation types for the debug mem access */
309enum {
310 DEBUG_MEM_OP_READ = 0,
311 DEBUG_MEM_OP_WRITE = 1,
312 DEBUG_MEM_OP_WRITE_BYTES = 2,
313};
314
315#define DEBUG_MEM_MAX_SIZE_DWORDS 32
316
317/**
318 * struct iwl_dbg_mem_access_cmd - Request the device to read/write memory
319 * @op: DEBUG_MEM_OP_*
320 * @addr: address to read/write from/to
321 * @len: in dwords, to read/write
322 * @data: for write opeations, contains the source buffer
323 */
324struct iwl_dbg_mem_access_cmd {
325 __le32 op;
326 __le32 addr;
327 __le32 len;
328 __le32 data[];
329} __packed; /* DEBUG_(U|L)MAC_RD_WR_CMD_API_S_VER_1 */
330
331/* Status responses for the debug mem access */
332enum {
333 DEBUG_MEM_STATUS_SUCCESS = 0x0,
334 DEBUG_MEM_STATUS_FAILED = 0x1,
335 DEBUG_MEM_STATUS_LOCKED = 0x2,
336 DEBUG_MEM_STATUS_HIDDEN = 0x3,
337 DEBUG_MEM_STATUS_LENGTH = 0x4,
338};
339
340/**
341 * struct iwl_dbg_mem_access_rsp - Response to debug mem commands
342 * @status: DEBUG_MEM_STATUS_*
343 * @len: read dwords (0 for write operations)
344 * @data: contains the read DWs
345 */
346struct iwl_dbg_mem_access_rsp {
347 __le32 status;
348 __le32 len;
349 __le32 data[];
350} __packed; /* DEBUG_(U|L)MAC_RD_WR_RSP_API_S_VER_1 */
351
352/**
353 * struct iwl_dbg_suspend_resume_cmd - dbgc suspend resume command
354 * @operation: suspend or resume operation, uses
355 * &enum iwl_dbg_suspend_resume_cmds
356 */
357struct iwl_dbg_suspend_resume_cmd {
358 __le32 operation;
359} __packed;
360
361#define BUF_ALLOC_MAX_NUM_FRAGS 16
362
363/**
364 * struct iwl_buf_alloc_frag - a DBGC fragment
365 * @addr: base address of the fragment
366 * @size: size of the fragment
367 */
368struct iwl_buf_alloc_frag {
369 __le64 addr;
370 __le32 size;
371} __packed; /* FRAGMENT_STRUCTURE_API_S_VER_1 */
372
373/**
374 * struct iwl_buf_alloc_cmd - buffer allocation command
375 * @alloc_id: &enum iwl_fw_ini_allocation_id
376 * @buf_location: &enum iwl_fw_ini_buffer_location
377 * @num_frags: number of fragments
378 * @frags: fragments array
379 */
380struct iwl_buf_alloc_cmd {
381 __le32 alloc_id;
382 __le32 buf_location;
383 __le32 num_frags;
384 struct iwl_buf_alloc_frag frags[BUF_ALLOC_MAX_NUM_FRAGS];
385} __packed; /* BUFFER_ALLOCATION_CMD_API_S_VER_2 */
386
387#define DRAM_INFO_FIRST_MAGIC_WORD 0x76543210
388#define DRAM_INFO_SECOND_MAGIC_WORD 0x89ABCDEF
389
390/**
391 * struct iwl_dram_info - DRAM fragments allocation struct
392 *
393 * Driver will fill in the first 1K(+) of the pointed DRAM fragment
394 *
395 * @first_word: magic word value
396 * @second_word: magic word value
397 * @framfrags: DRAM fragmentaion detail
398*/
399struct iwl_dram_info {
400 __le32 first_word;
401 __le32 second_word;
402 struct iwl_buf_alloc_cmd dram_frags[IWL_FW_INI_ALLOCATION_NUM - 1];
403} __packed; /* INIT_DRAM_FRAGS_ALLOCATIONS_S_VER_1 */
404
405/**
406 * struct iwl_dbgc1_info - DBGC1 address and size
407 *
408 * Driver will fill the dbcg1 address and size at address based on config TLV.
409 *
410 * @first_word: all 0 set as identifier
411 * @dbgc1_add_lsb: LSB bits of DBGC1 physical address
412 * @dbgc1_add_msb: MSB bits of DBGC1 physical address
413 * @dbgc1_size: DBGC1 size
414*/
415struct iwl_dbgc1_info {
416 __le32 first_word;
417 __le32 dbgc1_add_lsb;
418 __le32 dbgc1_add_msb;
419 __le32 dbgc1_size;
420} __packed; /* INIT_DRAM_FRAGS_ALLOCATIONS_S_VER_1 */
421
422/**
423 * struct iwl_dbg_host_event_cfg_cmd
424 * @enabled_severities: enabled severities
425 */
426struct iwl_dbg_host_event_cfg_cmd {
427 __le32 enabled_severities;
428} __packed; /* DEBUG_HOST_EVENT_CFG_CMD_API_S_VER_1 */
429
430/**
431 * struct iwl_dbg_dump_complete_cmd - dump complete cmd
432 *
433 * @tp: timepoint whose dump has completed
434 * @tp_data: timepoint data
435 */
436struct iwl_dbg_dump_complete_cmd {
437 __le32 tp;
438 __le32 tp_data;
439} __packed; /* FW_DUMP_COMPLETE_CMD_API_S_VER_1 */
440
441#define TAS_LMAC_BAND_HB 0
442#define TAS_LMAC_BAND_LB 1
443#define TAS_LMAC_BAND_UHB 2
444#define TAS_LMAC_BAND_INVALID 3
445
446/**
447 * struct iwl_mvm_tas_status_per_mac - tas status per lmac
448 * @static_status: tas statically enabled or disabled per lmac - TRUE/FALSE
449 * @static_dis_reason: TAS static disable reason, uses
450 * &enum iwl_mvm_tas_statically_disabled_reason
451 * @dynamic_status: Current TAS status. uses
452 * &enum iwl_mvm_tas_dyna_status
453 * @near_disconnection: is TAS currently near disconnection per lmac? - TRUE/FALSE
454 * @max_reg_pwr_limit: Regulatory power limits in dBm
455 * @sar_limit: SAR limits per lmac in dBm
456 * @band: Band per lmac
457 * @reserved: reserved
458 */
459struct iwl_mvm_tas_status_per_mac {
460 u8 static_status;
461 u8 static_dis_reason;
462 u8 dynamic_status;
463 u8 near_disconnection;
464 __le16 max_reg_pwr_limit;
465 __le16 sar_limit;
466 u8 band;
467 u8 reserved[3];
468} __packed; /*DEBUG_GET_TAS_STATUS_PER_MAC_S_VER_1*/
469
470/**
471 * struct iwl_mvm_tas_status_resp - Response to GET_TAS_STATUS
472 * @tas_fw_version: TAS FW version
473 * @is_uhb_for_usa_enable: is UHB enabled in USA? - TRUE/FALSE
474 * @curr_mcc: current mcc
475 * @block_list: country block list
476 * @tas_status_mac: TAS status per lmac, uses
477 * &struct iwl_mvm_tas_status_per_mac
478 * @in_dual_radio: is TAS in dual radio? - TRUE/FALSE
479 * @reserved: reserved
480 */
481struct iwl_mvm_tas_status_resp {
482 u8 tas_fw_version;
483 u8 is_uhb_for_usa_enable;
484 __le16 curr_mcc;
485 __le16 block_list[16];
486 struct iwl_mvm_tas_status_per_mac tas_status_mac[2];
487 u8 in_dual_radio;
488 u8 reserved[3];
489} __packed; /*DEBUG_GET_TAS_STATUS_RSP_API_S_VER_3*/
490
491/**
492 * enum iwl_mvm_tas_dyna_status - TAS current running status
493 * @TAS_DYNA_INACTIVE: TAS status is inactive
494 * @TAS_DYNA_INACTIVE_MVM_MODE: TAS is disabled due because FW is in MVM mode
495 * or is in softap mode.
496 * @TAS_DYNA_INACTIVE_TRIGGER_MODE: TAS is disabled because FW is in
497 * multi user trigger mode
498 * @TAS_DYNA_INACTIVE_BLOCK_LISTED: TAS is disabled because current mcc
499 * is blocklisted mcc
500 * @TAS_DYNA_INACTIVE_UHB_NON_US: TAS is disabled because current band is UHB
501 * and current mcc is USA
502 * @TAS_DYNA_ACTIVE: TAS is currently active
503 * @TAS_DYNA_STATUS_MAX: TAS status max value
504 */
505enum iwl_mvm_tas_dyna_status {
506 TAS_DYNA_INACTIVE,
507 TAS_DYNA_INACTIVE_MVM_MODE,
508 TAS_DYNA_INACTIVE_TRIGGER_MODE,
509 TAS_DYNA_INACTIVE_BLOCK_LISTED,
510 TAS_DYNA_INACTIVE_UHB_NON_US,
511 TAS_DYNA_ACTIVE,
512
513 TAS_DYNA_STATUS_MAX,
514}; /*_TAS_DYNA_STATUS_E*/
515
516/**
517 * enum iwl_mvm_tas_statically_disabled_reason - TAS statically disabled reason
518 * @TAS_DISABLED_DUE_TO_BIOS: TAS is disabled because TAS is disabled in BIOS
519 * @TAS_DISABLED_DUE_TO_SAR_6DBM: TAS is disabled because SAR limit is less than 6 Dbm
520 * @TAS_DISABLED_REASON_INVALID: TAS disable reason is invalid
521 * @TAS_DISABLED_REASON_MAX: TAS disable reason max value
522 */
523enum iwl_mvm_tas_statically_disabled_reason {
524 TAS_DISABLED_DUE_TO_BIOS,
525 TAS_DISABLED_DUE_TO_SAR_6DBM,
526 TAS_DISABLED_REASON_INVALID,
527
528 TAS_DISABLED_REASON_MAX,
529}; /*_TAS_STATICALLY_DISABLED_REASON_E*/
530
531/**
532 * enum iwl_fw_dbg_config_cmd_type - types of FW debug config command
533 * @DEBUG_TOKEN_CONFIG_TYPE: token config type
534 */
535enum iwl_fw_dbg_config_cmd_type {
536 DEBUG_TOKEN_CONFIG_TYPE = 0x2B,
537}; /* LDBG_CFG_CMD_TYPE_API_E_VER_1 */
538
539/* this token disables debug asserts in the firmware */
540#define IWL_FW_DBG_CONFIG_TOKEN 0x00010001
541
542/**
543 * struct iwl_fw_dbg_config_cmd - configure FW debug
544 *
545 * @type: according to &enum iwl_fw_dbg_config_cmd_type
546 * @conf: FW configuration
547 */
548struct iwl_fw_dbg_config_cmd {
549 __le32 type;
550 __le32 conf;
551} __packed; /* LDBG_CFG_CMD_API_S_VER_7 */
552
553#endif /* __iwl_fw_api_debug_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) 2007 - 2014 Intel Corporation. All rights reserved.
9 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
10 * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of version 2 of the GNU General Public License as
14 * published by the Free Software Foundation.
15 *
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
20 *
21 * The full GNU General Public License is included in this distribution
22 * in the file called COPYING.
23 *
24 * Contact Information:
25 * Intel Linux Wireless <linuxwifi@intel.com>
26 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
27 *
28 * BSD LICENSE
29 *
30 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
31 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
32 * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
33 * All rights reserved.
34 *
35 * Redistribution and use in source and binary forms, with or without
36 * modification, are permitted provided that the following conditions
37 * are met:
38 *
39 * * Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * * Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in
43 * the documentation and/or other materials provided with the
44 * distribution.
45 * * Neither the name Intel Corporation nor the names of its
46 * contributors may be used to endorse or promote products derived
47 * from this software without specific prior written permission.
48 *
49 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
50 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
51 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
52 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
53 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
54 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
55 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
57 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
58 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
59 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
60 *
61 *****************************************************************************/
62#ifndef __iwl_fw_api_debug_h__
63#define __iwl_fw_api_debug_h__
64
65/**
66 * enum iwl_debug_cmds - debug commands
67 */
68enum iwl_debug_cmds {
69 /**
70 * @LMAC_RD_WR:
71 * LMAC memory read/write, using &struct iwl_dbg_mem_access_cmd and
72 * &struct iwl_dbg_mem_access_rsp
73 */
74 LMAC_RD_WR = 0x0,
75 /**
76 * @UMAC_RD_WR:
77 * UMAC memory read/write, using &struct iwl_dbg_mem_access_cmd and
78 * &struct iwl_dbg_mem_access_rsp
79 */
80 UMAC_RD_WR = 0x1,
81 /**
82 * @MFU_ASSERT_DUMP_NTF:
83 * &struct iwl_mfu_assert_dump_notif
84 */
85 MFU_ASSERT_DUMP_NTF = 0xFE,
86};
87
88/* Error response/notification */
89enum {
90 FW_ERR_UNKNOWN_CMD = 0x0,
91 FW_ERR_INVALID_CMD_PARAM = 0x1,
92 FW_ERR_SERVICE = 0x2,
93 FW_ERR_ARC_MEMORY = 0x3,
94 FW_ERR_ARC_CODE = 0x4,
95 FW_ERR_WATCH_DOG = 0x5,
96 FW_ERR_WEP_GRP_KEY_INDX = 0x10,
97 FW_ERR_WEP_KEY_SIZE = 0x11,
98 FW_ERR_OBSOLETE_FUNC = 0x12,
99 FW_ERR_UNEXPECTED = 0xFE,
100 FW_ERR_FATAL = 0xFF
101};
102
103/**
104 * struct iwl_error_resp - FW error indication
105 * ( REPLY_ERROR = 0x2 )
106 * @error_type: one of FW_ERR_*
107 * @cmd_id: the command ID for which the error occurred
108 * @reserved1: reserved
109 * @bad_cmd_seq_num: sequence number of the erroneous command
110 * @error_service: which service created the error, applicable only if
111 * error_type = 2, otherwise 0
112 * @timestamp: TSF in usecs.
113 */
114struct iwl_error_resp {
115 __le32 error_type;
116 u8 cmd_id;
117 u8 reserved1;
118 __le16 bad_cmd_seq_num;
119 __le32 error_service;
120 __le64 timestamp;
121} __packed;
122
123#define TX_FIFO_MAX_NUM_9000 8
124#define TX_FIFO_MAX_NUM 15
125#define RX_FIFO_MAX_NUM 2
126#define TX_FIFO_INTERNAL_MAX_NUM 6
127
128/**
129 * struct iwl_shared_mem_cfg_v2 - Shared memory configuration information
130 *
131 * @shared_mem_addr: shared memory addr (pre 8000 HW set to 0x0 as MARBH is not
132 * accessible)
133 * @shared_mem_size: shared memory size
134 * @sample_buff_addr: internal sample (mon/adc) buff addr (pre 8000 HW set to
135 * 0x0 as accessible only via DBGM RDAT)
136 * @sample_buff_size: internal sample buff size
137 * @txfifo_addr: start addr of TXF0 (excluding the context table 0.5KB), (pre
138 * 8000 HW set to 0x0 as not accessible)
139 * @txfifo_size: size of TXF0 ... TXF7
140 * @rxfifo_size: RXF1, RXF2 sizes. If there is no RXF2, it'll have a value of 0
141 * @page_buff_addr: used by UMAC and performance debug (page miss analysis),
142 * when paging is not supported this should be 0
143 * @page_buff_size: size of %page_buff_addr
144 * @rxfifo_addr: Start address of rxFifo
145 * @internal_txfifo_addr: start address of internalFifo
146 * @internal_txfifo_size: internal fifos' size
147 *
148 * NOTE: on firmware that don't have IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG
149 * set, the last 3 members don't exist.
150 */
151struct iwl_shared_mem_cfg_v2 {
152 __le32 shared_mem_addr;
153 __le32 shared_mem_size;
154 __le32 sample_buff_addr;
155 __le32 sample_buff_size;
156 __le32 txfifo_addr;
157 __le32 txfifo_size[TX_FIFO_MAX_NUM_9000];
158 __le32 rxfifo_size[RX_FIFO_MAX_NUM];
159 __le32 page_buff_addr;
160 __le32 page_buff_size;
161 __le32 rxfifo_addr;
162 __le32 internal_txfifo_addr;
163 __le32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM];
164} __packed; /* SHARED_MEM_ALLOC_API_S_VER_2 */
165
166/**
167 * struct iwl_shared_mem_lmac_cfg - LMAC shared memory configuration
168 *
169 * @txfifo_addr: start addr of TXF0 (excluding the context table 0.5KB)
170 * @txfifo_size: size of TX FIFOs
171 * @rxfifo1_addr: RXF1 addr
172 * @rxfifo1_size: RXF1 size
173 */
174struct iwl_shared_mem_lmac_cfg {
175 __le32 txfifo_addr;
176 __le32 txfifo_size[TX_FIFO_MAX_NUM];
177 __le32 rxfifo1_addr;
178 __le32 rxfifo1_size;
179
180} __packed; /* SHARED_MEM_ALLOC_LMAC_API_S_VER_1 */
181
182/**
183 * struct iwl_shared_mem_cfg - Shared memory configuration information
184 *
185 * @shared_mem_addr: shared memory address
186 * @shared_mem_size: shared memory size
187 * @sample_buff_addr: internal sample (mon/adc) buff addr
188 * @sample_buff_size: internal sample buff size
189 * @rxfifo2_addr: start addr of RXF2
190 * @rxfifo2_size: size of RXF2
191 * @page_buff_addr: used by UMAC and performance debug (page miss analysis),
192 * when paging is not supported this should be 0
193 * @page_buff_size: size of %page_buff_addr
194 * @lmac_num: number of LMACs (1 or 2)
195 * @lmac_smem: per - LMAC smem data
196 */
197struct iwl_shared_mem_cfg {
198 __le32 shared_mem_addr;
199 __le32 shared_mem_size;
200 __le32 sample_buff_addr;
201 __le32 sample_buff_size;
202 __le32 rxfifo2_addr;
203 __le32 rxfifo2_size;
204 __le32 page_buff_addr;
205 __le32 page_buff_size;
206 __le32 lmac_num;
207 struct iwl_shared_mem_lmac_cfg lmac_smem[2];
208} __packed; /* SHARED_MEM_ALLOC_API_S_VER_3 */
209
210/**
211 * struct iwl_mfuart_load_notif - mfuart image version & status
212 * ( MFUART_LOAD_NOTIFICATION = 0xb1 )
213 * @installed_ver: installed image version
214 * @external_ver: external image version
215 * @status: MFUART loading status
216 * @duration: MFUART loading time
217 * @image_size: MFUART image size in bytes
218*/
219struct iwl_mfuart_load_notif {
220 __le32 installed_ver;
221 __le32 external_ver;
222 __le32 status;
223 __le32 duration;
224 /* image size valid only in v2 of the command */
225 __le32 image_size;
226} __packed; /* MFU_LOADER_NTFY_API_S_VER_2 */
227
228/**
229 * struct iwl_mfu_assert_dump_notif - mfuart dump logs
230 * ( MFU_ASSERT_DUMP_NTF = 0xfe )
231 * @assert_id: mfuart assert id that cause the notif
232 * @curr_reset_num: number of asserts since uptime
233 * @index_num: current chunk id
234 * @parts_num: total number of chunks
235 * @data_size: number of data bytes sent
236 * @data: data buffer
237 */
238struct iwl_mfu_assert_dump_notif {
239 __le32 assert_id;
240 __le32 curr_reset_num;
241 __le16 index_num;
242 __le16 parts_num;
243 __le32 data_size;
244 __le32 data[0];
245} __packed; /* MFU_DUMP_ASSERT_API_S_VER_1 */
246
247/**
248 * enum iwl_mvm_marker_id - marker ids
249 *
250 * The ids for different type of markers to insert into the usniffer logs
251 *
252 * @MARKER_ID_TX_FRAME_LATENCY: TX latency marker
253 * @MARKER_ID_SYNC_CLOCK: sync FW time and systime
254 */
255enum iwl_mvm_marker_id {
256 MARKER_ID_TX_FRAME_LATENCY = 1,
257 MARKER_ID_SYNC_CLOCK = 2,
258}; /* MARKER_ID_API_E_VER_2 */
259
260/**
261 * struct iwl_mvm_marker - mark info into the usniffer logs
262 *
263 * (MARKER_CMD = 0xcb)
264 *
265 * Mark the UTC time stamp into the usniffer logs together with additional
266 * metadata, so the usniffer output can be parsed.
267 * In the command response the ucode will return the GP2 time.
268 *
269 * @dw_len: The amount of dwords following this byte including this byte.
270 * @marker_id: A unique marker id (iwl_mvm_marker_id).
271 * @reserved: reserved.
272 * @timestamp: in milliseconds since 1970-01-01 00:00:00 UTC
273 * @metadata: additional meta data that will be written to the unsiffer log
274 */
275struct iwl_mvm_marker {
276 u8 dw_len;
277 u8 marker_id;
278 __le16 reserved;
279 __le64 timestamp;
280 __le32 metadata[0];
281} __packed; /* MARKER_API_S_VER_1 */
282
283/**
284 * struct iwl_mvm_marker_rsp - Response to marker cmd
285 *
286 * @gp2: The gp2 clock value in the FW
287 */
288struct iwl_mvm_marker_rsp {
289 __le32 gp2;
290} __packed;
291
292/* Operation types for the debug mem access */
293enum {
294 DEBUG_MEM_OP_READ = 0,
295 DEBUG_MEM_OP_WRITE = 1,
296 DEBUG_MEM_OP_WRITE_BYTES = 2,
297};
298
299#define DEBUG_MEM_MAX_SIZE_DWORDS 32
300
301/**
302 * struct iwl_dbg_mem_access_cmd - Request the device to read/write memory
303 * @op: DEBUG_MEM_OP_*
304 * @addr: address to read/write from/to
305 * @len: in dwords, to read/write
306 * @data: for write opeations, contains the source buffer
307 */
308struct iwl_dbg_mem_access_cmd {
309 __le32 op;
310 __le32 addr;
311 __le32 len;
312 __le32 data[];
313} __packed; /* DEBUG_(U|L)MAC_RD_WR_CMD_API_S_VER_1 */
314
315/* Status responses for the debug mem access */
316enum {
317 DEBUG_MEM_STATUS_SUCCESS = 0x0,
318 DEBUG_MEM_STATUS_FAILED = 0x1,
319 DEBUG_MEM_STATUS_LOCKED = 0x2,
320 DEBUG_MEM_STATUS_HIDDEN = 0x3,
321 DEBUG_MEM_STATUS_LENGTH = 0x4,
322};
323
324/**
325 * struct iwl_dbg_mem_access_rsp - Response to debug mem commands
326 * @status: DEBUG_MEM_STATUS_*
327 * @len: read dwords (0 for write operations)
328 * @data: contains the read DWs
329 */
330struct iwl_dbg_mem_access_rsp {
331 __le32 status;
332 __le32 len;
333 __le32 data[];
334} __packed; /* DEBUG_(U|L)MAC_RD_WR_RSP_API_S_VER_1 */
335
336#define CONT_REC_COMMAND_SIZE 80
337#define ENABLE_CONT_RECORDING 0x15
338#define DISABLE_CONT_RECORDING 0x16
339
340/*
341 * struct iwl_continuous_record_mode - recording mode
342 */
343struct iwl_continuous_record_mode {
344 __le16 enable_recording;
345} __packed;
346
347/*
348 * struct iwl_continuous_record_cmd - enable/disable continuous recording
349 */
350struct iwl_continuous_record_cmd {
351 struct iwl_continuous_record_mode record_mode;
352 u8 pad[CONT_REC_COMMAND_SIZE -
353 sizeof(struct iwl_continuous_record_mode)];
354} __packed;
355
356#endif /* __iwl_fw_api_debug_h__ */