drivers/net/wireless/iwlwifi/iwl-testmode.h

   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,
  91         IWL_TM_CMD_APP2DEV_GET_EEPROM,
  92         IWL_TM_CMD_APP2DEV_FIXRATE_REQ,
  93         /* if there is other new command for the driver layer operation,
  94          * append them here */
  95
  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,
 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,
 108
 109         /* commands from kernel space to carry the eeprom response
 110          * to user application */
 111         IWL_TM_CMD_DEV2APP_EEPROM_RSP,
 112
 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
 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
 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,
 169         IWL_TM_ATTR_TRACE_DATA,
 170
 171         /* When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_FIXRATE_REQ,
 172          * The mandatory fields are:
 173          * IWL_TM_ATTR_FIXRATE for the fixed rate
 174          */
 175         IWL_TM_ATTR_FIXRATE,
 176
 177         IWL_TM_ATTR_MAX,
 178 };
 179
 180 /* uCode trace buffer */
 181 #define TRACE_BUFF_SIZE         0x20000
 182 #define TRACE_BUFF_PADD         0x2000
 183 #define TRACE_TOTAL_SIZE        (TRACE_BUFF_SIZE + TRACE_BUFF_PADD)
 184
 185 #endif