Documentation/devicetree/bindings/sound/fsl,esai.txt

   1 Freescale Enhanced Serial Audio Interface (ESAI) Controller
   2
   3 The Enhanced Serial Audio Interface (ESAI) provides a full-duplex serial port
   4 for serial communication with a variety of serial devices, including industry
   5 standard codecs, Sony/Phillips Digital Interface (S/PDIF) transceivers, and
   6 other DSPs. It has up to six transmitters and four receivers.
   7
   8 Required properties:
   9
  10   - compatible : Compatible list, must contain "fsl,imx35-esai" or
  11                  "fsl,vf610-esai"
  12
  13   - reg : Offset and length of the register set for the device.
  14
  15   - interrupts : Contains the spdif interrupt.
  16
  17   - dmas : Generic dma devicetree binding as described in
  18   Documentation/devicetree/bindings/dma/dma.txt.
  19
  20   - dma-names : Two dmas have to be defined, "tx" and "rx".
  21
  22   - clocks: Contains an entry for each entry in clock-names.
  23
  24   - clock-names : Includes the following entries:
  25         "core"          The core clock used to access registers
  26         "extal"         The esai baud clock for esai controller used to derive
  27                         HCK, SCK and FS.
  28         "fsys"          The system clock derived from ahb clock used to derive
  29                         HCK, SCK and FS.
  30
  31   - fsl,fifo-depth: The number of elements in the transmit and receive FIFOs.
  32     This number is the maximum allowed value for TFCR[TFWM] or RFCR[RFWM].
  33
  34   - fsl,esai-synchronous: This is a boolean property. If present, indicating
  35     that ESAI would work in the synchronous mode, which means all the settings
  36     for Receiving would be duplicated from Transmition related registers.
  37
  38   - big-endian : If this property is absent, the native endian mode will
  39     be in use as default, or the big endian mode will be in use for all the
  40     device registers.
  41
  42 Example:
  43
  44 esai: esai@02024000 {
  45         compatible = "fsl,imx35-esai";
  46         reg = <0x02024000 0x4000>;
  47         interrupts = <0 51 0x04>;
  48         clocks = <&clks 208>, <&clks 118>, <&clks 208>;
  49         clock-names = "core", "extal", "fsys";
  50         dmas = <&sdma 23 21 0>, <&sdma 24 21 0>;
  51         dma-names = "rx", "tx";
  52         fsl,fifo-depth = <128>;
  53         fsl,esai-synchronous;
  54         big-endian;
  55         status = "disabled";
  56 };