xref: /kernel/linux/linux-6.6/Documentation/devicetree/bindings/clock/samsung,exynos5260-clock.yaml

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/clock/samsung,exynos5260-clock.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Samsung Exynos5260 SoC clock controller

maintainers:
  - Chanwoo Choi <cw00.choi@samsung.com>
  - Krzysztof Kozlowski <krzk@kernel.org>
  - Sylwester Nawrocki <s.nawrocki@samsung.com>
  - Tomasz Figa <tomasz.figa@gmail.com>

description: |
  Expected external clocks, defined in DTS as fixed-rate clocks with a matching
  name::
    - "fin_pll" - PLL input clock from XXTI
    - "xrtcxti" - input clock from XRTCXTI
    - "ioclk_pcm_extclk" - pcm external operation clock
    - "ioclk_spdif_extclk" - spdif external operation clock
    - "ioclk_i2s_cdclk" - i2s0 codec clock

  Phy clocks::
  There are several clocks which are generated by specific PHYs.  These clocks
  are fed into the clock controller and then routed to the hardware blocks.
  These clocks are defined as fixed clocks in the driver with following names::
    - "phyclk_dptx_phy_ch3_txd_clk" - dp phy clock for channel 3
    - "phyclk_dptx_phy_ch2_txd_clk" - dp phy clock for channel 2
    - "phyclk_dptx_phy_ch1_txd_clk" - dp phy clock for channel 1
    - "phyclk_dptx_phy_ch0_txd_clk" - dp phy clock for channel 0
    - "phyclk_hdmi_phy_tmds_clko" - hdmi phy tmds clock
    - "phyclk_hdmi_phy_pixel_clko" - hdmi phy pixel clock
    - "phyclk_hdmi_link_o_tmds_clkhi" - hdmi phy for hdmi link
    - "phyclk_dptx_phy_o_ref_clk_24m" - dp phy reference clock
    - "phyclk_dptx_phy_clk_div2"
    - "phyclk_mipi_dphy_4l_m_rxclkesc0"
    - "phyclk_usbhost20_phy_phyclock" - usb 2.0 phy clock
    - "phyclk_usbhost20_phy_freeclk"
    - "phyclk_usbhost20_phy_clk48mohci"
    - "phyclk_usbdrd30_udrd30_pipe_pclk"
    - "phyclk_usbdrd30_udrd30_phyclock" - usb 3.0 phy clock

  All available clocks are defined as preprocessor macros in
  include/dt-bindings/clock/exynos5260-clk.h header.

properties:
  compatible:
    enum:
      - samsung,exynos5260-clock-top
      - samsung,exynos5260-clock-peri
      - samsung,exynos5260-clock-egl
      - samsung,exynos5260-clock-kfc
      - samsung,exynos5260-clock-g2d
      - samsung,exynos5260-clock-mif
      - samsung,exynos5260-clock-mfc
      - samsung,exynos5260-clock-g3d
      - samsung,exynos5260-clock-fsys
      - samsung,exynos5260-clock-aud
      - samsung,exynos5260-clock-isp
      - samsung,exynos5260-clock-gscl
      - samsung,exynos5260-clock-disp

  clocks:
    minItems: 1
    maxItems: 19

  clock-names:
    minItems: 1
    maxItems: 19

  "#clock-cells":
    const: 1

  reg:
    maxItems: 1

required:
  - compatible
  - "#clock-cells"
  - reg

allOf:
  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos5260-clock-top
    then:
      properties:
        clocks:
          minItems: 4
          maxItems: 4
        clock-names:
          items:
            - const: fin_pll
            - const: dout_mem_pll
            - const: dout_bus_pll
            - const: dout_media_pll
      required:
        - clock-names
        - clocks

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos5260-clock-peri
    then:
      properties:
        clocks:
          minItems: 13
          maxItems: 13
        clock-names:
          items:
            - const: fin_pll
            - const: ioclk_pcm_extclk
            - const: ioclk_i2s_cdclk
            - const: ioclk_spdif_extclk
            - const: phyclk_hdmi_phy_ref_cko
            - const: dout_aclk_peri_66
            - const: dout_sclk_peri_uart0
            - const: dout_sclk_peri_uart1
            - const: dout_sclk_peri_uart2
            - const: dout_sclk_peri_spi0_b
            - const: dout_sclk_peri_spi1_b
            - const: dout_sclk_peri_spi2_b
            - const: dout_aclk_peri_aud
      required:
        - clock-names
        - clocks

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos5260-clock-egl
    then:
      properties:
        clocks:
          minItems: 2
          maxItems: 2
        clock-names:
          items:
            - const: fin_pll
            - const: dout_bus_pll
      required:
        - clock-names
        - clocks

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos5260-clock-kfc
    then:
      properties:
        clocks:
          minItems: 2
          maxItems: 2
        clock-names:
          items:
            - const: fin_pll
            - const: dout_media_pll
      required:
        - clock-names
        - clocks

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos5260-clock-g2d
    then:
      properties:
        clocks:
          minItems: 2
          maxItems: 2
        clock-names:
          items:
            - const: fin_pll
            - const: dout_aclk_g2d_333
      required:
        - clock-names
        - clocks

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos5260-clock-mif
    then:
      properties:
        clocks:
          minItems: 1
          maxItems: 1
        clock-names:
          items:
            - const: fin_pll
      required:
        - clock-names
        - clocks

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos5260-clock-mfc
    then:
      properties:
        clocks:
          minItems: 2
          maxItems: 2
        clock-names:
          items:
            - const: fin_pll
            - const: dout_aclk_mfc_333
      required:
        - clock-names
        - clocks

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos5260-clock-g3d
    then:
      properties:
        clocks:
          minItems: 1
          maxItems: 1
        clock-names:
          items:
            - const: fin_pll
      required:
        - clock-names
        - clocks

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos5260-clock-fsys
    then:
      properties:
        clocks:
          minItems: 7
          maxItems: 7
        clock-names:
          items:
            - const: fin_pll
            - const: phyclk_usbhost20_phy_phyclock
            - const: phyclk_usbhost20_phy_freeclk
            - const: phyclk_usbhost20_phy_clk48mohci
            - const: phyclk_usbdrd30_udrd30_pipe_pclk
            - const: phyclk_usbdrd30_udrd30_phyclock
            - const: dout_aclk_fsys_200
      required:
        - clock-names
        - clocks

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos5260-clock-aud
    then:
      properties:
        clocks:
          minItems: 4
          maxItems: 4
        clock-names:
          items:
            - const: fin_pll
            - const: fout_aud_pll
            - const: ioclk_i2s_cdclk
            - const: ioclk_pcm_extclk
      required:
        - clock-names
        - clocks

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos5260-clock-isp
    then:
      properties:
        clocks:
          minItems: 4
          maxItems: 4
        clock-names:
          items:
            - const: fin_pll
            - const: dout_aclk_isp1_266
            - const: dout_aclk_isp1_400
            - const: mout_aclk_isp1_266

      required:
        - clock-names
        - clocks

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos5260-clock-gscl
    then:
      properties:
        clocks:
          minItems: 3
          maxItems: 3
        clock-names:
          items:
            - const: fin_pll
            - const: dout_aclk_gscl_400
            - const: dout_aclk_gscl_333
      required:
        - clock-names
        - clocks

  - if:
      properties:
        compatible:
          contains:
            const: samsung,exynos5260-clock-disp
    then:
      properties:
        clocks:
          minItems: 19
          maxItems: 19
        clock-names:
          items:
            - const: fin_pll
            - const: phyclk_dptx_phy_ch3_txd_clk
            - const: phyclk_dptx_phy_ch2_txd_clk
            - const: phyclk_dptx_phy_ch1_txd_clk
            - const: phyclk_dptx_phy_ch0_txd_clk
            - const: phyclk_hdmi_phy_tmds_clko
            - const: phyclk_hdmi_phy_ref_clko
            - const: phyclk_hdmi_phy_pixel_clko
            - const: phyclk_hdmi_link_o_tmds_clkhi
            - const: phyclk_mipi_dphy_4l_m_txbyte_clkhs
            - const: phyclk_dptx_phy_o_ref_clk_24m
            - const: phyclk_dptx_phy_clk_div2
            - const: phyclk_mipi_dphy_4l_m_rxclkesc0
            - const: phyclk_hdmi_phy_ref_cko
            - const: ioclk_spdif_extclk
            - const: dout_aclk_peri_aud
            - const: dout_aclk_disp_222
            - const: dout_sclk_disp_pixel
            - const: dout_aclk_disp_333
      required:
        - clock-names
        - clocks

additionalProperties: false

examples:
  - |
    #include <dt-bindings/clock/exynos5260-clk.h>

    fin_pll: clock {
        compatible = "fixed-clock";
        clock-output-names = "fin_pll";
        #clock-cells = <0>;
        clock-frequency = <24000000>;
    };

    clock-controller@10010000 {
        compatible = "samsung,exynos5260-clock-top";
        reg = <0x10010000 0x10000>;
        #clock-cells = <1>;
        clocks = <&fin_pll>,
                 <&clock_mif MIF_DOUT_MEM_PLL>,
                 <&clock_mif MIF_DOUT_BUS_PLL>,
                 <&clock_mif MIF_DOUT_MEDIA_PLL>;
        clock-names = "fin_pll",
                      "dout_mem_pll",
                      "dout_bus_pll",
                      "dout_media_pll";
    };