2 * Atheros AR9170 driver
4 * firmware command interface definitions
6 * Copyright 2008, Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2009, 2010, Christian Lamparter <chunkeey@googlemail.com>
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.
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.
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/.
22 * This file incorporates work covered by the following copyright and
24 * Copyright (c) 2007-2008 Atheros Communications, Inc.
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.
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.
39 #ifndef __CARL9170_SHARED_FWCMD_H
40 #define __CARL9170_SHARED_FWCMD_H
42 #define CARL9170_MAX_CMD_LEN 64
43 #define CARL9170_MAX_CMD_PAYLOAD_LEN 60
45 #define CARL9170FW_API_MIN_VER 1
46 #define CARL9170FW_API_MAX_VER 1
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,
58 CARL9170_CMD_EKEY = 0x10,
59 CARL9170_CMD_DKEY = 0x11,
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,
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 CARL9170_CMD_PSM_ASYNC = (CARL9170_CMD_PSM |
77 CARL9170_CMD_ASYNC_FLAG),
79 /* responses and traps */
80 CARL9170_RSP_FLAG = 0xc0,
81 CARL9170_RSP_PRETBTT = 0xc0,
82 CARL9170_RSP_TXCOMP = 0xc1,
83 CARL9170_RSP_BEACON_CONFIG = 0xc2,
84 CARL9170_RSP_ATIM = 0xc3,
85 CARL9170_RSP_WATCHDOG = 0xc6,
86 CARL9170_RSP_TEXT = 0xca,
87 CARL9170_RSP_HEXDUMP = 0xcc,
88 CARL9170_RSP_RADAR = 0xcd,
89 CARL9170_RSP_GPIO = 0xce,
90 CARL9170_RSP_BOOT = 0xcf,
93 struct carl9170_set_key_cmd {
100 #define CARL9170_SET_KEY_CMD_SIZE 28
102 struct carl9170_disable_key_cmd {
106 #define CARL9170_DISABLE_KEY_CMD_SIZE 4
108 struct carl9170_u32_list {
112 struct carl9170_reg_list {
116 struct carl9170_write_reg {
123 #define CARL9170FW_PHY_HT_ENABLE 0x4
124 #define CARL9170FW_PHY_HT_DYN2040 0x8
125 #define CARL9170FW_PHY_HT_EXT_CHAN_OFF 0x3
126 #define CARL9170FW_PHY_HT_EXT_CHAN_OFF_S 2
128 struct carl9170_rf_init {
132 __le32 delta_slope_coeff_exp;
133 __le32 delta_slope_coeff_man;
134 __le32 delta_slope_coeff_exp_shgi;
135 __le32 delta_slope_coeff_man_shgi;
136 __le32 finiteLoopCount;
138 #define CARL9170_RF_INIT_SIZE 28
140 struct carl9170_rf_init_result {
141 __le32 ret; /* AR9170_PHY_REG_AGC_CONTROL */
143 #define CARL9170_RF_INIT_RESULT_SIZE 4
145 #define CARL9170_PSM_SLEEP 0x1000
146 #define CARL9170_PSM_SOFTWARE 0
147 #define CARL9170_PSM_WAKE 0 /* internally used. */
148 #define CARL9170_PSM_COUNTER 0xfff
149 #define CARL9170_PSM_COUNTER_S 0
151 struct carl9170_psm {
154 #define CARL9170_PSM_SIZE 4
156 struct carl9170_cab_flush_cmd {
160 #define CARL9170_CAB_FLUSH_CMD_SIZE 8
162 #define CARL9170_CAB_FLUSH_DRAIN 0
163 #define CARL9170_CAB_FLUSH_CAB_TRIGGER 1
165 struct carl9170_cmd_head {
178 struct carl9170_cmd {
179 struct carl9170_cmd_head hdr;
181 struct carl9170_set_key_cmd setkey;
182 struct carl9170_disable_key_cmd disablekey;
183 struct carl9170_u32_list echo;
184 struct carl9170_reg_list rreg;
185 struct carl9170_write_reg wreg;
186 struct carl9170_rf_init rf_init;
187 struct carl9170_psm psm;
188 struct carl9170_cab_flush_cmd cab_flush;
189 u8 data[CARL9170_MAX_CMD_PAYLOAD_LEN];
193 #define CARL9170_TX_STATUS_QUEUE 3
194 #define CARL9170_TX_STATUS_QUEUE_S 0
195 #define CARL9170_TX_STATUS_RIX_S 2
196 #define CARL9170_TX_STATUS_RIX (3 << CARL9170_TX_STATUS_RIX_S)
197 #define CARL9170_TX_STATUS_TRIES_S 4
198 #define CARL9170_TX_STATUS_TRIES (7 << CARL9170_TX_STATUS_TRIES_S)
199 #define CARL9170_TX_STATUS_SUCCESS 0x80
203 * Both structs [carl9170_tx_status and _carl9170_tx_status]
204 * need to be "bit for bit" in sync.
206 struct carl9170_tx_status {
208 * Beware of compiler bugs in all gcc pre 4.4!
217 struct _carl9170_tx_status {
219 * This version should be immune to all alignment bugs.
225 #define CARL9170_TX_STATUS_SIZE 2
227 #define CARL9170_RSP_TX_STATUS_NUM (CARL9170_MAX_CMD_PAYLOAD_LEN / \
228 sizeof(struct _carl9170_tx_status))
230 #define CARL9170_TX_MAX_RATE_TRIES 7
232 #define CARL9170_TX_MAX_RATES 4
233 #define CARL9170_TX_MAX_RETRY_RATES (CARL9170_TX_MAX_RATES - 1)
234 #define CARL9170_ERR_MAGIC "ERR:"
235 #define CARL9170_BUG_MAGIC "BUG:"
237 struct carl9170_gpio {
240 #define CARL9170_GPIO_SIZE 4
242 struct carl9170_tsf_rsp {
248 #define CARL9170_TSF_RSP_SIZE 8
250 struct carl9170_rsp {
251 struct carl9170_cmd_head hdr;
254 struct carl9170_rf_init_result rf_init_res;
255 struct carl9170_u32_list rreg_res;
256 struct carl9170_u32_list echo;
257 struct carl9170_tx_status tx_status[0];
258 struct _carl9170_tx_status _tx_status[0];
259 struct carl9170_gpio gpio;
260 struct carl9170_tsf_rsp tsf;
261 struct carl9170_psm psm;
262 u8 data[CARL9170_MAX_CMD_PAYLOAD_LEN];
266 #endif /* __CARL9170_SHARED_FWCMD_H */