2 * Shared Atheros AR9170 Header
4 * Firmware command interface definitions
6 * Copyright 2008, Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2009-2011 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_BCN_CTRL
= 0x05,
55 CARL9170_CMD_READ_TSF
= 0x06,
56 CARL9170_CMD_RX_FILTER
= 0x07,
57 CARL9170_CMD_WOL
= 0x08,
58 CARL9170_CMD_TALLY
= 0x09,
61 CARL9170_CMD_EKEY
= 0x10,
62 CARL9170_CMD_DKEY
= 0x11,
65 CARL9170_CMD_FREQUENCY
= 0x20,
66 CARL9170_CMD_RF_INIT
= 0x21,
67 CARL9170_CMD_SYNTH
= 0x22,
68 CARL9170_CMD_FREQ_START
= 0x23,
69 CARL9170_CMD_PSM
= 0x24,
71 /* Asychronous command flag */
72 CARL9170_CMD_ASYNC_FLAG
= 0x40,
73 CARL9170_CMD_WREG_ASYNC
= (CARL9170_CMD_WREG
|
74 CARL9170_CMD_ASYNC_FLAG
),
75 CARL9170_CMD_REBOOT_ASYNC
= (CARL9170_CMD_REBOOT
|
76 CARL9170_CMD_ASYNC_FLAG
),
77 CARL9170_CMD_BCN_CTRL_ASYNC
= (CARL9170_CMD_BCN_CTRL
|
78 CARL9170_CMD_ASYNC_FLAG
),
79 CARL9170_CMD_PSM_ASYNC
= (CARL9170_CMD_PSM
|
80 CARL9170_CMD_ASYNC_FLAG
),
82 /* responses and traps */
83 CARL9170_RSP_FLAG
= 0xc0,
84 CARL9170_RSP_PRETBTT
= 0xc0,
85 CARL9170_RSP_TXCOMP
= 0xc1,
86 CARL9170_RSP_BEACON_CONFIG
= 0xc2,
87 CARL9170_RSP_ATIM
= 0xc3,
88 CARL9170_RSP_WATCHDOG
= 0xc6,
89 CARL9170_RSP_TEXT
= 0xca,
90 CARL9170_RSP_HEXDUMP
= 0xcc,
91 CARL9170_RSP_RADAR
= 0xcd,
92 CARL9170_RSP_GPIO
= 0xce,
93 CARL9170_RSP_BOOT
= 0xcf,
96 struct carl9170_set_key_cmd
{
102 } __packed
__aligned(4);
103 #define CARL9170_SET_KEY_CMD_SIZE 28
105 struct carl9170_disable_key_cmd
{
108 } __packed
__aligned(4);
109 #define CARL9170_DISABLE_KEY_CMD_SIZE 4
111 struct carl9170_u32_list
{
115 struct carl9170_reg_list
{
119 struct carl9170_write_reg
{
126 #define CARL9170FW_PHY_HT_ENABLE 0x4
127 #define CARL9170FW_PHY_HT_DYN2040 0x8
128 #define CARL9170FW_PHY_HT_EXT_CHAN_OFF 0x3
129 #define CARL9170FW_PHY_HT_EXT_CHAN_OFF_S 2
131 struct carl9170_rf_init
{
135 __le32 delta_slope_coeff_exp
;
136 __le32 delta_slope_coeff_man
;
137 __le32 delta_slope_coeff_exp_shgi
;
138 __le32 delta_slope_coeff_man_shgi
;
139 __le32 finiteLoopCount
;
141 #define CARL9170_RF_INIT_SIZE 28
143 struct carl9170_rf_init_result
{
144 __le32 ret
; /* AR9170_PHY_REG_AGC_CONTROL */
146 #define CARL9170_RF_INIT_RESULT_SIZE 4
148 #define CARL9170_PSM_SLEEP 0x1000
149 #define CARL9170_PSM_SOFTWARE 0
150 #define CARL9170_PSM_WAKE 0 /* internally used. */
151 #define CARL9170_PSM_COUNTER 0xfff
152 #define CARL9170_PSM_COUNTER_S 0
154 struct carl9170_psm
{
157 #define CARL9170_PSM_SIZE 4
160 * Note: If a bit in rx_filter is set, then it
161 * means that the particular frames which matches
162 * the condition are FILTERED/REMOVED/DISCARDED!
163 * (This is can be a bit confusing, especially
164 * because someone people think it's the exact
165 * opposite way, so watch out!)
167 struct carl9170_rx_filter_cmd
{
170 #define CARL9170_RX_FILTER_CMD_SIZE 4
172 #define CARL9170_RX_FILTER_BAD 0x01
173 #define CARL9170_RX_FILTER_OTHER_RA 0x02
174 #define CARL9170_RX_FILTER_DECRY_FAIL 0x04
175 #define CARL9170_RX_FILTER_CTL_OTHER 0x08
176 #define CARL9170_RX_FILTER_CTL_PSPOLL 0x10
177 #define CARL9170_RX_FILTER_CTL_BACKR 0x20
178 #define CARL9170_RX_FILTER_MGMT 0x40
179 #define CARL9170_RX_FILTER_DATA 0x80
180 #define CARL9170_RX_FILTER_EVERYTHING (~0)
182 struct carl9170_bcn_ctrl_cmd
{
188 #define CARL9170_BCN_CTRL_CMD_SIZE 16
190 #define CARL9170_BCN_CTRL_DRAIN 0
191 #define CARL9170_BCN_CTRL_CAB_TRIGGER 1
193 struct carl9170_wol_cmd
{
197 __le32 null_interval
;
198 __le32 free_for_use2
;
203 #define CARL9170_WOL_CMD_SIZE 60
205 #define CARL9170_WOL_DISCONNECT 1
206 #define CARL9170_WOL_MAGIC_PKT 2
208 struct carl9170_cmd_head
{
221 struct carl9170_cmd
{
222 struct carl9170_cmd_head hdr
;
224 struct carl9170_set_key_cmd setkey
;
225 struct carl9170_disable_key_cmd disablekey
;
226 struct carl9170_u32_list echo
;
227 struct carl9170_reg_list rreg
;
228 struct carl9170_write_reg wreg
;
229 struct carl9170_rf_init rf_init
;
230 struct carl9170_psm psm
;
231 struct carl9170_wol_cmd wol
;
232 struct carl9170_bcn_ctrl_cmd bcn_ctrl
;
233 struct carl9170_rx_filter_cmd rx_filter
;
234 u8 data
[CARL9170_MAX_CMD_PAYLOAD_LEN
];
236 } __packed
__aligned(4);
238 #define CARL9170_TX_STATUS_QUEUE 3
239 #define CARL9170_TX_STATUS_QUEUE_S 0
240 #define CARL9170_TX_STATUS_RIX_S 2
241 #define CARL9170_TX_STATUS_RIX (3 << CARL9170_TX_STATUS_RIX_S)
242 #define CARL9170_TX_STATUS_TRIES_S 4
243 #define CARL9170_TX_STATUS_TRIES (7 << CARL9170_TX_STATUS_TRIES_S)
244 #define CARL9170_TX_STATUS_SUCCESS 0x80
246 #ifdef __CARL9170FW__
249 * Both structs [carl9170_tx_status and _carl9170_tx_status]
250 * need to be "bit for bit" in sync.
252 struct carl9170_tx_status
{
254 * Beware of compiler bugs in all gcc pre 4.4!
263 #endif /* __CARL9170FW__ */
265 struct _carl9170_tx_status
{
267 * This version should be immune to all alignment bugs.
273 #define CARL9170_TX_STATUS_SIZE 2
275 #define CARL9170_RSP_TX_STATUS_NUM (CARL9170_MAX_CMD_PAYLOAD_LEN / \
276 sizeof(struct _carl9170_tx_status))
278 #define CARL9170_TX_MAX_RATE_TRIES 7
280 #define CARL9170_TX_MAX_RATES 4
281 #define CARL9170_TX_MAX_RETRY_RATES (CARL9170_TX_MAX_RATES - 1)
282 #define CARL9170_ERR_MAGIC "ERR:"
283 #define CARL9170_BUG_MAGIC "BUG:"
285 struct carl9170_gpio
{
288 #define CARL9170_GPIO_SIZE 4
290 struct carl9170_tsf_rsp
{
296 #define CARL9170_TSF_RSP_SIZE 8
298 struct carl9170_tally_rsp
{
307 struct carl9170_rsp
{
308 struct carl9170_cmd_head hdr
;
311 struct carl9170_rf_init_result rf_init_res
;
312 struct carl9170_u32_list rreg_res
;
313 struct carl9170_u32_list echo
;
314 #ifdef __CARL9170FW__
315 struct carl9170_tx_status tx_status
[0];
316 #endif /* __CARL9170FW__ */
317 struct _carl9170_tx_status _tx_status
[0];
318 struct carl9170_gpio gpio
;
319 struct carl9170_tsf_rsp tsf
;
320 struct carl9170_psm psm
;
321 struct carl9170_tally_rsp tally
;
322 u8 data
[CARL9170_MAX_CMD_PAYLOAD_LEN
];
324 } __packed
__aligned(4);
326 #endif /* __CARL9170_SHARED_FWCMD_H */