[mirror_ubuntu-bionic-kernel.git] / include / sound / soc-topology.h

/*
 * linux/sound/soc-topology.h -- ALSA SoC Firmware Controls and DAPM
 *
 * Copyright (C) 2012 Texas Instruments Inc.
 * Copyright (C) 2015 Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * 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;

/* 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_enum:1;	/* this widget is an enum kcontrol */
};

/* 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 *,
		struct snd_kcontrol_new *, struct snd_soc_tplg_ctl_hdr *);
	int (*control_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 *,
		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 *,
		struct snd_soc_dai_driver *dai_drv);
	int (*dai_unload)(struct snd_soc_component *,
		struct snd_soc_dobj *);

	/* callback to handle vendor bespoke data */
	int (*vendor_load)(struct snd_soc_component *,
		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 *,
		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
8a978234 LG	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
	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 */
	36	enum 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 */
	48	struct snd_soc_dobj_control {
	49	struct snd_kcontrol *kcontrol;
	50	char **dtexts;
	51	unsigned long *dvalues;
	52	};
	53
	54	/* dynamic widget object */
	55	struct snd_soc_dobj_widget {
	56	unsigned int kcontrol_enum:1; /* this widget is an enum kcontrol */
	57	};
	58
8a978234 LG	59	/* generic dynamic object - all dynamic objects belong to this struct */
	60	struct snd_soc_dobj {
	61	enum snd_soc_dobj_type type;
	62	unsigned int index; /* objects can belong in different groups */
	63	struct list_head list;
	64	struct snd_soc_tplg_ops *ops;
	65	union {
	66	struct snd_soc_dobj_control control;
	67	struct snd_soc_dobj_widget widget;
8a978234 LG	68	};
	69	void private; / core does not touch this */
	70	};
	71
	72	/*
	73	* Kcontrol operations - used to map handlers onto firmware based controls.
	74	*/
	75	struct snd_soc_tplg_kcontrol_ops {
	76	u32 id;
	77	int (get)(struct snd_kcontrol kcontrol,
	78	struct snd_ctl_elem_value *ucontrol);
	79	int (put)(struct snd_kcontrol kcontrol,
	80	struct snd_ctl_elem_value *ucontrol);
	81	int (info)(struct snd_kcontrol kcontrol,
	82	struct snd_ctl_elem_info *uinfo);
	83	};
	84
1a3232d2 ML	85	/* Bytes ext operations, for TLV byte controls */
	86	struct snd_soc_tplg_bytes_ext_ops {
	87	u32 id;
a1e5e7e9 M	88	int (get)(struct snd_kcontrol kcontrol, unsigned int __user *bytes,
	89	unsigned int size);
	90	int (put)(struct snd_kcontrol kcontrol,
	91	const unsigned int __user *bytes, unsigned int size);
1a3232d2 ML	92	};
1a3232d2 ML	93
8a978234 LG	94	/*
	95	* DAPM widget event handlers - used to map handlers onto widgets.
	96	*/
	97	struct snd_soc_tplg_widget_events {
	98	u16 type;
	99	int (event_handler)(struct snd_soc_dapm_widget w,
	100	struct snd_kcontrol *k, int event);
	101	};
	102
	103	/*
	104	* Public API - Used by component drivers to load and unload dynamic objects
	105	* and their resources.
	106	*/
	107	struct snd_soc_tplg_ops {
	108
	109	/* external kcontrol init - used for any driver specific init */
	110	int (control_load)(struct snd_soc_component ,
	111	struct snd_kcontrol_new , struct snd_soc_tplg_ctl_hdr );
	112	int (control_unload)(struct snd_soc_component ,
	113	struct snd_soc_dobj *);
	114
	115	/* external widget init - used for any driver specific init */
	116	int (widget_load)(struct snd_soc_component ,
	117	struct snd_soc_dapm_widget *,
	118	struct snd_soc_tplg_dapm_widget *);
	119	int (widget_unload)(struct snd_soc_component ,
	120	struct snd_soc_dobj *);
	121
64527e8a ML	122	/* FE DAI - used for any driver specific init */
	123	int (dai_load)(struct snd_soc_component ,
	124	struct snd_soc_dai_driver *dai_drv);
	125	int (dai_unload)(struct snd_soc_component ,
8a978234 LG	126	struct snd_soc_dobj *);
	127
	128	/* callback to handle vendor bespoke data */
	129	int (vendor_load)(struct snd_soc_component ,
	130	struct snd_soc_tplg_hdr *);
	131	int (vendor_unload)(struct snd_soc_component ,
	132	struct snd_soc_tplg_hdr *);
	133
	134	/* completion - called at completion of firmware loading */
	135	void (complete)(struct snd_soc_component );
	136
	137	/* manifest - optional to inform component of manifest */
	138	int (manifest)(struct snd_soc_component ,
	139	struct snd_soc_tplg_manifest *);
	140
88a17d8f	141	/* vendor specific kcontrol handlers available for binding */
8a978234 LG	142	const struct snd_soc_tplg_kcontrol_ops *io_ops;
8a978234 LG	143	int io_ops_count;
1a3232d2 ML	144
	145	/* vendor specific bytes ext handlers available for binding */
	146	const struct snd_soc_tplg_bytes_ext_ops *bytes_ext_ops;
	147	int bytes_ext_ops_count;
8a978234 LG	148	};
8a978234 LG	149
78b50f39 MB	150	#ifdef CONFIG_SND_SOC_TOPOLOGY
78b50f39 MB	151
8a978234 LG	152	/* gets a pointer to data from the firmware block header */
	153	static inline const void snd_soc_tplg_get_data(struct snd_soc_tplg_hdr hdr)
	154	{
	155	const void *ptr = hdr;
	156
	157	return ptr + sizeof(*hdr);
	158	}
	159
	160	/* Dynamic Object loading and removal for component drivers */
	161	int snd_soc_tplg_component_load(struct snd_soc_component *comp,
	162	struct snd_soc_tplg_ops ops, const struct firmware fw,
	163	u32 index);
	164	int snd_soc_tplg_component_remove(struct snd_soc_component *comp, u32 index);
	165
	166	/* Widget removal - widgets also removed wth component API */
	167	void snd_soc_tplg_widget_remove(struct snd_soc_dapm_widget *w);
	168	void snd_soc_tplg_widget_remove_all(struct snd_soc_dapm_context *dapm,
	169	u32 index);
	170
	171	/* Binds event handlers to dynamic widgets */
	172	int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
	173	const struct snd_soc_tplg_widget_events *events, int num_events,
	174	u16 event_type);
	175
78b50f39 MB	176	#else
	177
	178	static inline int snd_soc_tplg_component_remove(struct snd_soc_component *comp,
	179	u32 index)
	180	{
	181	return 0;
	182	}
	183
	184	#endif
	185
8a978234	186	#endif