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>
35 void (*func)(const struct carl9170fw_desc_head *, struct carlfw *fw);
38 #define CHECK_FOR_FEATURE(feature_enum) \
39 { .id = feature_enum, .name = #feature_enum, .func = NULL }
41 #define CHECK_FOR_FEATURE_FUNC(feature_enum, _func) \
42 { .id = feature_enum, .name = #feature_enum, .func = _func }
44 static void show_miniboot_info(const struct carl9170fw_desc_head *head,
45 struct carlfw *fw __unused)
47 const struct carl9170fw_otus_desc *otus = (const void *) head;
49 fprintf(stdout, "\t\t\tminiboot size: %d Bytes\n", otus->miniboot_size);
52 static const struct feature_list known_otus_features_v1[] = {
53 CHECK_FOR_FEATURE(CARL9170FW_DUMMY_FEATURE),
54 CHECK_FOR_FEATURE_FUNC(CARL9170FW_MINIBOOT, show_miniboot_info),
55 CHECK_FOR_FEATURE(CARL9170FW_USB_INIT_FIRMWARE),
56 CHECK_FOR_FEATURE(CARL9170FW_USB_RESP_EP2),
57 CHECK_FOR_FEATURE(CARL9170FW_USB_DOWN_STREAM),
58 CHECK_FOR_FEATURE(CARL9170FW_USB_UP_STREAM),
59 CHECK_FOR_FEATURE(CARL9170FW_UNUSABLE),
60 CHECK_FOR_FEATURE(CARL9170FW_COMMAND_PHY),
61 CHECK_FOR_FEATURE(CARL9170FW_COMMAND_CAM),
62 CHECK_FOR_FEATURE(CARL9170FW_WLANTX_CAB),
63 CHECK_FOR_FEATURE(CARL9170FW_HANDLE_BACK_REQ),
64 CHECK_FOR_FEATURE(CARL9170FW_GPIO_INTERRUPT),
65 CHECK_FOR_FEATURE(CARL9170FW_PSM),
66 CHECK_FOR_FEATURE(CARL9170FW_RX_FILTER),
67 CHECK_FOR_FEATURE(CARL9170FW_WOL),
70 static void check_feature_list(const struct carl9170fw_desc_head *head,
72 const struct feature_list *list,
73 const unsigned int entries,
78 for (i = 0; i < entries; i++) {
79 if (!carl9170fw_supports(bitmap, list[i].id))
82 fprintf(stdout, "\t\t%2d = %s\n", list[i].id, list[i].name);
84 list[i].func(head, fw);
88 static void show_otus_desc(const struct carl9170fw_desc_head *head,
91 const struct carl9170fw_otus_desc *otus = (const void *) head;
93 BUILD_BUG_ON(ARRAY_SIZE(known_otus_features_v1) != __CARL9170FW_FEATURE_NUM);
95 fprintf(stdout, "\tFirmware upload pointer: 0x%x\n",
97 fprintf(stdout, "\tBeacon Address: %x, (reserved:%d Bytes)\n",
98 le32_to_cpu(otus->bcn_addr), le16_to_cpu(otus->bcn_len));
99 fprintf(stdout, "\tTX DMA chunk size:%d Bytes, TX DMA chunks:%d\n",
100 otus->tx_frag_len, otus->tx_descs);
101 fprintf(stdout, "\t=> %d Bytes are reserved for the TX queues\n",
102 otus->tx_frag_len * otus->tx_descs);
103 fprintf(stdout, "\tCommand response buffers:%d\n", otus->cmd_bufs);
104 fprintf(stdout, "\tMax. RX stream block size:%d Bytes\n",
105 otus->rx_max_frame_len);
106 fprintf(stdout, "\tSupported Firmware Interfaces: %d\n", otus->vif_num);
107 fprintf(stdout, "\tFirmware API Version: %d\n", otus->api_ver);
108 fprintf(stdout, "\tSupported Features: (raw:%.08x)\n",
109 le32_to_cpu(otus->feature_set));
111 check_feature_list(head, otus->feature_set, known_otus_features_v1,
112 ARRAY_SIZE(known_otus_features_v1), fw);
115 static void show_motd_desc(const struct carl9170fw_desc_head *head,
116 struct carlfw *fw __unused)
118 const struct carl9170fw_motd_desc *motd = (const void *) head;
119 char buf[CARL9170FW_MOTD_STRING_LEN];
120 unsigned int fw_date;
122 fw_date = motd->fw_year_month_day;
123 fprintf(stdout, "\tFirmware Build Date (YYYY-MM-DD): 2%03d-%02d-%02d\n",
124 CARL9170FW_GET_YEAR(fw_date), CARL9170FW_GET_MONTH(fw_date),
125 CARL9170FW_GET_DAY(fw_date));
127 strncpy(buf, motd->desc, CARL9170FW_MOTD_STRING_LEN);
128 fprintf(stdout, "\tFirmware Text:\"%s\"\n", buf);
130 strncpy(buf, motd->release, CARL9170FW_MOTD_STRING_LEN);
131 fprintf(stdout, "\tFirmware Release:\"%s\"\n", buf);
134 static void show_fix_desc(const struct carl9170fw_desc_head *head,
135 struct carlfw *fw __unused)
137 const struct carl9170fw_fix_desc *fix = (const void *) head;
138 const struct carl9170fw_fix_entry *iter;
141 for (i = 0; i < (head->length - sizeof(*head)) / sizeof(*iter); i++) {
142 iter = &fix->data[i];
143 fprintf(stdout, "\t\t%d: 0x%.8x := 0x%.8x (0x%.8x)\n", i,
144 le32_to_cpu(iter->address), le32_to_cpu(iter->value),
145 le32_to_cpu(iter->mask));
149 static void show_dbg_desc(const struct carl9170fw_desc_head *head,
150 struct carlfw *fw __unused)
152 const struct carl9170fw_dbg_desc *dbg = (const void *) head;
154 #define DBG_ADDR(_name, _reg) do { \
155 unsigned int __tmp = le32_to_cpu(dbg->_reg); \
157 fprintf(stdout, "\t\t" _name " = 0x%.8x\n", __tmp); \
160 fprintf(stdout, "\tFirmware Debug Registers/Counters\n");
161 DBG_ADDR("bogoclock ", bogoclock_addr);
162 DBG_ADDR("counter ", counter_addr);
163 DBG_ADDR("rx total ", rx_total_addr);
164 DBG_ADDR("rx overrun ", rx_overrun_addr);
165 DBG_ADDR("rx filer ", rx_filter);
168 static void show_txsq_desc(const struct carl9170fw_desc_head *head,
169 struct carlfw *fw __unused)
171 const struct carl9170fw_txsq_desc *txsq = (const void *) head;
173 fprintf(stdout, "\t\ttx-seq table addr: 0x%x\n",
174 le32_to_cpu(txsq->seq_table_addr));
177 static void show_chk_desc(const struct carl9170fw_desc_head *head,
178 struct carlfw *fw __unused)
180 const struct carl9170fw_chk_desc *chk = (const void *) head;
182 fprintf(stdout, "\tFirmware Descriptor CRC32: %08x\n",
183 le32_to_cpu(chk->hdr_crc32));
184 fprintf(stdout, "\tFirmware Image CRC32: %08x\n",
185 le32_to_cpu(chk->fw_crc32));
188 static void show_last_desc(const struct carl9170fw_desc_head *head,
189 struct carlfw *fw __unused)
192 const struct carl9170fw_last_desc *last __unused = (const void *) head;
197 #define ADD_HANDLER(_magic, _func) \
199 .magic = _magic##_MAGIC, \
200 .min_ver = CARL9170FW_## _magic##_DESC_CUR_VER, \
202 .size = CARL9170FW_## _magic##_DESC_SIZE, \
205 static const struct {
208 void (*func)(const struct carl9170fw_desc_head *, struct carlfw *);
211 ADD_HANDLER(OTUS, show_otus_desc),
212 ADD_HANDLER(TXSQ, show_txsq_desc),
213 ADD_HANDLER(MOTD, show_motd_desc),
214 ADD_HANDLER(DBG, show_dbg_desc),
215 ADD_HANDLER(FIX, show_fix_desc),
216 ADD_HANDLER(CHK, show_chk_desc),
217 ADD_HANDLER(LAST, show_last_desc),
220 static const uint8_t otus_magic[4] = { OTUS_MAGIC };
222 static void show_desc_head(struct carl9170fw_desc_head *head)
224 #define P(c) (isprint(c) ? c : ' ')
226 fprintf(stdout, ">\t%c%c%c%c Descriptor: size:%d, compatible:%d, "
228 P(head->magic[0]), P(head->magic[1]), P(head->magic[2]),
229 P(head->magic[3]), le16_to_cpu(head->length), head->min_ver,
233 static void fwinfo_info(void)
235 fprintf(stderr, "Usage:\n");
236 fprintf(stderr, "\tfwinfo FW-FILE\n");
238 fprintf(stderr, "\nDescription:\n");
239 fprintf(stderr, "\tDisplay firmware descriptors information in "
240 "a human readable form.\n");
242 fprintf(stderr, "\nParameteres:\n");
243 fprintf(stderr, "\t 'FW-FILE' = firmware file/base-name\n\n");
246 int main(int argc, char *args[])
248 struct carlfw *fw = NULL;
249 struct carl9170fw_desc_head *fw_desc;
259 fw = carlfw_load(args[1]);
260 if (IS_ERR_OR_NULL(fw)) {
262 fprintf(stderr, "Failed to open firmware \"%s\" (%d).\n",
267 carlfw_get_fw(fw, &len);
268 fprintf(stdout, "General Firmware Statistics:\n");
269 fprintf(stdout, "\tFirmware file size: %u Bytes\n", (unsigned int)len);
270 fprintf(stdout, "\t%d Descriptors in %d Bytes\n",
271 carlfw_get_descs_num(fw), carlfw_get_descs_size(fw));
274 fprintf(stdout, "\nDetailed Descriptor Description:\n");
275 while ((fw_desc = carlfw_desc_next(fw, fw_desc))) {
276 show_desc_head(fw_desc);
278 for (i = 0; i < ARRAY_SIZE(known_magics); i++) {
279 if (carl9170fw_desc_cmp(fw_desc, known_magics[i].magic,
280 known_magics[i].size, known_magics[i].min_ver)) {
281 known_magics[i].func(fw_desc, fw);
286 if (i == ARRAY_SIZE(known_magics))
287 fprintf(stderr, "Unknown Descriptor.\n");
289 fprintf(stdout, "\n");
302 fprintf(stderr, "%s\n", strerror(-err));
307 return err ? EXIT_FAILURE : EXIT_SUCCESS;