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 - 2012 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 - 2012 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 /*
  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.
  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  *
  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
  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
 106  *
 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
 111  *
 112  * @IWL_TM_CMD_APP2DEV_LOAD_WOWLAN_FW: load Wake On Wireless LAN uCode image
 113  * @IWL_TM_CMD_APP2DEV_GET_FW_VERSION: retrieve uCode version
 114  * @IWL_TM_CMD_APP2DEV_GET_DEVICE_ID: retrieve ID information in device
 115  * @IWL_TM_CMD_APP2DEV_GET_FW_INFO:
 116  *      retrieve information of existing loaded uCode image
 117  *
 118  * @IWL_TM_CMD_APP2DEV_INDIRECT_BUFFER_READ:
 119  * @IWL_TM_CMD_APP2DEV_INDIRECT_BUFFER_DUMP:
 120  * @IWL_TM_CMD_APP2DEV_INDIRECT_BUFFER_WRITE:
 121  *      Commands to read/write data from periphery or SRAM memory ranges.
 122  *      Fore reading, a READ command is sent from the userspace and the data
 123  *      is returned when the user calls a DUMP command.
 124  *      For writing, only a WRITE command is used.
 125  */
 126 enum iwl_tm_cmd_t {
 127         IWL_TM_CMD_APP2DEV_UCODE                = 1,
 128         IWL_TM_CMD_APP2DEV_DIRECT_REG_READ32    = 2,
 129         IWL_TM_CMD_APP2DEV_DIRECT_REG_WRITE32   = 3,
 130         IWL_TM_CMD_APP2DEV_DIRECT_REG_WRITE8    = 4,
 131         IWL_TM_CMD_APP2DEV_GET_DEVICENAME       = 5,
 132         IWL_TM_CMD_APP2DEV_LOAD_INIT_FW         = 6,
 133         IWL_TM_CMD_APP2DEV_CFG_INIT_CALIB       = 7,
 134         IWL_TM_CMD_APP2DEV_LOAD_RUNTIME_FW      = 8,
 135         IWL_TM_CMD_APP2DEV_GET_EEPROM           = 9,
 136         IWL_TM_CMD_APP2DEV_FIXRATE_REQ          = 10,
 137         IWL_TM_CMD_APP2DEV_BEGIN_TRACE          = 11,
 138         IWL_TM_CMD_APP2DEV_END_TRACE            = 12,
 139         IWL_TM_CMD_APP2DEV_READ_TRACE           = 13,
 140         IWL_TM_CMD_DEV2APP_SYNC_RSP             = 14,
 141         IWL_TM_CMD_DEV2APP_UCODE_RX_PKT         = 15,
 142         IWL_TM_CMD_DEV2APP_EEPROM_RSP           = 16,
 143         IWL_TM_CMD_APP2DEV_OWNERSHIP            = 17,
 144         RESERVED_18                             = 18,
 145         RESERVED_19                             = 19,
 146         RESERVED_20                             = 20,
 147         RESERVED_21                             = 21,
 148         IWL_TM_CMD_APP2DEV_LOAD_WOWLAN_FW       = 22,
 149         IWL_TM_CMD_APP2DEV_GET_FW_VERSION       = 23,
 150         IWL_TM_CMD_APP2DEV_GET_DEVICE_ID        = 24,
 151         IWL_TM_CMD_APP2DEV_GET_FW_INFO          = 25,
 152         IWL_TM_CMD_APP2DEV_INDIRECT_BUFFER_READ = 26,
 153         IWL_TM_CMD_APP2DEV_INDIRECT_BUFFER_DUMP = 27,
 154         IWL_TM_CMD_APP2DEV_INDIRECT_BUFFER_WRITE = 28,
 155         IWL_TM_CMD_MAX                          = 29,
 156 };
 157
 158 /*
 159  * Atrribute filed in testmode command
 160  * See enum iwl_tm_cmd_t.
 161  *
 162  * @IWL_TM_ATTR_NOT_APPLICABLE:
 163  *      The attribute is not applicable or invalid
 164  * @IWL_TM_ATTR_COMMAND:
 165  *      From user space to kernel space:
 166  *      the command either destines to ucode, driver, or register;
 167  *      From kernel space to user space:
 168  *      the command either carries synchronous response,
 169  *      or the spontaneous message multicast from the device;
 170  *
 171  * @IWL_TM_ATTR_UCODE_CMD_ID:
 172  * @IWL_TM_ATTR_UCODE_CMD_DATA:
 173  *      When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_UCODE,
 174  *      The mandatory fields are :
 175  *      IWL_TM_ATTR_UCODE_CMD_ID for recognizable command ID;
 176  *      IWL_TM_ATTR_COMMAND_FLAG for the flags of the commands;
 177  *      The optional fields are:
 178  *      IWL_TM_ATTR_UCODE_CMD_DATA for the actual command payload
 179  *      to the ucode
 180  *
 181  * @IWL_TM_ATTR_REG_OFFSET:
 182  * @IWL_TM_ATTR_REG_VALUE8:
 183  * @IWL_TM_ATTR_REG_VALUE32:
 184  *      When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_REG_XXX,
 185  *      The mandatory fields are:
 186  *      IWL_TM_ATTR_REG_OFFSET for the offset of the target register;
 187  *      IWL_TM_ATTR_REG_VALUE8 or IWL_TM_ATTR_REG_VALUE32 for value
 188  *
 189  * @IWL_TM_ATTR_SYNC_RSP:
 190  *      When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_DEV2APP_SYNC_RSP,
 191  *      The mandatory fields are:
 192  *      IWL_TM_ATTR_SYNC_RSP for the data content responding to the user
 193  *      application command
 194  *
 195  * @IWL_TM_ATTR_UCODE_RX_PKT:
 196  *      When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_DEV2APP_UCODE_RX_PKT,
 197  *      The mandatory fields are:
 198  *      IWL_TM_ATTR_UCODE_RX_PKT for the data content multicast to the user
 199  *      application
 200  *
 201  * @IWL_TM_ATTR_EEPROM:
 202  *      When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_DEV2APP_EEPROM,
 203  *      The mandatory fields are:
 204  *      IWL_TM_ATTR_EEPROM for the data content responging to the user
 205  *      application
 206  *
 207  * @IWL_TM_ATTR_TRACE_ADDR:
 208  * @IWL_TM_ATTR_TRACE_SIZE:
 209  * @IWL_TM_ATTR_TRACE_DUMP:
 210  *      When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_XXX_TRACE,
 211  *      The mandatory fields are:
 212  *      IWL_TM_ATTR_MEM_TRACE_ADDR for the trace address
 213  *      IWL_TM_ATTR_MEM_TRACE_SIZE for the trace buffer size
 214  *      IWL_TM_ATTR_MEM_TRACE_DUMP for the trace dump
 215  *
 216  * @IWL_TM_ATTR_FIXRATE:
 217  *      When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_FIXRATE_REQ,
 218  *      The mandatory fields are:
 219  *      IWL_TM_ATTR_FIXRATE for the fixed rate
 220  *
 221  * @IWL_TM_ATTR_UCODE_OWNER:
 222  *      When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_OWNERSHIP,
 223  *      The mandatory fields are:
 224  *      IWL_TM_ATTR_UCODE_OWNER for the new owner
 225  *
 226  * @IWL_TM_ATTR_MEM_ADDR:
 227  * @IWL_TM_ATTR_BUFFER_SIZE:
 228  *      When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_INDIRECT_BUFFER_READ
 229  *      or IWL_TM_CMD_APP2DEV_INDIRECT_BUFFER_WRITE.
 230  *      The mandatory fields are:
 231  *      IWL_TM_ATTR_MEM_ADDR for the address in SRAM/periphery to read/write
 232  *      IWL_TM_ATTR_BUFFER_SIZE for the buffer size of data to read/write.
 233  *
 234  * @IWL_TM_ATTR_BUFFER_DUMP:
 235  *      When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_INDIRECT_BUFFER_DUMP,
 236  *      IWL_TM_ATTR_BUFFER_DUMP is used for the data that was read.
 237  *      When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_INDIRECT_BUFFER_WRITE,
 238  *      this attribute contains the data to write.
 239  *
 240  * @IWL_TM_ATTR_FW_VERSION:
 241  *      When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_GET_FW_VERSION,
 242  *      IWL_TM_ATTR_FW_VERSION for the uCode version
 243  *
 244  * @IWL_TM_ATTR_DEVICE_ID:
 245  *      When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_GET_DEVICE_ID,
 246  *      IWL_TM_ATTR_DEVICE_ID for the device ID information
 247  *
 248  * @IWL_TM_ATTR_FW_TYPE:
 249  * @IWL_TM_ATTR_FW_INST_SIZE:
 250  * @IWL_TM_ATTR_FW_DATA_SIZE:
 251  *      When IWL_TM_ATTR_COMMAND is IWL_TM_CMD_APP2DEV_GET_FW_INFO,
 252  *      The mandatory fields are:
 253  *      IWL_TM_ATTR_FW_TYPE for the uCode type (INIT/RUNTIME/...)
 254  *      IWL_TM_ATTR_FW_INST_SIZE for the size of instruction section
 255  *      IWL_TM_ATTR_FW_DATA_SIZE for the size of data section
 256  *
 257  */
 258 enum iwl_tm_attr_t {
 259         IWL_TM_ATTR_NOT_APPLICABLE              = 0,
 260         IWL_TM_ATTR_COMMAND                     = 1,
 261         IWL_TM_ATTR_UCODE_CMD_ID                = 2,
 262         IWL_TM_ATTR_UCODE_CMD_DATA              = 3,
 263         IWL_TM_ATTR_REG_OFFSET                  = 4,
 264         IWL_TM_ATTR_REG_VALUE8                  = 5,
 265         IWL_TM_ATTR_REG_VALUE32                 = 6,
 266         IWL_TM_ATTR_SYNC_RSP                    = 7,
 267         IWL_TM_ATTR_UCODE_RX_PKT                = 8,
 268         IWL_TM_ATTR_EEPROM                      = 9,
 269         IWL_TM_ATTR_TRACE_ADDR                  = 10,
 270         IWL_TM_ATTR_TRACE_SIZE                  = 11,
 271         IWL_TM_ATTR_TRACE_DUMP                  = 12,
 272         IWL_TM_ATTR_FIXRATE                     = 13,
 273         IWL_TM_ATTR_UCODE_OWNER                 = 14,
 274         IWL_TM_ATTR_MEM_ADDR                    = 15,
 275         IWL_TM_ATTR_BUFFER_SIZE                 = 16,
 276         IWL_TM_ATTR_BUFFER_DUMP                 = 17,
 277         IWL_TM_ATTR_FW_VERSION                  = 18,
 278         IWL_TM_ATTR_DEVICE_ID                   = 19,
 279         IWL_TM_ATTR_FW_TYPE                     = 20,
 280         IWL_TM_ATTR_FW_INST_SIZE                = 21,
 281         IWL_TM_ATTR_FW_DATA_SIZE                = 22,
 282         IWL_TM_ATTR_MAX                         = 23,
 283 };
 284
 285 /* uCode trace buffer */
 286 #define TRACE_BUFF_SIZE_MAX     0x200000
 287 #define TRACE_BUFF_SIZE_MIN     0x20000
 288 #define TRACE_BUFF_SIZE_DEF     TRACE_BUFF_SIZE_MIN
 289 #define TRACE_BUFF_PADD         0x2000
 290
 291 /* Maximum data size of each dump it packet */
 292 #define DUMP_CHUNK_SIZE         (PAGE_SIZE - 1024)
 293
 294 /* Address offset of data segment in SRAM */
 295 #define SRAM_DATA_SEG_OFFSET   0x800000
 296
 297 #endif