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