240 lines · c
1/* SPDX-License-Identifier: GPL-2.0-only2 *3 * Copyright (C) 2013-15, Intel Corporation4 */5 6#ifndef __LINUX_SND_SOC_ACPI_H7#define __LINUX_SND_SOC_ACPI_H8 9#include <linux/stddef.h>10#include <linux/acpi.h>11#include <linux/mod_devicetable.h>12#include <linux/soundwire/sdw.h>13 14struct 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 */27struct snd_soc_acpi_mach *28snd_soc_acpi_find_machine(struct snd_soc_acpi_mach *machines);29 30bool 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 */34struct snd_soc_acpi_mach *snd_soc_acpi_codec_list(void *arg);35 36#else37/* acpi match */38static inline struct snd_soc_acpi_mach *39snd_soc_acpi_find_machine(struct snd_soc_acpi_mach *machines)40{41 return NULL;42}43 44static inline bool45snd_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 */52static inline struct snd_soc_acpi_mach *snd_soc_acpi_codec_list(void *arg)53{54 return NULL;55}56#endif57 58/**59 * snd_soc_acpi_mach_params: interface for machine driver configuration60 *61 * @acpi_ipc_irq_index: used for BYT-CR detection62 * @platform: string used for HDAudio codec support63 * @codec_mask: used for HDAudio support64 * @dmic_num: number of SoC- or chipset-attached PDM digital microphones65 * @link_mask: SoundWire links enabled on the board66 * @links: array of SoundWire link _ADR descriptors, null terminated67 * @i2s_link_mask: I2S/TDM links enabled on the board68 * @num_dai_drivers: number of elements in @dai_drivers69 * @dai_drivers: pointer to dai_drivers, used e.g. in nocodec mode70 * @subsystem_vendor: optional PCI SSID vendor value71 * @subsystem_device: optional PCI SSID device value72 * @subsystem_rev: optional PCI SSID revision value73 * @subsystem_id_set: true if a value has been written to74 * subsystem_vendor and subsystem_device.75 * @bt_link_mask: BT offload link enabled on the board76 */77struct snd_soc_acpi_mach_params {78 u32 acpi_ipc_irq_index;79 const char *platform;80 u32 codec_mask;81 u32 dmic_num;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 unsigned short subsystem_rev;90 bool subsystem_id_set;91 u32 bt_link_mask;92};93 94/**95 * snd_soc_acpi_endpoint - endpoint descriptor96 * @num: endpoint number (mandatory, unique per device)97 * @aggregated: 0 (independent) or 1 (logically grouped)98 * @group_position: zero-based order (only when @aggregated is 1)99 * @group_id: platform-unique group identifier (only when @aggregrated is 1)100 */101struct snd_soc_acpi_endpoint {102 u8 num;103 u8 aggregated;104 u8 group_position;105 u8 group_id;106};107 108/**109 * snd_soc_acpi_adr_device - descriptor for _ADR-enumerated device110 * @adr: 64 bit ACPI _ADR value111 * @num_endpoints: number of endpoints for this device112 * @endpoints: array of endpoints113 * @name_prefix: string used for codec controls114 */115struct snd_soc_acpi_adr_device {116 const u64 adr;117 const u8 num_endpoints;118 const struct snd_soc_acpi_endpoint *endpoints;119 const char *name_prefix;120};121 122/**123 * snd_soc_acpi_link_adr - ACPI-based list of _ADR enumerated devices124 * @mask: one bit set indicates the link this list applies to125 * @num_adr: ARRAY_SIZE of devices126 * @adr_d: array of devices127 *128 * The number of devices per link can be more than 1, e.g. in SoundWire129 * multi-drop configurations.130 */131 132struct snd_soc_acpi_link_adr {133 const u32 mask;134 const u32 num_adr;135 const struct snd_soc_acpi_adr_device *adr_d;136};137 138/*139 * when set the topology uses the -ssp<N> suffix, where N is determined based on140 * BIOS or DMI information141 */142#define SND_SOC_ACPI_TPLG_INTEL_SSP_NUMBER BIT(0)143 144/*145 * when more than one SSP is reported in the link mask, use the most significant.146 * This choice was found to be valid on platforms with ES8336 codecs.147 */148#define SND_SOC_ACPI_TPLG_INTEL_SSP_MSB BIT(1)149 150/*151 * when set the topology uses the -dmic<N>ch suffix, where N is determined based on152 * BIOS or DMI information153 */154#define SND_SOC_ACPI_TPLG_INTEL_DMIC_NUMBER BIT(2)155 156/*157 * when set the speaker amplifier name suffix (i.e. "-max98360a") will be158 * appended to topology file name159 */160#define SND_SOC_ACPI_TPLG_INTEL_AMP_NAME BIT(3)161 162/*163 * when set the headphone codec name suffix (i.e. "-rt5682") will be appended to164 * topology file name165 */166#define SND_SOC_ACPI_TPLG_INTEL_CODEC_NAME BIT(4)167 168/**169 * snd_soc_acpi_mach: ACPI-based machine descriptor. Most of the fields are170 * related to the hardware, except for the firmware and topology file names.171 * A platform supported by legacy and Sound Open Firmware (SOF) would expose172 * all firmware/topology related fields.173 *174 * @id: ACPI ID (usually the codec's) used to find a matching machine driver.175 * @uid: ACPI Unique ID, can be used to disambiguate matches.176 * @comp_ids: list of compatible audio codecs using the same machine driver,177 * firmware and topology178 * @link_mask: describes required board layout, e.g. for SoundWire.179 * @links: array of link _ADR descriptors, null terminated.180 * @drv_name: machine driver name181 * @fw_filename: firmware file name. Used when SOF is not enabled.182 * @tplg_filename: topology file name. Used when SOF is not enabled.183 * @board: board name184 * @machine_quirk: pointer to quirk, usually based on DMI information when185 * ACPI ID alone is not sufficient, wrong or misleading186 * @quirk_data: data used to uniquely identify a machine, usually a list of187 * audio codecs whose presence if checked with ACPI188 * @pdata: intended for platform data or machine specific-ops. This structure189 * is not constant since this field may be updated at run-time190 * @sof_tplg_filename: Sound Open Firmware topology file name, if enabled191 * @tplg_quirk_mask: quirks to select different topology files dynamically192 */193/* Descriptor for SST ASoC machine driver */194struct snd_soc_acpi_mach {195 u8 id[ACPI_ID_LEN];196 const char *uid;197 const struct snd_soc_acpi_codecs *comp_ids;198 const u32 link_mask;199 const struct snd_soc_acpi_link_adr *links;200 const char *drv_name;201 const char *fw_filename;202 const char *tplg_filename;203 const char *board;204 struct snd_soc_acpi_mach * (*machine_quirk)(void *arg);205 const void *quirk_data;206 void *pdata;207 struct snd_soc_acpi_mach_params mach_params;208 const char *sof_tplg_filename;209 const u32 tplg_quirk_mask;210};211 212#define SND_SOC_ACPI_MAX_CODECS 3213 214/**215 * struct snd_soc_acpi_codecs: Structure to hold secondary codec information216 * apart from the matched one, this data will be passed to the quirk function217 * to match with the ACPI detected devices218 *219 * @num_codecs: number of secondary codecs used in the platform220 * @codecs: holds the codec IDs221 *222 */223struct snd_soc_acpi_codecs {224 int num_codecs;225 u8 codecs[SND_SOC_ACPI_MAX_CODECS][ACPI_ID_LEN];226};227 228static inline bool snd_soc_acpi_sof_parent(struct device *dev)229{230 return dev->parent && dev->parent->driver && dev->parent->driver->name &&231 !strncmp(dev->parent->driver->name, "sof-audio-acpi", strlen("sof-audio-acpi"));232}233 234bool snd_soc_acpi_sdw_link_slaves_found(struct device *dev,235 const struct snd_soc_acpi_link_adr *link,236 struct sdw_extended_slave_id *ids,237 int num_slaves);238 239#endif240