aboutsummaryrefslogtreecommitdiff
path: root/Documentation/sound/alsa/soc/DAI.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/sound/alsa/soc/DAI.txt')
-rw-r--r--Documentation/sound/alsa/soc/DAI.txt490
1 files changed, 0 insertions, 490 deletions
diff --git a/Documentation/sound/alsa/soc/DAI.txt b/Documentation/sound/alsa/soc/DAI.txt
index 251545a8869..58cbfd01ea8 100644
--- a/Documentation/sound/alsa/soc/DAI.txt
+++ b/Documentation/sound/alsa/soc/DAI.txt
@@ -54,493 +54,3 @@ Common PCM operating modes:-
o Mode A - MSB is transmitted on falling edge of first BCLK after FRAME/SYNC.
o Mode B - MSB is transmitted on rising edge of FRAME/SYNC.
-
-
-ASoC DAI Configuration
-======================
-
-Every CODEC DAI and SoC DAI must have their capabilities defined in order to
-be configured together at runtime when the audio and clocking parameters are
-known. This is achieved by creating an array of struct snd_soc_hw_mode in the
-the CODEC and SoC interface drivers. Each element in the array describes a DAI
-mode and each mode is usually based upon the DAI system clock to sample rate
-ratio (FS).
-
-i.e. 48k sample rate @ 256 FS = sytem clock of 12.288 MHz
- 48000 * 256 = 12288000
-
-The CPU and Codec DAI modes are then ANDed together at runtime to determine the
-rutime DAI configuration for both the Codec and CPU.
-
-When creating a new codec or SoC DAI it's probably best to start of with a few
-sample rates first and then test your interface.
-
-struct snd_soc_dai_mode is defined (in soc.h) as:-
-
-/* SoC DAI mode */
-struct snd_soc_dai_mode {
- u16 fmt; /* SND_SOC_DAIFMT_* */
- u16 tdm; /* SND_SOC_HWTDM_* */
- u64 pcmfmt; /* SNDRV_PCM_FMTBIT_* */
- u16 pcmrate; /* SND_SOC_HWRATE_* */
- u16 pcmdir:2; /* SND_SOC_HWDIR_* */
- u16 flags:8; /* hw flags */
- u16 fs; /* mclk to rate divider */
- u64 bfs; /* mclk to bclk dividers */
- unsigned long priv; /* private mode data */
-};
-
-fmt:
-----
-This field defines the DAI mode hardware format (e.g. I2S settings) and
-supports the following settings:-
-
- 1) hardware DAI formats
-
-#define SND_SOC_DAIFMT_I2S (1 << 0) /* I2S mode */
-#define SND_SOC_DAIFMT_RIGHT_J (1 << 1) /* Right justified mode */
-#define SND_SOC_DAIFMT_LEFT_J (1 << 2) /* Left Justified mode */
-#define SND_SOC_DAIFMT_DSP_A (1 << 3) /* L data msb after FRM */
-#define SND_SOC_DAIFMT_DSP_B (1 << 4) /* L data msb during FRM */
-#define SND_SOC_DAIFMT_AC97 (1 << 5) /* AC97 */
-
- 2) hw DAI signal inversions
-
-#define SND_SOC_DAIFMT_NB_NF (1 << 8) /* normal bit clock + frame */
-#define SND_SOC_DAIFMT_NB_IF (1 << 9) /* normal bclk + inv frm */
-#define SND_SOC_DAIFMT_IB_NF (1 << 10) /* invert bclk + nor frm */
-#define SND_SOC_DAIFMT_IB_IF (1 << 11) /* invert bclk + frm */
-
- 3) hw 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 (1 << 12) /* codec clk & frm master */
-#define SND_SOC_DAIFMT_CBS_CFM (1 << 13) /* codec clk slave & frm master */
-#define SND_SOC_DAIFMT_CBM_CFS (1 << 14) /* codec clk master & frame slave */
-#define SND_SOC_DAIFMT_CBS_CFS (1 << 15) /* codec clk & frm slave */
-
-At least one option from each section must be selected. Multiple selections are
-also supported e.g.
-
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_LEFT_J | SND_SOC_DAIFMT_RIGHT_J | \
- SND_SOC_DAIFMT_NB_NF | SND_SOC_DAIFMT_NB_IF | SND_SOC_DAIFMT_IB_NF | \
- SND_SOC_DAIFMT_IB_IF
-
-
-tdm:
-------
-This field defines the Time Division Multiplexing left and right word
-positions for the DAI mode if applicable. Set to SND_SOC_DAITDM_LRDW(0,0) for
-no TDM.
-
-
-pcmfmt:
----------
-The hardware PCM format. This describes the PCM formats supported by the DAI
-mode e.g.
-
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE | SNDRV_PCM_FORMAT_S20_3LE | \
- SNDRV_PCM_FORMAT_S24_3LE
-
-pcmrate:
-----------
-The PCM sample rates supported by the DAI mode. e.g.
-
- .pcmrate = SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_11025 | SNDRV_PCM_RATE_16000 | \
- SNDRV_PCM_RATE_22050 | SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | \
- SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 | SNDRV_PCM_RATE_96000
-
-
-pcmdir:
----------
-The stream directions supported by this mode. e.g. playback and capture
-
-
-flags:
---------
-The DAI hardware flags supported by the mode.
-
-/* use bfs mclk divider mode (BCLK = MCLK / x) */
-#define SND_SOC_DAI_BFS_DIV 0x1
-/* use bfs rate mulitplier (BCLK = RATE * x)*/
-#define SND_SOC_DAI_BFS_RATE 0x2
-/* use bfs rcw multiplier (BCLK = RATE * CHN * WORD SIZE) */
-#define SND_SOC_DAI_BFS_RCW 0x4
-/* capture and playback can use different clocks */
-#define SND_SOC_DAI_ASYNC 0x8
-
-NOTE: Bitclock division and mulitiplication modes can be safely matched by the
-core logic.
-
-
-fs:
------
-The FS supported by this DAI mode FS is the ratio between the system clock and
-the sample rate. See above
-
-bfs:
-------
-BFS is the ratio of BCLK to MCLK or the ratio of BCLK to sample rate (this
-depends on the codec or CPU DAI).
-
-The BFS supported by the DAI mode. This can either be the ratio between the
-bitclock (BCLK) and the sample rate OR the ratio between the system clock and
-the sample rate. Depends on the flags above.
-
-priv:
------
-private codec mode data.
-
-
-
-Examples
-========
-
-Note that Codec DAI and CPU DAI examples are interchangeable in these examples
-as long as the bus master is reversed. i.e.
-
- SND_SOC_DAIFMT_CBM_CFM would become SND_SOC_DAIFMT_CBS_CFS
- and vice versa.
-
-This applies to all SND_SOC_DAIFMT_CB*_CF*.
-
-Example 1
----------
-
-Simple codec that only runs at 8k & 48k @ 256FS in master mode, can generate a
-BCLK of either MCLK/2 or MCLK/4.
-
- /* codec master */
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBM_CFM,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmrate = SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_48000,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .flags = SND_SOC_DAI_BFS_DIV,
- .fs = 256,
- .bfs = SND_SOC_FSBD(2) | SND_SOC_FSBD(4),
- }
-
-
-Example 2
----------
-Simple codec that only runs at 8k & 48k @ 256FS in master mode, can generate a
-BCLK of either Rate * 32 or Rate * 64.
-
- /* codec master */
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBM_CFM,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmrate = SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_48000,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .flags = SND_SOC_DAI_BFS_RATE,
- .fs = 256,
- .bfs = 32,
- },
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBM_CFM,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmrate = SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_48000,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .flags = SND_SOC_DAI_BFS_RATE,
- .fs = 256,
- .bfs = 64,
- },
-
-
-Example 3
----------
-Codec that runs at 8k & 48k @ 256FS in master mode, can generate a BCLK that
-is a multiple of Rate * channels * word size. (RCW) i.e.
-
- BCLK = 8000 * 2 * 16 (8k, stereo, 16bit)
- = 256kHz
-
-This codecs supports a RCW multiple of 1,2
-
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBM_CFM,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmrate = SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_48000,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .flags = SND_SOC_DAI_BFS_RCW,
- .fs = 256,
- .bfs = SND_SOC_FSBW(1) | SND_SOC_FSBW(2),
- }
-
-
-Example 4
----------
-Codec that only runs at 8k & 48k @ 256FS in master mode, can generate a
-BCLK of either Rate * 32 or Rate * 64. Codec can also run in slave mode as long
-as BCLK is rate * 32 or rate * 64.
-
- /* codec master */
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBM_CFM,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmrate = SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_48000,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .flags = SND_SOC_DAI_BFS_RATE,
- .fs = 256,
- .bfs = 32,
- },
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBM_CFM,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmrate = SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_48000,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .flags = SND_SOC_DAI_BFS_RATE,
- .fs = 256,
- .bfs = 64,
- },
-
- /* codec slave */
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBS_CFS,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmdir = SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_48000,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .flags = SND_SOC_DAI_BFS_RATE,
- .fs = SND_SOC_FS_ALL,
- .bfs = 32,
- },
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBS_CFS,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmdir = SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_48000,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .flags = SND_SOC_DAI_BFS_RATE,
- .fs = SND_SOC_FS_ALL,
- .bfs = 64,
- },
-
-
-Example 5
----------
-Codec that only runs at 8k, 16k, 32k, 48k, 96k @ 128FS, 192FS & 256FS in master
-mode and can generate a BCLK of MCLK / (1,2,4,8,16). Codec can also run in slave
-mode as and does not care about FS or BCLK (as long as there is enough bandwidth).
-
- #define CODEC_FSB \
- (SND_SOC_FSBD(1) | SND_SOC_FSBD(2) | SND_SOC_FSBD(4) | \
- SND_SOC_FSBD(8) | SND_SOC_FSBD(16))
-
- #define CODEC_RATES \
- (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_32000 |\
- SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_96000)
-
- /* codec master @ 128, 192 & 256 FS */
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBM_CFM,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmrate = CODEC_RATES,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .flags = SND_SOC_DAI_BFS_DIV,
- .fs = 128,
- .bfs = CODEC_FSB,
- },
-
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBM_CFM,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmrate = CODEC_RATES,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .flags = SND_SOC_DAI_BFS_DIV,
- .fs = 192,
- .bfs = CODEC_FSB
- },
-
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBM_CFM,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmrate = CODEC_RATES,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .flags = SND_SOC_DAI_BFS_DIV,
- .fs = 256,
- .bfs = CODEC_FSB,
- },
-
- /* codec slave */
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBS_CFS,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmrate = CODEC_RATES,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .fs = SND_SOC_FS_ALL,
- .bfs = SND_SOC_FSB_ALL,
- },
-
-
-Example 6
----------
-Codec that only runs at 8k, 44.1k, 48k @ different FS in master mode (for use
-with a fixed MCLK) and can generate a BCLK of MCLK / (1,2,4,8,16).
-Codec can also run in slave mode as and does not care about FS or BCLK (as long
-as there is enough bandwidth). Codec can support 16, 24 and 32 bit PCM sample
-sizes.
-
- #define CODEC_FSB \
- (SND_SOC_FSBD(1) | SND_SOC_FSBD(2) | SND_SOC_FSBD(4) | \
- SND_SOC_FSBD(8) | SND_SOC_FSBD(16))
-
- #define CODEC_PCM_FORMATS \
- (SNDRV_PCM_FORMAT_S16_LE | SNDRV_PCM_FORMAT_S20_3LE | \
- SNDRV_PCM_FORMAT_S24_3LE | SNDRV_PCM_FORMAT_S24_LE | SNDRV_PCM_FORMAT_S32_LE)
-
- /* codec master */
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBM_CFM,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmrate = SNDRV_PCM_RATE_8000,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .flags = SND_SOC_DAI_BFS_DIV,
- .fs = 1536,
- .bfs = CODEC_FSB,
- },
-
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBM_CFM,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmrate = SNDRV_PCM_RATE_44100,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .flags = SND_SOC_DAI_BFS_DIV,
- .fs = 272,
- .bfs = CODEC_FSB,
- },
-
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBM_CFM,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmrate = SNDRV_PCM_RATE_48000,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .flags = SND_SOC_DAI_BFS_DIV,
- .fs = 256,
- .bfs = CODEC_FSB,
- },
-
- /* codec slave */
- {
- .fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBS_CFS,
- .pcmfmt = SNDRV_PCM_FORMAT_S16_LE,
- .pcmrate = CODEC_RATES,
- .pcmdir = SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE,
- .fs = SND_SOC_FS_ALL,
- .bfs = SND_SOC_FSB_ALL,
- },
-
-
-Example 7
----------
-AC97 Codec that does not support VRA (i.e only runs at 48k).
-
- #define AC97_DIR \
- (SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE)
-
- #define AC97_PCM_FORMATS \
- (SNDRV_PCM_FORMAT_S16_LE | SNDRV_PCM_FORMAT_S18_3LE | \
- SNDRV_PCM_FORMAT_S20_3LE)
-
- /* AC97 with no VRA */
- {
- .pcmfmt = AC97_PCM_FORMATS,
- .pcmrate = SNDRV_PCM_RATE_48000,
- }
-
-
-Example 8
----------
-
-CPU DAI that supports 8k - 48k @ 256FS and BCLK = MCLK / 4 in master mode.
-Slave mode (CPU DAI is FRAME master) supports 8k - 96k at any FS as long as
-BCLK = 64 * rate. (Intel XScale I2S controller).
-
- #define PXA_I2S_DAIFMT \
- (SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_LEFT_J | SND_SOC_DAIFMT_NB_NF)
-
- #define PXA_I2S_DIR \
- (SND_SOC_DAIDIR_PLAYBACK | SND_SOC_DAIDIR_CAPTURE)
-
- #define PXA_I2S_RATES \
- (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_11025 | SNDRV_PCM_RATE_16000 | \
- SNDRV_PCM_RATE_22050 | SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | \
- SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 | SNDRV_PCM_RATE_96000)
-
- /* priv is divider */
- static struct snd_soc_dai_mode pxa2xx_i2s_modes[] = {
- /* pxa2xx I2S frame and clock master modes */
- {
- .fmt = PXA_I2S_DAIFMT | SND_SOC_DAIFMT_CBS_CFS,
- .pcmfmt = SNDRV_PCM_FMTBIT_S16_LE,
- .pcmrate = SNDRV_PCM_RATE_8000,
- .pcmdir = PXA_I2S_DIR,
- .flags = SND_SOC_DAI_BFS_DIV,
- .fs = 256,
- .bfs = SND_SOC_FSBD(4),
- .priv = 0x48,
- },
- {
- .fmt = PXA_I2S_DAIFMT | SND_SOC_DAIFMT_CBS_CFS,
- .pcmfmt = SNDRV_PCM_FMTBIT_S16_LE,
- .pcmrate = SNDRV_PCM_RATE_11025,
- .pcmdir = PXA_I2S_DIR,
- .flags = SND_SOC_DAI_BFS_DIV,
- .fs = 256,
- .bfs = SND_SOC_FSBD(4),
- .priv = 0x34,
- },
- {
- .fmt = PXA_I2S_DAIFMT | SND_SOC_DAIFMT_CBS_CFS,
- .pcmfmt = SNDRV_PCM_FMTBIT_S16_LE,
- .pcmrate = SNDRV_PCM_RATE_16000,
- .pcmdir = PXA_I2S_DIR,
- .flags = SND_SOC_DAI_BFS_DIV,
- .fs = 256,
- .bfs = SND_SOC_FSBD(4),
- .priv = 0x24,
- },
- {
- .fmt = PXA_I2S_DAIFMT | SND_SOC_DAIFMT_CBS_CFS,
- .pcmfmt = SNDRV_PCM_FMTBIT_S16_LE,
- .pcmrate = SNDRV_PCM_RATE_22050,
- .pcmdir = PXA_I2S_DIR,
- .flags = SND_SOC_DAI_BFS_DIV,
- .fs = 256,
- .bfs = SND_SOC_FSBD(4),
- .priv = 0x1a,
- },
- {
- .fmt = PXA_I2S_DAIFMT | SND_SOC_DAIFMT_CBS_CFS,
- .pcmfmt = SNDRV_PCM_FMTBIT_S16_LE,
- .pcmrate = SNDRV_PCM_RATE_44100,
- .pcmdir = PXA_I2S_DIR,
- .flags = SND_SOC_DAI_BFS_DIV,
- .fs = 256,
- .bfs = SND_SOC_FSBD(4),
- .priv = 0xd,
- },
- {
- .fmt = PXA_I2S_DAIFMT | SND_SOC_DAIFMT_CBS_CFS,
- .pcmfmt = SNDRV_PCM_FMTBIT_S16_LE,
- .pcmrate = SNDRV_PCM_RATE_48000,
- .pcmdir = PXA_I2S_DIR,
- .flags = SND_SOC_DAI_BFS_DIV,
- .fs = 256,
- .bfs = SND_SOC_FSBD(4),
- .priv = 0xc,
- },
-
- /* pxa2xx I2S frame master and clock slave mode */
- {
- .fmt = PXA_I2S_DAIFMT | SND_SOC_DAIFMT_CBM_CFS,
- .pcmfmt = SNDRV_PCM_FMTBIT_S16_LE,
- .pcmrate = PXA_I2S_RATES,
- .pcmdir = PXA_I2S_DIR,
- .fs = SND_SOC_FS_ALL,
- .flags = SND_SOC_DAI_BFS_RATE,
- .bfs = 64,
- .priv = 0x48,
- },
-};