[mirror_ubuntu-hirsute-kernel.git] / Documentation / sound / alsa / soc / machine.txt

ASoC Machine Driver
===================

The ASoC machine (or board) driver is the code that glues together the platform
and codec drivers.

The machine driver can contain codec and platform specific code. It registers
the audio subsystem with the kernel as a platform device and is represented by
the following struct:-

/* SoC machine */
struct snd_soc_card {
	char *name;

	int (*probe)(struct platform_device *pdev);
	int (*remove)(struct platform_device *pdev);

	/* the pre and post PM functions are used to do any PM work before and
	 * after the codec and DAIs do any PM work. */
	int (*suspend_pre)(struct platform_device *pdev, pm_message_t state);
	int (*suspend_post)(struct platform_device *pdev, pm_message_t state);
	int (*resume_pre)(struct platform_device *pdev);
	int (*resume_post)(struct platform_device *pdev);

	/* machine stream operations */
	struct snd_soc_ops *ops;

	/* CPU <--> Codec DAI links  */
	struct snd_soc_dai_link *dai_link;
	int num_links;
};

probe()/remove()
----------------
probe/remove are optional. Do any machine specific probe here.


suspend()/resume()
------------------
The machine driver has pre and post versions of suspend and resume to take care
of any machine audio tasks that have to be done before or after the codec, DAIs
and DMA is suspended and resumed. Optional.


Machine operations
------------------
The machine specific audio operations can be set here. Again this is optional.


Machine DAI Configuration
-------------------------
The machine DAI configuration glues all the codec and CPU DAIs together. It can
also be used to set up the DAI system clock and for any machine related DAI
initialisation e.g. the machine audio map can be connected to the codec audio
map, unconnected codec pins can be set as such. Please see corgi.c, spitz.c
for examples.

struct snd_soc_dai_link is used to set up each DAI in your machine. e.g.

/* corgi digital audio interface glue - connects codec <--> CPU */
static struct snd_soc_dai_link corgi_dai = {
	.name = "WM8731",
	.stream_name = "WM8731",
	.cpu_dai = &pxa_i2s_dai,
	.codec_dai = &wm8731_dai,
	.init = corgi_wm8731_init,
	.ops = &corgi_ops,
};

struct snd_soc_card then sets up the machine with its DAIs. e.g.

/* corgi audio machine driver */
static struct snd_soc_card snd_soc_corgi = {
	.name = "Corgi",
	.dai_link = &corgi_dai,
	.num_links = 1,
};


Machine Audio Subsystem
-----------------------

The machine soc device glues the platform, machine and codec driver together.
Private data can also be set here. e.g.

/* corgi audio private data */
static struct wm8731_setup_data corgi_wm8731_setup = {
	.i2c_address = 0x1b,
};

/* corgi audio subsystem */
static struct snd_soc_device corgi_snd_devdata = {
	.machine = &snd_soc_corgi,
	.platform = &pxa2xx_soc_platform,
	.codec_dev = &soc_codec_dev_wm8731,
	.codec_data = &corgi_wm8731_setup,
};


Machine Power Map
-----------------

The machine driver can optionally extend the codec power map and to become an
audio power map of the audio subsystem. This allows for automatic power up/down
of speaker/HP amplifiers, etc. Codec pins can be connected to the machines jack
sockets in the machine init function. See soc/pxa/spitz.c and dapm.txt for
details.


Machine Controls
----------------

Machine specific audio mixer controls can be added in the DAI init function.
Commit	Line	Data
eb1a6af3 LG	1	ASoC Machine Driver
	2	===================
	3
	4	The ASoC machine (or board) driver is the code that glues together the platform
	5	and codec drivers.
	6
	7	The machine driver can contain codec and platform specific code. It registers
	8	the audio subsystem with the kernel as a platform device and is represented by
	9	the following struct:-
	10
	11	/* SoC machine */
4f904735	12	struct snd_soc_card {
eb1a6af3 LG	13	char *name;
	14
	15	int (probe)(struct platform_device pdev);
	16	int (remove)(struct platform_device pdev);
	17
	18	/* the pre and post PM functions are used to do any PM work before and
7c4dbbd8	19	* after the codec and DAIs do any PM work. */
eb1a6af3 LG	20	int (suspend_pre)(struct platform_device pdev, pm_message_t state);
	21	int (suspend_post)(struct platform_device pdev, pm_message_t state);
	22	int (resume_pre)(struct platform_device pdev);
	23	int (resume_post)(struct platform_device pdev);
	24
	25	/* machine stream operations */
	26	struct snd_soc_ops *ops;
	27
	28	/* CPU <--> Codec DAI links */
	29	struct snd_soc_dai_link *dai_link;
	30	int num_links;
	31	};
	32
	33	probe()/remove()
	34	----------------
	35	probe/remove are optional. Do any machine specific probe here.
	36
	37
	38	suspend()/resume()
	39	------------------
	40	The machine driver has pre and post versions of suspend and resume to take care
7c4dbbd8	41	of any machine audio tasks that have to be done before or after the codec, DAIs
eb1a6af3 LG	42	and DMA is suspended and resumed. Optional.
	43
	44
	45	Machine operations
	46	------------------
	47	The machine specific audio operations can be set here. Again this is optional.
	48
	49
	50	Machine DAI Configuration
	51	-------------------------
7c4dbbd8	52	The machine DAI configuration glues all the codec and CPU DAIs together. It can
eb1a6af3 LG	53	also be used to set up the DAI system clock and for any machine related DAI
eb1a6af3 LG	54	initialisation e.g. the machine audio map can be connected to the codec audio
7c4dbbd8	55	map, unconnected codec pins can be set as such. Please see corgi.c, spitz.c
eb1a6af3 LG	56	for examples.
	57
	58	struct snd_soc_dai_link is used to set up each DAI in your machine. e.g.
	59
	60	/* corgi digital audio interface glue - connects codec <--> CPU */
	61	static struct snd_soc_dai_link corgi_dai = {
	62	.name = "WM8731",
	63	.stream_name = "WM8731",
	64	.cpu_dai = &pxa_i2s_dai,
	65	.codec_dai = &wm8731_dai,
	66	.init = corgi_wm8731_init,
10b98527	67	.ops = &corgi_ops,
eb1a6af3 LG	68	};
eb1a6af3 LG	69
a33f3224	70	struct snd_soc_card then sets up the machine with its DAIs. e.g.
eb1a6af3 LG	71
eb1a6af3 LG	72	/* corgi audio machine driver */
87506549	73	static struct snd_soc_card snd_soc_corgi = {
eb1a6af3 LG	74	.name = "Corgi",
	75	.dai_link = &corgi_dai,
	76	.num_links = 1,
eb1a6af3 LG	77	};
	78
	79
	80	Machine Audio Subsystem
	81	-----------------------
	82
	83	The machine soc device glues the platform, machine and codec driver together.
	84	Private data can also be set here. e.g.
	85
	86	/* corgi audio private data */
	87	static struct wm8731_setup_data corgi_wm8731_setup = {
	88	.i2c_address = 0x1b,
	89	};
	90
	91	/* corgi audio subsystem */
	92	static struct snd_soc_device corgi_snd_devdata = {
87506549	93	.machine = &snd_soc_corgi,
eb1a6af3 LG	94	.platform = &pxa2xx_soc_platform,
	95	.codec_dev = &soc_codec_dev_wm8731,
	96	.codec_data = &corgi_wm8731_setup,
	97	};
	98
	99
	100	Machine Power Map
	101	-----------------
	102
	103	The machine driver can optionally extend the codec power map and to become an
	104	audio power map of the audio subsystem. This allows for automatic power up/down
	105	of speaker/HP amplifiers, etc. Codec pins can be connected to the machines jack
	106	sockets in the machine init function. See soc/pxa/spitz.c and dapm.txt for
	107	details.
	108
	109
	110	Machine Controls
	111	----------------
	112
7c4dbbd8	113	Machine specific audio mixer controls can be added in the DAI init function.