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,
56 CARL9170_CMD_USB_WD = 0x07,
59 CARL9170_CMD_EKEY = 0x10,
60 CARL9170_CMD_DKEY = 0x11,
63 CARL9170_CMD_FREQUENCY = 0x20,
64 CARL9170_CMD_RF_INIT = 0x21,
65 CARL9170_CMD_SYNTH = 0x22,
66 CARL9170_CMD_FREQ_START = 0x23,
67 CARL9170_CMD_PSM = 0x24,
69 /* Asychronous command flag */
70 CARL9170_CMD_ASYNC_FLAG = 0x40,
71 CARL9170_CMD_WREG_ASYNC = (CARL9170_CMD_WREG |
72 CARL9170_CMD_ASYNC_FLAG),
73 CARL9170_CMD_REBOOT_ASYNC = (CARL9170_CMD_REBOOT |
74 CARL9170_CMD_ASYNC_FLAG),
75 CARL9170_CMD_FLUSH_CAB_ASYNC = (CARL9170_CMD_FLUSH_CAB |
76 CARL9170_CMD_ASYNC_FLAG),
78 /* responses and traps */
79 CARL9170_RSP_FLAG = 0xc0,
80 CARL9170_RSP_PRETBTT = 0xc0,
81 CARL9170_RSP_TXCOMP = 0xc1,
82 CARL9170_RSP_BEACON_CONFIG = 0xc2,
83 CARL9170_RSP_ATIM = 0xc3,
84 CARL9170_RSP_WATCHDOG = 0xc6,
85 CARL9170_RSP_TEXT = 0xca,
86 CARL9170_RSP_HEXDUMP = 0xcc,
87 CARL9170_RSP_RADAR = 0xcd,
88 CARL9170_RSP_GPIO = 0xce,
89 CARL9170_RSP_USB_WD = 0xcf
92 struct carl9170_set_key_cmd {
99 #define CARL9170_SET_KEY_CMD_SIZE 28
101 struct carl9170_disable_key_cmd {
105 #define CARL9170_DISABLE_KEY_CMD_SIZE 4
107 struct carl9170_u32_list {
111 struct carl9170_reg_list {
115 struct carl9170_write_reg {
122 #define CARL9170FW_PHY_HT_ENABLE 0x4
123 #define CARL9170FW_PHY_HT_DYN2040 0x8
124 #define CARL9170FW_PHY_HT_EXT_CHAN_OFF 0x3
125 #define CARL9170FW_PHY_HT_EXT_CHAN_OFF_S 2
127 struct carl9170_rf_init {
131 __le32 delta_slope_coeff_exp;
132 __le32 delta_slope_coeff_man;
133 __le32 delta_slope_coeff_exp_shgi;
134 __le32 delta_slope_coeff_man_shgi;
135 __le32 finiteLoopCount;
137 #define CARL9170_RF_INIT_SIZE 28
139 struct carl9170_rf_init_result {
140 __le32 ret; /* AR9170_PHY_REG_AGC_CONTROL */
142 #define CARL9170_RF_INIT_RESULT_SIZE 4
144 #define CARL9170_USB_WATCHDOG_INACTIVE 0
145 #define CARL9170_USB_WATCHDOG_ON_DUTY 1
147 struct carl9170_watchdog_cmd {
150 #define CARL9170_WATCHDOG_CMD_SIZE 4
152 #define CARL9170_PSM_SLEEP 0x1000
153 #define CARL9170_PSM_SOFTWARE 0
154 #define CARL9170_PSM_WAKE 0 /* internally used. */
155 #define CARL9170_PSM_COUNTER 0xfff
156 #define CARL9170_PSM_COUNTER_S 0
158 struct carl9170_psm {
161 #define CARL9170_PSM_SIZE 4
163 struct carl9170_cab_flush_cmd {
164 __le32 vif_id; /* currently unused */
166 #define CARL9170_CAB_FLUSH_CMD_SIZE 4
168 struct carl9170_cmd_head {
181 struct carl9170_cmd {
182 struct carl9170_cmd_head hdr;
184 struct carl9170_set_key_cmd setkey;
185 struct carl9170_disable_key_cmd disablekey;
186 struct carl9170_u32_list echo;
187 struct carl9170_watchdog_cmd watchdog;
188 struct carl9170_reg_list rreg;
189 struct carl9170_write_reg wreg;
190 struct carl9170_rf_init rf_init;
191 struct carl9170_psm psm;
192 struct carl9170_cab_flush_cmd cab_flush;
193 u8 data[CARL9170_MAX_CMD_PAYLOAD_LEN];
197 #define CARL9170_TX_STATUS_QUEUE 3
198 #define CARL9170_TX_STATUS_QUEUE_S 0
199 #define CARL9170_TX_STATUS_RIX_S 2
200 #define CARL9170_TX_STATUS_RIX (3 << CARL9170_TX_STATUS_RIX_S)
201 #define CARL9170_TX_STATUS_TRIES_S 4
202 #define CARL9170_TX_STATUS_TRIES (7 << CARL9170_TX_STATUS_TRIES_S)
203 #define CARL9170_TX_STATUS_SUCCESS 0x80
207 * Both structs [carl9170_tx_status and _carl9170_tx_status]
208 * need to be "bit for bit" in sync.
210 struct carl9170_tx_status {
212 * Beware of compiler bugs in all gcc pre 4.4!
221 struct _carl9170_tx_status {
223 * This version should be immune to all alignment bugs.
229 #define CARL9170_TX_STATUS_SIZE 2
231 #define CARL9170_RSP_TX_STATUS_NUM (CARL9170_MAX_CMD_PAYLOAD_LEN / \
232 sizeof(struct _carl9170_tx_status))
234 #define CARL9170_TX_MAX_RATE_TRIES 7
236 #define CARL9170_TX_MAX_RATES 4
237 #define CARL9170_TX_MAX_RETRY_RATES (CARL9170_TX_MAX_RATES - 1)
238 #define CARL9170_ERR_MAGIC "ERR:"
239 #define CARL9170_BUG_MAGIC "BUG:"
241 struct carl9170_gpio {
244 #define CARL9170_GPIO_SIZE 4
246 struct carl9170_tsf_rsp {
252 #define CARL9170_TSF_RSP_SIZE 8
254 struct carl9170_rsp {
255 struct carl9170_cmd_head hdr;
258 struct carl9170_rf_init_result rf_init_res;
259 struct carl9170_u32_list rreg_res;
260 struct carl9170_u32_list echo;
261 struct carl9170_watchdog_cmd watchdog;
262 struct carl9170_tx_status tx_status[0];
263 struct _carl9170_tx_status _tx_status[0];
264 struct carl9170_gpio gpio;
265 struct carl9170_tsf_rsp tsf;
266 struct carl9170_psm psm;
267 u8 data[CARL9170_MAX_CMD_PAYLOAD_LEN];
271 #endif /* __CARL9170_SHARED_FWCMD_H */