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