1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */ 2*4882a593Smuzhiyun /* 3*4882a593Smuzhiyun * wmfw.h - Wolfson firmware format information 4*4882a593Smuzhiyun * 5*4882a593Smuzhiyun * Copyright 2012 Wolfson Microelectronics plc 6*4882a593Smuzhiyun * 7*4882a593Smuzhiyun * Author: Mark Brown <broonie@opensource.wolfsonmicro.com> 8*4882a593Smuzhiyun */ 9*4882a593Smuzhiyun 10*4882a593Smuzhiyun #ifndef __WMFW_H 11*4882a593Smuzhiyun #define __WMFW_H 12*4882a593Smuzhiyun 13*4882a593Smuzhiyun #include <linux/types.h> 14*4882a593Smuzhiyun 15*4882a593Smuzhiyun #define WMFW_MAX_ALG_NAME 256 16*4882a593Smuzhiyun #define WMFW_MAX_ALG_DESCR_NAME 256 17*4882a593Smuzhiyun 18*4882a593Smuzhiyun #define WMFW_MAX_COEFF_NAME 256 19*4882a593Smuzhiyun #define WMFW_MAX_COEFF_DESCR_NAME 256 20*4882a593Smuzhiyun 21*4882a593Smuzhiyun #define WMFW_CTL_FLAG_SYS 0x8000 22*4882a593Smuzhiyun #define WMFW_CTL_FLAG_VOLATILE 0x0004 23*4882a593Smuzhiyun #define WMFW_CTL_FLAG_WRITEABLE 0x0002 24*4882a593Smuzhiyun #define WMFW_CTL_FLAG_READABLE 0x0001 25*4882a593Smuzhiyun 26*4882a593Smuzhiyun /* Non-ALSA coefficient types start at 0x1000 */ 27*4882a593Smuzhiyun #define WMFW_CTL_TYPE_ACKED 0x1000 /* acked control */ 28*4882a593Smuzhiyun #define WMFW_CTL_TYPE_HOSTEVENT 0x1001 /* event control */ 29*4882a593Smuzhiyun #define WMFW_CTL_TYPE_HOST_BUFFER 0x1002 /* host buffer pointer */ 30*4882a593Smuzhiyun 31*4882a593Smuzhiyun struct wmfw_header { 32*4882a593Smuzhiyun char magic[4]; 33*4882a593Smuzhiyun __le32 len; 34*4882a593Smuzhiyun __le16 rev; 35*4882a593Smuzhiyun u8 core; 36*4882a593Smuzhiyun u8 ver; 37*4882a593Smuzhiyun } __packed; 38*4882a593Smuzhiyun 39*4882a593Smuzhiyun struct wmfw_footer { 40*4882a593Smuzhiyun __le64 timestamp; 41*4882a593Smuzhiyun __le32 checksum; 42*4882a593Smuzhiyun } __packed; 43*4882a593Smuzhiyun 44*4882a593Smuzhiyun struct wmfw_adsp1_sizes { 45*4882a593Smuzhiyun __le32 dm; 46*4882a593Smuzhiyun __le32 pm; 47*4882a593Smuzhiyun __le32 zm; 48*4882a593Smuzhiyun } __packed; 49*4882a593Smuzhiyun 50*4882a593Smuzhiyun struct wmfw_adsp2_sizes { 51*4882a593Smuzhiyun __le32 xm; 52*4882a593Smuzhiyun __le32 ym; 53*4882a593Smuzhiyun __le32 pm; 54*4882a593Smuzhiyun __le32 zm; 55*4882a593Smuzhiyun } __packed; 56*4882a593Smuzhiyun 57*4882a593Smuzhiyun struct wmfw_region { 58*4882a593Smuzhiyun union { 59*4882a593Smuzhiyun __be32 type; 60*4882a593Smuzhiyun __le32 offset; 61*4882a593Smuzhiyun }; 62*4882a593Smuzhiyun __le32 len; 63*4882a593Smuzhiyun u8 data[]; 64*4882a593Smuzhiyun } __packed; 65*4882a593Smuzhiyun 66*4882a593Smuzhiyun struct wmfw_id_hdr { 67*4882a593Smuzhiyun __be32 core_id; 68*4882a593Smuzhiyun __be32 core_rev; 69*4882a593Smuzhiyun __be32 id; 70*4882a593Smuzhiyun __be32 ver; 71*4882a593Smuzhiyun } __packed; 72*4882a593Smuzhiyun 73*4882a593Smuzhiyun struct wmfw_v3_id_hdr { 74*4882a593Smuzhiyun __be32 core_id; 75*4882a593Smuzhiyun __be32 block_rev; 76*4882a593Smuzhiyun __be32 vendor_id; 77*4882a593Smuzhiyun __be32 id; 78*4882a593Smuzhiyun __be32 ver; 79*4882a593Smuzhiyun } __packed; 80*4882a593Smuzhiyun 81*4882a593Smuzhiyun struct wmfw_adsp1_id_hdr { 82*4882a593Smuzhiyun struct wmfw_id_hdr fw; 83*4882a593Smuzhiyun __be32 zm; 84*4882a593Smuzhiyun __be32 dm; 85*4882a593Smuzhiyun __be32 n_algs; 86*4882a593Smuzhiyun } __packed; 87*4882a593Smuzhiyun 88*4882a593Smuzhiyun struct wmfw_adsp2_id_hdr { 89*4882a593Smuzhiyun struct wmfw_id_hdr fw; 90*4882a593Smuzhiyun __be32 zm; 91*4882a593Smuzhiyun __be32 xm; 92*4882a593Smuzhiyun __be32 ym; 93*4882a593Smuzhiyun __be32 n_algs; 94*4882a593Smuzhiyun } __packed; 95*4882a593Smuzhiyun 96*4882a593Smuzhiyun struct wmfw_halo_id_hdr { 97*4882a593Smuzhiyun struct wmfw_v3_id_hdr fw; 98*4882a593Smuzhiyun __be32 xm_base; 99*4882a593Smuzhiyun __be32 xm_size; 100*4882a593Smuzhiyun __be32 ym_base; 101*4882a593Smuzhiyun __be32 ym_size; 102*4882a593Smuzhiyun __be32 n_algs; 103*4882a593Smuzhiyun } __packed; 104*4882a593Smuzhiyun 105*4882a593Smuzhiyun struct wmfw_alg_hdr { 106*4882a593Smuzhiyun __be32 id; 107*4882a593Smuzhiyun __be32 ver; 108*4882a593Smuzhiyun } __packed; 109*4882a593Smuzhiyun 110*4882a593Smuzhiyun struct wmfw_adsp1_alg_hdr { 111*4882a593Smuzhiyun struct wmfw_alg_hdr alg; 112*4882a593Smuzhiyun __be32 zm; 113*4882a593Smuzhiyun __be32 dm; 114*4882a593Smuzhiyun } __packed; 115*4882a593Smuzhiyun 116*4882a593Smuzhiyun struct wmfw_adsp2_alg_hdr { 117*4882a593Smuzhiyun struct wmfw_alg_hdr alg; 118*4882a593Smuzhiyun __be32 zm; 119*4882a593Smuzhiyun __be32 xm; 120*4882a593Smuzhiyun __be32 ym; 121*4882a593Smuzhiyun } __packed; 122*4882a593Smuzhiyun 123*4882a593Smuzhiyun struct wmfw_halo_alg_hdr { 124*4882a593Smuzhiyun struct wmfw_alg_hdr alg; 125*4882a593Smuzhiyun __be32 xm_base; 126*4882a593Smuzhiyun __be32 xm_size; 127*4882a593Smuzhiyun __be32 ym_base; 128*4882a593Smuzhiyun __be32 ym_size; 129*4882a593Smuzhiyun } __packed; 130*4882a593Smuzhiyun 131*4882a593Smuzhiyun struct wmfw_adsp_alg_data { 132*4882a593Smuzhiyun __le32 id; 133*4882a593Smuzhiyun u8 name[WMFW_MAX_ALG_NAME]; 134*4882a593Smuzhiyun u8 descr[WMFW_MAX_ALG_DESCR_NAME]; 135*4882a593Smuzhiyun __le32 ncoeff; 136*4882a593Smuzhiyun u8 data[]; 137*4882a593Smuzhiyun } __packed; 138*4882a593Smuzhiyun 139*4882a593Smuzhiyun struct wmfw_adsp_coeff_data { 140*4882a593Smuzhiyun struct { 141*4882a593Smuzhiyun __le16 offset; 142*4882a593Smuzhiyun __le16 type; 143*4882a593Smuzhiyun __le32 size; 144*4882a593Smuzhiyun } hdr; 145*4882a593Smuzhiyun u8 name[WMFW_MAX_COEFF_NAME]; 146*4882a593Smuzhiyun u8 descr[WMFW_MAX_COEFF_DESCR_NAME]; 147*4882a593Smuzhiyun __le16 ctl_type; 148*4882a593Smuzhiyun __le16 flags; 149*4882a593Smuzhiyun __le32 len; 150*4882a593Smuzhiyun u8 data[]; 151*4882a593Smuzhiyun } __packed; 152*4882a593Smuzhiyun 153*4882a593Smuzhiyun struct wmfw_coeff_hdr { 154*4882a593Smuzhiyun u8 magic[4]; 155*4882a593Smuzhiyun __le32 len; 156*4882a593Smuzhiyun union { 157*4882a593Smuzhiyun __be32 rev; 158*4882a593Smuzhiyun __le32 ver; 159*4882a593Smuzhiyun }; 160*4882a593Smuzhiyun union { 161*4882a593Smuzhiyun __be32 core; 162*4882a593Smuzhiyun __le32 core_ver; 163*4882a593Smuzhiyun }; 164*4882a593Smuzhiyun u8 data[]; 165*4882a593Smuzhiyun } __packed; 166*4882a593Smuzhiyun 167*4882a593Smuzhiyun struct wmfw_coeff_item { 168*4882a593Smuzhiyun __le16 offset; 169*4882a593Smuzhiyun __le16 type; 170*4882a593Smuzhiyun __le32 id; 171*4882a593Smuzhiyun __le32 ver; 172*4882a593Smuzhiyun __le32 sr; 173*4882a593Smuzhiyun __le32 len; 174*4882a593Smuzhiyun u8 data[]; 175*4882a593Smuzhiyun } __packed; 176*4882a593Smuzhiyun 177*4882a593Smuzhiyun #define WMFW_ADSP1 1 178*4882a593Smuzhiyun #define WMFW_ADSP2 2 179*4882a593Smuzhiyun #define WMFW_HALO 4 180*4882a593Smuzhiyun 181*4882a593Smuzhiyun #define WMFW_ABSOLUTE 0xf0 182*4882a593Smuzhiyun #define WMFW_ALGORITHM_DATA 0xf2 183*4882a593Smuzhiyun #define WMFW_METADATA 0xfc 184*4882a593Smuzhiyun #define WMFW_NAME_TEXT 0xfe 185*4882a593Smuzhiyun #define WMFW_INFO_TEXT 0xff 186*4882a593Smuzhiyun 187*4882a593Smuzhiyun #define WMFW_ADSP1_PM 2 188*4882a593Smuzhiyun #define WMFW_ADSP1_DM 3 189*4882a593Smuzhiyun #define WMFW_ADSP1_ZM 4 190*4882a593Smuzhiyun 191*4882a593Smuzhiyun #define WMFW_ADSP2_PM 2 192*4882a593Smuzhiyun #define WMFW_ADSP2_ZM 4 193*4882a593Smuzhiyun #define WMFW_ADSP2_XM 5 194*4882a593Smuzhiyun #define WMFW_ADSP2_YM 6 195*4882a593Smuzhiyun 196*4882a593Smuzhiyun #define WMFW_HALO_PM_PACKED 0x10 197*4882a593Smuzhiyun #define WMFW_HALO_XM_PACKED 0x11 198*4882a593Smuzhiyun #define WMFW_HALO_YM_PACKED 0x12 199*4882a593Smuzhiyun 200*4882a593Smuzhiyun #endif 201