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