2020-05-01 22:58:50 +08:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0-only
|
2017-10-13 07:49:38 +08:00
|
|
|
*
|
2018-07-02 14:24:04 +08:00
|
|
|
* Copyright (C) 2013-15, Intel Corporation. All rights reserved.
|
2017-10-13 07:49:38 +08:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __LINUX_SND_SOC_ACPI_H
|
|
|
|
#define __LINUX_SND_SOC_ACPI_H
|
|
|
|
|
|
|
|
#include <linux/stddef.h>
|
|
|
|
#include <linux/acpi.h>
|
2018-01-05 06:35:52 +08:00
|
|
|
#include <linux/mod_devicetable.h>
|
2017-10-13 07:49:38 +08:00
|
|
|
|
|
|
|
struct snd_soc_acpi_package_context {
|
|
|
|
char *name; /* package name */
|
|
|
|
int length; /* number of elements */
|
|
|
|
struct acpi_buffer *format;
|
|
|
|
struct acpi_buffer *state;
|
|
|
|
bool data_valid;
|
|
|
|
};
|
|
|
|
|
2018-01-12 03:52:09 +08:00
|
|
|
/* codec name is used in DAIs is i2c-<HID>:00 with HID being 8 chars */
|
|
|
|
#define SND_ACPI_I2C_ID_LEN (4 + ACPI_ID_LEN + 3 + 1)
|
|
|
|
|
2017-10-13 07:49:38 +08:00
|
|
|
#if IS_ENABLED(CONFIG_ACPI)
|
2019-01-26 04:16:17 +08:00
|
|
|
/* acpi match */
|
|
|
|
struct snd_soc_acpi_mach *
|
|
|
|
snd_soc_acpi_find_machine(struct snd_soc_acpi_mach *machines);
|
|
|
|
|
2017-10-13 07:49:38 +08:00
|
|
|
bool snd_soc_acpi_find_package_from_hid(const u8 hid[ACPI_ID_LEN],
|
|
|
|
struct snd_soc_acpi_package_context *ctx);
|
2019-01-26 04:16:17 +08:00
|
|
|
|
|
|
|
/* check all codecs */
|
|
|
|
struct snd_soc_acpi_mach *snd_soc_acpi_codec_list(void *arg);
|
|
|
|
|
2017-10-13 07:49:38 +08:00
|
|
|
#else
|
2019-01-26 04:16:17 +08:00
|
|
|
/* acpi match */
|
|
|
|
static inline struct snd_soc_acpi_mach *
|
|
|
|
snd_soc_acpi_find_machine(struct snd_soc_acpi_mach *machines)
|
|
|
|
{
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2017-10-13 07:49:38 +08:00
|
|
|
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;
|
|
|
|
}
|
|
|
|
|
2019-01-26 04:16:17 +08:00
|
|
|
/* check all codecs */
|
|
|
|
static inline struct snd_soc_acpi_mach *snd_soc_acpi_codec_list(void *arg)
|
|
|
|
{
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
#endif
|
2017-10-13 07:49:38 +08:00
|
|
|
|
2018-11-02 05:34:48 +08:00
|
|
|
/**
|
|
|
|
* snd_soc_acpi_mach_params: interface for machine driver configuration
|
|
|
|
*
|
|
|
|
* @acpi_ipc_irq_index: used for BYT-CR detection
|
2020-08-25 04:09:12 +08:00
|
|
|
* @platform: string used for HDAudio codec support
|
2018-11-02 05:34:48 +08:00
|
|
|
* @codec_mask: used for HDAudio support
|
2019-10-29 21:40:11 +08:00
|
|
|
* @common_hdmi_codec_drv: use commom HDAudio HDMI codec driver
|
2020-01-11 06:25:25 +08:00
|
|
|
* @link_mask: links enabled on the board
|
|
|
|
* @links: array of link _ADR descriptors, null terminated
|
2021-04-10 06:01:17 +08:00
|
|
|
* @num_dai_drivers: number of elements in @dai_drivers
|
|
|
|
* @dai_drivers: pointer to dai_drivers, used e.g. in nocodec mode
|
2018-11-02 05:34:48 +08:00
|
|
|
*/
|
|
|
|
struct snd_soc_acpi_mach_params {
|
|
|
|
u32 acpi_ipc_irq_index;
|
|
|
|
const char *platform;
|
|
|
|
u32 codec_mask;
|
2018-11-17 08:47:05 +08:00
|
|
|
u32 dmic_num;
|
2019-10-29 21:40:11 +08:00
|
|
|
bool common_hdmi_codec_drv;
|
2020-01-11 06:25:25 +08:00
|
|
|
u32 link_mask;
|
|
|
|
const struct snd_soc_acpi_link_adr *links;
|
2021-04-10 06:01:17 +08:00
|
|
|
u32 num_dai_drivers;
|
|
|
|
struct snd_soc_dai_driver *dai_drivers;
|
2020-01-11 06:25:25 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
2020-03-26 05:50:17 +08:00
|
|
|
* 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 {
|
|
|
|
u8 num;
|
|
|
|
u8 aggregated;
|
|
|
|
u8 group_position;
|
|
|
|
u8 group_id;
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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
|
2020-09-23 16:05:11 +08:00
|
|
|
* @name_prefix: string used for codec controls
|
2020-03-26 05:50:17 +08:00
|
|
|
*/
|
|
|
|
struct snd_soc_acpi_adr_device {
|
|
|
|
const u64 adr;
|
|
|
|
const u8 num_endpoints;
|
|
|
|
const struct snd_soc_acpi_endpoint *endpoints;
|
2020-09-23 16:05:11 +08:00
|
|
|
const char *name_prefix;
|
2020-03-26 05:50:17 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* snd_soc_acpi_link_adr - ACPI-based list of _ADR enumerated devices
|
2020-01-11 06:25:25 +08:00
|
|
|
* @mask: one bit set indicates the link this list applies to
|
2020-03-26 05:50:17 +08:00
|
|
|
* @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.
|
2020-01-11 06:25:25 +08:00
|
|
|
*/
|
|
|
|
|
|
|
|
struct snd_soc_acpi_link_adr {
|
|
|
|
const u32 mask;
|
|
|
|
const u32 num_adr;
|
2020-03-26 05:50:17 +08:00
|
|
|
const struct snd_soc_acpi_adr_device *adr_d;
|
2018-11-02 05:34:48 +08:00
|
|
|
};
|
|
|
|
|
2017-10-13 07:49:38 +08:00
|
|
|
/**
|
|
|
|
* 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.
|
2017-10-13 07:49:40 +08:00
|
|
|
* A platform supported by legacy and Sound Open Firmware (SOF) would expose
|
|
|
|
* all firmware/topology related fields.
|
2017-10-13 07:49:38 +08:00
|
|
|
*
|
|
|
|
* @id: ACPI ID (usually the codec's) used to find a matching machine driver.
|
2019-09-17 05:42:40 +08:00
|
|
|
* @link_mask: describes required board layout, e.g. for SoundWire.
|
2020-01-11 06:25:25 +08:00
|
|
|
* @links: array of link _ADR descriptors, null terminated.
|
2017-10-13 07:49:38 +08:00
|
|
|
* @drv_name: machine driver name
|
2017-10-13 07:49:40 +08:00
|
|
|
* @fw_filename: firmware file name. Used when SOF is not enabled.
|
2017-10-13 07:49:38 +08:00
|
|
|
* @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
|
2017-10-13 07:49:40 +08:00
|
|
|
* @sof_fw_filename: Sound Open Firmware file name, if enabled
|
|
|
|
* @sof_tplg_filename: Sound Open Firmware topology file name, if enabled
|
2017-10-13 07:49:38 +08:00
|
|
|
*/
|
|
|
|
/* Descriptor for SST ASoC machine driver */
|
|
|
|
struct snd_soc_acpi_mach {
|
|
|
|
const u8 id[ACPI_ID_LEN];
|
2019-09-17 05:42:40 +08:00
|
|
|
const u32 link_mask;
|
2020-01-11 06:25:25 +08:00
|
|
|
const struct snd_soc_acpi_link_adr *links;
|
2017-10-13 07:49:38 +08:00
|
|
|
const char *drv_name;
|
|
|
|
const char *fw_filename;
|
|
|
|
const char *board;
|
|
|
|
struct snd_soc_acpi_mach * (*machine_quirk)(void *arg);
|
|
|
|
const void *quirk_data;
|
|
|
|
void *pdata;
|
2018-11-02 05:34:48 +08:00
|
|
|
struct snd_soc_acpi_mach_params mach_params;
|
2017-10-13 07:49:40 +08:00
|
|
|
const char *sof_fw_filename;
|
|
|
|
const char *sof_tplg_filename;
|
2017-10-13 07:49:38 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
#define SND_SOC_ACPI_MAX_CODECS 3
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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 {
|
|
|
|
int num_codecs;
|
|
|
|
u8 codecs[SND_SOC_ACPI_MAX_CODECS][ACPI_ID_LEN];
|
|
|
|
};
|
|
|
|
|
2020-11-13 06:38:15 +08:00
|
|
|
static inline bool snd_soc_acpi_sof_parent(struct device *dev)
|
|
|
|
{
|
|
|
|
return dev->parent && dev->parent->driver && dev->parent->driver->name &&
|
2021-03-02 08:31:19 +08:00
|
|
|
!strncmp(dev->parent->driver->name, "sof-audio-acpi", strlen("sof-audio-acpi"));
|
2020-11-13 06:38:15 +08:00
|
|
|
}
|
|
|
|
|
2017-10-13 07:49:38 +08:00
|
|
|
#endif
|