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

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

Convert rockchip,rk3128-cru.txt to YAML.

Signed-off-by: Johan Jonker <jbx6244@gmail.com>
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Link: https://lore.kernel.org/r/4e69a06d-7b53-ab48-1e50-2b29ff3a54e6@gmail.com
Signed-off-by: Heiko Stuebner <heiko@sntech.de>

authored by

Johan Jonker and committed by
Heiko Stuebner
f878a26a 2408ab5a

+76 -58
-58
Documentation/devicetree/bindings/clock/rockchip,rk3128-cru.txt
··· 1 - * Rockchip RK3126/RK3128 Clock and Reset Unit 2 - 3 - The RK3126/RK3128 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,rk3126-cru" or "rockchip,rk3128-cru" 10 - "rockchip,rk3126-cru" - controller compatible with RK3126 SoC. 11 - "rockchip,rk3128-cru" - controller compatible with RK3128 SoC. 12 - - reg: physical base address of the controller and length of memory mapped 13 - region. 14 - - #clock-cells: should be 1. 15 - - #reset-cells: should be 1. 16 - 17 - Optional Properties: 18 - 19 - - rockchip,grf: phandle to the syscon managing the "general register files" 20 - If missing pll rates are not changeable, due to the missing pll lock status. 21 - 22 - Each clock is assigned an identifier and client nodes can use this identifier 23 - to specify the clock which they consume. All available clocks are defined as 24 - preprocessor macros in the dt-bindings/clock/rk3128-cru.h headers and can be 25 - used in device tree sources. Similar macros exist for the reset sources in 26 - these files. 27 - 28 - External clocks: 29 - 30 - There are several clocks that are generated outside the SoC. It is expected 31 - that they are defined using standard clock bindings with following 32 - clock-output-names: 33 - - "xin24m" - crystal input - required, 34 - - "ext_i2s" - external I2S clock - optional, 35 - - "gmac_clkin" - external GMAC clock - optional 36 - 37 - Example: Clock controller node: 38 - 39 - cru: cru@20000000 { 40 - compatible = "rockchip,rk3128-cru"; 41 - reg = <0x20000000 0x1000>; 42 - rockchip,grf = <&grf>; 43 - 44 - #clock-cells = <1>; 45 - #reset-cells = <1>; 46 - }; 47 - 48 - Example: UART controller node that consumes the clock generated by the clock 49 - controller: 50 - 51 - uart2: serial@20068000 { 52 - compatible = "rockchip,serial"; 53 - reg = <0x20068000 0x100>; 54 - interrupts = <GIC_SPI 22 IRQ_TYPE_LEVEL_HIGH>; 55 - clock-frequency = <24000000>; 56 - clocks = <&cru SCLK_UART2>, <&cru PCLK_UART2>; 57 - clock-names = "sclk_uart", "pclk_uart"; 58 - };
+76
Documentation/devicetree/bindings/clock/rockchip,rk3128-cru.yaml
··· 1 + # SPDX-License-Identifier: (GPL-2.0+ OR MIT) 2 + %YAML 1.2 3 + --- 4 + $id: http://devicetree.org/schemas/clock/rockchip,rk3128-cru.yaml# 5 + $schema: http://devicetree.org/meta-schemas/core.yaml# 6 + 7 + title: Rockchip RK3126/RK3128 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 RK3126/RK3128 clock controller generates and supplies clock 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/rk3128-cru.h headers and can be 20 + used in device tree sources. Similar macros exist for the reset sources in 21 + these files. 22 + 23 + properties: 24 + compatible: 25 + enum: 26 + - rockchip,rk3126-cru 27 + - rockchip,rk3128-cru 28 + 29 + reg: 30 + maxItems: 1 31 + 32 + "#clock-cells": 33 + const: 1 34 + 35 + "#reset-cells": 36 + const: 1 37 + 38 + clocks: 39 + minItems: 1 40 + maxItems: 3 41 + 42 + clock-names: 43 + minItems: 1 44 + items: 45 + - const: xin24m 46 + - enum: 47 + - ext_i2s 48 + - gmac_clkin 49 + - enum: 50 + - ext_i2s 51 + - gmac_clkin 52 + 53 + rockchip,grf: 54 + $ref: /schemas/types.yaml#/definitions/phandle 55 + description: 56 + Phandle to the syscon managing the "general register files" (GRF), 57 + if missing pll rates are not changeable, due to the missing pll 58 + lock status. 59 + 60 + required: 61 + - compatible 62 + - reg 63 + - "#clock-cells" 64 + - "#reset-cells" 65 + 66 + additionalProperties: false 67 + 68 + examples: 69 + - | 70 + cru: clock-controller@20000000 { 71 + compatible = "rockchip,rk3128-cru"; 72 + reg = <0x20000000 0x1000>; 73 + rockchip,grf = <&grf>; 74 + #clock-cells = <1>; 75 + #reset-cells = <1>; 76 + };