1 /* SPDX-License-Identifier: GPL-2.0 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 13 struct 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 */ 26 struct snd_soc_acpi_mach * 27 snd_soc_acpi_find_machine(struct snd_soc_acpi_mach *machines); 28 29 bool 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 */ 33 struct snd_soc_acpi_mach *snd_soc_acpi_codec_list(void *arg); 34 35 #else 36 /* acpi match */ 37 static inline struct snd_soc_acpi_mach * 38 snd_soc_acpi_find_machine(struct snd_soc_acpi_mach *machines) 39 { 40 return NULL; 41 } 42 43 static inline bool 44 snd_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 */ 51 static 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 */ 67 struct 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_link_adr: ACPI-based list of _ADR, with a variable 79 * number of devices per link 80 * 81 * @mask: one bit set indicates the link this list applies to 82 * @num_adr: ARRAY_SIZE of adr 83 * @adr: array of _ADR (represented as u64). 84 */ 85 86 struct snd_soc_acpi_link_adr { 87 const u32 mask; 88 const u32 num_adr; 89 const u64 *adr; 90 }; 91 92 /** 93 * snd_soc_acpi_mach: ACPI-based machine descriptor. Most of the fields are 94 * related to the hardware, except for the firmware and topology file names. 95 * A platform supported by legacy and Sound Open Firmware (SOF) would expose 96 * all firmware/topology related fields. 97 * 98 * @id: ACPI ID (usually the codec's) used to find a matching machine driver. 99 * @link_mask: describes required board layout, e.g. for SoundWire. 100 * @links: array of link _ADR descriptors, null terminated. 101 * @drv_name: machine driver name 102 * @fw_filename: firmware file name. Used when SOF is not enabled. 103 * @board: board name 104 * @machine_quirk: pointer to quirk, usually based on DMI information when 105 * ACPI ID alone is not sufficient, wrong or misleading 106 * @quirk_data: data used to uniquely identify a machine, usually a list of 107 * audio codecs whose presence if checked with ACPI 108 * @pdata: intended for platform data or machine specific-ops. This structure 109 * is not constant since this field may be updated at run-time 110 * @sof_fw_filename: Sound Open Firmware file name, if enabled 111 * @sof_tplg_filename: Sound Open Firmware topology file name, if enabled 112 */ 113 /* Descriptor for SST ASoC machine driver */ 114 struct snd_soc_acpi_mach { 115 const u8 id[ACPI_ID_LEN]; 116 const u32 link_mask; 117 const struct snd_soc_acpi_link_adr *links; 118 const char *drv_name; 119 const char *fw_filename; 120 const char *board; 121 struct snd_soc_acpi_mach * (*machine_quirk)(void *arg); 122 const void *quirk_data; 123 void *pdata; 124 struct snd_soc_acpi_mach_params mach_params; 125 const char *sof_fw_filename; 126 const char *sof_tplg_filename; 127 }; 128 129 #define SND_SOC_ACPI_MAX_CODECS 3 130 131 /** 132 * struct snd_soc_acpi_codecs: Structure to hold secondary codec information 133 * apart from the matched one, this data will be passed to the quirk function 134 * to match with the ACPI detected devices 135 * 136 * @num_codecs: number of secondary codecs used in the platform 137 * @codecs: holds the codec IDs 138 * 139 */ 140 struct snd_soc_acpi_codecs { 141 int num_codecs; 142 u8 codecs[SND_SOC_ACPI_MAX_CODECS][ACPI_ID_LEN]; 143 }; 144 145 #endif 146