Messages in this thread | | | Date | Thu, 20 May 2021 23:09:08 +0530 | From | Pratyush Yadav <> | Subject | Re: [PATCH v3 2/3] mtd: spi-nor: otp: use more consistent wording |
| |
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@walle.cc> > --- > 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.
Please add a note to clarify this. Same for the write and erase functions.
With this fixed,
Reviewed-by: Pratyush Yadav <p.yadav@ti.com>
> * > * Return: number of bytes read successfully, -errno otherwise > */ > @@ -56,16 +58,16 @@ int spi_nor_otp_read_secr(struct spi_nor *nor, loff_t addr, size_t len, u8 *buf) > } > > /** > - * spi_nor_otp_write_secr() - write OTP data > + * spi_nor_otp_write_secr() - write security register > * @nor: pointer to 'struct spi_nor' > * @addr: offset to write to > * @len: number of bytes to write > * @buf: pointer to src buffer > * > - * Write OTP data to one region by using the SPINOR_OP_PSECR commands. This > - * method is used on GigaDevice and Winbond flashes. > + * Write a security register by using the SPINOR_OP_PSECR commands. This method > + * is used on GigaDevice and Winbond flashes to access OTP data. > * > - * Please note, the write must not span multiple OTP regions. > + * Please note, the write must not span multiple registers. > * > * Return: number of bytes written successfully, -errno otherwise > */ > @@ -88,7 +90,7 @@ int spi_nor_otp_write_secr(struct spi_nor *nor, loff_t addr, size_t len, > > /* > * We only support a write to one single page. For now all winbond > - * flashes only have one page per OTP region. > + * flashes only have one page per security register. > */ > ret = spi_nor_write_enable(nor); > if (ret) > -- > 2.20.1 >
-- Regards, Pratyush Yadav Texas Instruments Inc.
| |