Re: [PATCH v2] dt-bindings: serial: Move omap-serial.txt to YAML schema

[Vignesh Raghavendra <vigneshr@ti.com>]

On 6/18/21 8:28 PM, Rob Herring wrote:
> On Thu, Jun 10, 2021 at 12:22 PM Vignesh Raghavendra <vigneshr@ti.com> wrote:
>>
>> Convert serial-omap.txt to YAML schema for better checks and documentation.
>>
>> Signed-off-by: Vignesh Raghavendra <vigneshr@ti.com>
>> ---
>>
>> v2:
>> *Drop reg-io-width and reg-shift as they are constant and documented in
>>  txt bindings (also not used by driver).
>> *Drop unused label in example.
>> *Rename file to 8250_omap.yaml to be more generic as IP is present in
>> varies families of TI SoCs.
>> *Add description for interrupt entries
>>
>>  .../devicetree/bindings/serial/8250_omap.yaml | 118 ++++++++++++++++++
>>  .../bindings/serial/omap_serial.txt           |  40 ------
>>  2 files changed, 118 insertions(+), 40 deletions(-)
>>  create mode 100644 Documentation/devicetree/bindings/serial/8250_omap.yaml
>>  delete mode 100644 Documentation/devicetree/bindings/serial/omap_serial.txt
>>
>> diff --git a/Documentation/devicetree/bindings/serial/8250_omap.yaml b/Documentation/devicetree/bindings/serial/8250_omap.yaml
>> new file mode 100644
>> index 000000000000..1c826fcf5828
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/serial/8250_omap.yaml
>> @@ -0,0 +1,118 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/serial/8250_omap.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Bindings for 8250 compliant UARTs on TI's OMAP2+ and K3 SoCs
>> +
>> +maintainers:
>> +  - Vignesh Raghavendra <vigneshr@ti.com>
>> +
>> +allOf:
>> +  - $ref: /schemas/serial/serial.yaml#
>> +  - $ref: /schemas/serial/rs485.yaml#
>> +
>> +properties:
>> +  compatible:
>> +    oneOf:
>> +      - enum:
>> +          - ti,am3352-uart
>> +          - ti,am4372-uart
>> +          - ti,am654-uart
>> +          - ti,dra742-uart
>> +          - ti,omap2-uart
>> +          - ti,omap3-uart
>> +          - ti,omap4-uart
>> +      - items:
>> +          - enum:
>> +              - ti,am64-uart
>> +              - ti,j721e-uart
>> +          - const: ti,am654-uart
>> +
>> +  ti,hwmods:
>> +    description:
>> +      Must be "uart<n>", n being the instance number (1-based)
>> +      This property is applicable only on legacy platforms mainly omap2/3
>> +      and ti81xx and should not be used on other platforms.
>> +    $ref: /schemas/types.yaml#/definitions/string
>> +    deprecated: true
>> +
>> +  dmas:
>> +    minItems: 1
>> +    maxItems: 2
>> +
>> +  dma-names:
>> +    items:
>> +      - const: tx
>> +      - const: rx
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  interrupts:
>> +    minItems: 1
>> +    maxItems: 2
>> +    description:
>> +      First entry is module IRQ required for normal IO operation.
>> +      Second entry is optional and corresponds to system wakeup IRQ
>> +      where supported.
> 
> interrupts:
>   minItems: 1
>   items:
>     - description: module IRQ required for normal IO operation
>     - description: system wakeup IRQ
> 

OK, will send a follow up fix as the patch is already queued.

>> +
>> +  clocks:
>> +    maxItems: 1
>> +
>> +  clock-names:
>> +    const: fclk
>> +
>> +  rts-gpios: true
>> +  cts-gpios: true
>> +  dtr-gpios: true
>> +  dsr-gpios: true
>> +  rng-gpios: true
>> +  dcd-gpios: true
>> +  rs485-rts-delay: true
>> +  rs485-rts-active-low: true
>> +  rs485-rx-during-tx: true
>> +  rs485-rts-active-high: true
>> +  linux,rs485-enabled-at-boot-time: true
>> +  rts-gpio: true
>> +  power-domains: true
>> +  clock-frequency: true
>> +  current-speed: true
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - interrupts
>> +
>> +additionalProperties: false
> 
> Do you want to support serial attached devices? If so, you need:
> 
> unevaluatedProperties: false
> 

Yes, support for serial client devices is desired, but I see that with
"unevaluatedProperties: false" there are no warnings if DT has a
property not documented in the schema? Did I miss something?

> You can also drop listing all the inherited properties from the
> included schemas.

Yes, this can be done with "unevaluatedProperties: false".

Regards
Vignesh