Merge branch 'linus' into core/generic-dma-coherent
[pandora-kernel.git] / 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
28 Optional properties:
29 - codec-handle    : phandle to a 'codec' node that defines an audio
30                     codec connected to this SSI.  This node is typically
31                     a child of an I2C or other control node.
32
33 Child 'codec' node required properties:
34 - compatible      : compatible list, contains the name of the codec
35
36 Child 'codec' node optional properties:
37 - clock-frequency  : The frequency of the input clock, which typically
38                      comes from an on-board dedicated oscillator.