1 /* 2 * TRX image file header format. 3 * 4 * Copyright (C) 1999-2017, Broadcom Corporation 5 * 6 * Unless you and Broadcom execute a separate written software license 7 * agreement governing use of this software, this software is licensed to you 8 * under the terms of the GNU General Public License version 2 (the "GPL"), 9 * available at http://www.broadcom.com/licenses/GPLv2.php, with the 10 * following added to such license: 11 * 12 * As a special exception, the copyright holders of this software give you 13 * permission to link this software with independent modules, and to copy and 14 * distribute the resulting executable under terms of your choice, provided that 15 * you also meet, for each linked independent module, the terms and conditions of 16 * the license of that module. An independent module is a module which is not 17 * derived from this software. The special exception does not apply to any 18 * modifications of the software. 19 * 20 * Notwithstanding the above, under no circumstances may you combine this 21 * software in any way with any other Broadcom software provided under a license 22 * other than the GPL, without Broadcom's express prior written consent. 23 * 24 * 25 * <<Broadcom-WL-IPTag/Open:>> 26 * 27 * $Id: trxhdr.h 520026 2014-12-10 01:29:40Z $ 28 */ 29 30 #ifndef _TRX_HDR_H 31 #define _TRX_HDR_H 32 33 #include <typedefs.h> 34 35 #define TRX_MAGIC 0x30524448 /* "HDR0" */ 36 #define TRX_MAX_LEN 0x3B0000 /* Max length */ 37 #define TRX_NO_HEADER 1 /* Do not write TRX header */ 38 #define TRX_GZ_FILES 0x2 /* Contains up to TRX_MAX_OFFSET individual gzip files */ 39 #define TRX_EMBED_UCODE 0x8 /* Trx contains embedded ucode image */ 40 #define TRX_ROMSIM_IMAGE 0x10 /* Trx contains ROM simulation image */ 41 #define TRX_UNCOMP_IMAGE 0x20 /* Trx contains uncompressed rtecdc.bin image */ 42 #define TRX_BOOTLOADER 0x40 /* the image is a bootloader */ 43 44 #define TRX_V1 1 45 #define TRX_V1_MAX_OFFSETS 3 /* V1: Max number of individual files */ 46 47 #ifndef BCMTRXV2 48 #define TRX_VERSION TRX_V1 /* Version 1 */ 49 #define TRX_MAX_OFFSET TRX_V1_MAX_OFFSETS 50 #endif 51 52 /* BMAC Host driver/application like bcmdl need to support both Ver 1 as well as 53 * Ver 2 of trx header. To make it generic, trx_header is structure is modified 54 * as below where size of "offsets" field will vary as per the TRX version. 55 * Currently, BMAC host driver and bcmdl are modified to support TRXV2 as well. 56 * To make sure, other applications like "dhdl" which are yet to be enhanced to support 57 * TRXV2 are not broken, new macro and structure defintion take effect only when BCMTRXV2 58 * is defined. 59 */ 60 struct trx_header { 61 uint32 magic; /* "HDR0" */ 62 uint32 len; /* Length of file including header */ 63 uint32 crc32; /* 32-bit CRC from flag_version to end of file */ 64 uint32 flag_version; /* 0:15 flags, 16:31 version */ 65 #ifndef BCMTRXV2 66 uint32 offsets[TRX_MAX_OFFSET]; /* Offsets of partitions from start of header */ 67 #else 68 uint32 offsets[1]; /* Offsets of partitions from start of header */ 69 #endif 70 }; 71 72 #ifdef BCMTRXV2 73 #define TRX_VERSION TRX_V2 /* Version 2 */ 74 #define TRX_MAX_OFFSET TRX_V2_MAX_OFFSETS 75 76 #define TRX_V2 2 77 /* V2: Max number of individual files 78 * To support SDR signature + Config data region 79 */ 80 #define TRX_V2_MAX_OFFSETS 5 81 #define SIZEOF_TRXHDR_V1 (sizeof(struct trx_header)+(TRX_V1_MAX_OFFSETS-1)*sizeof(uint32)) 82 #define SIZEOF_TRXHDR_V2 (sizeof(struct trx_header)+(TRX_V2_MAX_OFFSETS-1)*sizeof(uint32)) 83 #define TRX_VER(trx) ((trx)->flag_version>>16) 84 #define ISTRX_V1(trx) (TRX_VER(trx) == TRX_V1) 85 #define ISTRX_V2(trx) (TRX_VER(trx) == TRX_V2) 86 /* For V2, return size of V2 size: others, return V1 size */ 87 #define SIZEOF_TRX(trx) (ISTRX_V2(trx) ? SIZEOF_TRXHDR_V2: SIZEOF_TRXHDR_V1) 88 #else 89 #define SIZEOF_TRX(trx) (sizeof(struct trx_header)) 90 #endif /* BCMTRXV2 */ 91 92 /* Compatibility */ 93 typedef struct trx_header TRXHDR, *PTRXHDR; 94 95 #endif /* _TRX_HDR_H */ 96