Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

dt-bindings: clock: convert rockchip,rk3036-cru.txt to YAML

Convert rockchip,rk3036-cru.txt to YAML.

Changes against original bindings:
Add clocks and clock-names because the device has to have
at least one input clock.

Signed-off-by: Johan Jonker <jbx6244@gmail.com>
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Link: https://lore.kernel.org/r/20220330114847.18633-1-jbx6244@gmail.com
Signed-off-by: Heiko Stuebner <heiko@sntech.de>

authored by

Johan Jonker and committed by
Heiko Stuebner
de55d163 d87642d7

+72 -56
-56
Documentation/devicetree/bindings/clock/rockchip,rk3036-cru.txt
··· 1 - * Rockchip RK3036 Clock and Reset Unit 2 - 3 - The RK3036 clock controller generates and supplies clock to various 4 - controllers within the SoC and also implements a reset controller for SoC 5 - peripherals. 6 - 7 - Required Properties: 8 - 9 - - compatible: should be "rockchip,rk3036-cru" 10 - - reg: physical base address of the controller and length of memory mapped 11 - region. 12 - - #clock-cells: should be 1. 13 - - #reset-cells: should be 1. 14 - 15 - Optional Properties: 16 - 17 - - rockchip,grf: phandle to the syscon managing the "general register files" 18 - If missing pll rates are not changeable, due to the missing pll lock status. 19 - 20 - Each clock is assigned an identifier and client nodes can use this identifier 21 - to specify the clock which they consume. All available clocks are defined as 22 - preprocessor macros in the dt-bindings/clock/rk3036-cru.h headers and can be 23 - used in device tree sources. Similar macros exist for the reset sources in 24 - these files. 25 - 26 - External clocks: 27 - 28 - There are several clocks that are generated outside the SoC. It is expected 29 - that they are defined using standard clock bindings with following 30 - clock-output-names: 31 - - "xin24m" - crystal input - required, 32 - - "ext_i2s" - external I2S clock - optional, 33 - - "rmii_clkin" - external EMAC clock - optional 34 - 35 - Example: Clock controller node: 36 - 37 - cru: cru@20000000 { 38 - compatible = "rockchip,rk3036-cru"; 39 - reg = <0x20000000 0x1000>; 40 - rockchip,grf = <&grf>; 41 - 42 - #clock-cells = <1>; 43 - #reset-cells = <1>; 44 - }; 45 - 46 - Example: UART controller node that consumes the clock generated by the clock 47 - controller: 48 - 49 - uart0: serial@20060000 { 50 - compatible = "snps,dw-apb-uart"; 51 - reg = <0x20060000 0x100>; 52 - interrupts = <GIC_SPI 20 IRQ_TYPE_LEVEL_HIGH>; 53 - reg-shift = <2>; 54 - reg-io-width = <4>; 55 - clocks = <&cru SCLK_UART0>; 56 - };
+72
Documentation/devicetree/bindings/clock/rockchip,rk3036-cru.yaml
··· 1 + # SPDX-License-Identifier: GPL-2.0 2 + %YAML 1.2 3 + --- 4 + $id: http://devicetree.org/schemas/clock/rockchip,rk3036-cru.yaml# 5 + $schema: http://devicetree.org/meta-schemas/core.yaml# 6 + 7 + title: Rockchip RK3036 Clock and Reset Unit (CRU) 8 + 9 + maintainers: 10 + - Elaine Zhang <zhangqing@rock-chips.com> 11 + - Heiko Stuebner <heiko@sntech.de> 12 + 13 + description: | 14 + The RK3036 clock controller generates and supplies clocks to various 15 + controllers within the SoC and also implements a reset controller for SoC 16 + peripherals. 17 + Each clock is assigned an identifier and client nodes can use this identifier 18 + to specify the clock which they consume. All available clocks are defined as 19 + preprocessor macros in the dt-bindings/clock/rk3036-cru.h headers and can be 20 + used in device tree sources. Similar macros exist for the reset sources in 21 + these files. 22 + There are several clocks that are generated outside the SoC. It is expected 23 + that they are defined using standard clock bindings with following 24 + clock-output-names: 25 + - "xin24m" - crystal input - required 26 + - "ext_i2s" - external I2S clock - optional 27 + - "rmii_clkin" - external EMAC clock - optional 28 + 29 + properties: 30 + compatible: 31 + enum: 32 + - rockchip,rk3036-cru 33 + 34 + reg: 35 + maxItems: 1 36 + 37 + "#clock-cells": 38 + const: 1 39 + 40 + "#reset-cells": 41 + const: 1 42 + 43 + clocks: 44 + maxItems: 1 45 + 46 + clock-names: 47 + const: xin24m 48 + 49 + rockchip,grf: 50 + $ref: /schemas/types.yaml#/definitions/phandle 51 + description: 52 + Phandle to the syscon managing the "general register files" (GRF), 53 + if missing pll rates are not changeable, due to the missing pll 54 + lock status. 55 + 56 + required: 57 + - compatible 58 + - reg 59 + - "#clock-cells" 60 + - "#reset-cells" 61 + 62 + additionalProperties: false 63 + 64 + examples: 65 + - | 66 + cru: clock-controller@20000000 { 67 + compatible = "rockchip,rk3036-cru"; 68 + reg = <0x20000000 0x1000>; 69 + rockchip,grf = <&grf>; 70 + #clock-cells = <1>; 71 + #reset-cells = <1>; 72 + };