xref: /OK3568_Linux_fs/kernel/sound/soc/codecs/aw87xxx/aw87xxx.h (revision 4882a59341e53eb6f0b4789bf948001014eff981) 
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0+ */
2*4882a593Smuzhiyun 
3*4882a593Smuzhiyun #ifndef __AW87XXX_H__
4*4882a593Smuzhiyun #define __AW87XXX_H__
5*4882a593Smuzhiyun #include <linux/version.h>
6*4882a593Smuzhiyun #include <linux/kernel.h>
7*4882a593Smuzhiyun #include <sound/control.h>
8*4882a593Smuzhiyun #include <sound/soc.h>
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #include "aw_device.h"
11*4882a593Smuzhiyun #include "aw_monitor.h"
12*4882a593Smuzhiyun #include "aw_acf_bin.h"
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #define AW_CFG_UPDATE_DELAY
15*4882a593Smuzhiyun #define AW_CFG_UPDATE_DELAY_TIMER	(3000)
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun #define AW87XXX_NO_OFF_BIN		(0)
18*4882a593Smuzhiyun #define AW87XXX_OFF_BIN_OK		(1)
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun #define AW87XXX_KCONTROL_NUM		(2)
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun #define AW_I2C_RETRIES			(5)
23*4882a593Smuzhiyun #define AW_I2C_RETRY_DELAY		(2)
24*4882a593Smuzhiyun #define AW_I2C_READ_MSG_NUM		(2)
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun #define AW87XXX_FW_NAME_MAX		(64)
27*4882a593Smuzhiyun #define AW_NAME_BUF_MAX			(64)
28*4882a593Smuzhiyun #define AW_LOAD_FW_RETRIES		(3)
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun #define AW_DEV_REG_RD_ACCESS		(1 << 0)
31*4882a593Smuzhiyun #define AW_DEV_REG_WR_ACCESS		(1 << 1)
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun #define AWRW_ADDR_BYTES			(1)
34*4882a593Smuzhiyun #define AWRW_DATA_BYTES			(1)
35*4882a593Smuzhiyun #define AWRW_HDR_LEN			(24)
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun /***********************************************************
38*4882a593Smuzhiyun  *
39*4882a593Smuzhiyun  * aw87xxx codec control compatible with kernel 4.19
40*4882a593Smuzhiyun  *
41*4882a593Smuzhiyun  ***********************************************************/
42*4882a593Smuzhiyun #if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 19, 1)
43*4882a593Smuzhiyun #define AW_KERNEL_VER_OVER_4_19_1
44*4882a593Smuzhiyun #endif
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun #ifdef AW_KERNEL_VER_OVER_4_19_1
47*4882a593Smuzhiyun typedef struct snd_soc_component aw_snd_soc_codec_t;
48*4882a593Smuzhiyun #else
49*4882a593Smuzhiyun typedef struct snd_soc_codec aw_snd_soc_codec_t;
50*4882a593Smuzhiyun #endif
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun struct aw_componet_codec_ops {
53*4882a593Smuzhiyun 	int (*add_codec_controls)(aw_snd_soc_codec_t *codec,
54*4882a593Smuzhiyun 		const struct snd_kcontrol_new *controls, unsigned int num_controls);
55*4882a593Smuzhiyun 	void (*unregister_codec)(struct device *dev);
56*4882a593Smuzhiyun };
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun /********************************************
60*4882a593Smuzhiyun  *
61*4882a593Smuzhiyun  * aw87xxx devices attributes
62*4882a593Smuzhiyun  *
63*4882a593Smuzhiyun  *******************************************/
64*4882a593Smuzhiyun enum {
65*4882a593Smuzhiyun 	AWRW_FLAG_WRITE = 0,
66*4882a593Smuzhiyun 	AWRW_FLAG_READ,
67*4882a593Smuzhiyun };
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun enum {
70*4882a593Smuzhiyun 	AWRW_I2C_ST_NONE = 0,
71*4882a593Smuzhiyun 	AWRW_I2C_ST_READ,
72*4882a593Smuzhiyun 	AWRW_I2C_ST_WRITE,
73*4882a593Smuzhiyun };
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun enum {
76*4882a593Smuzhiyun 	AWRW_HDR_WR_FLAG = 0,
77*4882a593Smuzhiyun 	AWRW_HDR_ADDR_BYTES,
78*4882a593Smuzhiyun 	AWRW_HDR_DATA_BYTES,
79*4882a593Smuzhiyun 	AWRW_HDR_REG_NUM,
80*4882a593Smuzhiyun 	AWRW_HDR_REG_ADDR,
81*4882a593Smuzhiyun 	AWRW_HDR_MAX,
82*4882a593Smuzhiyun };
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun struct aw_i2c_packet {
85*4882a593Smuzhiyun 	char status;
86*4882a593Smuzhiyun 	unsigned int reg_num;
87*4882a593Smuzhiyun 	unsigned int reg_addr;
88*4882a593Smuzhiyun 	char *reg_data;
89*4882a593Smuzhiyun };
90*4882a593Smuzhiyun 
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun /********************************************
93*4882a593Smuzhiyun  *
94*4882a593Smuzhiyun  * aw87xxx device struct
95*4882a593Smuzhiyun  *
96*4882a593Smuzhiyun  *******************************************/
97*4882a593Smuzhiyun struct aw87xxx {
98*4882a593Smuzhiyun 	char fw_name[AW87XXX_FW_NAME_MAX];
99*4882a593Smuzhiyun 	int32_t dev_index;
100*4882a593Smuzhiyun 	char *current_profile;
101*4882a593Smuzhiyun 	char prof_off_name[AW_PROFILE_STR_MAX];
102*4882a593Smuzhiyun 	uint32_t off_bin_status;
103*4882a593Smuzhiyun 	struct device *dev;
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun 	struct mutex reg_lock;
106*4882a593Smuzhiyun 	struct aw_device aw_dev;
107*4882a593Smuzhiyun 	struct aw_i2c_packet i2c_packet;
108*4882a593Smuzhiyun 
109*4882a593Smuzhiyun 	struct delayed_work fw_load_work;
110*4882a593Smuzhiyun 	struct acf_bin_info acf_info;
111*4882a593Smuzhiyun 
112*4882a593Smuzhiyun 	aw_snd_soc_codec_t *codec;
113*4882a593Smuzhiyun 
114*4882a593Smuzhiyun 	struct list_head list;
115*4882a593Smuzhiyun 
116*4882a593Smuzhiyun 	struct aw_monitor monitor;
117*4882a593Smuzhiyun };
118*4882a593Smuzhiyun 
119*4882a593Smuzhiyun int aw87xxx_update_profile(struct aw87xxx *aw87xxx, char *profile);
120*4882a593Smuzhiyun int aw87xxx_esd_update_profile(struct aw87xxx *aw87xxx, char *profile);
121*4882a593Smuzhiyun 
122*4882a593Smuzhiyun #endif
123