1 /* SPDX-License-Identifier: GPL-2.0-only
2 *
3 * Copyright (C) 2013-15, Intel Corporation
4 */
5
6 #ifndef __LINUX_SND_SOC_ACPI_H
7 #define __LINUX_SND_SOC_ACPI_H
8
9 #include <linux/stddef.h>
10 #include <linux/acpi.h>
11 #include <linux/mod_devicetable.h>
12 #include <linux/soundwire/sdw.h>
13
14 struct snd_soc_acpi_package_context {
15 char *name; /* package name */
16 int length; /* number of elements */
17 struct acpi_buffer *format;
18 struct acpi_buffer *state;
19 bool data_valid;
20 };
21
22 /* codec name is used in DAIs is i2c-<HID>:00 with HID being 8 chars */
23 #define SND_ACPI_I2C_ID_LEN (4 + ACPI_ID_LEN + 3 + 1)
24
25 #if IS_ENABLED(CONFIG_ACPI)
26 /* acpi match */
27 struct snd_soc_acpi_mach *
28 snd_soc_acpi_find_machine(struct snd_soc_acpi_mach *machines);
29
30 bool snd_soc_acpi_find_package_from_hid(const u8 hid[ACPI_ID_LEN],
31 struct snd_soc_acpi_package_context *ctx);
32
33 /* check all codecs */
34 struct snd_soc_acpi_mach *snd_soc_acpi_codec_list(void *arg);
35
36 #else
37 /* acpi match */
38 static inline struct snd_soc_acpi_mach *
39 snd_soc_acpi_find_machine(struct snd_soc_acpi_mach *machines)
40 {
41 return NULL;
42 }
43
44 static inline bool
45 snd_soc_acpi_find_package_from_hid(const u8 hid[ACPI_ID_LEN],
46 struct snd_soc_acpi_package_context *ctx)
47 {
48 return false;
49 }
50
51 /* check all codecs */
52 static inline struct snd_soc_acpi_mach *snd_soc_acpi_codec_list(void *arg)
53 {
54 return NULL;
55 }
56 #endif
57
58 /**
59 * snd_soc_acpi_mach_params: interface for machine driver configuration
60 *
61 * @acpi_ipc_irq_index: used for BYT-CR detection
62 * @platform: string used for HDAudio codec support
63 * @codec_mask: used for HDAudio support
64 * @dmic_num: number of SoC- or chipset-attached PDM digital microphones
65 * @common_hdmi_codec_drv: use commom HDAudio HDMI codec driver
66 * @link_mask: SoundWire links enabled on the board
67 * @links: array of SoundWire link _ADR descriptors, null terminated
68 * @i2s_link_mask: I2S/TDM links enabled on the board
69 * @num_dai_drivers: number of elements in @dai_drivers
70 * @dai_drivers: pointer to dai_drivers, used e.g. in nocodec mode
71 * @subsystem_vendor: optional PCI SSID vendor value
72 * @subsystem_device: optional PCI SSID device value
73 * @subsystem_id_set: true if a value has been written to
74 * subsystem_vendor and subsystem_device.
75 */
76 struct snd_soc_acpi_mach_params {
77 u32 acpi_ipc_irq_index;
78 const char *platform;
79 u32 codec_mask;
80 u32 dmic_num;
81 bool common_hdmi_codec_drv;
82 u32 link_mask;
83 const struct snd_soc_acpi_link_adr *links;
84 u32 i2s_link_mask;
85 u32 num_dai_drivers;
86 struct snd_soc_dai_driver *dai_drivers;
87 unsigned short subsystem_vendor;
88 unsigned short subsystem_device;
89 bool subsystem_id_set;
90 };
91
92 /**
93 * snd_soc_acpi_endpoint - endpoint descriptor
94 * @num: endpoint number (mandatory, unique per device)
95 * @aggregated: 0 (independent) or 1 (logically grouped)
96 * @group_position: zero-based order (only when @aggregated is 1)
97 * @group_id: platform-unique group identifier (only when @aggregrated is 1)
98 */
99 struct snd_soc_acpi_endpoint {
100 u8 num;
101 u8 aggregated;
102 u8 group_position;
103 u8 group_id;
104 };
105
106 /**
107 * snd_soc_acpi_adr_device - descriptor for _ADR-enumerated device
108 * @adr: 64 bit ACPI _ADR value
109 * @num_endpoints: number of endpoints for this device
110 * @endpoints: array of endpoints
111 * @name_prefix: string used for codec controls
112 */
113 struct snd_soc_acpi_adr_device {
114 const u64 adr;
115 const u8 num_endpoints;
116 const struct snd_soc_acpi_endpoint *endpoints;
117 const char *name_prefix;
118 };
119
120 /**
121 * snd_soc_acpi_link_adr - ACPI-based list of _ADR enumerated devices
122 * @mask: one bit set indicates the link this list applies to
123 * @num_adr: ARRAY_SIZE of devices
124 * @adr_d: array of devices
125 *
126 * The number of devices per link can be more than 1, e.g. in SoundWire
127 * multi-drop configurations.
128 */
129
130 struct snd_soc_acpi_link_adr {
131 const u32 mask;
132 const u32 num_adr;
133 const struct snd_soc_acpi_adr_device *adr_d;
134 };
135
136 /*
137 * when set the topology uses the -ssp<N> suffix, where N is determined based on
138 * BIOS or DMI information
139 */
140 #define SND_SOC_ACPI_TPLG_INTEL_SSP_NUMBER BIT(0)
141
142 /*
143 * when more than one SSP is reported in the link mask, use the most significant.
144 * This choice was found to be valid on platforms with ES8336 codecs.
145 */
146 #define SND_SOC_ACPI_TPLG_INTEL_SSP_MSB BIT(1)
147
148 /*
149 * when set the topology uses the -dmic<N>ch suffix, where N is determined based on
150 * BIOS or DMI information
151 */
152 #define SND_SOC_ACPI_TPLG_INTEL_DMIC_NUMBER BIT(2)
153
154 /*
155 * when set the speaker amplifier name suffix (i.e. "-max98360a") will be
156 * appended to topology file name
157 */
158 #define SND_SOC_ACPI_TPLG_INTEL_AMP_NAME BIT(3)
159
160 /*
161 * when set the headphone codec name suffix (i.e. "-rt5682") will be appended to
162 * topology file name
163 */
164 #define SND_SOC_ACPI_TPLG_INTEL_CODEC_NAME BIT(4)
165
166 /**
167 * snd_soc_acpi_mach: ACPI-based machine descriptor. Most of the fields are
168 * related to the hardware, except for the firmware and topology file names.
169 * A platform supported by legacy and Sound Open Firmware (SOF) would expose
170 * all firmware/topology related fields.
171 *
172 * @id: ACPI ID (usually the codec's) used to find a matching machine driver.
173 * @uid: ACPI Unique ID, can be used to disambiguate matches.
174 * @comp_ids: list of compatible audio codecs using the same machine driver,
175 * firmware and topology
176 * @link_mask: describes required board layout, e.g. for SoundWire.
177 * @links: array of link _ADR descriptors, null terminated.
178 * @drv_name: machine driver name
179 * @fw_filename: firmware file name. Used when SOF is not enabled.
180 * @tplg_filename: topology file name. Used when SOF is not enabled.
181 * @board: board name
182 * @machine_quirk: pointer to quirk, usually based on DMI information when
183 * ACPI ID alone is not sufficient, wrong or misleading
184 * @quirk_data: data used to uniquely identify a machine, usually a list of
185 * audio codecs whose presence if checked with ACPI
186 * @pdata: intended for platform data or machine specific-ops. This structure
187 * is not constant since this field may be updated at run-time
188 * @sof_tplg_filename: Sound Open Firmware topology file name, if enabled
189 * @tplg_quirk_mask: quirks to select different topology files dynamically
190 */
191 /* Descriptor for SST ASoC machine driver */
192 struct snd_soc_acpi_mach {
193 u8 id[ACPI_ID_LEN];
194 const char *uid;
195 const struct snd_soc_acpi_codecs *comp_ids;
196 const u32 link_mask;
197 const struct snd_soc_acpi_link_adr *links;
198 const char *drv_name;
199 const char *fw_filename;
200 const char *tplg_filename;
201 const char *board;
202 struct snd_soc_acpi_mach * (*machine_quirk)(void *arg);
203 const void *quirk_data;
204 void *pdata;
205 struct snd_soc_acpi_mach_params mach_params;
206 const char *sof_tplg_filename;
207 const u32 tplg_quirk_mask;
208 };
209
210 #define SND_SOC_ACPI_MAX_CODECS 3
211
212 /**
213 * struct snd_soc_acpi_codecs: Structure to hold secondary codec information
214 * apart from the matched one, this data will be passed to the quirk function
215 * to match with the ACPI detected devices
216 *
217 * @num_codecs: number of secondary codecs used in the platform
218 * @codecs: holds the codec IDs
219 *
220 */
221 struct snd_soc_acpi_codecs {
222 int num_codecs;
223 u8 codecs[SND_SOC_ACPI_MAX_CODECS][ACPI_ID_LEN];
224 };
225
226 static inline bool snd_soc_acpi_sof_parent(struct device *dev)
227 {
228 return dev->parent && dev->parent->driver && dev->parent->driver->name &&
229 !strncmp(dev->parent->driver->name, "sof-audio-acpi", strlen("sof-audio-acpi"));
230 }
231
232 bool snd_soc_acpi_sdw_link_slaves_found(struct device *dev,
233 const struct snd_soc_acpi_link_adr *link,
234 struct sdw_extended_slave_id *ids,
235 int num_slaves);
236
237 #endif
238
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.