diff mbox series

[v3,4/8] dt-bindings: clock: Add devicetree binding for BM1880 SoC

Message ID 20190819130143.18778-5-manivannan.sadhasivam@linaro.org
State Superseded
Headers show
Series [v3,1/8] clk: Zero init clk_init_data in helpers | expand

Commit Message

Manivannan Sadhasivam Aug. 19, 2019, 1:01 p.m. UTC
Add YAML devicetree binding for Bitmain BM1880 SoC.

Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>

---
 .../bindings/clock/bitmain,bm1880-clk.yaml    | 83 +++++++++++++++++++
 include/dt-bindings/clock/bm1880-clock.h      | 82 ++++++++++++++++++
 2 files changed, 165 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/clock/bitmain,bm1880-clk.yaml
 create mode 100644 include/dt-bindings/clock/bm1880-clock.h

-- 
2.17.1

Comments

Rob Herring Aug. 19, 2019, 7:18 p.m. UTC | #1
On Mon, Aug 19, 2019 at 8:02 AM Manivannan Sadhasivam
<manivannan.sadhasivam@linaro.org> wrote:
>

> Add YAML devicetree binding for Bitmain BM1880 SoC.

>

> Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>

> ---

>  .../bindings/clock/bitmain,bm1880-clk.yaml    | 83 +++++++++++++++++++

>  include/dt-bindings/clock/bm1880-clock.h      | 82 ++++++++++++++++++

>  2 files changed, 165 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/clock/bitmain,bm1880-clk.yaml

>  create mode 100644 include/dt-bindings/clock/bm1880-clock.h

>

> diff --git a/Documentation/devicetree/bindings/clock/bitmain,bm1880-clk.yaml b/Documentation/devicetree/bindings/clock/bitmain,bm1880-clk.yaml

> new file mode 100644

> index 000000000000..a457f996287d

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/clock/bitmain,bm1880-clk.yaml

> @@ -0,0 +1,83 @@

> +# SPDX-License-Identifier: GPL-2.0

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/bindings/clock/bitmain,bm1880-clk.yaml#

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

> +

> +title: Bitmain BM1880 Clock Controller

> +

> +maintainers:

> +  - Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>

> +

> +description: |

> +  The Bitmain BM1880 clock controller generates and supplies clock to

> +  various peripherals within the SoC.

> +

> +  This binding uses common clock bindings

> +  [1] Documentation/devicetree/bindings/clock/clock-bindings.txt

> +

> +properties:

> +  compatible:

> +    oneOf:

> +      - items:

> +          - enum:

> +              - bitmain,bm1880-clk


Just 'const: bitmain,bm1880-clk' is enough.

> +

> +  reg:

> +    minItems: 2

> +    maxItems: 2


These 2 are implied by the items list and can be dropped.

> +    items:

> +      - description: pll registers

> +      - description: system registers

> +

> +  reg-names:

> +    items:

> +      - const: pll

> +      - const: sys

> +

> +  clocks:

> +    maxItems: 1

> +    description: Phandle of the input reference clock


Don't need a description if there's only one entry.

> +

> +  clock-names:

> +    maxItems: 1

> +    items:

> +      - const: osc


Just:

clock-names:
  const: osc

> +

> +  '#clock-cells':

> +    const: 1

> +

> +required:

> +  - compatible

> +  - reg

> +  - reg-names

> +  - clocks

> +  - clock-names

> +  - '#clock-cells'

> +

> +examples:

> +  # Clock controller node:

> +  - |

> +    clk: clock-controller@e8 {

> +        compatible = "bitmain,bm1880-clk";

> +        reg = <0xe8 0x0c>, <0x800 0xb0>;

> +        reg-names = "pll", "sys";

> +        clocks = <&osc>;

> +        clock-names = "osc";

> +        #clock-cells = <1>;

> +    };

> +

> +  # Example UART controller node that consumes clock generated by the clock controller:

> +  - |

> +    uart0: serial@58018000 {

> +         compatible = "snps,dw-apb-uart";

> +         reg = <0x0 0x58018000 0x0 0x2000>;

> +         clocks = <&clk BM1880_CLK_UART_500M>;

> +                  <&clk BM1880_CLK_APB_UART>;


This won't build without includes. Please run 'make dt_binding_check'
before you submit bindings.

> +         clock-names = "baudclk", "apb_pclk";

> +         interrupts = <GIC_SPI 9 IRQ_TYPE_LEVEL_HIGH>;

> +         reg-shift = <2>;

> +         reg-io-width = <4>;

> +    };

> +

> +...

> diff --git a/include/dt-bindings/clock/bm1880-clock.h b/include/dt-bindings/clock/bm1880-clock.h

> new file mode 100644

> index 000000000000..895646d66b07

> --- /dev/null

> +++ b/include/dt-bindings/clock/bm1880-clock.h

> @@ -0,0 +1,82 @@

> +/* SPDX-License-Identifier: GPL-2.0 */

> +/*

> + * Device Tree binding constants for Bitmain BM1880 SoC

> + *

> + * Copyright (c) 2019 Linaro Ltd.

> + */

> +

> +#ifndef __DT_BINDINGS_CLOCK_BM1880_H

> +#define __DT_BINDINGS_CLOCK_BM1880_H

> +

> +#define BM1880_CLK_OSC                 0

> +#define BM1880_CLK_MPLL                        1

> +#define BM1880_CLK_SPLL                        2

> +#define BM1880_CLK_FPLL                        3

> +#define BM1880_CLK_DDRPLL              4

> +#define BM1880_CLK_A53                 5

> +#define BM1880_CLK_50M_A53             6

> +#define BM1880_CLK_AHB_ROM             7

> +#define BM1880_CLK_AXI_SRAM            8

> +#define BM1880_CLK_DDR_AXI             9

> +#define BM1880_CLK_EFUSE               10

> +#define BM1880_CLK_APB_EFUSE           11

> +#define BM1880_CLK_AXI5_EMMC           12

> +#define BM1880_CLK_EMMC                        13

> +#define BM1880_CLK_100K_EMMC           14

> +#define BM1880_CLK_AXI5_SD             15

> +#define BM1880_CLK_SD                  16

> +#define BM1880_CLK_100K_SD             17

> +#define BM1880_CLK_500M_ETH0           18

> +#define BM1880_CLK_AXI4_ETH0           19

> +#define BM1880_CLK_500M_ETH1           20

> +#define BM1880_CLK_AXI4_ETH1           21

> +#define BM1880_CLK_AXI1_GDMA           22

> +#define BM1880_CLK_APB_GPIO            23

> +#define BM1880_CLK_APB_GPIO_INTR       24

> +#define BM1880_CLK_GPIO_DB             25

> +#define BM1880_CLK_AXI1_MINER          26

> +#define BM1880_CLK_AHB_SF              27

> +#define BM1880_CLK_SDMA_AXI            28

> +#define BM1880_CLK_SDMA_AUD            29

> +#define BM1880_CLK_APB_I2C             30

> +#define BM1880_CLK_APB_WDT             31

> +#define BM1880_CLK_APB_JPEG            32

> +#define BM1880_CLK_JPEG_AXI            33

> +#define BM1880_CLK_AXI5_NF             34

> +#define BM1880_CLK_APB_NF              35

> +#define BM1880_CLK_NF                  36

> +#define BM1880_CLK_APB_PWM             37

> +#define BM1880_CLK_DIV_0_RV            38

> +#define BM1880_CLK_DIV_1_RV            39

> +#define BM1880_CLK_MUX_RV              40

> +#define BM1880_CLK_RV                  41

> +#define BM1880_CLK_APB_SPI             42

> +#define BM1880_CLK_TPU_AXI             43

> +#define BM1880_CLK_DIV_UART_500M       44

> +#define BM1880_CLK_UART_500M           45

> +#define BM1880_CLK_APB_UART            46

> +#define BM1880_CLK_APB_I2S             47

> +#define BM1880_CLK_AXI4_USB            48

> +#define BM1880_CLK_APB_USB             49

> +#define BM1880_CLK_125M_USB            50

> +#define BM1880_CLK_33K_USB             51

> +#define BM1880_CLK_DIV_12M_USB         52

> +#define BM1880_CLK_12M_USB             53

> +#define BM1880_CLK_APB_VIDEO           54

> +#define BM1880_CLK_VIDEO_AXI           55

> +#define BM1880_CLK_VPP_AXI             56

> +#define BM1880_CLK_APB_VPP             57

> +#define BM1880_CLK_DIV_0_AXI1          58

> +#define BM1880_CLK_DIV_1_AXI1          59

> +#define BM1880_CLK_AXI1                        60

> +#define BM1880_CLK_AXI2                        61

> +#define BM1880_CLK_AXI3                        62

> +#define BM1880_CLK_AXI4                        63

> +#define BM1880_CLK_AXI5                        64

> +#define BM1880_CLK_DIV_0_AXI6          65

> +#define BM1880_CLK_DIV_1_AXI6          66

> +#define BM1880_CLK_MUX_AXI6            67

> +#define BM1880_CLK_AXI6                        68

> +#define BM1880_NR_CLKS                 69

> +

> +#endif /* __DT_BINDINGS_CLOCK_BM1880_H */

> --

> 2.17.1

>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/clock/bitmain,bm1880-clk.yaml b/Documentation/devicetree/bindings/clock/bitmain,bm1880-clk.yaml
new file mode 100644
index 000000000000..a457f996287d
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/bitmain,bm1880-clk.yaml
@@ -0,0 +1,83 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/bindings/clock/bitmain,bm1880-clk.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Bitmain BM1880 Clock Controller
+
+maintainers:
+  - Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
+
+description: |
+  The Bitmain BM1880 clock controller generates and supplies clock to
+  various peripherals within the SoC.
+
+  This binding uses common clock bindings
+  [1] Documentation/devicetree/bindings/clock/clock-bindings.txt
+
+properties:
+  compatible:
+    oneOf:
+      - items:
+          - enum:
+              - bitmain,bm1880-clk
+
+  reg:
+    minItems: 2
+    maxItems: 2
+    items:
+      - description: pll registers
+      - description: system registers
+
+  reg-names:
+    items:
+      - const: pll
+      - const: sys
+
+  clocks:
+    maxItems: 1
+    description: Phandle of the input reference clock
+
+  clock-names:
+    maxItems: 1
+    items:
+      - const: osc
+
+  '#clock-cells':
+    const: 1
+
+required:
+  - compatible
+  - reg
+  - reg-names
+  - clocks
+  - clock-names
+  - '#clock-cells'
+
+examples:
+  # Clock controller node:
+  - |
+    clk: clock-controller@e8 {
+        compatible = "bitmain,bm1880-clk";
+        reg = <0xe8 0x0c>, <0x800 0xb0>;
+        reg-names = "pll", "sys";
+        clocks = <&osc>;
+        clock-names = "osc";
+        #clock-cells = <1>;
+    };
+
+  # Example UART controller node that consumes clock generated by the clock controller:
+  - |
+    uart0: serial@58018000 {
+         compatible = "snps,dw-apb-uart";
+         reg = <0x0 0x58018000 0x0 0x2000>;
+         clocks = <&clk BM1880_CLK_UART_500M>;
+                  <&clk BM1880_CLK_APB_UART>;
+         clock-names = "baudclk", "apb_pclk";
+         interrupts = <GIC_SPI 9 IRQ_TYPE_LEVEL_HIGH>;
+         reg-shift = <2>;
+         reg-io-width = <4>;
+    };
+
+...
diff --git a/include/dt-bindings/clock/bm1880-clock.h b/include/dt-bindings/clock/bm1880-clock.h
new file mode 100644
index 000000000000..895646d66b07
--- /dev/null
+++ b/include/dt-bindings/clock/bm1880-clock.h
@@ -0,0 +1,82 @@ 
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * Device Tree binding constants for Bitmain BM1880 SoC
+ *
+ * Copyright (c) 2019 Linaro Ltd.
+ */
+
+#ifndef __DT_BINDINGS_CLOCK_BM1880_H
+#define __DT_BINDINGS_CLOCK_BM1880_H
+
+#define BM1880_CLK_OSC			0
+#define BM1880_CLK_MPLL			1
+#define BM1880_CLK_SPLL			2
+#define BM1880_CLK_FPLL			3
+#define BM1880_CLK_DDRPLL		4
+#define BM1880_CLK_A53			5
+#define BM1880_CLK_50M_A53		6
+#define BM1880_CLK_AHB_ROM		7
+#define BM1880_CLK_AXI_SRAM		8
+#define BM1880_CLK_DDR_AXI		9
+#define BM1880_CLK_EFUSE		10
+#define BM1880_CLK_APB_EFUSE		11
+#define BM1880_CLK_AXI5_EMMC		12
+#define BM1880_CLK_EMMC			13
+#define BM1880_CLK_100K_EMMC		14
+#define BM1880_CLK_AXI5_SD		15
+#define BM1880_CLK_SD			16
+#define BM1880_CLK_100K_SD		17
+#define BM1880_CLK_500M_ETH0		18
+#define BM1880_CLK_AXI4_ETH0		19
+#define BM1880_CLK_500M_ETH1		20
+#define BM1880_CLK_AXI4_ETH1		21
+#define BM1880_CLK_AXI1_GDMA		22
+#define BM1880_CLK_APB_GPIO		23
+#define BM1880_CLK_APB_GPIO_INTR	24
+#define BM1880_CLK_GPIO_DB		25
+#define BM1880_CLK_AXI1_MINER		26
+#define BM1880_CLK_AHB_SF		27
+#define BM1880_CLK_SDMA_AXI		28
+#define BM1880_CLK_SDMA_AUD		29
+#define BM1880_CLK_APB_I2C		30
+#define BM1880_CLK_APB_WDT		31
+#define BM1880_CLK_APB_JPEG		32
+#define BM1880_CLK_JPEG_AXI		33
+#define BM1880_CLK_AXI5_NF		34
+#define BM1880_CLK_APB_NF		35
+#define BM1880_CLK_NF			36
+#define BM1880_CLK_APB_PWM		37
+#define BM1880_CLK_DIV_0_RV		38
+#define BM1880_CLK_DIV_1_RV		39
+#define BM1880_CLK_MUX_RV		40
+#define BM1880_CLK_RV			41
+#define BM1880_CLK_APB_SPI		42
+#define BM1880_CLK_TPU_AXI		43
+#define BM1880_CLK_DIV_UART_500M	44
+#define BM1880_CLK_UART_500M		45
+#define BM1880_CLK_APB_UART		46
+#define BM1880_CLK_APB_I2S		47
+#define BM1880_CLK_AXI4_USB		48
+#define BM1880_CLK_APB_USB		49
+#define BM1880_CLK_125M_USB		50
+#define BM1880_CLK_33K_USB		51
+#define BM1880_CLK_DIV_12M_USB		52
+#define BM1880_CLK_12M_USB		53
+#define BM1880_CLK_APB_VIDEO		54
+#define BM1880_CLK_VIDEO_AXI		55
+#define BM1880_CLK_VPP_AXI		56
+#define BM1880_CLK_APB_VPP		57
+#define BM1880_CLK_DIV_0_AXI1		58
+#define BM1880_CLK_DIV_1_AXI1		59
+#define BM1880_CLK_AXI1			60
+#define BM1880_CLK_AXI2			61
+#define BM1880_CLK_AXI3			62
+#define BM1880_CLK_AXI4			63
+#define BM1880_CLK_AXI5			64
+#define BM1880_CLK_DIV_0_AXI6		65
+#define BM1880_CLK_DIV_1_AXI6		66
+#define BM1880_CLK_MUX_AXI6		67
+#define BM1880_CLK_AXI6			68
+#define BM1880_NR_CLKS			69
+
+#endif /* __DT_BINDINGS_CLOCK_BM1880_H */