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