include/shared/fwcmd.h

   1 /*
   2  * Atheros AR9170 driver
   3  *
   4  * firmware command interface definitions
   5  *
   6  * Copyright 2008, Johannes Berg <johannes@sipsolutions.net>
   7  * Copyright 2009, 2010, Christian Lamparter <chunkeey@googlemail.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; see the file COPYING.  If not, see
  20  * http://www.gnu.org/licenses/.
  21  *
  22  * This file incorporates work covered by the following copyright and
  23  * permission notice:
  24  *    Copyright (c) 2007-2008 Atheros Communications, Inc.
  25  *
  26  *    Permission to use, copy, modify, and/or distribute this software for any
  27  *    purpose with or without fee is hereby granted, provided that the above
  28  *    copyright notice and this permission notice appear in all copies.
  29  *
  30  *    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  31  *    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  32  *    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  33  *    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  34  *    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  35  *    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  36  *    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  37  */
  38
  39 #ifndef __CARL9170_SHARED_FWCMD_H
  40 #define __CARL9170_SHARED_FWCMD_H
  41
  42 #define CARL9170_MAX_CMD_LEN            64
  43 #define CARL9170_MAX_CMD_PAYLOAD_LEN    60
  44
  45 #define CARL9170FW_API_MIN_VER          1
  46 #define CARL9170FW_API_MAX_VER          1
  47
  48 enum carl9170_cmd_oids {
  49         CARL9170_CMD_RREG               = 0x00,
  50         CARL9170_CMD_WREG               = 0x01,
  51         CARL9170_CMD_ECHO               = 0x02,
  52         CARL9170_CMD_SWRST              = 0x03,
  53         CARL9170_CMD_REBOOT             = 0x04,
  54         CARL9170_CMD_FLUSH_CAB          = 0x05,
  55         CARL9170_CMD_READ_TSF           = 0x06,
  56
  57         /* CAM */
  58         CARL9170_CMD_EKEY               = 0x10,
  59         CARL9170_CMD_DKEY               = 0x11,
  60
  61         /* RF / PHY */
  62         CARL9170_CMD_FREQUENCY          = 0x20,
  63         CARL9170_CMD_RF_INIT            = 0x21,
  64         CARL9170_CMD_SYNTH              = 0x22,
  65         CARL9170_CMD_FREQ_START         = 0x23,
  66         CARL9170_CMD_PSM                = 0x24,
  67
  68         /* Asychronous command flag */
  69         CARL9170_CMD_ASYNC_FLAG         = 0x40,
  70         CARL9170_CMD_WREG_ASYNC         = (CARL9170_CMD_WREG |
  71                                            CARL9170_CMD_ASYNC_FLAG),
  72         CARL9170_CMD_REBOOT_ASYNC       = (CARL9170_CMD_REBOOT |
  73                                            CARL9170_CMD_ASYNC_FLAG),
  74         CARL9170_CMD_FLUSH_CAB_ASYNC    = (CARL9170_CMD_FLUSH_CAB |
  75                                            CARL9170_CMD_ASYNC_FLAG),
  76
  77         /* responses and traps */
  78         CARL9170_RSP_FLAG               = 0xc0,
  79         CARL9170_RSP_PRETBTT            = 0xc0,
  80         CARL9170_RSP_TXCOMP             = 0xc1,
  81         CARL9170_RSP_BEACON_CONFIG      = 0xc2,
  82         CARL9170_RSP_ATIM               = 0xc3,
  83         CARL9170_RSP_WATCHDOG           = 0xc6,
  84         CARL9170_RSP_TEXT               = 0xca,
  85         CARL9170_RSP_HEXDUMP            = 0xcc,
  86         CARL9170_RSP_RADAR              = 0xcd,
  87         CARL9170_RSP_GPIO               = 0xce,
  88 };
  89
  90 struct carl9170_set_key_cmd {
  91         __le16          user;
  92         __le16          keyId;
  93         __le16          type;
  94         u8              macAddr[6];
  95         u32             key[4];
  96 } __packed;
  97 #define CARL9170_SET_KEY_CMD_SIZE               28
  98
  99 struct carl9170_disable_key_cmd {
 100         __le16          user;
 101         __le16          padding;
 102 } __packed;
 103 #define CARL9170_DISABLE_KEY_CMD_SIZE           4
 104
 105 struct carl9170_u32_list {
 106         u32     vals[0];
 107 } __packed;
 108
 109 struct carl9170_reg_list {
 110         __le32          regs[0];
 111 } __packed;
 112
 113 struct carl9170_write_reg {
 114         struct {
 115                 __le32          addr;
 116                 __le32          val;
 117         } regs[0] __packed;
 118 } __packed;
 119
 120 #define CARL9170FW_PHY_HT_ENABLE                0x4
 121 #define CARL9170FW_PHY_HT_DYN2040               0x8
 122 #define CARL9170FW_PHY_HT_EXT_CHAN_OFF          0x3
 123 #define CARL9170FW_PHY_HT_EXT_CHAN_OFF_S        2
 124
 125 struct carl9170_rf_init {
 126         __le32          freq;
 127         u8              ht_settings;
 128         u8              padding2[3];
 129         __le32          delta_slope_coeff_exp;
 130         __le32          delta_slope_coeff_man;
 131         __le32          delta_slope_coeff_exp_shgi;
 132         __le32          delta_slope_coeff_man_shgi;
 133         __le32          finiteLoopCount;
 134 } __packed;
 135 #define CARL9170_RF_INIT_SIZE           28
 136
 137 struct carl9170_rf_init_result {
 138         __le32          ret;            /* AR9170_PHY_REG_AGC_CONTROL */
 139 } __packed;
 140 #define CARL9170_RF_INIT_RESULT_SIZE    4
 141
 142 #define CARL9170_PSM_SLEEP              0x1000
 143 #define CARL9170_PSM_SOFTWARE           0
 144 #define CARL9170_PSM_WAKE               0 /* internally used. */
 145 #define CARL9170_PSM_COUNTER            0xfff
 146 #define CARL9170_PSM_COUNTER_S          0
 147
 148 struct carl9170_psm {
 149         __le32          state;
 150 } __packed;
 151 #define CARL9170_PSM_SIZE               4
 152
 153 struct carl9170_cab_flush_cmd {
 154         __le32          vif_id;         /* currently unused */
 155 } __packed;
 156 #define CARL9170_CAB_FLUSH_CMD_SIZE     4
 157
 158 struct carl9170_cmd_head {
 159         union {
 160                 struct {
 161                         u8      len;
 162                         u8      cmd;
 163                         u8      seq;
 164                         u8      ext;
 165                 } __packed;
 166
 167                 u32 hdr_data;
 168         } __packed;
 169 } __packed;
 170
 171 struct carl9170_cmd {
 172         struct carl9170_cmd_head hdr;
 173         union {
 174                 struct carl9170_set_key_cmd     setkey;
 175                 struct carl9170_disable_key_cmd disablekey;
 176                 struct carl9170_u32_list        echo;
 177                 struct carl9170_reg_list        rreg;
 178                 struct carl9170_write_reg       wreg;
 179                 struct carl9170_rf_init         rf_init;
 180                 struct carl9170_psm             psm;
 181                 struct carl9170_cab_flush_cmd   cab_flush;
 182                 u8 data[CARL9170_MAX_CMD_PAYLOAD_LEN];
 183         } __packed;
 184 } __packed;
 185
 186 #define CARL9170_TX_STATUS_QUEUE        3
 187 #define CARL9170_TX_STATUS_QUEUE_S      0
 188 #define CARL9170_TX_STATUS_RIX_S        2
 189 #define CARL9170_TX_STATUS_RIX          (3 << CARL9170_TX_STATUS_RIX_S)
 190 #define CARL9170_TX_STATUS_TRIES_S      4
 191 #define CARL9170_TX_STATUS_TRIES        (7 << CARL9170_TX_STATUS_TRIES_S)
 192 #define CARL9170_TX_STATUS_SUCCESS      0x80
 193
 194 /*
 195  * NOTE:
 196  * Both structs [carl9170_tx_status and _carl9170_tx_status]
 197  * need to be "bit for bit" in sync.
 198  */
 199 struct carl9170_tx_status {
 200         /*
 201          * Beware of compiler bugs in all gcc pre 4.4!
 202          */
 203
 204         u8 cookie;
 205         u8 queue:2;
 206         u8 rix:2;
 207         u8 tries:3;
 208         u8 success:1;
 209 } __packed;
 210 struct _carl9170_tx_status {
 211         /*
 212          * This version should be immune to all alignment bugs.
 213          */
 214
 215         u8 cookie;
 216         u8 info;
 217 } __packed;
 218 #define CARL9170_TX_STATUS_SIZE         2
 219
 220 #define CARL9170_RSP_TX_STATUS_NUM      (CARL9170_MAX_CMD_PAYLOAD_LEN / \
 221                                          sizeof(struct _carl9170_tx_status))
 222
 223 #define CARL9170_TX_MAX_RATE_TRIES      7
 224
 225 #define CARL9170_TX_MAX_RATES           4
 226 #define CARL9170_TX_MAX_RETRY_RATES     (CARL9170_TX_MAX_RATES - 1)
 227 #define CARL9170_ERR_MAGIC              "ERR:"
 228 #define CARL9170_BUG_MAGIC              "BUG:"
 229
 230 struct carl9170_gpio {
 231         __le32 gpio;
 232 } __packed;
 233 #define CARL9170_GPIO_SIZE              4
 234
 235 struct carl9170_tsf_rsp {
 236         union {
 237                 __le32 tsf[2];
 238                 __le64 tsf_64;
 239         } __packed;
 240 } __packed;
 241 #define CARL9170_TSF_RSP_SIZE           8
 242
 243 struct carl9170_rsp {
 244         struct carl9170_cmd_head hdr;
 245
 246         union {
 247                 struct carl9170_rf_init_result  rf_init_res;
 248                 struct carl9170_u32_list        rreg_res;
 249                 struct carl9170_u32_list        echo;
 250                 struct carl9170_tx_status       tx_status[0];
 251                 struct _carl9170_tx_status      _tx_status[0];
 252                 struct carl9170_gpio            gpio;
 253                 struct carl9170_tsf_rsp         tsf;
 254                 struct carl9170_psm             psm;
 255                 u8 data[CARL9170_MAX_CMD_PAYLOAD_LEN];
 256         } __packed;
 257 } __packed;
 258
 259 #endif /* __CARL9170_SHARED_FWCMD_H */