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