lists.openwall.net   lists  /  announce  owl-users  owl-dev  john-users  john-dev  passwdqc-users  yescrypt  popa3d-users  /  oss-security  kernel-hardening  musl  sabotage  tlsify  passwords  /  crypt-dev  xvendor  /  Bugtraq  Full-Disclosure  linux-kernel  linux-netdev  linux-ext4  linux-hardening  linux-cve-announce  PHC 
Open Source and information security mailing list archives
 
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Date:   Tue, 3 Mar 2020 08:17:22 +0000
From:   Benjamin GAIGNARD <benjamin.gaignard@...com>
To:     Rob Herring <robh@...nel.org>
CC:     "dmitry.torokhov@...il.com" <dmitry.torokhov@...il.com>,
        "mark.rutland@....com" <mark.rutland@....com>,
        "lee.jones@...aro.org" <lee.jones@...aro.org>,
        "lgirdwood@...il.com" <lgirdwood@...il.com>,
        "broonie@...nel.org" <broonie@...nel.org>,
        "wim@...ux-watchdog.org" <wim@...ux-watchdog.org>,
        "linux@...ck-us.net" <linux@...ck-us.net>,
        "Pascal PAILLET-LME" <p.paillet@...com>,
        "linux-input@...r.kernel.org" <linux-input@...r.kernel.org>,
        "devicetree@...r.kernel.org" <devicetree@...r.kernel.org>,
        "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
        "linux-watchdog@...r.kernel.org" <linux-watchdog@...r.kernel.org>
Subject: Re: [PATCH v4] dt-bindings: mfd: Convert stpmic1 bindings to
 json-schema



On 3/3/20 2:39 AM, Rob Herring wrote:
> On Fri, Feb 28, 2020 at 11:58:09AM +0100, Benjamin Gaignard wrote:
>> Convert stpmic1 bindings to json-schema.
>>
>> Signed-off-by: Benjamin Gaignard <benjamin.gaignard@...com>
>> ---
>> version 4:
>> - move on uppder node $ref: ../regulator/regulator.yaml
>> - move fixed strings under properties field
>> - remove unneeded () in patternProperties
>> - keep ldo3 separate from other ldo properties
>> Note:
>> - 'st,mask-reset' property stay in each subnode, I don't find
>>    the syntax to avoid dupliquate it.
>> - ldo6-supply and all possible *-supply are describe by this regular
>>    expression: ^(buck[1-4]|ldo[1-6]|boost|pwr_sw[1-2])-supply$":
>>
>> version 3:
>> - put $ref under allOf keyword
>> - for each regulator node add the list of supported regulator properties
>>
>>   .../devicetree/bindings/input/st,stpmic1-onkey.txt |  28 --
>>   .../devicetree/bindings/mfd/st,stpmic1.txt         |  61 ----
>>   .../devicetree/bindings/mfd/st,stpmic1.yaml        | 338 +++++++++++++++++++++
>>   .../bindings/regulator/st,stpmic1-regulator.txt    |  64 ----
>>   .../bindings/watchdog/st,stpmic1-wdt.txt           |  11 -
>>   5 files changed, 338 insertions(+), 164 deletions(-)
>>   delete mode 100644 Documentation/devicetree/bindings/input/st,stpmic1-onkey.txt
>>   delete mode 100644 Documentation/devicetree/bindings/mfd/st,stpmic1.txt
>>   create mode 100644 Documentation/devicetree/bindings/mfd/st,stpmic1.yaml
>>   delete mode 100644 Documentation/devicetree/bindings/regulator/st,stpmic1-regulator.txt
>>   delete mode 100644 Documentation/devicetree/bindings/watchdog/st,stpmic1-wdt.txt
>>
>> diff --git a/Documentation/devicetree/bindings/input/st,stpmic1-onkey.txt b/Documentation/devicetree/bindings/input/st,stpmic1-onkey.txt
>> deleted file mode 100644
>> index eb8e83736c02..000000000000
>> --- a/Documentation/devicetree/bindings/input/st,stpmic1-onkey.txt
>> +++ /dev/null
>> @@ -1,28 +0,0 @@
>> -STMicroelectronics STPMIC1 Onkey
>> -
>> -Required properties:
>> -
>> -- compatible = "st,stpmic1-onkey";
>> -- interrupts: interrupt line to use
>> -- interrupt-names = "onkey-falling", "onkey-rising"
>> -	onkey-falling: happens when onkey is pressed; IT_PONKEY_F of pmic
>> -	onkey-rising: happens when onkey is released; IT_PONKEY_R of pmic
>> -
>> -Optional properties:
>> -
>> -- st,onkey-clear-cc-flag: onkey is able power on after an
>> -  over-current shutdown event.
>> -- st,onkey-pu-inactive: onkey pull up is not active
>> -- power-off-time-sec: Duration in seconds which the key should be kept
>> -        pressed for device to power off automatically (from 1 to 16 seconds).
>> -        see See Documentation/devicetree/bindings/input/input.yaml
>> -
>> -Example:
>> -
>> -onkey {
>> -	compatible = "st,stpmic1-onkey";
>> -	interrupt-parent = <&pmic>;
>> -	interrupts = <IT_PONKEY_F 0>,<IT_PONKEY_R 1>;
>> -	interrupt-names = "onkey-falling", "onkey-rising";
>> -	power-off-time-sec = <10>;
>> -};
>> diff --git a/Documentation/devicetree/bindings/mfd/st,stpmic1.txt b/Documentation/devicetree/bindings/mfd/st,stpmic1.txt
>> deleted file mode 100644
>> index afd45c089585..000000000000
>> --- a/Documentation/devicetree/bindings/mfd/st,stpmic1.txt
>> +++ /dev/null
>> @@ -1,61 +0,0 @@
>> -* STMicroelectronics STPMIC1 Power Management IC
>> -
>> -Required properties:
>> -- compatible:		: "st,stpmic1"
>> -- reg:			: The I2C slave address for the STPMIC1 chip.
>> -- interrupts:		: The interrupt line the device is connected to.
>> -- #interrupt-cells:	: Should be 1.
>> -- interrupt-controller:	: Marks the device node as an interrupt controller.
>> -			    Interrupt numbers are defined at
>> -			    dt-bindings/mfd/st,stpmic1.h.
>> -
>> -STPMIC1 consists in a varied group of sub-devices.
>> -Each sub-device binding is be described in own documentation file.
>> -
>> -Device			 Description
>> -------			------------
>> -st,stpmic1-onkey	: Power on key, see ../input/st,stpmic1-onkey.txt
>> -st,stpmic1-regulators	: Regulators, see ../regulator/st,stpmic1-regulator.txt
>> -st,stpmic1-wdt		: Watchdog, see ../watchdog/st,stpmic1-wdt.txt
>> -
>> -Example:
>> -
>> -#include <dt-bindings/mfd/st,stpmic1.h>
>> -
>> -pmic: pmic@33 {
>> -	compatible = "st,stpmic1";
>> -	reg = <0x33>;
>> -	interrupt-parent = <&gpioa>;
>> -	interrupts = <0 2>;
>> -
>> -	interrupt-controller;
>> -	#interrupt-cells = <2>;
>> -
>> -	onkey {
>> -		compatible = "st,stpmic1-onkey";
>> -		interrupts = <IT_PONKEY_F 0>,<IT_PONKEY_R 1>;
>> -		interrupt-names = "onkey-falling", "onkey-rising";
>> -		power-off-time-sec = <10>;
>> -	};
>> -
>> -	watchdog {
>> -		compatible = "st,stpmic1-wdt";
>> -	};
>> -
>> -	regulators {
>> -		compatible = "st,stpmic1-regulators";
>> -
>> -		vdd_core: buck1 {
>> -			regulator-name = "vdd_core";
>> -			regulator-boot-on;
>> -			regulator-min-microvolt = <700000>;
>> -			regulator-max-microvolt = <1200000>;
>> -		};
>> -		vdd: buck3 {
>> -			regulator-name = "vdd";
>> -			regulator-min-microvolt = <3300000>;
>> -			regulator-max-microvolt = <3300000>;
>> -			regulator-boot-on;
>> -			regulator-pull-down;
>> -		};
>> -	};
>> diff --git a/Documentation/devicetree/bindings/mfd/st,stpmic1.yaml b/Documentation/devicetree/bindings/mfd/st,stpmic1.yaml
>> new file mode 100644
>> index 000000000000..e9adcd04a48d
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/mfd/st,stpmic1.yaml
>> @@ -0,0 +1,338 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/mfd/st,stpmic1.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: STMicroelectonics STPMIC1 Power Management IC bindings
>> +
>> +description: STMicroelectronics STPMIC1 Power Management IC
>> +
>> +maintainers:
>> +  - pascal Paillet <p.paillet@...com>
>> +
>> +properties:
>> +  compatible:
>> +    const: st,stpmic1
>> +
>> +  reg:
>> +    const: 0x33
>> +
>> +  interrupts:
>> +    maxItems: 1
>> +
>> +  "#interrupt-cells":
>> +    const: 2
>> +
>> +  interrupt-controller: true
>> +
>> +  onkey:
>> +    type: object
>> +
>> +    allOf:
>> +      - $ref: ../input/input.yaml
>> +
>> +    properties:
>> +      compatible:
>> +        const: st,stpmic1-onkey
>> +
>> +      interrupts:
>> +        items:
>> +          - description: onkey-falling, happens when onkey is pressed. IT_PONKEY_F of pmic
>> +          - description: onkey-rising, happens when onkey is released. IT_PONKEY_R of pmic
>> +
>> +      interrupt-names:
>> +        items:
>> +          - const: onkey-falling
>> +          - const: onkey-rising
>> +
>> +      st,onkey-clear-cc-flag:
>> +        description: onkey is able power on after an over-current shutdown event.
>> +        $ref: /schemas/types.yaml#/definitions/flag
>> +
>> +      st,onkey-pu-inactive:
>> +        description: onkey pull up is not active
>> +        $ref: /schemas/types.yaml#/definitions/flag
>> +
>> +      power-off-time-sec:
>> +        minimum: 1
>> +        maximum: 16
>> +
>> +    required:
>> +      - compatible
>> +      - interrupts
>> +      - interrupt-names
>> +
>> +    additionalProperties: false
>> +
>> +  watchdog:
>> +    type: object
>> +
>> +    allOf:
>> +      - $ref: ../watchdog/watchdog.yaml
>> +
>> +    properties:
>> +      compatible:
>> +        const: st,stpmic1-wdt
>> +
>> +      timeout-sec: true
>> +
>> +    required:
>> +      - compatible
>> +
>> +    additionalProperties: false
>> +
>> +  regulators:
>> +    type: object
>> +
>> +    allOf:
>> +      - $ref: ../regulator/regulator.yaml
> Sigh. Haven't I already said this was at the wrong level once before?
>
> My suggestion was to put this under
> "^(buck[1-4]|ldo[1-6]|boost|pwr_sw[1-2])-supply$".
Yes but "^(buck[1-4]|ldo[1-6]|boost|pwr_sw[1-2])-supply$" node doesn't 
need regulators properties.
Only the nodes without '-supply' need these properties and they are at 
the same level than the -supply nodes.
I have put the reference to the regulator upper as I can.

>
>> +
>> +    description: |
>> +      Available Regulators in STPMIC1 device are:
>> +        - buck1 for Buck BUCK1
>> +        - buck2 for Buck BUCK2
>> +        - buck3 for Buck BUCK3
>> +        - buck4 for Buck BUCK4
>> +        - ldo1 for LDO LDO1
>> +        - ldo2 for LDO LDO2
>> +        - ldo3 for LDO LDO3
>> +        - ldo4 for LDO LDO4
>> +        - ldo5 for LDO LDO5
>> +        - ldo6 for LDO LDO6
>> +        - vref_ddr for LDO Vref DDR
>> +        - boost for Buck BOOST
>> +        - pwr_sw1 for VBUS_OTG switch
>> +        - pwr_sw2 for SW_OUT switch
>> +      Switches are fixed voltage regulators with only enable/disable capability.
>> +
>> +    properties:
>> +      compatible:
>> +        const: st,stpmic1-regulators
>> +
>> +      ldo3:
>> +        type: object
>> +
>> +        properties:
>> +          interrupts:
>> +            maxItems: 1
>> +
>> +          st,mask-reset:
>> +            description: mask reset for this regulator,
>> +                         the regulator configuration is maintained during pmic reset.
>> +            $ref: /schemas/types.yaml#/definitions/flag
>> +
>> +          regulator-name: true
>> +          regulator-boot-on: true
>> +          regulator-always-on: true
>> +          regulator-min-microvolt: true
>> +          regulator-max-microvolt: true
>> +          regulator-allow-bypass: true
>> +          regulator-over-current-protection: true
>> +
>> +        additionalProperties: false
>> +
>> +      ldo4:
>> +        type: object
>> +
>> +        properties:
>> +          interrupts:
>> +            maxItems: 1
>> +
>> +          st,mask-reset:
>> +            description: mask reset for this regulator,
>> +                         the regulator configuration is maintained during pmic reset.
>> +            $ref: /schemas/types.yaml#/definitions/flag
>> +
>> +          regulator-name: true
>> +          regulator-boot-on: true
>> +          regulator-always-on: true
>> +          regulator-over-current-protection: true
>> +
>> +        additionalProperties: false
>> +
>> +    patternProperties:
>> +      "^(buck[1-4]|ldo[1-6]|boost|pwr_sw[1-2])-supply$":
>> +        description: STPMIC1 voltage regulators supplies
>> +
>> +      "^ldo[1-2,5-6]$":
>> +        type: object
>> +
>> +        properties:
>> +          interrupts:
>> +            maxItems: 1
>> +
>> +          st,mask-reset:
>> +            description: mask reset for this regulator,
>> +                         the regulator configuration is maintained during pmic reset.
>> +            $ref: /schemas/types.yaml#/definitions/flag
> Move all these to a single definition under
> "^(buck[1-4]|ldo[1-6]|boost|pwr_sw[1-2])-supply$" and just do
> 'st,mask-reset: true' here.
Same here.
>
>> +
>> +          regulator-name: true
>> +          regulator-boot-on: true
>> +          regulator-always-on: true
>> +          regulator-min-microvolt: true
>> +          regulator-max-microvolt: true
>> +          regulator-over-current-protection: true
>> +          regulator-enable-ramp-delay: true
>> +
>> +        additionalProperties: false
>> +
>> +      "^buck[1-4]$":
>> +        type: object
>> +
>> +        properties:
>> +          interrupts:
>> +            maxItems: 1
>> +
>> +          st,mask-reset:
>> +            description: mask reset for this regulator,
>> +                         the regulator configuration is maintained during pmic reset.
>> +            $ref: /schemas/types.yaml#/definitions/flag
>> +
>> +          regulator-name: true
>> +          regulator-boot-on: true
>> +          regulator-always-on: true
>> +          regulator-min-microvolt: true
>> +          regulator-max-microvolt: true
>> +          regulator-initial-mode: true
>> +          regulator-pull-down: true
>> +          regulator-over-current-protection: true
>> +          regulator-enable-ramp-delay: true
>> +
>> +        additionalProperties: false
>> +
>> +      "^vref_ddr$":
> Not a pattern.
I will fix that in v5
>
>> +        type: object
>> +
>> +        properties:
>> +          interrupts:
>> +            maxItems: 1
>> +
>> +          st,mask-reset:
>> +            description: mask reset for this regulator,
>> +                         the regulator configuration is maintained during pmic reset.
>> +            $ref: /schemas/types.yaml#/definitions/flag
>> +
>> +          regulator-name: true
>> +          regulator-boot-on: true
>> +          regulator-always-on: true
>> +
>> +        additionalProperties: false
>> +
>> +      "^boost$":
> And neither is this...
Ok
>
>> +        type: object
>> +
>> +        properties:
>> +          interrupts:
>> +            maxItems: 1
>> +
>> +          st,mask-reset:
>> +            description: mask reset for this regulator,
>> +                         the regulator configuration is maintained during pmic reset.
>> +            $ref: /schemas/types.yaml#/definitions/flag
>> +
>> +          regulator-name: true
>> +          regulator-boot-on: true
>> +          regulator-always-on: true
>> +          regulator-over-current-protection: true
>> +
>> +        additionalProperties: false
>> +
>> +      "^pwr_sw[1-2]$":
>> +        type: object
>> +
>> +        properties:
>> +          interrupts:
>> +            maxItems: 1
>> +
>> +          regulator-name: true
>> +          regulator-boot-on: true
>> +          regulator-always-on: true
>> +          regulator-over-current-protection: true
>> +          regulator-active-discharge: true
>> +
>> +        additionalProperties: false
>> +
>> +    required:
>> +      - compatible
>> +
>> +    additionalProperties: false
>> +
>> +  additionalProperties: false
>> +
>> +additionalProperties: false
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - interrupts
>> +  - "#interrupt-cells"
>> +  - interrupt-controller
>> +
>> +examples:
>> +  - |
>> +    #include <dt-bindings/mfd/st,stpmic1.h>
>> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
>> +    i2c@0 {
>> +      #address-cells = <1>;
>> +      #size-cells = <0>;
>> +      pmic@33 {
>> +        compatible = "st,stpmic1";
>> +        reg = <0x33>;
>> +        interrupt-parent = <&gpioa>;
>> +        interrupts = <0 2>;
>> +
>> +        interrupt-controller;
>> +        #interrupt-cells = <2>;
>> +
>> +        onkey {
>> +          compatible = "st,stpmic1-onkey";
>> +          interrupts = <IT_PONKEY_F 0>,<IT_PONKEY_R 1>;
>> +          interrupt-names = "onkey-falling", "onkey-rising";
>> +          power-off-time-sec = <10>;
>> +        };
>> +
>> +        watchdog {
>> +          compatible = "st,stpmic1-wdt";
>> +        };
>> +
>> +        regulators {
>> +          compatible = "st,stpmic1-regulators";
>> +
>> +          ldo6-supply = <&v3v3>;
>> +
>> +          buck1 {
>> +            regulator-name = "vdd_core";
>> +            interrupts = <IT_CURLIM_BUCK1 0>;
>> +            st,mask-reset;
>> +            regulator-boot-on;
>> +            regulator-min-microvolt = <700000>;
>> +            regulator-max-microvolt = <1200000>;
>> +          };
>> +
>> +          buck3 {
>> +            regulator-name = "vdd";
>> +            regulator-min-microvolt = <3300000>;
>> +            regulator-max-microvolt = <3300000>;
>> +            regulator-boot-on;
>> +            regulator-pull-down;
>> +          };
>> +
>> +          buck4 {
>> +            regulator-name = "v3v3";
>> +            interrupts = <IT_CURLIM_BUCK4 0>;
>> +            regulator-min-microvolt = <3300000>;
>> +            regulator-max-microvolt = <3300000>;
>> +          };
>> +
>> +          ldo6 {
>> +            regulator-name = "v1v8";
>> +            regulator-min-microvolt = <1800000>;
>> +            regulator-max-microvolt = <1800000>;
>> +            regulator-over-current-protection;
>> +          };
>> +        };
>> +      };
>> +    };
>> +
>> +...
>> diff --git a/Documentation/devicetree/bindings/regulator/st,stpmic1-regulator.txt b/Documentation/devicetree/bindings/regulator/st,stpmic1-regulator.txt
>> deleted file mode 100644
>> index 6189df71ea98..000000000000
>> --- a/Documentation/devicetree/bindings/regulator/st,stpmic1-regulator.txt
>> +++ /dev/null
>> @@ -1,64 +0,0 @@
>> -STMicroelectronics STPMIC1 Voltage regulators
>> -
>> -Regulator Nodes are optional depending on needs.
>> -
>> -Available Regulators in STPMIC1 device are:
>> -  - buck1 for Buck BUCK1
>> -  - buck2 for Buck BUCK2
>> -  - buck3 for Buck BUCK3
>> -  - buck4 for Buck BUCK4
>> -  - ldo1 for LDO LDO1
>> -  - ldo2 for LDO LDO2
>> -  - ldo3 for LDO LDO3
>> -  - ldo4 for LDO LDO4
>> -  - ldo5 for LDO LDO5
>> -  - ldo6 for LDO LDO6
>> -  - vref_ddr for LDO Vref DDR
>> -  - boost for Buck BOOST
>> -  - pwr_sw1 for VBUS_OTG switch
>> -  - pwr_sw2 for SW_OUT switch
>> -
>> -Switches are fixed voltage regulators with only enable/disable capability.
>> -
>> -Optional properties:
>> -- st,mask-reset: mask reset for this regulator: the regulator configuration
>> -  is maintained during pmic reset.
>> -- regulator-over-current-protection:
>> -    if set, all regulators are switched off in case of over-current detection
>> -    on this regulator,
>> -    if not set, the driver only sends an over-current event.
>> -- interrupts: index of current limit detection interrupt
>> -- <regulator>-supply: phandle to the parent supply/regulator node
>> -	each regulator supply can be described except vref_ddr.
>> -- regulator-active-discharge: can be used on pwr_sw1 and pwr_sw2.
>> -
>> -Example:
>> -regulators {
>> -	compatible = "st,stpmic1-regulators";
>> -
>> -	ldo6-supply = <&v3v3>;
>> -
>> -	vdd_core: buck1 {
>> -		regulator-name = "vdd_core";
>> -		interrupts = <IT_CURLIM_BUCK1 0>;
>> -		st,mask-reset;
>> -		regulator-pull-down;
>> -		regulator-min-microvolt = <700000>;
>> -		regulator-max-microvolt = <1200000>;
>> -	};
>> -
>> -	v3v3: buck4 {
>> -		regulator-name = "v3v3";
>> -		interrupts = <IT_CURLIM_BUCK4 0>;
>> -
>> -		regulator-min-microvolt = <3300000>;
>> -		regulator-max-microvolt = <3300000>;
>> -	};
>> -
>> -	v1v8: ldo6 {
>> -		regulator-name = "v1v8";
>> -		regulator-min-microvolt = <1800000>;
>> -		regulator-max-microvolt = <1800000>;
>> -		regulator-over-current-protection;
>> -	};
>> -};
>> diff --git a/Documentation/devicetree/bindings/watchdog/st,stpmic1-wdt.txt b/Documentation/devicetree/bindings/watchdog/st,stpmic1-wdt.txt
>> deleted file mode 100644
>> index 7cc1407f15cb..000000000000
>> --- a/Documentation/devicetree/bindings/watchdog/st,stpmic1-wdt.txt
>> +++ /dev/null
>> @@ -1,11 +0,0 @@
>> -STMicroelectronics STPMIC1 Watchdog
>> -
>> -Required properties:
>> -
>> -- compatible : should be "st,stpmic1-wdt"
>> -
>> -Example:
>> -
>> -watchdog {
>> -	compatible = "st,stpmic1-wdt";
>> -};
>> -- 
>> 2.15.0
>>

Powered by blists - more mailing lists

Powered by Openwall GNU/*/Linux Powered by OpenVZ