1 /* 2 * TRX image file header format. 3 * 4 * Copyright (C) 1999-2019, Broadcom. 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 16 * of the license of that module. An independent module is a module which is 17 * not 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 \ 39 0x2 /* Contains up to TRX_MAX_OFFSET individual gzip files */ 40 #define TRX_EMBED_UCODE 0x8 /* Trx contains embedded ucode image */ 41 #define TRX_ROMSIM_IMAGE 0x10 /* Trx contains ROM simulation image */ 42 #define TRX_UNCOMP_IMAGE 0x20 /* Trx contains uncompressed rtecdc.bin image */ 43 #define TRX_BOOTLOADER 0x40 /* the image is a bootloader */ 44 45 #define TRX_V1 1 46 #define TRX_V1_MAX_OFFSETS 3 /* V1: Max number of individual files */ 47 48 #ifndef BCMTRXV2 49 #define TRX_VERSION TRX_V1 /* Version 1 */ 50 #define TRX_MAX_OFFSET TRX_V1_MAX_OFFSETS 51 #endif // endif 52 53 /* BMAC Host driver/application like bcmdl need to support both Ver 1 as well as 54 * Ver 2 of trx header. To make it generic, trx_header is structure is modified 55 * as below where size of "offsets" field will vary as per the TRX version. 56 * Currently, BMAC host driver and bcmdl are modified to support TRXV2 as well. 57 * To make sure, other applications like "dhdl" which are yet to be enhanced to 58 * support TRXV2 are not broken, new macro and structure defintion take effect 59 * only when BCMTRXV2 is defined. 60 */ 61 struct trx_header { 62 uint32 magic; /* "HDR0" */ 63 uint32 len; /* Length of file including header */ 64 uint32 crc32; /* 32-bit CRC from flag_version to end of file */ 65 uint32 flag_version; /* 0:15 flags, 16:31 version */ 66 #ifndef BCMTRXV2 67 uint32 offsets[TRX_MAX_OFFSET]; /* Offsets of partitions from start of 68 header */ 69 #else 70 uint32 offsets[1]; /* Offsets of partitions from start of header */ 71 #endif // endif 72 }; 73 74 #ifdef BCMTRXV2 75 #define TRX_VERSION TRX_V2 /* Version 2 */ 76 #define TRX_MAX_OFFSET TRX_V2_MAX_OFFSETS 77 78 #define TRX_V2 2 79 /* V2: Max number of individual files 80 * To support SDR signature + Config data region 81 */ 82 #define TRX_V2_MAX_OFFSETS 5 83 #define SIZEOF_TRXHDR_V1 \ 84 (sizeof(struct trx_header) + (TRX_V1_MAX_OFFSETS - 1) * sizeof(uint32)) 85 #define SIZEOF_TRXHDR_V2 \ 86 (sizeof(struct trx_header) + (TRX_V2_MAX_OFFSETS - 1) * sizeof(uint32)) 87 #define TRX_VER(trx) ((trx)->flag_version >> 16) 88 #define ISTRX_V1(trx) (TRX_VER(trx) == TRX_V1) 89 #define ISTRX_V2(trx) (TRX_VER(trx) == TRX_V2) 90 /* For V2, return size of V2 size: others, return V1 size */ 91 #define SIZEOF_TRX(trx) (ISTRX_V2(trx) ? SIZEOF_TRXHDR_V2 : SIZEOF_TRXHDR_V1) 92 #else 93 #define SIZEOF_TRX(trx) (sizeof(struct trx_header)) 94 #endif /* BCMTRXV2 */ 95 96 /* Compatibility */ 97 typedef struct trx_header TRXHDR, *PTRXHDR; 98 99 #endif /* _TRX_HDR_H */ 100