Commit | Line | Data |
---|---|---|
1bd3cbc1 EG |
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) 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) 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 | #ifndef __fw_error_dump_h__ | |
64 | #define __fw_error_dump_h__ | |
65 | ||
66 | #include <linux/types.h> | |
67 | ||
68 | #define IWL_FW_ERROR_DUMP_BARKER 0x14789632 | |
69 | ||
70 | /** | |
71 | * enum iwl_fw_error_dump_type - types of data in the dump file | |
72 | * @IWL_FW_ERROR_DUMP_SRAM: | |
473ad712 | 73 | * @IWL_FW_ERROR_DUMP_CSR: Control Status Registers - from offset 0 |
7b445f35 | 74 | * @IWL_FW_ERROR_DUMP_RXF: |
4d075007 JB |
75 | * @IWL_FW_ERROR_DUMP_TXCMD: last TX command data, structured as |
76 | * &struct iwl_fw_error_dump_txcmd packets | |
06ddbf5a EG |
77 | * @IWL_FW_ERROR_DUMP_DEV_FW_INFO: struct %iwl_fw_error_dump_info |
78 | * info on the device / firmware. | |
c2d20201 | 79 | * @IWL_FW_ERROR_DUMP_FW_MONITOR: firmware monitor |
67c65f2c EG |
80 | * @IWL_FW_ERROR_DUMP_PRPH: range of periphery registers - there can be several |
81 | * sections like this in a single file. | |
1bd3cbc1 EG |
82 | */ |
83 | enum iwl_fw_error_dump_type { | |
84 | IWL_FW_ERROR_DUMP_SRAM = 0, | |
473ad712 | 85 | IWL_FW_ERROR_DUMP_CSR = 1, |
7b445f35 | 86 | IWL_FW_ERROR_DUMP_RXF = 2, |
4d075007 | 87 | IWL_FW_ERROR_DUMP_TXCMD = 3, |
06ddbf5a | 88 | IWL_FW_ERROR_DUMP_DEV_FW_INFO = 4, |
c2d20201 | 89 | IWL_FW_ERROR_DUMP_FW_MONITOR = 5, |
67c65f2c | 90 | IWL_FW_ERROR_DUMP_PRPH = 6, |
1bd3cbc1 EG |
91 | |
92 | IWL_FW_ERROR_DUMP_MAX, | |
93 | }; | |
94 | ||
95 | /** | |
96 | * struct iwl_fw_error_dump_data - data for one type | |
97 | * @type: %enum iwl_fw_error_dump_type | |
d4849277 EG |
98 | * @len: the length starting from %data |
99 | * @data: the data itself | |
1bd3cbc1 EG |
100 | */ |
101 | struct iwl_fw_error_dump_data { | |
102 | __le32 type; | |
103 | __le32 len; | |
104 | __u8 data[]; | |
7b445f35 | 105 | } __packed; |
1bd3cbc1 EG |
106 | |
107 | /** | |
108 | * struct iwl_fw_error_dump_file - the layout of the header of the file | |
109 | * @barker: must be %IWL_FW_ERROR_DUMP_BARKER | |
110 | * @file_len: the length of all the file starting from %barker | |
111 | * @data: array of %struct iwl_fw_error_dump_data | |
112 | */ | |
113 | struct iwl_fw_error_dump_file { | |
114 | __le32 barker; | |
115 | __le32 file_len; | |
116 | u8 data[0]; | |
7b445f35 | 117 | } __packed; |
1bd3cbc1 | 118 | |
4d075007 JB |
119 | /** |
120 | * struct iwl_fw_error_dump_txcmd - TX command data | |
121 | * @cmdlen: original length of command | |
122 | * @caplen: captured length of command (may be less) | |
123 | * @data: captured command data, @caplen bytes | |
124 | */ | |
125 | struct iwl_fw_error_dump_txcmd { | |
126 | __le32 cmdlen; | |
127 | __le32 caplen; | |
128 | u8 data[]; | |
129 | } __packed; | |
130 | ||
06ddbf5a EG |
131 | enum iwl_fw_error_dump_family { |
132 | IWL_FW_ERROR_DUMP_FAMILY_7 = 7, | |
133 | IWL_FW_ERROR_DUMP_FAMILY_8 = 8, | |
134 | }; | |
135 | ||
136 | /** | |
137 | * struct iwl_fw_error_dump_info - info on the device / firmware | |
138 | * @device_family: the family of the device (7 / 8) | |
139 | * @hw_step: the step of the device | |
140 | * @fw_human_readable: human readable FW version | |
141 | * @dev_human_readable: name of the device | |
142 | * @bus_human_readable: name of the bus used | |
143 | */ | |
144 | struct iwl_fw_error_dump_info { | |
145 | __le32 device_family; | |
146 | __le32 hw_step; | |
147 | u8 fw_human_readable[FW_VER_HUMAN_READABLE_SZ]; | |
148 | u8 dev_human_readable[64]; | |
149 | u8 bus_human_readable[8]; | |
150 | } __packed; | |
151 | ||
c2d20201 | 152 | /** |
c544e9c4 | 153 | * struct iwl_fw_error_dump_fw_mon - FW monitor data |
c2d20201 EG |
154 | * @fw_mon_wr_ptr: the position of the write pointer in the cyclic buffer |
155 | * @fw_mon_base_ptr: base pointer of the data | |
156 | * @fw_mon_cycle_cnt: number of wrap arounds | |
157 | * @reserved: for future use | |
158 | * @data: captured data | |
159 | */ | |
c544e9c4 | 160 | struct iwl_fw_error_dump_fw_mon { |
c2d20201 EG |
161 | __le32 fw_mon_wr_ptr; |
162 | __le32 fw_mon_base_ptr; | |
163 | __le32 fw_mon_cycle_cnt; | |
164 | __le32 reserved[3]; | |
165 | u8 data[]; | |
166 | } __packed; | |
167 | ||
67c65f2c EG |
168 | /** |
169 | * struct iwl_fw_error_dump_prph - periphery registers data | |
170 | * @prph_start: address of the first register in this chunk | |
171 | * @data: the content of the registers | |
172 | */ | |
173 | struct iwl_fw_error_dump_prph { | |
174 | __le32 prph_start; | |
175 | __le32 data[]; | |
176 | }; | |
177 | ||
4d075007 | 178 | /** |
1fa16056 | 179 | * iwl_fw_error_next_data - advance fw error dump data pointer |
4d075007 JB |
180 | * @data: previous data block |
181 | * Returns: next data block | |
182 | */ | |
183 | static inline struct iwl_fw_error_dump_data * | |
1fa16056 | 184 | iwl_fw_error_next_data(struct iwl_fw_error_dump_data *data) |
4d075007 JB |
185 | { |
186 | return (void *)(data->data + le32_to_cpu(data->len)); | |
187 | } | |
188 | ||
1bd3cbc1 | 189 | #endif /* __fw_error_dump_h__ */ |