Commit 6974ae5a authored by GyoungBo Min's avatar GyoungBo Min Committed by Krzysztof Kozlowski
Browse files

dt-bindings: clock: Add ARTPEC-9 clock controller 



Add dt-schema for Axis ARTPEC-9 SoC clock controller.

The Clock Management Unit (CMU) has a top-level block CMU_CMU
which generates clocks for other blocks.

Add device-tree binding definitions for following CMU blocks:
- CMU_CMU
- CMU_BUS
- CMU_CORE
- CMU_CPUCL
- CMU_FSYS0
- CMU_FSYS1
- CMU_IMEM
- CMU_PERI

Signed-off-by: default avatarGyoungBo Min <mingyoungbo@coasia.com>
Reviewed-by: default avatarKyunghwan Kim <kenkim@coasia.com>
Signed-off-by: default avatarRavi Patel <ravi.patel@samsung.com>
Reviewed-by: default avatarRob Herring (Arm) <robh@kernel.org>
Link: https://patch.msgid.link/20251029130731.51305-2-ravi.patel@samsung.com


Signed-off-by: default avatarKrzysztof Kozlowski <krzk@kernel.org>
parent 6de23f81

Documentation/devicetree/bindings/clock/axis,artpec9-clock.yaml

0 → 100644
+232 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/clock/axis,artpec9-clock.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Axis ARTPEC-9 SoC clock controller



maintainers:

  - Jesper Nilsson <jesper.nilsson@axis.com>



description: |

  ARTPEC-9 clock controller is comprised of several CMU (Clock Management Unit)

  units, generating clocks for different domains. Those CMU units are modeled

  as separate device tree nodes, and might depend on each other.

  The root clock in that root tree is an external clock: OSCCLK (25 MHz).

  This external clock must be defined as a fixed-rate clock in dts.



  CMU_CMU is a top-level CMU, where all base clocks are prepared using PLLs and

  dividers, all other clocks of function blocks (other CMUs) are usually

  derived from CMU_CMU.



  Each clock is assigned an identifier and client nodes can use this identifier

  to specify the clock which they consume. All clocks available for usage

  in clock consumer nodes are defined as preprocessor macros in

  'include/dt-bindings/clock/axis,artpec9-clk.h' header.



properties:

  compatible:

    enum:

      - axis,artpec9-cmu-cmu

      - axis,artpec9-cmu-bus

      - axis,artpec9-cmu-core

      - axis,artpec9-cmu-cpucl

      - axis,artpec9-cmu-fsys0

      - axis,artpec9-cmu-fsys1

      - axis,artpec9-cmu-imem

      - axis,artpec9-cmu-peri



  reg:

    maxItems: 1



  clocks:

    minItems: 1

    maxItems: 5



  clock-names:

    minItems: 1

    maxItems: 5



  "#clock-cells":

    const: 1



required:

  - compatible

  - reg

  - clocks

  - clock-names

  - "#clock-cells"



allOf:

  - if:

      properties:

        compatible:

          const: axis,artpec9-cmu-cmu



    then:

      properties:

        clocks:

          items:

            - description: External reference clock (25 MHz)



        clock-names:

          items:

            - const: fin_pll



  - if:

      properties:

        compatible:

          const: axis,artpec9-cmu-bus



    then:

      properties:

        clocks:

          items:

            - description: External reference clock (25 MHz)

            - description: CMU_BUS bus clock (from CMU_CMU)



        clock-names:

          items:

            - const: fin_pll

            - const: bus



  - if:

      properties:

        compatible:

          const: axis,artpec9-cmu-core



    then:

      properties:

        clocks:

          items:

            - description: External reference clock (25 MHz)

            - description: CMU_CORE main clock (from CMU_CMU)



        clock-names:

          items:

            - const: fin_pll

            - const: main



  - if:

      properties:

        compatible:

          const: axis,artpec9-cmu-cpucl



    then:

      properties:

        clocks:

          items:

            - description: External reference clock (25 MHz)

            - description: CMU_CPUCL switch clock (from CMU_CMU)



        clock-names:

          items:

            - const: fin_pll

            - const: switch



  - if:

      properties:

        compatible:

          const: axis,artpec9-cmu-fsys0



    then:

      properties:

        clocks:

          items:

            - description: External reference clock (25 MHz)

            - description: CMU_FSYS0 bus clock (from CMU_CMU)

            - description: CMU_FSYS0 IP clock (from CMU_CMU)



        clock-names:

          items:

            - const: fin_pll

            - const: bus

            - const: ip



  - if:

      properties:

        compatible:

          const: axis,artpec9-cmu-fsys1



    then:

      properties:

        clocks:

          items:

            - description: External reference clock (25 MHz)

            - description: CMU_FSYS1 scan0 clock (from CMU_CMU)

            - description: CMU_FSYS1 scan1 clock (from CMU_CMU)

            - description: CMU_FSYS1 bus clock (from CMU_CMU)



        clock-names:

          items:

            - const: fin_pll

            - const: scan0

            - const: scan1

            - const: bus



  - if:

      properties:

        compatible:

          const: axis,artpec9-cmu-imem



    then:

      properties:

        clocks:

          items:

            - description: External reference clock (25 MHz)

            - description: CMU_IMEM ACLK clock (from CMU_CMU)

            - description: CMU_IMEM CA5 clock (from CMU_CMU)

            - description: CMU_IMEM JPEG clock (from CMU_CMU)

            - description: CMU_IMEM SSS clock (from CMU_CMU)



        clock-names:

          items:

            - const: fin_pll

            - const: aclk

            - const: ca5

            - const: jpeg

            - const: sss



  - if:

      properties:

        compatible:

          const: axis,artpec9-cmu-peri



    then:

      properties:

        clocks:

          items:

            - description: External reference clock (25 MHz)

            - description: CMU_PERI IP clock (from CMU_CMU)

            - description: CMU_PERI DISP clock (from CMU_CMU)



        clock-names:

          items:

            - const: fin_pll

            - const: ip

            - const: disp



additionalProperties: false



examples:

  # Clock controller node for CMU_FSYS1

  - |

    #include <dt-bindings/clock/axis,artpec9-clk.h>



    soc {

        #address-cells = <2>;

        #size-cells = <2>;



        cmu_fsys1: clock-controller@14c10000 {

            compatible = "axis,artpec9-cmu-fsys1";

            reg = <0x0 0x14c10000 0x0 0x4000>;

            #clock-cells = <1>;

            clocks = <&fin_pll>,

                     <&cmu_cmu CLK_DOUT_CMU_FSYS1_SCAN0>,

                     <&cmu_cmu CLK_DOUT_CMU_FSYS1_SCAN1>,

                     <&cmu_cmu CLK_DOUT_CMU_FSYS1_BUS>;

            clock-names = "fin_pll", "scan0", "scan1", "bus";

        };

    };

...

include/dt-bindings/clock/axis,artpec9-clk.h

0 → 100644
+195 −0
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */

/*

 * Copyright (c) 2025 Samsung Electronics Co., Ltd.

 *             https://www.samsung.com

 * Copyright (c) 2025  Axis Communications AB.

 *             https://www.axis.com

 *

 * Device Tree binding constants for ARTPEC-9 clock controller.

 */



#ifndef _DT_BINDINGS_CLOCK_ARTPEC9_H

#define _DT_BINDINGS_CLOCK_ARTPEC9_H



/* CMU_CMU */

#define CLK_FOUT_SHARED0_PLL						1

#define CLK_DOUT_SHARED0_DIV2						2

#define CLK_DOUT_SHARED0_DIV3						3

#define CLK_DOUT_SHARED0_DIV4						4

#define CLK_FOUT_SHARED1_PLL						5

#define CLK_DOUT_SHARED1_DIV2						6

#define CLK_DOUT_SHARED1_DIV3						7

#define CLK_DOUT_SHARED1_DIV4						8

#define CLK_FOUT_AUDIO_PLL						9

#define CLK_DOUT_CMU_ADD						10

#define CLK_DOUT_CMU_BUS						11

#define CLK_DOUT_CMU_CDC_CORE						12

#define CLK_DOUT_CMU_CORE_MAIN						13

#define CLK_DOUT_CMU_CPUCL_SWITCH					14

#define CLK_DOUT_CMU_DLP_CORE						15

#define CLK_DOUT_CMU_FSYS0_BUS						16

#define CLK_DOUT_CMU_FSYS0_IP						17

#define CLK_DOUT_CMU_FSYS1_BUS						18

#define CLK_DOUT_CMU_FSYS1_SCAN0					19

#define CLK_DOUT_CMU_FSYS1_SCAN1					20

#define CLK_DOUT_CMU_GPU_3D						21

#define CLK_DOUT_CMU_GPU_2D						22

#define CLK_DOUT_CMU_IMEM_ACLK						23

#define CLK_DOUT_CMU_IMEM_CA5						24

#define CLK_DOUT_CMU_IMEM_JPEG						25

#define CLK_DOUT_CMU_IMEM_SSS						26

#define CLK_DOUT_CMU_IPA_CORE						27

#define CLK_DOUT_CMU_LCPU						28

#define CLK_DOUT_CMU_MIF_SWITCH						29

#define CLK_DOUT_CMU_MIF_BUSP						30

#define CLK_DOUT_CMU_PERI_DISP						31

#define CLK_DOUT_CMU_PERI_IP						32

#define CLK_DOUT_CMU_RSP_CORE						33

#define CLK_DOUT_CMU_TRFM						34

#define CLK_DOUT_CMU_VIO_CORE_L						35

#define CLK_DOUT_CMU_VIO_CORE						36

#define CLK_DOUT_CMU_VIP0						37

#define CLK_DOUT_CMU_VIP1						38

#define CLK_DOUT_CMU_VPP_CORE						39

#define CLK_DOUT_CMU_VIO_AUDIO						40



/* CMU_BUS */

#define CLK_MOUT_BUS_ACLK_USER						1



/* CMU_CORE */

#define CLK_MOUT_CORE_ACLK_USER						1



/* CMU_CPUCL */

#define CLK_FOUT_CPUCL_PLL0						1

#define CLK_MOUT_CPUCL_PLL0						2

#define CLK_FOUT_CPUCL_PLL1						3

#define CLK_MOUT_CPUCL_PLL_SCU						4

#define CLK_MOUT_CPUCL_SWITCH_SCU_USER					5

#define CLK_MOUT_CPUCL_SWITCH_USER					6

#define CLK_DOUT_CPUCL_CPU						7

#define CLK_DOUT_CPUCL_CLUSTER_PERIPHCLK				8

#define CLK_DOUT_CPUCL_CLUSTER_GICCLK					9

#define CLK_DOUT_CPUCL_CLUSTER_PCLK					10

#define CLK_DOUT_CPUCL_CMUREF						11

#define CLK_DOUT_CPUCL_CLUSTER_ATCLK					12

#define CLK_DOUT_CPUCL_CLUSTER_SCU					13

#define CLK_DOUT_CPUCL_DBG						14

#define CLK_GOUT_CPUCL_SHORTSTOP					15

#define CLK_GOUT_CPUCL_CLUSTER_CPU					16

#define CLK_GOUT_CPUCL_CSSYS_IPCLKPORT_ATCLK				17

#define CLK_GOUT_CPUCL_CSSYS_IPCLKPORT_PCLKDBG				18



/* CMU_FSYS0 */

#define CLK_MOUT_FSYS0_BUS_USER						1

#define CLK_MOUT_FSYS0_IP_USER						2

#define CLK_MOUT_FSYS0_MAIN_USER					3

#define CLK_DOUT_FSYS0_125						4

#define CLK_DOUT_FSYS0_ADC						5

#define CLK_DOUT_FSYS0_BUS_300						6

#define CLK_DOUT_FSYS0_EQOS0						7

#define CLK_DOUT_FSYS0_EQOS1						8

#define CLK_DOUT_FSYS0_MMC_CARD0					9

#define CLK_DOUT_FSYS0_MMC_CARD1					10

#define CLK_DOUT_FSYS0_MMC_CARD2					11

#define CLK_DOUT_FSYS0_QSPI						12

#define CLK_DOUT_FSYS0_SFMC_NAND					13

#define CLK_GOUT_FSYS0_EQOS_TOP0_IPCLKPORT_ACLK_I			14

#define CLK_GOUT_FSYS0_EQOS_TOP0_IPCLKPORT_CLK_CSR_I			15

#define CLK_GOUT_FSYS0_EQOS_TOP0_IPCLKPORT_I_RGMII_PHASE_CLK_250	16

#define CLK_GOUT_FSYS0_EQOS_TOP0_IPCLKPORT_I_RGMII_TXCLK		17

#define CLK_GOUT_FSYS0_EQOS_TOP1_IPCLKPORT_I_RGMII_PHASE_CLK_250	18

#define CLK_GOUT_FSYS0_EQOS_TOP1_IPCLKPORT_I_RGMII_TXCLK		19

#define CLK_GOUT_FSYS0_EQOS_TOP1_IPCLKPORT_ACLK_I			20

#define CLK_GOUT_FSYS0_EQOS_TOP1_IPCLKPORT_CLK_CSR_I			21

#define CLK_GOUT_FSYS0_I3C0_IPCLKPORT_I_APB_S_PCLK			22

#define CLK_GOUT_FSYS0_I3C0_IPCLKPORT_I_CORE_CLK			23

#define CLK_GOUT_FSYS0_I3C0_IPCLKPORT_I_DMA_CLK				24

#define CLK_GOUT_FSYS0_I3C0_IPCLKPORT_I_HDR_TX_CLK			25

#define CLK_GOUT_FSYS0_I3C1_IPCLKPORT_I_APB_S_PCLK			26

#define CLK_GOUT_FSYS0_I3C1_IPCLKPORT_I_CORE_CLK			27

#define CLK_GOUT_FSYS0_I3C1_IPCLKPORT_I_DMA_CLK				28

#define CLK_GOUT_FSYS0_I3C1_IPCLKPORT_I_HDR_TX_CLK			29

#define CLK_GOUT_FSYS0_MMC0_IPCLKPORT_SDCLKIN				30

#define CLK_GOUT_FSYS0_MMC1_IPCLKPORT_SDCLKIN				31

#define CLK_GOUT_FSYS0_MMC2_IPCLKPORT_SDCLKIN				32

#define CLK_GOUT_FSYS0_QSPI_IPCLKPORT_HCLK				33

#define CLK_GOUT_FSYS0_QSPI_IPCLKPORT_SSI_CLK				34

#define CLK_GOUT_FSYS0_SFMC_IPCLKPORT_I_ACLK_NAND			35

#define CLK_GOUT_FSYS0_I2C0_IPCLKPORT_I_PCLK				36

#define CLK_GOUT_FSYS0_I2C1_IPCLKPORT_I_PCLK				37

#define CLK_GOUT_FSYS0_MMC0_IPCLKPORT_I_ACLK				38

#define CLK_GOUT_FSYS0_MMC1_IPCLKPORT_I_ACLK				39

#define CLK_GOUT_FSYS0_MMC2_IPCLKPORT_I_ACLK				40

#define CLK_GOUT_FSYS0_PWM_IPCLKPORT_I_PCLK_S0				41



/* CMU_FSYS1 */

#define CLK_FOUT_FSYS1_PLL						1

#define CLK_MOUT_FSYS1_SCAN0_USER					2

#define CLK_MOUT_FSYS1_SCAN1_USER					3

#define CLK_MOUT_FSYS1_BUS_USER						4

#define CLK_DOUT_FSYS1_200						5

#define CLK_DOUT_FSYS1_BUS_300						6

#define CLK_DOUT_FSYS1_OTP_MEM						7

#define CLK_DOUT_FSYS1_PCIE_PHY_REFCLK_SYSPLL				8

#define CLK_GOUT_FSYS1_IPCLKPORT_PCIE_PHY_APB2CR_PCLK_100		9

#define CLK_GOUT_FSYS1_UART0_PCLK					10

#define CLK_GOUT_FSYS1_UART0_SCLK_UART					11

#define CLK_GOUT_FSYS1_IPCLKPORT_PCIE_PHY_APB2CR_PCLK_300		12

#define CLK_GOUT_FSYS1_IPCLKPORT_PCIE_SUB_CON_X1_DBI_ACLK_SOC		13

#define CLK_GOUT_FSYS1_IPCLKPORT_PCIE_SUB_CON_X1_MSTR_ACLK_SOC		14

#define CLK_GOUT_FSYS1_IPCLKPORT_PCIE_SUB_CON_X1_SLV_ACLK_SOC		15

#define CLK_GOUT_FSYS1_IPCLKPORT_PCIE_SUB_CON_X2_DBI_ACLK_SOC		16

#define CLK_GOUT_FSYS1_IPCLKPORT_PCIE_SUB_CON_X2_MSTR_ACLK_SOC		17

#define CLK_GOUT_FSYS1_IPCLKPORT_PCIE_SUB_CON_X2_SLV_ACLK_SOC		18

#define CLK_GOUT_FSYS1_USB20DRD_IPCLKPORT_ACLK_PHYCTRL_20		19

#define CLK_GOUT_FSYS1_USB20DRD_IPCLKPORT_BUS_CLK_EARLY			20

#define CLK_GOUT_FSYS1_XHB_AHBBR_FSYS1_IPCLKPORT_CLK			21

#define CLK_GOUT_FSYS1_XHB_USB_IPCLKPORT_CLK				22



/* CMU_IMEM */

#define CLK_MOUT_IMEM_ACLK_USER						1

#define CLK_MOUT_IMEM_CA5_USER						2

#define CLK_MOUT_IMEM_SSS_USER						3

#define CLK_MOUT_IMEM_JPEG_USER						4

#define CLK_DOUT_IMEM_PCLK						5

#define CLK_GOUT_IMEM_CA5_0_IPCLKPORT_ATCLK				6

#define CLK_GOUT_IMEM_CA5_0_IPCLKPORT_CLKIN				7

#define CLK_GOUT_IMEM_CA5_0_IPCLKPORT_PCLK_DBG				8

#define CLK_GOUT_IMEM_CA5_1_IPCLKPORT_ATCLK				9

#define CLK_GOUT_IMEM_CA5_1_IPCLKPORT_CLKIN				10

#define CLK_GOUT_IMEM_CA5_1_IPCLKPORT_PCLK_DBG				11

#define CLK_GOUT_IMEM_MCT0_PCLK						12

#define CLK_GOUT_IMEM_MCT1_PCLK						13

#define CLK_GOUT_IMEM_MCT2_PCLK						14

#define CLK_GOUT_IMEM_MCT3_PCLK						15

#define CLK_GOUT_IMEM_PCLK_TMU0_APBIF					16



/* CMU_PERI */

#define CLK_MOUT_PERI_IP_USER						1

#define CLK_MOUT_PERI_DISP_USER						2

#define CLK_DOUT_PERI_125						3

#define CLK_DOUT_PERI_PCLK						4

#define CLK_DOUT_PERI_SPI						5

#define CLK_DOUT_PERI_UART1						6

#define CLK_DOUT_PERI_UART2						7

#define CLK_GOUT_PERI_DMA4DSIM_IPCLKPORT_CLK_APB_CLK			8

#define CLK_GOUT_PERI_DMA4DSIM_IPCLKPORT_CLK_AXI_CLK			9

#define CLK_GOUT_PERI_I3C2_IPCLKPORT_I_APB_S_PCLK			10

#define CLK_GOUT_PERI_I3C2_IPCLKPORT_I_CORE_CLK				11

#define CLK_GOUT_PERI_I3C2_IPCLKPORT_I_DMA_CLK				12

#define CLK_GOUT_PERI_I3C2_IPCLKPORT_I_HDR_TX_CLK			13

#define CLK_GOUT_PERI_I3C3_IPCLKPORT_I_APB_S_PCLK			14

#define CLK_GOUT_PERI_I3C3_IPCLKPORT_I_CORE_CLK				15

#define CLK_GOUT_PERI_I3C3_IPCLKPORT_I_DMA_CLK				16

#define CLK_GOUT_PERI_I3C3_IPCLKPORT_I_HDR_TX_CLK			17

#define CLK_GOUT_PERI_APB_ASYNC_DSIM_IPCLKPORT_PCLKS			18

#define CLK_GOUT_PERI_I2C2_IPCLKPORT_I_PCLK				19

#define CLK_GOUT_PERI_I2C3_IPCLKPORT_I_PCLK				20

#define CLK_GOUT_PERI_SPI0_PCLK						21

#define CLK_GOUT_PERI_SPI0_SCLK_SPI					22

#define CLK_GOUT_PERI_UART1_PCLK					23

#define CLK_GOUT_PERI_UART1_SCLK_UART					24

#define CLK_GOUT_PERI_UART2_PCLK					25

#define CLK_GOUT_PERI_UART2_SCLK_UART					26



#endif /* _DT_BINDINGS_CLOCK_ARTPEC9_H */