[deliverable/linux.git] / drivers / net / wireless / iwlwifi / iwl-testmode.h

/******************************************************************************
 *
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
 * Copyright(c) 2010 - 2011 Intel Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
 * USA
 *
 * The full GNU General Public License is included in this distribution
 * in the file called LICENSE.GPL.
 *
 * Contact Information:
 *  Intel Linux Wireless <ilw@linux.intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 * BSD LICENSE
 *
 * Copyright(c) 2010 - 2011 Intel Corporation. All rights reserved.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name Intel Corporation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
#ifndef __IWL_TESTMODE_H__
#define __IWL_TESTMODE_H__

#include <linux/types.h>


/* Commands from user space to kernel space(IWL_TM_CMD_ID_APP2DEV_XX) and
 * from and kernel space to user space(IWL_TM_CMD_ID_DEV2APP_XX).
 * The command ID is carried with IWL_TM_ATTR_COMMAND. There are three types of
 * of command from user space and two types of command from kernel space.
 * See below.
 */
enum iwl_tm_cmd_t {
	/* commands from user application to the uCode,
	 * the actual uCode host command ID is carried with
	 * IWL_TM_ATTR_UCODE_CMD_ID */
	IWL_TM_CMD_APP2DEV_UCODE = 1,

	/* commands from user applicaiton to access register */
	IWL_TM_CMD_APP2DEV_REG_READ32,
	IWL_TM_CMD_APP2DEV_REG_WRITE32,
	IWL_TM_CMD_APP2DEV_REG_WRITE8,

	/* commands fom user space for pure driver level operations */
	IWL_TM_CMD_APP2DEV_GET_DEVICENAME,
	IWL_TM_CMD_APP2DEV_LOAD_INIT_FW,
	IWL_TM_CMD_APP2DEV_CFG_INIT_CALIB,
	IWL_TM_CMD_APP2DEV_LOAD_RUNTIME_FW,
	IWL_TM_CMD_APP2DEV_GET_EEPROM,
	IWL_TM_CMD_APP2DEV_FIXRATE_REQ,
	/* if there is other new command for the driver layer operation,
	 * append them here */

	/* commands fom user space for uCode trace operations */
	IWL_TM_CMD_APP2DEV_BEGIN_TRACE,
	IWL_TM_CMD_APP2DEV_END_TRACE,
	IWL_TM_CMD_APP2DEV_READ_TRACE,

	/* commands from kernel space to carry the synchronous response
	 * to user application */
	IWL_TM_CMD_DEV2APP_SYNC_RSP,

	/* commands from kernel space to multicast the spontaneous messages
	 * to user application */
	IWL_TM_CMD_DEV2APP_UCODE_RX_PKT,

	/* commands from kernel space to carry the eeprom response
	 * to user application */
	IWL_TM_CMD_DEV2APP_EEPROM_RSP,

	IWL_TM_CMD_MAX,
};

enum iwl_tm_attr_t {
	IWL_TM_ATTR_NOT_APPLICABLE = 0,

	/* From user space to kernel space:
	 * the command either destines to ucode, driver, or register;
	 * See enum iwl_tm_cmd_t.
	 *
	 * From kernel space to user space:
	 * the command either carries synchronous response,
	 * or the spontaneous message multicast from the device;
	 * See enum iwl_tm_cmd_t. */
	IWL_TM_ATTR_COMMAND,

	/* When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_UCODE,
	 * The mandatory fields are :
	 * IWL_TM_ATTR_UCODE_CMD_ID for recognizable command ID;
	 * IWL_TM_ATTR_COMMAND_FLAG for the flags of the commands;
	 * The optional fields are:
	 * IWL_TM_ATTR_UCODE_CMD_DATA for the actual command payload
	 * to the ucode */
	IWL_TM_ATTR_UCODE_CMD_ID,
	IWL_TM_ATTR_UCODE_CMD_DATA,

	/* When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_REG_XXX,
	 * The mandatory fields are:
	 * IWL_TM_ATTR_REG_OFFSET for the offset of the target register;
	 * IWL_TM_ATTR_REG_VALUE8 or IWL_TM_ATTR_REG_VALUE32 for value */
	IWL_TM_ATTR_REG_OFFSET,
	IWL_TM_ATTR_REG_VALUE8,
	IWL_TM_ATTR_REG_VALUE32,

	/* When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_DEV2APP_SYNC_RSP,
	 * The mandatory fields are:
	 * IWL_TM_ATTR_SYNC_RSP for the data content responding to the user
	 * application command */
	IWL_TM_ATTR_SYNC_RSP,
	/* When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_DEV2APP_UCODE_RX_PKT,
	 * The mandatory fields are:
	 * IWL_TM_ATTR_UCODE_RX_PKT for the data content multicast to the user
	 * application */
	IWL_TM_ATTR_UCODE_RX_PKT,

	/* When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_DEV2APP_EEPROM,
	 * The mandatory fields are:
	 * IWL_TM_ATTR_EEPROM for the data content responging to the user
	 * application */
	IWL_TM_ATTR_EEPROM,

	/* When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_XXX_TRACE,
	 * The mandatory fields are:
	 * IWL_TM_ATTR_MEM_TRACE_ADDR for the trace address
	 */
	IWL_TM_ATTR_TRACE_ADDR,
	IWL_TM_ATTR_TRACE_SIZE,
	IWL_TM_ATTR_TRACE_DUMP,

	/* When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_FIXRATE_REQ,
	 * The mandatory fields are:
	 * IWL_TM_ATTR_FIXRATE for the fixed rate
	 */
	IWL_TM_ATTR_FIXRATE,

	IWL_TM_ATTR_MAX,
};

/* uCode trace buffer */
#define TRACE_BUFF_SIZE_MAX	0x200000
#define TRACE_BUFF_SIZE_MIN	0x20000
#define TRACE_BUFF_SIZE_DEF	TRACE_BUFF_SIZE_MIN
#define TRACE_BUFF_PADD		0x2000
#define TRACE_CHUNK_SIZE	(PAGE_SIZE - 1024)

#endif
Commit	Line	Data
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
69	/* Commands from user space to kernel space(IWL_TM_CMD_ID_APP2DEV_XX) and
70	* from and kernel space to user space(IWL_TM_CMD_ID_DEV2APP_XX).
71	* The command ID is carried with IWL_TM_ATTR_COMMAND. There are three types of
72	* of command from user space and two types of command from kernel space.
73	* See below.
74	*/
75	enum iwl_tm_cmd_t {
76	/* commands from user application to the uCode,
77	* the actual uCode host command ID is carried with
78	* IWL_TM_ATTR_UCODE_CMD_ID */
79	IWL_TM_CMD_APP2DEV_UCODE = 1,
80
81	/* commands from user applicaiton to access register */
82	IWL_TM_CMD_APP2DEV_REG_READ32,
83	IWL_TM_CMD_APP2DEV_REG_WRITE32,
84	IWL_TM_CMD_APP2DEV_REG_WRITE8,
85
86	/* commands fom user space for pure driver level operations */
87	IWL_TM_CMD_APP2DEV_GET_DEVICENAME,
88	IWL_TM_CMD_APP2DEV_LOAD_INIT_FW,
89	IWL_TM_CMD_APP2DEV_CFG_INIT_CALIB,
90	IWL_TM_CMD_APP2DEV_LOAD_RUNTIME_FW,
4babc358	91	IWL_TM_CMD_APP2DEV_GET_EEPROM,
6489854b	92	IWL_TM_CMD_APP2DEV_FIXRATE_REQ,
4613e72d CK	93	/* if there is other new command for the driver layer operation,
	94	* append them here */
	95
7a4e5281 WYG	96	/* commands fom user space for uCode trace operations */
	97	IWL_TM_CMD_APP2DEV_BEGIN_TRACE,
	98	IWL_TM_CMD_APP2DEV_END_TRACE,
	99	IWL_TM_CMD_APP2DEV_READ_TRACE,
4613e72d CK	100
	101	/* commands from kernel space to carry the synchronous response
	102	* to user application */
	103	IWL_TM_CMD_DEV2APP_SYNC_RSP,
	104
	105	/* commands from kernel space to multicast the spontaneous messages
	106	* to user application */
	107	IWL_TM_CMD_DEV2APP_UCODE_RX_PKT,
4babc358 WYG	108
	109	/* commands from kernel space to carry the eeprom response
	110	* to user application */
	111	IWL_TM_CMD_DEV2APP_EEPROM_RSP,
	112
4613e72d CK	113	IWL_TM_CMD_MAX,
	114	};
	115
	116	enum iwl_tm_attr_t {
	117	IWL_TM_ATTR_NOT_APPLICABLE = 0,
	118
	119	/* From user space to kernel space:
	120	* the command either destines to ucode, driver, or register;
	121	* See enum iwl_tm_cmd_t.
	122	*
	123	* From kernel space to user space:
	124	* the command either carries synchronous response,
	125	* or the spontaneous message multicast from the device;
	126	* See enum iwl_tm_cmd_t. */
	127	IWL_TM_ATTR_COMMAND,
	128
	129	/* When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_UCODE,
	130	* The mandatory fields are :
	131	* IWL_TM_ATTR_UCODE_CMD_ID for recognizable command ID;
	132	* IWL_TM_ATTR_COMMAND_FLAG for the flags of the commands;
	133	* The optional fields are:
	134	* IWL_TM_ATTR_UCODE_CMD_DATA for the actual command payload
	135	* to the ucode */
	136	IWL_TM_ATTR_UCODE_CMD_ID,
	137	IWL_TM_ATTR_UCODE_CMD_DATA,
	138
	139	/* When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_REG_XXX,
	140	* The mandatory fields are:
	141	* IWL_TM_ATTR_REG_OFFSET for the offset of the target register;
	142	* IWL_TM_ATTR_REG_VALUE8 or IWL_TM_ATTR_REG_VALUE32 for value */
	143	IWL_TM_ATTR_REG_OFFSET,
	144	IWL_TM_ATTR_REG_VALUE8,
	145	IWL_TM_ATTR_REG_VALUE32,
	146
	147	/* When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_DEV2APP_SYNC_RSP,
	148	* The mandatory fields are:
	149	* IWL_TM_ATTR_SYNC_RSP for the data content responding to the user
	150	* application command */
	151	IWL_TM_ATTR_SYNC_RSP,
	152	/* When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_DEV2APP_UCODE_RX_PKT,
	153	* The mandatory fields are:
	154	* IWL_TM_ATTR_UCODE_RX_PKT for the data content multicast to the user
	155	* application */
	156	IWL_TM_ATTR_UCODE_RX_PKT,
	157
4babc358 WYG	158	/* When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_DEV2APP_EEPROM,
	159	* The mandatory fields are:
	160	* IWL_TM_ATTR_EEPROM for the data content responging to the user
	161	* application */
	162	IWL_TM_ATTR_EEPROM,
	163
7a4e5281 WYG	164	/* When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_XXX_TRACE,
	165	* The mandatory fields are:
	166	* IWL_TM_ATTR_MEM_TRACE_ADDR for the trace address
	167	*/
	168	IWL_TM_ATTR_TRACE_ADDR,
49b72100	169	IWL_TM_ATTR_TRACE_SIZE,
eb64dca0	170	IWL_TM_ATTR_TRACE_DUMP,
7a4e5281	171
6489854b WYG	172	/* When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_FIXRATE_REQ,
	173	* The mandatory fields are:
	174	* IWL_TM_ATTR_FIXRATE for the fixed rate
	175	*/
	176	IWL_TM_ATTR_FIXRATE,
	177
4613e72d CK	178	IWL_TM_ATTR_MAX,
	179	};
	180
7a4e5281	181	/* uCode trace buffer */
49b72100 WYG	182	#define TRACE_BUFF_SIZE_MAX 0x200000
	183	#define TRACE_BUFF_SIZE_MIN 0x20000
	184	#define TRACE_BUFF_SIZE_DEF TRACE_BUFF_SIZE_MIN
7a4e5281	185	#define TRACE_BUFF_PADD 0x2000
eb64dca0	186	#define TRACE_CHUNK_SIZE (PAGE_SIZE - 1024)
4613e72d CK	187
4613e72d CK	188	#endif