mbox series

[v2,0/4] dt-bindings: power: reset: at91: convert to YAML

Message ID 20230524123528.439082-1-claudiu.beznea@microchip.com
Headers show
Series dt-bindings: power: reset: at91: convert to YAML | expand

Message

Claudiu Beznea May 24, 2023, 12:35 p.m. UTC
Hi,

Series convert AT91 shutdown controllers documentation to YAML.
Along with it device trees were updated and also entries to
MAINTAINERS with documentation files.

Thank you,
Claudiu

Changes in v2:
- use minimum, maximum on uint32 enums instead of all possible values
- change commit description for patch 3/4 to explain why there is a
  syscon along with microchip,sama7g5-shdwc
- remove | near description entries

Claudiu Beznea (4):
  ARM: dts: at91: use generic name for shutdown controller
  dt-bindings: power: reset: atmel,at91sam9260-shdwc: convert to yaml
  dt-bindings: power: reset: atmel,sama5d2-shdwc: convert to yaml
  MAINTAINERS: add documentation file for Microchip SAMA5D2 shutdown
    controller

 .../devicetree/bindings/arm/atmel-sysregs.txt |  94 --------------
 .../power/reset/atmel,at91sam9260-shdwc.yaml  |  82 +++++++++++++
 .../power/reset/atmel,sama5d2-shdwc.yaml      | 115 ++++++++++++++++++
 MAINTAINERS                                   |   1 +
 arch/arm/boot/dts/at91-qil_a9260.dts          |   2 +-
 arch/arm/boot/dts/at91-sama5d27_som1_ek.dts   |   2 +-
 arch/arm/boot/dts/at91-sama5d2_ptc_ek.dts     |   2 +-
 arch/arm/boot/dts/at91-sama5d2_xplained.dts   |   2 +-
 arch/arm/boot/dts/at91sam9260.dtsi            |   2 +-
 arch/arm/boot/dts/at91sam9260ek.dts           |   2 +-
 arch/arm/boot/dts/at91sam9261.dtsi            |   2 +-
 arch/arm/boot/dts/at91sam9263.dtsi            |   2 +-
 arch/arm/boot/dts/at91sam9g20ek_common.dtsi   |   2 +-
 arch/arm/boot/dts/at91sam9g45.dtsi            |   2 +-
 arch/arm/boot/dts/at91sam9n12.dtsi            |   2 +-
 arch/arm/boot/dts/at91sam9rl.dtsi             |   2 +-
 arch/arm/boot/dts/at91sam9x5.dtsi             |   2 +-
 arch/arm/boot/dts/sam9x60.dtsi                |   2 +-
 arch/arm/boot/dts/sama5d2.dtsi                |   2 +-
 arch/arm/boot/dts/sama5d3.dtsi                |   2 +-
 arch/arm/boot/dts/sama5d4.dtsi                |   2 +-
 arch/arm/boot/dts/sama7g5.dtsi                |   2 +-
 arch/arm/boot/dts/usb_a9260.dts               |   2 +-
 arch/arm/boot/dts/usb_a9263.dts               |   2 +-
 24 files changed, 218 insertions(+), 114 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/power/reset/atmel,at91sam9260-shdwc.yaml
 create mode 100644 Documentation/devicetree/bindings/power/reset/atmel,sama5d2-shdwc.yaml

Comments

Krzysztof Kozlowski June 2, 2023, 2:53 p.m. UTC | #1
On 24/05/2023 14:35, Claudiu Beznea wrote:
> Convert Atmel SAMA5D2 shutdown controller to YAML. SAMA7G5 SHDWC DT node
> (available in arch/arm/boot/dts/sama7g5.dtsi) has syscon along with its
> compatible. There is no usage of this syscon in the current code but it
> may be necessary in future as some registers of SHDWC are accessed in
> different drivers (at91-sama5d2_shdwc.c and arch/arm/mach-at91/pm.c).
> Thus update the YAML with it to make DT checkers happy.
> 



> +---
> +$id: http://devicetree.org/schemas/power/reset/atmel,sama5d2-shdwc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Atmel SAMA5D2 SHDWC Shutdown Controller
> +
> +maintainers:
> +  - Claudiu Beznea <claudiu.beznea@microchip.com>
> +
> +description:
> +  Atmel SHDWC shutdown controller controls the power supplies VDDIO and VDDCORE
> +  and the wake-up detection on debounced input lines.
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - items:
> +          - const: microchip,sama7g5-shdwc
> +          - const: syscon
> +      - items:

These are not items, but just enum. This could not work as intended.

> +          enum:
> +            - atmel,sama5d2-shdwc
> +            - microchip,sam9x60-shdwc
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  "#address-cells":
> +    const: 1
> +
> +  "#size-cells":
> +    const: 0
> +
> +  debounce-delay-us:
> +    description:
> +      Minimum wake-up inputs debouncer period in microseconds. It is usually a
> +      board-related property.
> +
> +  atmel,wakeup-rtc-timer:
> +    description: enable real-time clock wake-up
> +    type: boolean
> +
> +patternProperties:
> +  "^input@[0-15]$":
> +    description:
> +      Wake-up input nodes. These are usually described in the "board" part of
> +      the Device Tree. Note also that input 0 is linked to the wake-up pin and
> +      is frequently used.
> +    type: object
> +    properties:
> +      reg:
> +        description: contains the wake-up input index
> +        minimum: 0
> +        maximum: 15
> +
> +      atmel,wakeup-active-high:
> +        description:
> +          The corresponding wake-up input described by the child forces the
> +          wake-up of the core power supply on a high level. The default is to
> +          be active low.
> +        type: boolean
> +
> +    required:
> +      - reg
> +
> +    additionalProperties: false
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +
> +allOf:
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - microchip,sam9x60-shdwc
> +              - microchip,sama7g5-shdwc
> +    then:
> +      properties:
> +        atmel,wakeup-rtt-timer:
> +          description: enable real-time timer wake-up
> +          type: boolean

Don't define properties in allOf. This should be in top-level.


Missing additionalProperties: false.

Best regards,
Krzysztof
Rob Herring June 7, 2023, 8:43 p.m. UTC | #2
On Wed, May 24, 2023 at 08:19:08PM +0100, Conor Dooley wrote:
> On Wed, May 24, 2023 at 03:35:27PM +0300, Claudiu Beznea wrote:
> > Convert Atmel SAMA5D2 shutdown controller to YAML. SAMA7G5 SHDWC DT node
> > (available in arch/arm/boot/dts/sama7g5.dtsi) has syscon along with its
> > compatible. There is no usage of this syscon in the current code but it
> > may be necessary in future as some registers of SHDWC are accessed in
> > different drivers (at91-sama5d2_shdwc.c and arch/arm/mach-at91/pm.c).
> > Thus update the YAML with it to make DT checkers happy.
> > 
> > Signed-off-by: Claudiu Beznea <claudiu.beznea@microchip.com>
> 
> Modulo the license thing that I mentioned on v1,

Should be fine given it's an Microchip employee changing a Microchip 
binding.

Rob
Conor Dooley June 7, 2023, 8:48 p.m. UTC | #3
On Wed, Jun 07, 2023 at 02:43:51PM -0600, Rob Herring wrote:
> On Wed, May 24, 2023 at 08:19:08PM +0100, Conor Dooley wrote:
> > On Wed, May 24, 2023 at 03:35:27PM +0300, Claudiu Beznea wrote:
> > > Convert Atmel SAMA5D2 shutdown controller to YAML. SAMA7G5 SHDWC DT node
> > > (available in arch/arm/boot/dts/sama7g5.dtsi) has syscon along with its
> > > compatible. There is no usage of this syscon in the current code but it
> > > may be necessary in future as some registers of SHDWC are accessed in
> > > different drivers (at91-sama5d2_shdwc.c and arch/arm/mach-at91/pm.c).
> > > Thus update the YAML with it to make DT checkers happy.
> > > 
> > > Signed-off-by: Claudiu Beznea <claudiu.beznea@microchip.com>
> > 
> > Modulo the license thing that I mentioned on v1,
> 
> Should be fine given it's an Microchip employee changing a Microchip 
> binding.

Aye, that part I figured was fine - it was the when I looked at the
blame for the files & they were filled with your name that I wondered
about the licensing.
If you're okay with it though then clearly there's not an issue :)

Cheers,
Conor.
Conor Dooley June 8, 2023, 4:49 p.m. UTC | #4
On Thu, Jun 08, 2023 at 08:38:10AM -0600, Rob Herring wrote:

> For reference, anything done by Arm, Linaro or NVIDIA employees is
> okay to relicense to dual license.

Ah cool, that's good to know, thanks.
Perhaps I should try to get a similar edict issued for Microchip ones.
@Nicolas, does that sound reasonable?

Cheers,
Conor.
Nicolas Ferre June 9, 2023, 10:09 a.m. UTC | #5
On 08/06/2023 at 18:49, Conor Dooley wrote:
> 
> On Thu, Jun 08, 2023 at 08:38:10AM -0600, Rob Herring wrote:
> 
>> For reference, anything done by Arm, Linaro or NVIDIA employees is
>> okay to relicense to dual license.
> Ah cool, that's good to know, thanks.
> Perhaps I should try to get a similar edict issued for Microchip ones.
> @Nicolas, does that sound reasonable?

Well, we can work it out internally, indeed. But is there a public 
statement about this somewhere?

Regards,
   Nicolas
Conor Dooley June 13, 2023, 6:44 p.m. UTC | #6
On Fri, Jun 09, 2023 at 12:09:24PM +0200, Nicolas Ferre wrote:
> On 08/06/2023 at 18:49, Conor Dooley wrote:
> > 
> > On Thu, Jun 08, 2023 at 08:38:10AM -0600, Rob Herring wrote:
> > 
> > > For reference, anything done by Arm, Linaro or NVIDIA employees is
> > > okay to relicense to dual license.
> > Ah cool, that's good to know, thanks.
> > Perhaps I should try to get a similar edict issued for Microchip ones.
> > @Nicolas, does that sound reasonable?
> 
> Well, we can work it out internally, indeed. But is there a public statement
> about this somewhere?

You mean, is there a public statement about Arm/Linaro/Nvidia being okay
with relicensing bindings as dual license?
Conor Dooley July 10, 2023, 5:12 p.m. UTC | #7
Hey Nicolas,

On Tue, Jun 13, 2023 at 07:44:58PM +0100, Conor Dooley wrote:
> On Fri, Jun 09, 2023 at 12:09:24PM +0200, Nicolas Ferre wrote:
> > On 08/06/2023 at 18:49, Conor Dooley wrote:
> > > 
> > > On Thu, Jun 08, 2023 at 08:38:10AM -0600, Rob Herring wrote:
> > > 
> > > > For reference, anything done by Arm, Linaro or NVIDIA employees is
> > > > okay to relicense to dual license.
> > > Ah cool, that's good to know, thanks.
> > > Perhaps I should try to get a similar edict issued for Microchip ones.
> > > @Nicolas, does that sound reasonable?
> > 
> > Well, we can work it out internally, indeed. But is there a public statement
> > about this somewhere?
> 
> You mean, is there a public statement about Arm/Linaro/Nvidia being okay
> with relicensing bindings as dual license?

This was sitting at the end of my queue, don't recall following this up
internally. Getting an edict might be more hassle than it is worth & I
guess I am always CCed on bindings to Ack them.