tools/src/fwinfo.c

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