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

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

Convert RK3328 clock controller bindings to DT schema

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

Signed-off-by: Johan Jonker <jbx6244@gmail.com>
Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
[add Krzysztof's review from v1, shorten commit description]
Link: https://lore.kernel.org/r/20240930215001.1999212-2-heiko@sntech.de
Signed-off-by: Heiko Stuebner <heiko@sntech.de>

authored by

Johan Jonker and committed by
Heiko Stuebner
5011cc7a 9852d85e

+74 -58
-58
Documentation/devicetree/bindings/clock/rockchip,rk3328-cru.txt
··· 1 - * Rockchip RK3328 Clock and Reset Unit 2 - 3 - The RK3328 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,rk3328-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/rk3328-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 - - "clkin_i2s" - external I2S clock - optional, 33 - - "gmac_clkin" - external GMAC clock - optional 34 - - "phy_50m_out" - output clock of the pll in the mac phy 35 - - "hdmi_phy" - output clock of the hdmi phy pll - optional 36 - 37 - Example: Clock controller node: 38 - 39 - cru: clock-controller@ff440000 { 40 - compatible = "rockchip,rk3328-cru"; 41 - reg = <0x0 0xff440000 0x0 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 - uart0: serial@ff120000 { 52 - compatible = "snps,dw-apb-uart"; 53 - reg = <0xff120000 0x100>; 54 - interrupts = <GIC_SPI 56 IRQ_TYPE_LEVEL_HIGH>; 55 - reg-shift = <2>; 56 - reg-io-width = <4>; 57 - clocks = <&cru SCLK_UART0>; 58 - };
+74
Documentation/devicetree/bindings/clock/rockchip,rk3328-cru.yaml
··· 1 + # SPDX-License-Identifier: GPL-2.0 2 + %YAML 1.2 3 + --- 4 + $id: http://devicetree.org/schemas/clock/rockchip,rk3328-cru.yaml# 5 + $schema: http://devicetree.org/meta-schemas/core.yaml# 6 + 7 + title: Rockchip RK3328 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 RK3328 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/rk3328-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 + - "clkin_i2s" - external I2S clock - optional, 27 + - "gmac_clkin" - external GMAC clock - optional 28 + - "phy_50m_out" - output clock of the pll in the mac phy 29 + - "hdmi_phy" - output clock of the hdmi phy pll - optional 30 + 31 + properties: 32 + compatible: 33 + enum: 34 + - rockchip,rk3328-cru 35 + 36 + reg: 37 + maxItems: 1 38 + 39 + "#clock-cells": 40 + const: 1 41 + 42 + "#reset-cells": 43 + const: 1 44 + 45 + clocks: 46 + maxItems: 1 47 + 48 + clock-names: 49 + const: xin24m 50 + 51 + rockchip,grf: 52 + $ref: /schemas/types.yaml#/definitions/phandle 53 + description: 54 + Phandle to the syscon managing the "general register files" (GRF), 55 + if missing pll rates are not changeable, due to the missing pll 56 + lock status. 57 + 58 + required: 59 + - compatible 60 + - reg 61 + - "#clock-cells" 62 + - "#reset-cells" 63 + 64 + additionalProperties: false 65 + 66 + examples: 67 + - | 68 + cru: clock-controller@ff440000 { 69 + compatible = "rockchip,rk3328-cru"; 70 + reg = <0xff440000 0x1000>; 71 + rockchip,grf = <&grf>; 72 + #clock-cells = <1>; 73 + #reset-cells = <1>; 74 + };