Re: [PATCH v3 2/3] mtd: spi-nor: otp: use more consistent wording

[Michael Walle]

Am 2021-05-20 19:39, schrieb Pratyush Yadav:
> On 20/05/21 05:58PM, Michael Walle wrote:
> > Use the wording as used in the datasheet to describe the access 
> > methods
> > of the security registers (aka OTP storage). This will also match the
> > function names.
> >
> > Signed-off-by: Michael Walle <michael@xxxxxxxx>
> > ---
> >  drivers/mtd/spi-nor/otp.c | 18 ++++++++++--------
> >  1 file changed, 10 insertions(+), 8 deletions(-)
> >
> > diff --git a/drivers/mtd/spi-nor/otp.c b/drivers/mtd/spi-nor/otp.c
> > index 91a4c510ed51..ec0c1b33f7cc 100644
> > --- a/drivers/mtd/spi-nor/otp.c
> > +++ b/drivers/mtd/spi-nor/otp.c
> > @@ -15,14 +15,16 @@
> >  #define spi_nor_otp_n_regions(nor) 
> > ((nor)->params->otp.org->n_regions)
> >
> >  /**
> > - * spi_nor_otp_read_secr() - read OTP data
> > + * spi_nor_otp_read_secr() - read security register
> >   * @nor:	pointer to 'struct spi_nor'
> >   * @addr:       offset to read from
> >   * @len:        number of bytes to read
> >   * @buf:        pointer to dst buffer
> >   *
> > - * Read OTP data from one region by using the SPINOR_OP_RSECR 
> > commands. This
> > - * method is used on GigaDevice and Winbond flashes.
> > + * Read a security register by using the SPINOR_OP_RSECR commands. 
> > This method
> > + * is used on GigaDevice and Winbond flashes to access OTP data.
> > + *
> > + * Please note, the read must not span multiple registers.
>
> Security register is a very vague term. It in no way tells you that it
> means OTP data unless you already know. If I read this for the first
> time, I would think it is some sort of password or access 
> enable/disable
> type of register, and not OTP data region.

Hence why I didn't use that wording. Also if I read register I think
of some small amount of bits, not a whole 256bytes. But it is like it 
is.

-michael