xref: /linux/include/sound/tas2781.h (revision 08df80a3c51674ab73ae770885a383ca553fbbbf)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 //
3 // ALSA SoC Texas Instruments TAS2781 Audio Smart Amplifier
4 //
5 // Copyright (C) 2022 - 2023 Texas Instruments Incorporated
6 // https://www.ti.com
7 //
8 // The TAS2781 driver implements a flexible and configurable
9 // algo coefficient setting for one, two, or even multiple
10 // TAS2781 chips.
11 //
12 // Author: Shenghao Ding <shenghao-ding@ti.com>
13 // Author: Kevin Lu <kevin-lu@ti.com>
14 //
15 
16 #ifndef __TAS2781_H__
17 #define __TAS2781_H__
18 
19 #include "tas2781-dsp.h"
20 
21 /* version number */
22 #define TAS2781_DRV_VER			1
23 #define SMARTAMP_MODULE_NAME		"tas2781"
24 #define TAS2781_GLOBAL_ADDR	0x40
25 #define TAS2563_GLOBAL_ADDR	0x48
26 #define TASDEVICE_RATES			(SNDRV_PCM_RATE_44100 |\
27 	SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_96000 |\
28 	SNDRV_PCM_RATE_88200)
29 
30 #define TASDEVICE_FORMATS		(SNDRV_PCM_FMTBIT_S16_LE | \
31 	SNDRV_PCM_FMTBIT_S24_LE | \
32 	SNDRV_PCM_FMTBIT_S32_LE)
33 
34 /*PAGE Control Register (available in page0 of each book) */
35 #define TASDEVICE_PAGE_SELECT		0x00
36 #define TASDEVICE_BOOKCTL_PAGE		0x00
37 #define TASDEVICE_BOOKCTL_REG		127
38 #define TASDEVICE_BOOK_ID(reg)		(reg / (256 * 128))
39 #define TASDEVICE_PAGE_ID(reg)		((reg % (256 * 128)) / 128)
40 #define TASDEVICE_PAGE_REG(reg)		((reg % (256 * 128)) % 128)
41 #define TASDEVICE_PGRG(reg)		(reg % (256 * 128))
42 #define TASDEVICE_REG(book, page, reg)	(((book * 256 * 128) + \
43 					(page * 128)) + reg)
44 
45 /*Software Reset */
46 #define TAS2781_REG_SWRESET		TASDEVICE_REG(0x0, 0X0, 0x01)
47 #define TAS2781_REG_SWRESET_RESET	BIT(0)
48 
49 /*I2C Checksum */
50 #define TASDEVICE_I2CChecksum		TASDEVICE_REG(0x0, 0x0, 0x7E)
51 
52 /* Volume control */
53 #define TAS2781_DVC_LVL			TASDEVICE_REG(0x0, 0x0, 0x1A)
54 #define TAS2781_AMP_LEVEL		TASDEVICE_REG(0x0, 0x0, 0x03)
55 #define TAS2781_AMP_LEVEL_MASK		GENMASK(5, 1)
56 
57 #define TASDEVICE_CMD_SING_W		0x1
58 #define TASDEVICE_CMD_BURST		0x2
59 #define TASDEVICE_CMD_DELAY		0x3
60 #define TASDEVICE_CMD_FIELD_W		0x4
61 
62 enum audio_device {
63 	TAS2781	= 0,
64 };
65 
66 enum device_catlog_id {
67 	LENOVO = 0,
68 	OTHERS
69 };
70 
71 struct tasdevice {
72 	struct tasdevice_fw *cali_data_fmw;
73 	unsigned int dev_addr;
74 	unsigned int err_code;
75 	unsigned char cur_book;
76 	short cur_prog;
77 	short cur_conf;
78 	bool is_loading;
79 	bool is_loaderr;
80 };
81 
82 struct tasdevice_irqinfo {
83 	int irq_gpio;
84 	int irq;
85 };
86 
87 struct calidata {
88 	unsigned char *data;
89 	unsigned long total_sz;
90 };
91 
92 struct tasdevice_priv {
93 	struct tasdevice tasdevice[TASDEVICE_MAX_CHANNELS];
94 	struct tasdevice_irqinfo irq_info;
95 	struct tasdevice_rca rcabin;
96 	struct calidata cali_data;
97 	struct tasdevice_fw *fmw;
98 	struct gpio_desc *reset;
99 	struct mutex codec_lock;
100 	struct regmap *regmap;
101 	struct device *dev;
102 	struct tm tm;
103 
104 	enum device_catlog_id catlog_id;
105 	const char *acpi_subsystem_id;
106 	unsigned char cal_binaryname[TASDEVICE_MAX_CHANNELS][64];
107 	unsigned char crc8_lkp_tbl[CRC8_TABLE_SIZE];
108 	unsigned char coef_binaryname[64];
109 	unsigned char rca_binaryname[64];
110 	unsigned char dev_name[32];
111 	unsigned char ndev;
112 	unsigned int magic_num;
113 	unsigned int chip_id;
114 	unsigned int sysclk;
115 
116 	int cur_prog;
117 	int cur_conf;
118 	int fw_state;
119 	int index;
120 	void *client;
121 	void *codec;
122 	bool force_fwload_status;
123 	bool playback_started;
124 	bool isacpi;
125 	unsigned int global_addr;
126 
127 	int (*fw_parse_variable_header)(struct tasdevice_priv *tas_priv,
128 		const struct firmware *fmw, int offset);
129 	int (*fw_parse_program_data)(struct tasdevice_priv *tas_priv,
130 		struct tasdevice_fw *tas_fmw,
131 		const struct firmware *fmw, int offset);
132 	int (*fw_parse_configuration_data)(struct tasdevice_priv *tas_priv,
133 		struct tasdevice_fw *tas_fmw,
134 		const struct firmware *fmw, int offset);
135 	int (*tasdevice_load_block)(struct tasdevice_priv *tas_priv,
136 		struct tasdev_blk *block);
137 
138 	int (*save_calibration)(struct tasdevice_priv *tas_priv);
139 	void (*apply_calibration)(struct tasdevice_priv *tas_priv);
140 };
141 
142 void tas2781_reset(struct tasdevice_priv *tas_dev);
143 int tascodec_init(struct tasdevice_priv *tas_priv, void *codec,
144 	void (*cont)(const struct firmware *fw, void *context));
145 struct tasdevice_priv *tasdevice_kzalloc(struct i2c_client *i2c);
146 int tasdevice_init(struct tasdevice_priv *tas_priv);
147 void tasdevice_remove(struct tasdevice_priv *tas_priv);
148 int tasdevice_save_calibration(struct tasdevice_priv *tas_priv);
149 void tasdevice_apply_calibration(struct tasdevice_priv *tas_priv);
150 int tasdevice_dev_read(struct tasdevice_priv *tas_priv,
151 	unsigned short chn, unsigned int reg, unsigned int *value);
152 int tasdevice_dev_write(struct tasdevice_priv *tas_priv,
153 	unsigned short chn, unsigned int reg, unsigned int value);
154 int tasdevice_dev_bulk_write(
155 	struct tasdevice_priv *tas_priv, unsigned short chn,
156 	unsigned int reg, unsigned char *p_data, unsigned int n_length);
157 int tasdevice_dev_bulk_read(struct tasdevice_priv *tas_priv,
158 	unsigned short chn, unsigned int reg, unsigned char *p_data,
159 	unsigned int n_length);
160 int tasdevice_dev_update_bits(
161 	struct tasdevice_priv *tasdevice, unsigned short chn,
162 	unsigned int reg, unsigned int mask, unsigned int value);
163 int tasdevice_amp_putvol(struct tasdevice_priv *tas_priv,
164 	struct snd_ctl_elem_value *ucontrol, struct soc_mixer_control *mc);
165 int tasdevice_amp_getvol(struct tasdevice_priv *tas_priv,
166 	struct snd_ctl_elem_value *ucontrol, struct soc_mixer_control *mc);
167 int tasdevice_digital_putvol(struct tasdevice_priv *tas_priv,
168 	struct snd_ctl_elem_value *ucontrol, struct soc_mixer_control *mc);
169 int tasdevice_digital_getvol(struct tasdevice_priv *tas_priv,
170 	struct snd_ctl_elem_value *ucontrol, struct soc_mixer_control *mc);
171 
172 #endif /* __TAS2781_H__ */
173