Christian Lamparter | aae9af6 | 2010-09-06 01:06:57 +0200 | [diff] [blame] | 1 | /* |
| 2 | * Shared CARL9170 Header |
| 3 | * |
| 4 | * Firmware descriptor format |
| 5 | * |
Christian Lamparter | 85ee512 | 2011-06-30 20:27:47 +0200 | [diff] [blame] | 6 | * Copyright 2009-2011 Christian Lamparter <chunkeey@googlemail.com> |
Christian Lamparter | aae9af6 | 2010-09-06 01:06:57 +0200 | [diff] [blame] | 7 | * |
| 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. |
| 11 | * |
| 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. |
| 16 | * |
| 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/. |
| 20 | */ |
| 21 | |
| 22 | #ifndef __CARL9170_SHARED_FWDESC_H |
| 23 | #define __CARL9170_SHARED_FWDESC_H |
| 24 | |
| 25 | /* NOTE: Don't mess with the order of the flags! */ |
| 26 | enum carl9170fw_feature_list { |
| 27 | /* Always set */ |
| 28 | CARL9170FW_DUMMY_FEATURE, |
| 29 | |
| 30 | /* |
| 31 | * Indicates that this image has special boot block which prevents |
| 32 | * legacy drivers to drive the firmware. |
| 33 | */ |
| 34 | CARL9170FW_MINIBOOT, |
| 35 | |
| 36 | /* usb registers are initialized by the firmware */ |
| 37 | CARL9170FW_USB_INIT_FIRMWARE, |
| 38 | |
| 39 | /* command traps & notifications are send through EP2 */ |
| 40 | CARL9170FW_USB_RESP_EP2, |
| 41 | |
| 42 | /* usb download (app -> fw) stream */ |
| 43 | CARL9170FW_USB_DOWN_STREAM, |
| 44 | |
| 45 | /* usb upload (fw -> app) stream */ |
| 46 | CARL9170FW_USB_UP_STREAM, |
| 47 | |
| 48 | /* unusable - reserved to flag non-functional debug firmwares */ |
| 49 | CARL9170FW_UNUSABLE, |
| 50 | |
| 51 | /* AR9170_CMD_RF_INIT, AR9170_CMD_FREQ_START, AR9170_CMD_FREQUENCY */ |
| 52 | CARL9170FW_COMMAND_PHY, |
| 53 | |
| 54 | /* AR9170_CMD_EKEY, AR9170_CMD_DKEY */ |
| 55 | CARL9170FW_COMMAND_CAM, |
| 56 | |
| 57 | /* Firmware has a software Content After Beacon Queueing mechanism */ |
| 58 | CARL9170FW_WLANTX_CAB, |
| 59 | |
| 60 | /* The firmware is capable of responding to incoming BAR frames */ |
| 61 | CARL9170FW_HANDLE_BACK_REQ, |
| 62 | |
| 63 | /* GPIO Interrupt | CARL9170_RSP_GPIO */ |
| 64 | CARL9170FW_GPIO_INTERRUPT, |
| 65 | |
| 66 | /* Firmware PSM support | CARL9170_CMD_PSM */ |
| 67 | CARL9170FW_PSM, |
| 68 | |
Christian Lamparter | 5c89569 | 2010-09-28 23:00:59 +0200 | [diff] [blame] | 69 | /* Firmware RX filter | CARL9170_CMD_RX_FILTER */ |
| 70 | CARL9170FW_RX_FILTER, |
| 71 | |
Christian Lamparter | 9e09b5c | 2011-01-22 22:46:49 +0100 | [diff] [blame] | 72 | /* Wake up on WLAN */ |
| 73 | CARL9170FW_WOL, |
| 74 | |
Christian Lamparter | 85ee512 | 2011-06-30 20:27:47 +0200 | [diff] [blame] | 75 | /* Firmware supports PSM in the 5GHZ Band */ |
| 76 | CARL9170FW_FIXED_5GHZ_PSM, |
| 77 | |
Christian Lamparter | 43b52a5 | 2011-07-16 17:21:01 +0200 | [diff] [blame] | 78 | /* HW (ANI, CCA, MIB) tally counters */ |
| 79 | CARL9170FW_HW_COUNTERS, |
| 80 | |
Christian Lamparter | aae9af6 | 2010-09-06 01:06:57 +0200 | [diff] [blame] | 81 | /* KEEP LAST */ |
| 82 | __CARL9170FW_FEATURE_NUM |
| 83 | }; |
| 84 | |
| 85 | #define OTUS_MAGIC "OTAR" |
| 86 | #define MOTD_MAGIC "MOTD" |
| 87 | #define FIX_MAGIC "FIX\0" |
| 88 | #define DBG_MAGIC "DBG\0" |
| 89 | #define CHK_MAGIC "CHK\0" |
Christian Lamparter | 9e09b5c | 2011-01-22 22:46:49 +0100 | [diff] [blame] | 90 | #define TXSQ_MAGIC "TXSQ" |
Christian Lamparter | 85ee512 | 2011-06-30 20:27:47 +0200 | [diff] [blame] | 91 | #define WOL_MAGIC "WOL\0" |
Christian Lamparter | aae9af6 | 2010-09-06 01:06:57 +0200 | [diff] [blame] | 92 | #define LAST_MAGIC "LAST" |
| 93 | |
| 94 | #define CARL9170FW_SET_DAY(d) (((d) - 1) % 31) |
| 95 | #define CARL9170FW_SET_MONTH(m) ((((m) - 1) % 12) * 31) |
| 96 | #define CARL9170FW_SET_YEAR(y) (((y) - 10) * 372) |
| 97 | |
| 98 | #define CARL9170FW_GET_DAY(d) (((d) % 31) + 1) |
| 99 | #define CARL9170FW_GET_MONTH(m) ((((m) / 31) % 12) + 1) |
| 100 | #define CARL9170FW_GET_YEAR(y) ((y) / 372 + 10) |
| 101 | |
Christian Lamparter | 9e09b5c | 2011-01-22 22:46:49 +0100 | [diff] [blame] | 102 | #define CARL9170FW_MAGIC_SIZE 4 |
| 103 | |
Christian Lamparter | aae9af6 | 2010-09-06 01:06:57 +0200 | [diff] [blame] | 104 | struct carl9170fw_desc_head { |
Christian Lamparter | 9e09b5c | 2011-01-22 22:46:49 +0100 | [diff] [blame] | 105 | u8 magic[CARL9170FW_MAGIC_SIZE]; |
Christian Lamparter | aae9af6 | 2010-09-06 01:06:57 +0200 | [diff] [blame] | 106 | __le16 length; |
| 107 | u8 min_ver; |
| 108 | u8 cur_ver; |
| 109 | } __packed; |
| 110 | #define CARL9170FW_DESC_HEAD_SIZE \ |
| 111 | (sizeof(struct carl9170fw_desc_head)) |
| 112 | |
| 113 | #define CARL9170FW_OTUS_DESC_MIN_VER 6 |
Christian Lamparter | 85ee512 | 2011-06-30 20:27:47 +0200 | [diff] [blame] | 114 | #define CARL9170FW_OTUS_DESC_CUR_VER 7 |
Christian Lamparter | aae9af6 | 2010-09-06 01:06:57 +0200 | [diff] [blame] | 115 | struct carl9170fw_otus_desc { |
| 116 | struct carl9170fw_desc_head head; |
| 117 | __le32 feature_set; |
| 118 | __le32 fw_address; |
| 119 | __le32 bcn_addr; |
| 120 | __le16 bcn_len; |
| 121 | __le16 miniboot_size; |
| 122 | __le16 tx_frag_len; |
| 123 | __le16 rx_max_frame_len; |
| 124 | u8 tx_descs; |
| 125 | u8 cmd_bufs; |
| 126 | u8 api_ver; |
| 127 | u8 vif_num; |
| 128 | } __packed; |
| 129 | #define CARL9170FW_OTUS_DESC_SIZE \ |
| 130 | (sizeof(struct carl9170fw_otus_desc)) |
| 131 | |
| 132 | #define CARL9170FW_MOTD_STRING_LEN 24 |
| 133 | #define CARL9170FW_MOTD_RELEASE_LEN 20 |
| 134 | #define CARL9170FW_MOTD_DESC_MIN_VER 1 |
| 135 | #define CARL9170FW_MOTD_DESC_CUR_VER 2 |
| 136 | struct carl9170fw_motd_desc { |
| 137 | struct carl9170fw_desc_head head; |
| 138 | __le32 fw_year_month_day; |
| 139 | char desc[CARL9170FW_MOTD_STRING_LEN]; |
| 140 | char release[CARL9170FW_MOTD_RELEASE_LEN]; |
| 141 | } __packed; |
| 142 | #define CARL9170FW_MOTD_DESC_SIZE \ |
| 143 | (sizeof(struct carl9170fw_motd_desc)) |
| 144 | |
| 145 | #define CARL9170FW_FIX_DESC_MIN_VER 1 |
| 146 | #define CARL9170FW_FIX_DESC_CUR_VER 2 |
| 147 | struct carl9170fw_fix_entry { |
| 148 | __le32 address; |
| 149 | __le32 mask; |
| 150 | __le32 value; |
| 151 | } __packed; |
| 152 | |
| 153 | struct carl9170fw_fix_desc { |
| 154 | struct carl9170fw_desc_head head; |
| 155 | struct carl9170fw_fix_entry data[0]; |
| 156 | } __packed; |
| 157 | #define CARL9170FW_FIX_DESC_SIZE \ |
| 158 | (sizeof(struct carl9170fw_fix_desc)) |
| 159 | |
| 160 | #define CARL9170FW_DBG_DESC_MIN_VER 1 |
Christian Lamparter | 5c89569 | 2010-09-28 23:00:59 +0200 | [diff] [blame] | 161 | #define CARL9170FW_DBG_DESC_CUR_VER 3 |
Christian Lamparter | aae9af6 | 2010-09-06 01:06:57 +0200 | [diff] [blame] | 162 | struct carl9170fw_dbg_desc { |
| 163 | struct carl9170fw_desc_head head; |
| 164 | |
| 165 | __le32 bogoclock_addr; |
| 166 | __le32 counter_addr; |
| 167 | __le32 rx_total_addr; |
| 168 | __le32 rx_overrun_addr; |
Christian Lamparter | 5c89569 | 2010-09-28 23:00:59 +0200 | [diff] [blame] | 169 | __le32 rx_filter; |
Christian Lamparter | aae9af6 | 2010-09-06 01:06:57 +0200 | [diff] [blame] | 170 | |
| 171 | /* Put your debugging definitions here */ |
| 172 | } __packed; |
| 173 | #define CARL9170FW_DBG_DESC_SIZE \ |
| 174 | (sizeof(struct carl9170fw_dbg_desc)) |
| 175 | |
| 176 | #define CARL9170FW_CHK_DESC_MIN_VER 1 |
| 177 | #define CARL9170FW_CHK_DESC_CUR_VER 2 |
| 178 | struct carl9170fw_chk_desc { |
| 179 | struct carl9170fw_desc_head head; |
| 180 | __le32 fw_crc32; |
| 181 | __le32 hdr_crc32; |
| 182 | } __packed; |
| 183 | #define CARL9170FW_CHK_DESC_SIZE \ |
| 184 | (sizeof(struct carl9170fw_chk_desc)) |
| 185 | |
Christian Lamparter | 9e09b5c | 2011-01-22 22:46:49 +0100 | [diff] [blame] | 186 | #define CARL9170FW_TXSQ_DESC_MIN_VER 1 |
| 187 | #define CARL9170FW_TXSQ_DESC_CUR_VER 1 |
| 188 | struct carl9170fw_txsq_desc { |
| 189 | struct carl9170fw_desc_head head; |
| 190 | |
| 191 | __le32 seq_table_addr; |
| 192 | } __packed; |
| 193 | #define CARL9170FW_TXSQ_DESC_SIZE \ |
| 194 | (sizeof(struct carl9170fw_txsq_desc)) |
| 195 | |
Christian Lamparter | 85ee512 | 2011-06-30 20:27:47 +0200 | [diff] [blame] | 196 | #define CARL9170FW_WOL_DESC_MIN_VER 1 |
| 197 | #define CARL9170FW_WOL_DESC_CUR_VER 1 |
| 198 | struct carl9170fw_wol_desc { |
| 199 | struct carl9170fw_desc_head head; |
| 200 | |
| 201 | __le32 supported_triggers; /* CARL9170_WOL_ */ |
| 202 | } __packed; |
| 203 | #define CARL9170FW_WOL_DESC_SIZE \ |
| 204 | (sizeof(struct carl9170fw_wol_desc)) |
| 205 | |
Christian Lamparter | aae9af6 | 2010-09-06 01:06:57 +0200 | [diff] [blame] | 206 | #define CARL9170FW_LAST_DESC_MIN_VER 1 |
| 207 | #define CARL9170FW_LAST_DESC_CUR_VER 2 |
| 208 | struct carl9170fw_last_desc { |
| 209 | struct carl9170fw_desc_head head; |
| 210 | } __packed; |
| 211 | #define CARL9170FW_LAST_DESC_SIZE \ |
| 212 | (sizeof(struct carl9170fw_fix_desc)) |
| 213 | |
| 214 | #define CARL9170FW_DESC_MAX_LENGTH 8192 |
| 215 | |
| 216 | #define CARL9170FW_FILL_DESC(_magic, _length, _min_ver, _cur_ver) \ |
| 217 | .head = { \ |
| 218 | .magic = _magic, \ |
| 219 | .length = cpu_to_le16(_length), \ |
| 220 | .min_ver = _min_ver, \ |
| 221 | .cur_ver = _cur_ver, \ |
| 222 | } |
| 223 | |
| 224 | static inline void carl9170fw_fill_desc(struct carl9170fw_desc_head *head, |
Christian Lamparter | 9e09b5c | 2011-01-22 22:46:49 +0100 | [diff] [blame] | 225 | u8 magic[CARL9170FW_MAGIC_SIZE], |
| 226 | __le16 length, u8 min_ver, u8 cur_ver) |
Christian Lamparter | aae9af6 | 2010-09-06 01:06:57 +0200 | [diff] [blame] | 227 | { |
| 228 | head->magic[0] = magic[0]; |
| 229 | head->magic[1] = magic[1]; |
| 230 | head->magic[2] = magic[2]; |
| 231 | head->magic[3] = magic[3]; |
| 232 | |
| 233 | head->length = length; |
| 234 | head->min_ver = min_ver; |
| 235 | head->cur_ver = cur_ver; |
| 236 | } |
| 237 | |
| 238 | #define carl9170fw_for_each_hdr(desc, fw_desc) \ |
| 239 | for (desc = fw_desc; \ |
Christian Lamparter | 9e09b5c | 2011-01-22 22:46:49 +0100 | [diff] [blame] | 240 | memcmp(desc->magic, LAST_MAGIC, CARL9170FW_MAGIC_SIZE) && \ |
Christian Lamparter | aae9af6 | 2010-09-06 01:06:57 +0200 | [diff] [blame] | 241 | le16_to_cpu(desc->length) >= CARL9170FW_DESC_HEAD_SIZE && \ |
| 242 | le16_to_cpu(desc->length) < CARL9170FW_DESC_MAX_LENGTH; \ |
| 243 | desc = (void *)((unsigned long)desc + le16_to_cpu(desc->length))) |
| 244 | |
| 245 | #define CHECK_HDR_VERSION(head, _min_ver) \ |
| 246 | (((head)->cur_ver < _min_ver) || ((head)->min_ver > _min_ver)) \ |
| 247 | |
| 248 | static inline bool carl9170fw_supports(__le32 list, u8 feature) |
| 249 | { |
| 250 | return le32_to_cpu(list) & BIT(feature); |
| 251 | } |
| 252 | |
| 253 | static inline bool carl9170fw_desc_cmp(const struct carl9170fw_desc_head *head, |
Christian Lamparter | 9e09b5c | 2011-01-22 22:46:49 +0100 | [diff] [blame] | 254 | const u8 descid[CARL9170FW_MAGIC_SIZE], |
| 255 | u16 min_len, u8 compatible_revision) |
Christian Lamparter | aae9af6 | 2010-09-06 01:06:57 +0200 | [diff] [blame] | 256 | { |
| 257 | if (descid[0] == head->magic[0] && descid[1] == head->magic[1] && |
| 258 | descid[2] == head->magic[2] && descid[3] == head->magic[3] && |
| 259 | !CHECK_HDR_VERSION(head, compatible_revision) && |
| 260 | (le16_to_cpu(head->length) >= min_len)) |
| 261 | return true; |
| 262 | |
| 263 | return false; |
| 264 | } |
| 265 | |
| 266 | #define CARL9170FW_MIN_SIZE 32 |
| 267 | #define CARL9170FW_MAX_SIZE 16384 |
| 268 | |
| 269 | static inline bool carl9170fw_size_check(unsigned int len) |
| 270 | { |
| 271 | return (len <= CARL9170FW_MAX_SIZE && len >= CARL9170FW_MIN_SIZE); |
| 272 | } |
| 273 | |
| 274 | #endif /* __CARL9170_SHARED_FWDESC_H */ |