include/sound/soc-acpi.h

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