Bindings/sound/fsl-asoc-card.txt

   1 Freescale Generic ASoC Sound Card with ASRC support
   2
   3 The Freescale Generic ASoC Sound Card can be used, ideally, for all Freescale
   4 SoCs connecting with external CODECs.
   5
   6 The idea of this generic sound card is a bit like ASoC Simple Card. However,
   7 for Freescale SoCs (especially those released in recent years), most of them
   8 have ASRC (Documentation/devicetree/bindings/sound/fsl,asrc.txt) inside. And
   9 this is a specific feature that might be painstakingly controlled and merged
  10 into the Simple Card.
  11
  12 So having this generic sound card allows all Freescale SoC users to benefit
  13 from the simplification of a new card support and the capability of the wide
  14 sample rates support through ASRC.
  15
  16 Note: The card is initially designed for those sound cards who use AC'97, I2S
  17       and PCM DAI formats. However, it'll be also possible to support those non
  18       AC'97/I2S/PCM type sound cards, such as S/PDIF audio and HDMI audio, as
  19       long as the driver has been properly upgraded.
  20
  21
  22 The compatible list for this generic sound card currently:
  23  "fsl,imx-audio-ac97"
  24
  25  "fsl,imx-audio-cs42888"
  26
  27  "fsl,imx-audio-cs427x"
  28  (compatible with CS4271 and CS4272)
  29
  30  "fsl,imx-audio-wm8962"
  31
  32  "fsl,imx-audio-sgtl5000"
  33  (compatible with Documentation/devicetree/bindings/sound/imx-audio-sgtl5000.txt)
  34
  35  "fsl,imx-audio-wm8960"
  36
  37  "fsl,imx-audio-mqs"
  38
  39  "fsl,imx-audio-wm8524"
  40
  41  "fsl,imx-audio-tlv320aic32x4"
  42
  43  "fsl,imx-audio-tlv320aic31xx"
  44
  45  "fsl,imx-audio-si476x"
  46
  47  "fsl,imx-audio-wm8958"
  48
  49  "fsl,imx-audio-nau8822"
  50
  51 Required properties:
  52
  53   - compatible          : Contains one of entries in the compatible list.
  54
  55   - model               : The user-visible name of this sound complex
  56
  57   - audio-cpu           : The phandle of an CPU DAI controller
  58
  59   - audio-codec         : The phandle of an audio codec
  60
  61 Optional properties:
  62
  63   - audio-asrc          : The phandle of ASRC. It can be absent if there's no
  64                           need to add ASRC support via DPCM.
  65
  66   - audio-routing       : A list of the connections between audio components.
  67                           Each entry is a pair of strings, the first being the
  68                           connection's sink, the second being the connection's
  69                           source. There're a few pre-designed board connectors:
  70                            * Line Out Jack
  71                            * Line In Jack
  72                            * Headphone Jack
  73                            * Mic Jack
  74                            * Ext Spk
  75                            * AMIC (stands for Analog Microphone Jack)
  76                            * DMIC (stands for Digital Microphone Jack)
  77
  78                           Note: The "Mic Jack" and "AMIC" are redundant while
  79                                 coexisting in order to support the old bindings
  80                                 of wm8962 and sgtl5000.
  81
  82   - hp-det-gpio         : The GPIO that detect headphones are plugged in
  83   - mic-det-gpio        : The GPIO that detect microphones are plugged in
  84   - bitclock-master     : Indicates dai-link bit clock master; for details see simple-card.yaml.
  85   - frame-master        : Indicates dai-link frame master; for details see simple-card.yaml.
  86   - dai-format          : audio format, for details see simple-card.yaml.
  87   - frame-inversion     : dai-link uses frame clock inversion, for details see simple-card.yaml.
  88   - bitclock-inversion  : dai-link uses bit clock inversion, for details see simple-card.yaml.
  89   - mclk-id             : main clock id, specific for each card configuration.
  90
  91 Optional unless SSI is selected as a CPU DAI:
  92
  93   - mux-int-port        : The internal port of the i.MX audio muxer (AUDMUX)
  94
  95   - mux-ext-port        : The external port of the i.MX audio muxer
  96
  97 Example:
  98 sound-cs42888 {
  99         compatible = "fsl,imx-audio-cs42888";
 100         model = "cs42888-audio";
 101         audio-cpu = <&esai>;
 102         audio-asrc = <&asrc>;
 103         audio-codec = <&cs42888>;
 104         audio-routing =
 105                 "Line Out Jack", "AOUT1L",
 106                 "Line Out Jack", "AOUT1R",
 107                 "Line Out Jack", "AOUT2L",
 108                 "Line Out Jack", "AOUT2R",
 109                 "Line Out Jack", "AOUT3L",
 110                 "Line Out Jack", "AOUT3R",
 111                 "Line Out Jack", "AOUT4L",
 112                 "Line Out Jack", "AOUT4R",
 113                 "AIN1L", "Line In Jack",
 114                 "AIN1R", "Line In Jack",
 115                 "AIN2L", "Line In Jack",
 116                 "AIN2R", "Line In Jack";
 117 };