1 /******************************************************************************
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.
8 * Copyright(c) 2010 - 2011 Intel Corporation. All rights reserved.
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.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2010 - 2011 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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.
62 *****************************************************************************/
63 #ifndef __IWL_TESTMODE_H__
64 #define __IWL_TESTMODE_H__
66 #include <linux/types.h>
70 * Commands from user space to kernel space(IWL_TM_CMD_ID_APP2DEV_XX) and
71 * from and kernel space to user space(IWL_TM_CMD_ID_DEV2APP_XX).
72 * The command ID is carried with IWL_TM_ATTR_COMMAND.
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
79 * @IWL_TM_CMD_APP2DEV_DIRECT_REG_READ32:
80 * @IWL_TM_CMD_APP2DEV_DIRECT_REG_WRITE32:
81 * @IWL_TM_CMD_APP2DEV_DIRECT_REG_WRITE8:
82 * commands from user applicaiton to access register
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
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
97 * @IWL_TM_CMD_DEV2APP_SYNC_RSP:
98 * commands from kernel space to carry the synchronous response
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
106 * @IWL_TM_CMD_APP2DEV_OWNERSHIP:
107 * commands from user application to own change the ownership of the uCode
108 * if application has the ownership, the only host command from
109 * testmode will deliver to uCode. Default owner is driver
110 * @IWL_TM_CMD_APP2DEV_INDIRECT_REG_READ32:
111 * @IWL_TM_CMD_APP2DEV_INDIRECT_REG_WRITE32:
112 * commands from user applicaiton to indirectly access peripheral register
116 IWL_TM_CMD_APP2DEV_UCODE = 1,
117 IWL_TM_CMD_APP2DEV_DIRECT_REG_READ32 = 2,
118 IWL_TM_CMD_APP2DEV_DIRECT_REG_WRITE32 = 3,
119 IWL_TM_CMD_APP2DEV_DIRECT_REG_WRITE8 = 4,
120 IWL_TM_CMD_APP2DEV_GET_DEVICENAME = 5,
121 IWL_TM_CMD_APP2DEV_LOAD_INIT_FW = 6,
122 IWL_TM_CMD_APP2DEV_CFG_INIT_CALIB = 7,
123 IWL_TM_CMD_APP2DEV_LOAD_RUNTIME_FW = 8,
124 IWL_TM_CMD_APP2DEV_GET_EEPROM = 9,
125 IWL_TM_CMD_APP2DEV_FIXRATE_REQ = 10,
126 IWL_TM_CMD_APP2DEV_BEGIN_TRACE = 11,
127 IWL_TM_CMD_APP2DEV_END_TRACE = 12,
128 IWL_TM_CMD_APP2DEV_READ_TRACE = 13,
129 IWL_TM_CMD_DEV2APP_SYNC_RSP = 14,
130 IWL_TM_CMD_DEV2APP_UCODE_RX_PKT = 15,
131 IWL_TM_CMD_DEV2APP_EEPROM_RSP = 16,
132 IWL_TM_CMD_APP2DEV_OWNERSHIP = 17,
133 IWL_TM_CMD_APP2DEV_INDIRECT_REG_READ32 = 18,
134 IWL_TM_CMD_APP2DEV_INDIRECT_REG_WRITE32 = 19,
139 * Atrribute filed in testmode command
140 * See enum iwl_tm_cmd_t.
142 * @IWL_TM_ATTR_NOT_APPLICABLE:
143 * The attribute is not applicable or invalid
144 * @IWL_TM_ATTR_COMMAND:
145 * From user space to kernel space:
146 * the command either destines to ucode, driver, or register;
147 * From kernel space to user space:
148 * the command either carries synchronous response,
149 * or the spontaneous message multicast from the device;
151 * @IWL_TM_ATTR_UCODE_CMD_ID:
152 * @IWL_TM_ATTR_UCODE_CMD_DATA:
153 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_UCODE,
154 * The mandatory fields are :
155 * IWL_TM_ATTR_UCODE_CMD_ID for recognizable command ID;
156 * IWL_TM_ATTR_COMMAND_FLAG for the flags of the commands;
157 * The optional fields are:
158 * IWL_TM_ATTR_UCODE_CMD_DATA for the actual command payload
161 * @IWL_TM_ATTR_REG_OFFSET:
162 * @IWL_TM_ATTR_REG_VALUE8:
163 * @IWL_TM_ATTR_REG_VALUE32:
164 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_REG_XXX,
165 * The mandatory fields are:
166 * IWL_TM_ATTR_REG_OFFSET for the offset of the target register;
167 * IWL_TM_ATTR_REG_VALUE8 or IWL_TM_ATTR_REG_VALUE32 for value
169 * @IWL_TM_ATTR_SYNC_RSP:
170 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_DEV2APP_SYNC_RSP,
171 * The mandatory fields are:
172 * IWL_TM_ATTR_SYNC_RSP for the data content responding to the user
173 * application command
175 * @IWL_TM_ATTR_UCODE_RX_PKT:
176 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_DEV2APP_UCODE_RX_PKT,
177 * The mandatory fields are:
178 * IWL_TM_ATTR_UCODE_RX_PKT for the data content multicast to the user
181 * @IWL_TM_ATTR_EEPROM:
182 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_DEV2APP_EEPROM,
183 * The mandatory fields are:
184 * IWL_TM_ATTR_EEPROM for the data content responging to the user
187 * @IWL_TM_ATTR_TRACE_ADDR:
188 * @IWL_TM_ATTR_TRACE_SIZE:
189 * @IWL_TM_ATTR_TRACE_DUMP:
190 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_XXX_TRACE,
191 * The mandatory fields are:
192 * IWL_TM_ATTR_MEM_TRACE_ADDR for the trace address
193 * IWL_TM_ATTR_MEM_TRACE_SIZE for the trace buffer size
194 * IWL_TM_ATTR_MEM_TRACE_DUMP for the trace dump
196 * @IWL_TM_ATTR_FIXRATE:
197 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_FIXRATE_REQ,
198 * The mandatory fields are:
199 * IWL_TM_ATTR_FIXRATE for the fixed rate
201 * @IWL_TM_ATTR_UCODE_OWNER:
202 * When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_OWNERSHIP,
203 * The mandatory fields are:
204 * IWL_TM_ATTR_UCODE_OWNER for the new owner
207 IWL_TM_ATTR_NOT_APPLICABLE = 0,
208 IWL_TM_ATTR_COMMAND = 1,
209 IWL_TM_ATTR_UCODE_CMD_ID = 2,
210 IWL_TM_ATTR_UCODE_CMD_DATA = 3,
211 IWL_TM_ATTR_REG_OFFSET = 4,
212 IWL_TM_ATTR_REG_VALUE8 = 5,
213 IWL_TM_ATTR_REG_VALUE32 = 6,
214 IWL_TM_ATTR_SYNC_RSP = 7,
215 IWL_TM_ATTR_UCODE_RX_PKT = 8,
216 IWL_TM_ATTR_EEPROM = 9,
217 IWL_TM_ATTR_TRACE_ADDR = 10,
218 IWL_TM_ATTR_TRACE_SIZE = 11,
219 IWL_TM_ATTR_TRACE_DUMP = 12,
220 IWL_TM_ATTR_FIXRATE = 13,
221 IWL_TM_ATTR_UCODE_OWNER = 14,
222 IWL_TM_ATTR_MAX = 15,
225 /* uCode trace buffer */
226 #define TRACE_BUFF_SIZE_MAX 0x200000
227 #define TRACE_BUFF_SIZE_MIN 0x20000
228 #define TRACE_BUFF_SIZE_DEF TRACE_BUFF_SIZE_MIN
229 #define TRACE_BUFF_PADD 0x2000
230 #define TRACE_CHUNK_SIZE (PAGE_SIZE - 1024)