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