Documentation/devicetree/bindings/sound/rockchip-i2s.yaml

   1 # SPDX-License-Identifier: GPL-2.0
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/sound/rockchip-i2s.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Rockchip I2S controller
   8
   9 description:
  10   The I2S bus (Inter-IC sound bus) is a serial link for digital
  11   audio data transfer between devices in the system.
  12
  13 maintainers:
  14   - Heiko Stuebner <heiko@sntech.de>
  15
  16 properties:
  17   compatible:
  18     oneOf:
  19       - const: rockchip,rk3066-i2s
  20       - items:
  21           - enum:
  22               - rockchip,px30-i2s
  23               - rockchip,rk3036-i2s
  24               - rockchip,rk3188-i2s
  25               - rockchip,rk3228-i2s
  26               - rockchip,rk3288-i2s
  27               - rockchip,rk3308-i2s
  28               - rockchip,rk3328-i2s
  29               - rockchip,rk3366-i2s
  30               - rockchip,rk3368-i2s
  31               - rockchip,rk3399-i2s
  32           - const: rockchip,rk3066-i2s
  33
  34   reg:
  35     maxItems: 1
  36
  37   interrupts:
  38     maxItems: 1
  39
  40   clocks:
  41     items:
  42       - description: clock for I2S controller
  43       - description: clock for I2S BUS
  44
  45   clock-names:
  46     items:
  47       - const: i2s_clk
  48       - const: i2s_hclk
  49
  50   dmas:
  51     minItems: 1
  52     maxItems: 2
  53
  54   dma-names:
  55     oneOf:
  56       - const: rx
  57       - items:
  58           - const: tx
  59           - const: rx
  60
  61   power-domains:
  62     maxItems: 1
  63
  64   reset-names:
  65     items:
  66       - const: reset-m
  67       - const: reset-h
  68
  69   resets:
  70     maxItems: 2
  71
  72   rockchip,capture-channels:
  73     $ref: /schemas/types.yaml#/definitions/uint32
  74     default: 2
  75     description:
  76       Max capture channels, if not set, 2 channels default.
  77
  78   rockchip,playback-channels:
  79     $ref: /schemas/types.yaml#/definitions/uint32
  80     default: 8
  81     description:
  82       Max playback channels, if not set, 8 channels default.
  83
  84   rockchip,grf:
  85     $ref: /schemas/types.yaml#/definitions/phandle
  86     description:
  87       The phandle of the syscon node for the GRF register.
  88       Required property for controllers which support multi channel
  89       playback/capture.
  90
  91   "#sound-dai-cells":
  92     const: 0
  93
  94 required:
  95   - compatible
  96   - reg
  97   - interrupts
  98   - clocks
  99   - clock-names
 100   - dmas
 101   - dma-names
 102   - "#sound-dai-cells"
 103
 104 additionalProperties: false
 105
 106 examples:
 107   - |
 108     #include <dt-bindings/clock/rk3288-cru.h>
 109     #include <dt-bindings/interrupt-controller/arm-gic.h>
 110     #include <dt-bindings/interrupt-controller/irq.h>
 111     i2s@ff890000 {
 112       compatible = "rockchip,rk3288-i2s", "rockchip,rk3066-i2s";
 113       reg = <0xff890000 0x10000>;
 114       interrupts = <GIC_SPI 85 IRQ_TYPE_LEVEL_HIGH>;
 115       clocks = <&cru SCLK_I2S0>, <&cru HCLK_I2S0>;
 116       clock-names = "i2s_clk", "i2s_hclk";
 117       dmas = <&pdma1 0>, <&pdma1 1>;
 118       dma-names = "tx", "rx";
 119       rockchip,capture-channels = <2>;
 120       rockchip,playback-channels = <8>;
 121       #sound-dai-cells = <0>;
 122     };