Re: [PATCH 2/6] dt-bindings: iio: pressure: honeywell,hsc030pa.yaml add sleep-mode

[Petre Rodan]

Hello Krzysztof,

On Wed, Jan 10, 2024 at 09:48:34PM +0100, Krzysztof Kozlowski wrote:
> On 10/01/2024 18:22, Petre Rodan wrote:
> > Add sleep-mode property present in some custom chips.
> > 
> > This flag activates a special wakeup sequence prior to conversion.
> > 
> > Signed-off-by: Petre Rodan <petre.rodan@xxxxxxxxxxxxxxx>
> > ---
> >  .../bindings/iio/pressure/honeywell,hsc030pa.yaml      | 10 ++++++++++
> >  1 file changed, 10 insertions(+)
> > 
> > diff --git a/Documentation/devicetree/bindings/iio/pressure/honeywell,hsc030pa.yaml b/Documentation/devicetree/bindings/iio/pressure/honeywell,hsc030pa.yaml
> > index 89977b9f01cf..350da1d6991b 100644
> > --- a/Documentation/devicetree/bindings/iio/pressure/honeywell,hsc030pa.yaml
> > +++ b/Documentation/devicetree/bindings/iio/pressure/honeywell,hsc030pa.yaml
> > @@ -86,6 +86,15 @@ properties:
> >        Maximum pressure value the sensor can measure in pascal.
> >        To be specified only if honeywell,pressure-triplet is set to "NA".
> > 
> > +  honeywell,sleep-mode:
> 
> "Sleep mode" naming suggests there are choices, like mode foo and mode
> bar. Probably you want something like "sleep-between-measurements" or
> something matching how does it work.

"sleep mode" is the terminology used by Honeywell and it defines a chip capability.
it is present in the HSC/SSC and ABP series of ICs.

other such options (capabilities) include temperature output in the ABP series.

the action the driver needs to perform if this option is present is to provide a
wake-up sequence before reading out the conversions.

now regarding a rename of this property, I would vote to leave it as is - for the
users to have a 1:1 equivalence of terms between the driver and the datasheet.

I say that because for instance in circuit design when a part symbol and
footprint is drawn based on a datasheet it is recommended to keep the same pin
notations and the same block diagram as in the datasheet, precisely for this 1:1
equivalence, so there is no uncertainty for the end-user.

cheers,
peter

> 
> > +    description: |
> 
> Do not need '|' unless you need to preserve formatting.
> 
> > +      'Sleep Mode' is a special factory set mode of the chip that allows the
> > +      sensor to power down between measurements. It is implemented only on
> > +      special request, and it is an attribute not present in the HSC/SSC series
> > +      nomenclature.
> > +      Set in order to enable the special wakeup sequence prior to conversion.
> > +    $ref: /schemas/types.yaml#/definitions/flag
> > +
> >    vdd-supply:
> >      description:
> >        Provide VDD power to the sensor (either 3.3V or 5V depending on the chip)
> > @@ -140,6 +149,7 @@ examples:
> >              honeywell,pressure-triplet = "NA";
> >              honeywell,pmin-pascal = <0>;
> >              honeywell,pmax-pascal = <200000>;
> > +            //honeywell,sleep-mode;
> 
> Drop comment.
> 
> > 2.41.0
> > 
> 
> Best regards,
> Krzysztof
> 

-- 
petre rodan

Attachment: signature.asc
Description: PGP signature