/* SPDX-License-Identifier: GPL-2.0-only * * Copyright (C) 2013-15, Intel Corporation */ #ifndef __LINUX_SND_SOC_ACPI_H #define __LINUX_SND_SOC_ACPI_H #include <linux/stddef.h> #include <linux/acpi.h> #include <linux/mod_devicetable.h> #include <linux/soundwire/sdw.h> struct snd_soc_acpi_package_context { … }; /* codec name is used in DAIs is i2c-<HID>:00 with HID being 8 chars */ #define SND_ACPI_I2C_ID_LEN … #if IS_ENABLED(CONFIG_ACPI) /* acpi match */ struct snd_soc_acpi_mach * snd_soc_acpi_find_machine(struct snd_soc_acpi_mach *machines); bool snd_soc_acpi_find_package_from_hid(const u8 hid[ACPI_ID_LEN], struct snd_soc_acpi_package_context *ctx); /* check all codecs */ struct snd_soc_acpi_mach *snd_soc_acpi_codec_list(void *arg); #else /* acpi match */ static inline struct snd_soc_acpi_mach * snd_soc_acpi_find_machine(struct snd_soc_acpi_mach *machines) { return NULL; } static inline bool snd_soc_acpi_find_package_from_hid(const u8 hid[ACPI_ID_LEN], struct snd_soc_acpi_package_context *ctx) { return false; } /* check all codecs */ static inline struct snd_soc_acpi_mach *snd_soc_acpi_codec_list(void *arg) { return NULL; } #endif /** * snd_soc_acpi_mach_params: interface for machine driver configuration * * @acpi_ipc_irq_index: used for BYT-CR detection * @platform: string used for HDAudio codec support * @codec_mask: used for HDAudio support * @dmic_num: number of SoC- or chipset-attached PDM digital microphones * @common_hdmi_codec_drv: use commom HDAudio HDMI codec driver * @link_mask: SoundWire links enabled on the board * @links: array of SoundWire link _ADR descriptors, null terminated * @i2s_link_mask: I2S/TDM links enabled on the board * @num_dai_drivers: number of elements in @dai_drivers * @dai_drivers: pointer to dai_drivers, used e.g. in nocodec mode * @subsystem_vendor: optional PCI SSID vendor value * @subsystem_device: optional PCI SSID device value * @subsystem_id_set: true if a value has been written to * subsystem_vendor and subsystem_device. */ struct snd_soc_acpi_mach_params { … }; /** * snd_soc_acpi_endpoint - endpoint descriptor * @num: endpoint number (mandatory, unique per device) * @aggregated: 0 (independent) or 1 (logically grouped) * @group_position: zero-based order (only when @aggregated is 1) * @group_id: platform-unique group identifier (only when @aggregrated is 1) */ struct snd_soc_acpi_endpoint { … }; /** * snd_soc_acpi_adr_device - descriptor for _ADR-enumerated device * @adr: 64 bit ACPI _ADR value * @num_endpoints: number of endpoints for this device * @endpoints: array of endpoints * @name_prefix: string used for codec controls */ struct snd_soc_acpi_adr_device { … }; /** * snd_soc_acpi_link_adr - ACPI-based list of _ADR enumerated devices * @mask: one bit set indicates the link this list applies to * @num_adr: ARRAY_SIZE of devices * @adr_d: array of devices * * The number of devices per link can be more than 1, e.g. in SoundWire * multi-drop configurations. */ struct snd_soc_acpi_link_adr { … }; /* * when set the topology uses the -ssp<N> suffix, where N is determined based on * BIOS or DMI information */ #define SND_SOC_ACPI_TPLG_INTEL_SSP_NUMBER … /* * when more than one SSP is reported in the link mask, use the most significant. * This choice was found to be valid on platforms with ES8336 codecs. */ #define SND_SOC_ACPI_TPLG_INTEL_SSP_MSB … /* * when set the topology uses the -dmic<N>ch suffix, where N is determined based on * BIOS or DMI information */ #define SND_SOC_ACPI_TPLG_INTEL_DMIC_NUMBER … /* * when set the speaker amplifier name suffix (i.e. "-max98360a") will be * appended to topology file name */ #define SND_SOC_ACPI_TPLG_INTEL_AMP_NAME … /* * when set the headphone codec name suffix (i.e. "-rt5682") will be appended to * topology file name */ #define SND_SOC_ACPI_TPLG_INTEL_CODEC_NAME … /** * snd_soc_acpi_mach: ACPI-based machine descriptor. Most of the fields are * related to the hardware, except for the firmware and topology file names. * A platform supported by legacy and Sound Open Firmware (SOF) would expose * all firmware/topology related fields. * * @id: ACPI ID (usually the codec's) used to find a matching machine driver. * @uid: ACPI Unique ID, can be used to disambiguate matches. * @comp_ids: list of compatible audio codecs using the same machine driver, * firmware and topology * @link_mask: describes required board layout, e.g. for SoundWire. * @links: array of link _ADR descriptors, null terminated. * @drv_name: machine driver name * @fw_filename: firmware file name. Used when SOF is not enabled. * @tplg_filename: topology file name. Used when SOF is not enabled. * @board: board name * @machine_quirk: pointer to quirk, usually based on DMI information when * ACPI ID alone is not sufficient, wrong or misleading * @quirk_data: data used to uniquely identify a machine, usually a list of * audio codecs whose presence if checked with ACPI * @pdata: intended for platform data or machine specific-ops. This structure * is not constant since this field may be updated at run-time * @sof_tplg_filename: Sound Open Firmware topology file name, if enabled * @tplg_quirk_mask: quirks to select different topology files dynamically */ /* Descriptor for SST ASoC machine driver */ struct snd_soc_acpi_mach { … }; #define SND_SOC_ACPI_MAX_CODECS … /** * struct snd_soc_acpi_codecs: Structure to hold secondary codec information * apart from the matched one, this data will be passed to the quirk function * to match with the ACPI detected devices * * @num_codecs: number of secondary codecs used in the platform * @codecs: holds the codec IDs * */ struct snd_soc_acpi_codecs { … }; static inline bool snd_soc_acpi_sof_parent(struct device *dev) { … } bool snd_soc_acpi_sdw_link_slaves_found(struct device *dev, const struct snd_soc_acpi_link_adr *link, struct sdw_extended_slave_id *ids, int num_slaves); #endif