1/* SPDX-License-Identifier: GPL-2.0-only
  2 *
  3 * Copyright (C) 2013-15, Intel Corporation. All rights reserved.
  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
 13struct snd_soc_acpi_package_context {
 14	char *name;           /* package name */
 15	int length;           /* number of elements */
 16	struct acpi_buffer *format;
 17	struct acpi_buffer *state;
 18	bool data_valid;
 19};
 20
 21/* codec name is used in DAIs is i2c-<HID>:00 with HID being 8 chars */
 22#define SND_ACPI_I2C_ID_LEN (4 + ACPI_ID_LEN + 3 + 1)
 23
 24#if IS_ENABLED(CONFIG_ACPI)
 25/* acpi match */
 26struct snd_soc_acpi_mach *
 27snd_soc_acpi_find_machine(struct snd_soc_acpi_mach *machines);
 28
 29bool snd_soc_acpi_find_package_from_hid(const u8 hid[ACPI_ID_LEN],
 30				    struct snd_soc_acpi_package_context *ctx);
 31
 32/* check all codecs */
 33struct snd_soc_acpi_mach *snd_soc_acpi_codec_list(void *arg);
 34
 35#else
 36/* acpi match */
 37static inline struct snd_soc_acpi_mach *
 38snd_soc_acpi_find_machine(struct snd_soc_acpi_mach *machines)
 39{
 40	return NULL;
 41}
 42
 43static inline bool
 44snd_soc_acpi_find_package_from_hid(const u8 hid[ACPI_ID_LEN],
 45				   struct snd_soc_acpi_package_context *ctx)
 46{
 47	return false;
 48}
 49
 50/* check all codecs */
 51static inline struct snd_soc_acpi_mach *snd_soc_acpi_codec_list(void *arg)
 52{
 53	return NULL;
 54}
 55#endif
 56
 57/**
 58 * snd_soc_acpi_mach_params: interface for machine driver configuration
 59 *
 60 * @acpi_ipc_irq_index: used for BYT-CR detection
 61 * @platform: string used for HDaudio codec support
 62 * @codec_mask: used for HDAudio support
 63 * @common_hdmi_codec_drv: use commom HDAudio HDMI codec driver
 64 * @link_mask: links enabled on the board
 65 * @links: array of link _ADR descriptors, null terminated
 66 */
 67struct snd_soc_acpi_mach_params {
 68	u32 acpi_ipc_irq_index;
 69	const char *platform;
 70	u32 codec_mask;
 71	u32 dmic_num;
 72	bool common_hdmi_codec_drv;
 73	u32 link_mask;
 74	const struct snd_soc_acpi_link_adr *links;
 75};
 76
 77/**
 78 * snd_soc_acpi_endpoint - endpoint descriptor
 79 * @num: endpoint number (mandatory, unique per device)
 80 * @aggregated: 0 (independent) or 1 (logically grouped)
 81 * @group_position: zero-based order (only when @aggregated is 1)
 82 * @group_id: platform-unique group identifier (only when @aggregrated is 1)
 83 */
 84struct snd_soc_acpi_endpoint {
 85	u8 num;
 86	u8 aggregated;
 87	u8 group_position;
 88	u8 group_id;
 89};
 90
 91/**
 92 * snd_soc_acpi_adr_device - descriptor for _ADR-enumerated device
 93 * @adr: 64 bit ACPI _ADR value
 94 * @num_endpoints: number of endpoints for this device
 95 * @endpoints: array of endpoints
 96 */
 97struct snd_soc_acpi_adr_device {
 98	const u64 adr;
 99	const u8 num_endpoints;
100	const struct snd_soc_acpi_endpoint *endpoints;
101};
102
103/**
104 * snd_soc_acpi_link_adr - ACPI-based list of _ADR enumerated devices
105 * @mask: one bit set indicates the link this list applies to
106 * @num_adr: ARRAY_SIZE of devices
107 * @adr_d: array of devices
108 *
109 * The number of devices per link can be more than 1, e.g. in SoundWire
110 * multi-drop configurations.
111 */
112
113struct snd_soc_acpi_link_adr {
114	const u32 mask;
115	const u32 num_adr;
116	const struct snd_soc_acpi_adr_device *adr_d;
117};
118
119/**
120 * snd_soc_acpi_mach: ACPI-based machine descriptor. Most of the fields are
121 * related to the hardware, except for the firmware and topology file names.
122 * A platform supported by legacy and Sound Open Firmware (SOF) would expose
123 * all firmware/topology related fields.
124 *
125 * @id: ACPI ID (usually the codec's) used to find a matching machine driver.
126 * @link_mask: describes required board layout, e.g. for SoundWire.
127 * @links: array of link _ADR descriptors, null terminated.
128 * @drv_name: machine driver name
129 * @fw_filename: firmware file name. Used when SOF is not enabled.
130 * @board: board name
131 * @machine_quirk: pointer to quirk, usually based on DMI information when
132 * ACPI ID alone is not sufficient, wrong or misleading
133 * @quirk_data: data used to uniquely identify a machine, usually a list of
134 * audio codecs whose presence if checked with ACPI
135 * @pdata: intended for platform data or machine specific-ops. This structure
136 *  is not constant since this field may be updated at run-time
137 * @sof_fw_filename: Sound Open Firmware file name, if enabled
138 * @sof_tplg_filename: Sound Open Firmware topology file name, if enabled
139 */
140/* Descriptor for SST ASoC machine driver */
141struct snd_soc_acpi_mach {
142	const u8 id[ACPI_ID_LEN];
143	const u32 link_mask;
144	const struct snd_soc_acpi_link_adr *links;
145	const char *drv_name;
146	const char *fw_filename;
147	const char *board;
148	struct snd_soc_acpi_mach * (*machine_quirk)(void *arg);
149	const void *quirk_data;
150	void *pdata;
151	struct snd_soc_acpi_mach_params mach_params;
152	const char *sof_fw_filename;
153	const char *sof_tplg_filename;
154};
155
156#define SND_SOC_ACPI_MAX_CODECS 3
157
158/**
159 * struct snd_soc_acpi_codecs: Structure to hold secondary codec information
160 * apart from the matched one, this data will be passed to the quirk function
161 * to match with the ACPI detected devices
162 *
163 * @num_codecs: number of secondary codecs used in the platform
164 * @codecs: holds the codec IDs
165 *
166 */
167struct snd_soc_acpi_codecs {
168	int num_codecs;
169	u8 codecs[SND_SOC_ACPI_MAX_CODECS][ACPI_ID_LEN];
170};
171
172#endif