1 // SPDX-License-Identifier: GPL-2.0-only
4 * Copyright (C) 2012 OpenWrt.org
5 * Copyright (C) 2012 Mikko Hissa <mikko.hissa@uta.fi>
14 #include <arpa/inet.h>
19 #define BUF_SIZE 0x200
20 #define VERSION_SIZE 0x10
24 #define DEFAULT_BLOCK_SIZE 65535
26 #define DEFAULT_HEAD_VALUE 0x0
27 #define DEFAULT_VERSION "123"
28 #define DEFAULT_MAGIC 0x12345678
34 uint8_t version
[VERSION_SIZE
];
35 uint32_t firmware_type
;
38 uint8_t md5sum
[MD5_SIZE
];
39 uint8_t pad
[PAD_SIZE
];
53 static firmware_type FIRMWARE_TYPES
[] = {
54 { 0x00, "combo" }, /* Used for new capwap-included style header */
55 { 0x01, "bootloader" },
57 { 0x03, "kernelapp" },
59 /* The types below this line vary by manufacturer */
60 { 0x05, "littleapps (D-Link)/factoryapps (EnGenius)" },
61 { 0x06, "sounds (D-Link)/littleapps (EnGenius)" },
62 { 0x07, "userconfig (D-Link)/appdata (EnGenius)" },
63 { 0x08, "userconfig (EnGenius)"},
64 { 0x09, "odmapps (EnGenius)"},
65 { 0x0a, "factoryapps (D-Link)" },
66 { 0x0b, "odmapps (D-Link)" },
67 { 0x0c, "langpack (D-Link)" }
70 #define MOD_DEFAULT 0x616C6C00
71 #define SKU_DEFAULT 0x0
72 #define DATECODE_NONE 0xFFFFFFFF
73 #define FIRMWARE_TYPE_NONE 0xFF
75 struct capwap_header
{
78 uint32_t firmware_ver
[3];
80 uint32_t capwap_ver
[3];
85 static long get_file_size(const char *filename
)
90 fp_file
= fopen(filename
, "r");
93 fseek(fp_file
, 0, SEEK_END
);
94 result
= ftell(fp_file
);
99 static int header_checksum(void *data
, size_t len
)
101 int sum
= 0; /* shouldn't this be unsigned ? */
104 if (data
!= NULL
&& len
> 0) {
105 for (i
= 0; i
< len
; ++i
)
106 sum
+= ((unsigned char *)data
)[i
];
113 static int md5_file(const char *filename
, uint8_t *dst
)
122 fp_src
= fopen(filename
, "r+b");
126 while (!feof(fp_src
)) {
127 bytes_read
= fread(&buf
, 1, BUF_SIZE
, fp_src
);
128 MD5_Update(&ctx
, &buf
, bytes_read
);
132 MD5_Final(dst
, &ctx
);
137 static int encode_image(const char *input_file_name
,
138 const char *output_file_name
, img_header
*header
,
139 struct capwap_header
*cw_header
, int block_size
)
153 fp_input
= fopen(input_file_name
, "r+b");
155 fprintf(stderr
, "Cannot open %s !!\n", input_file_name
);
159 fp_output
= fopen(output_file_name
, "w+b");
161 fprintf(stderr
, "Cannot open %s !!\n", output_file_name
);
166 header
->filesize
= get_file_size(input_file_name
);
167 if (!header
->filesize
) {
168 fprintf(stderr
, "File %s open/size error!\n", input_file_name
);
176 if (block_size
> 0) {
177 pad_len
= block_size
- (header
->filesize
% block_size
);
180 if (md5_file(input_file_name
, (uint8_t *) &header
->md5sum
) < 0) {
181 fprintf(stderr
, "MD5 failed on file %s\n", input_file_name
);
187 header
->chksum
= header_checksum(header
, HDR_LEN
);
189 header
->chksum
+= header_checksum(cw_header
,
190 sizeof(struct capwap_header
) + cw_header
->model_size
);
193 header
->head
= htonl(header
->head
);
194 header
->vendor_id
= htonl(header
->vendor_id
);
195 header
->product_id
= htonl(header
->product_id
);
196 header
->firmware_type
= htonl(header
->firmware_type
);
197 header
->filesize
= htonl(header
->filesize
);
198 header
->chksum
= htonl(header
->chksum
);
199 magic
= header
->magic
;
200 header
->magic
= htonl(header
->magic
);
202 fwrite(header
, HDR_LEN
, 1, fp_output
);
205 model_size
= cw_header
->model_size
;
206 cw_header
->mod
= htonl(cw_header
->mod
);
207 cw_header
->sku
= htonl(cw_header
->sku
);
208 cw_header
->firmware_ver
[0] = htonl(cw_header
->firmware_ver
[0]);
209 cw_header
->firmware_ver
[1] = htonl(cw_header
->firmware_ver
[1]);
210 cw_header
->firmware_ver
[2] = htonl(cw_header
->firmware_ver
[2]);
211 cw_header
->datecode
= htonl(cw_header
->datecode
);
212 cw_header
->capwap_ver
[0] = htonl(cw_header
->capwap_ver
[0]);
213 cw_header
->capwap_ver
[1] = htonl(cw_header
->capwap_ver
[1]);
214 cw_header
->capwap_ver
[2] = htonl(cw_header
->capwap_ver
[2]);
215 cw_header
->model_size
= htonl(cw_header
->model_size
);
216 fwrite(cw_header
, sizeof(struct capwap_header
) + model_size
, 1,
220 while (!feof(fp_input
) || pad_len
> 0) {
223 bytes_read
= fread(&buf
, 1, BUF_SIZE
, fp_input
);
228 * No more bytes read, start padding
230 if (bytes_read
< BUF_SIZE
&& pad_len
> 0) {
231 bytes_avail
= BUF_SIZE
- bytes_read
;
232 memset( &buf
[bytes_read
], 0, bytes_avail
);
233 bytes_read
+= bytes_avail
< pad_len
? bytes_avail
: pad_len
;
234 pad_len
-= bytes_avail
< pad_len
? bytes_avail
: pad_len
;
237 for (i
= 0; i
< bytes_read
; i
++)
238 buf
[i
] ^= magic
>> (i
% 8) & 0xff;
239 fwrite(&buf
, bytes_read
, 1, fp_output
);
247 int decode_image(const char *input_file_name
, const char *output_file_name
)
249 struct capwap_header cw_header
;
258 size_t bytes_written
;
261 fp_input
= fopen(input_file_name
, "r+b");
263 fprintf(stderr
, "Cannot open %s !!\n", input_file_name
);
267 fp_output
= fopen(output_file_name
, "w+b");
269 fprintf(stderr
, "Cannot open %s !!\n", output_file_name
);
274 if (fread(&header
, 1, HDR_LEN
, fp_input
) != HDR_LEN
) {
275 fprintf(stderr
, "Incorrect header size reading base header!!");
281 header
.head
= ntohl(header
.head
);
282 header
.vendor_id
= ntohl(header
.vendor_id
);
283 header
.product_id
= ntohl(header
.product_id
);
284 header
.firmware_type
= ntohl(header
.firmware_type
);
285 header
.filesize
= ntohl(header
.filesize
);
286 header
.chksum
= ntohl(header
.chksum
);
287 header
.magic
= ntohl(header
.magic
);
289 /* read capwap header if firmware_type is zero */
290 if (header
.firmware_type
== 0) {
291 if (fread(&cw_header
, 1, sizeof(struct capwap_header
),
292 fp_input
) != sizeof(struct capwap_header
)) {
293 fprintf(stderr
, "Incorrect header size reading capwap_header!!");
298 cw_header
.mod
= ntohl(cw_header
.mod
);
299 cw_header
.sku
= ntohl(cw_header
.sku
);
300 cw_header
.firmware_ver
[0] = ntohl(cw_header
.firmware_ver
[0]);
301 cw_header
.firmware_ver
[1] = ntohl(cw_header
.firmware_ver
[1]);
302 cw_header
.firmware_ver
[2] = ntohl(cw_header
.firmware_ver
[2]);
303 cw_header
.datecode
= ntohl(cw_header
.datecode
);
304 cw_header
.capwap_ver
[0] = ntohl(cw_header
.capwap_ver
[0]);
305 cw_header
.capwap_ver
[1] = ntohl(cw_header
.capwap_ver
[1]);
306 cw_header
.capwap_ver
[2] = ntohl(cw_header
.capwap_ver
[2]);
307 cw_header
.model_size
= ntohl(cw_header
.model_size
);
309 pmodel
= malloc(cw_header
.model_size
+ 1);
311 pmodel
[cw_header
.model_size
] = '\0';
312 if (fread(pmodel
, 1, cw_header
.model_size
, fp_input
) !=
313 cw_header
.model_size
) {
314 fprintf(stderr
, "Incorrect header size reading model name!!");
322 fprintf(stderr
, "Incorrect header size reading model name!!");
330 while (!feof(fp_input
)) {
332 bytes_read
= fread(&buf
, 1, BUF_SIZE
, fp_input
);
333 for (i
= 0; i
< bytes_read
; i
++)
334 buf
[i
] ^= header
.magic
>> (i
% 8) & 0xff;
337 * Handle padded source file
339 if (bytes_written
+ bytes_read
> header
.filesize
) {
340 bytes_read
= header
.filesize
- bytes_written
;
342 fwrite(&buf
, bytes_read
, 1, fp_output
);
346 fwrite(&buf
, bytes_read
, 1, fp_output
);
347 bytes_written
+= bytes_read
;
356 static void usage(const char *progname
, int status
)
358 FILE *stream
= (status
!= EXIT_SUCCESS
) ? stderr
: stdout
;
361 fprintf(stream
, "Usage: %s [OPTIONS...]\n", progname
);
364 " -e <file> encode image file <file>\n"
365 " -d <file> decode image file <file>\n"
366 " -o <file> write output to the file <file>\n"
367 " -t <type> set image type to <type>\n"
368 " valid image <type> values:\n");
369 for (i
= 0; i
< sizeof(FIRMWARE_TYPES
) / sizeof(firmware_type
); i
++) {
370 fprintf(stream
, " %-5i= %s\n", FIRMWARE_TYPES
[i
].id
,
371 FIRMWARE_TYPES
[i
].name
);
373 fprintf(stream
, " -v <version> set image version to <version>\n"
374 " -r <vendor> set image vendor id to <vendor>\n"
375 " -p <product> set image product id to <product>\n"
376 " -m <magic> set encoding magic <magic>\n"
377 " -z enable image padding to <blocksize>\n"
378 " -b <blocksize> set image <blocksize>, defaults to %u\n"
379 " -c <datecode> add capwap header with <datecode> (e.g. 171101)\n"
380 " -w <fw_ver> firmware version for capwap header (e.g. 3.0.1)\n"
381 " -x <cw_ver> capwap firmware version for capwap header (e.g. 1.8.53)\n"
382 " -n <name> model name for capwap header (e.g. ENS620EXT)\n"
383 " -h show this screen\n", DEFAULT_BLOCK_SIZE
);
387 int main(int argc
, char *argv
[])
389 static const char period
[2] = ".";
390 struct capwap_header cw_header
;
393 struct capwap_header
*pcw_header
= NULL
;
394 char *output_file
= NULL
;
395 char *input_file
= NULL
;
396 char *progname
= NULL
;
397 char *mod_name
= NULL
;
406 block_size
= DEFAULT_BLOCK_SIZE
;
407 progname
= basename(argv
[0]);
409 memset(&header
, 0, sizeof(img_header
));
410 header
.magic
= DEFAULT_MAGIC
;
411 header
.head
= DEFAULT_HEAD_VALUE
;
412 header
.firmware_type
= FIRMWARE_TYPE_NONE
;
413 memset(&cw_header
, 0, sizeof(struct capwap_header
));
414 cw_header
.mod
= MOD_DEFAULT
;
415 cw_header
.sku
= SKU_DEFAULT
;
416 cw_header
.datecode
= DATECODE_NONE
;
417 strncpy( (char*)&header
.version
, DEFAULT_VERSION
, VERSION_SIZE
- 1);
419 while ((opt
= getopt(argc
, argv
, ":o:e:d:t:v:r:p:m:b:c:w:x:n:h?z")) != -1) {
430 output_file
= optarg
;
433 tmp
= strtol(optarg
, 0, 10);
434 for (i
= 0; i
< sizeof(FIRMWARE_TYPES
) / sizeof(firmware_type
);
436 if (FIRMWARE_TYPES
[i
].id
== tmp
) {
437 header
.firmware_type
= FIRMWARE_TYPES
[i
].id
;
441 if (header
.firmware_type
== FIRMWARE_TYPE_NONE
) {
442 fprintf(stderr
, "Invalid firmware type \"0\"!\n");
443 usage(progname
, EXIT_FAILURE
);
447 strncpy( (char*)&header
.version
, optarg
,
451 header
.vendor_id
= strtol(optarg
, 0, 0);
454 header
.product_id
= strtol(optarg
, 0, 0);
457 header
.magic
= strtoul(optarg
, 0, 16);
463 block_size
= strtol(optarg
, 0, 10);
466 cw_header
.datecode
= strtoul(optarg
, 0, 10);
469 token
= strtok(optarg
, period
);
471 while (token
&& (i
< 3)) {
472 cw_header
.firmware_ver
[i
++] =
473 strtoul(token
, 0, 10);
474 token
= strtok(NULL
, period
);
478 token
= strtok(optarg
, period
);
480 while (token
&& (i
< 3)) {
481 cw_header
.capwap_ver
[i
++] =
482 strtoul(token
, 0, 10);
483 token
= strtok(NULL
, period
);
488 cw_header
.model_size
= strlen(mod_name
);
491 usage(progname
, EXIT_SUCCESS
);
494 fprintf(stderr
, "Option -%c requires an operand\n", optopt
);
495 usage(progname
, EXIT_FAILURE
);
498 fprintf(stderr
, "Unrecognized option: -%c\n", optopt
);
499 usage(progname
, EXIT_FAILURE
);
502 usage(progname
, EXIT_FAILURE
);
507 /* Check required arguments */
509 fprintf(stderr
, "A mode must be defined\n");
510 usage(progname
, EXIT_FAILURE
);
513 if (input_file
== NULL
|| output_file
== NULL
) {
514 fprintf(stderr
, "Input and output files must be defined\n");
515 usage(progname
, EXIT_FAILURE
);
518 if (mode
== DECODE
) {
519 if (decode_image(input_file
, output_file
) < 0)
525 if ((header
.firmware_type
== 0) &&
526 (cw_header
.datecode
== DATECODE_NONE
)) {
527 fprintf(stderr
, "Firmware type must be non-zero for non-capwap images\n");
528 usage(progname
, EXIT_FAILURE
);
531 if (header
.vendor_id
== 0 || header
.product_id
== 0) {
532 fprintf(stderr
, "Vendor ID and Product ID must be defined and non-zero\n");
533 usage(progname
, EXIT_FAILURE
);
536 /* Check capwap header specific arguments */
537 if (cw_header
.datecode
!= DATECODE_NONE
) {
539 fprintf(stderr
, "Capwap header specified: model name must be specified\n");
540 usage(progname
, EXIT_FAILURE
);
542 if (!cw_header
.firmware_ver
[0] && !cw_header
.firmware_ver
[1] &&
543 !cw_header
.firmware_ver
[2]) {
544 fprintf(stderr
, "Capwap header specified, fw_ver must be non-zero\n");
546 if (!cw_header
.capwap_ver
[0] && !cw_header
.capwap_ver
[1] &&
547 !cw_header
.capwap_ver
[2]) {
548 fprintf(stderr
, "Capwap header specified, cw_ver must be non-zero\n");
550 pcw_header
= malloc(sizeof(struct capwap_header
) +
551 cw_header
.model_size
);
553 memcpy(pcw_header
, &cw_header
,
554 sizeof(struct capwap_header
));
555 memcpy(&(pcw_header
->model
), mod_name
,
556 cw_header
.model_size
);
558 fprintf(stderr
, "Failed to allocate memory\n");
563 if (encode_image(input_file
, output_file
, &header
, pcw_header
,
564 pad
? block_size
: 0) < 0)