lkml.org 
[lkml]   [2020]   [Jan]   [13]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 1/2] mtd: spi-nor: add OTP support
Am 2020-01-09 00:36, schrieb Michael Walle:
> Implement the MTD callbacks for the OTP methods for the SPI NOR
> subsystem.
>
> Usually, the OTP area of a SPI flash can be accessed like the normal
> memory, eg by offset addressing; except that you either have to use
> special read/write commands (Winbond) or you have to enter (and exit) a
> specific OTP mode (Macronix, Micron). Sometimes there are individual
> regions, which might have individual offsets. Therefore, it is possible
> to specify the starting address of the first regions as well as the
> distance between two regions (Winbond).
>
> Additionally, the regions might be locked down. Once locked, no further
> write access is possible.
>
> Signed-off-by: Michael Walle <michael@walle.cc>
> ---
> drivers/mtd/spi-nor/spi-nor.c | 147 ++++++++++++++++++++++++++++++++++
> include/linux/mtd/spi-nor.h | 38 +++++++++
> 2 files changed, 185 insertions(+)
>
> diff --git a/drivers/mtd/spi-nor/spi-nor.c
> b/drivers/mtd/spi-nor/spi-nor.c
> index 818cb9393f41..5eabaec70508 100644
> --- a/drivers/mtd/spi-nor/spi-nor.c
> +++ b/drivers/mtd/spi-nor/spi-nor.c
> @@ -241,6 +241,15 @@ struct flash_info {
>
> /* Part specific fixup hooks. */
> const struct spi_nor_fixups *fixups;
> +
> + /* OTP size in bytes */
> + u16 otp_size;
> + /* Number of OTP banks */
> + u16 n_otps;
> + /* Start address of OTP area */
> + u32 otp_start_addr;
> + /* Offset between consecutive OTP banks if there are more than one */
> + u32 otp_addr_offset;
> };
>
> #define JEDEC_MFR(info) ((info)->id[0])
> @@ -2240,6 +2249,12 @@ static int spi_nor_sr2_bit7_quad_enable(struct
> spi_nor *nor)
> .addr_width = 3, \
> .flags = SPI_NOR_NO_FR | SPI_S3AN,
>
> +#define OTP_INFO(_otp_size, _n_otps, _otp_start_addr,
> _otp_addr_offset) \
> + .otp_size = (_otp_size), \
> + .n_otps = (_n_otps), \
> + .otp_start_addr = (_otp_start_addr), \
> + .otp_addr_offset = (_otp_addr_offset),
> +
> static int
> is25lp256_post_bfpt_fixups(struct spi_nor *nor,
> const struct sfdp_parameter_header *bfpt_header,
> @@ -4827,6 +4842,12 @@ static void spi_nor_info_init_params(struct
> spi_nor *nor)
> spi_nor_set_erase_type(&map->erase_type[i], info->sector_size,
> SPINOR_OP_SE);
> spi_nor_init_uniform_erase_map(map, erase_mask, params->size);
> +
> + /* OTP parameters */
> + nor->params.otp_info.otp_size = info->otp_size;
> + nor->params.otp_info.n_otps = info->n_otps;
> + nor->params.otp_info.otp_start_addr = info->otp_start_addr;
> + nor->params.otp_info.otp_addr_offset = info->otp_addr_offset;
> }
>
> static void spansion_post_sfdp_fixups(struct spi_nor *nor)
> @@ -5122,6 +5143,125 @@ static const struct flash_info
> *spi_nor_get_flash_info(struct spi_nor *nor,
> return info;
> }
>
> +static loff_t spi_nor_otp_region_start(struct spi_nor *nor, int
> region)
> +{
> + struct spi_nor_otp_info *info = &nor->params.otp_info;
> +
> + return info->otp_start_addr + region * info->otp_addr_offset;
> +}
> +
> +static loff_t spi_nor_otp_region_end(struct spi_nor *nor, int region)
> +{
> + struct spi_nor_otp_info *info = &nor->params.otp_info;
> +
> + return (info->otp_start_addr + region * info->otp_addr_offset
> + + info->otp_size - 1);
> +}
> +
> +static int spi_nor_otp_info(struct mtd_info *mtd, size_t len, size_t
> *retlen,
> + struct otp_info *buf)
> +{
> + struct spi_nor *nor = mtd_to_spi_nor(mtd);
> + int i;
> +
> + for (i = 0; i < nor->params.otp_info.n_otps; i++) {
> + buf[i].start = spi_nor_otp_region_start(nor, i);
> + buf[i].length = nor->params.otp_info.otp_size;
> + buf[i].locked = !!(nor->params.otp_ops->is_locked(nor, i));

is_locked() might return an error. will be fixed in the next version.


> + }
> +
> + *retlen = nor->params.otp_info.n_otps * sizeof(*buf);
> +
> + return 0;
> +}
> +
> +static int spi_nor_otp_addr_to_region(struct spi_nor *nor, loff_t
> addr)
> +{
> + int i;
> +
> + for (i = 0; i < nor->params.otp_info.n_otps; i++)
> + if (addr >= spi_nor_otp_region_start(nor, i) &&
> + addr <= spi_nor_otp_region_end(nor, i))
> + return i;
> +
> + return -EINVAL;
> +}
> +
> +static int _spi_nor_otp_read_write(struct mtd_info *mtd, loff_t ofs,
> + size_t len, size_t *retlen, u_char *buf,
> + bool is_write)
> +{
> + struct spi_nor *nor = mtd_to_spi_nor(mtd);
> + enum spi_nor_ops ops = (is_write) ? SPI_NOR_OPS_OTP_WRITE
> + : SPI_NOR_OPS_OTP_READ;
> + int region;
> + int ret;
> +
> + *retlen = 0;
> +
> + /* check boundaries */
> + region = spi_nor_otp_addr_to_region(nor, ofs);
> + if (region < 0)
> + return 0;
> +
> + if (ofs < spi_nor_otp_region_start(nor, region))
> + return 0;
> +
> + if ((ofs + len - 1) > spi_nor_otp_region_end(nor, region))
> + return 0;
> +
> + ret = spi_nor_lock_and_prep(nor, ops);
> +
> + if (is_write)
> + ret = nor->params.otp_ops->write(nor, ofs, len, buf);
> + else
> + ret = nor->params.otp_ops->read(nor, ofs, len, buf);
> +
> + spi_nor_unlock_and_unprep(nor, ops);
> +
> + if (ret < 0)
> + return ret;
> +
> + *retlen = len;
> + return 0;
> +}
> +
> +static int spi_nor_otp_read(struct mtd_info *mtd, loff_t from, size_t
> len,
> + size_t *retlen, u_char *buf)
> +{
> + return _spi_nor_otp_read_write(mtd, from, len, retlen, buf, false);
> +}
> +
> +static int spi_nor_otp_write(struct mtd_info *mtd, loff_t to, size_t
> len,
> + size_t *retlen, u_char *buf)
> +{
> + return _spi_nor_otp_read_write(mtd, to, len, retlen, buf, true);
> +}
> +
> +static int spi_nor_otp_lock(struct mtd_info *mtd, loff_t from, size_t
> len)
> +{
> + struct spi_nor *nor = mtd_to_spi_nor(mtd);
> + int region;
> + int ret;
> +
> + region = spi_nor_otp_addr_to_region(nor, from);
> + if (region < 0)
> + return -EINVAL;
> +
> + if (len != nor->params.otp_info.otp_size)
> + return -EINVAL;
> +
> + ret = spi_nor_lock_and_prep(nor, SPI_NOR_OPS_OTP_LOCK);
> + if (ret)
> + return ret;
> +
> + ret = nor->params.otp_ops->lock(nor, region);
> +
> + spi_nor_unlock_and_unprep(nor, SPI_NOR_OPS_OTP_LOCK);
> +
> + return ret;
> +}
> +
> int spi_nor_scan(struct spi_nor *nor, const char *name,
> const struct spi_nor_hwcaps *hwcaps)
> {
> @@ -5197,6 +5337,13 @@ int spi_nor_scan(struct spi_nor *nor, const char
> *name,
> mtd->_is_locked = spi_nor_is_locked;
> }
>
> + if (nor->params.otp_ops) {
> + mtd->_get_user_prot_info = spi_nor_otp_info;
> + mtd->_read_user_prot_reg = spi_nor_otp_read;
> + mtd->_write_user_prot_reg = spi_nor_otp_write;
> + mtd->_lock_user_prot_reg = spi_nor_otp_lock;
> + }
> +
> /* sst nor chips use AAI word program */
> if (info->flags & SST_WRITE)
> mtd->_write = sst_write;
> diff --git a/include/linux/mtd/spi-nor.h b/include/linux/mtd/spi-nor.h
> index 7cefad41acff..e427dcd72f79 100644
> --- a/include/linux/mtd/spi-nor.h
> +++ b/include/linux/mtd/spi-nor.h
> @@ -232,6 +232,9 @@ enum spi_nor_ops {
> SPI_NOR_OPS_LOCK,
> SPI_NOR_OPS_UNLOCK,
> SPI_NOR_OPS_IS_LOCKED,
> + SPI_NOR_OPS_OTP_READ,
> + SPI_NOR_OPS_OTP_WRITE,
> + SPI_NOR_OPS_OTP_LOCK,
> };
>
> enum spi_nor_option_flags {
> @@ -510,6 +513,36 @@ struct spi_nor_locking_ops {
> int (*is_locked)(struct spi_nor *nor, loff_t ofs, uint64_t len);
> };
>
> +/**
> + * struct spi_nor_otp_info - Structure to describe the SPI NOR OTP
> region
> + * @otp_size: size of one OTP region in bytes.
> + * @n_otps: number of individual OTP regions.
> + * @otp_start_addr: start address of the OTP area.
> + * @otp_addr_offset: offset between consecutive OTP regions if there
> are
> + * more than one.
> + */
> +struct spi_nor_otp_info {
> + u32 otp_size;
> + int n_otps;
> + u32 otp_start_addr;
> + u32 otp_addr_offset;
> +};
> +
> +/**
> + * struct spi_nor_otp_ops - SPI NOR OTP methods
> + * @read: read from the SPI NOR OTP area.
> + * @write: write to the SPI NOR OTP area.
> + * @lock: lock an OTP region.
> + * @is_locked: check if an OTP region of the SPI NOR is locked.
> + */
> +struct spi_nor_otp_ops {
> + int (*read)(struct spi_nor *nor, loff_t ofs, uint64_t len, u8 *buf);
> + int (*write)(struct spi_nor *nor, loff_t ofs, uint64_t len, u8 *buf);
> + int (*lock)(struct spi_nor *nor, unsigned int region);
> + int (*is_locked)(struct spi_nor *nor, unsigned int region);
> +};
> +
> +
> /**
> * struct spi_nor_flash_parameter - SPI NOR flash parameters and
> settings.
> * Includes legacy flash parameters and settings that can be
> overwritten
> @@ -526,6 +559,7 @@ struct spi_nor_locking_ops {
> * higher index in the array, the higher
> priority.
> * @erase_map: the erase map parsed from the SFDP Sector Map
> Parameter
> * Table.
> + * @otp_info: describes the OTP regions.
> * @quad_enable: enables SPI NOR quad mode.
> * @set_4byte: puts the SPI NOR in 4 byte addressing mode.
> * @convert_addr: converts an absolute address into something the
> flash
> @@ -536,6 +570,7 @@ struct spi_nor_locking_ops {
> * e.g. different opcodes, specific address
> calculation,
> * page size, etc.
> * @locking_ops: SPI NOR locking methods.
> + * @otp_ops: SPI NOR OTP methods.
> */
> struct spi_nor_flash_parameter {
> u64 size;
> @@ -547,12 +582,15 @@ struct spi_nor_flash_parameter {
>
> struct spi_nor_erase_map erase_map;
>
> + struct spi_nor_otp_info otp_info;
> +
> int (*quad_enable)(struct spi_nor *nor);
> int (*set_4byte)(struct spi_nor *nor, bool enable);
> u32 (*convert_addr)(struct spi_nor *nor, u32 addr);
> int (*setup)(struct spi_nor *nor, const struct spi_nor_hwcaps
> *hwcaps);
>
> const struct spi_nor_locking_ops *locking_ops;
> + const struct spi_nor_otp_ops *otp_ops;
> };
>
> /**

\
 
 \ /
  Last update: 2020-01-13 09:38    [W:0.072 / U:6.076 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site