xref: /linux/sound/soc/intel/boards/sof_sdw_common.h (revision 3582cf94ff49469ffe78e96014550f7d4e466fbd)
1 /* SPDX-License-Identifier: GPL-2.0-only
2  *  Copyright (c) 2020 Intel Corporation
3  */
4 
5 /*
6  *  sof_sdw_common.h - prototypes for common helpers
7  */
8 
9 #ifndef SND_SOC_SOF_SDW_COMMON_H
10 #define SND_SOC_SOF_SDW_COMMON_H
11 
12 #include <linux/bits.h>
13 #include <linux/types.h>
14 #include <sound/soc.h>
15 
16 #define MAX_NO_PROPS 2
17 #define MAX_HDMI_NUM 4
18 #define SDW_UNUSED_DAI_ID -1
19 #define SDW_JACK_OUT_DAI_ID 0
20 #define SDW_JACK_IN_DAI_ID 1
21 #define SDW_AMP_OUT_DAI_ID 2
22 #define SDW_AMP_IN_DAI_ID 3
23 #define SDW_DMIC_DAI_ID 4
24 #define SDW_MAX_CPU_DAIS 16
25 #define SDW_INTEL_BIDIR_PDI_BASE 2
26 
27 /* 8 combinations with 4 links + unused group 0 */
28 #define SDW_MAX_GROUPS 9
29 
30 enum {
31 	SOF_PRE_TGL_HDMI_COUNT = 3,
32 	SOF_TGL_HDMI_COUNT = 4,
33 };
34 
35 enum {
36 	SOF_I2S_SSP0 = BIT(0),
37 	SOF_I2S_SSP1 = BIT(1),
38 	SOF_I2S_SSP2 = BIT(2),
39 	SOF_I2S_SSP3 = BIT(3),
40 	SOF_I2S_SSP4 = BIT(4),
41 	SOF_I2S_SSP5 = BIT(5),
42 };
43 
44 #define SOF_JACK_JDSRC(quirk)		((quirk) & GENMASK(3, 0))
45 #define SOF_SDW_FOUR_SPK		BIT(4)
46 #define SOF_SDW_TGL_HDMI		BIT(5)
47 #define SOF_SDW_PCH_DMIC		BIT(6)
48 #define SOF_SSP_PORT(x)		(((x) & GENMASK(5, 0)) << 7)
49 #define SOF_SSP_GET_PORT(quirk)	(((quirk) >> 7) & GENMASK(5, 0))
50 #define SOF_SDW_NO_AGGREGATION		BIT(14)
51 
52 /* BT audio offload: reserve 3 bits for future */
53 #define SOF_BT_OFFLOAD_SSP_SHIFT	15
54 #define SOF_BT_OFFLOAD_SSP_MASK	(GENMASK(17, 15))
55 #define SOF_BT_OFFLOAD_SSP(quirk)	\
56 	(((quirk) << SOF_BT_OFFLOAD_SSP_SHIFT) & SOF_BT_OFFLOAD_SSP_MASK)
57 #define SOF_SSP_BT_OFFLOAD_PRESENT	BIT(18)
58 
59 #define SOF_SDW_DAI_TYPE_JACK		0
60 #define SOF_SDW_DAI_TYPE_AMP		1
61 #define SOF_SDW_DAI_TYPE_MIC		2
62 
63 #define SOF_SDW_MAX_DAI_NUM		3
64 
65 struct sof_sdw_codec_info;
66 
67 struct sof_sdw_dai_info {
68 	const bool direction[2]; /* playback & capture support */
69 	const char *dai_name;
70 	const int dai_type;
71 	const int dailink[2]; /* dailink id for each direction */
72 	int  (*init)(struct snd_soc_card *card,
73 		     const struct snd_soc_acpi_link_adr *link,
74 		     struct snd_soc_dai_link *dai_links,
75 		     struct sof_sdw_codec_info *info,
76 		     bool playback);
77 	int (*exit)(struct snd_soc_card *card, struct snd_soc_dai_link *dai_link);
78 };
79 
80 struct sof_sdw_codec_info {
81 	const int part_id;
82 	const int version_id;
83 	int amp_num;
84 	const u8 acpi_id[ACPI_ID_LEN];
85 	const bool ignore_pch_dmic;
86 	const struct snd_soc_ops *ops;
87 	struct sof_sdw_dai_info dais[SOF_SDW_MAX_DAI_NUM];
88 	const int dai_num;
89 
90 	int (*codec_card_late_probe)(struct snd_soc_card *card);
91 };
92 
93 struct mc_private {
94 	struct list_head hdmi_pcm_list;
95 	bool idisp_codec;
96 	struct snd_soc_jack sdw_headset;
97 	struct device *headset_codec_dev; /* only one headset per card */
98 	struct device *amp_dev1, *amp_dev2;
99 };
100 
101 extern unsigned long sof_sdw_quirk;
102 
103 int sdw_startup(struct snd_pcm_substream *substream);
104 int sdw_prepare(struct snd_pcm_substream *substream);
105 int sdw_trigger(struct snd_pcm_substream *substream, int cmd);
106 int sdw_hw_free(struct snd_pcm_substream *substream);
107 void sdw_shutdown(struct snd_pcm_substream *substream);
108 
109 /* generic HDMI support */
110 int sof_sdw_hdmi_init(struct snd_soc_pcm_runtime *rtd);
111 
112 int sof_sdw_hdmi_card_late_probe(struct snd_soc_card *card);
113 
114 /* DMIC support */
115 int sof_sdw_dmic_init(struct snd_soc_pcm_runtime *rtd);
116 
117 /* RT711 support */
118 int sof_sdw_rt711_init(struct snd_soc_card *card,
119 		       const struct snd_soc_acpi_link_adr *link,
120 		       struct snd_soc_dai_link *dai_links,
121 		       struct sof_sdw_codec_info *info,
122 		       bool playback);
123 int sof_sdw_rt711_exit(struct snd_soc_card *card, struct snd_soc_dai_link *dai_link);
124 
125 /* RT711-SDCA support */
126 int sof_sdw_rt_sdca_jack_init(struct snd_soc_card *card,
127 			      const struct snd_soc_acpi_link_adr *link,
128 			      struct snd_soc_dai_link *dai_links,
129 			      struct sof_sdw_codec_info *info,
130 			      bool playback);
131 int sof_sdw_rt_sdca_jack_exit(struct snd_soc_card *card, struct snd_soc_dai_link *dai_link);
132 
133 /* RT712-SDCA support */
134 int sof_sdw_rt712_sdca_init(struct snd_soc_card *card,
135 			    const struct snd_soc_acpi_link_adr *link,
136 			    struct snd_soc_dai_link *dai_links,
137 			    struct sof_sdw_codec_info *info,
138 			    bool playback);
139 int sof_sdw_rt712_sdca_exit(struct snd_soc_card *card, struct snd_soc_dai_link *dai_link);
140 int sof_sdw_rt712_spk_init(struct snd_soc_card *card,
141 			   const struct snd_soc_acpi_link_adr *link,
142 			   struct snd_soc_dai_link *dai_links,
143 			   struct sof_sdw_codec_info *info,
144 			   bool playback);
145 int sof_sdw_rt712_sdca_dmic_init(struct snd_soc_card *card,
146 				 const struct snd_soc_acpi_link_adr *link,
147 				 struct snd_soc_dai_link *dai_links,
148 				 struct sof_sdw_codec_info *info,
149 				 bool playback);
150 
151 /* RT700 support */
152 int sof_sdw_rt700_init(struct snd_soc_card *card,
153 		       const struct snd_soc_acpi_link_adr *link,
154 		       struct snd_soc_dai_link *dai_links,
155 		       struct sof_sdw_codec_info *info,
156 		       bool playback);
157 
158 /* RT1308 I2S support */
159 extern struct snd_soc_ops sof_sdw_rt1308_i2s_ops;
160 
161 /* generic amp support */
162 int sof_sdw_rt_amp_init(struct snd_soc_card *card,
163 			const struct snd_soc_acpi_link_adr *link,
164 			struct snd_soc_dai_link *dai_links,
165 			struct sof_sdw_codec_info *info,
166 			bool playback);
167 int sof_sdw_rt_amp_exit(struct snd_soc_card *card, struct snd_soc_dai_link *dai_link);
168 
169 /* RT1316 support */
170 
171 /* RT715 support */
172 int sof_sdw_rt715_init(struct snd_soc_card *card,
173 		       const struct snd_soc_acpi_link_adr *link,
174 		       struct snd_soc_dai_link *dai_links,
175 		       struct sof_sdw_codec_info *info,
176 		       bool playback);
177 
178 /* RT715-SDCA support */
179 int sof_sdw_rt715_sdca_init(struct snd_soc_card *card,
180 			    const struct snd_soc_acpi_link_adr *link,
181 			    struct snd_soc_dai_link *dai_links,
182 			    struct sof_sdw_codec_info *info,
183 			    bool playback);
184 
185 /* MAXIM codec support */
186 int sof_sdw_maxim_init(struct snd_soc_card *card,
187 		       const struct snd_soc_acpi_link_adr *link,
188 		       struct snd_soc_dai_link *dai_links,
189 		       struct sof_sdw_codec_info *info,
190 		       bool playback);
191 
192 /* RT5682 support */
193 int sof_sdw_rt5682_init(struct snd_soc_card *card,
194 			const struct snd_soc_acpi_link_adr *link,
195 			struct snd_soc_dai_link *dai_links,
196 			struct sof_sdw_codec_info *info,
197 			bool playback);
198 
199 /* CS42L42 support */
200 int sof_sdw_cs42l42_init(struct snd_soc_card *card,
201 			 const struct snd_soc_acpi_link_adr *link,
202 			 struct snd_soc_dai_link *dai_links,
203 			 struct sof_sdw_codec_info *info,
204 			 bool playback);
205 
206 #endif
207