tools/firmware-utils/src/zynos.h

   1 /*
   2  *  $Id$
   3  *
   4  *  Copyright (C) 2007-2008 OpenWrt.org
   5  *  Copyright (C) 2007-2008 Gabor Juhos <juhosg at openwrt.org>
   6  *
   7  *  This code was based on the information of the ZyXEL's firmware
   8  *  image format written by Kolja Waschk, can be found at:
   9  *  http://www.ixo.de/info/zyxel_uclinux
  10  *
  11  *  This program is free software; you can redistribute it and/or modify it
  12  *  under the terms of the GNU General Public License version 2 as published
  13  *  by the Free Software Foundation.
  14  *
  15  */
  16
  17 #ifndef _ZYNOS_H
  18 #define _ZYNOS_H
  19
  20 #define BOOTBASE_NAME_LEN       32
  21 #define BOOTBASE_MAC_LEN        6
  22 #define BOOTBASE_FEAT_LEN       22
  23
  24 #define BOOTEXT_DEF_SIZE        0x18000
  25
  26 struct zyn_bootbase_info {
  27         char            vendor[BOOTBASE_NAME_LEN]; /* Vendor name */
  28         char            model[BOOTBASE_NAME_LEN]; /* Model name */
  29         uint32_t        bootext_addr;   /* absolute address of the Boot Extension */
  30         uint16_t        res0;           /* reserved/unknown */
  31         uint8_t         sys_type;       /* system type */
  32         uint8_t         res1;           /* reserved/unknown */
  33         uint16_t        model_id;       /* model id */
  34         uint8_t         feat_other[BOOTBASE_FEAT_LEN]; /* other feature bits */
  35         uint8_t         feat_main;      /* main feature bits */
  36         uint8_t         res2;           /* reserved/unknown */
  37         uint8_t         mac[BOOTBASE_MAC_LEN]; /* mac address */
  38         uint8_t         country;        /* default country code */
  39         uint8_t         dbgflag;        /* debug flag */
  40 } __attribute__((packed));
  41
  42 #define ROMBIN_SIG_LEN  3
  43 #define ROMBIN_VER_LEN  15
  44
  45 struct zyn_rombin_hdr {
  46         uint32_t        addr;           /* load address of the object */
  47         uint16_t        res0;           /* unknown/unused */
  48         char            sig[ROMBIN_SIG_LEN];    /* magic, must be "SIG" */
  49         uint8_t         type;           /* type of the object */
  50         uint32_t        osize;          /* size of the uncompressed data */
  51         uint32_t        csize;          /* size of the compressed data */
  52         uint8_t         flags;          /* various flags */
  53         uint8_t         res1;           /* unknown/unused */
  54         uint16_t        ocsum;          /* csum of the uncompressed data */
  55         uint16_t        ccsum;          /* csum of the compressed data */
  56         char            ver[ROMBIN_VER_LEN];
  57         uint32_t        mmap_addr;      /* address of the Memory Map Table*/
  58         uint32_t        res2;           /* unknown/unused*/
  59         uint8_t         res3;           /* unknown/unused*/
  60 } __attribute__((packed));
  61
  62 #define ROMBIN_SIGNATURE        "SIG"
  63
  64 /* Rombin flag bits */
  65 #define ROMBIN_FLAG_01          0x01
  66 #define ROMBIN_FLAG_02          0x02
  67 #define ROMBIN_FLAG_04          0x04
  68 #define ROMBIN_FLAG_08          0x08
  69 #define ROMBIN_FLAG_10          0x10
  70 #define ROMBIN_FLAG_CCSUM       0x20    /* compressed checksum is valid */
  71 #define ROMBIN_FLAG_OCSUM       0x40    /* original checksum is valid */
  72 #define ROMBIN_FLAG_COMPRESSED  0x80    /* the binary is compressed */
  73
  74 /* Object types */
  75 #define OBJECT_TYPE_ROMIMG      0x01
  76 #define OBJECT_TYPE_ROMBOOT     0x02
  77 #define OBJECT_TYPE_BOOTEXT     0x03
  78 #define OBJECT_TYPE_ROMBIN      0x04
  79 #define OBJECT_TYPE_ROMDIR      0x05
  80 #define OBJECT_TYPE_6           0x06
  81 #define OBJECT_TYPE_ROMMAP      0x07
  82 #define OBJECT_TYPE_RAM         0x80
  83 #define OBJECT_TYPE_RAMCODE     0x81
  84 #define OBJECT_TYPE_RAMBOOT     0x82
  85
  86 /*
  87  * Memory Map Table header
  88  */
  89 struct zyn_mmt_hdr {
  90         uint16_t        count;
  91         uint32_t        user_start;
  92         uint32_t        user_end;
  93         uint16_t        csum;
  94         uint8_t         res[12];
  95 } __attribute__((packed));
  96
  97 #define OBJECT_NAME_LEN         8
  98
  99 struct zyn_mmt_item {
 100         uint8_t         type;   /* type of the object */
 101         uint8_t         name[OBJECT_NAME_LEN]; /* name of the object */
 102         uint8_t         res0;   /* unused/unknown */
 103         uint32_t        addr;
 104         uint32_t        size;   /* size of the object */
 105         uint8_t         res1[3]; /* unused/unknown */
 106         uint8_t         type2;
 107 } __attribute__((packed));
 108
 109 /*
 110  * Vendor IDs
 111  */
 112 #define ZYNOS_VENDOR_ID_ZYXEL   0
 113 #define ZYNOS_VENDOR_ID_NETGEAR 1
 114 #define ZYNOS_VENDOR_ID_DLINK   2
 115 #define ZYNOS_VENDOR_ID_03      3
 116 #define ZYNOS_VENDOR_ID_LUCENT  4
 117 #define ZYNOS_VENDOR_ID_O2      10
 118
 119 /*
 120  * Model IDs (in big-endian format)
 121  */
 122 #define MID(x)  (((x) & 0xFF) << 8) | (((x) & 0xFF00) >> 8)
 123
 124 /*
 125  * Infineon/ADMtek ADM5120 based models
 126  */
 127 #define ZYNOS_MODEL_ES_2024A            MID(  221)
 128 #define ZYNOS_MODEL_ES_2024PWR          MID( 4097)
 129 #define ZYNOS_MODEL_ES_2108             MID(61952)
 130 #define ZYNOS_MODEL_ES_2108_F           MID(44801)
 131 #define ZYNOS_MODEL_ES_2108_G           MID(62208)
 132 #define ZYNOS_MODEL_ES_2108_LC          MID(64512)
 133 #define ZYNOS_MODEL_ES_2108PWR          MID(62464)
 134 #define ZYNOS_MODEL_HS_100              MID(61855)
 135 #define ZYNOS_MODEL_HS_100W             ZYNOS_MODEL_HS_100
 136 #define ZYNOS_MODEL_P_334               MID(62879)
 137 #define ZYNOS_MODEL_P_334U              MID(56735)
 138 #define ZYNOS_MODEL_P_334W              MID(62367)
 139 #define ZYNOS_MODEL_P_334WH             MID(57344)
 140 #define ZYNOS_MODEL_P_334WHD            MID(57600)
 141 #define ZYNOS_MODEL_P_334WT             MID(61343)
 142 #define ZYNOS_MODEL_P_335               MID(60831)
 143 #define ZYNOS_MODEL_P_335PLUS           MID( 9472)
 144 #define ZYNOS_MODEL_P_335U              MID(56479)
 145 #define ZYNOS_MODEL_P_335WT             ZYNOS_MODEL_P_335
 146
 147 /*
 148  * Texas Instruments AR7 based models
 149  */
 150 #define ZYNOS_MODEL_P_2602H_61C         MID( 3229)
 151 #define ZYNOS_MODEL_P_2602H_63C         MID( 3485)
 152 #define ZYNOS_MODEL_P_2602H_D1A         /* n.a. */
 153 #define ZYNOS_MODEL_P_2602H_D3A         /* n.a. */
 154 #define ZYNOS_MODEL_P_2602HW_61C        /* n.a. */
 155 #define ZYNOS_MODEL_P_2602HW_63         /* n.a. */
 156 #define ZYNOS_MODEL_P_2602HW_63C        ZYNOS_MODEL_P_2602H_63C
 157 #define ZYNOS_MODEL_P_2602HW_D1A        MID( 6301)
 158 #define ZYNOS_MODEL_P_2602HW_D3A        /* n.a. */
 159 #define ZYNOS_MODEL_P_2602HWL_61        MID( 1181)
 160 #define ZYNOS_MODEL_P_2602HWL_61C       ZYNOS_MODEL_P_2602H_61C
 161 #define ZYNOS_MODEL_P_2602HWL_63C       ZYNOS_MODEL_P_2602H_63C
 162 #define ZYNOS_MODEL_P_2602HWL_D1A       ZYNOS_MODEL_P_2602HW_D1A
 163 #define ZYNOS_MODEL_P_2602HWL_D3A       MID( 7581)
 164 #define ZYNOS_MODEL_P_2602HWN_D7A       MID(30464)
 165 #define ZYNOS_MODEL_P_2602HWNLI_D7A     MID( 6813)
 166
 167 #define ZYNOS_MODEL_P_2602R_61          MID( 2205)
 168 #define ZYNOS_MODEL_P_2602R_63          MID( 3997)
 169 #define ZYNOS_MODEL_P_2602R_D1A         /* n.a. */
 170 #define ZYNOS_MODEL_P_2602R_D3A         /* n.a. */
 171 #define ZYNOS_MODEL_P_2602RL_D1A        MID( 6045)
 172 #define ZYNOS_MODEL_P_2602RL_D3A        MID( 7069)
 173
 174 #define ZYNOS_MODEL_P_660H_61           MID(19346)
 175 #define ZYNOS_MODEL_P_660H_63           MID(22162)
 176 #define ZYNOS_MODEL_P_660H_67           /* n.a. */
 177 #define ZYNOS_MODEL_P_660H_D1           MID( 7066)
 178 #define ZYNOS_MODEL_P_660H_D3           MID(13210)
 179
 180 #define ZYNOS_MODEL_P_660HW_61          ZYNOS_MODEL_P_660H_61
 181 #define ZYNOS_MODEL_P_660HW_63          ZYNOS_MODEL_P_660H_63
 182 #define ZYNOS_MODEL_P_660HW_67          ZYNOS_MODEL_P_660HW_63
 183 #define ZYNOS_MODEL_P_660HW_D1          MID( 9114)
 184 #define ZYNOS_MODEL_P_660HW_D3          MID(12698)
 185
 186 #define ZYNOS_MODEL_P_660R_61           MID(20882)
 187 #define ZYNOS_MODEL_P_660R_61C          MID( 1178)
 188 #define ZYNOS_MODEL_P_660R_63           MID(21138)
 189 #define ZYNOS_MODEL_P_660R_63C          MID(  922)
 190 #define ZYNOS_MODEL_P_660R_67           ZYNOS_MODEL_P_660R_63
 191 #define ZYNOS_MODEL_P_660R_67C          /* n.a. */
 192 #define ZYNOS_MODEL_P_660R_D1           MID( 7322)
 193 #define ZYNOS_MODEL_P_660R_D3           MID(10138)
 194
 195 #define ZYNOS_MODEL_P_661H_61           MID(19346)
 196 #define ZYNOS_MODEL_P_661H_63           MID( 1946)
 197 #define ZYNOS_MODEL_P_661H_D1           MID(10650)
 198 #define ZYNOS_MODEL_P_661H_D3           MID(12442)
 199
 200 #define ZYNOS_MODEL_P_661HW_61          ZYNOS_MODEL_P_661H_61
 201 #define ZYNOS_MODEL_P_661HW_63          ZYNOS_MODEL_P_661H_63
 202 #define ZYNOS_MODEL_P_661HW_D1          MID(10906)
 203 #define ZYNOS_MODEL_P_661HW_D3          MID(14746)
 204
 205 #define ZYNOS_MODEL_P_662H_61           MID(22418)
 206 #define ZYNOS_MODEL_P_662H_63           /* n.a. */
 207 #define ZYNOS_MODEL_P_662H_67           /* n.a. */
 208 #define ZYNOS_MODEL_P_662H_D1           /* n.a. */
 209 #define ZYNOS_MODEL_P_662H_D3           /* n.a. */
 210
 211 #define ZYNOS_MODEL_P_662HW_61          /* n.a. */
 212 #define ZYNOS_MODEL_P_662HW_63          MID(22674)
 213 #define ZYNOS_MODEL_P_662HW_67          /* n.a. */
 214 #define ZYNOS_MODEL_P_662HW_D1          MID(10394)
 215 #define ZYNOS_MODEL_P_662HW_D3          MID(12954)
 216
 217 /* OEM boards */
 218 #define ZYNOS_MODEL_O2SURF              ZYNOS_MODEL_P_2602HWN_D7A
 219
 220 /* Atheros AR2318 based boards */
 221 #define ZYNOS_MODEL_NBG_318S            MID(59392)
 222
 223 #endif /* _ZYNOS_H */