--- /dev/null
+/*
+ Copyright 2000-2010 Broadcom Corporation
+
+ Unless you and Broadcom execute a separate written software license
+ agreement governing use of this software, this software is licensed
+ to you under the terms of the GNU General Public License version 2
+ (the \93GPL?, available at http://www.broadcom.com/licenses/GPLv2.php,
+ with the following added to such license:
+
+ As a special exception, the copyright holders of this software give
+ you permission to link this software with independent modules, and to
+ copy and distribute the resulting executable under terms of your
+ choice, provided that you also meet, for each linked independent
+ module, the terms and conditions of the license of that module.
+ An independent module is a module which is not derived from this
+ software. The special exception does not apply to any modifications
+ of the software.
+
+ Notwithstanding the above, under no circumstances may you combine this
+ software in any way with any other Broadcom software provided under a
+ license other than the GPL, without Broadcom's express prior written
+ consent.
+*/
+
+//**************************************************************************************
+// File Name : bcmTag.h
+//
+// Description: add tag with validation system to the firmware image file to be uploaded
+// via http
+//
+// Created : 02/28/2002 seanl
+//**************************************************************************************
+
+#ifndef _BCMTAG_H_
+#define _BCMTAG_H_
+
+
+#define BCM_SIG_1 "Broadcom Corporation"
+#define BCM_SIG_2 "ver. 2.0" // was "firmware version 2.0" now it is split 6 char out for chip id.
+
+#define BCM_TAG_VER "6"
+
+// file tag (head) structure all is in clear text except validationTokens (crc, md5, sha1, etc). Total: 128 unsigned chars
+#define TAG_LEN 256
+#if 1 //__MSTC__, RaynorChung: Support 963268 nand flash, patch form SVN#3597 on http://svn.zyxel.com.tw/svn/CPE_SW1/BCM96368/trunk/P-870HA/branches/cht/fttb8/4.11
+#if defined(INC_NAND_FLASH_DRIVER) && (INC_NAND_FLASH_DRIVER==1)
+#define TAG_BLOCK_LEN 128*1024
+#else
+#define TAG_BLOCK_LEN 256
+#endif
+#define TAG_BLOCK_LEN_NAND 128*1024
+#endif
+#define TAG_VER_LEN 4
+#define SIG_LEN 20
+#define SIG_LEN_2 14 // Original second SIG = 20 is now devided into 14 for SIG_LEN_2 and 6 for CHIP_ID
+#define CHIP_ID_LEN 6
+#define IMAGE_LEN 10
+#define ADDRESS_LEN 12
+#define FLAG_LEN 2
+#define TOKEN_LEN 20
+#define BOARD_ID_LEN 16
+#if 1//__MSTC__, RaynorChung: Support 963268 nand flash, patch form SVN#3597 on http://svn.zyxel.com.tw/svn/CPE_SW1/BCM96368/trunk/P-870HA/branches/cht/fttb8/4.11
+#define VERSION_LEN 32
+#define MODEL_ID_LEN 5
+#endif
+#define IMAGE_VER_LEN 32
+#if 1 //__TELUS__, for HPNA software version
+#define HPNA_SWVERSION_LEN 8
+#endif
+#if 1 //__MSTC__, Dennis merge from ZyXEL ROM-D feature, zongyue
+#define NEXT_IMAGE_FLAG 1
+#endif
+#if 1//__MSTC__, RaynorChung: Support 963268 nand flash, patch form SVN#3597 on http://svn.zyxel.com.tw/svn/CPE_SW1/BCM96368/trunk/P-870HA/branches/cht/fttb8/4.11
+#define RESERVED_LEN (TAG_LEN - TAG_VER_LEN - SIG_LEN - SIG_LEN_2 - CHIP_ID_LEN - BOARD_ID_LEN - \
+ (4*IMAGE_LEN) - (3*ADDRESS_LEN) - (3*FLAG_LEN) - (2*VERSION_LEN) - \
+ (2*TOKEN_LEN) - NEXT_IMAGE_FLAG)
+#else
+#define RESERVED_LEN (TAG_LEN - TAG_VER_LEN - SIG_LEN - SIG_LEN_2 - CHIP_ID_LEN - BOARD_ID_LEN - \
+ (4*IMAGE_LEN) - (3*ADDRESS_LEN) - (3*FLAG_LEN) - (2*TOKEN_LEN) - IMAGE_VER_LEN)
+#endif
+
+
+// TAG for downloadable image (kernel plus file system)
+typedef struct _FILE_TAG
+{
+ char tagVersion[TAG_VER_LEN]; // tag version. Will be 2 here.
+ char signiture_1[SIG_LEN]; // text line for company info
+ char signiture_2[SIG_LEN_2]; // additional info (can be version number)
+ char chipId[CHIP_ID_LEN]; // chip id
+ char boardId[BOARD_ID_LEN]; // board id
+ char bigEndian[FLAG_LEN]; // if = 1 - big, = 0 - little endia of the host
+ char totalImageLen[IMAGE_LEN]; // the sum of all the following length
+ char cfeAddress[ADDRESS_LEN]; // if non zero, cfe starting address
+ char cfeLen[IMAGE_LEN]; // if non zero, cfe size in clear ASCII text.
+ char rootfsAddress[ADDRESS_LEN]; // if non zero, filesystem starting address
+ char rootfsLen[IMAGE_LEN]; // if non zero, filesystem size in clear ASCII text.
+ char kernelAddress[ADDRESS_LEN]; // if non zero, kernel starting address
+ char kernelLen[IMAGE_LEN]; // if non zero, kernel size in clear ASCII text.
+ char imageSequence[FLAG_LEN * 2]; // incrments everytime an image is flashed
+#if 1//__MSTC__, RaynorChung: Support 963268 nand flash, patch form SVN#3597 on http://svn.zyxel.com.tw/svn/CPE_SW1/BCM96368/trunk/P-870HA/branches/cht/fttb8/4.11
+ char externalversion[VERSION_LEN]; // external version
+ char internalversion[VERSION_LEN]; // internal version
+#else
+ char imageVersion[IMAGE_VER_LEN]; // image version
+#endif
+#if 1 //__MSTC__, Dennis merge from ZyXEL ROM-D feature, zongyue
+ char imageNext[NEXT_IMAGE_FLAG]; // if non zero, has image at behind
+#endif
+ char reserved[RESERVED_LEN]; // reserved for later use
+ char imageValidationToken[TOKEN_LEN];// image validation token - can be crc, md5, sha; for
+ // now will be 4 unsigned char crc
+ char tagValidationToken[TOKEN_LEN]; // validation token for tag(from signiture_1 to end of // mageValidationToken)
+} FILE_TAG, *PFILE_TAG;
+
+/* Whole flash image TAG definitions. */
+#define WFI_VERSION 0x00005732
+#define WFI_ANY_VERS_MASK 0x0000ff00
+#define WFI_ANY_VERS 0x00005700
+#define WFI_VERSION_NAND_1MB_DATA 0x00005731
+#define WFI_NOR_FLASH 1
+#define WFI_NAND16_FLASH 2
+#define WFI_NAND128_FLASH 3
+
+/* TAG at end of whole flash ".w" image. Size must be TOKEN_LEN. */
+typedef struct _WFI_TAG
+{
+ unsigned long wfiCrc;
+ unsigned long wfiVersion;
+ unsigned long wfiChipId;
+ unsigned long wfiFlashType;
+ unsigned long wfiReserved;
+} WFI_TAG, *PWFI_TAG;
+
+#define CRC32_INIT_VALUE 0xffffffff /* Initial CRC32 checksum value */
+#define CRC_LEN 4
+
+#if 1 //__MSTC__, Dennis merge from ZyXEL ROM-D feature, zongyue
+#define IMAGE_TAG_LEN 32
+#define IMAGE_RESERVED_LEN (IMAGE_TAG_LEN - NEXT_IMAGE_FLAG - (2*FLAG_LEN) - IMAGE_LEN - (2*CRC_LEN))
+
+#define IMAGE_TYPE_IMGDEF 0
+#define IMAGE_TYPE_ROMD 1
+#define IMAGE_TYPE_HPNA 2
+typedef struct _IMAGE_TAG
+{
+ char imageNext[NEXT_IMAGE_FLAG]; /* if non zero, has image at behind */
+ char imageType[FLAG_LEN]; /* type of image */
+ char imageSignature[FLAG_LEN]; /* image signature */
+ char imageLen[IMAGE_LEN]; /* if non zero, image size in clear ASCII text */
+ char reserved[IMAGE_RESERVED_LEN]; /* reserved for later use */
+ char imageValidationToken[CRC_LEN]; /* image validation token, 4 unsigned char crc */
+ char tagValidationToken[CRC_LEN]; /* validation token for tag(from imageNext to end of imageValidationToken) */
+}IMAGE_TAG, *PIMAGE_TAG;
+#endif
+
+// only included if for bcmTag.exe program
+#ifdef BCMTAG_EXE_USE
+
+static unsigned long Crc32_table[256] = {
+ 0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA,
+ 0x076DC419, 0x706AF48F, 0xE963A535, 0x9E6495A3,
+ 0x0EDB8832, 0x79DCB8A4, 0xE0D5E91E, 0x97D2D988,
+ 0x09B64C2B, 0x7EB17CBD, 0xE7B82D07, 0x90BF1D91,
+ 0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE,
+ 0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7,
+ 0x136C9856, 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC,
+ 0x14015C4F, 0x63066CD9, 0xFA0F3D63, 0x8D080DF5,
+ 0x3B6E20C8, 0x4C69105E, 0xD56041E4, 0xA2677172,
+ 0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B,
+ 0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940,
+ 0x32D86CE3, 0x45DF5C75, 0xDCD60DCF, 0xABD13D59,
+ 0x26D930AC, 0x51DE003A, 0xC8D75180, 0xBFD06116,
+ 0x21B4F4B5, 0x56B3C423, 0xCFBA9599, 0xB8BDA50F,
+ 0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924,
+ 0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D,
+ 0x76DC4190, 0x01DB7106, 0x98D220BC, 0xEFD5102A,
+ 0x71B18589, 0x06B6B51F, 0x9FBFE4A5, 0xE8B8D433,
+ 0x7807C9A2, 0x0F00F934, 0x9609A88E, 0xE10E9818,
+ 0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01,
+ 0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E,
+ 0x6C0695ED, 0x1B01A57B, 0x8208F4C1, 0xF50FC457,
+ 0x65B0D9C6, 0x12B7E950, 0x8BBEB8EA, 0xFCB9887C,
+ 0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3, 0xFBD44C65,
+ 0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2,
+ 0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB,
+ 0x4369E96A, 0x346ED9FC, 0xAD678846, 0xDA60B8D0,
+ 0x44042D73, 0x33031DE5, 0xAA0A4C5F, 0xDD0D7CC9,
+ 0x5005713C, 0x270241AA, 0xBE0B1010, 0xC90C2086,
+ 0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F,
+ 0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4,
+ 0x59B33D17, 0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD,
+ 0xEDB88320, 0x9ABFB3B6, 0x03B6E20C, 0x74B1D29A,
+ 0xEAD54739, 0x9DD277AF, 0x04DB2615, 0x73DC1683,
+ 0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8,
+ 0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1,
+ 0xF00F9344, 0x8708A3D2, 0x1E01F268, 0x6906C2FE,
+ 0xF762575D, 0x806567CB, 0x196C3671, 0x6E6B06E7,
+ 0xFED41B76, 0x89D32BE0, 0x10DA7A5A, 0x67DD4ACC,
+ 0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5,
+ 0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252,
+ 0xD1BB67F1, 0xA6BC5767, 0x3FB506DD, 0x48B2364B,
+ 0xD80D2BDA, 0xAF0A1B4C, 0x36034AF6, 0x41047A60,
+ 0xDF60EFC3, 0xA867DF55, 0x316E8EEF, 0x4669BE79,
+ 0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236,
+ 0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F,
+ 0xC5BA3BBE, 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04,
+ 0xC2D7FFA7, 0xB5D0CF31, 0x2CD99E8B, 0x5BDEAE1D,
+ 0x9B64C2B0, 0xEC63F226, 0x756AA39C, 0x026D930A,
+ 0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713,
+ 0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38,
+ 0x92D28E9B, 0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21,
+ 0x86D3D2D4, 0xF1D4E242, 0x68DDB3F8, 0x1FDA836E,
+ 0x81BE16CD, 0xF6B9265B, 0x6FB077E1, 0x18B74777,
+ 0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C,
+ 0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45,
+ 0xA00AE278, 0xD70DD2EE, 0x4E048354, 0x3903B3C2,
+ 0xA7672661, 0xD06016F7, 0x4969474D, 0x3E6E77DB,
+ 0xAED16A4A, 0xD9D65ADC, 0x40DF0B66, 0x37D83BF0,
+ 0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9,
+ 0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6,
+ 0xBAD03605, 0xCDD70693, 0x54DE5729, 0x23D967BF,
+ 0xB3667A2E, 0xC4614AB8, 0x5D681B02, 0x2A6F2B94,
+ 0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B, 0x2D02EF8D
+};
+#endif // BCMTAG_USE
+
+
+#endif // _BCMTAG_H_
+
--- /dev/null
+static const char *title =\
+"Broadcom Consumer Router Firmware Header Dump"
+;
+static const float VERSION = 1.0f;
+
+static const char *copyright = \
+"Copyright 2015-2016 TJ <hacker@iam.tj>\n"
+"Licensed on the terms of the GNU General Public License version 3\n"
+;
+
+static const char *help = \
+"For routers using the Broadcom CFE ((Customer Premises Equipment) CPE Firmware Environment) and firmware update files.\n\n"
+
+"Displays the fields of the firmware update file header structure.\n\n"
+;
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <stdarg.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <unistd.h>
+#include <arpa/inet.h>
+#include <stdint.h>
+#include <stddef.h>
+
+#define BCMTAG_EXE_USE 1
+
+#include "heap_reap.h"
+#include "bcmTag.h"
+
+static unsigned int MESSAGE_SIZE = 1024;
+
+static void
+pr_usage(int verbose)
+{
+ fprintf(stderr,
+ "Usage:\n"
+ " -h show additional help\n"
+ "\n"
+ "%s",
+ verbose ? help : ""
+ );
+}
+
+static void
+pr_error_exit(unsigned int usage, const char *error, ...)
+{
+ va_list args;
+ char error_message[MESSAGE_SIZE + 1];
+
+ if (!error) return;
+
+ va_start(args, error);
+ (void) vsnprintf(error_message, MESSAGE_SIZE + 1, error, args);
+ va_end(args);
+ fprintf(stderr, "Error: %s\n", error_message);
+
+ if (usage) pr_usage(usage);
+
+ heap_and_reap(NULL-1, 0, 0);
+ exit(EXIT_FAILURE);
+}
+
+/* calculate standard CRC32
+ *
+ * @param data pointer to start of input data
+ * @param len length in bytes of data to be checksummed
+ * @param crc32 seed value (Broadcom use 0xffffffff)
+ */
+unsigned int crc32(const unsigned char *data, ssize_t len, unsigned int crc)
+{
+ for ( ; len > 0; --len ) {
+ crc = (crc >> 8) ^ Crc32_table[ (crc ^ *data++) & 0xff ];
+ }
+ return crc;
+}
+
+
+int
+main(int argc, char **argv)
+{
+ unsigned int arg, crc;
+ char *filename = NULL;
+ int fd, fd_mode;
+ unsigned char *buffer = NULL;
+ unsigned long header_len = sizeof(FILE_TAG);
+ char *format_spec_user = "%-12s Manufacturer: %s Model: %s CRC32: %08x Length: %ld File: %s\n";
+ char *format_spec_test = "%-12s %s %s %08x %ld\n";
+ char *format_spec = format_spec_user; // default output format
+
+ unsigned int opt_quiet;
+
+ opt_quiet = 0;
+
+ fprintf(stderr, "%s\nVersion: %0.2f\n%s\n", title, VERSION, copyright);
+
+ for (arg = 1; arg < (unsigned) argc; ++arg) {
+ char *p = argv[arg];
+ size_t arg_len = strlen(p);
+
+ if (p[0] == '-') {
+ if(p[1] != 0) {
+ switch (p[1]) {
+ case 'h': // help
+ pr_usage(1);
+ goto end;
+ }
+ } else {
+ pr_error_exit(0, "cannot read data from stdin; provide a filename");
+ }
+ continue;
+ }
+ else if (!filename) { // remaining non-option must be the filename
+ filename = p;
+ } else {
+ if (!opt_quiet)
+ fprintf(stderr, "Can only process one file; ignoring '%s'\n", p);
+ }
+ }
+
+
+ fd_mode = O_RDONLY;
+
+ if (filename) {
+ if ((fd = open(filename, fd_mode)) > 0) {
+ if ( (buffer = heap_and_reap(NULL, header_len, 1)) != NULL) {
+ ssize_t qty;
+ if ( (qty = read(fd, buffer, header_len)) < header_len) {
+ if (!opt_quiet)
+ fprintf(stderr, "warning: only able to read %ld of %ld bytes\n", qty, header_len);
+ header_len = qty;
+ }
+ } else {
+ close(fd);
+ pr_error_exit(0, "unable to allocate memory (%ld bytes)\n", header_len);
+ }
+
+ PFILE_TAG header = (PFILE_TAG) buffer;
+ printf("%04lx Tag Version: %s\n"
+ "%04lx Signature 1: %s\n"
+ "%04lx Signature 2: %s\n"
+ "%04lx Chip ID: %s\n"
+ "%04lx Board ID: %s\n"
+ "%04lx Big Endian: %s\n"
+ "%04lx Image Len: %s (0x%08lx)\n"
+ "%04lx CFE Address: %s (0x%08lx)\n"
+ "%04lx CFE Len: %s (0x%08lx)\n"
+ "%04lx Root FS Address: %s (0x%08lx)\n"
+ "%04lx Root FS Len: %s (0x%08lx)\n"
+ "%04lx Kernel Address: %s (0x%08lx)\n"
+ "%04lx Kernel Len: %s (0x%08lx)\n"
+ "%04lx Image Sequence: %s (0x%08x)\n"
+ "%04lx External Version: %s\n"
+ "%04lx Internal Version: %s\n"
+ "%04lx Image Next: %u\n"
+ "%04lx Image Validation Token: 0x%0x\n"
+ "%04lx Tag Validation Token: 0x%0x\n"
+ "",
+ offsetof(struct _FILE_TAG, tagVersion), header->tagVersion,
+ offsetof(struct _FILE_TAG, signiture_1), header->signiture_1,
+ offsetof(struct _FILE_TAG, signiture_2), header->signiture_2,
+ offsetof(struct _FILE_TAG, chipId), header->chipId,
+ offsetof(struct _FILE_TAG, boardId), header->boardId,
+ offsetof(struct _FILE_TAG, bigEndian), *header->bigEndian == '1' ? "Yes" : "No",
+ offsetof(struct _FILE_TAG, totalImageLen), header->totalImageLen, atol(header->totalImageLen),
+ offsetof(struct _FILE_TAG, cfeAddress), header->cfeAddress, atol(header->cfeAddress),
+ offsetof(struct _FILE_TAG, cfeLen), header->cfeLen, atol(header->cfeLen),
+ offsetof(struct _FILE_TAG, rootfsAddress), header->rootfsAddress, atol(header->rootfsAddress),
+ offsetof(struct _FILE_TAG, rootfsLen), header->rootfsLen, atol(header->rootfsLen),
+ offsetof(struct _FILE_TAG, kernelAddress), header->kernelAddress, atol(header->kernelAddress),
+ offsetof(struct _FILE_TAG, kernelLen), header->kernelLen, atol(header->kernelLen),
+ offsetof(struct _FILE_TAG, imageSequence), header->imageSequence, atoi(header->imageSequence),
+ offsetof(struct _FILE_TAG, externalversion), header->externalversion,
+ offsetof(struct _FILE_TAG, internalversion), header->internalversion,
+ offsetof(struct _FILE_TAG, imageNext), (unsigned int)*(unsigned char *)(header->imageNext),
+ offsetof(struct _FILE_TAG, imageValidationToken), ntohl( *((unsigned int *)(header->imageValidationToken)) ),
+ offsetof(struct _FILE_TAG, tagValidationToken), ntohl( *((unsigned int *)(header->tagValidationToken)) )
+ );
+
+ heap_and_reap(buffer, 0, 0);
+ close(fd);
+ } else {
+ fprintf(stderr, "Unable to open for %s (%s)\n", "reading" , filename );
+ }
+ } else {
+ pr_usage(0);
+ }
+
+end:
+ heap_and_reap(NULL-1, 0, 0);
+ return 0;
+}
+
projects / firmware_header_dump.git / commitdiff