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