[PATCH 04/10] dt-bindings: treewide: add feature-domains description in binding files

[Gatien CHEVALLIER]

On 7/7/23 16:07, Oleksii Moisieiev wrote:
> 
> Gatien Chevallier <gatien.chevallier at foss.st.com> writes:
> 
>> feature-domains is an optional property that allows a peripheral to
>> refer to one or more feature domain controller(s).
>>
>> Description of this property is added to all peripheral binding files of
>> the peripheral under the STM32 firewall controllers. It allows an accurate
>> representation of the hardware, where various peripherals are connected
>> to this firewall bus. The firewall can then check the peripheral accesses
>> before allowing it to probe.
>>
>> Signed-off-by: Gatien Chevallier <gatien.chevallier at foss.st.com>
>> ---
>>
>> Disclaimer: Some error with dtbs_check will be observed as I've
>> considered the property to be generic, as Rob asked
>>
>>   Documentation/devicetree/bindings/crypto/st,stm32-hash.yaml  | 4 ++++
>>   Documentation/devicetree/bindings/dma/st,stm32-dma.yaml      | 4 ++++
>>   Documentation/devicetree/bindings/dma/st,stm32-dmamux.yaml   | 4 ++++
>>   Documentation/devicetree/bindings/i2c/st,stm32-i2c.yaml      | 4 ++++
>>   Documentation/devicetree/bindings/iio/adc/st,stm32-adc.yaml  | 4 ++++
>>   .../devicetree/bindings/iio/adc/st,stm32-dfsdm-adc.yaml      | 4 ++++
>>   Documentation/devicetree/bindings/iio/dac/st,stm32-dac.yaml  | 4 ++++
>>   .../devicetree/bindings/media/cec/st,stm32-cec.yaml          | 4 ++++
>>   Documentation/devicetree/bindings/media/st,stm32-dcmi.yaml   | 4 ++++
>>   .../bindings/memory-controllers/st,stm32-fmc2-ebi.yaml       | 4 ++++
>>   Documentation/devicetree/bindings/mfd/st,stm32-lptimer.yaml  | 4 ++++
>>   Documentation/devicetree/bindings/mfd/st,stm32-timers.yaml   | 5 +++++
>>   Documentation/devicetree/bindings/mmc/arm,pl18x.yaml         | 4 ++++
>>   Documentation/devicetree/bindings/net/stm32-dwmac.yaml       | 4 ++++
>>   Documentation/devicetree/bindings/phy/phy-stm32-usbphyc.yaml | 4 ++++
>>   .../devicetree/bindings/regulator/st,stm32-vrefbuf.yaml      | 4 ++++
>>   Documentation/devicetree/bindings/rng/st,stm32-rng.yaml      | 4 ++++
>>   Documentation/devicetree/bindings/serial/st,stm32-uart.yaml  | 4 ++++
>>   Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml    | 4 ++++
>>   Documentation/devicetree/bindings/sound/st,stm32-sai.yaml    | 4 ++++
>>   .../devicetree/bindings/sound/st,stm32-spdifrx.yaml          | 4 ++++
>>   Documentation/devicetree/bindings/spi/st,stm32-qspi.yaml     | 4 ++++
>>   Documentation/devicetree/bindings/spi/st,stm32-spi.yaml      | 4 ++++
>>   Documentation/devicetree/bindings/usb/dwc2.yaml              | 4 ++++
>>   24 files changed, 97 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/crypto/st,stm32-hash.yaml b/Documentation/devicetree/bindings/crypto/st,stm32-hash.yaml
>> index b767ec72a999..daf8dcaef627 100644
>> --- a/Documentation/devicetree/bindings/crypto/st,stm32-hash.yaml
>> +++ b/Documentation/devicetree/bindings/crypto/st,stm32-hash.yaml
>> @@ -50,6 +50,10 @@ properties:
>>     power-domains:
>>       maxItems: 1
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
> 
> I beliewe feature-domains is generic binding. This means that maxItems
> can be implementation dependend. I would rather drop maxItems so the
> following format will be possible:
> 
>            feature-domains = <&etzpc 1>, <&etzpc 2>, <&some_other_domain 1 2 3 4>
>            feature-domain-names = "firewall 1", "firewall 2", "other_domain"
> 

I'd prefer to drop the maxItems as well. I've been told at one point in
the first series to choose a number for this maybe picking a high but
reasonnable number is preferrable.

Based on How to Get Your DT Schema Bindings Accepted in Less than 10 
Iterations pdf published by Krzysztof, I see that examples use
minItems/maxItems. But I can't find if it's mandatory


> Also I beliewe driver will handle feature-domain-names property so it
> will parse feature-domains only related to the firewall.
> 

Yep, in case of multiple feature-domains, it could be nice.

>>   required:
>>     - compatible
>>     - reg
>> diff --git a/Documentation/devicetree/bindings/dma/st,stm32-dma.yaml b/Documentation/devicetree/bindings/dma/st,stm32-dma.yaml
>> index 329847ef096a..2236ac95574b 100644
>> --- a/Documentation/devicetree/bindings/dma/st,stm32-dma.yaml
>> +++ b/Documentation/devicetree/bindings/dma/st,stm32-dma.yaml
>> @@ -82,6 +82,10 @@ properties:
>>       description: if defined, it indicates that the controller
>>         supports memory-to-memory transfer
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   required:
>>     - compatible
>>     - reg
>> diff --git a/Documentation/devicetree/bindings/dma/st,stm32-dmamux.yaml b/Documentation/devicetree/bindings/dma/st,stm32-dmamux.yaml
>> index e722fbcd8a5f..47ae890f5bd9 100644
>> --- a/Documentation/devicetree/bindings/dma/st,stm32-dmamux.yaml
>> +++ b/Documentation/devicetree/bindings/dma/st,stm32-dmamux.yaml
>> @@ -28,6 +28,10 @@ properties:
>>     resets:
>>       maxItems: 1
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   required:
>>     - compatible
>>     - reg
>> diff --git a/Documentation/devicetree/bindings/i2c/st,stm32-i2c.yaml b/Documentation/devicetree/bindings/i2c/st,stm32-i2c.yaml
>> index 94b75d9f66cd..326a96741f50 100644
>> --- a/Documentation/devicetree/bindings/i2c/st,stm32-i2c.yaml
>> +++ b/Documentation/devicetree/bindings/i2c/st,stm32-i2c.yaml
>> @@ -99,6 +99,10 @@ properties:
>>   
>>     wakeup-source: true
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   required:
>>     - compatible
>>     - reg
>> diff --git a/Documentation/devicetree/bindings/iio/adc/st,stm32-adc.yaml b/Documentation/devicetree/bindings/iio/adc/st,stm32-adc.yaml
>> index 995cbf8cefc6..3eb20d67f0fc 100644
>> --- a/Documentation/devicetree/bindings/iio/adc/st,stm32-adc.yaml
>> +++ b/Documentation/devicetree/bindings/iio/adc/st,stm32-adc.yaml
>> @@ -93,6 +93,10 @@ properties:
>>     '#size-cells':
>>       const: 0
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   allOf:
>>     - if:
>>         properties:
>> diff --git a/Documentation/devicetree/bindings/iio/adc/st,stm32-dfsdm-adc.yaml b/Documentation/devicetree/bindings/iio/adc/st,stm32-dfsdm-adc.yaml
>> index 1970503389aa..bc34ae172417 100644
>> --- a/Documentation/devicetree/bindings/iio/adc/st,stm32-dfsdm-adc.yaml
>> +++ b/Documentation/devicetree/bindings/iio/adc/st,stm32-dfsdm-adc.yaml
>> @@ -59,6 +59,10 @@ properties:
>>         If not, SPI CLKOUT frequency will not be accurate.
>>       maximum: 20000000
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   required:
>>     - compatible
>>     - reg
>> diff --git a/Documentation/devicetree/bindings/iio/dac/st,stm32-dac.yaml b/Documentation/devicetree/bindings/iio/dac/st,stm32-dac.yaml
>> index 04045b932bd2..90d35a2a6504 100644
>> --- a/Documentation/devicetree/bindings/iio/dac/st,stm32-dac.yaml
>> +++ b/Documentation/devicetree/bindings/iio/dac/st,stm32-dac.yaml
>> @@ -45,6 +45,10 @@ properties:
>>     '#size-cells':
>>       const: 0
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   additionalProperties: false
>>   
>>   required:
>> diff --git a/Documentation/devicetree/bindings/media/cec/st,stm32-cec.yaml b/Documentation/devicetree/bindings/media/cec/st,stm32-cec.yaml
>> index 2314a9a14650..f88e3c0e6175 100644
>> --- a/Documentation/devicetree/bindings/media/cec/st,stm32-cec.yaml
>> +++ b/Documentation/devicetree/bindings/media/cec/st,stm32-cec.yaml
>> @@ -29,6 +29,10 @@ properties:
>>         - const: cec
>>         - const: hdmi-cec
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   required:
>>     - compatible
>>     - reg
>> diff --git a/Documentation/devicetree/bindings/media/st,stm32-dcmi.yaml b/Documentation/devicetree/bindings/media/st,stm32-dcmi.yaml
>> index 6b3e413cedb2..4fa1d14910df 100644
>> --- a/Documentation/devicetree/bindings/media/st,stm32-dcmi.yaml
>> +++ b/Documentation/devicetree/bindings/media/st,stm32-dcmi.yaml
>> @@ -36,6 +36,10 @@ properties:
>>     resets:
>>       maxItems: 1
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>     port:
>>       $ref: /schemas/graph.yaml#/$defs/port-base
>>       unevaluatedProperties: false
>> diff --git a/Documentation/devicetree/bindings/memory-controllers/st,stm32-fmc2-ebi.yaml b/Documentation/devicetree/bindings/memory-controllers/st,stm32-fmc2-ebi.yaml
>> index 14f1833d37c9..63b3d012147b 100644
>> --- a/Documentation/devicetree/bindings/memory-controllers/st,stm32-fmc2-ebi.yaml
>> +++ b/Documentation/devicetree/bindings/memory-controllers/st,stm32-fmc2-ebi.yaml
>> @@ -45,6 +45,10 @@ properties:
>>         Reflects the memory layout with four integer values per bank. Format:
>>         <bank-number> 0 <address of the bank> <size>
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   patternProperties:
>>     "^.*@[0-4],[a-f0-9]+$":
>>       additionalProperties: true
>> diff --git a/Documentation/devicetree/bindings/mfd/st,stm32-lptimer.yaml b/Documentation/devicetree/bindings/mfd/st,stm32-lptimer.yaml
>> index 27329c5dc38e..59d770544950 100644
>> --- a/Documentation/devicetree/bindings/mfd/st,stm32-lptimer.yaml
>> +++ b/Documentation/devicetree/bindings/mfd/st,stm32-lptimer.yaml
>> @@ -44,6 +44,10 @@ properties:
>>   
>>     wakeup-source: true
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>     pwm:
>>       type: object
>>       additionalProperties: false
>> diff --git a/Documentation/devicetree/bindings/mfd/st,stm32-timers.yaml b/Documentation/devicetree/bindings/mfd/st,stm32-timers.yaml
>> index f84e09a5743b..d5ad097e94ec 100644
>> --- a/Documentation/devicetree/bindings/mfd/st,stm32-timers.yaml
>> +++ b/Documentation/devicetree/bindings/mfd/st,stm32-timers.yaml
>> @@ -67,6 +67,11 @@ properties:
>>     "#size-cells":
>>       const: 0
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>> +
>>     pwm:
>>       type: object
>>       additionalProperties: false
>> diff --git a/Documentation/devicetree/bindings/mmc/arm,pl18x.yaml b/Documentation/devicetree/bindings/mmc/arm,pl18x.yaml
>> index 2459a55ed540..6ebedee65153 100644
>> --- a/Documentation/devicetree/bindings/mmc/arm,pl18x.yaml
>> +++ b/Documentation/devicetree/bindings/mmc/arm,pl18x.yaml
>> @@ -79,6 +79,10 @@ properties:
>>             - const: rx
>>             - const: tx
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>     power-domains: true
>>   
>>     resets:
>> diff --git a/Documentation/devicetree/bindings/net/stm32-dwmac.yaml b/Documentation/devicetree/bindings/net/stm32-dwmac.yaml
>> index fc8c96b08d7d..0e408dc85c13 100644
>> --- a/Documentation/devicetree/bindings/net/stm32-dwmac.yaml
>> +++ b/Documentation/devicetree/bindings/net/stm32-dwmac.yaml
>> @@ -93,6 +93,10 @@ properties:
>>         select RCC clock instead of ETH_REF_CLK.
>>       type: boolean
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   required:
>>     - compatible
>>     - clocks
>> diff --git a/Documentation/devicetree/bindings/phy/phy-stm32-usbphyc.yaml b/Documentation/devicetree/bindings/phy/phy-stm32-usbphyc.yaml
>> index 24a3dbde223b..b9ac20c8bf05 100644
>> --- a/Documentation/devicetree/bindings/phy/phy-stm32-usbphyc.yaml
>> +++ b/Documentation/devicetree/bindings/phy/phy-stm32-usbphyc.yaml
>> @@ -55,6 +55,10 @@ properties:
>>       description: number of clock cells for ck_usbo_48m consumer
>>       const: 0
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   # Required child nodes:
>>   
>>   patternProperties:
>> diff --git a/Documentation/devicetree/bindings/regulator/st,stm32-vrefbuf.yaml b/Documentation/devicetree/bindings/regulator/st,stm32-vrefbuf.yaml
>> index 05f4ad2c7d3a..02cefe4ef42b 100644
>> --- a/Documentation/devicetree/bindings/regulator/st,stm32-vrefbuf.yaml
>> +++ b/Documentation/devicetree/bindings/regulator/st,stm32-vrefbuf.yaml
>> @@ -30,6 +30,10 @@ properties:
>>     vdda-supply:
>>       description: phandle to the vdda input analog voltage.
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   required:
>>     - compatible
>>     - reg
>> diff --git a/Documentation/devicetree/bindings/rng/st,stm32-rng.yaml b/Documentation/devicetree/bindings/rng/st,stm32-rng.yaml
>> index 187b172d0cca..79eb5f5bd252 100644
>> --- a/Documentation/devicetree/bindings/rng/st,stm32-rng.yaml
>> +++ b/Documentation/devicetree/bindings/rng/st,stm32-rng.yaml
>> @@ -30,6 +30,10 @@ properties:
>>       type: boolean
>>       description: If set enable the clock detection management
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   required:
>>     - compatible
>>     - reg
>> diff --git a/Documentation/devicetree/bindings/serial/st,stm32-uart.yaml b/Documentation/devicetree/bindings/serial/st,stm32-uart.yaml
>> index 1df8ffe95fc6..893978e7170f 100644
>> --- a/Documentation/devicetree/bindings/serial/st,stm32-uart.yaml
>> +++ b/Documentation/devicetree/bindings/serial/st,stm32-uart.yaml
>> @@ -70,6 +70,10 @@ properties:
>>       enum: [1, 2, 4, 8, 12, 14, 16]
>>       default: 8
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   allOf:
>>     - $ref: rs485.yaml#
>>     - $ref: serial.yaml#
>> diff --git a/Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml b/Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml
>> index b9111d375b93..64c5898e51f8 100644
>> --- a/Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml
>> +++ b/Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml
>> @@ -65,6 +65,10 @@ properties:
>>       $ref: audio-graph-port.yaml#
>>       unevaluatedProperties: false
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   required:
>>     - compatible
>>     - "#sound-dai-cells"
>> diff --git a/Documentation/devicetree/bindings/sound/st,stm32-sai.yaml b/Documentation/devicetree/bindings/sound/st,stm32-sai.yaml
>> index 56d206f97a96..9bc08b7645dc 100644
>> --- a/Documentation/devicetree/bindings/sound/st,stm32-sai.yaml
>> +++ b/Documentation/devicetree/bindings/sound/st,stm32-sai.yaml
>> @@ -48,6 +48,10 @@ properties:
>>     clock-names:
>>       maxItems: 3
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   required:
>>     - compatible
>>     - reg
>> diff --git a/Documentation/devicetree/bindings/sound/st,stm32-spdifrx.yaml b/Documentation/devicetree/bindings/sound/st,stm32-spdifrx.yaml
>> index bc48151b9adb..f00e5db9ee3b 100644
>> --- a/Documentation/devicetree/bindings/sound/st,stm32-spdifrx.yaml
>> +++ b/Documentation/devicetree/bindings/sound/st,stm32-spdifrx.yaml
>> @@ -50,6 +50,10 @@ properties:
>>     resets:
>>       maxItems: 1
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   required:
>>     - compatible
>>     - "#sound-dai-cells"
>> diff --git a/Documentation/devicetree/bindings/spi/st,stm32-qspi.yaml b/Documentation/devicetree/bindings/spi/st,stm32-qspi.yaml
>> index 8bba965a9ae6..2ac136802467 100644
>> --- a/Documentation/devicetree/bindings/spi/st,stm32-qspi.yaml
>> +++ b/Documentation/devicetree/bindings/spi/st,stm32-qspi.yaml
>> @@ -46,6 +46,10 @@ properties:
>>         - const: tx
>>         - const: rx
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   required:
>>     - compatible
>>     - reg
>> diff --git a/Documentation/devicetree/bindings/spi/st,stm32-spi.yaml b/Documentation/devicetree/bindings/spi/st,stm32-spi.yaml
>> index 9ca1a843c820..725c26daabe4 100644
>> --- a/Documentation/devicetree/bindings/spi/st,stm32-spi.yaml
>> +++ b/Documentation/devicetree/bindings/spi/st,stm32-spi.yaml
>> @@ -59,6 +59,10 @@ properties:
>>         - const: rx
>>         - const: tx
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   patternProperties:
>>     "^[a-zA-Z][a-zA-Z0-9,+\\-._]{0,63}@[0-9a-f]+$":
>>       type: object
>> diff --git a/Documentation/devicetree/bindings/usb/dwc2.yaml b/Documentation/devicetree/bindings/usb/dwc2.yaml
>> index d3506090f8b1..c372caf154fc 100644
>> --- a/Documentation/devicetree/bindings/usb/dwc2.yaml
>> +++ b/Documentation/devicetree/bindings/usb/dwc2.yaml
>> @@ -171,6 +171,10 @@ properties:
>>   
>>     tpl-support: true
>>   
>> +  feature-domains:
>> +    minItems: 1
>> +    maxItems: 3
>> +
>>   dependencies:
>>     port: [ usb-role-switch ]
>>     role-switch-default-mode: [ usb-role-switch ]
> 
>