tools/src/fwinfo.c

   1 /*
   2  * Copyright 2010, Christian Lamparter <chunkeey@googlemail.com>
   3  *
   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.
   7  *
   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.
  12  *
  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.
  16  */
  17
  18 #include <stdlib.h>
  19 #include <stdio.h>
  20 #include <error.h>
  21 #include <string.h>
  22 #include <errno.h>
  23 #include <sys/types.h>
  24 #include <sys/stat.h>
  25 #include <unistd.h>
  26 #include <ctype.h>
  27
  28 #include "carlfw.h"
  29
  30 #include "compiler.h"
  31
  32 struct feature_list {
  33         unsigned int id;
  34         char name[64];
  35         void (*func)(const struct carl9170fw_desc_head *, struct carlfw *fw);
  36 };
  37
  38 #define CHECK_FOR_FEATURE(feature_enum)                                 \
  39         { .id = feature_enum, .name = #feature_enum, .func = NULL }
  40
  41 #define CHECK_FOR_FEATURE_FUNC(feature_enum, _func)                     \
  42         { .id = feature_enum, .name = #feature_enum, .func = _func }
  43
  44 static void show_miniboot_info(const struct carl9170fw_desc_head *head,
  45                                struct carlfw *fw __unused)
  46 {
  47         const struct carl9170fw_otus_desc *otus = (const void *) head;
  48
  49         fprintf(stdout, "\t\t\tminiboot size: %d Bytes\n", otus->miniboot_size);
  50 }
  51
  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 };
  68
  69 static void check_feature_list(const struct carl9170fw_desc_head *head,
  70                                const __le32 bitmap,
  71                                const struct feature_list *list,
  72                                const unsigned int entries,
  73                                struct carlfw *fw)
  74 {
  75         unsigned int i;
  76
  77         for (i = 0; i < entries; i++) {
  78                 if (!carl9170fw_supports(bitmap, list[i].id))
  79                         continue;
  80
  81                 fprintf(stdout, "\t\t%2d = %s\n", list[i].id, list[i].name);
  82                 if (list[i].func)
  83                         list[i].func(head, fw);
  84         }
  85 }
  86
  87 static void show_otus_desc(const struct carl9170fw_desc_head *head,
  88                            struct carlfw *fw)
  89 {
  90         const struct carl9170fw_otus_desc *otus = (const void *) head;
  91
  92         BUILD_BUG_ON(ARRAY_SIZE(known_otus_features_v1) != __CARL9170FW_FEATURE_NUM);
  93
  94         fprintf(stdout, "\tFirmware upload pointer: 0x%x\n",
  95                 otus->fw_address);
  96         fprintf(stdout, "\tBeacon Address: %x, (reserved:%d Bytes)\n",
  97                 le32_to_cpu(otus->bcn_addr), le16_to_cpu(otus->bcn_len));
  98         fprintf(stdout, "\tTX DMA chunk size:%d Bytes, TX DMA chunks:%d\n",
  99                 otus->tx_frag_len, otus->tx_descs);
 100         fprintf(stdout, "\t=> %d Bytes are reserved for the TX queues\n",
 101                 otus->tx_frag_len * otus->tx_descs);
 102         fprintf(stdout, "\tCommand response buffers:%d\n", otus->cmd_bufs);
 103         fprintf(stdout, "\tMax. RX stream block size:%d Bytes\n",
 104                 otus->rx_max_frame_len);
 105         fprintf(stdout, "\tSupported Firmware Interfaces: %d\n", otus->vif_num);
 106         fprintf(stdout, "\tFirmware API Version: %d\n", otus->api_ver);
 107         fprintf(stdout, "\tSupported Features: (raw:%.08x)\n",
 108                 le32_to_cpu(otus->feature_set));
 109
 110         check_feature_list(head, otus->feature_set, known_otus_features_v1,
 111                            ARRAY_SIZE(known_otus_features_v1), fw);
 112 }
 113
 114 static void show_motd_desc(const struct carl9170fw_desc_head *head,
 115                            struct carlfw *fw __unused)
 116 {
 117         const struct carl9170fw_motd_desc *motd = (const void *) head;
 118         char buf[CARL9170FW_MOTD_STRING_LEN];
 119         unsigned int fw_date;
 120
 121         fw_date = motd->fw_year_month_day;
 122         fprintf(stdout, "\tFirmware Build Date (YYYY-MM-DD): 2%03d-%02d-%02d\n",
 123                 CARL9170FW_GET_YEAR(fw_date), CARL9170FW_GET_MONTH(fw_date),
 124                 CARL9170FW_GET_DAY(fw_date));
 125
 126         strncpy(buf, motd->desc, CARL9170FW_MOTD_STRING_LEN);
 127         fprintf(stdout, "\tFirmware Text:\"%s\"\n", buf);
 128
 129         strncpy(buf, motd->release, CARL9170FW_MOTD_STRING_LEN);
 130         fprintf(stdout, "\tFirmware Release:\"%s\"\n", buf);
 131 }
 132
 133 static void show_fix_desc(const struct carl9170fw_desc_head *head,
 134                           struct carlfw *fw __unused)
 135 {
 136         const struct carl9170fw_fix_desc *fix = (const void *) head;
 137         const struct carl9170fw_fix_entry *iter;
 138         unsigned int i;
 139
 140         for (i = 0; i < (head->length - sizeof(*head)) / sizeof(*iter); i++) {
 141                 iter = &fix->data[i];
 142                 fprintf(stdout, "\t\t%d: 0x%.8x := 0x%.8x (0x%.8x)\n", i,
 143                         le32_to_cpu(iter->address), le32_to_cpu(iter->value),
 144                         le32_to_cpu(iter->mask));
 145         }
 146 }
 147
 148 static void show_dbg_desc(const struct carl9170fw_desc_head *head,
 149                             struct carlfw *fw __unused)
 150 {
 151         const struct carl9170fw_dbg_desc *dbg = (const void *) head;
 152
 153 #define DBG_ADDR(_name, _reg) do {                                      \
 154         unsigned int __tmp = le32_to_cpu(dbg->_reg);                    \
 155         if (__tmp)                                                      \
 156                 fprintf(stdout, "\t\t" _name " = 0x%.8x\n", __tmp);     \
 157         } while (0);
 158
 159         fprintf(stdout, "\tFirmware Debug Registers/Counters\n");
 160         DBG_ADDR("bogoclock    ", bogoclock_addr);
 161         DBG_ADDR("counter      ", counter_addr);
 162         DBG_ADDR("rx total     ", rx_total_addr);
 163         DBG_ADDR("rx overrun   ", rx_overrun_addr);
 164         DBG_ADDR("rx filer     ", rx_filter);
 165 }
 166
 167 static void show_chk_desc(const struct carl9170fw_desc_head *head,
 168                             struct carlfw *fw __unused)
 169 {
 170         const struct carl9170fw_chk_desc *chk = (const void *) head;
 171
 172         fprintf(stdout, "\tFirmware Descriptor CRC32: %08x\n",
 173                 le32_to_cpu(chk->hdr_crc32));
 174         fprintf(stdout, "\tFirmware Image CRC32: %08x\n",
 175                 le32_to_cpu(chk->fw_crc32));
 176 }
 177
 178 static void show_last_desc(const struct carl9170fw_desc_head *head,
 179                            struct carlfw *fw __unused)
 180
 181 {
 182         const struct carl9170fw_last_desc *last __unused = (const void *) head;
 183
 184         /* Nothing here */
 185 }
 186
 187 #define ADD_HANDLER(_magic, _func)                              \
 188         {                                                       \
 189           .magic = _magic##_MAGIC,                              \
 190           .min_ver = CARL9170FW_## _magic##_DESC_CUR_VER,       \
 191           .func = _func,                                        \
 192           .size = CARL9170FW_## _magic##_DESC_SIZE,             \
 193         }
 194
 195 static const struct {
 196         uint8_t magic[4];
 197         uint8_t min_ver;
 198         void (*func)(const struct carl9170fw_desc_head *, struct carlfw *);
 199         uint16_t size;
 200 } known_magics[] = {
 201         ADD_HANDLER(OTUS, show_otus_desc),
 202         ADD_HANDLER(MOTD, show_motd_desc),
 203         ADD_HANDLER(DBG, show_dbg_desc),
 204         ADD_HANDLER(FIX, show_fix_desc),
 205         ADD_HANDLER(CHK, show_chk_desc),
 206         ADD_HANDLER(LAST, show_last_desc),
 207 };
 208
 209 static const uint8_t otus_magic[4] = { OTUS_MAGIC };
 210
 211 static void show_desc_head(struct carl9170fw_desc_head *head)
 212 {
 213 #define P(c) (isprint(c) ? c :  ' ')
 214
 215         fprintf(stdout, ">\t%c%c%c%c Descriptor: size:%d, compatible:%d, "
 216                         "version:%d\n",
 217                 P(head->magic[0]), P(head->magic[1]), P(head->magic[2]),
 218                 P(head->magic[3]), le16_to_cpu(head->length), head->min_ver,
 219                 head->cur_ver);
 220 }
 221
 222 static void fwinfo_info(void)
 223 {
 224         fprintf(stderr, "Usage:\n");
 225         fprintf(stderr, "\tfwinfo FW-FILE\n");
 226
 227         fprintf(stderr, "\nDescription:\n");
 228         fprintf(stderr, "\tDisplay firmware descriptors information in "
 229                         "a human readable form.\n");
 230
 231         fprintf(stderr, "\nParameteres:\n");
 232         fprintf(stderr, "\t 'FW-FILE'   = firmware file/base-name\n\n");
 233 }
 234
 235 int main(int argc, char *args[])
 236 {
 237         struct carlfw *fw = NULL;
 238         struct carl9170fw_desc_head *fw_desc;
 239         unsigned int i;
 240         int err = 0;
 241         size_t len;
 242
 243         if (argc != 2) {
 244                 err = -EINVAL;
 245                 goto out;
 246         }
 247
 248         fw = carlfw_load(args[1]);
 249         if (IS_ERR_OR_NULL(fw)) {
 250                 err = PTR_ERR(fw);
 251                 fprintf(stderr, "Failed to open firmware \"%s\" (%d).\n",
 252                         args[1], err);
 253                 goto out;
 254         }
 255
 256         carlfw_get_fw(fw, &len);
 257         fprintf(stdout, "General Firmware Statistics:\n");
 258         fprintf(stdout, "\tFirmware file size: %u Bytes\n", len);
 259         fprintf(stdout, "\t%d Descriptors in %d Bytes\n",
 260                 carlfw_get_descs_num(fw), carlfw_get_descs_size(fw));
 261
 262         fw_desc = NULL;
 263         fprintf(stdout, "\nDetailed Descriptor Description:\n");
 264         while ((fw_desc = carlfw_desc_next(fw, fw_desc))) {
 265                 show_desc_head(fw_desc);
 266
 267                 for (i = 0; i < ARRAY_SIZE(known_magics); i++) {
 268                         if (carl9170fw_desc_cmp(fw_desc, known_magics[i].magic,
 269                             known_magics[i].size, known_magics[i].min_ver)) {
 270                                 known_magics[i].func(fw_desc, fw);
 271                                 break;
 272                         }
 273                 }
 274
 275                 if (i == ARRAY_SIZE(known_magics))
 276                         fprintf(stderr, "Unknown Descriptor.\n");
 277
 278                 fprintf(stdout, "\n");
 279         }
 280
 281 out:
 282         switch (err) {
 283         case 0:
 284                 break;
 285
 286         case -EINVAL:
 287                 fwinfo_info();
 288                 break;
 289
 290         default:
 291                 fprintf(stderr, "%s\n", strerror(-err));
 292                 break;
 293         }
 294
 295         carlfw_release(fw);
 296         return err ? EXIT_FAILURE : EXIT_SUCCESS;
 297 }