Documentation/devicetree/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 Required properties:
  44
  45   - compatible          : Contains one of entries in the compatible list.
  46
  47   - model               : The user-visible name of this sound complex
  48
  49   - audio-cpu           : The phandle of an CPU DAI controller
  50
  51   - audio-codec         : The phandle of an audio codec
  52
  53 Optional properties:
  54
  55   - audio-asrc          : The phandle of ASRC. It can be absent if there's no
  56                           need to add ASRC support via DPCM.
  57
  58   - audio-routing       : A list of the connections between audio components.
  59                           Each entry is a pair of strings, the first being the
  60                           connection's sink, the second being the connection's
  61                           source. There're a few pre-designed board connectors:
  62                            * Line Out Jack
  63                            * Line In Jack
  64                            * Headphone Jack
  65                            * Mic Jack
  66                            * Ext Spk
  67                            * AMIC (stands for Analog Microphone Jack)
  68                            * DMIC (stands for Digital Microphone Jack)
  69
  70                           Note: The "Mic Jack" and "AMIC" are redundant while
  71                                 coexisting in order to support the old bindings
  72                                 of wm8962 and sgtl5000.
  73
  74   - hp-det-gpio         : The GPIO that detect headphones are plugged in
  75   - mic-det-gpio        : The GPIO that detect microphones are plugged in
  76   - bitclock-master     : Indicates dai-link bit clock master; for details see simple-card.yaml.
  77   - frame-master        : Indicates dai-link frame master; for details see simple-card.yaml.
  78   - dai-format          : audio format, for details see simple-card.yaml.
  79   - frame-inversion     : dai-link uses frame clock inversion, for details see simple-card.yaml.
  80   - bitclock-inversion  : dai-link uses bit clock inversion, for details see simple-card.yaml.
  81
  82 Optional unless SSI is selected as a CPU DAI:
  83
  84   - mux-int-port        : The internal port of the i.MX audio muxer (AUDMUX)
  85
  86   - mux-ext-port        : The external port of the i.MX audio muxer
  87
  88 Example:
  89 sound-cs42888 {
  90         compatible = "fsl,imx-audio-cs42888";
  91         model = "cs42888-audio";
  92         audio-cpu = <&esai>;
  93         audio-asrc = <&asrc>;
  94         audio-codec = <&cs42888>;
  95         audio-routing =
  96                 "Line Out Jack", "AOUT1L",
  97                 "Line Out Jack", "AOUT1R",
  98                 "Line Out Jack", "AOUT2L",
  99                 "Line Out Jack", "AOUT2R",
 100                 "Line Out Jack", "AOUT3L",
 101                 "Line Out Jack", "AOUT3R",
 102                 "Line Out Jack", "AOUT4L",
 103                 "Line Out Jack", "AOUT4R",
 104                 "AIN1L", "Line In Jack",
 105                 "AIN1R", "Line In Jack",
 106                 "AIN2L", "Line In Jack",
 107                 "AIN2R", "Line In Jack";
 108 };