xref: /openbmc/linux/include/sound/soc-acpi.h (revision 0d5ea120)
1 /*
2  * Copyright (C) 2013-15, Intel Corporation. All rights reserved.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License version
6  * 2 as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11  * GNU General Public License for more details.
12  *
13  */
14 
15 #ifndef __LINUX_SND_SOC_ACPI_H
16 #define __LINUX_SND_SOC_ACPI_H
17 
18 #include <linux/stddef.h>
19 #include <linux/acpi.h>
20 
21 struct snd_soc_acpi_package_context {
22 	char *name;           /* package name */
23 	int length;           /* number of elements */
24 	struct acpi_buffer *format;
25 	struct acpi_buffer *state;
26 	bool data_valid;
27 };
28 
29 #if IS_ENABLED(CONFIG_ACPI)
30 /* translation fron HID to I2C name, needed for DAI codec_name */
31 const char *snd_soc_acpi_find_name_from_hid(const u8 hid[ACPI_ID_LEN]);
32 bool snd_soc_acpi_find_package_from_hid(const u8 hid[ACPI_ID_LEN],
33 				    struct snd_soc_acpi_package_context *ctx);
34 #else
35 static inline const char *
36 snd_soc_acpi_find_name_from_hid(const u8 hid[ACPI_ID_LEN])
37 {
38 	return NULL;
39 }
40 static inline bool
41 snd_soc_acpi_find_package_from_hid(const u8 hid[ACPI_ID_LEN],
42 				   struct snd_soc_acpi_package_context *ctx)
43 {
44 	return false;
45 }
46 #endif
47 
48 /* acpi match */
49 struct snd_soc_acpi_mach *
50 snd_soc_acpi_find_machine(struct snd_soc_acpi_mach *machines);
51 
52 /**
53  * snd_soc_acpi_mach: ACPI-based machine descriptor. Most of the fields are
54  * related to the hardware, except for the firmware and topology file names.
55  * A platform supported by legacy and Sound Open Firmware (SOF) would expose
56  * all firmware/topology related fields.
57  *
58  * @id: ACPI ID (usually the codec's) used to find a matching machine driver.
59  * @drv_name: machine driver name
60  * @fw_filename: firmware file name. Used when SOF is not enabled.
61  * @board: board name
62  * @machine_quirk: pointer to quirk, usually based on DMI information when
63  * ACPI ID alone is not sufficient, wrong or misleading
64  * @quirk_data: data used to uniquely identify a machine, usually a list of
65  * audio codecs whose presence if checked with ACPI
66  * @pdata: intended for platform data or machine specific-ops. This structure
67  *  is not constant since this field may be updated at run-time
68  * @sof_fw_filename: Sound Open Firmware file name, if enabled
69  * @sof_tplg_filename: Sound Open Firmware topology file name, if enabled
70  * @asoc_plat_name: ASoC platform name, used for binding machine drivers
71  * if non NULL
72  * @new_mach_data: machine driver private data fixup
73  */
74 /* Descriptor for SST ASoC machine driver */
75 struct snd_soc_acpi_mach {
76 	const u8 id[ACPI_ID_LEN];
77 	const char *drv_name;
78 	const char *fw_filename;
79 	const char *board;
80 	struct snd_soc_acpi_mach * (*machine_quirk)(void *arg);
81 	const void *quirk_data;
82 	void *pdata;
83 	const char *sof_fw_filename;
84 	const char *sof_tplg_filename;
85 	const char *asoc_plat_name;
86 	struct platform_device * (*new_mach_data)(void *pdata);
87 };
88 
89 #define SND_SOC_ACPI_MAX_CODECS 3
90 
91 /**
92  * struct snd_soc_acpi_codecs: Structure to hold secondary codec information
93  * apart from the matched one, this data will be passed to the quirk function
94  * to match with the ACPI detected devices
95  *
96  * @num_codecs: number of secondary codecs used in the platform
97  * @codecs: holds the codec IDs
98  *
99  */
100 struct snd_soc_acpi_codecs {
101 	int num_codecs;
102 	u8 codecs[SND_SOC_ACPI_MAX_CODECS][ACPI_ID_LEN];
103 };
104 
105 /* check all codecs */
106 struct snd_soc_acpi_mach *snd_soc_acpi_codec_list(void *arg);
107 
108 #endif
109