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 #include <linux/mod_devicetable.h> 21 22 struct snd_soc_acpi_package_context { 23 char *name; /* package name */ 24 int length; /* number of elements */ 25 struct acpi_buffer *format; 26 struct acpi_buffer *state; 27 bool data_valid; 28 }; 29 30 /* codec name is used in DAIs is i2c-<HID>:00 with HID being 8 chars */ 31 #define SND_ACPI_I2C_ID_LEN (4 + ACPI_ID_LEN + 3 + 1) 32 33 #if IS_ENABLED(CONFIG_ACPI) 34 bool snd_soc_acpi_find_package_from_hid(const u8 hid[ACPI_ID_LEN], 35 struct snd_soc_acpi_package_context *ctx); 36 #else 37 static inline bool 38 snd_soc_acpi_find_package_from_hid(const u8 hid[ACPI_ID_LEN], 39 struct snd_soc_acpi_package_context *ctx) 40 { 41 return false; 42 } 43 #endif 44 45 /* acpi match */ 46 struct snd_soc_acpi_mach * 47 snd_soc_acpi_find_machine(struct snd_soc_acpi_mach *machines); 48 49 /** 50 * snd_soc_acpi_mach: ACPI-based machine descriptor. Most of the fields are 51 * related to the hardware, except for the firmware and topology file names. 52 * A platform supported by legacy and Sound Open Firmware (SOF) would expose 53 * all firmware/topology related fields. 54 * 55 * @id: ACPI ID (usually the codec's) used to find a matching machine driver. 56 * @drv_name: machine driver name 57 * @fw_filename: firmware file name. Used when SOF is not enabled. 58 * @board: board name 59 * @machine_quirk: pointer to quirk, usually based on DMI information when 60 * ACPI ID alone is not sufficient, wrong or misleading 61 * @quirk_data: data used to uniquely identify a machine, usually a list of 62 * audio codecs whose presence if checked with ACPI 63 * @pdata: intended for platform data or machine specific-ops. This structure 64 * is not constant since this field may be updated at run-time 65 * @sof_fw_filename: Sound Open Firmware file name, if enabled 66 * @sof_tplg_filename: Sound Open Firmware topology file name, if enabled 67 * @asoc_plat_name: ASoC platform name, used for binding machine drivers 68 * if non NULL 69 * @new_mach_data: machine driver private data fixup 70 */ 71 /* Descriptor for SST ASoC machine driver */ 72 struct snd_soc_acpi_mach { 73 const u8 id[ACPI_ID_LEN]; 74 const char *drv_name; 75 const char *fw_filename; 76 const char *board; 77 struct snd_soc_acpi_mach * (*machine_quirk)(void *arg); 78 const void *quirk_data; 79 void *pdata; 80 const char *sof_fw_filename; 81 const char *sof_tplg_filename; 82 const char *asoc_plat_name; 83 struct platform_device * (*new_mach_data)(void *pdata); 84 }; 85 86 #define SND_SOC_ACPI_MAX_CODECS 3 87 88 /** 89 * struct snd_soc_acpi_codecs: Structure to hold secondary codec information 90 * apart from the matched one, this data will be passed to the quirk function 91 * to match with the ACPI detected devices 92 * 93 * @num_codecs: number of secondary codecs used in the platform 94 * @codecs: holds the codec IDs 95 * 96 */ 97 struct snd_soc_acpi_codecs { 98 int num_codecs; 99 u8 codecs[SND_SOC_ACPI_MAX_CODECS][ACPI_ID_LEN]; 100 }; 101 102 /* check all codecs */ 103 struct snd_soc_acpi_mach *snd_soc_acpi_codec_list(void *arg); 104 105 #endif 106