1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * TRX image file header format. 4 * 5 * Copyright (C) 1999-2019, Broadcom. 6 * 7 * Unless you and Broadcom execute a separate written software license 8 * agreement governing use of this software, this software is licensed to you 9 * under the terms of the GNU General Public License version 2 (the "GPL"), 10 * available at http://www.broadcom.com/licenses/GPLv2.php, with the 11 * following added to such license: 12 * 13 * As a special exception, the copyright holders of this software give you 14 * permission to link this software with independent modules, and to copy and 15 * distribute the resulting executable under terms of your choice, provided that 16 * you also meet, for each linked independent module, the terms and conditions of 17 * the license of that module. An independent module is a module which is not 18 * derived from this software. The special exception does not apply to any 19 * modifications of the software. 20 * 21 * Notwithstanding the above, under no circumstances may you combine this 22 * software in any way with any other Broadcom software provided under a license 23 * other than the GPL, without Broadcom's express prior written consent. 24 * 25 * 26 * <<Broadcom-WL-IPTag/Open:>> 27 * 28 * $Id: trxhdr.h 520026 2014-12-10 01:29:40Z $ 29 */ 30 31 #ifndef _TRX_HDR_H 32 #define _TRX_HDR_H 33 34 #include <typedefs.h> 35 36 #define TRX_MAGIC 0x30524448 /* "HDR0" */ 37 #define TRX_MAX_LEN 0x3B0000 /* Max length */ 38 #define TRX_NO_HEADER 1 /* Do not write TRX header */ 39 #define TRX_GZ_FILES 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 support 58 * TRXV2 are not broken, new macro and structure defintion take effect only when BCMTRXV2 59 * 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 header */ 68 #else 69 uint32 offsets[1]; /* Offsets of partitions from start of header */ 70 #endif // endif 71 }; 72 73 #ifdef BCMTRXV2 74 #define TRX_VERSION TRX_V2 /* Version 2 */ 75 #define TRX_MAX_OFFSET TRX_V2_MAX_OFFSETS 76 77 #define TRX_V2 2 78 /* V2: Max number of individual files 79 * To support SDR signature + Config data region 80 */ 81 #define TRX_V2_MAX_OFFSETS 5 82 #define SIZEOF_TRXHDR_V1 (sizeof(struct trx_header)+(TRX_V1_MAX_OFFSETS-1)*sizeof(uint32)) 83 #define SIZEOF_TRXHDR_V2 (sizeof(struct trx_header)+(TRX_V2_MAX_OFFSETS-1)*sizeof(uint32)) 84 #define TRX_VER(trx) ((trx)->flag_version>>16) 85 #define ISTRX_V1(trx) (TRX_VER(trx) == TRX_V1) 86 #define ISTRX_V2(trx) (TRX_VER(trx) == TRX_V2) 87 /* For V2, return size of V2 size: others, return V1 size */ 88 #define SIZEOF_TRX(trx) (ISTRX_V2(trx) ? SIZEOF_TRXHDR_V2: SIZEOF_TRXHDR_V1) 89 #else 90 #define SIZEOF_TRX(trx) (sizeof(struct trx_header)) 91 #endif /* BCMTRXV2 */ 92 93 /* Compatibility */ 94 typedef struct trx_header TRXHDR, *PTRXHDR; 95 96 #endif /* _TRX_HDR_H */ 97