1 /* 2 * Shared CARL9170 Header 3 * 4 * Firmware descriptor format 5 * 6 * Copyright 2009, 2010, Christian Lamparter <chunkeey@googlemail.com> 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 69 /* Firmware RX filter | CARL9170_CMD_RX_FILTER */ 70 CARL9170FW_RX_FILTER, 71 72 /* Wake up on WLAN */ 73 CARL9170FW_WOL, 74 75 /* KEEP LAST */ 76 __CARL9170FW_FEATURE_NUM 77 }; 78 79 #define OTUS_MAGIC "OTAR" 80 #define MOTD_MAGIC "MOTD" 81 #define FIX_MAGIC "FIX\0" 82 #define DBG_MAGIC "DBG\0" 83 #define CHK_MAGIC "CHK\0" 84 #define TXSQ_MAGIC "TXSQ" 85 #define LAST_MAGIC "LAST" 86 87 #define CARL9170FW_SET_DAY(d) (((d) - 1) % 31) 88 #define CARL9170FW_SET_MONTH(m) ((((m) - 1) % 12) * 31) 89 #define CARL9170FW_SET_YEAR(y) (((y) - 10) * 372) 90 91 #define CARL9170FW_GET_DAY(d) (((d) % 31) + 1) 92 #define CARL9170FW_GET_MONTH(m) ((((m) / 31) % 12) + 1) 93 #define CARL9170FW_GET_YEAR(y) ((y) / 372 + 10) 94 95 #define CARL9170FW_MAGIC_SIZE 4 96 97 struct carl9170fw_desc_head { 98 u8 magic[CARL9170FW_MAGIC_SIZE]; 99 __le16 length; 100 u8 min_ver; 101 u8 cur_ver; 102 } __packed; 103 #define CARL9170FW_DESC_HEAD_SIZE \ 104 (sizeof(struct carl9170fw_desc_head)) 105 106 #define CARL9170FW_OTUS_DESC_MIN_VER 6 107 #define CARL9170FW_OTUS_DESC_CUR_VER 6 108 struct carl9170fw_otus_desc { 109 struct carl9170fw_desc_head head; 110 __le32 feature_set; 111 __le32 fw_address; 112 __le32 bcn_addr; 113 __le16 bcn_len; 114 __le16 miniboot_size; 115 __le16 tx_frag_len; 116 __le16 rx_max_frame_len; 117 u8 tx_descs; 118 u8 cmd_bufs; 119 u8 api_ver; 120 u8 vif_num; 121 } __packed; 122 #define CARL9170FW_OTUS_DESC_SIZE \ 123 (sizeof(struct carl9170fw_otus_desc)) 124 125 #define CARL9170FW_MOTD_STRING_LEN 24 126 #define CARL9170FW_MOTD_RELEASE_LEN 20 127 #define CARL9170FW_MOTD_DESC_MIN_VER 1 128 #define CARL9170FW_MOTD_DESC_CUR_VER 2 129 struct carl9170fw_motd_desc { 130 struct carl9170fw_desc_head head; 131 __le32 fw_year_month_day; 132 char desc[CARL9170FW_MOTD_STRING_LEN]; 133 char release[CARL9170FW_MOTD_RELEASE_LEN]; 134 } __packed; 135 #define CARL9170FW_MOTD_DESC_SIZE \ 136 (sizeof(struct carl9170fw_motd_desc)) 137 138 #define CARL9170FW_FIX_DESC_MIN_VER 1 139 #define CARL9170FW_FIX_DESC_CUR_VER 2 140 struct carl9170fw_fix_entry { 141 __le32 address; 142 __le32 mask; 143 __le32 value; 144 } __packed; 145 146 struct carl9170fw_fix_desc { 147 struct carl9170fw_desc_head head; 148 struct carl9170fw_fix_entry data[0]; 149 } __packed; 150 #define CARL9170FW_FIX_DESC_SIZE \ 151 (sizeof(struct carl9170fw_fix_desc)) 152 153 #define CARL9170FW_DBG_DESC_MIN_VER 1 154 #define CARL9170FW_DBG_DESC_CUR_VER 3 155 struct carl9170fw_dbg_desc { 156 struct carl9170fw_desc_head head; 157 158 __le32 bogoclock_addr; 159 __le32 counter_addr; 160 __le32 rx_total_addr; 161 __le32 rx_overrun_addr; 162 __le32 rx_filter; 163 164 /* Put your debugging definitions here */ 165 } __packed; 166 #define CARL9170FW_DBG_DESC_SIZE \ 167 (sizeof(struct carl9170fw_dbg_desc)) 168 169 #define CARL9170FW_CHK_DESC_MIN_VER 1 170 #define CARL9170FW_CHK_DESC_CUR_VER 2 171 struct carl9170fw_chk_desc { 172 struct carl9170fw_desc_head head; 173 __le32 fw_crc32; 174 __le32 hdr_crc32; 175 } __packed; 176 #define CARL9170FW_CHK_DESC_SIZE \ 177 (sizeof(struct carl9170fw_chk_desc)) 178 179 #define CARL9170FW_TXSQ_DESC_MIN_VER 1 180 #define CARL9170FW_TXSQ_DESC_CUR_VER 1 181 struct carl9170fw_txsq_desc { 182 struct carl9170fw_desc_head head; 183 184 __le32 seq_table_addr; 185 } __packed; 186 #define CARL9170FW_TXSQ_DESC_SIZE \ 187 (sizeof(struct carl9170fw_txsq_desc)) 188 189 #define CARL9170FW_LAST_DESC_MIN_VER 1 190 #define CARL9170FW_LAST_DESC_CUR_VER 2 191 struct carl9170fw_last_desc { 192 struct carl9170fw_desc_head head; 193 } __packed; 194 #define CARL9170FW_LAST_DESC_SIZE \ 195 (sizeof(struct carl9170fw_fix_desc)) 196 197 #define CARL9170FW_DESC_MAX_LENGTH 8192 198 199 #define CARL9170FW_FILL_DESC(_magic, _length, _min_ver, _cur_ver) \ 200 .head = { \ 201 .magic = _magic, \ 202 .length = cpu_to_le16(_length), \ 203 .min_ver = _min_ver, \ 204 .cur_ver = _cur_ver, \ 205 } 206 207 static inline void carl9170fw_fill_desc(struct carl9170fw_desc_head *head, 208 u8 magic[CARL9170FW_MAGIC_SIZE], 209 __le16 length, u8 min_ver, u8 cur_ver) 210 { 211 head->magic[0] = magic[0]; 212 head->magic[1] = magic[1]; 213 head->magic[2] = magic[2]; 214 head->magic[3] = magic[3]; 215 216 head->length = length; 217 head->min_ver = min_ver; 218 head->cur_ver = cur_ver; 219 } 220 221 #define carl9170fw_for_each_hdr(desc, fw_desc) \ 222 for (desc = fw_desc; \ 223 memcmp(desc->magic, LAST_MAGIC, CARL9170FW_MAGIC_SIZE) && \ 224 le16_to_cpu(desc->length) >= CARL9170FW_DESC_HEAD_SIZE && \ 225 le16_to_cpu(desc->length) < CARL9170FW_DESC_MAX_LENGTH; \ 226 desc = (void *)((unsigned long)desc + le16_to_cpu(desc->length))) 227 228 #define CHECK_HDR_VERSION(head, _min_ver) \ 229 (((head)->cur_ver < _min_ver) || ((head)->min_ver > _min_ver)) \ 230 231 static inline bool carl9170fw_supports(__le32 list, u8 feature) 232 { 233 return le32_to_cpu(list) & BIT(feature); 234 } 235 236 static inline bool carl9170fw_desc_cmp(const struct carl9170fw_desc_head *head, 237 const u8 descid[CARL9170FW_MAGIC_SIZE], 238 u16 min_len, u8 compatible_revision) 239 { 240 if (descid[0] == head->magic[0] && descid[1] == head->magic[1] && 241 descid[2] == head->magic[2] && descid[3] == head->magic[3] && 242 !CHECK_HDR_VERSION(head, compatible_revision) && 243 (le16_to_cpu(head->length) >= min_len)) 244 return true; 245 246 return false; 247 } 248 249 #define CARL9170FW_MIN_SIZE 32 250 #define CARL9170FW_MAX_SIZE 16384 251 252 static inline bool carl9170fw_size_check(unsigned int len) 253 { 254 return (len <= CARL9170FW_MAX_SIZE && len >= CARL9170FW_MIN_SIZE); 255 } 256 257 #endif /* __CARL9170_SHARED_FWDESC_H */ 258