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