linux/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,
	/* if there is other new command for the driver layer operation,
	 * append them here */


	/* 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,
	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,

	IWL_TM_ATTR_MAX,
};


#endif