diff mbox series

[V3,1/1] dt-bindings: rtc: add atcrtc100 Real Time Clock

Message ID 20241104144053.1136083-2-cl634@andestech.com
State Superseded
Headers show
Series dt-bindings: rtc: atcrtc100: add Andes atcrtc100 | expand

Commit Message

CL Wang Nov. 4, 2024, 2:40 p.m. UTC
Document devicetree bindings for the Andes atcrtc100 Real Time Clock.

Signed-off-by: CL Wang <cl634@andestech.com>
---
 .../bindings/rtc/andestech,atcrtc100.yaml     | 44 +++++++++++++++++++
 MAINTAINERS                                   |  1 +
 2 files changed, 45 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/rtc/andestech,atcrtc100.yaml

Comments

Krzysztof Kozlowski Nov. 4, 2024, 2:47 p.m. UTC | #1
On 04/11/2024 15:40, CL Wang wrote:
> Document devicetree bindings for the Andes atcrtc100 Real Time Clock.
> 
> Signed-off-by: CL Wang <cl634@andestech.com>
> ---

What changed? Explain in details.

In the future, please provide changelog under '---' or in cover letter.

Where is the driver? Why this is sent separately?

>  .../bindings/rtc/andestech,atcrtc100.yaml     | 44 +++++++++++++++++++
>  MAINTAINERS                                   |  1 +
>  2 files changed, 45 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/rtc/andestech,atcrtc100.yaml
> 

...

> diff --git a/MAINTAINERS b/MAINTAINERS
> index 10342c0fa599..372d7ea53c98 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -3357,6 +3357,7 @@ F:	include/linux/mfd/atc260x/*
>  ATCRTC100 RTC DRIVER
>  M:	CL Wang <cl634@andestech.com>
>  S:	Supported
> +F:	Documentation/devicetree/bindings/rtc/andestech,atcrtc100.yaml
>  F:	drivers/rtc/rtc-atcrtc100.c

There is no such file.


Best regards,
Krzysztof
Alexandre Belloni Nov. 4, 2024, 8:50 p.m. UTC | #2
On 04/11/2024 22:40:53+0800, CL Wang wrote:
> Document devicetree bindings for the Andes atcrtc100 Real Time Clock.
> 
> Signed-off-by: CL Wang <cl634@andestech.com>
> ---
>  .../bindings/rtc/andestech,atcrtc100.yaml     | 44 +++++++++++++++++++
>  MAINTAINERS                                   |  1 +
>  2 files changed, 45 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/rtc/andestech,atcrtc100.yaml
> 
> diff --git a/Documentation/devicetree/bindings/rtc/andestech,atcrtc100.yaml b/Documentation/devicetree/bindings/rtc/andestech,atcrtc100.yaml
> new file mode 100644
> index 000000000000..cf99cff76734
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/andestech,atcrtc100.yaml
> @@ -0,0 +1,44 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/andestech,atcrtc100.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Andes ATCRTC100 Real-Time Clock
> +
> +maintainers:
> +  - CL Wang <cl634@andestech.com>
> +
> +allOf:
> +  - $ref: rtc.yaml#
> +
> +properties:
> +  compatible:
> +    enum:
> +      - andestech,atcrtc100
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    items:
> +      - description: Periodic timekeeping interrupt
> +      - description: RTC alarm interrupt
> +
> +  wakeup-source: true

The driver misuses this property. wakeup-source is mutually exclusive
with the alarm interrupt. The driver requires both interrupts to be
present so the property is useless (which is expected as the interrupt
lines are always connected to the CPU)

> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    rtc@f0300000 {
> +        compatible = "andestech,atcrtc100";
> +        reg = <0xf0300000 0x100>;
> +        interrupts = <1>, <2>;
> +        wakeup-source;
> +    };
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 10342c0fa599..372d7ea53c98 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -3357,6 +3357,7 @@ F:	include/linux/mfd/atc260x/*
>  ATCRTC100 RTC DRIVER
>  M:	CL Wang <cl634@andestech.com>
>  S:	Supported
> +F:	Documentation/devicetree/bindings/rtc/andestech,atcrtc100.yaml
>  F:	drivers/rtc/rtc-atcrtc100.c
>  
>  ATHEROS 71XX/9XXX GPIO DRIVER
> -- 
> 2.34.1
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/rtc/andestech,atcrtc100.yaml b/Documentation/devicetree/bindings/rtc/andestech,atcrtc100.yaml
new file mode 100644
index 000000000000..cf99cff76734
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/andestech,atcrtc100.yaml
@@ -0,0 +1,44 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/andestech,atcrtc100.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Andes ATCRTC100 Real-Time Clock
+
+maintainers:
+  - CL Wang <cl634@andestech.com>
+
+allOf:
+  - $ref: rtc.yaml#
+
+properties:
+  compatible:
+    enum:
+      - andestech,atcrtc100
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    items:
+      - description: Periodic timekeeping interrupt
+      - description: RTC alarm interrupt
+
+  wakeup-source: true
+
+required:
+  - compatible
+  - reg
+  - interrupts
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    rtc@f0300000 {
+        compatible = "andestech,atcrtc100";
+        reg = <0xf0300000 0x100>;
+        interrupts = <1>, <2>;
+        wakeup-source;
+    };
diff --git a/MAINTAINERS b/MAINTAINERS
index 10342c0fa599..372d7ea53c98 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -3357,6 +3357,7 @@  F:	include/linux/mfd/atc260x/*
 ATCRTC100 RTC DRIVER
 M:	CL Wang <cl634@andestech.com>
 S:	Supported
+F:	Documentation/devicetree/bindings/rtc/andestech,atcrtc100.yaml
 F:	drivers/rtc/rtc-atcrtc100.c
 
 ATHEROS 71XX/9XXX GPIO DRIVER