[v5,02/10] dt-bindings: rtc: mediatek: convert MT6397 rtc documentation
Commit Message
- Convert rtc/rtc-mt6397.txt to rtc/mt6397-rtc.yaml
- Add maintainer
- Remove the .txt binding file
Signed-off-by: Alexandre Mergnat <amergnat@baylibre.com>
---
Documentation/devicetree/bindings/mfd/mt6397.txt | 2 +-
.../bindings/rtc/mediatek,mt6397-rtc.yaml | 43 ++++++++++++++++++++++
.../devicetree/bindings/rtc/rtc-mt6397.txt | 31 ----------------
3 files changed, 44 insertions(+), 32 deletions(-)
Comments
On Wed, Nov 16, 2022 at 01:32:56PM +0100, Alexandre Mergnat wrote:
> - Convert rtc/rtc-mt6397.txt to rtc/mt6397-rtc.yaml
> - Add maintainer
> - Remove the .txt binding file
>
> Signed-off-by: Alexandre Mergnat <amergnat@baylibre.com>
> ---
> Documentation/devicetree/bindings/mfd/mt6397.txt | 2 +-
> .../bindings/rtc/mediatek,mt6397-rtc.yaml | 43 ++++++++++++++++++++++
> .../devicetree/bindings/rtc/rtc-mt6397.txt | 31 ----------------
> 3 files changed, 44 insertions(+), 32 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/mfd/mt6397.txt b/Documentation/devicetree/bindings/mfd/mt6397.txt
> index 0088442efca1..79aaf21af8e9 100644
> --- a/Documentation/devicetree/bindings/mfd/mt6397.txt
> +++ b/Documentation/devicetree/bindings/mfd/mt6397.txt
> @@ -33,7 +33,7 @@ Optional subnodes:
> - compatible: "mediatek,mt6331-rtc"
> - compatible: "mediatek,mt6358-rtc"
> - compatible: "mediatek,mt6397-rtc"
> - For details, see ../rtc/rtc-mt6397.txt
> + For details, see ../rtc/mediatek,mt6397-rtc.yaml
> - regulators
> Required properties:
> - compatible: "mediatek,mt6323-regulator"
> diff --git a/Documentation/devicetree/bindings/rtc/mediatek,mt6397-rtc.yaml b/Documentation/devicetree/bindings/rtc/mediatek,mt6397-rtc.yaml
> new file mode 100644
> index 000000000000..f5a323597f1d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/mediatek,mt6397-rtc.yaml
> @@ -0,0 +1,43 @@
> + # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/rtc/mediatek,mt6397-rtc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: MediaTek MT6397/MT6366/MT6358/MT6323 RTC
> +
> +maintainers:
> + - Tianping Fang <tianping.fang@mediatek.com>
> + - Alexandre Mergnat <amergnat@baylibre.com>
> +
> +description: |
Don't need '|' if no formatting.
> + MediaTek PMIC based RTC is an independent function of MediaTek PMIC that works
> + as a type of multi-function device (MFD). The RTC can be configured and set up
> + with PMIC wrapper bus which is a common resource shared with the other
> + functions found on the same PMIC.
> +
> +allOf:
> + - $ref: rtc.yaml#
> +
> +properties:
> + compatible:
> + enum:
> + - mediatek,mt6323-rtc
> + - mediatek,mt6358-rtc
> + - mediatek,mt6366-rtc
> + - mediatek,mt6397-rtc
> +
> + start-year: true
> +
> +additionalProperties: false
> +
> +required:
> + - compatible
> +
> +examples:
> + - |
> + pmic {
> + rtc {
> + compatible = "mediatek,mt6397-rtc";
> + };
> + };
Please drop the example here. Just one complete example in the MFD
schema.
@@ -33,7 +33,7 @@ Optional subnodes:
- compatible: "mediatek,mt6331-rtc"
- compatible: "mediatek,mt6358-rtc"
- compatible: "mediatek,mt6397-rtc"
- For details, see ../rtc/rtc-mt6397.txt
+ For details, see ../rtc/mediatek,mt6397-rtc.yaml
- regulators
Required properties:
- compatible: "mediatek,mt6323-regulator"
new file mode 100644
@@ -0,0 +1,43 @@
+ # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/mediatek,mt6397-rtc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: MediaTek MT6397/MT6366/MT6358/MT6323 RTC
+
+maintainers:
+ - Tianping Fang <tianping.fang@mediatek.com>
+ - Alexandre Mergnat <amergnat@baylibre.com>
+
+description: |
+ MediaTek PMIC based RTC is an independent function of MediaTek PMIC that works
+ as a type of multi-function device (MFD). The RTC can be configured and set up
+ with PMIC wrapper bus which is a common resource shared with the other
+ functions found on the same PMIC.
+
+allOf:
+ - $ref: rtc.yaml#
+
+properties:
+ compatible:
+ enum:
+ - mediatek,mt6323-rtc
+ - mediatek,mt6358-rtc
+ - mediatek,mt6366-rtc
+ - mediatek,mt6397-rtc
+
+ start-year: true
+
+additionalProperties: false
+
+required:
+ - compatible
+
+examples:
+ - |
+ pmic {
+ rtc {
+ compatible = "mediatek,mt6397-rtc";
+ };
+ };
deleted file mode 100644
@@ -1,31 +0,0 @@
-Device-Tree bindings for MediaTek PMIC based RTC
-
-MediaTek PMIC based RTC is an independent function of MediaTek PMIC that works
-as a type of multi-function device (MFD). The RTC can be configured and set up
-with PMIC wrapper bus which is a common resource shared with the other
-functions found on the same PMIC.
-
-For MediaTek PMIC MFD bindings, see:
-../mfd/mt6397.txt
-
-For MediaTek PMIC wrapper bus bindings, see:
-../soc/mediatek/pwrap.txt
-
-Required properties:
-- compatible: Should be one of follows
- "mediatek,mt6323-rtc": for MT6323 PMIC
- "mediatek,mt6358-rtc": for MT6358 PMIC
- "mediatek,mt6366-rtc", "mediatek,mt6358-rtc": for MT6366 PMIC
- "mediatek,mt6397-rtc": for MT6397 PMIC
-
-Example:
-
- pmic {
- compatible = "mediatek,mt6323";
-
- ...
-
- rtc {
- compatible = "mediatek,mt6323-rtc";
- };
- };