Message-ID: <20251024-judicious-raven-of-economy-e8857b@kuoka>
Date: Fri, 24 Oct 2025 09:09:45 +0200
From: Krzysztof Kozlowski <krzk@...nel.org>
To: Joan-Na-adi <joan.na.devcode@...il.com>
Cc: Liam Girdwood <lgirdwood@...il.com>, Mark Brown <broonie@...nel.org>, 
	Rob Herring <robh@...nel.org>, Krzysztof Kozlowski <krzk+dt@...nel.org>, 
	Conor Dooley <conor+dt@...nel.org>, linux-kernel@...r.kernel.org, devicetree@...r.kernel.org, 
	Joan Na <joan.na@...log.com>
Subject: Re: [PATCH v4 1/2] dt-bindings: regulator: Add MAX77675 regulator
 binding

On Tue, Oct 21, 2025 at 02:08:29PM +0900, Joan-Na-adi wrote:
> From: Joan Na <joan.na@...log.com>
> 
> Add device tree binding YAML schema for the Maxim MAX77675 PMIC regulator.
> This defines the node properties and supported regulator names for use
> in device tree sources.

Subject: no improvements.

I also missed last time reversed prefixes:
Please use subject prefixes matching the subsystem. You can get them for
example with 'git log --oneline -- DIRECTORY_OR_FILE' on the directory
your patch is touching. For bindings, the preferred subjects are
explained here:
https://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html#i-for-patch-submitters

> 
> Signed-off-by: Joan Na <joan.na@...log.com>
> ---
>  .../bindings/regulator/maxim,max77675.yaml    | 195 ++++++++++++++++++
>  1 file changed, 195 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/regulator/maxim,max77675.yaml
> 
> diff --git a/Documentation/devicetree/bindings/regulator/maxim,max77675.yaml b/Documentation/devicetree/bindings/regulator/maxim,max77675.yaml
> new file mode 100644
> index 000000000000..0ec0844b6d64
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/regulator/maxim,max77675.yaml
> @@ -0,0 +1,195 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/regulator/maxim,max77675.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Maxim MAX77675 PMIC Regulator
> +
> +maintainers:
> +  - Joan Na <joan.na@...log.com>
> +
> +description: |

Do not need '|' unless you need to preserve formatting.

> +  The MAX77675 is a PMIC providing multiple switching buck regulators
> +  (SBB0–SBB3), accessible via I2C. Each SBB can be configured individually
> +  in the Device Tree. Additional PMIC settings can be configured through

Drop the second sentence. You do not have to describe how DT works in
DT. We all know it.

> +  device-specific properties.
> +
> +properties:
> +  compatible:
> +    const: maxim,max77675
> +
> +  reg:
> +    maxItems: 1
> +
> +  maxim,en-mode:
> +    description: |
> +      Enable mode configuration.
> +      The debounce time set by 'maxim,en-debounce-time-us' applies to
> +      both push-button and slide-switch modes.
> +      "push-button"  - A long press triggers power-on or power-down
> +      "slide-switch" - Low level powers on, high level powers down
> +      "logic"        - Low level powers on, high level powers down (no debounce time)
> +    $ref: /schemas/types.yaml#/definitions/string
> +    enum: [push-button, slide-switch, logic]
> +    default: slide-switch
> +
> +  maxim,voltage-change-latency-us:
> +    description: |
> +      Specifies the delay (in microseconds) between an output voltage change request
> +      and the start of the SBB voltage ramp.
> +      Use 10us for low-latency or 100us for high-latency (default).

Drop sentence. Don't repeat constraints in free form text.

> +    enum: [10, 100]
> +    default: 100
> +
> +  maxim,drv-sbb-strength:
> +    description: |
> +      SIMO Buck-Boost Drive Strength Trim.
> +      Controls the drive strength of the SIMO regulator's power MOSFETs.
> +      This setting affects the switching speed, which impacts power efficiency and EMI.
> +      "max"  – Maximum drive strength (~0.6 ns transition time)
> +      "high" – High drive strength (~1.2 ns transition time)
> +      "low"  – Low drive strength (~1.8 ns transition time)
> +      "min"  – Minimum drive strength (~8 ns transition time)
> +    $ref: /schemas/types.yaml#/definitions/string
> +    enum: [max, high, low, min]
> +    default: max
> +
> +  maxim,dvs-slew-rate-mv-per-us:
> +    description: |

Drop |

> +      Dynamic rising slew rate for output voltage transitions, in mV/μs.
> +      This setting is only used when 'maxim,fixed-slew-rate' is not present.
> +    enum: [5, 10]
> +    default: 5
> +
> +  maxim,en-debounce-time-us:

debounce-delay-us

> +    description: Debounce time for the enable pin, in microseconds
> +    enum: [100, 30000]
> +    default: 100
> +
> +  maxim,manual-reset-time-sec:
> +    description: Manual reset time in seconds

That's for the power button? If so, you have here few input properties -
that's reset-time-sec from input.yaml, right? Reference that schema and
provide here constraints.

> +    enum: [4, 8, 12, 16]
> +    default: 4
> +
> +  maxim,en-pullup-disable:
> +    type: boolean
> +    description: |

Drop |

> +      Disable internal pull-up for EN pin.
> +      When set, the internal pull-up is disabled.

These two repeat itself.

> +      Defaults to enabled if this property is not specified.

Don't repeat constraints in free form text.

> +    default: false
> +
> +  maxim,bias-low-power-request:
> +    type: boolean
> +    description: |
> +      Request low-power bias mode.
> +      When set, the device enters low-power bias mode.

These two repeat itself.

> +      Defaults to normal bias mode if this property is not specified.

Don't repeat constraints in free form text.

> +    default: false
> +
> +  maxim,simo-int-ldo-always-on:
> +    type: boolean
> +    description: |
> +      Set internal LDO to always supply 1.8V
> +      When set, the internal LDO always supplies 1.8V.

These two repeat itself.

> +      By default, the SIMO internal channel supplies 1.8V during low-power mode
> +    default: false
> +
> +  regulators:
> +    type: object
> +    description: Regulator child nodes
> +    patternProperties:
> +      "^sbb[0-3]$":
> +        type: object
> +        $ref: regulator.yaml#
> +        properties:
> +          maxim,fps-slot:
> +            description: |
> +              FPS (Flexible Power Sequencer) slot selection.
> +              The Flexible Power Sequencer allows resources to power up under hardware or software control
> +              Additionally, each resource can power up independently or among a group of other regulators

Please wrap according to coding style (see coding style document, so at
80).

> +              with adjustable power-up and power-down slots.
> +              This device's regulators provide an additional property to configure the FPS parameters,
> +              allowing each regulator to be assigned to an FPS slot for proper power management control.

Redundant statement. Please do not describe how to use Devicetree.
Explain the hardware.

> +              "slot0"   - Assign to FPS Slot 0
> +              "slot1"   - Assign to FPS Slot 1
> +              "slot2"   - Assign to FPS Slot 2
> +              "slot3"   - Assign to FPS Slot 3
> +              "default" - Use the default FPS slot value stored in OTP and read from the register
> +            $ref: /schemas/types.yaml#/definitions/string
> +            enum: [slot0, slot1, slot2, slot3, default]
> +            default: default
> +
> +          maxim,fixed-slew-rate:
> +            type: boolean
> +            description: |
> +              Use fixed slew rate of 2 mV/μs for output voltage transitions.

Drop. Please don't write two sentences which are repeating the same.
Write concise yet informative descriptions.

> +              When this property is present, the device uses a constant 2 mV/μs slew rate
> +              and ignores any dynamic slew rate configuration.
> +              When absent, the device uses the dynamic slew rate specified
> +              by 'maxim,dvs-slew-rate-mv-per-us'
> +            default: true
> +
> +        unevaluatedProperties: false
> +
> +required:
> +  - compatible
> +  - reg
> +  - regulators

Best regards,
Krzysztof

Powered by blists - more mailing lists