[linux-2.6-block.git] / include / sound / soc-topology.h

/* SPDX-License-Identifier: GPL-2.0
 *
 * linux/sound/soc-topology.h -- ALSA SoC Firmware Controls and DAPM
 *
 * Copyright (C) 2012 Texas Instruments Inc.
 * Copyright (C) 2015 Intel Corporation.
 *
 * Simple file API to load FW that includes mixers, coefficients, DAPM graphs,
 * algorithms, equalisers, DAIs, widgets, FE caps, BE caps, codec link caps etc.
 */

#ifndef __LINUX_SND_SOC_TPLG_H
#define __LINUX_SND_SOC_TPLG_H

#include <sound/asoc.h>
#include <linux/list.h>

struct firmware;
struct snd_kcontrol;
struct snd_soc_tplg_pcm_be;
struct snd_ctl_elem_value;
struct snd_ctl_elem_info;
struct snd_soc_dapm_widget;
struct snd_soc_component;
struct snd_soc_tplg_pcm_fe;
struct snd_soc_dapm_context;
struct snd_soc_card;
struct snd_kcontrol_new;
struct snd_soc_dai_link;
struct snd_soc_dai_driver;
struct snd_soc_dai;
struct snd_soc_dapm_route;

/* object scan be loaded and unloaded in groups with identfying indexes */
#define SND_SOC_TPLG_INDEX_ALL	0	/* ID that matches all FW objects */

/* dynamic object type */
enum snd_soc_dobj_type {
	SND_SOC_DOBJ_NONE		= 0,	/* object is not dynamic */
	SND_SOC_DOBJ_MIXER,
	SND_SOC_DOBJ_ENUM,
	SND_SOC_DOBJ_BYTES,
	SND_SOC_DOBJ_PCM,
	SND_SOC_DOBJ_DAI_LINK,
	SND_SOC_DOBJ_CODEC_LINK,
	SND_SOC_DOBJ_WIDGET,
};

/* dynamic control object */
struct snd_soc_dobj_control {
	struct snd_kcontrol *kcontrol;
	char **dtexts;
	unsigned long *dvalues;
};

/* dynamic widget object */
struct snd_soc_dobj_widget {
	unsigned int kcontrol_type;	/* kcontrol type: mixer, enum, bytes */
};

/* generic dynamic object - all dynamic objects belong to this struct */
struct snd_soc_dobj {
	enum snd_soc_dobj_type type;
	unsigned int index;	/* objects can belong in different groups */
	struct list_head list;
	struct snd_soc_tplg_ops *ops;
	union {
		struct snd_soc_dobj_control control;
		struct snd_soc_dobj_widget widget;
	};
	void *private; /* core does not touch this */
};

/*
 * Kcontrol operations - used to map handlers onto firmware based controls.
 */
struct snd_soc_tplg_kcontrol_ops {
	u32 id;
	int (*get)(struct snd_kcontrol *kcontrol,
			struct snd_ctl_elem_value *ucontrol);
	int (*put)(struct snd_kcontrol *kcontrol,
			struct snd_ctl_elem_value *ucontrol);
	int (*info)(struct snd_kcontrol *kcontrol,
		struct snd_ctl_elem_info *uinfo);
};

/* Bytes ext operations, for TLV byte controls */
struct snd_soc_tplg_bytes_ext_ops {
	u32 id;
	int (*get)(struct snd_kcontrol *kcontrol, unsigned int __user *bytes,
							unsigned int size);
	int (*put)(struct snd_kcontrol *kcontrol,
			const unsigned int __user *bytes, unsigned int size);
};

/*
 * DAPM widget event handlers - used to map handlers onto widgets.
 */
struct snd_soc_tplg_widget_events {
	u16 type;
	int (*event_handler)(struct snd_soc_dapm_widget *w,
			struct snd_kcontrol *k, int event);
};

/*
 * Public API - Used by component drivers to load and unload dynamic objects
 * and their resources.
 */
struct snd_soc_tplg_ops {

	/* external kcontrol init - used for any driver specific init */
	int (*control_load)(struct snd_soc_component *, int index,
		struct snd_kcontrol_new *, struct snd_soc_tplg_ctl_hdr *);
	int (*control_unload)(struct snd_soc_component *,
		struct snd_soc_dobj *);

	/* DAPM graph route element loading and unloading */
	int (*dapm_route_load)(struct snd_soc_component *, int index,
		struct snd_soc_dapm_route *route);
	int (*dapm_route_unload)(struct snd_soc_component *,
		struct snd_soc_dobj *);

	/* external widget init - used for any driver specific init */
	int (*widget_load)(struct snd_soc_component *, int index,
		struct snd_soc_dapm_widget *,
		struct snd_soc_tplg_dapm_widget *);
	int (*widget_ready)(struct snd_soc_component *, int index,
		struct snd_soc_dapm_widget *,
		struct snd_soc_tplg_dapm_widget *);
	int (*widget_unload)(struct snd_soc_component *,
		struct snd_soc_dobj *);

	/* FE DAI - used for any driver specific init */
	int (*dai_load)(struct snd_soc_component *, int index,
		struct snd_soc_dai_driver *dai_drv,
		struct snd_soc_tplg_pcm *pcm, struct snd_soc_dai *dai);

	int (*dai_unload)(struct snd_soc_component *,
		struct snd_soc_dobj *);

	/* DAI link - used for any driver specific init */
	int (*link_load)(struct snd_soc_component *, int index,
		struct snd_soc_dai_link *link,
		struct snd_soc_tplg_link_config *cfg);
	int (*link_unload)(struct snd_soc_component *,
		struct snd_soc_dobj *);

	/* callback to handle vendor bespoke data */
	int (*vendor_load)(struct snd_soc_component *, int index,
		struct snd_soc_tplg_hdr *);
	int (*vendor_unload)(struct snd_soc_component *,
		struct snd_soc_tplg_hdr *);

	/* completion - called at completion of firmware loading */
	void (*complete)(struct snd_soc_component *);

	/* manifest - optional to inform component of manifest */
	int (*manifest)(struct snd_soc_component *, int index,
		struct snd_soc_tplg_manifest *);

	/* vendor specific kcontrol handlers available for binding */
	const struct snd_soc_tplg_kcontrol_ops *io_ops;
	int io_ops_count;

	/* vendor specific bytes ext handlers available for binding */
	const struct snd_soc_tplg_bytes_ext_ops *bytes_ext_ops;
	int bytes_ext_ops_count;
};

#ifdef CONFIG_SND_SOC_TOPOLOGY

/* gets a pointer to data from the firmware block header */
static inline const void *snd_soc_tplg_get_data(struct snd_soc_tplg_hdr *hdr)
{
	const void *ptr = hdr;

	return ptr + sizeof(*hdr);
}

/* Dynamic Object loading and removal for component drivers */
int snd_soc_tplg_component_load(struct snd_soc_component *comp,
	struct snd_soc_tplg_ops *ops, const struct firmware *fw,
	u32 index);
int snd_soc_tplg_component_remove(struct snd_soc_component *comp, u32 index);

/* Widget removal - widgets also removed wth component API */
void snd_soc_tplg_widget_remove(struct snd_soc_dapm_widget *w);
void snd_soc_tplg_widget_remove_all(struct snd_soc_dapm_context *dapm,
	u32 index);

/* Binds event handlers to dynamic widgets */
int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
	const struct snd_soc_tplg_widget_events *events, int num_events,
	u16 event_type);

#else

static inline int snd_soc_tplg_component_remove(struct snd_soc_component *comp,
						u32 index)
{
	return 0;
}

#endif

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