Loading...
1/* SPDX-License-Identifier: GPL-2.0
2 *
3 * linux/sound/soc-topology.h -- ALSA SoC Firmware Controls and DAPM
4 *
5 * Copyright (C) 2012 Texas Instruments Inc.
6 * Copyright (C) 2015 Intel Corporation.
7 *
8 * Simple file API to load FW that includes mixers, coefficients, DAPM graphs,
9 * algorithms, equalisers, DAIs, widgets, FE caps, BE caps, codec link caps etc.
10 */
11
12#ifndef __LINUX_SND_SOC_TPLG_H
13#define __LINUX_SND_SOC_TPLG_H
14
15#include <sound/asoc.h>
16#include <linux/list.h>
17
18struct firmware;
19struct snd_kcontrol;
20struct snd_soc_tplg_pcm_be;
21struct snd_ctl_elem_value;
22struct snd_ctl_elem_info;
23struct snd_soc_dapm_widget;
24struct snd_soc_component;
25struct snd_soc_tplg_pcm_fe;
26struct snd_soc_dapm_context;
27struct snd_soc_card;
28struct snd_kcontrol_new;
29struct snd_soc_dai_link;
30struct snd_soc_dai_driver;
31struct snd_soc_dai;
32struct snd_soc_dapm_route;
33
34/* object scan be loaded and unloaded in groups with identfying indexes */
35#define SND_SOC_TPLG_INDEX_ALL 0 /* ID that matches all FW objects */
36
37/* dynamic object type */
38enum snd_soc_dobj_type {
39 SND_SOC_DOBJ_NONE = 0, /* object is not dynamic */
40 SND_SOC_DOBJ_MIXER,
41 SND_SOC_DOBJ_BYTES,
42 SND_SOC_DOBJ_ENUM,
43 SND_SOC_DOBJ_GRAPH,
44 SND_SOC_DOBJ_WIDGET,
45 SND_SOC_DOBJ_DAI_LINK,
46 SND_SOC_DOBJ_PCM,
47 SND_SOC_DOBJ_CODEC_LINK,
48 SND_SOC_DOBJ_BACKEND_LINK,
49};
50
51/* dynamic control object */
52struct snd_soc_dobj_control {
53 struct snd_kcontrol *kcontrol;
54 char **dtexts;
55 unsigned long *dvalues;
56};
57
58/* dynamic widget object */
59struct snd_soc_dobj_widget {
60 unsigned int kcontrol_type; /* kcontrol type: mixer, enum, bytes */
61};
62
63/* generic dynamic object - all dynamic objects belong to this struct */
64struct snd_soc_dobj {
65 enum snd_soc_dobj_type type;
66 unsigned int index; /* objects can belong in different groups */
67 struct list_head list;
68 struct snd_soc_tplg_ops *ops;
69 union {
70 struct snd_soc_dobj_control control;
71 struct snd_soc_dobj_widget widget;
72 };
73 void *private; /* core does not touch this */
74};
75
76/*
77 * Kcontrol operations - used to map handlers onto firmware based controls.
78 */
79struct snd_soc_tplg_kcontrol_ops {
80 u32 id;
81 int (*get)(struct snd_kcontrol *kcontrol,
82 struct snd_ctl_elem_value *ucontrol);
83 int (*put)(struct snd_kcontrol *kcontrol,
84 struct snd_ctl_elem_value *ucontrol);
85 int (*info)(struct snd_kcontrol *kcontrol,
86 struct snd_ctl_elem_info *uinfo);
87};
88
89/* Bytes ext operations, for TLV byte controls */
90struct snd_soc_tplg_bytes_ext_ops {
91 u32 id;
92 int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
93 unsigned int size);
94 int (*put)(struct snd_kcontrol *kcontrol,
95 const unsigned int __user *bytes, unsigned int size);
96};
97
98/*
99 * DAPM widget event handlers - used to map handlers onto widgets.
100 */
101struct snd_soc_tplg_widget_events {
102 u16 type;
103 int (*event_handler)(struct snd_soc_dapm_widget *w,
104 struct snd_kcontrol *k, int event);
105};
106
107/*
108 * Public API - Used by component drivers to load and unload dynamic objects
109 * and their resources.
110 */
111struct snd_soc_tplg_ops {
112
113 /* external kcontrol init - used for any driver specific init */
114 int (*control_load)(struct snd_soc_component *, int index,
115 struct snd_kcontrol_new *, struct snd_soc_tplg_ctl_hdr *);
116 int (*control_unload)(struct snd_soc_component *,
117 struct snd_soc_dobj *);
118
119 /* DAPM graph route element loading and unloading */
120 int (*dapm_route_load)(struct snd_soc_component *, int index,
121 struct snd_soc_dapm_route *route);
122 int (*dapm_route_unload)(struct snd_soc_component *,
123 struct snd_soc_dobj *);
124
125 /* external widget init - used for any driver specific init */
126 int (*widget_load)(struct snd_soc_component *, int index,
127 struct snd_soc_dapm_widget *,
128 struct snd_soc_tplg_dapm_widget *);
129 int (*widget_ready)(struct snd_soc_component *, int index,
130 struct snd_soc_dapm_widget *,
131 struct snd_soc_tplg_dapm_widget *);
132 int (*widget_unload)(struct snd_soc_component *,
133 struct snd_soc_dobj *);
134
135 /* FE DAI - used for any driver specific init */
136 int (*dai_load)(struct snd_soc_component *, int index,
137 struct snd_soc_dai_driver *dai_drv,
138 struct snd_soc_tplg_pcm *pcm, struct snd_soc_dai *dai);
139
140 int (*dai_unload)(struct snd_soc_component *,
141 struct snd_soc_dobj *);
142
143 /* DAI link - used for any driver specific init */
144 int (*link_load)(struct snd_soc_component *, int index,
145 struct snd_soc_dai_link *link,
146 struct snd_soc_tplg_link_config *cfg);
147 int (*link_unload)(struct snd_soc_component *,
148 struct snd_soc_dobj *);
149
150 /* callback to handle vendor bespoke data */
151 int (*vendor_load)(struct snd_soc_component *, int index,
152 struct snd_soc_tplg_hdr *);
153 int (*vendor_unload)(struct snd_soc_component *,
154 struct snd_soc_tplg_hdr *);
155
156 /* completion - called at completion of firmware loading */
157 void (*complete)(struct snd_soc_component *);
158
159 /* manifest - optional to inform component of manifest */
160 int (*manifest)(struct snd_soc_component *, int index,
161 struct snd_soc_tplg_manifest *);
162
163 /* vendor specific kcontrol handlers available for binding */
164 const struct snd_soc_tplg_kcontrol_ops *io_ops;
165 int io_ops_count;
166
167 /* vendor specific bytes ext handlers available for binding */
168 const struct snd_soc_tplg_bytes_ext_ops *bytes_ext_ops;
169 int bytes_ext_ops_count;
170};
171
172#ifdef CONFIG_SND_SOC_TOPOLOGY
173
174/* gets a pointer to data from the firmware block header */
175static inline const void *snd_soc_tplg_get_data(struct snd_soc_tplg_hdr *hdr)
176{
177 const void *ptr = hdr;
178
179 return ptr + sizeof(*hdr);
180}
181
182/* Dynamic Object loading and removal for component drivers */
183int snd_soc_tplg_component_load(struct snd_soc_component *comp,
184 struct snd_soc_tplg_ops *ops, const struct firmware *fw,
185 u32 index);
186int snd_soc_tplg_component_remove(struct snd_soc_component *comp, u32 index);
187
188/* Widget removal - widgets also removed wth component API */
189void snd_soc_tplg_widget_remove(struct snd_soc_dapm_widget *w);
190void snd_soc_tplg_widget_remove_all(struct snd_soc_dapm_context *dapm,
191 u32 index);
192
193/* Binds event handlers to dynamic widgets */
194int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
195 const struct snd_soc_tplg_widget_events *events, int num_events,
196 u16 event_type);
197
198#else
199
200static inline int snd_soc_tplg_component_remove(struct snd_soc_component *comp,
201 u32 index)
202{
203 return 0;
204}
205
206#endif
207
208#endif
1/* SPDX-License-Identifier: GPL-2.0
2 *
3 * linux/sound/soc-topology.h -- ALSA SoC Firmware Controls and DAPM
4 *
5 * Copyright (C) 2012 Texas Instruments Inc.
6 * Copyright (C) 2015 Intel Corporation.
7 *
8 * Simple file API to load FW that includes mixers, coefficients, DAPM graphs,
9 * algorithms, equalisers, DAIs, widgets, FE caps, BE caps, codec link caps etc.
10 */
11
12#ifndef __LINUX_SND_SOC_TPLG_H
13#define __LINUX_SND_SOC_TPLG_H
14
15#include <sound/asoc.h>
16#include <linux/list.h>
17
18struct firmware;
19struct snd_kcontrol;
20struct snd_soc_tplg_pcm_be;
21struct snd_ctl_elem_value;
22struct snd_ctl_elem_info;
23struct snd_soc_dapm_widget;
24struct snd_soc_component;
25struct snd_soc_tplg_pcm_fe;
26struct snd_soc_dapm_context;
27struct snd_soc_card;
28struct snd_kcontrol_new;
29struct snd_soc_dai_link;
30struct snd_soc_dai_driver;
31struct snd_soc_dai;
32struct snd_soc_dapm_route;
33
34/* dynamic object type */
35enum snd_soc_dobj_type {
36 SND_SOC_DOBJ_NONE = 0, /* object is not dynamic */
37 SND_SOC_DOBJ_MIXER,
38 SND_SOC_DOBJ_BYTES,
39 SND_SOC_DOBJ_ENUM,
40 SND_SOC_DOBJ_GRAPH,
41 SND_SOC_DOBJ_WIDGET,
42 SND_SOC_DOBJ_DAI_LINK,
43 SND_SOC_DOBJ_PCM,
44 SND_SOC_DOBJ_CODEC_LINK,
45 SND_SOC_DOBJ_BACKEND_LINK,
46};
47
48/* dynamic control object */
49struct snd_soc_dobj_control {
50 struct snd_kcontrol *kcontrol;
51 char **dtexts;
52 unsigned long *dvalues;
53};
54
55/* dynamic widget object */
56struct snd_soc_dobj_widget {
57 unsigned int *kcontrol_type; /* kcontrol type: mixer, enum, bytes */
58};
59
60/* generic dynamic object - all dynamic objects belong to this struct */
61struct snd_soc_dobj {
62 enum snd_soc_dobj_type type;
63 unsigned int index; /* objects can belong in different groups */
64 struct list_head list;
65 struct snd_soc_tplg_ops *ops;
66 union {
67 struct snd_soc_dobj_control control;
68 struct snd_soc_dobj_widget widget;
69 };
70 void *private; /* core does not touch this */
71};
72
73/*
74 * Kcontrol operations - used to map handlers onto firmware based controls.
75 */
76struct snd_soc_tplg_kcontrol_ops {
77 u32 id;
78 int (*get)(struct snd_kcontrol *kcontrol,
79 struct snd_ctl_elem_value *ucontrol);
80 int (*put)(struct snd_kcontrol *kcontrol,
81 struct snd_ctl_elem_value *ucontrol);
82 int (*info)(struct snd_kcontrol *kcontrol,
83 struct snd_ctl_elem_info *uinfo);
84};
85
86/* Bytes ext operations, for TLV byte controls */
87struct snd_soc_tplg_bytes_ext_ops {
88 u32 id;
89 int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
90 unsigned int size);
91 int (*put)(struct snd_kcontrol *kcontrol,
92 const unsigned int __user *bytes, unsigned int size);
93};
94
95/*
96 * DAPM widget event handlers - used to map handlers onto widgets.
97 */
98struct snd_soc_tplg_widget_events {
99 u16 type;
100 int (*event_handler)(struct snd_soc_dapm_widget *w,
101 struct snd_kcontrol *k, int event);
102};
103
104/*
105 * Public API - Used by component drivers to load and unload dynamic objects
106 * and their resources.
107 */
108struct snd_soc_tplg_ops {
109
110 /* external kcontrol init - used for any driver specific init */
111 int (*control_load)(struct snd_soc_component *, int index,
112 struct snd_kcontrol_new *, struct snd_soc_tplg_ctl_hdr *);
113 int (*control_unload)(struct snd_soc_component *,
114 struct snd_soc_dobj *);
115
116 /* DAPM graph route element loading and unloading */
117 int (*dapm_route_load)(struct snd_soc_component *, int index,
118 struct snd_soc_dapm_route *route);
119 int (*dapm_route_unload)(struct snd_soc_component *,
120 struct snd_soc_dobj *);
121
122 /* external widget init - used for any driver specific init */
123 int (*widget_load)(struct snd_soc_component *, int index,
124 struct snd_soc_dapm_widget *,
125 struct snd_soc_tplg_dapm_widget *);
126 int (*widget_ready)(struct snd_soc_component *, int index,
127 struct snd_soc_dapm_widget *,
128 struct snd_soc_tplg_dapm_widget *);
129 int (*widget_unload)(struct snd_soc_component *,
130 struct snd_soc_dobj *);
131
132 /* FE DAI - used for any driver specific init */
133 int (*dai_load)(struct snd_soc_component *, int index,
134 struct snd_soc_dai_driver *dai_drv,
135 struct snd_soc_tplg_pcm *pcm, struct snd_soc_dai *dai);
136
137 int (*dai_unload)(struct snd_soc_component *,
138 struct snd_soc_dobj *);
139
140 /* DAI link - used for any driver specific init */
141 int (*link_load)(struct snd_soc_component *, int index,
142 struct snd_soc_dai_link *link,
143 struct snd_soc_tplg_link_config *cfg);
144 int (*link_unload)(struct snd_soc_component *,
145 struct snd_soc_dobj *);
146
147 /* callback to handle vendor bespoke data */
148 int (*vendor_load)(struct snd_soc_component *, int index,
149 struct snd_soc_tplg_hdr *);
150 int (*vendor_unload)(struct snd_soc_component *,
151 struct snd_soc_tplg_hdr *);
152
153 /* completion - called at completion of firmware loading */
154 void (*complete)(struct snd_soc_component *);
155
156 /* manifest - optional to inform component of manifest */
157 int (*manifest)(struct snd_soc_component *, int index,
158 struct snd_soc_tplg_manifest *);
159
160 /* vendor specific kcontrol handlers available for binding */
161 const struct snd_soc_tplg_kcontrol_ops *io_ops;
162 int io_ops_count;
163
164 /* vendor specific bytes ext handlers available for binding */
165 const struct snd_soc_tplg_bytes_ext_ops *bytes_ext_ops;
166 int bytes_ext_ops_count;
167};
168
169#ifdef CONFIG_SND_SOC_TOPOLOGY
170
171/* gets a pointer to data from the firmware block header */
172static inline const void *snd_soc_tplg_get_data(struct snd_soc_tplg_hdr *hdr)
173{
174 const void *ptr = hdr;
175
176 return ptr + sizeof(*hdr);
177}
178
179/* Dynamic Object loading and removal for component drivers */
180int snd_soc_tplg_component_load(struct snd_soc_component *comp,
181 struct snd_soc_tplg_ops *ops, const struct firmware *fw);
182int snd_soc_tplg_component_remove(struct snd_soc_component *comp);
183
184/* Binds event handlers to dynamic widgets */
185int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
186 const struct snd_soc_tplg_widget_events *events, int num_events,
187 u16 event_type);
188
189#else
190
191static inline int snd_soc_tplg_component_remove(struct snd_soc_component *comp,
192 u32 index)
193{
194 return 0;
195}
196
197#endif
198
199#endif