[PATCH v7 1/2] dt-bindings: soc: starfive: Add StarFive syscon doc

[William Qiu]

On 2023/4/7 2:30, Krzysztof Kozlowski wrote:
> On 06/04/2023 12:33, William Qiu wrote:
>> Add documentation to describe StarFive System Controller Registers.
> 
> Subject: drop second/last, redundant "doc". The "dt-bindings" prefix is
> already stating that these are documentation files.
> 
Will fix.
>> 
>> Signed-off-by: William Qiu <william.qiu at starfivetech.com>
>> ---
>>  .../soc/starfive/starfive,jh7110-syscon.yaml  | 56 +++++++++++++++++++
>>  MAINTAINERS                                   |  5 ++
>>  2 files changed, 61 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/soc/starfive/starfive,jh7110-syscon.yaml
>> 
>> diff --git a/Documentation/devicetree/bindings/soc/starfive/starfive,jh7110-syscon.yaml b/Documentation/devicetree/bindings/soc/starfive/starfive,jh7110-syscon.yaml
>> new file mode 100644
>> index 000000000000..0d0319426b67
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/soc/starfive/starfive,jh7110-syscon.yaml
>> @@ -0,0 +1,56 @@
>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/soc/starfive/starfive,jh7110-syscon.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: StarFive JH7110 SoC system controller
>> +
>> +maintainers:
>> +  - William Qiu <william.qiu at starfivetech.com>
>> +
>> +description: |
>> +  The StarFive JH7110 SoC system controller provides register information such
>> +  as offset, mask and shift to configure related modules such as MMC and PCIe.
>> +
>> +properties:
>> +  compatible:
>> +    oneOf:
>> +      - items:
>> +          - enum:
>> +              - starfive,jh7110-aon-syscon
>> +              - starfive,jh7110-sys-syscon
>> +          - const: syscon
>> +          - const: simple-mfd
>> +      - items:
>> +          - const: starfive,jh7110-stg-syscon
>> +          - const: syscon
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  clock-controller:
>> +    type: object
> 
> This should be rather specific schema, so $ref.
> 

This would be $ref: /schemas/clock/starfive,jh7110-pll.yaml#, but this file is not
available at present,  so I would like to ask if I should submit the documents
instead of Xingyu


>> +
>> +  power-controller:
>> +    type: object
> 
Will fix, it would be $ref: /schemas/power/starfive,jh7110-pmu.yaml#.

Best regards,
William
> Same problem.
> 
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    syscon at 10240000 {
>> +        compatible = "starfive,jh7110-stg-syscon", "syscon";
>> +        reg = <0x10240000 0x1000>;
>> +    };
>> +
>> +    syscon at 13030000 {
>> +        compatible = "starfive,jh7110-sys-syscon", "syscon", "simple-mfd";
>> +        reg = <0x13030000 0x1000>;
>> +    };
> Best regards,
> Krzysztof
>