ssi.txt 4.1 KB

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