Add airlink firmware generation tool, thanks to Vassily Galinsky for that !
[openwrt.git] / tools / firmware-utils / src / airlink.c
1 /*
2  * Thanks to Vassily Galinsky for this tool
3 *****************************************************************************
4 AIRLINK AR525W firmware image structure
5   -8:-5  Extended (httpd) header checksum  -       sum2
6   -4:-1  Extended (httpd) header magic     -       "ARRN" - 0x4e525241
7    0: 3  Standard (tftpd) header magic     -       "GMTK" - 0x4b544d47
8    4: 7  Standard (tftpd) header checksum  -       sum1
9    8: b  0
10    c: f  Size of compressed linux kernel
11   10:13  Size of firmware image file with standard header
12   14:17  Product code                      -       0x5
13   18:1b  Bootloader checksum               -       sum0
14   1c:1f  0
15   20:    Compressed linux kernel
16   -      Squashfs or jffs2 file system - kernel dependent - either 32 bytes or sector aligned 
17 *****************************************************************************/
18 #include <stdio.h>
19 #include <stdlib.h>
20 #include <unistd.h>
21 #include <sys/mman.h>
22 #include <sys/types.h>
23 #include <sys/stat.h>
24 #include <fcntl.h>
25
26 typedef unsigned long u32;
27 typedef unsigned char uchar;
28
29 u32 crctab[257] = {
30         0x00000000, 0x77073096, 0xee0e612c, 0x990951ba,
31         0x076dc419, 0x706af48f, 0xe963a535, 0x9e6495a3,
32         0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
33         0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91,
34         0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
35         0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
36         0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec,
37         0x14015c4f, 0x63066cd9, 0xfa0f3d63, 0x8d080df5,
38         0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172,
39         0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
40         0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940,
41         0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
42         0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116,
43         0x21b4f4b5, 0x56b3c423, 0xcfba9599, 0xb8bda50f,
44         0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
45         0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d,
46         0x76dc4190, 0x01db7106, 0x98d220bc, 0xefd5102a,
47         0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
48         0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818,
49         0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
50         0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e,
51         0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457,
52         0x65b0d9c6, 0x12b7e950, 0x8bbeb8ea, 0xfcb9887c,
53         0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
54         0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
55         0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb,
56         0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0,
57         0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9,
58         0x5005713c, 0x270241aa, 0xbe0b1010, 0xc90c2086,
59         0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
60         0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4,
61         0x59b33d17, 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad,
62         0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
63         0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683,
64         0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
65         0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
66         0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe,
67         0xf762575d, 0x806567cb, 0x196c3671, 0x6e6b06e7,
68         0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc,
69         0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
70         0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252,
71         0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
72         0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60,
73         0xdf60efc3, 0xa867df55, 0x316e8eef, 0x4669be79,
74         0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
75         0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f,
76         0xc5ba3bbe, 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04,
77         0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
78         0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a,
79         0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
80         0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
81         0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21,
82         0x86d3d2d4, 0xf1d4e242, 0x68ddb3f8, 0x1fda836e,
83         0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
84         0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
85         0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45,
86         0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2,
87         0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db,
88         0xaed16a4a, 0xd9d65adc, 0x40df0b66, 0x37d83bf0,
89         0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
90         0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6,
91         0xbad03605, 0xcdd70693, 0x54de5729, 0x23d967bf,
92         0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
93         0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d,
94         0
95 };
96
97 u32 header[] = {
98         0x00000000, 0x4e525241,
99         0x4b544d47, 0x00000000, 0x00000000, 0x000afd4a,
100         0x00000000, 0x00000005, 0x00000000, 0x00000000
101 };
102
103 static int JFFS2 = 0;
104
105 int generate_image(char *kname, char *fsname, char *fname, int EHDR)
106 {
107         int i;
108         u32 lenk, lens;
109         uchar *bk, *bs;
110         int fkd, ffd, fsd;
111         int pad = 0x1f;
112         fkd = open(kname, O_RDONLY);
113         ffd = creat(fname, 0x644);
114         if ((fkd < 0) || (ffd < 0))
115                 return -1;
116         if (fsname) {
117                 fsd = open(fsname, O_RDONLY);
118                 if (fsd < 0)
119                         return -1;
120         }
121         lenk = lseek(fkd, 0, SEEK_END);
122         header[5] = lenk;
123         bk = (uchar *) mmap(NULL, lenk, PROT_READ, MAP_SHARED, fkd, 0);
124         if (bk == MAP_FAILED)
125                 return -1;
126         if (fsname) {
127                 lens = lseek(fsd, 0, SEEK_END);
128                 bs = (uchar *) mmap(NULL, lens, PROT_READ, MAP_SHARED, fsd,
129                                     0);
130                 if (bs == MAP_FAILED)
131                         return -1;
132         }
133         if (EHDR)
134                 write(ffd, header, 0x28);
135         else
136                 write(ffd, header + 2, 0x20);
137         write(ffd, bk, lenk);
138         if (fsname && JFFS2)
139                 pad = 0xffff;
140         printf("Padding header+kernel - 0x%x +  0x%x = 0x%x\n",
141                lenk + 0x20, ((lenk + 0x20) | pad) + 1 - lenk - 0x20,
142                ((lenk + 0x20) | pad) + 1);
143         for (i = 0; i < ((lenk + 0x20) | pad) + 1 - lenk - 0x20; i++)
144                 write(ffd, header, 1);
145         if (fsname) {
146                 write(ffd, bs, lens);
147                 close(fsd);
148         }
149         close(ffd);
150         close(fkd);
151         return 0;
152 }
153
154 u32 crc32(uchar * buf, u32 len)
155 {
156         register int i;
157         u32 sum;
158         register u32 s0;
159         s0 = ~0;
160         for (i = 0; i < len; i++) {
161                 s0 = (s0 >> 8) ^ crctab[(uchar) (s0 & 0xFF) ^ buf[i]];
162         }
163         sum = ~s0;
164         return sum;
165 }
166
167 void usage(char *prog)
168 {
169         printf("Usage: %s [-b 0/1] image_filename \n", prog);
170         printf("       update checksums for firmware file\n");
171         printf
172             ("Usage: %s [-b 0/1] [-j] [-e] kernel filesystem image_filename \n",
173              prog);
174         printf("       generate firmware file and update checksums\n");
175         printf("--------------------------------------------------\n");
176         printf("       -e - generate header for web upload\n");
177         printf("       -j - generate header for jffs2 filesystem\n");
178         printf("       -b 0/1 - clear/update bootloader checksum\n");
179 }
180
181 int main(int argc, char **argv)
182 {
183         uchar b[0x400];
184         char EHDR = 0;
185         char BHDR = 0;
186         int c, fd;
187         extern char *optarg;
188         extern int optind, optopt;
189
190         while ((c = getopt(argc, argv, "b:e:j")) != -1) {
191                 switch (c) {
192                 case 'b':
193                         if (optarg[0] == '1')
194                                 BHDR = 1;
195                         break;
196                 case 'e':
197                         EHDR = 1;
198                         break;
199                 case 'j':
200                         JFFS2 = 1;
201                         break;
202                 case '?':
203                         fprintf(stderr, "\nError: unknown arg %c\n\n\n",
204                                 optopt);
205                         usage(argv[0]);
206                         exit(-1);
207                 }
208         }
209         if (((argc - optind) < 1) && ((argc - optind) > 3)) {
210                 usage(argv[0]);
211                 exit(-1);
212         }
213         if ((argc - optind) == 3)
214                 if (generate_image
215                     (argv[optind], argv[optind + 1], argv[optind + 2],
216                      EHDR)) {
217                         fprintf(stderr,
218                                 "\nError generating image file %s\n\n\n",
219                                 argv[argc - 1]);
220                         usage(argv[0]);
221                         exit(-1);
222                 }
223         if ((argc - optind) == 2)
224                 if (generate_image
225                     (argv[optind], NULL, argv[optind + 1], EHDR)) {
226                         fprintf(stderr,
227                                 "\nError generating image file %s\n\n\n",
228                                 argv[argc - 1]);
229                         usage(argv[0]);
230                         exit(-1);
231                 }
232
233         fd = open(argv[argc - 1], O_RDWR);
234         if (fd < 0) {
235                 fprintf(stderr, "\nImage file not found %s\n\n\n",
236                         argv[argc - 1]);
237                 usage(argv[0]);
238                 exit(-1);
239         }
240         long i, len = lseek(fd, 0, SEEK_END);
241         lseek(fd, 0, SEEK_SET);
242         uchar *buf = malloc(len);
243         read(fd, buf, len);
244         u32 sum, l0;
245         u32 MagicS = 0x4b544d47;
246         u32 MagicE = 0x4e525241;
247         if (*((u32 *) buf) == MagicS) {
248                 fprintf(stderr,
249                         "Image without extra 8 bytes - Standard header\n");
250                 *((u32 *) (buf + 0x10)) = len;
251                 lseek(fd, 0x10, SEEK_SET);
252                 write(fd, buf + 0x10, 0x4);
253                 EHDR = 0;
254         } else if ((*((u32 *) (buf + 0x8)) == MagicS)
255                    && ((*((u32 *) (buf + 0x4)) == MagicE))) {
256                 fprintf(stderr,
257                         "Image with extra 8 bytes - Extended header\n");
258                 *((u32 *) (buf + 0x18)) = len - 8;
259                 lseek(fd, 0x18, SEEK_SET);
260                 write(fd, buf + 0x18, 0x4);
261                 buf += 8;
262                 EHDR = 1;
263         } else if (len == *((u32 *) (buf + 0x10))) {
264                 fprintf(stderr,
265                         "Image without extra 8 bytes - Standard header\n");
266                 EHDR = 0;
267         } else if (len == *((u32 *) (buf + 0x18)) + 8) {
268                 fprintf(stderr,
269                         "Image with extra 8 bytes - Extended header\n");
270                 buf += 8;
271                 EHDR = 1;
272         } else {
273                 fprintf(stderr, "ERROR: Wrong image size\n");
274                 exit(-1);
275         }
276         l0 = *((u32 *) & buf[0x10]);
277         if (!BHDR)
278                 *((u32 *) & buf[0x18]) = 0;
279         ulong sum0 = *((u32 *) & buf[0x18]);
280         ulong sum1 = *((u32 *) & buf[0x4]);
281         *((u32 *) & buf[0x4]) = 0x0L;
282         for (i = 0; i < 0x100; i++)
283                 b[i] = buf[i];
284         for (i = 0; i < 0x100; i++)
285                 b[0x100 + i] = buf[(l0 >> 1) + i];
286         for (i = 0; i < 0x200; i++)
287                 b[0x200 + i] = buf[l0 - 0x200 + i];
288         *((u32 *) & b[0x18]) = 0x0L;
289
290         sum = crc32(b, 0x400);
291         printf("CRC32 sum0 - (%x, %x, %x)\n", sum, sum0, 0x400);
292         if (EHDR)
293                 lseek(fd, 0x20, SEEK_SET);
294         else
295                 lseek(fd, 0x18, SEEK_SET);
296         if (BHDR)
297                 *((u32 *) & buf[0x18]) = sum;
298         else
299                 *((u32 *) & buf[0x18]) = sum0;
300         write(fd, &buf[0x18], 0x4);
301
302         sum = crc32(buf, l0);
303         printf("CRC32 sum1 - (%x, %x, %x)\n", sum, sum1, l0);
304         if (EHDR)
305                 lseek(fd, 0xC, SEEK_SET);
306         else
307                 lseek(fd, 0x4, SEEK_SET);
308         *((u32 *) & buf[0x4]) = sum;
309         write(fd, &buf[0x4], 0x4);
310         if (EHDR) {
311                 ulong sum2 = *((u32 *) & buf[-0x8]);
312                 *((u32 *) & buf[-0x8]) = 0L;
313                 sum = crc32(buf - 0x4, len - 0x4);
314                 sum = htonl(sum);
315                 printf("CRC32 sum2 - (%x, %x, %x)\n", sum, sum2,
316                        len - 0x4);
317                 lseek(fd, 0, SEEK_SET);
318                 *((u32 *) & buf[-0x8]) = sum;
319                 write(fd, &buf[-0x8], 0x4);
320                 buf -= 8;
321         }
322         close(fd);
323         free(buf);
324         return 0;
325 }