[PATCH v2 6/7] dt-bindings: mfd: syscon: Split and enforce documenting MFD children

[Krzysztof Kozlowski]

On 17/06/2024 18:44, Conor Dooley wrote:
>> +$id: http://devicetree.org/schemas/mfd/syscon-common.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: System Controller Registers R/W Common Properties
>> +
>> +description: |
> 
> This | can go, right?

Ack

> 
>> +  System controller node represents a register region containing a set
>> +  of miscellaneous registers. The registers are not cohesive enough to
>> +  represent as any specific type of device. The typical use-case is
>> +  for some other node's driver, or platform-specific code, to acquire
>> +  a reference to the syscon node (e.g. by phandle, node path, or
>> +  search using a specific compatible value), interrogate the node (or
>> +  associated OS driver) to determine the location of the registers,
>> +  and access the registers directly.
>> +
>> +maintainers:
>> +  - Lee Jones <lee at kernel.org>
>> +
>> +select:
>> +  properties:
>> +    compatible:
>> +      contains:
>> +        enum:
> 
> And this can be const, given it's unlikely to grow?

ack

> 
>> +          - syscon
>> +
>> +  required:
>> +    - compatible
>> +
>> +properties:
>> +  compatible:
>> +    contains:
>> +      const: syscon
>> +    minItems: 2
>> +    maxItems: 5  # Should be enough
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  reg-io-width:
>> +    description: |
> 
> Same with this one.

ack

> 
>> +      The size (in bytes) of the IO accesses that should be performed
>> +      on the device.
>> +    enum: [1, 2, 4, 8]
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +
>> +allOf:
>> +  - if:
>> +      properties:
>> +        compatible:
>> +          contains:
>> +            const: simple-mfd
>> +    then:
>> +      properties:
>> +        compatible:
>> +          minItems: 3
>> +          maxItems: 5
>> +
>> +additionalProperties: true
>> +
>> +examples:
>> +  - |
>> +    syscon: syscon at 1c00000 {
>> +        compatible = "allwinner,sun8i-h3-system-controller", "syscon";
>> +        reg = <0x01c00000 0x1000>;
>> +    };
>> +...
>> diff --git a/Documentation/devicetree/bindings/mfd/syscon.yaml b/Documentation/devicetree/bindings/mfd/syscon.yaml
>> index d6fa58c9e4de..d4e9533cf3fe 100644
>> --- a/Documentation/devicetree/bindings/mfd/syscon.yaml
>> +++ b/Documentation/devicetree/bindings/mfd/syscon.yaml
>> @@ -4,7 +4,7 @@
>>  $id: http://devicetree.org/schemas/mfd/syscon.yaml#
>>  $schema: http://devicetree.org/meta-schemas/core.yaml#
>>  
>> -title: System Controller Registers R/W
>> +title: System Controller Devices
>>  
>>  description: |
>>    System controller node represents a register region containing a set
>> @@ -19,123 +19,196 @@ description: |
>>  maintainers:
>>    - Lee Jones <lee at kernel.org>
>>  
>> +# Need a select with all compatibles listed for compatibility with older
>> +# dtschema (<2024.02), so this will not be selected for other schemas having
>> +# syscon fallback.
>>  select:
>>    properties:
>>      compatible:
>>        contains:
>>          enum:
>> -          - syscon
> 
> Wow, this is noisy. Is it not possible to achieve something similar by
> making the select check for not: compatible: contains: simple-mfd? Or
> did I misunderstand the intention here?

See comment from Rob for v1. This is needed for older schema, although
2024.02 worked fine in my tests. The point is to select all schemas, not
by compatible property, because then we match this schema to anything
having syscon.

Kind of similar how it is woth arm,primecell.



Best regards,
Krzysztof