1 /* 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 21 struct firmware; 22 struct snd_kcontrol; 23 struct snd_soc_tplg_pcm_be; 24 struct snd_ctl_elem_value; 25 struct snd_ctl_elem_info; 26 struct snd_soc_dapm_widget; 27 struct snd_soc_component; 28 struct snd_soc_tplg_pcm_fe; 29 struct snd_soc_dapm_context; 30 struct snd_soc_card; 31 struct snd_kcontrol_new; 32 struct snd_soc_dai_link; 33 struct snd_soc_dai_driver; 34 struct snd_soc_dai; 35 36 /* object scan be loaded and unloaded in groups with identfying indexes */ 37 #define SND_SOC_TPLG_INDEX_ALL 0 /* ID that matches all FW objects */ 38 39 /* dynamic object type */ 40 enum snd_soc_dobj_type { 41 SND_SOC_DOBJ_NONE = 0, /* object is not dynamic */ 42 SND_SOC_DOBJ_MIXER, 43 SND_SOC_DOBJ_ENUM, 44 SND_SOC_DOBJ_BYTES, 45 SND_SOC_DOBJ_PCM, 46 SND_SOC_DOBJ_DAI_LINK, 47 SND_SOC_DOBJ_CODEC_LINK, 48 SND_SOC_DOBJ_WIDGET, 49 }; 50 51 /* dynamic control object */ 52 struct snd_soc_dobj_control { 53 struct snd_kcontrol *kcontrol; 54 char **dtexts; 55 unsigned long *dvalues; 56 }; 57 58 /* dynamic widget object */ 59 struct 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 */ 64 struct 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 */ 79 struct 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 */ 90 struct 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 */ 101 struct 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 */ 111 struct 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 /* external widget init - used for any driver specific init */ 120 int (*widget_load)(struct snd_soc_component *, int index, 121 struct snd_soc_dapm_widget *, 122 struct snd_soc_tplg_dapm_widget *); 123 int (*widget_ready)(struct snd_soc_component *, int index, 124 struct snd_soc_dapm_widget *, 125 struct snd_soc_tplg_dapm_widget *); 126 int (*widget_unload)(struct snd_soc_component *, 127 struct snd_soc_dobj *); 128 129 /* FE DAI - used for any driver specific init */ 130 int (*dai_load)(struct snd_soc_component *, int index, 131 struct snd_soc_dai_driver *dai_drv, 132 struct snd_soc_tplg_pcm *pcm, struct snd_soc_dai *dai); 133 134 int (*dai_unload)(struct snd_soc_component *, 135 struct snd_soc_dobj *); 136 137 /* DAI link - used for any driver specific init */ 138 int (*link_load)(struct snd_soc_component *, int index, 139 struct snd_soc_dai_link *link, 140 struct snd_soc_tplg_link_config *cfg); 141 int (*link_unload)(struct snd_soc_component *, 142 struct snd_soc_dobj *); 143 144 /* callback to handle vendor bespoke data */ 145 int (*vendor_load)(struct snd_soc_component *, int index, 146 struct snd_soc_tplg_hdr *); 147 int (*vendor_unload)(struct snd_soc_component *, 148 struct snd_soc_tplg_hdr *); 149 150 /* completion - called at completion of firmware loading */ 151 void (*complete)(struct snd_soc_component *); 152 153 /* manifest - optional to inform component of manifest */ 154 int (*manifest)(struct snd_soc_component *, int index, 155 struct snd_soc_tplg_manifest *); 156 157 /* vendor specific kcontrol handlers available for binding */ 158 const struct snd_soc_tplg_kcontrol_ops *io_ops; 159 int io_ops_count; 160 161 /* vendor specific bytes ext handlers available for binding */ 162 const struct snd_soc_tplg_bytes_ext_ops *bytes_ext_ops; 163 int bytes_ext_ops_count; 164 }; 165 166 #ifdef CONFIG_SND_SOC_TOPOLOGY 167 168 /* gets a pointer to data from the firmware block header */ 169 static inline const void *snd_soc_tplg_get_data(struct snd_soc_tplg_hdr *hdr) 170 { 171 const void *ptr = hdr; 172 173 return ptr + sizeof(*hdr); 174 } 175 176 /* Dynamic Object loading and removal for component drivers */ 177 int snd_soc_tplg_component_load(struct snd_soc_component *comp, 178 struct snd_soc_tplg_ops *ops, const struct firmware *fw, 179 u32 index); 180 int snd_soc_tplg_component_remove(struct snd_soc_component *comp, u32 index); 181 182 /* Widget removal - widgets also removed wth component API */ 183 void snd_soc_tplg_widget_remove(struct snd_soc_dapm_widget *w); 184 void snd_soc_tplg_widget_remove_all(struct snd_soc_dapm_context *dapm, 185 u32 index); 186 187 /* Binds event handlers to dynamic widgets */ 188 int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w, 189 const struct snd_soc_tplg_widget_events *events, int num_events, 190 u16 event_type); 191 192 #else 193 194 static inline int snd_soc_tplg_component_remove(struct snd_soc_component *comp, 195 u32 index) 196 { 197 return 0; 198 } 199 200 #endif 201 202 #endif 203