iwlwifi: rename CONFIG_IWLWIFI_DEVICE_SVTOOL to CONFIG_IWLWIFI_DEVICE_TESTMODE
[deliverable/linux.git] / drivers / net / wireless / iwlwifi / iwl-testmode.h
CommitLineData
4613e72d
CK
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) 2010 - 2011 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 LICENSE.GPL.
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) 2010 - 2011 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 __IWL_TESTMODE_H__
64#define __IWL_TESTMODE_H__
65
66#include <linux/types.h>
67
68
4466320f
WYG
69/*
70 * Commands from user space to kernel space(IWL_TM_CMD_ID_APP2DEV_XX) and
4613e72d 71 * from and kernel space to user space(IWL_TM_CMD_ID_DEV2APP_XX).
4466320f
WYG
72 * The command ID is carried with IWL_TM_ATTR_COMMAND.
73 *
74 * @IWL_TM_CMD_APP2DEV_UCODE:
75 * commands from user application to the uCode,
76 * the actual uCode host command ID is carried with
77 * IWL_TM_ATTR_UCODE_CMD_ID
78 *
72bcacc2
HK
79 * @IWL_TM_CMD_APP2DEV_DIRECT_REG_READ32:
80 * @IWL_TM_CMD_APP2DEV_DIRECT_REG_WRITE32:
81 * @IWL_TM_CMD_APP2DEV_DIRECT_REG_WRITE8:
4466320f
WYG
82 * commands from user applicaiton to access register
83 *
84 * @IWL_TM_CMD_APP2DEV_GET_DEVICENAME: retrieve device name
85 * @IWL_TM_CMD_APP2DEV_LOAD_INIT_FW: load initial uCode image
86 * @IWL_TM_CMD_APP2DEV_CFG_INIT_CALIB: perform calibration
87 * @IWL_TM_CMD_APP2DEV_LOAD_RUNTIME_FW: load runtime uCode image
88 * @IWL_TM_CMD_APP2DEV_GET_EEPROM: request EEPROM data
89 * @IWL_TM_CMD_APP2DEV_FIXRATE_REQ: set fix MCS
90 * commands fom user space for pure driver level operations
91 *
92 * @IWL_TM_CMD_APP2DEV_BEGIN_TRACE:
93 * @IWL_TM_CMD_APP2DEV_END_TRACE:
94 * @IWL_TM_CMD_APP2DEV_READ_TRACE:
95 * commands fom user space for uCode trace operations
96 *
97 * @IWL_TM_CMD_DEV2APP_SYNC_RSP:
98 * commands from kernel space to carry the synchronous response
99 * to user application
100 * @IWL_TM_CMD_DEV2APP_UCODE_RX_PKT:
101 * commands from kernel space to multicast the spontaneous messages
102 * to user application
103 * @IWL_TM_CMD_DEV2APP_EEPROM_RSP:
104 * commands from kernel space to carry the eeprom response
105 * to user application
306713fd 106 *
e98a1939
WYG
107 * @IWL_TM_CMD_APP2DEV_OWNERSHIP:
108 * commands from user application to own change the ownership of the uCode
109 * if application has the ownership, the only host command from
110 * testmode will deliver to uCode. Default owner is driver
306713fd 111 *
72bcacc2
HK
112 * @IWL_TM_CMD_APP2DEV_INDIRECT_REG_READ32:
113 * @IWL_TM_CMD_APP2DEV_INDIRECT_REG_WRITE32:
114 * commands from user applicaiton to indirectly access peripheral register
115 *
306713fd
HK
116 * @IWL_TM_CMD_APP2DEV_READ_SRAM:
117 * @IWL_TM_CMD_APP2DEV_DUMP_SRAM:
118 * commands from user applicaiton to read data in sram
119 *
d4af19fe 120 * @IWL_TM_CMD_APP2DEV_LOAD_WOWLAN_FW: load Weak On Wireless LAN uCode image
e1a38fe1 121 * @IWL_TM_CMD_APP2DEV_GET_FW_VERSION: retrieve uCode version
d4af19fe 122 *
4613e72d
CK
123 */
124enum iwl_tm_cmd_t {
4466320f 125 IWL_TM_CMD_APP2DEV_UCODE = 1,
72bcacc2
HK
126 IWL_TM_CMD_APP2DEV_DIRECT_REG_READ32 = 2,
127 IWL_TM_CMD_APP2DEV_DIRECT_REG_WRITE32 = 3,
128 IWL_TM_CMD_APP2DEV_DIRECT_REG_WRITE8 = 4,
4466320f
WYG
129 IWL_TM_CMD_APP2DEV_GET_DEVICENAME = 5,
130 IWL_TM_CMD_APP2DEV_LOAD_INIT_FW = 6,
131 IWL_TM_CMD_APP2DEV_CFG_INIT_CALIB = 7,
132 IWL_TM_CMD_APP2DEV_LOAD_RUNTIME_FW = 8,
133 IWL_TM_CMD_APP2DEV_GET_EEPROM = 9,
134 IWL_TM_CMD_APP2DEV_FIXRATE_REQ = 10,
135 IWL_TM_CMD_APP2DEV_BEGIN_TRACE = 11,
136 IWL_TM_CMD_APP2DEV_END_TRACE = 12,
137 IWL_TM_CMD_APP2DEV_READ_TRACE = 13,
138 IWL_TM_CMD_DEV2APP_SYNC_RSP = 14,
139 IWL_TM_CMD_DEV2APP_UCODE_RX_PKT = 15,
140 IWL_TM_CMD_DEV2APP_EEPROM_RSP = 16,
e98a1939 141 IWL_TM_CMD_APP2DEV_OWNERSHIP = 17,
72bcacc2
HK
142 IWL_TM_CMD_APP2DEV_INDIRECT_REG_READ32 = 18,
143 IWL_TM_CMD_APP2DEV_INDIRECT_REG_WRITE32 = 19,
306713fd
HK
144 IWL_TM_CMD_APP2DEV_READ_SRAM = 20,
145 IWL_TM_CMD_APP2DEV_DUMP_SRAM = 21,
d4af19fe 146 IWL_TM_CMD_APP2DEV_LOAD_WOWLAN_FW = 22,
e1a38fe1
HK
147 IWL_TM_CMD_APP2DEV_GET_FW_VERSION = 23,
148 IWL_TM_CMD_MAX = 24,
4613e72d
CK
149};
150
4466320f
WYG
151/*
152 * Atrribute filed in testmode command
153 * See enum iwl_tm_cmd_t.
154 *
155 * @IWL_TM_ATTR_NOT_APPLICABLE:
156 * The attribute is not applicable or invalid
157 * @IWL_TM_ATTR_COMMAND:
158 * From user space to kernel space:
159 * the command either destines to ucode, driver, or register;
160 * From kernel space to user space:
161 * the command either carries synchronous response,
162 * or the spontaneous message multicast from the device;
163 *
164 * @IWL_TM_ATTR_UCODE_CMD_ID:
165 * @IWL_TM_ATTR_UCODE_CMD_DATA:
166 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_UCODE,
167 * The mandatory fields are :
168 * IWL_TM_ATTR_UCODE_CMD_ID for recognizable command ID;
169 * IWL_TM_ATTR_COMMAND_FLAG for the flags of the commands;
170 * The optional fields are:
171 * IWL_TM_ATTR_UCODE_CMD_DATA for the actual command payload
172 * to the ucode
173 *
174 * @IWL_TM_ATTR_REG_OFFSET:
175 * @IWL_TM_ATTR_REG_VALUE8:
176 * @IWL_TM_ATTR_REG_VALUE32:
177 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_REG_XXX,
178 * The mandatory fields are:
179 * IWL_TM_ATTR_REG_OFFSET for the offset of the target register;
180 * IWL_TM_ATTR_REG_VALUE8 or IWL_TM_ATTR_REG_VALUE32 for value
181 *
182 * @IWL_TM_ATTR_SYNC_RSP:
183 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_DEV2APP_SYNC_RSP,
184 * The mandatory fields are:
185 * IWL_TM_ATTR_SYNC_RSP for the data content responding to the user
186 * application command
187 *
188 * @IWL_TM_ATTR_UCODE_RX_PKT:
189 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_DEV2APP_UCODE_RX_PKT,
190 * The mandatory fields are:
191 * IWL_TM_ATTR_UCODE_RX_PKT for the data content multicast to the user
192 * application
193 *
194 * @IWL_TM_ATTR_EEPROM:
195 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_DEV2APP_EEPROM,
196 * The mandatory fields are:
197 * IWL_TM_ATTR_EEPROM for the data content responging to the user
198 * application
199 *
200 * @IWL_TM_ATTR_TRACE_ADDR:
201 * @IWL_TM_ATTR_TRACE_SIZE:
202 * @IWL_TM_ATTR_TRACE_DUMP:
203 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_XXX_TRACE,
204 * The mandatory fields are:
205 * IWL_TM_ATTR_MEM_TRACE_ADDR for the trace address
206 * IWL_TM_ATTR_MEM_TRACE_SIZE for the trace buffer size
207 * IWL_TM_ATTR_MEM_TRACE_DUMP for the trace dump
208 *
209 * @IWL_TM_ATTR_FIXRATE:
210 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_FIXRATE_REQ,
211 * The mandatory fields are:
212 * IWL_TM_ATTR_FIXRATE for the fixed rate
213 *
e98a1939
WYG
214 * @IWL_TM_ATTR_UCODE_OWNER:
215 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_OWNERSHIP,
216 * The mandatory fields are:
217 * IWL_TM_ATTR_UCODE_OWNER for the new owner
306713fd
HK
218 *
219 * @IWL_TM_ATTR_SRAM_ADDR:
220 * @IWL_TM_ATTR_SRAM_SIZE:
221 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_READ_SRAM,
222 * The mandatory fields are:
223 * IWL_TM_ATTR_SRAM_ADDR for the address in sram
224 * IWL_TM_ATTR_SRAM_SIZE for the buffer size of data reading
225 *
226 * @IWL_TM_ATTR_SRAM_DUMP:
227 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_DUMP_SRAM,
228 * IWL_TM_ATTR_SRAM_DUMP for the data in sram
229 *
e1a38fe1
HK
230 * @IWL_TM_ATTR_FW_VERSION:
231 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_GET_FW_VERSION,
232 * IWL_TM_ATTR_FW_VERSION for the uCode version
233 *
4466320f 234 */
4613e72d 235enum iwl_tm_attr_t {
4466320f
WYG
236 IWL_TM_ATTR_NOT_APPLICABLE = 0,
237 IWL_TM_ATTR_COMMAND = 1,
238 IWL_TM_ATTR_UCODE_CMD_ID = 2,
239 IWL_TM_ATTR_UCODE_CMD_DATA = 3,
240 IWL_TM_ATTR_REG_OFFSET = 4,
241 IWL_TM_ATTR_REG_VALUE8 = 5,
242 IWL_TM_ATTR_REG_VALUE32 = 6,
243 IWL_TM_ATTR_SYNC_RSP = 7,
244 IWL_TM_ATTR_UCODE_RX_PKT = 8,
245 IWL_TM_ATTR_EEPROM = 9,
246 IWL_TM_ATTR_TRACE_ADDR = 10,
247 IWL_TM_ATTR_TRACE_SIZE = 11,
248 IWL_TM_ATTR_TRACE_DUMP = 12,
249 IWL_TM_ATTR_FIXRATE = 13,
e98a1939 250 IWL_TM_ATTR_UCODE_OWNER = 14,
306713fd
HK
251 IWL_TM_ATTR_SRAM_ADDR = 15,
252 IWL_TM_ATTR_SRAM_SIZE = 16,
253 IWL_TM_ATTR_SRAM_DUMP = 17,
e1a38fe1
HK
254 IWL_TM_ATTR_FW_VERSION = 18,
255 IWL_TM_ATTR_MAX = 19,
4613e72d
CK
256};
257
7a4e5281 258/* uCode trace buffer */
49b72100
WYG
259#define TRACE_BUFF_SIZE_MAX 0x200000
260#define TRACE_BUFF_SIZE_MIN 0x20000
261#define TRACE_BUFF_SIZE_DEF TRACE_BUFF_SIZE_MIN
7a4e5281 262#define TRACE_BUFF_PADD 0x2000
e056a653
HK
263
264/* Maximum data size of each dump it packet */
265#define DUMP_CHUNK_SIZE (PAGE_SIZE - 1024)
4613e72d
CK
266
267#endif
This page took 0.096345 seconds and 5 git commands to generate.