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

/*
 * linux/sound/soc-dai.h -- ALSA SoC Layer
 *
 * Copyright:	2005-2008 Wolfson Microelectronics. PLC.
 *
 * 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.
 *
 * Digital Audio Interface (DAI) API.
 */

#ifndef __LINUX_SND_SOC_DAI_H
#define __LINUX_SND_SOC_DAI_H


#include <linux/list.h>

struct snd_pcm_substream;

/*
 * DAI hardware audio formats.
 *
 * Describes the physical PCM data formating and clocking. Add new formats
 * to the end.
 */
#define SND_SOC_DAIFMT_I2S		0 /* I2S mode */
#define SND_SOC_DAIFMT_RIGHT_J		1 /* Right Justified mode */
#define SND_SOC_DAIFMT_LEFT_J		2 /* Left Justified mode */
#define SND_SOC_DAIFMT_DSP_A		3 /* L data msb after FRM LRC */
#define SND_SOC_DAIFMT_DSP_B		4 /* L data msb during FRM LRC */
#define SND_SOC_DAIFMT_AC97		5 /* AC97 */

/* left and right justified also known as MSB and LSB respectively */
#define SND_SOC_DAIFMT_MSB		SND_SOC_DAIFMT_LEFT_J
#define SND_SOC_DAIFMT_LSB		SND_SOC_DAIFMT_RIGHT_J

/*
 * DAI Clock gating.
 *
 * DAI bit clocks can be be gated (disabled) when not the DAI is not
 * sending or receiving PCM data in a frame. This can be used to save power.
 */
#define SND_SOC_DAIFMT_CONT		(0 << 4) /* continuous clock */
#define SND_SOC_DAIFMT_GATED		(1 << 4) /* clock is gated */

/*
 * DAI hardware signal inversions.
 *
 * Specifies whether the DAI can also support inverted clocks for the specified
 * format.
 */
#define SND_SOC_DAIFMT_NB_NF		(0 << 8) /* normal bit clock + frame */
#define SND_SOC_DAIFMT_NB_IF		(1 << 8) /* normal bclk + inv frm */
#define SND_SOC_DAIFMT_IB_NF		(2 << 8) /* invert bclk + nor frm */
#define SND_SOC_DAIFMT_IB_IF		(3 << 8) /* invert bclk + frm */

/*
 * DAI hardware clock masters.
 *
 * This is wrt the codec, the inverse is true for the interface
 * i.e. if the codec is clk and frm master then the interface is
 * clk and frame slave.
 */
#define SND_SOC_DAIFMT_CBM_CFM		(0 << 12) /* codec clk & frm master */
#define SND_SOC_DAIFMT_CBS_CFM		(1 << 12) /* codec clk slave & frm master */
#define SND_SOC_DAIFMT_CBM_CFS		(2 << 12) /* codec clk master & frame slave */
#define SND_SOC_DAIFMT_CBS_CFS		(3 << 12) /* codec clk & frm slave */

#define SND_SOC_DAIFMT_FORMAT_MASK	0x000f
#define SND_SOC_DAIFMT_CLOCK_MASK	0x00f0
#define SND_SOC_DAIFMT_INV_MASK		0x0f00
#define SND_SOC_DAIFMT_MASTER_MASK	0xf000

/*
 * Master Clock Directions
 */
#define SND_SOC_CLOCK_IN		0
#define SND_SOC_CLOCK_OUT		1

#define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S16_LE |\
                               SNDRV_PCM_FMTBIT_S32_LE)

struct snd_soc_dai_ops;
struct snd_soc_dai;
struct snd_ac97_bus_ops;

/* Digital Audio Interface registration */
int snd_soc_register_dai(struct snd_soc_dai *dai);
void snd_soc_unregister_dai(struct snd_soc_dai *dai);
int snd_soc_register_dais(struct snd_soc_dai *dai, size_t count);
void snd_soc_unregister_dais(struct snd_soc_dai *dai, size_t count);

/* Digital Audio Interface clocking API.*/
int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
	unsigned int freq, int dir);

int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
	int div_id, int div);

int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
	int pll_id, unsigned int freq_in, unsigned int freq_out);

/* Digital Audio interface formatting */
int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);

int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
	unsigned int mask, int slots);

int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);

/* Digital Audio Interface mute */
int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute);

/*
 * Digital Audio Interface.
 *
 * Describes the Digital Audio Interface in terms of it's ALSA, DAI and AC97
 * operations an capabilities. Codec and platfom drivers will register a this
 * structure for every DAI they have.
 *
 * This structure covers the clocking, formating and ALSA operations for each
 * interface a
 */
struct snd_soc_dai_ops {
	/*
	 * DAI clocking configuration, all optional.
	 * Called by soc_card drivers, normally in their hw_params.
	 */
	int (*set_sysclk)(struct snd_soc_dai *dai,
		int clk_id, unsigned int freq, int dir);
	int (*set_pll)(struct snd_soc_dai *dai,
		int pll_id, unsigned int freq_in, unsigned int freq_out);
	int (*set_clkdiv)(struct snd_soc_dai *dai, int div_id, int div);

	/*
	 * DAI format configuration
	 * Called by soc_card drivers, normally in their hw_params.
	 */
	int (*set_fmt)(struct snd_soc_dai *dai, unsigned int fmt);
	int (*set_tdm_slot)(struct snd_soc_dai *dai,
		unsigned int mask, int slots);
	int (*set_tristate)(struct snd_soc_dai *dai, int tristate);

	/*
	 * DAI digital mute - optional.
	 * Called by soc-core to minimise any pops.
	 */
	int (*digital_mute)(struct snd_soc_dai *dai, int mute);

	/*
	 * ALSA PCM audio operations - all optional.
	 * Called by soc-core during audio PCM operations.
	 */
	int (*startup)(struct snd_pcm_substream *,
		struct snd_soc_dai *);
	void (*shutdown)(struct snd_pcm_substream *,
		struct snd_soc_dai *);
	int (*hw_params)(struct snd_pcm_substream *,
		struct snd_pcm_hw_params *, struct snd_soc_dai *);
	int (*hw_free)(struct snd_pcm_substream *,
		struct snd_soc_dai *);
	int (*prepare)(struct snd_pcm_substream *,
		struct snd_soc_dai *);
	int (*trigger)(struct snd_pcm_substream *, int,
		struct snd_soc_dai *);
};

/*
 * Digital Audio Interface runtime data.
 *
 * Holds runtime data for a DAI.
 */
struct snd_soc_dai {
	/* DAI description */
	char *name;
	unsigned int id;
	int ac97_control;

	struct device *dev;

	/* DAI callbacks */
	int (*probe)(struct platform_device *pdev,
		     struct snd_soc_dai *dai);
	void (*remove)(struct platform_device *pdev,
		       struct snd_soc_dai *dai);
	int (*suspend)(struct snd_soc_dai *dai);
	int (*resume)(struct snd_soc_dai *dai);

	/* ops */
	struct snd_soc_dai_ops *ops;

	/* DAI capabilities */
	struct snd_soc_pcm_stream capture;
	struct snd_soc_pcm_stream playback;
	unsigned int symmetric_rates:1;

	/* DAI runtime info */
	struct snd_pcm_runtime *runtime;
	struct snd_soc_codec *codec;
	unsigned int active;
	unsigned char pop_wait:1;
	void *dma_data;

	/* DAI private data */
	void *private_data;

	/* parent codec/platform */
	union {
		struct snd_soc_codec *codec;
		struct snd_soc_platform *platform;
	};

	struct list_head list;
};

#endif
Commit	Line	Data
a47cbe72 MB	1	/*
	2	* linux/sound/soc-dai.h -- ALSA SoC Layer
	3	*
	4	* Copyright: 2005-2008 Wolfson Microelectronics. PLC.
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License version 2 as
	8	* published by the Free Software Foundation.
	9	*
	10	* Digital Audio Interface (DAI) API.
	11	*/
	12
	13	#ifndef __LINUX_SND_SOC_DAI_H
	14	#define __LINUX_SND_SOC_DAI_H
	15
	16
	17	#include <linux/list.h>
	18
	19	struct snd_pcm_substream;
	20
	21	/*
	22	* DAI hardware audio formats.
	23	*
	24	* Describes the physical PCM data formating and clocking. Add new formats
	25	* to the end.
	26	*/
	27	#define SND_SOC_DAIFMT_I2S 0 /* I2S mode */
	28	#define SND_SOC_DAIFMT_RIGHT_J 1 /* Right Justified mode */
	29	#define SND_SOC_DAIFMT_LEFT_J 2 /* Left Justified mode */
	30	#define SND_SOC_DAIFMT_DSP_A 3 /* L data msb after FRM LRC */
	31	#define SND_SOC_DAIFMT_DSP_B 4 /* L data msb during FRM LRC */
	32	#define SND_SOC_DAIFMT_AC97 5 /* AC97 */
	33
	34	/* left and right justified also known as MSB and LSB respectively */
	35	#define SND_SOC_DAIFMT_MSB SND_SOC_DAIFMT_LEFT_J
	36	#define SND_SOC_DAIFMT_LSB SND_SOC_DAIFMT_RIGHT_J
	37
	38	/*
	39	* DAI Clock gating.
	40	*
	41	* DAI bit clocks can be be gated (disabled) when not the DAI is not
	42	* sending or receiving PCM data in a frame. This can be used to save power.
	43	*/
	44	#define SND_SOC_DAIFMT_CONT (0 << 4) /* continuous clock */
	45	#define SND_SOC_DAIFMT_GATED (1 << 4) /* clock is gated */
	46
a47cbe72 MB	47	/*
	48	* DAI hardware signal inversions.
	49	*
	50	* Specifies whether the DAI can also support inverted clocks for the specified
	51	* format.
	52	*/
	53	#define SND_SOC_DAIFMT_NB_NF (0 << 8) /* normal bit clock + frame */
	54	#define SND_SOC_DAIFMT_NB_IF (1 << 8) /* normal bclk + inv frm */
	55	#define SND_SOC_DAIFMT_IB_NF (2 << 8) /* invert bclk + nor frm */
	56	#define SND_SOC_DAIFMT_IB_IF (3 << 8) /* invert bclk + frm */
	57
	58	/*
	59	* DAI hardware clock masters.
	60	*
	61	* This is wrt the codec, the inverse is true for the interface
	62	* i.e. if the codec is clk and frm master then the interface is
	63	* clk and frame slave.
	64	*/
	65	#define SND_SOC_DAIFMT_CBM_CFM (0 << 12) /* codec clk & frm master */
	66	#define SND_SOC_DAIFMT_CBS_CFM (1 << 12) /* codec clk slave & frm master */
	67	#define SND_SOC_DAIFMT_CBM_CFS (2 << 12) /* codec clk master & frame slave */
	68	#define SND_SOC_DAIFMT_CBS_CFS (3 << 12) /* codec clk & frm slave */
	69
	70	#define SND_SOC_DAIFMT_FORMAT_MASK 0x000f
	71	#define SND_SOC_DAIFMT_CLOCK_MASK 0x00f0
	72	#define SND_SOC_DAIFMT_INV_MASK 0x0f00
	73	#define SND_SOC_DAIFMT_MASTER_MASK 0xf000
	74
	75	/*
	76	* Master Clock Directions
	77	*/
	78	#define SND_SOC_CLOCK_IN 0
	79	#define SND_SOC_CLOCK_OUT 1
	80
33f503c9 MB	81	#define SND_SOC_STD_AC97_FMTS (SNDRV_PCM_FMTBIT_S16_LE \|\
	82	SNDRV_PCM_FMTBIT_S32_LE)
	83
a47cbe72 MB	84	struct snd_soc_dai_ops;
	85	struct snd_soc_dai;
	86	struct snd_ac97_bus_ops;
	87
9115171a MB	88	/* Digital Audio Interface registration */
	89	int snd_soc_register_dai(struct snd_soc_dai *dai);
	90	void snd_soc_unregister_dai(struct snd_soc_dai *dai);
	91	int snd_soc_register_dais(struct snd_soc_dai *dai, size_t count);
	92	void snd_soc_unregister_dais(struct snd_soc_dai *dai, size_t count);
	93
a47cbe72 MB	94	/* Digital Audio Interface clocking API.*/
	95	int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
	96	unsigned int freq, int dir);
	97
	98	int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
	99	int div_id, int div);
	100
	101	int snd_soc_dai_set_pll(struct snd_soc_dai *dai,
	102	int pll_id, unsigned int freq_in, unsigned int freq_out);
	103
	104	/* Digital Audio interface formatting */
	105	int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt);
	106
	107	int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
	108	unsigned int mask, int slots);
	109
	110	int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate);
	111
	112	/* Digital Audio Interface mute */
	113	int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute);
	114
	115	/*
	116	* Digital Audio Interface.
	117	*
	118	* Describes the Digital Audio Interface in terms of it's ALSA, DAI and AC97
	119	* operations an capabilities. Codec and platfom drivers will register a this
	120	* structure for every DAI they have.
	121	*
	122	* This structure covers the clocking, formating and ALSA operations for each
	123	* interface a
	124	*/
	125	struct snd_soc_dai_ops {
	126	/*
	127	* DAI clocking configuration, all optional.
	128	* Called by soc_card drivers, normally in their hw_params.
	129	*/
	130	int (set_sysclk)(struct snd_soc_dai dai,
	131	int clk_id, unsigned int freq, int dir);
	132	int (set_pll)(struct snd_soc_dai dai,
	133	int pll_id, unsigned int freq_in, unsigned int freq_out);
	134	int (set_clkdiv)(struct snd_soc_dai dai, int div_id, int div);
	135
	136	/*
	137	* DAI format configuration
	138	* Called by soc_card drivers, normally in their hw_params.
	139	*/
	140	int (set_fmt)(struct snd_soc_dai dai, unsigned int fmt);
	141	int (set_tdm_slot)(struct snd_soc_dai dai,
	142	unsigned int mask, int slots);
	143	int (set_tristate)(struct snd_soc_dai dai, int tristate);
	144
	145	/*
	146	* DAI digital mute - optional.
	147	* Called by soc-core to minimise any pops.
	148	*/
	149	int (digital_mute)(struct snd_soc_dai dai, int mute);
dee89c4d MB	150
	151	/*
	152	* ALSA PCM audio operations - all optional.
	153	* Called by soc-core during audio PCM operations.
	154	*/
	155	int (startup)(struct snd_pcm_substream ,
	156	struct snd_soc_dai *);
	157	void (shutdown)(struct snd_pcm_substream ,
	158	struct snd_soc_dai *);
	159	int (hw_params)(struct snd_pcm_substream ,
	160	struct snd_pcm_hw_params , struct snd_soc_dai );
	161	int (hw_free)(struct snd_pcm_substream ,
	162	struct snd_soc_dai *);
	163	int (prepare)(struct snd_pcm_substream ,
	164	struct snd_soc_dai *);
	165	int (trigger)(struct snd_pcm_substream , int,
	166	struct snd_soc_dai *);
a47cbe72 MB	167	};
	168
	169	/*
	170	* Digital Audio Interface runtime data.
	171	*
	172	* Holds runtime data for a DAI.
	173	*/
	174	struct snd_soc_dai {
	175	/* DAI description */
	176	char *name;
	177	unsigned int id;
3ba9e10a	178	int ac97_control;
a47cbe72	179
9115171a MB	180	struct device *dev;
9115171a MB	181
a47cbe72 MB	182	/* DAI callbacks */
	183	int (probe)(struct platform_device pdev,
	184	struct snd_soc_dai *dai);
	185	void (remove)(struct platform_device pdev,
	186	struct snd_soc_dai *dai);
dc7d7b83 MB	187	int (suspend)(struct snd_soc_dai dai);
dc7d7b83 MB	188	int (resume)(struct snd_soc_dai dai);
a47cbe72 MB	189
a47cbe72 MB	190	/* ops */
6335d055	191	struct snd_soc_dai_ops *ops;
a47cbe72 MB	192
	193	/* DAI capabilities */
	194	struct snd_soc_pcm_stream capture;
	195	struct snd_soc_pcm_stream playback;
06f409d7	196	unsigned int symmetric_rates:1;
a47cbe72 MB	197
	198	/* DAI runtime info */
	199	struct snd_pcm_runtime *runtime;
	200	struct snd_soc_codec *codec;
	201	unsigned int active;
	202	unsigned char pop_wait:1;
	203	void *dma_data;
	204
	205	/* DAI private data */
	206	void *private_data;
	207
	208	/* parent codec/platform */
	209	union {
	210	struct snd_soc_codec *codec;
	211	struct snd_soc_platform *platform;
	212	};
	213
	214	struct list_head list;
	215	};
	216
	217	#endif