2 * Copyright 2010-2011 Christian Lamparter <chunkeey@googlemail.com>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation version 2 of the License.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #include <sys/types.h>
36 void (*func)(const struct carl9170fw_desc_head *, struct carlfw *fw);
39 #define CHECK_FOR_FEATURE(feature_enum) \
40 { .id = feature_enum, .name = #feature_enum, .func = NULL }
42 #define CHECK_FOR_FEATURE_FUNC(feature_enum, _func) \
43 { .id = feature_enum, .name = #feature_enum, .func = _func }
45 static void show_miniboot_info(const struct carl9170fw_desc_head *head,
46 struct carlfw *fw __unused)
48 const struct carl9170fw_otus_desc *otus = (const void *) head;
50 fprintf(stdout, "\t\t\tminiboot size: %d Bytes\n", otus->miniboot_size);
53 static const struct feature_list known_otus_features_v1[] = {
54 CHECK_FOR_FEATURE(CARL9170FW_DUMMY_FEATURE),
55 CHECK_FOR_FEATURE_FUNC(CARL9170FW_MINIBOOT, show_miniboot_info),
56 CHECK_FOR_FEATURE(CARL9170FW_USB_INIT_FIRMWARE),
57 CHECK_FOR_FEATURE(CARL9170FW_USB_RESP_EP2),
58 CHECK_FOR_FEATURE(CARL9170FW_USB_DOWN_STREAM),
59 CHECK_FOR_FEATURE(CARL9170FW_USB_UP_STREAM),
60 CHECK_FOR_FEATURE(CARL9170FW_UNUSABLE),
61 CHECK_FOR_FEATURE(CARL9170FW_COMMAND_PHY),
62 CHECK_FOR_FEATURE(CARL9170FW_COMMAND_CAM),
63 CHECK_FOR_FEATURE(CARL9170FW_WLANTX_CAB),
64 CHECK_FOR_FEATURE(CARL9170FW_HANDLE_BACK_REQ),
65 CHECK_FOR_FEATURE(CARL9170FW_GPIO_INTERRUPT),
66 CHECK_FOR_FEATURE(CARL9170FW_PSM),
67 CHECK_FOR_FEATURE(CARL9170FW_RX_FILTER),
68 CHECK_FOR_FEATURE(CARL9170FW_WOL),
71 static void check_feature_list(const struct carl9170fw_desc_head *head,
73 const struct feature_list *list,
74 const unsigned int entries,
79 for (i = 0; i < entries; i++) {
80 if (!carl9170fw_supports(bitmap, list[i].id))
83 fprintf(stdout, "\t\t%2d = %s\n", list[i].id, list[i].name);
85 list[i].func(head, fw);
89 static void show_otus_desc(const struct carl9170fw_desc_head *head,
92 const struct carl9170fw_otus_desc *otus = (const void *) head;
94 BUILD_BUG_ON(ARRAY_SIZE(known_otus_features_v1) != __CARL9170FW_FEATURE_NUM);
96 fprintf(stdout, "\tFirmware upload pointer: 0x%x\n",
98 fprintf(stdout, "\tBeacon Address: %x, (reserved:%d Bytes)\n",
99 le32_to_cpu(otus->bcn_addr), le16_to_cpu(otus->bcn_len));
100 fprintf(stdout, "\tTX DMA chunk size:%d Bytes, TX DMA chunks:%d\n",
101 otus->tx_frag_len, otus->tx_descs);
102 fprintf(stdout, "\t=> %d Bytes are reserved for the TX queues\n",
103 otus->tx_frag_len * otus->tx_descs);
104 fprintf(stdout, "\tCommand response buffers:%d\n", otus->cmd_bufs);
105 fprintf(stdout, "\tMax. RX stream block size:%d Bytes\n",
106 otus->rx_max_frame_len);
107 fprintf(stdout, "\tSupported Firmware Interfaces: %d\n", otus->vif_num);
108 fprintf(stdout, "\tFirmware API Version: %d\n", otus->api_ver);
109 fprintf(stdout, "\tSupported Features: (raw:%.08x)\n",
110 le32_to_cpu(otus->feature_set));
112 check_feature_list(head, otus->feature_set, known_otus_features_v1,
113 ARRAY_SIZE(known_otus_features_v1), fw);
116 static void show_motd_desc(const struct carl9170fw_desc_head *head,
117 struct carlfw *fw __unused)
119 const struct carl9170fw_motd_desc *motd = (const void *) head;
120 char buf[CARL9170FW_MOTD_STRING_LEN];
121 unsigned int fw_date;
123 fw_date = motd->fw_year_month_day;
124 fprintf(stdout, "\tFirmware Build Date (YYYY-MM-DD): 2%03d-%02d-%02d\n",
125 CARL9170FW_GET_YEAR(fw_date), CARL9170FW_GET_MONTH(fw_date),
126 CARL9170FW_GET_DAY(fw_date));
128 strncpy(buf, motd->desc, CARL9170FW_MOTD_STRING_LEN);
129 fprintf(stdout, "\tFirmware Text:\"%s\"\n", buf);
131 strncpy(buf, motd->release, CARL9170FW_MOTD_STRING_LEN);
132 fprintf(stdout, "\tFirmware Release:\"%s\"\n", buf);
135 static void show_fix_desc(const struct carl9170fw_desc_head *head,
136 struct carlfw *fw __unused)
138 const struct carl9170fw_fix_desc *fix = (const void *) head;
139 const struct carl9170fw_fix_entry *iter;
142 for (i = 0; i < (head->length - sizeof(*head)) / sizeof(*iter); i++) {
143 iter = &fix->data[i];
144 fprintf(stdout, "\t\t%d: 0x%.8x := 0x%.8x (0x%.8x)\n", i,
145 le32_to_cpu(iter->address), le32_to_cpu(iter->value),
146 le32_to_cpu(iter->mask));
150 static void show_dbg_desc(const struct carl9170fw_desc_head *head,
151 struct carlfw *fw __unused)
153 const struct carl9170fw_dbg_desc *dbg = (const void *) head;
155 #define DBG_ADDR(_name, _reg) do { \
156 unsigned int __tmp = le32_to_cpu(dbg->_reg); \
158 fprintf(stdout, "\t\t" _name " = 0x%.8x\n", __tmp); \
161 fprintf(stdout, "\tFirmware Debug Registers/Counters\n");
162 DBG_ADDR("bogoclock ", bogoclock_addr);
163 DBG_ADDR("counter ", counter_addr);
164 DBG_ADDR("rx total ", rx_total_addr);
165 DBG_ADDR("rx overrun ", rx_overrun_addr);
166 DBG_ADDR("rx filer ", rx_filter);
169 static void show_txsq_desc(const struct carl9170fw_desc_head *head,
170 struct carlfw *fw __unused)
172 const struct carl9170fw_txsq_desc *txsq = (const void *) head;
174 fprintf(stdout, "\t\ttx-seq table addr: 0x%x\n",
175 le32_to_cpu(txsq->seq_table_addr));
179 static const struct feature_list wol_triggers_v1[] = {
180 CHECK_FOR_FEATURE(CARL9170_WOL_DISCONNECT),
181 CHECK_FOR_FEATURE(CARL9170_WOL_MAGIC_PKT),
184 static void show_wol_desc(const struct carl9170fw_desc_head *head,
185 struct carlfw *fw __unused)
187 const struct carl9170fw_wol_desc *wol = (const void *) head;
189 fprintf(stdout, "\tSupported WOWLAN triggers: (raw:%.08x)\n",
190 le32_to_cpu(wol->supported_triggers));
192 check_feature_list(head, wol->supported_triggers, wol_triggers_v1,
193 ARRAY_SIZE(wol_triggers_v1), fw);
196 static void show_chk_desc(const struct carl9170fw_desc_head *head,
197 struct carlfw *fw __unused)
199 const struct carl9170fw_chk_desc *chk = (const void *) head;
201 fprintf(stdout, "\tFirmware Descriptor CRC32: %08x\n",
202 le32_to_cpu(chk->hdr_crc32));
203 fprintf(stdout, "\tFirmware Image CRC32: %08x\n",
204 le32_to_cpu(chk->fw_crc32));
207 static void show_last_desc(const struct carl9170fw_desc_head *head,
208 struct carlfw *fw __unused)
211 const struct carl9170fw_last_desc *last __unused = (const void *) head;
216 #define ADD_HANDLER(_magic, _func) \
218 .magic = _magic##_MAGIC, \
219 .min_ver = CARL9170FW_## _magic##_DESC_CUR_VER, \
221 .size = CARL9170FW_## _magic##_DESC_SIZE, \
224 static const struct {
227 void (*func)(const struct carl9170fw_desc_head *, struct carlfw *);
230 ADD_HANDLER(OTUS, show_otus_desc),
231 ADD_HANDLER(TXSQ, show_txsq_desc),
232 ADD_HANDLER(MOTD, show_motd_desc),
233 ADD_HANDLER(DBG, show_dbg_desc),
234 ADD_HANDLER(FIX, show_fix_desc),
235 ADD_HANDLER(CHK, show_chk_desc),
236 ADD_HANDLER(WOL, show_wol_desc),
237 ADD_HANDLER(LAST, show_last_desc),
240 static const uint8_t otus_magic[4] = { OTUS_MAGIC };
242 static void show_desc_head(struct carl9170fw_desc_head *head)
244 #define P(c) (isprint(c) ? c : ' ')
246 fprintf(stdout, ">\t%c%c%c%c Descriptor: size:%d, compatible:%d, "
248 P(head->magic[0]), P(head->magic[1]), P(head->magic[2]),
249 P(head->magic[3]), le16_to_cpu(head->length), head->min_ver,
253 static void fwinfo_info(void)
255 fprintf(stderr, "Usage:\n");
256 fprintf(stderr, "\tfwinfo FW-FILE\n");
258 fprintf(stderr, "\nDescription:\n");
259 fprintf(stderr, "\tDisplay firmware descriptors information in "
260 "a human readable form.\n");
262 fprintf(stderr, "\nParameteres:\n");
263 fprintf(stderr, "\t 'FW-FILE' = firmware file/base-name\n\n");
266 int main(int argc, char *args[])
268 struct carlfw *fw = NULL;
269 struct carl9170fw_desc_head *fw_desc;
279 fw = carlfw_load(args[1]);
280 if (IS_ERR_OR_NULL(fw)) {
282 fprintf(stderr, "Failed to open firmware \"%s\" (%d).\n",
287 carlfw_get_fw(fw, &len);
288 fprintf(stdout, "General Firmware Statistics:\n");
289 fprintf(stdout, "\tFirmware file size: %u Bytes\n", (unsigned int)len);
290 fprintf(stdout, "\t%d Descriptors in %d Bytes\n",
291 carlfw_get_descs_num(fw), carlfw_get_descs_size(fw));
294 fprintf(stdout, "\nDetailed Descriptor Description:\n");
295 while ((fw_desc = carlfw_desc_next(fw, fw_desc))) {
296 show_desc_head(fw_desc);
298 for (i = 0; i < ARRAY_SIZE(known_magics); i++) {
299 if (carl9170fw_desc_cmp(fw_desc, known_magics[i].magic,
300 known_magics[i].size, known_magics[i].min_ver)) {
301 known_magics[i].func(fw_desc, fw);
306 if (i == ARRAY_SIZE(known_magics))
307 fprintf(stderr, "Unknown Descriptor.\n");
309 fprintf(stdout, "\n");
322 fprintf(stderr, "%s\n", strerror(-err));
327 return err ? EXIT_FAILURE : EXIT_SUCCESS;