blob: 086cd7ff6ddcbb457ee31277baf3fee143f0181d [file] [log] [blame]
Liam Girdwood8a978232015-05-29 19:06:14 +01001/*
2 * linux/sound/soc-topology.h -- ALSA SoC Firmware Controls and DAPM
3 *
4 * Copyright (C) 2012 Texas Instruments Inc.
5 * Copyright (C) 2015 Intel Corporation.
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
10 *
11 * Simple file API to load FW that includes mixers, coefficients, DAPM graphs,
12 * algorithms, equalisers, DAIs, widgets, FE caps, BE caps, codec link caps etc.
13 */
14
15#ifndef __LINUX_SND_SOC_TPLG_H
16#define __LINUX_SND_SOC_TPLG_H
17
18#include <sound/asoc.h>
19#include <linux/list.h>
20
21struct firmware;
22struct snd_kcontrol;
23struct snd_soc_tplg_pcm_be;
24struct snd_ctl_elem_value;
25struct snd_ctl_elem_info;
26struct snd_soc_dapm_widget;
27struct snd_soc_component;
28struct snd_soc_tplg_pcm_fe;
29struct snd_soc_dapm_context;
30struct snd_soc_card;
31
32/* object scan be loaded and unloaded in groups with identfying indexes */
33#define SND_SOC_TPLG_INDEX_ALL 0 /* ID that matches all FW objects */
34
35/* dynamic object type */
36enum snd_soc_dobj_type {
37 SND_SOC_DOBJ_NONE = 0, /* object is not dynamic */
38 SND_SOC_DOBJ_MIXER,
39 SND_SOC_DOBJ_ENUM,
40 SND_SOC_DOBJ_BYTES,
41 SND_SOC_DOBJ_PCM,
42 SND_SOC_DOBJ_DAI_LINK,
43 SND_SOC_DOBJ_CODEC_LINK,
44 SND_SOC_DOBJ_WIDGET,
45};
46
47/* dynamic control object */
48struct snd_soc_dobj_control {
49 struct snd_kcontrol *kcontrol;
50 char **dtexts;
51 unsigned long *dvalues;
52};
53
54/* dynamic widget object */
55struct snd_soc_dobj_widget {
56 unsigned int kcontrol_enum:1; /* this widget is an enum kcontrol */
57};
58
59/* dynamic PCM DAI object */
60struct snd_soc_dobj_pcm_dai {
61 struct snd_soc_tplg_pcm_dai *pd;
62 unsigned int count;
63};
64
65/* generic dynamic object - all dynamic objects belong to this struct */
66struct snd_soc_dobj {
67 enum snd_soc_dobj_type type;
68 unsigned int index; /* objects can belong in different groups */
69 struct list_head list;
70 struct snd_soc_tplg_ops *ops;
71 union {
72 struct snd_soc_dobj_control control;
73 struct snd_soc_dobj_widget widget;
74 struct snd_soc_dobj_pcm_dai pcm_dai;
75 };
76 void *private; /* core does not touch this */
77};
78
79/*
80 * Kcontrol operations - used to map handlers onto firmware based controls.
81 */
82struct snd_soc_tplg_kcontrol_ops {
83 u32 id;
84 int (*get)(struct snd_kcontrol *kcontrol,
85 struct snd_ctl_elem_value *ucontrol);
86 int (*put)(struct snd_kcontrol *kcontrol,
87 struct snd_ctl_elem_value *ucontrol);
88 int (*info)(struct snd_kcontrol *kcontrol,
89 struct snd_ctl_elem_info *uinfo);
90};
91
Mengdong Lin1a3232d2015-08-18 18:12:20 +080092/* Bytes ext operations, for TLV byte controls */
93struct snd_soc_tplg_bytes_ext_ops {
94 u32 id;
95 int (*get)(unsigned int __user *bytes, unsigned int size);
96 int (*put)(const unsigned int __user *bytes, unsigned int size);
97};
98
Liam Girdwood8a978232015-05-29 19:06:14 +010099/*
100 * DAPM widget event handlers - used to map handlers onto widgets.
101 */
102struct snd_soc_tplg_widget_events {
103 u16 type;
104 int (*event_handler)(struct snd_soc_dapm_widget *w,
105 struct snd_kcontrol *k, int event);
106};
107
108/*
109 * Public API - Used by component drivers to load and unload dynamic objects
110 * and their resources.
111 */
112struct snd_soc_tplg_ops {
113
114 /* external kcontrol init - used for any driver specific init */
115 int (*control_load)(struct snd_soc_component *,
116 struct snd_kcontrol_new *, struct snd_soc_tplg_ctl_hdr *);
117 int (*control_unload)(struct snd_soc_component *,
118 struct snd_soc_dobj *);
119
120 /* external widget init - used for any driver specific init */
121 int (*widget_load)(struct snd_soc_component *,
122 struct snd_soc_dapm_widget *,
123 struct snd_soc_tplg_dapm_widget *);
124 int (*widget_unload)(struct snd_soc_component *,
125 struct snd_soc_dobj *);
126
127 /* FE - used for any driver specific init */
128 int (*pcm_dai_load)(struct snd_soc_component *,
129 struct snd_soc_tplg_pcm_dai *pcm_dai, int num_fe);
130 int (*pcm_dai_unload)(struct snd_soc_component *,
131 struct snd_soc_dobj *);
132
133 /* callback to handle vendor bespoke data */
134 int (*vendor_load)(struct snd_soc_component *,
135 struct snd_soc_tplg_hdr *);
136 int (*vendor_unload)(struct snd_soc_component *,
137 struct snd_soc_tplg_hdr *);
138
139 /* completion - called at completion of firmware loading */
140 void (*complete)(struct snd_soc_component *);
141
142 /* manifest - optional to inform component of manifest */
143 int (*manifest)(struct snd_soc_component *,
144 struct snd_soc_tplg_manifest *);
145
Mengdong Lin88a17d82015-08-18 18:11:51 +0800146 /* vendor specific kcontrol handlers available for binding */
Liam Girdwood8a978232015-05-29 19:06:14 +0100147 const struct snd_soc_tplg_kcontrol_ops *io_ops;
148 int io_ops_count;
Mengdong Lin1a3232d2015-08-18 18:12:20 +0800149
150 /* vendor specific bytes ext handlers available for binding */
151 const struct snd_soc_tplg_bytes_ext_ops *bytes_ext_ops;
152 int bytes_ext_ops_count;
Liam Girdwood8a978232015-05-29 19:06:14 +0100153};
154
Mark Brown78b50f32015-08-15 08:24:20 -0700155#ifdef CONFIG_SND_SOC_TOPOLOGY
156
Liam Girdwood8a978232015-05-29 19:06:14 +0100157/* gets a pointer to data from the firmware block header */
158static inline const void *snd_soc_tplg_get_data(struct snd_soc_tplg_hdr *hdr)
159{
160 const void *ptr = hdr;
161
162 return ptr + sizeof(*hdr);
163}
164
165/* Dynamic Object loading and removal for component drivers */
166int snd_soc_tplg_component_load(struct snd_soc_component *comp,
167 struct snd_soc_tplg_ops *ops, const struct firmware *fw,
168 u32 index);
169int snd_soc_tplg_component_remove(struct snd_soc_component *comp, u32 index);
170
171/* Widget removal - widgets also removed wth component API */
172void snd_soc_tplg_widget_remove(struct snd_soc_dapm_widget *w);
173void snd_soc_tplg_widget_remove_all(struct snd_soc_dapm_context *dapm,
174 u32 index);
175
176/* Binds event handlers to dynamic widgets */
177int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
178 const struct snd_soc_tplg_widget_events *events, int num_events,
179 u16 event_type);
180
Mark Brown78b50f32015-08-15 08:24:20 -0700181#else
182
183static inline int snd_soc_tplg_component_remove(struct snd_soc_component *comp,
184 u32 index)
185{
186 return 0;
187}
188
189#endif
190
Liam Girdwood8a978232015-05-29 19:06:14 +0100191#endif