Re: [PATCH 1/2] dt-bindings: rtc: Add Spreadtrum SC27xx RTC documentation

[Alexandre Belloni]

Hi,

On 07/11/2017 at 19:34:07 +0800, Baolin Wang wrote:
> This patch adds the binding documentation for Spreadtrum SC27xx series
> RTC device.
> 
> Signed-off-by: Baolin Wang <baolin.wang@xxxxxxxxxxxxxx>
> ---
>  .../devicetree/bindings/rtc/sprd,sc27xx-rtc.txt    |   16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/rtc/sprd,sc27xx-rtc.txt
> 
> diff --git a/Documentation/devicetree/bindings/rtc/sprd,sc27xx-rtc.txt b/Documentation/devicetree/bindings/rtc/sprd,sc27xx-rtc.txt
> new file mode 100644
> index 0000000..971d3a2
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/sprd,sc27xx-rtc.txt
> @@ -0,0 +1,16 @@
> +Spreadtrum SC27xx Real Time Clock
> +
> +Required properties:
> +- compatible: should be "sprd,sc27xx-rtc".

Don't use wildcards in a compatible, use a specific chip model. later
chips may or may not be compatible with that one.

> +- reg: address offset of rtc register.
> +- interrupt-parent: phandle for the interrupt controller.
> +- interrupts: rtc alarm interrupt.
> +
> +Example:
> +
> +	rtc: rtc@280 {

The rtc: alias is probably useless

> +		compatible = "sprd,sc27xx-rtc";
> +		reg = <0x280>;
> +		interrupt-parent = <&pmic>;
> +		interrupts = <2 IRQ_TYPE_LEVEL_HIGH>;
> +	};

I would include the parent MFD node too.


-- 
Alexandre Belloni, Free Electrons
Embedded Linux and Kernel engineering
http://free-electrons.com