Documentation/devicetree/bindings/sound/st,stm32-sai.txt

   1 STMicroelectronics STM32 Serial Audio Interface (SAI).
   2
   3 The SAI interface (Serial Audio Interface) offers a wide set of audio protocols
   4 as I2S standards, LSB or MSB-justified, PCM/DSP, TDM, and AC'97.
   5 The SAI contains two independent audio sub-blocks. Each sub-block has
   6 its own clock generator and I/O lines controller.
   7
   8 Required properties:
   9   - compatible: Should be "st,stm32f4-sai" or "st,stm32h7-sai"
  10   - reg: Base address and size of SAI common register set.
  11   - clocks: Must contain phandle and clock specifier pairs for each entry
  12         in clock-names.
  13   - clock-names: Must contain "x8k" and "x11k"
  14         "x8k": SAI parent clock for sampling rates multiple of 8kHz.
  15         "x11k": SAI parent clock for sampling rates multiple of 11.025kHz.
  16   - interrupts: cpu DAI interrupt line shared by SAI sub-blocks
  17
  18 Optional properties:
  19   - resets: Reference to a reset controller asserting the SAI
  20
  21 SAI subnodes:
  22 Two subnodes corresponding to SAI sub-block instances A et B can be defined.
  23 Subnode can be omitted for unsused sub-block.
  24
  25 SAI subnodes required properties:
  26   - compatible: Should be "st,stm32-sai-sub-a" or "st,stm32-sai-sub-b"
  27         for SAI sub-block A or B respectively.
  28   - reg: Base address and size of SAI sub-block register set.
  29   - clocks: Must contain one phandle and clock specifier pair
  30         for sai_ck which feeds the internal clock generator.
  31   - clock-names: Must contain "sai_ck".
  32   - dmas: see Documentation/devicetree/bindings/dma/stm32-dma.txt
  33   - dma-names: identifier string for each DMA request line
  34         "tx": if sai sub-block is configured as playback DAI
  35         "rx": if sai sub-block is configured as capture DAI
  36   - pinctrl-names: should contain only value "default"
  37   - pinctrl-0: see Documentation/devicetree/bindings/pinctrl/pinctrl-stm32.txt
  38
  39 The device node should contain one 'port' child node with one child 'endpoint'
  40 node, according to the bindings defined in Documentation/devicetree/bindings/
  41 graph.txt.
  42
  43 Example:
  44 sound_card {
  45         compatible = "audio-graph-card";
  46         dais = <&sai1b_port>;
  47 };
  48
  49 sai1: sai1@40015800 {
  50         compatible = "st,stm32h7-sai";
  51         #address-cells = <1>;
  52         #size-cells = <1>;
  53         ranges = <0 0x40015800 0x400>;
  54         reg = <0x40015800 0x4>;
  55         clocks = <&rcc PLL1_Q>, <&rcc PLL2_P>;
  56         clock-names = "x8k", "x11k";
  57         interrupts = <87>;
  58
  59         sai1a: audio-controller@40015804 {
  60                 compatible = "st,stm32-sai-sub-a";
  61                 reg = <0x4 0x1C>;
  62                 clocks = <&rcc SAI1_CK>;
  63                 clock-names = "sai_ck";
  64                 dmas = <&dmamux1 1 87 0x400 0x0>;
  65                 dma-names = "tx";
  66                 pinctrl-names = "default";
  67                 pinctrl-0 = <&pinctrl_sai1a>;
  68
  69                 sai1b_port: port {
  70                         cpu_endpoint: endpoint {
  71                                 remote-endpoint = <&codec_endpoint>;
  72                                 format = "i2s";
  73                         };
  74                 };
  75         };
  76 };
  77
  78 audio-codec {
  79         codec_port: port {
  80                 codec_endpoint: endpoint {
  81                         remote-endpoint = <&cpu_endpoint>;
  82                 };
  83         };
  84 };