2 * Shared CARL9170 Header
4 * Firmware descriptor format
6 * Copyright 2009-2011 Christian Lamparter <chunkeey@googlemail.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; see the file COPYING. If not, see
19 * http://www.gnu.org/licenses/.
22 #ifndef __CARL9170_SHARED_FWDESC_H
23 #define __CARL9170_SHARED_FWDESC_H
25 /* NOTE: Don't mess with the order of the flags! */
26 enum carl9170fw_feature_list {
28 CARL9170FW_DUMMY_FEATURE,
31 * Indicates that this image has special boot block which prevents
32 * legacy drivers to drive the firmware.
36 /* usb registers are initialized by the firmware */
37 CARL9170FW_USB_INIT_FIRMWARE,
39 /* command traps & notifications are send through EP2 */
40 CARL9170FW_USB_RESP_EP2,
42 /* usb download (app -> fw) stream */
43 CARL9170FW_USB_DOWN_STREAM,
45 /* usb upload (fw -> app) stream */
46 CARL9170FW_USB_UP_STREAM,
48 /* unusable - reserved to flag non-functional debug firmwares */
51 /* AR9170_CMD_RF_INIT, AR9170_CMD_FREQ_START, AR9170_CMD_FREQUENCY */
52 CARL9170FW_COMMAND_PHY,
54 /* AR9170_CMD_EKEY, AR9170_CMD_DKEY */
55 CARL9170FW_COMMAND_CAM,
57 /* Firmware has a software Content After Beacon Queueing mechanism */
58 CARL9170FW_WLANTX_CAB,
60 /* The firmware is capable of responding to incoming BAR frames */
61 CARL9170FW_HANDLE_BACK_REQ,
63 /* GPIO Interrupt | CARL9170_RSP_GPIO */
64 CARL9170FW_GPIO_INTERRUPT,
66 /* Firmware PSM support | CARL9170_CMD_PSM */
69 /* Firmware RX filter | CARL9170_CMD_RX_FILTER */
75 /* Firmware supports PSM in the 5GHZ Band */
76 CARL9170FW_FIXED_5GHZ_PSM,
78 /* HW (ANI, CCA, MIB) tally counters */
79 CARL9170FW_HW_COUNTERS,
81 /* Firmware will pass BA when BARs are queued */
82 CARL9170FW_RX_BA_FILTER,
84 /* Firmware has support to write a byte at a time */
85 CARL9170FW_HAS_WREGB_CMD,
87 /* Pattern generator */
88 CARL9170FW_PATTERN_GENERATOR,
91 __CARL9170FW_FEATURE_NUM
94 #define OTUS_MAGIC "OTAR"
95 #define MOTD_MAGIC "MOTD"
96 #define FIX_MAGIC "FIX\0"
97 #define DBG_MAGIC "DBG\0"
98 #define CHK_MAGIC "CHK\0"
99 #define TXSQ_MAGIC "TXSQ"
100 #define WOL_MAGIC "WOL\0"
101 #define PATTERN_MAGIC "RDR\0"
102 #define LAST_MAGIC "LAST"
104 #define CARL9170FW_SET_DAY(d) (((d) - 1) % 31)
105 #define CARL9170FW_SET_MONTH(m) ((((m) - 1) % 12) * 31)
106 #define CARL9170FW_SET_YEAR(y) (((y) - 10) * 372)
108 #define CARL9170FW_GET_DAY(d) (((d) % 31) + 1)
109 #define CARL9170FW_GET_MONTH(m) ((((m) / 31) % 12) + 1)
110 #define CARL9170FW_GET_YEAR(y) ((y) / 372 + 10)
112 #define CARL9170FW_MAGIC_SIZE 4
114 struct carl9170fw_desc_head {
115 u8 magic[CARL9170FW_MAGIC_SIZE];
120 #define CARL9170FW_DESC_HEAD_SIZE \
121 (sizeof(struct carl9170fw_desc_head))
123 #define CARL9170FW_OTUS_DESC_MIN_VER 6
124 #define CARL9170FW_OTUS_DESC_CUR_VER 7
125 struct carl9170fw_otus_desc {
126 struct carl9170fw_desc_head head;
131 __le16 miniboot_size;
133 __le16 rx_max_frame_len;
139 #define CARL9170FW_OTUS_DESC_SIZE \
140 (sizeof(struct carl9170fw_otus_desc))
142 #define CARL9170FW_MOTD_STRING_LEN 24
143 #define CARL9170FW_MOTD_RELEASE_LEN 20
144 #define CARL9170FW_MOTD_DESC_MIN_VER 1
145 #define CARL9170FW_MOTD_DESC_CUR_VER 2
146 struct carl9170fw_motd_desc {
147 struct carl9170fw_desc_head head;
148 __le32 fw_year_month_day;
149 char desc[CARL9170FW_MOTD_STRING_LEN];
150 char release[CARL9170FW_MOTD_RELEASE_LEN];
152 #define CARL9170FW_MOTD_DESC_SIZE \
153 (sizeof(struct carl9170fw_motd_desc))
155 #define CARL9170FW_FIX_DESC_MIN_VER 1
156 #define CARL9170FW_FIX_DESC_CUR_VER 2
157 struct carl9170fw_fix_entry {
163 struct carl9170fw_fix_desc {
164 struct carl9170fw_desc_head head;
165 struct carl9170fw_fix_entry data[0];
167 #define CARL9170FW_FIX_DESC_SIZE \
168 (sizeof(struct carl9170fw_fix_desc))
170 #define CARL9170FW_DBG_DESC_MIN_VER 1
171 #define CARL9170FW_DBG_DESC_CUR_VER 3
172 struct carl9170fw_dbg_desc {
173 struct carl9170fw_desc_head head;
175 __le32 bogoclock_addr;
177 __le32 rx_total_addr;
178 __le32 rx_overrun_addr;
181 /* Put your debugging definitions here */
183 #define CARL9170FW_DBG_DESC_SIZE \
184 (sizeof(struct carl9170fw_dbg_desc))
186 #define CARL9170FW_PATTERN_MAP_NAME_LEN 15
187 struct carl9170fw_pattern_map_entry {
189 char name[CARL9170FW_PATTERN_MAP_NAME_LEN];
192 #define CARL9170FW_PATTERN_DESC_MIN_VER 1
193 #define CARL9170FW_PATTERN_DESC_CUR_VER 1
194 struct carl9170fw_pattern_desc {
195 struct carl9170fw_desc_head head;
199 struct carl9170fw_pattern_map_entry patterns[0];
201 #define CARL9170FW_PATTERN_DESC_SIZE \
202 (sizeof(struct carl9170fw_pattern_desc))
204 #define CARL9170FW_CHK_DESC_MIN_VER 1
205 #define CARL9170FW_CHK_DESC_CUR_VER 2
206 struct carl9170fw_chk_desc {
207 struct carl9170fw_desc_head head;
211 #define CARL9170FW_CHK_DESC_SIZE \
212 (sizeof(struct carl9170fw_chk_desc))
214 #define CARL9170FW_TXSQ_DESC_MIN_VER 1
215 #define CARL9170FW_TXSQ_DESC_CUR_VER 1
216 struct carl9170fw_txsq_desc {
217 struct carl9170fw_desc_head head;
219 __le32 seq_table_addr;
221 #define CARL9170FW_TXSQ_DESC_SIZE \
222 (sizeof(struct carl9170fw_txsq_desc))
224 #define CARL9170FW_WOL_DESC_MIN_VER 1
225 #define CARL9170FW_WOL_DESC_CUR_VER 1
226 struct carl9170fw_wol_desc {
227 struct carl9170fw_desc_head head;
229 __le32 supported_triggers; /* CARL9170_WOL_ */
231 #define CARL9170FW_WOL_DESC_SIZE \
232 (sizeof(struct carl9170fw_wol_desc))
234 #define CARL9170FW_LAST_DESC_MIN_VER 1
235 #define CARL9170FW_LAST_DESC_CUR_VER 2
236 struct carl9170fw_last_desc {
237 struct carl9170fw_desc_head head;
239 #define CARL9170FW_LAST_DESC_SIZE \
240 (sizeof(struct carl9170fw_fix_desc))
242 #define CARL9170FW_DESC_MAX_LENGTH 8192
244 #define CARL9170FW_FILL_DESC(_magic, _length, _min_ver, _cur_ver) \
247 .length = cpu_to_le16(_length), \
248 .min_ver = _min_ver, \
249 .cur_ver = _cur_ver, \
252 static inline void carl9170fw_fill_desc(struct carl9170fw_desc_head *head,
253 u8 magic[CARL9170FW_MAGIC_SIZE],
254 __le16 length, u8 min_ver, u8 cur_ver)
256 head->magic[0] = magic[0];
257 head->magic[1] = magic[1];
258 head->magic[2] = magic[2];
259 head->magic[3] = magic[3];
261 head->length = length;
262 head->min_ver = min_ver;
263 head->cur_ver = cur_ver;
266 #define carl9170fw_for_each_hdr(desc, fw_desc) \
267 for (desc = fw_desc; \
268 memcmp(desc->magic, LAST_MAGIC, CARL9170FW_MAGIC_SIZE) && \
269 le16_to_cpu(desc->length) >= CARL9170FW_DESC_HEAD_SIZE && \
270 le16_to_cpu(desc->length) < CARL9170FW_DESC_MAX_LENGTH; \
271 desc = (void *)((unsigned long)desc + le16_to_cpu(desc->length)))
273 #define CHECK_HDR_VERSION(head, _min_ver) \
274 (((head)->cur_ver < _min_ver) || ((head)->min_ver > _min_ver)) \
276 static inline bool carl9170fw_supports(__le32 list, u8 feature)
278 return le32_to_cpu(list) & BIT(feature);
281 static inline bool carl9170fw_desc_cmp(const struct carl9170fw_desc_head *head,
282 const u8 descid[CARL9170FW_MAGIC_SIZE],
283 u16 min_len, u8 compatible_revision)
285 if (descid[0] == head->magic[0] && descid[1] == head->magic[1] &&
286 descid[2] == head->magic[2] && descid[3] == head->magic[3] &&
287 !CHECK_HDR_VERSION(head, compatible_revision) &&
288 (le16_to_cpu(head->length) >= min_len))
294 #define CARL9170FW_MIN_SIZE 32
295 #define CARL9170FW_MAX_SIZE 16384
297 static inline bool carl9170fw_size_check(unsigned int len)
299 return (len <= CARL9170FW_MAX_SIZE && len >= CARL9170FW_MIN_SIZE);
302 #endif /* __CARL9170_SHARED_FWDESC_H */