openwrt/target/utils/src/trx.c

   1 /*
   2  * Copyright (C) 2004  Manuel Novoa III  <mjn3@codepoet.org>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  17  */
  18
  19 /* July 29, 2004
  20  *
  21  * This is a hacked replacement for the 'trx' utility used to create
  22  * wrt54g .trx firmware files.  It isn't pretty, but it does the job
  23  * for me.
  24  *
  25  * As an extension, you can specify a larger maximum length for the
  26  * .trx file using '-m'.  It will be rounded up to be a multiple of 4K.
  27  * NOTE: This space will be malloc()'d.
  28  *
  29  * August 16, 2004
  30  *
  31  * Sigh... Make it endian-neutral.
  32  *
  33  * TODO: Support '-b' option to specify offsets for each file.
  34  *
  35  * February 19, 2005 - mbm
  36  *
  37  * Add -a (align offset) and -b (absolute offset)
  38  */
  39
  40 #include <stdio.h>
  41 #include <stdlib.h>
  42 #include <stddef.h>
  43 #include <stdint.h>
  44 #include <string.h>
  45 #include <errno.h>
  46 #include <unistd.h>
  47 #include <endian.h>
  48 #include <byteswap.h>
  49
  50 #if __BYTE_ORDER == __BIG_ENDIAN
  51 #define STORE32_LE(X)           bswap_32(X)
  52 #elif __BYTE_ORDER == __LITTLE_ENDIAN
  53 #define STORE32_LE(X)           (X)
  54 #else
  55 #error unkown endianness!
  56 #endif
  57
  58 uint32_t crc32buf(char *buf, size_t len);
  59
  60 /**********************************************************************/
  61 /* from trxhdr.h */
  62
  63 #define TRX_MAGIC       0x30524448      /* "HDR0" */
  64 #define TRX_VERSION     1
  65 #define TRX_MAX_LEN     0x5A0000
  66 #define TRX_NO_HEADER   1               /* Do not write TRX header */
  67
  68 struct trx_header {
  69         uint32_t magic;                 /* "HDR0" */
  70         uint32_t len;                   /* Length of file including header */
  71         uint32_t crc32;                 /* 32-bit CRC from flag_version to end of file */
  72         uint32_t flag_version;  /* 0:15 flags, 16:31 version */
  73         uint32_t offsets[3];    /* Offsets of partitions from start of header */
  74 };
  75
  76 /**********************************************************************/
  77
  78 void usage(void) __attribute__ (( __noreturn__ ));
  79
  80 void usage(void)
  81 {
  82         fprintf(stderr, "Usage: trx [-o outfile] [-m maxlen] [-a align] [-b offset] file [file [file]]\n");
  83         exit(EXIT_FAILURE);
  84 }
  85
  86 int main(int argc, char **argv)
  87 {
  88         FILE *out = stdout;
  89         FILE *in;
  90         char *ofn = NULL;
  91         char *buf;
  92         char *e;
  93         int c, i;
  94         size_t n;
  95         uint32_t cur_len;
  96         unsigned long maxlen = TRX_MAX_LEN;
  97         struct trx_header *p;
  98
  99         fprintf(stderr, "mjn3's trx replacement - v0.81.1\n");
 100
 101         if (!(buf = malloc(maxlen))) {
 102                 fprintf(stderr, "malloc failed\n");
 103                 return EXIT_FAILURE;
 104         }
 105
 106         p = (struct trx_header *) buf;
 107
 108         p->magic = STORE32_LE(TRX_MAGIC);
 109         cur_len = sizeof(struct trx_header);
 110         p->flag_version = STORE32_LE((TRX_VERSION << 16));
 111
 112         in = NULL;
 113         i = 0;
 114
 115         while ((c = getopt(argc, argv, "-:o:m:a:b:")) != -1) {
 116                 switch (c) {
 117                         case 1:
 118                                 p->offsets[i++] = STORE32_LE(cur_len);
 119
 120                                 if (!(in = fopen(optarg, "r"))) {
 121                                         fprintf(stderr, "can not open \"%s\" for reading\n", optarg);
 122                                         usage();
 123                                 }
 124                                 n = fread(buf + cur_len, 1, maxlen - cur_len, in);
 125                                 if (!feof(in)) {
 126                                         fprintf(stderr, "fread failure or file \"%s\" too large\n",optarg);
 127                                         fclose(in);
 128                                         return EXIT_FAILURE;
 129                                 }
 130                                 fclose(in);
 131 #undef  ROUND
 132 #define ROUND 4
 133                                 if (n & (ROUND-1)) {
 134                                         memset(buf + cur_len + n, 0, ROUND - (n & (ROUND-1)));
 135                                         n += ROUND - (n & (ROUND-1));
 136                                 }
 137                                 cur_len += n;
 138
 139                                 break;
 140                         case 'o':
 141                                 ofn = optarg;
 142                                 if (ofn && !(out = fopen(ofn, "w"))) {
 143                                         fprintf(stderr, "can not open \"%s\" for writing\n", ofn);
 144                                         usage();
 145                                 }
 146
 147                                 break;
 148                         case 'm':
 149                                 errno = 0;
 150                                 maxlen = strtoul(optarg, &e, 0);
 151                                 if (errno || (e == optarg) || *e) {
 152                                         fprintf(stderr, "illegal numeric string\n");
 153                                         usage();
 154                                 }
 155 #undef  ROUND
 156 #define ROUND 0x1000
 157                                 if (maxlen & (ROUND-1)) {
 158                                         maxlen += (ROUND - (maxlen & (ROUND-1)));
 159                                 }
 160                                 if (maxlen < ROUND) {
 161                                         fprintf(stderr, "maxlen too small (or wrapped)\n");
 162                                         usage();
 163                                 }
 164                                 if (maxlen > TRX_MAX_LEN) {
 165                                         fprintf(stderr, "WARNING: maxlen exceeds default maximum!  Beware of overwriting nvram!\n");
 166                                 }
 167                                 if (!(buf = realloc(buf,maxlen))) {
 168                                         fprintf(stderr, "realloc failed");
 169                                         return EXIT_FAILURE;
 170                                 }
 171                                 break;
 172                         case 'a':
 173                                 errno = 0;
 174                                 n = strtoul(optarg, &e, 0);
 175                                 if (errno || (e == optarg) || *e) {
 176                                         fprintf(stderr, "illegal numeric string\n");
 177                                         usage();
 178                                 }
 179                                 if (cur_len & (n-1)) {
 180                                         n = n - (cur_len & (n-1));
 181                                         memset(buf + cur_len, 0, n);
 182                                         cur_len += n;
 183                                 }
 184                                 break;
 185                         case 'b':
 186                                 errno = 0;
 187                                 n = strtoul(optarg, &e, 0);
 188                                 if (errno || (e == optarg) || *e) {
 189                                         fprintf(stderr, "illegal numeric string\n");
 190                                         usage();
 191                                 }
 192                                 if (n < cur_len) {
 193                                         fprintf(stderr, "WARNING: current length exceeds -b %d offset\n",n);
 194                                 } else {
 195                                         memset(buf + cur_len, 0, n - cur_len);
 196                                         cur_len = n;
 197                                 }
 198                                 break;
 199                         default:
 200                                 usage();
 201                 }
 202         }
 203
 204         if (!in) {
 205                 fprintf(stderr, "we require atleast one filename\n");
 206                 usage();
 207         }
 208
 209 #undef  ROUND
 210 #define ROUND 0x1000
 211         n = cur_len & (ROUND-1);
 212         if (n) {
 213                 memset(buf + cur_len, 0, ROUND - n);
 214                 cur_len += ROUND - n;
 215         }
 216
 217         p->crc32 = crc32buf((char *) &p->flag_version,
 218                                                 cur_len - offsetof(struct trx_header, flag_version));
 219         p->crc32 = STORE32_LE(p->crc32);
 220
 221         p->len = STORE32_LE(cur_len);
 222
 223         if (!fwrite(buf, cur_len, 1, out) || fflush(out)) {
 224                 fprintf(stderr, "fwrite failed\n");
 225                 return EXIT_FAILURE;
 226         }
 227
 228         fclose(out);
 229
 230         return EXIT_SUCCESS;
 231 }
 232
 233 /**********************************************************************/
 234 /* The following was grabbed and tweaked from the old snippets collection
 235  * of public domain C code. */
 236
 237 /**********************************************************************\
 238 |* Demonstration program to compute the 32-bit CRC used as the frame  *|
 239 |* check sequence in ADCCP (ANSI X3.66, also known as FIPS PUB 71     *|
 240 |* and FED-STD-1003, the U.S. versions of CCITT's X.25 link-level     *|
 241 |* protocol).  The 32-bit FCS was added via the Federal Register,     *|
 242 |* 1 June 1982, p.23798.  I presume but don't know for certain that   *|
 243 |* this polynomial is or will be included in CCITT V.41, which        *|
 244 |* defines the 16-bit CRC (often called CRC-CCITT) polynomial.  FIPS  *|
 245 |* PUB 78 says that the 32-bit FCS reduces otherwise undetected       *|
 246 |* errors by a factor of 10^-5 over 16-bit FCS.                       *|
 247 \**********************************************************************/
 248
 249 /* Copyright (C) 1986 Gary S. Brown.  You may use this program, or
 250    code or tables extracted from it, as desired without restriction.*/
 251
 252 /* First, the polynomial itself and its table of feedback terms.  The  */
 253 /* polynomial is                                                       */
 254 /* X^32+X^26+X^23+X^22+X^16+X^12+X^11+X^10+X^8+X^7+X^5+X^4+X^2+X^1+X^0 */
 255 /* Note that we take it "backwards" and put the highest-order term in  */
 256 /* the lowest-order bit.  The X^32 term is "implied"; the LSB is the   */
 257 /* X^31 term, etc.  The X^0 term (usually shown as "+1") results in    */
 258 /* the MSB being 1.                                                    */
 259
 260 /* Note that the usual hardware shift register implementation, which   */
 261 /* is what we're using (we're merely optimizing it by doing eight-bit  */
 262 /* chunks at a time) shifts bits into the lowest-order term.  In our   */
 263 /* implementation, that means shifting towards the right.  Why do we   */
 264 /* do it this way?  Because the calculated CRC must be transmitted in  */
 265 /* order from highest-order term to lowest-order term.  UARTs transmit */
 266 /* characters in order from LSB to MSB.  By storing the CRC this way,  */
 267 /* we hand it to the UART in the order low-byte to high-byte; the UART */
 268 /* sends each low-bit to hight-bit; and the result is transmission bit */
 269 /* by bit from highest- to lowest-order term without requiring any bit */
 270 /* shuffling on our part.  Reception works similarly.                  */
 271
 272 /* The feedback terms table consists of 256, 32-bit entries.  Notes:   */
 273 /*                                                                     */
 274 /*  1. The table can be generated at runtime if desired; code to do so */
 275 /*     is shown later.  It might not be obvious, but the feedback      */
 276 /*     terms simply represent the results of eight shift/xor opera-    */
 277 /*     tions for all combinations of data and CRC register values.     */
 278 /*                                                                     */
 279 /*  2. The CRC accumulation logic is the same for all CRC polynomials, */
 280 /*     be they sixteen or thirty-two bits wide.  You simply choose the */
 281 /*     appropriate table.  Alternatively, because the table can be     */
 282 /*     generated at runtime, you can start by generating the table for */
 283 /*     the polynomial in question and use exactly the same "updcrc",   */
 284 /*     if your application needn't simultaneously handle two CRC       */
 285 /*     polynomials.  (Note, however, that XMODEM is strange.)          */
 286 /*                                                                     */
 287 /*  3. For 16-bit CRCs, the table entries need be only 16 bits wide;   */
 288 /*     of course, 32-bit entries work OK if the high 16 bits are zero. */
 289 /*                                                                     */
 290 /*  4. The values must be right-shifted by eight bits by the "updcrc"  */
 291 /*     logic; the shift must be unsigned (bring in zeroes).  On some   */
 292 /*     hardware you could probably optimize the shift in assembler by  */
 293 /*     using byte-swap instructions.                                   */
 294
 295 static const uint32_t crc_32_tab[] = { /* CRC polynomial 0xedb88320 */
 296 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
 297 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
 298 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2,
 299 0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
 300 0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
 301 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172,
 302 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c,
 303 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
 304 0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423,
 305 0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
 306 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106,
 307 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
 308 0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d,
 309 0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e,
 310 0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
 311 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
 312 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7,
 313 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0,
 314 0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa,
 315 0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
 316 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81,
 317 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
 318 0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84,
 319 0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
 320 0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
 321 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc,
 322 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e,
 323 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
 324 0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55,
 325 0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
 326 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28,
 327 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
 328 0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f,
 329 0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
 330 0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
 331 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
 332 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69,
 333 0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2,
 334 0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc,
 335 0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
 336 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693,
 337 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
 338 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
 339 };
 340
 341 #define UPDC32(octet,crc) (crc_32_tab[((crc) ^ (octet)) & 0xff] ^ ((crc) >> 8))
 342
 343 uint32_t crc32buf(char *buf, size_t len)
 344 {
 345       uint32_t crc;
 346
 347       crc = 0xFFFFFFFF;
 348
 349       for ( ; len; --len, ++buf)
 350       {
 351             crc = UPDC32(*buf, crc);
 352       }
 353
 354       return crc;
 355 }