Documentation/powerpc/dts-bindings/fsl/ssi.txt

   1 Freescale Synchronous Serial Interface
   2
   3 The SSI is a serial device that communicates with audio codecs.  It can
   4 be programmed in AC97, I2S, left-justified, or right-justified modes.
   5
   6 Required properties:
   7 - compatible      : compatible list, containing "fsl,ssi"
   8 - cell-index      : the SSI, <0> = SSI1, <1> = SSI2, and so on
   9 - reg             : offset and length of the register set for the device
  10 - interrupts      : <a b> where a is the interrupt number and b is a
  11                      field that represents an encoding of the sense and
  12                     level information for the interrupt.  This should be
  13                     encoded based on the information in section 2)
  14                     depending on the type of interrupt controller you
  15                     have.
  16 - interrupt-parent : the phandle for the interrupt controller that
  17                      services interrupts for this device.
  18 - fsl,mode        : the operating mode for the SSI interface
  19                     "i2s-slave" - I2S mode, SSI is clock slave
  20                     "i2s-master" - I2S mode, SSI is clock master
  21                     "lj-slave" - left-justified mode, SSI is clock slave
  22                     "lj-master" - l.j. mode, SSI is clock master
  23                     "rj-slave" - right-justified mode, SSI is clock slave
  24                     "rj-master" - r.j., SSI is clock master
  25                     "ac97-slave" - AC97 mode, SSI is clock slave
  26                     "ac97-master" - AC97 mode, SSI is clock master
  27 - fsl,playback-dma: phandle to a node for the DMA channel to use for
  28                     playback of audio.  This is typically dictated by SOC
  29                     design.  See the notes below.
  30 - fsl,capture-dma:  phandle to a node for the DMA channel to use for
  31                     capture (recording) of audio.  This is typically dictated
  32                     by SOC design.  See the notes below.
  33
  34 Optional properties:
  35 - codec-handle    : phandle to a 'codec' node that defines an audio
  36                     codec connected to this SSI.  This node is typically
  37                     a child of an I2C or other control node.
  38
  39 Child 'codec' node required properties:
  40 - compatible      : compatible list, contains the name of the codec
  41
  42 Child 'codec' node optional properties:
  43 - clock-frequency  : The frequency of the input clock, which typically
  44                      comes from an on-board dedicated oscillator.
  45
  46 Notes on fsl,playback-dma and fsl,capture-dma:
  47
  48 On SOCs that have an SSI, specific DMA channels are hard-wired for playback
  49 and capture.  On the MPC8610, for example, SSI1 must use DMA channel 0 for
  50 playback and DMA channel 1 for capture.  SSI2 must use DMA channel 2 for
  51 playback and DMA channel 3 for capture.  The developer can choose which
  52 DMA controller to use, but the channels themselves are hard-wired.  The
  53 purpose of these two properties is to represent this hardware design.
  54
  55 The device tree nodes for the DMA channels that are referenced by
  56 "fsl,playback-dma" and "fsl,capture-dma" must be marked as compatible with
  57 "fsl,ssi-dma-channel".  The SOC-specific compatible string (e.g.
  58 "fsl,mpc8610-dma-channel") can remain.  If these nodes are left as
  59 "fsl,elo-dma-channel" or "fsl,eloplus-dma-channel", then the generic Elo DMA
  60 drivers (fsldma) will attempt to use them, and it will conflict with the
  61 sound drivers.