xref: /OK3568_Linux_fs/kernel/sound/soc/codecs/aw883xx/aw_bin_parse.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0+ */
2*4882a593Smuzhiyun 
3*4882a593Smuzhiyun #ifndef __AW_BIN_PARSE_H__
4*4882a593Smuzhiyun #define __AW_BIN_PARSE_H__
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun #include "aw_device.h"
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #define NULL				((void *)0)
9*4882a593Smuzhiyun #define GET_32_DATA(w, x, y, z)		((unsigned int)((((uint8_t)w) << 24) | (((uint8_t)x) << 16) | (((uint8_t)y) << 8) | ((uint8_t)z)))
10*4882a593Smuzhiyun #define BIN_NUM_MAX			100
11*4882a593Smuzhiyun #define HEADER_LEN			60
12*4882a593Smuzhiyun /*********************************************************
13*4882a593Smuzhiyun  *
14*4882a593Smuzhiyun  * header information
15*4882a593Smuzhiyun  *
16*4882a593Smuzhiyun  ********************************************************/
17*4882a593Smuzhiyun enum return_enum {
18*4882a593Smuzhiyun 	BIN_HEADER_VER_ERR = 1,
19*4882a593Smuzhiyun 	BIN_DATA_TYPE_ERR = 2,
20*4882a593Smuzhiyun 	BIN_DATA_LEN_ERR = 3,
21*4882a593Smuzhiyun 	DATA_VER_ERR = 4,
22*4882a593Smuzhiyun 	REG_NUM_ERR = 5,
23*4882a593Smuzhiyun 	DSP_REG_NUM_ERR = 6,
24*4882a593Smuzhiyun 	SOC_APP_NUM_ERR = 7,
25*4882a593Smuzhiyun 	BIN_IS_NULL = 8,
26*4882a593Smuzhiyun };
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun enum bin_header_version_enum {
29*4882a593Smuzhiyun 	HEADER_VERSION_1_0_0 = 0x01000000,
30*4882a593Smuzhiyun };
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun enum data_type_enum {
33*4882a593Smuzhiyun 	DATA_TYPE_REGISTER = 0x00000000,
34*4882a593Smuzhiyun 	DATA_TYPE_DSP_REG = 0x00000010,
35*4882a593Smuzhiyun 	DATA_TYPE_DSP_CFG = 0x00000011,
36*4882a593Smuzhiyun 	DATA_TYPE_SOC_REG = 0x00000020,
37*4882a593Smuzhiyun 	DATA_TYPE_SOC_APP = 0x00000021,
38*4882a593Smuzhiyun 	DATA_TYPE_DSP_FW = DATA_TYPE_SOC_APP,
39*4882a593Smuzhiyun 	DATA_TYPE_MULTI_BINS = 0x00002000,
40*4882a593Smuzhiyun };
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun /**
43*4882a593Smuzhiyun  * @DATA_VERSION_V1:default little edian
44*4882a593Smuzhiyun  */
45*4882a593Smuzhiyun enum data_version_enum {
46*4882a593Smuzhiyun 	DATA_VERSION_V1 = 0X00000001,
47*4882a593Smuzhiyun 	DATA_VERSION_MAX,
48*4882a593Smuzhiyun };
49*4882a593Smuzhiyun 
50*4882a593Smuzhiyun /**
51*4882a593Smuzhiyun  * @header_len: Frame header length
52*4882a593Smuzhiyun  * @check_sum: Frame header information-Checksum
53*4882a593Smuzhiyun  * @header_ver: Frame header information-Frame header version
54*4882a593Smuzhiyun  * @bin_data_type: Frame header information-Data type
55*4882a593Smuzhiyun  * @bin_data_ver: Frame header information-Data version
56*4882a593Smuzhiyun  * @bin_data_len: Frame header information-Data length
57*4882a593Smuzhiyun  * @ui_ver: Frame header information-ui version
58*4882a593Smuzhiyun  * @chip_type[8]: Frame header information-chip type
59*4882a593Smuzhiyun  * @reg_byte_len: Frame header information-reg byte len
60*4882a593Smuzhiyun  * @data_byte_len: Frame header information-data byte len
61*4882a593Smuzhiyun  * @device_addr: Frame header information-device addr
62*4882a593Smuzhiyun  * @valid_data_len: Length of valid data obtained after parsing
63*4882a593Smuzhiyun  * @valid_data_addr: The offset address of the valid data obtained
64*4882a593Smuzhiyun  *                   after parsing relative to info
65*4882a593Smuzhiyun  * @reg_num: The number of registers obtained after parsing
66*4882a593Smuzhiyun  * @reg_data_byte_len: The byte length of the register obtained after parsing
67*4882a593Smuzhiyun  * @download_addr: The starting address or download address obtained
68*4882a593Smuzhiyun  *                 after parsing
69*4882a593Smuzhiyun  * @app_version: The software version number obtained after parsing
70*4882a593Smuzhiyun  */
71*4882a593Smuzhiyun struct bin_header_info {
72*4882a593Smuzhiyun 	unsigned int header_len;
73*4882a593Smuzhiyun 	unsigned int check_sum;
74*4882a593Smuzhiyun 	unsigned int header_ver;
75*4882a593Smuzhiyun 	unsigned int bin_data_type;
76*4882a593Smuzhiyun 	unsigned int bin_data_ver;
77*4882a593Smuzhiyun 	unsigned int bin_data_len;
78*4882a593Smuzhiyun 	unsigned int ui_ver;
79*4882a593Smuzhiyun 	unsigned char chip_type[8];
80*4882a593Smuzhiyun 	unsigned int reg_byte_len;
81*4882a593Smuzhiyun 	unsigned int data_byte_len;
82*4882a593Smuzhiyun 	unsigned int device_addr;
83*4882a593Smuzhiyun 	unsigned int valid_data_len;
84*4882a593Smuzhiyun 	unsigned int valid_data_addr;
85*4882a593Smuzhiyun 
86*4882a593Smuzhiyun 	unsigned int reg_num;
87*4882a593Smuzhiyun 	unsigned int reg_data_byte_len;
88*4882a593Smuzhiyun 	unsigned int download_addr;
89*4882a593Smuzhiyun 	unsigned int app_version;
90*4882a593Smuzhiyun };
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun /************************************************************
93*4882a593Smuzhiyun *
94*4882a593Smuzhiyun * function define
95*4882a593Smuzhiyun *
96*4882a593Smuzhiyun ************************************************************/
97*4882a593Smuzhiyun /**
98*4882a593Smuzhiyun  * @len: The size of the bin file obtained from the firmware
99*4882a593Smuzhiyun  * @data[]: Store the bin file obtained from the firmware
100*4882a593Smuzhiyun  */
101*4882a593Smuzhiyun struct bin_container {
102*4882a593Smuzhiyun 	unsigned int len;
103*4882a593Smuzhiyun 	unsigned char data[];
104*4882a593Smuzhiyun };
105*4882a593Smuzhiyun 
106*4882a593Smuzhiyun /**
107*4882a593Smuzhiyun  * @p_addr: Offset pointer (backward offset pointer to obtain frame header
108*4882a593Smuzhiyun  *          information and important information)
109*4882a593Smuzhiyun  * @all_bin_parse_num: The number of all bin files
110*4882a593Smuzhiyun  * @multi_bin_parse_num: The number of single bin files
111*4882a593Smuzhiyun  * @single_bin_parse_num: The number of multiple bin files
112*4882a593Smuzhiyun  * @header_info[BIN_NUM_MAX]: Frame header information and other important data
113*4882a593Smuzhiyun  *                            obtained after parsing
114*4882a593Smuzhiyun  * @info: Obtained bin file data that needs to be parsed
115*4882a593Smuzhiyun  */
116*4882a593Smuzhiyun struct aw_bin {
117*4882a593Smuzhiyun 	unsigned char *p_addr;
118*4882a593Smuzhiyun 	unsigned int all_bin_parse_num;
119*4882a593Smuzhiyun 	unsigned int multi_bin_parse_num;
120*4882a593Smuzhiyun 	unsigned int single_bin_parse_num;
121*4882a593Smuzhiyun 	struct bin_header_info header_info[BIN_NUM_MAX];
122*4882a593Smuzhiyun 	struct bin_container info;
123*4882a593Smuzhiyun };
124*4882a593Smuzhiyun 
125*4882a593Smuzhiyun int aw_parsing_bin_file(struct aw_bin *bin);
126*4882a593Smuzhiyun int aw_parse_bin_header_1_0_0(struct aw_bin *bin);
127*4882a593Smuzhiyun 
128*4882a593Smuzhiyun /*******************awinic audio parse acf***********************/
129*4882a593Smuzhiyun int aw_dev_dsp_data_order(struct aw_device *aw_dev,
130*4882a593Smuzhiyun 				uint8_t *data, uint32_t data_len);
131*4882a593Smuzhiyun int aw_dev_get_prof_data(struct aw_device *aw_dev, int index,
132*4882a593Smuzhiyun 			struct aw_prof_desc **prof_desc);
133*4882a593Smuzhiyun char *aw_dev_get_prof_name(struct aw_device *aw_dev, int index);
134*4882a593Smuzhiyun int aw_dev_set_profile_index(struct aw_device *aw_dev, int index);
135*4882a593Smuzhiyun int aw_dev_get_profile_index(struct aw_device *aw_dev);
136*4882a593Smuzhiyun int aw_dev_check_profile_index(struct aw_device *aw_dev, int index);
137*4882a593Smuzhiyun int aw_dev_get_profile_count(struct aw_device *aw_dev);
138*4882a593Smuzhiyun int aw_dev_cfg_load(struct aw_device *aw_dev, struct aw_container *aw_cfg);
139*4882a593Smuzhiyun int aw_dev_load_acf_check(struct aw_container *aw_cfg);
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun #endif
142