mtd/spi-nor/core.h

1 /* SPDX-License-Identifier: GPL-2.0 */
18 #define SPI_NOR_DEFAULT_N_BANKS 1
44 		   SPI_MEM_OP_DATA_IN(1, buf, 0))
56 		   SPI_MEM_OP_DATA_OUT(1, buf, 0))
62 		   SPI_MEM_OP_DATA_OUT(1, buf, 0))
68 		   SPI_MEM_OP_DATA_IN(1, buf, 0))
80 		   SPI_MEM_OP_DATA_OUT(1, buf, 0))
103 		   SPI_MEM_OP_DUMMY(1, 0),				\
127 	SNOR_F_NO_OP_CHIP_ERASE	= BIT(1),
202  * struct spi_nor_erase_type - Structure to describe a SPI NOR erase type
223  * struct spi_nor_erase_command - Used for non-uniform erases
226  * are run-length encoded.
241  * struct spi_nor_erase_region - Structure to describe a SPI NOR erase region
257 #define SNOR_ERASE_TYPE_MASK	GENMASK_ULL(SNOR_ERASE_TYPE_MAX - 1, 0)
263 #define SNOR_ERASE_FLAGS_MASK	GENMASK_ULL(SNOR_ERASE_FLAGS_MAX - 1, 0)
266  * struct spi_nor_erase_map - Structure to describe the SPI NOR erase map
270  * @uniform_region:	a pre-allocated erase region for SPI NOR with a uniform
278  *			uniform and non-uniform SPI NOR flash memories if they
290  * struct spi_nor_locking_ops - SPI NOR locking methods
302  * struct spi_nor_otp_organization - Structure to describe the SPI NOR OTP regions
303  * @len:	size of one OTP region in bytes.
304  * @base:	start address of the OTP area.
305  * @offset:	offset between consecutive OTP regions if there are more
307  * @n_regions:	number of individual OTP regions.
317  * struct spi_nor_otp_ops - SPI NOR OTP methods
318  * @read:	read from the SPI NOR OTP area.
319  * @write:	write to the SPI NOR OTP area.
320  * @lock:	lock an OTP region.
321  * @erase:	erase an OTP region.
322  * @is_locked:	check if an OTP region of the SPI NOR is locked.
334  * struct spi_nor_otp - SPI NOR OTP grouping structure
335  * @org:	OTP region organization
336  * @ops:	OTP access ops
344  * struct spi_nor_flash_parameter - SPI NOR flash parameters and settings.
351  * @writesize		Minimal writable flash unit size. Defaults to 1. Set to
352  *			ECC unit size for ECC-ed flashes.
375  * @otp:		SPI NOR OTP info.
381  *                      not a power-of-2.
411 	struct spi_nor_otp		otp;  member
425  * struct spi_nor_fixups - SPI NOR fixup hooks
452  * struct spi_nor_id - SPI NOR flash ID.
465  * struct flash_info - SPI NOR flash_info entry.
473  * @n_banks:        (optional) the number of banks. Defaults to 1.
484  *   SPI_NOR_4BIT_BP:         flash SR has 4 bit fields (BP0-3) for block
489  *                            Usually these will power-up in a write-protected
521  * @otp_org:        flash's OTP organization.
535 #define SPI_NOR_HAS_TB			BIT(1)
547 #define SECT_4K				BIT(1)
556 #define SPI_NOR_IO_MODE_EN_VOLATILE	BIT(1)
560 	const struct spi_nor_otp_organization *otp;  member
579  * struct spi_nor_manufacturer - SPI NOR manufacturer object
593  * struct sfdp - SFDP data
706  * spi_nor_needs_sfdp() - returns true if SFDP parsing is used for this flash.
715 	 * non-legacy flash entries in flash_info will have a size of zero iff  in spi_nor_needs_sfdp()
718 	return !nor->info->size;  in spi_nor_needs_sfdp()