[v2,1/3] dt-bindings: rtc: Add Amlogic A4 and A5 rtc

Commit Message

Xianwei Zhao via B4 Relay Sept. 3, 2024, 7 a.m. UTC

From: Yiting Deng <[e-mail]>

Add documentation describing the Amlogic A4(A113L2) and A5(A113X2)
rtc controller.

Signed-off-by: Yiting Deng <[e-mail]>
Signed-off-by: Xianwei Zhao <[e-mail]>
---
 .../bindings/rtc/amlogic,amlogic-rtc.yaml          | 66 ++++++++++++++++++++++
 1 file changed, 66 insertions(+)

Comments

Krzysztof Kozlowski Sept. 3, 2024, 2:03 p.m. UTC | #1

On 03/09/2024 09:00, Xianwei Zhao via B4 Relay wrote:
> From: Yiting Deng <[e-mail]>
> 
> Add documentation describing the Amlogic A4(A113L2) and A5(A113X2)
> rtc controller.

RTC. And no "controller".

> 
> Signed-off-by: Yiting Deng <[e-mail]>
> Signed-off-by: Xianwei Zhao <[e-mail]>
> ---
>  .../bindings/rtc/amlogic,amlogic-rtc.yaml          | 66 ++++++++++++++++++++++
>  1 file changed, 66 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/rtc/amlogic,amlogic-rtc.yaml b/Documentation/devicetree/bindings/rtc/amlogic,amlogic-rtc.yaml
> new file mode 100644
> index 000000000000..128c60b623e1
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/amlogic,amlogic-rtc.yaml

That's odd filename. Use compatible as the filename.

> @@ -0,0 +1,66 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright (C) 2024 Amlogic, Inc. All rights reserved
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/amlogic,amlogic-rtc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Amlogic Real Time Clock controller include a4, a5

Sorry, that's unparseable. Either this is clock controller or RTC. What
does it mean "include a4"?


> +
> +maintainers:
> +  - Yiting Deng <[e-mail]>
> +  - Xianwei Zhao <[e-mail]>
> +
> +description:
> +  The Amlogic new chips used RTC module.

This tells me nothing. Please say something useful or drop this.

Best regards,
Krzysztof

Xianwei Zhao Sept. 4, 2024, 8:18 a.m. UTC | #2

Hi Krzysztof,
    Thanks for your reply.

On 2024/9/3 22:03, Krzysztof Kozlowski wrote:
> [ EXTERNAL EMAIL ]
> 
> On 03/09/2024 09:00, Xianwei Zhao via B4 Relay wrote:
>> From: Yiting Deng <[e-mail]>
>>
>> Add documentation describing the Amlogic A4(A113L2) and A5(A113X2)
>> rtc controller.
> 
> RTC. And no "controller".
> 

Will do, describe it as "Add documentation describing the Amlogic 
A4(A113L2) and A5(A113X2) RTC."


>>
>> Signed-off-by: Yiting Deng <[e-mail]>
>> Signed-off-by: Xianwei Zhao <[e-mail]>
>> ---
>>   .../bindings/rtc/amlogic,amlogic-rtc.yaml          | 66 ++++++++++++++++++++++
>>   1 file changed, 66 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/rtc/amlogic,amlogic-rtc.yaml b/Documentation/devicetree/bindings/rtc/amlogic,amlogic-rtc.yaml
>> new file mode 100644
>> index 000000000000..128c60b623e1
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/rtc/amlogic,amlogic-rtc.yaml
> 
> That's odd filename. Use compatible as the filename.
> 

Will do, rename "amlogic,a4-rtc.yaml".

>> @@ -0,0 +1,66 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +# Copyright (C) 2024 Amlogic, Inc. All rights reserved
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/rtc/amlogic,amlogic-rtc.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Amlogic Real Time Clock controller include a4, a5
> 
> Sorry, that's unparseable. Either this is clock controller or RTC. What
> does it mean "include a4"?
> 

Will describe it to "title: Amlogic  A4 and A5 RTC".


> 
>> +
>> +maintainers:
>> +  - Yiting Deng <[e-mail]>
>> +  - Xianwei Zhao <[e-mail]>
>> +
>> +description:
>> +  The Amlogic new chips used RTC module.
> 
> This tells me nothing. Please say something useful or drop this.
> 

Will drop description.

> Best regards,
> Krzysztof
>

Patch

diff --git a/Documentation/devicetree/bindings/rtc/amlogic,amlogic-rtc.yaml b/Documentation/devicetree/bindings/rtc/amlogic,amlogic-rtc.yaml
new file mode 100644
index 000000000000..128c60b623e1
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/amlogic,amlogic-rtc.yaml
@@ -0,0 +1,66 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (C) 2024 Amlogic, Inc. All rights reserved
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/amlogic,amlogic-rtc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Amlogic Real Time Clock controller include a4, a5
+
+maintainers:
+  - Yiting Deng <[e-mail]>
+  - Xianwei Zhao <[e-mail]>
+
+description:
+  The Amlogic new chips used RTC module.
+
+allOf:
+  - $ref: rtc.yaml#
+
+properties:
+  compatible:
+    enum:
+      - amlogic,a4-rtc
+      - amlogic,a5-rtc
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    items:
+      - description: RTC clock source, available 24M or 32K crystal
+          oscillator source. when using 24M, need to divide 24M into 32K.
+      - description: RTC module accesses the clock of the apb bus.
+
+  clock-names:
+    items:
+      - const: osc
+      - const: sys
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+  - clock-names
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    apb {
+        #address-cells = <2>;
+        #size-cells = <2>;
+
+        rtc@8e600 {
+            compatible = "amlogic,a4-rtc";
+            reg = <0x0 0x8e600 0x0 0x38>;
+            interrupts = <GIC_SPI 131 IRQ_TYPE_EDGE_RISING>;
+            clocks = <&xtal_32k>, <&clkc_periphs 1>;
+            clock-names = "osc", "sys";
+        };
+    };