/*
- WRT350Nv2-Builder 2.0 (previously called buildimg)
+ WRT350Nv2-Builder 2.3 (previously called buildimg)
Copyright (C) 2008-2009 Dirk Teurlings <info@upexia.nl>
- Copyright (C) 2009 Matthias Buecher (http://www.maddes.net/)
+ Copyright (C) 2009-2010 Matthias Buecher (http://www.maddes.net/)
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
:kernel 0x001A0000 /path/to/uImage
:rootfs 0 /path/to/root.squashfs
:u-boot 0 /path/to/u-boot.bin
+ #version 0x2020
args:
1 wrt350nv2.par parameter file describing the image layout
2 wrt350nv2.img output file for linksys style image
- An u-boot image inside the bin file is not necessary.
+ A u-boot image inside the bin file is not necessary.
The version is not important.
- The name of the bin file is not important.
+ The name of the bin file is not important, but still "wrt350n.bin" is used to
+ keep as close as possible to the stock firmware.
Linksys assumes that no mtd will be used to its maximum, so the last 16 bytes
of the mtd are abused to define the length of the next mtd content (4 bytes for
size + 12 pad bytes).
- At the end of "rootfs" additional 16 bytes are abused for some data and an
+ At the end of "rootfs" additional 16 bytes are abused for some data and a
highly important eRcOmM identifier, so the last 32 bytes of "rootfs" are abused.
- At the end of "u-boot" 128 bytes are abused for some data, a checksum and an
+ At the end of "u-boot" 128 bytes are abused for some data, a checksum and a
highly important sErCoMm identifier.
To extract everything from a Linksys style firmware image see
https://forum.openwrt.org/viewtopic.php?pid=92928#p92928
-*/
+ Changelog:
+ v2.3 - allow jffs by adding its magic number (0x8519)
+ added parameter option -i to ignore unknown magic numbers
+ v2.2 - fixed checksum byte calculation for other versions than 0x2019
+ fixed rare problem with padsize
+ updated info to stock firmware 2.00.20
+ fixed typos
+ v2.1 - used "wrt350n.bin" for the created image (closer to stock)
+ added option to create the image in two separate steps (-b / -z)
+ v2.0 - complete re-write
-// ToDo:
-// * Has NODE to be added to bin file *after* creating checksum byte?
+*/
// includes
#define _GNU_SOURCE // for GNU's basename()
// custom includes
#include "md5.h" // MD5 routines
-#include "upgrade.h" // Linksys definitions from firmware 2.0.19
+#include "upgrade.h" // Linksys definitions from firmware 2.0.19 (unchanged up to 2.0.20)
// version info
-#define VERSION "2.0"
+#define VERSION "2.3"
char program_info[] = "WRT350Nv2-Builder v%s by Dirk Teurlings <info@upexia.nl> and Matthias Buecher (http://www.maddes.net/)\n";
// verbosity
mtd_info mtd_uboot = { "u-boot", 0, 0, NULL, 0L, { 0, 0 } };
#define ROOTFS_END_OFFSET 0x00760000
-#define ROOTFS_MIN_OFFSET 0x00700000 // should be filled up to here, to make sure that the zip file is big enough to pass the size check of the stock firmware
+#define ROOTFS_MIN_OFFSET 0x00640000 // should be filled up to here, to make sure that the zip file is big enough to pass the size check of the stock firmware
+ // 2.0.17: filled up to 0x00640000
+ // 2.0.19: filled up to 0x00670000
+ // 2.0.20: filled up to 0x00670000
// rootfs statics via: hexdump -v -e '1/1 "0x%02X, "' -s 0x0075FFE0 -n 16 "wrt350n.bin" ; echo -en "\n"
unsigned char product_id[] = { 0x00, 0x03 }; // seems to be a fixed value
unsigned char protocol_id[] = { 0x00, 0x00 }; // seems to be a fixed value
-unsigned char fw_version[] = { 0x20, 0x19 };
+unsigned char fw_version[] = { 0x20, 0x20 };
unsigned char rootfs_unknown[] = { 0x90, 0xF7 }; // seems to be a fixed value
unsigned char sign[] = { 0x65, 0x52, 0x63, 0x4F, 0x6D, 0x4D, 0x00, 0x00 }; // eRcOmM
0x00, 0x00, 0x00, 0x04,
0x73, 0x45, 0x72, 0x43, 0x6F, 0x4D, 0x6D }; // sErCoMm
-// img statics via: hexdump -v -e '1/1 "0x%02X, "' -s 0 -n 512 "WRT350N-EU-ETSI-2.00.19.img" ; echo -en "\n"
+// img statics via: hexdump -v -e '1/1 "0x%02X, "' -s 0 -n 512 "WRT350N-EU-ETSI-2.00.19.img" ; echo -en "\n" (unchanged up to 2.0.20)
unsigned char img_hdr[] = { 0x00, 0x01, 0x00, 0x00, 0x59, 0x42, 0x50, 0x00, 0x01, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03,
// read next line into memory
do {
// allocate memory for input line
- if (buffer == NULL) {
+ if (!buffer) {
buffer = malloc(buffer_size);
}
- if (buffer == NULL) {
+ if (!buffer) {
exitcode = 1;
printf("parse_par_file: can not allocate %i bytes\n", (int) buffer_size);
break;
}
line = fgets(buffer, buffer_size, f_par);
- if (line == NULL) {
+ if (!line) {
exitcode = ferror(f_par);
if (exitcode) {
printf("parse_par_file: %s\n", strerror(exitcode));
buffer_size *= 2;
lprintf(DEBUG_LVL2, " extending buffer to %i bytes\n", buffer_size);
} while (1);
- if (line == NULL || exitcode) {
+ if ((!line) || (exitcode)) {
break;
}
printf("line %i does not meet defined format (:<mtdname> <mtdsize> <file>)\n", lineno);
} else {
// populate mtd_info if supported mtd names
- if (strcmp(string1, mtd_kernel.name) == 0) {
+ if (!strcmp(string1, mtd_kernel.name)) {
mtd = &mtd_kernel;
- } else if (strcmp(string1, mtd_rootfs.name) == 0) {
+ } else if (!strcmp(string1, mtd_rootfs.name)) {
mtd = &mtd_rootfs;
- } else if (strcmp(string1, mtd_uboot.name) == 0) {
+ } else if (!strcmp(string1, mtd_uboot.name)) {
mtd = &mtd_uboot;
}
- if (mtd == NULL) {
+ if (!mtd) {
printf("unknown mtd %s in line %i\n", string1, lineno);
- } else if (mtd->filename != NULL) {
+ } else if (mtd->filename) {
f_exitcode = 1;
printf("mtd %s in line %i multiple definitions\n", string1, lineno);
} else {
// Get file size
f_in = fopen(mtd->filename, "rb");
- if (f_in == NULL) {
+ if (!f_in) {
f_exitcode = errno;
printf("input file %s: %s\n", mtd->filename, strerror(f_exitcode));
} else {
case '#': // integer values
count = sscanf(line, "#%255s %i", string1, &value);
if (count != 2) {
- printf("line %i does not meet defined format (:<variable name> <integer>\n", lineno);
+ printf("line %i does not meet defined format (#<variable name> <integer>\n", lineno);
} else {
- if (strcmp(string1, "version") == 0) {
+ if (!strcmp(string1, "version")) {
// changing version
fw_version[0] = 0x000000FF & ( value >> 8 );
fw_version[1] = 0x000000FF & value;
printf("line %i does not meet defined format (:<mtdname> <mtdsize> <file>)\n", lineno);
} else {
/*
- if (strcmp(string1, "something") == 0) {
- something = string2;
- string2 = NULL; // do not free
+ if (!strcmp(string1, "something")) {
+ something = strdup(string2);
} else {
*/
printf("unknown string variable %s in line %i\n", string1, lineno);
// allocate memory for bin file
buffer = malloc(KERNEL_CODE_OFFSET + FLASH_SIZE);
- if (buffer == NULL) {
+ if (!buffer) {
exitcode = 1;
printf("create_bin_file: can not allocate %i bytes\n", FLASH_SIZE);
} else {
printf("create_bin_file: unknown mtd %i\n", i);
break;
}
- if (mtd == NULL) {
+ if (!mtd) {
break;
}
- if (mtd->filename == NULL) {
+ if (!mtd->filename) {
continue;
}
// adding file content
f_in = fopen(mtd->filename, "rb");
- if (f_in == NULL) {
+ if (!f_in) {
exitcode = errno;
printf("input file %s: %s\n", mtd->filename, strerror(exitcode));
} else {
// padding
if (padsize > 0) {
- printf("mtd %s input file %s is too small (0x%08lX), adding 0x%08X random bytes\n", mtd->name, mtd->filename, mtd->filesize, padsize);
-
addsize = padsize & 0x0000FFFF; // start on next 64KB border
padsize -= addsize;
+ }
+ if (padsize > 0) {
+ printf("mtd %s input file %s is too small (0x%08lX), adding 0x%08X random bytes\n", mtd->name, mtd->filename, mtd->filesize, padsize);
+
addsize += KERNEL_CODE_OFFSET + mtd->offset + mtd->filesize; // get offset
lprintf(DEBUG, " padding offset 0x%08X length 0x%08X\n", addsize, padsize);
f_in = fopen(rand_filename, "rb");
- if (f_in == NULL) {
+ if (!f_in) {
exitcode = errno;
printf("input file %s: %s\n", rand_filename, strerror(exitcode));
} else {
memcpy(&buffer[KERNEL_CODE_OFFSET + FW_VERSION_OFFSET + 2], rootfs_unknown, 2);
memcpy(&buffer[KERNEL_CODE_OFFSET + SIGN_OFFSET], sign, 8); // eRcOmM
- lprintf(DEBUG, "adding u-boot special data 1/2\n"); // ToDo: or after creating the checksum byte?
-// memcpy(&buffer[KERNEL_CODE_OFFSET + SN_OFF], sn, 12); // ToDo: find out what's this for?
-// memcpy(&buffer[KERNEL_CODE_OFFSET + PIN_OFF], pin, 8); // ToDo: find out what's this for?
-// memcpy(&buffer[KERNEL_CODE_OFFSET + NODE_BASE_OFF], node, 25); // ToDo: find out what's this for?
+ lprintf(DEBUG, "adding u-boot special data\n");
+// memcpy(&buffer[KERNEL_CODE_OFFSET + SN_OFF], sn, 12); // ToDo: currently zero, find out what's this for?
+// memcpy(&buffer[KERNEL_CODE_OFFSET + PIN_OFF], pin, 8); // ToDo: currently zero, find out what's this for?
+// memcpy(&buffer[KERNEL_CODE_OFFSET + NODE_BASE_OFF], node, 25); // ToDo: currently zero, find out what's this for?
+ memcpy(&buffer[KERNEL_CODE_OFFSET + BOOT_ADDR_BASE_OFF + PID_OFFSET], pid, 70); // sErCoMm
+ memcpy(&buffer[KERNEL_CODE_OFFSET + BOOT_ADDR_BASE_OFF + PID_OFFSET + 57], fw_version, 2);
lprintf(DEBUG, "adding checksum byte\n");
csum = 0;
}
lprintf(DEBUG_LVL2, " checksum 0x%016lX (%li)\n", csum, csum);
- buffer[KERNEL_CODE_OFFSET + NODE_BASE_OFF + 25] = ~(csum+108)+1;
+ buffer[KERNEL_CODE_OFFSET + NODE_BASE_OFF + 25] = ~csum + 1;
lprintf(DEBUG, " byte 0x%02X\n", buffer[KERNEL_CODE_OFFSET + NODE_BASE_OFF + 25]);
-
- lprintf(DEBUG, "adding u-boot special data 2/2\n");
- memcpy(&buffer[KERNEL_CODE_OFFSET + BOOT_ADDR_BASE_OFF + PID_OFFSET], pid, 70); // sErCoMm
- memcpy(&buffer[KERNEL_CODE_OFFSET + BOOT_ADDR_BASE_OFF + PID_OFFSET + 57], fw_version, 2);
}
// write bin file
if (!exitcode) {
lprintf(DEBUG, "writing file %s\n", bin_filename);
f_out = fopen(bin_filename, "wb");
- if (f_out == NULL) {
+ if (!f_out) {
exitcode = errno;
printf("output file %s: %s\n", bin_filename, strerror(exitcode));
} else {
buffer = NULL;
do {
// allocate memory for command line
- if (buffer == NULL) {
+ if (!buffer) {
buffer = malloc(buffer_size);
}
- if (buffer == NULL) {
+ if (!buffer) {
exitcode = 1;
printf("create_zip_file: can not allocate %i bytes\n", (int) buffer_size);
break;
}
// if buffer was not completely filled, then line fit in completely
- count = snprintf(buffer, buffer_size, "zip %s %s", zip_filename, bin_filename);
- if (count > -1 && count < buffer_size) {
+ count = snprintf(buffer, buffer_size, "zip \"%s\" \"%s\"", zip_filename, bin_filename);
+ if ((count > -1) && (count < buffer_size)) {
break;
}
// zipping binfile
lprintf(DEBUG, "%s\n", buffer);
count = system(buffer);
- if (count < 0 || WEXITSTATUS(count)) {
+ if ((count < 0) || (WEXITSTATUS(count))) {
exitcode = 1;
printf("create_zip_file: can not execute %s bytes\n", buffer);
}
if (!exitcode) {
lprintf(DEBUG_LVL2, " adding zip file\n");
f_in = fopen(zip_filename, "rb");
- if (f_in == NULL) {
+ if (!f_in) {
exitcode = errno;
printf("input file %s: %s\n", zip_filename, strerror(exitcode));
} else {
int exitcode = 0;
int help;
+ int onlybin;
int havezip;
+ int ignoremagic;
char option;
char *par_filename = NULL;
- char *out_filename = NULL;
+ char *img_filename = NULL;
char *base_filename = NULL;
char *bin_filename = NULL;
char *zip_filename = NULL;
- FILE *f_par;
- FILE *f_out;
+ FILE *f_par = NULL;
+ FILE *f_img = NULL;
int i;
mtd_info *mtd;
int mandatory;
int noupdate;
int sizecheck;
- unsigned char magic[2];
+ int magiccheck;
+ int magicerror;
// display program header
// command line processing
// options
help = 0;
+ onlybin = 0;
havezip = 0;
- while ((option = getopt(argc, argv, ":hzf:v")) != -1) {
+ ignoremagic = 0;
+ while ((option = getopt(argc, argv, "hbzif:v")) != -1) {
switch(option) {
case 'h':
help = 1;
break;
+ case 'b':
+ onlybin = 1;
+ break;
case 'z':
havezip = 1;
break;
+ case 'i':
+ ignoremagic = 1;
+ break;
case 'f':
sizecheck = sscanf(optarg, "%i", &i);
if (sizecheck != 1) {
- printf("firmware version of -f option not a valid integer\n");
+ printf("Firmware version of -f option not a valid integer\n");
exitcode = 1;
} else {
fw_version[0] = 0x000000FF & ( i >> 8 );
// files
for ( ; optind < argc; optind++) {
- if (par_filename == NULL) {
+ if (!par_filename) {
par_filename = argv[optind];
if (access(par_filename, R_OK)) {
continue;
}
- if (out_filename == NULL) {
- out_filename = argv[optind];
+ if ((!onlybin) && (!img_filename)) {
+ img_filename = argv[optind];
- if (!access(out_filename, F_OK)) { // if file already exists then check write access
- if (access(out_filename, W_OK)) {
- printf("No write access to output file %s\n", out_filename);
+ if (!access(img_filename, F_OK)) { // if file already exists then check write access
+ if (access(img_filename, W_OK)) {
+ printf("No write access to image file %s\n", img_filename);
exitcode = 1;
}
}
}
// file name checks
- if (par_filename == NULL) {
+ if (!par_filename) {
if (havezip) {
printf("Zip file not stated\n");
} else {
exitcode = 1;
} else {
base_filename = basename(par_filename);
- if (base_filename == NULL) {
+ if (!base_filename) {
if (havezip) {
printf("Zip file is a directory\n");
} else {
}
}
- if (out_filename == NULL) {
- printf("Output file not stated\n");
- exitcode = 1;
- } else {
- base_filename = basename(out_filename);
- if (base_filename == NULL) {
- printf("Output file is a directory\n");
+ if (!onlybin) {
+ if (!img_filename) {
+ printf("Image file not stated\n");
exitcode = 1;
} else {
- base_filename = strdup(base_filename);
- zip_filename = strrchr(base_filename, '.');
- if (zip_filename != NULL) {
- zip_filename[0] = 0;
- zip_filename = NULL; // clean up
+ base_filename = basename(img_filename);
+ if (!base_filename) {
+ printf("Image file is a directory\n");
+ exitcode = 1;
}
}
}
- // react on parameter problems or help request, and exit
- if ((exitcode != 0) || help) {
+ // check for mutually exclusive options
+ if ((onlybin) && (havezip)) {
+ printf("Option -b and -z are mutually exclusive\n");
+ exitcode = 1;
+ }
+
+ // react on option problems or help request, then exit
+ if ((exitcode) || (help)) {
if (help) {
printf("This program creates Linksys style images for the WRT350Nv2 router.\n");
}
printf(" Usage:\n\
- %s [-h] [-z] [-f <version>] [-v] <parameter or zip file> <output file>\n\n\
+ %s [-h] [-b] [-z] [-i] [-f <version>] [-v] <parameter or zip file> [<image file>]\n\n\
Options:\n\
-h - Show this help\n\
+ -b - Create only bin file, no img or zip file is created\n\
-z - Have zip file, the img file will be directly created from it\n\
+ -i - Ignore unknown magic numbers\n\
-f <version> - Wanted firmware version to use with -z\n\
- Default firmware version is 0x2019 = 2.00.19.\n\
+ Default firmware version is 0x2020 = 2.00.20.\n\
Note: version from parameter file will supersede this\n\
-v - Increase debug verbosity level\n\n\
Example:\n\
par_filename = NULL;
}
- lprintf(DEBUG_LVL2, " verbosity: %i\n", verbosity);
- lprintf(DEBUG_LVL2, " program: %s\n", argv[0]);
+ lprintf(DEBUG_LVL2, " Verbosity: %i\n", verbosity);
+ lprintf(DEBUG_LVL2, " Program: %s\n", argv[0]);
- lprintf(DEBUG, "Parameter file: %s\n", par_filename);
- lprintf(DEBUG, "Output file: %s\n", out_filename);
- lprintf(DEBUG_LVL2, " basename: %s (%i)\n", base_filename, strlen(base_filename));
+ if (par_filename) {
+ lprintf(DEBUG, "Parameter file: %s\n", par_filename);
+ }
+ if (zip_filename) {
+ lprintf(DEBUG, "Zip file: %s\n", zip_filename);
+ }
+ if (img_filename) {
+ lprintf(DEBUG, "Image file: %s\n", img_filename);
+ }
// open files from command line
- // parameter file
- if (par_filename != NULL) {
- f_par = fopen(par_filename, "r");
- if (f_par == NULL) {
+ // parameter/zip file
+ if (par_filename) {
+ f_par = fopen(par_filename, "rt");
+ if (!f_par) {
exitcode = errno;
- printf("input file %s: %s\n", par_filename, strerror(exitcode));
+ printf("Input file %s: %s\n", par_filename, strerror(exitcode));
}
}
- // output file
- f_out = fopen(out_filename, "w");
- if (f_out == NULL) {
- exitcode = errno;
- printf("Output file %s: %s\n", out_filename, strerror(exitcode));
+ // image file
+ if (img_filename) {
+ f_img = fopen(img_filename, "wb");
+ if (!f_img) {
+ exitcode = errno;
+ printf("Output file %s: %s\n", img_filename, strerror(exitcode));
+ }
}
if (exitcode) {
// parameter file processing
- if (!exitcode && par_filename != NULL) {
+ if ((!exitcode) && (f_par)) {
lprintf(DEBUG, "parsing parameter file...\n");
exitcode = parse_par_file(f_par);
lprintf(DEBUG, "...done parsing file\n");
}
- if (par_filename != NULL) {
+ if (f_par) {
fclose(f_par);
}
// check all input data
- if (!exitcode && par_filename != NULL) {
+ if ((!exitcode) && (par_filename)) {
lprintf(DEBUG, "checking mtd data...\n");
for (i = 1; i <= 3; i++) {
mandatory = 0;
noupdate = 0;
sizecheck = 0;
- magic[0] = 0;
- magic[1] = 0;
+ magiccheck = 0;
switch (i) {
case 1:
mtd = &mtd_kernel;
mandatory = 1;
sizecheck = mtd_kernel.size - 16;
- magic[0] = 0x27;
- magic[1] = 0x05;
+ magiccheck = 1;
break;
case 2:
mtd = &mtd_rootfs;
mtd->size = ROOTFS_END_OFFSET - mtd_kernel.size;
mandatory = 1;
sizecheck = PRODUCT_ID_OFFSET - mtd_kernel.size;
- magic[0] = 0x68;
- magic[1] = 0x73;
+ magiccheck = 1;
break;
case 3:
mtd = &mtd_uboot;
printf("unknown mtd check %i\n", i);
break;
}
- if (mtd == NULL) {
+ if (!mtd) {
break;
}
lprintf(DEBUG_LVL2, " checking mtd %s\n", mtd->name);
// general checks
- if (mandatory && mtd->filename == NULL) {
+ if ((mandatory) && (!mtd->filename)) {
exitcode = 1;
printf("mtd %s not specified correctly or at all in parameter file\n", mtd->name);
}
- // end checks if no file data present
- if (mtd->filename == NULL) {
+ // no further checks if no file data present
+ if (!mtd->filename) {
continue;
}
}
// general magic number check
- if (magic[0]) {
- if (mtd->magic[0] != magic[0] || mtd->magic[1] != magic[1]) {
- exitcode = 1;
- printf("mtd %s input file %s has wrong magic number (0x%02X%02X)\n", mtd->name, mtd->filename, mtd->magic[0], mtd->magic[1]);
+ magicerror = 0;
+ if (magiccheck) {
+ switch (i) {
+ case 1: // kernel
+ if (!(
+ ((mtd->magic[0] == 0x27) && (mtd->magic[1] == 0x05)) // uImage
+ )) {
+ magicerror = 1;
+ }
+ break;
+ case 2: // rootfs
+ if (!(
+ ((mtd->magic[0] == 0x68) && (mtd->magic[1] == 0x73)) // squashfs
+ || ((mtd->magic[0] == 0x85) && (mtd->magic[1] == 0x19)) // jffs
+ )) {
+ magicerror = 1;
+ }
+ break;
+ default:
+ magicerror = 1;
+ break;
+ }
+ if (magicerror) {
+ printf("mtd %s input file %s has unknown magic number (0x%02X%02X)", mtd->name, mtd->filename, mtd->magic[0], mtd->magic[1]);
+ if (ignoremagic) {
+ printf("...ignoring");
+ } else {
+ exitcode = 1;
+ }
+ printf("\n");
}
}
// bin creation in memory
- if (!exitcode && par_filename != NULL) {
- // create bin name from basename
- bin_filename = malloc(strlen(base_filename)+10);
- sprintf(bin_filename, "%s.bin", base_filename);
+ if ((!exitcode) && (par_filename)) {
+ bin_filename = "wrt350n.bin";
lprintf(DEBUG, "creating bin file %s...\n", bin_filename);
lprintf(DEBUG, "...done creating bin file\n");
}
-
// zip file creation
- if (!exitcode && zip_filename == NULL) {
- // create zip name from basename
- zip_filename = malloc(strlen(base_filename)+10);
- sprintf(zip_filename, "%s.zip", base_filename);
+ if ((!exitcode) && (!onlybin) && (!zip_filename)) {
+ zip_filename = "wrt350n.zip";
lprintf(DEBUG, "creating zip file %s...\n", zip_filename);
// img file creation
- if (!exitcode) {
+ if ((!exitcode) && (f_img)) {
lprintf(DEBUG, "creating img file...\n");
- exitcode = create_img_file(f_out, out_filename, zip_filename);
+ exitcode = create_img_file(f_img, img_filename, zip_filename);
lprintf(DEBUG, "...done creating img file\n");
}
- fclose(f_out);
+// clean up
+ if (f_img) {
+ fclose(f_img);
+ }
// end program
return exitcode;