xref: /linux/Documentation/devicetree/bindings/mmc/rockchip-dw-mshc.yaml (revision 0d3b051adbb72ed81956447d0d1e54d5943ee6f5)
1# SPDX-License-Identifier: GPL-2.0
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/mmc/rockchip-dw-mshc.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Rockchip designware mobile storage host controller device tree bindings
8
9description:
10  Rockchip uses the Synopsys designware mobile storage host controller
11  to interface a SoC with storage medium such as eMMC or SD/MMC cards.
12  This file documents the combined properties for the core Synopsys dw mshc
13  controller that are not already included in the synopsys-dw-mshc-common.yaml
14  file and the Rockchip specific extensions.
15
16allOf:
17  - $ref: "synopsys-dw-mshc-common.yaml#"
18
19maintainers:
20  - Heiko Stuebner <heiko@sntech.de>
21
22# Everything else is described in the common file
23properties:
24  compatible:
25    oneOf:
26      # for Rockchip RK2928 and before RK3288
27      - const: rockchip,rk2928-dw-mshc
28      # for Rockchip RK3288
29      - const: rockchip,rk3288-dw-mshc
30      - items:
31          - enum:
32            # for Rockchip PX30
33              - rockchip,px30-dw-mshc
34            # for Rockchip RK3036
35              - rockchip,rk3036-dw-mshc
36            # for Rockchip RK322x
37              - rockchip,rk3228-dw-mshc
38            # for Rockchip RK3308
39              - rockchip,rk3308-dw-mshc
40            # for Rockchip RK3328
41              - rockchip,rk3328-dw-mshc
42            # for Rockchip RK3368
43              - rockchip,rk3368-dw-mshc
44            # for Rockchip RK3399
45              - rockchip,rk3399-dw-mshc
46            # for Rockchip RV1108
47              - rockchip,rv1108-dw-mshc
48          - const: rockchip,rk3288-dw-mshc
49
50  reg:
51    maxItems: 1
52
53  interrupts:
54    maxItems: 1
55
56  clocks:
57    minItems: 2
58    maxItems: 4
59    description:
60      Handle to "biu" and "ciu" clocks for the bus interface unit clock and
61      the card interface unit clock. If "ciu-drive" and "ciu-sample" are
62      specified in clock-names, it should also contain
63      handles to these clocks.
64
65  clock-names:
66    minItems: 2
67    items:
68      - const: biu
69      - const: ciu
70      - const: ciu-drive
71      - const: ciu-sample
72    description:
73      Apart from the clock-names "biu" and "ciu" two more clocks
74      "ciu-drive" and "ciu-sample" are supported. They are used
75      to control the clock phases, "ciu-sample" is required for tuning
76      high speed modes.
77
78  rockchip,default-sample-phase:
79    $ref: /schemas/types.yaml#/definitions/uint32
80    minimum: 0
81    maximum: 360
82    default: 0
83    description:
84      The default phase to set "ciu-sample" at probing,
85      low speeds or in case where all phases work at tuning time.
86      If not specified 0 deg will be used.
87
88  rockchip,desired-num-phases:
89    $ref: /schemas/types.yaml#/definitions/uint32
90    minimum: 0
91    maximum: 360
92    default: 360
93    description:
94      The desired number of times that the host execute tuning when needed.
95      If not specified, the host will do tuning for 360 times,
96      namely tuning for each degree.
97
98required:
99  - compatible
100  - reg
101  - interrupts
102  - clocks
103  - clock-names
104
105unevaluatedProperties: false
106
107examples:
108  - |
109    #include <dt-bindings/clock/rk3288-cru.h>
110    #include <dt-bindings/interrupt-controller/arm-gic.h>
111    #include <dt-bindings/interrupt-controller/irq.h>
112    sdmmc: mmc@ff0c0000 {
113      compatible = "rockchip,rk3288-dw-mshc";
114      reg = <0xff0c0000 0x4000>;
115      interrupts = <GIC_SPI 32 IRQ_TYPE_LEVEL_HIGH>;
116      clocks = <&cru HCLK_SDMMC>, <&cru SCLK_SDMMC>,
117               <&cru SCLK_SDMMC_DRV>, <&cru SCLK_SDMMC_SAMPLE>;
118      clock-names = "biu", "ciu", "ciu-drive", "ciu-sample";
119      resets = <&cru SRST_MMC0>;
120      reset-names = "reset";
121      fifo-depth = <0x100>;
122      max-frequency = <150000000>;
123    };
124
125...
126