1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) */ 2 /* 3 * This file is provided under a dual BSD/GPLv2 license. When using or 4 * redistributing this file, you may do so under either license. 5 * 6 * Copyright(c) 2018 Intel Corporation. All rights reserved. 7 */ 8 9 /* 10 * Firmware file format . 11 */ 12 13 #ifndef __INCLUDE_UAPI_SOF_FW_H__ 14 #define __INCLUDE_UAPI_SOF_FW_H__ 15 16 #define SND_SOF_FW_SIG_SIZE 4 17 #define SND_SOF_FW_ABI 1 18 #define SND_SOF_FW_SIG "Reef" 19 20 /* 21 * Firmware module is made up of 1 . N blocks of different types. The 22 * Block header is used to determine where and how block is to be copied in the 23 * DSP/host memory space. 24 */ 25 enum snd_sof_fw_blk_type { 26 SOF_FW_BLK_TYPE_INVALID = -1, 27 SOF_FW_BLK_TYPE_START = 0, 28 SOF_FW_BLK_TYPE_RSRVD0 = SOF_FW_BLK_TYPE_START, 29 SOF_FW_BLK_TYPE_IRAM = 1, /* local instruction RAM */ 30 SOF_FW_BLK_TYPE_DRAM = 2, /* local data RAM */ 31 SOF_FW_BLK_TYPE_SRAM = 3, /* system RAM */ 32 SOF_FW_BLK_TYPE_ROM = 4, 33 SOF_FW_BLK_TYPE_IMR = 5, 34 SOF_FW_BLK_TYPE_RSRVD6 = 6, 35 SOF_FW_BLK_TYPE_RSRVD7 = 7, 36 SOF_FW_BLK_TYPE_RSRVD8 = 8, 37 SOF_FW_BLK_TYPE_RSRVD9 = 9, 38 SOF_FW_BLK_TYPE_RSRVD10 = 10, 39 SOF_FW_BLK_TYPE_RSRVD11 = 11, 40 SOF_FW_BLK_TYPE_RSRVD12 = 12, 41 SOF_FW_BLK_TYPE_RSRVD13 = 13, 42 SOF_FW_BLK_TYPE_RSRVD14 = 14, 43 /* use SOF_FW_BLK_TYPE_RSVRDX for new block types */ 44 SOF_FW_BLK_TYPE_NUM 45 }; 46 47 struct snd_sof_blk_hdr { 48 enum snd_sof_fw_blk_type type; 49 uint32_t size; /* bytes minus this header */ 50 uint32_t offset; /* offset from base */ 51 } __packed; 52 53 /* 54 * Firmware file is made up of 1 .. N different modules types. The module 55 * type is used to determine how to load and parse the module. 56 */ 57 enum snd_sof_fw_mod_type { 58 SOF_FW_BASE = 0, /* base firmware image */ 59 SOF_FW_MODULE = 1, /* firmware module */ 60 }; 61 62 struct snd_sof_mod_hdr { 63 enum snd_sof_fw_mod_type type; 64 uint32_t size; /* bytes minus this header */ 65 uint32_t num_blocks; /* number of blocks */ 66 } __packed; 67 68 /* 69 * Firmware file header. 70 */ 71 struct snd_sof_fw_header { 72 unsigned char sig[SND_SOF_FW_SIG_SIZE]; /* "Reef" */ 73 uint32_t file_size; /* size of file minus this header */ 74 uint32_t num_modules; /* number of modules */ 75 uint32_t abi; /* version of header format */ 76 } __packed; 77 78 #endif 79