[mirror_ubuntu-bionic-kernel.git] / include / linux / mtd / spi-nor.h

/*
 * Copyright (C) 2014 Freescale Semiconductor, Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 */

#ifndef __LINUX_MTD_SPI_NOR_H
#define __LINUX_MTD_SPI_NOR_H

/*
 * Note on opcode nomenclature: some opcodes have a format like
 * SPINOR_OP_FUNCTION{4,}_x_y_z. The numbers x, y, and z stand for the number
 * of I/O lines used for the opcode, address, and data (respectively). The
 * FUNCTION has an optional suffix of '4', to represent an opcode which
 * requires a 4-byte (32-bit) address.
 */

/* Flash opcodes. */
#define SPINOR_OP_WREN		0x06	/* Write enable */
#define SPINOR_OP_RDSR		0x05	/* Read status register */
#define SPINOR_OP_WRSR		0x01	/* Write status register 1 byte */
#define SPINOR_OP_READ		0x03	/* Read data bytes (low frequency) */
#define SPINOR_OP_READ_FAST	0x0b	/* Read data bytes (high frequency) */
#define SPINOR_OP_READ_1_1_2	0x3b	/* Read data bytes (Dual SPI) */
#define SPINOR_OP_READ_1_1_4	0x6b	/* Read data bytes (Quad SPI) */
#define SPINOR_OP_PP		0x02	/* Page program (up to 256 bytes) */
#define SPINOR_OP_BE_4K		0x20	/* Erase 4KiB block */
#define SPINOR_OP_BE_4K_PMC	0xd7	/* Erase 4KiB block on PMC chips */
#define SPINOR_OP_BE_32K	0x52	/* Erase 32KiB block */
#define SPINOR_OP_CHIP_ERASE	0xc7	/* Erase whole flash chip */
#define SPINOR_OP_SE		0xd8	/* Sector erase (usually 64KiB) */
#define SPINOR_OP_RDID		0x9f	/* Read JEDEC ID */
#define SPINOR_OP_RDCR		0x35	/* Read configuration register */
#define SPINOR_OP_RDFSR		0x70	/* Read flag status register */

/* 4-byte address opcodes - used on Spansion and some Macronix flashes. */
#define SPINOR_OP_READ4		0x13	/* Read data bytes (low frequency) */
#define SPINOR_OP_READ4_FAST	0x0c	/* Read data bytes (high frequency) */
#define SPINOR_OP_READ4_1_1_2	0x3c	/* Read data bytes (Dual SPI) */
#define SPINOR_OP_READ4_1_1_4	0x6c	/* Read data bytes (Quad SPI) */
#define SPINOR_OP_PP_4B		0x12	/* Page program (up to 256 bytes) */
#define SPINOR_OP_SE_4B		0xdc	/* Sector erase (usually 64KiB) */

/* Used for SST flashes only. */
#define SPINOR_OP_BP		0x02	/* Byte program */
#define SPINOR_OP_WRDI		0x04	/* Write disable */
#define SPINOR_OP_AAI_WP	0xad	/* Auto address increment word program */

/* Used for Macronix and Winbond flashes. */
#define SPINOR_OP_EN4B		0xb7	/* Enter 4-byte mode */
#define SPINOR_OP_EX4B		0xe9	/* Exit 4-byte mode */

/* Used for Spansion flashes only. */
#define SPINOR_OP_BRWR		0x17	/* Bank register write */

/* Used for Micron flashes only. */
#define SPINOR_OP_RD_EVCR      0x65    /* Read EVCR register */
#define SPINOR_OP_WD_EVCR      0x61    /* Write EVCR register */

/* Status Register bits. */
#define SR_WIP			1	/* Write in progress */
#define SR_WEL			2	/* Write enable latch */
/* meaning of other SR_* bits may differ between vendors */
#define SR_BP0			4	/* Block protect 0 */
#define SR_BP1			8	/* Block protect 1 */
#define SR_BP2			0x10	/* Block protect 2 */
#define SR_SRWD			0x80	/* SR write protect */

#define SR_QUAD_EN_MX		0x40	/* Macronix Quad I/O */

/* Enhanced Volatile Configuration Register bits */
#define EVCR_QUAD_EN_MICRON    0x80    /* Micron Quad I/O */

/* Flag Status Register bits */
#define FSR_READY		0x80

/* Configuration Register bits. */
#define CR_QUAD_EN_SPAN		0x2	/* Spansion Quad I/O */

enum read_mode {
	SPI_NOR_NORMAL = 0,
	SPI_NOR_FAST,
	SPI_NOR_DUAL,
	SPI_NOR_QUAD,
};

/**
 * struct spi_nor_xfer_cfg - Structure for defining a Serial Flash transfer
 * @wren:		command for "Write Enable", or 0x00 for not required
 * @cmd:		command for operation
 * @cmd_pins:		number of pins to send @cmd (1, 2, 4)
 * @addr:		address for operation
 * @addr_pins:		number of pins to send @addr (1, 2, 4)
 * @addr_width:		number of address bytes
 *			(3,4, or 0 for address not required)
 * @mode:		mode data
 * @mode_pins:		number of pins to send @mode (1, 2, 4)
 * @mode_cycles:	number of mode cycles (0 for mode not required)
 * @dummy_cycles:	number of dummy cycles (0 for dummy not required)
 */
struct spi_nor_xfer_cfg {
	u8		wren;
	u8		cmd;
	u8		cmd_pins;
	u32		addr;
	u8		addr_pins;
	u8		addr_width;
	u8		mode;
	u8		mode_pins;
	u8		mode_cycles;
	u8		dummy_cycles;
};

#define SPI_NOR_MAX_CMD_SIZE	8
enum spi_nor_ops {
	SPI_NOR_OPS_READ = 0,
	SPI_NOR_OPS_WRITE,
	SPI_NOR_OPS_ERASE,
	SPI_NOR_OPS_LOCK,
	SPI_NOR_OPS_UNLOCK,
};

enum spi_nor_option_flags {
	SNOR_F_USE_FSR		= BIT(0),
};

struct mtd_info;

/**
 * struct spi_nor - Structure for defining a the SPI NOR layer
 * @mtd:		point to a mtd_info structure
 * @lock:		the lock for the read/write/erase/lock/unlock operations
 * @dev:		point to a spi device, or a spi nor controller device.
 * @page_size:		the page size of the SPI NOR
 * @addr_width:		number of address bytes
 * @erase_opcode:	the opcode for erasing a sector
 * @read_opcode:	the read opcode
 * @read_dummy:		the dummy needed by the read operation
 * @program_opcode:	the program opcode
 * @flash_read:		the mode of the read
 * @sst_write_second:	used by the SST write operation
 * @flags:		flag options for the current SPI-NOR (SNOR_F_*)
 * @cfg:		used by the read_xfer/write_xfer
 * @cmd_buf:		used by the write_reg
 * @prepare:		[OPTIONAL] do some preparations for the
 *			read/write/erase/lock/unlock operations
 * @unprepare:		[OPTIONAL] do some post work after the
 *			read/write/erase/lock/unlock operations
 * @read_xfer:		[OPTIONAL] the read fundamental primitive
 * @write_xfer:		[OPTIONAL] the writefundamental primitive
 * @read_reg:		[DRIVER-SPECIFIC] read out the register
 * @write_reg:		[DRIVER-SPECIFIC] write data to the register
 * @read:		[DRIVER-SPECIFIC] read data from the SPI NOR
 * @write:		[DRIVER-SPECIFIC] write data to the SPI NOR
 * @erase:		[DRIVER-SPECIFIC] erase a sector of the SPI NOR
 *			at the offset @offs
 * @lock:		[FLASH-SPECIFIC] lock a region of the SPI NOR
 * @unlock:		[FLASH-SPECIFIC] unlock a region of the SPI NOR
 * @priv:		the private data
 */
struct spi_nor {
	struct mtd_info		*mtd;
	struct mutex		lock;
	struct device		*dev;
	u32			page_size;
	u8			addr_width;
	u8			erase_opcode;
	u8			read_opcode;
	u8			read_dummy;
	u8			program_opcode;
	enum read_mode		flash_read;
	bool			sst_write_second;
	u32			flags;
	struct spi_nor_xfer_cfg	cfg;
	u8			cmd_buf[SPI_NOR_MAX_CMD_SIZE];

	int (*prepare)(struct spi_nor *nor, enum spi_nor_ops ops);
	void (*unprepare)(struct spi_nor *nor, enum spi_nor_ops ops);
	int (*read_xfer)(struct spi_nor *nor, struct spi_nor_xfer_cfg *cfg,
			 u8 *buf, size_t len);
	int (*write_xfer)(struct spi_nor *nor, struct spi_nor_xfer_cfg *cfg,
			  u8 *buf, size_t len);
	int (*read_reg)(struct spi_nor *nor, u8 opcode, u8 *buf, int len);
	int (*write_reg)(struct spi_nor *nor, u8 opcode, u8 *buf, int len,
			int write_enable);

	int (*read)(struct spi_nor *nor, loff_t from,
			size_t len, size_t *retlen, u_char *read_buf);
	void (*write)(struct spi_nor *nor, loff_t to,
			size_t len, size_t *retlen, const u_char *write_buf);
	int (*erase)(struct spi_nor *nor, loff_t offs);

	int (*flash_lock)(struct spi_nor *nor, loff_t ofs, uint64_t len);
	int (*flash_unlock)(struct spi_nor *nor, loff_t ofs, uint64_t len);

	void *priv;
};

/**
 * spi_nor_scan() - scan the SPI NOR
 * @nor:	the spi_nor structure
 * @name:	the chip type name
 * @mode:	the read mode supported by the driver
 *
 * The drivers can use this fuction to scan the SPI NOR.
 * In the scanning, it will try to get all the necessary information to
 * fill the mtd_info{} and the spi_nor{}.
 *
 * The chip type name can be provided through the @name parameter.
 *
 * Return: 0 for success, others for failure.
 */
int spi_nor_scan(struct spi_nor *nor, const char *name, enum read_mode mode);

#endif
Commit	Line	Data
8eabdd1e HS	1	/*
	2	* Copyright (C) 2014 Freescale Semiconductor, Inc.
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License as published by
	6	* the Free Software Foundation; either version 2 of the License, or
	7	* (at your option) any later version.
	8	*/
	9
f39d2fa0 HS	10	#ifndef __LINUX_MTD_SPI_NOR_H
	11	#define __LINUX_MTD_SPI_NOR_H
	12
58b89a1f BN	13	/*
	14	* Note on opcode nomenclature: some opcodes have a format like
	15	* SPINOR_OP_FUNCTION{4,}_x_y_z. The numbers x, y, and z stand for the number
	16	* of I/O lines used for the opcode, address, and data (respectively). The
	17	* FUNCTION has an optional suffix of '4', to represent an opcode which
	18	* requires a 4-byte (32-bit) address.
	19	*/
	20
f39d2fa0	21	/* Flash opcodes. */
b02e7f3e BN	22	#define SPINOR_OP_WREN 0x06 /* Write enable */
	23	#define SPINOR_OP_RDSR 0x05 /* Read status register */
	24	#define SPINOR_OP_WRSR 0x01 /* Write status register 1 byte */
58b89a1f BN	25	#define SPINOR_OP_READ 0x03 /* Read data bytes (low frequency) */
	26	#define SPINOR_OP_READ_FAST 0x0b /* Read data bytes (high frequency) */
	27	#define SPINOR_OP_READ_1_1_2 0x3b /* Read data bytes (Dual SPI) */
	28	#define SPINOR_OP_READ_1_1_4 0x6b /* Read data bytes (Quad SPI) */
b02e7f3e BN	29	#define SPINOR_OP_PP 0x02 /* Page program (up to 256 bytes) */
	30	#define SPINOR_OP_BE_4K 0x20 /* Erase 4KiB block */
	31	#define SPINOR_OP_BE_4K_PMC 0xd7 /* Erase 4KiB block on PMC chips */
	32	#define SPINOR_OP_BE_32K 0x52 /* Erase 32KiB block */
	33	#define SPINOR_OP_CHIP_ERASE 0xc7 /* Erase whole flash chip */
	34	#define SPINOR_OP_SE 0xd8 /* Sector erase (usually 64KiB) */
	35	#define SPINOR_OP_RDID 0x9f /* Read JEDEC ID */
	36	#define SPINOR_OP_RDCR 0x35 /* Read configuration register */
c14dedde	37	#define SPINOR_OP_RDFSR 0x70 /* Read flag status register */
f39d2fa0 HS	38
f39d2fa0 HS	39	/* 4-byte address opcodes - used on Spansion and some Macronix flashes. */
58b89a1f BN	40	#define SPINOR_OP_READ4 0x13 /* Read data bytes (low frequency) */
	41	#define SPINOR_OP_READ4_FAST 0x0c /* Read data bytes (high frequency) */
	42	#define SPINOR_OP_READ4_1_1_2 0x3c /* Read data bytes (Dual SPI) */
	43	#define SPINOR_OP_READ4_1_1_4 0x6c /* Read data bytes (Quad SPI) */
b02e7f3e BN	44	#define SPINOR_OP_PP_4B 0x12 /* Page program (up to 256 bytes) */
b02e7f3e BN	45	#define SPINOR_OP_SE_4B 0xdc /* Sector erase (usually 64KiB) */
f39d2fa0 HS	46
f39d2fa0 HS	47	/* Used for SST flashes only. */
b02e7f3e BN	48	#define SPINOR_OP_BP 0x02 /* Byte program */
	49	#define SPINOR_OP_WRDI 0x04 /* Write disable */
	50	#define SPINOR_OP_AAI_WP 0xad /* Auto address increment word program */
f39d2fa0 HS	51
f39d2fa0 HS	52	/* Used for Macronix and Winbond flashes. */
b02e7f3e BN	53	#define SPINOR_OP_EN4B 0xb7 /* Enter 4-byte mode */
b02e7f3e BN	54	#define SPINOR_OP_EX4B 0xe9 /* Exit 4-byte mode */
f39d2fa0 HS	55
f39d2fa0 HS	56	/* Used for Spansion flashes only. */
b02e7f3e	57	#define SPINOR_OP_BRWR 0x17 /* Bank register write */
f39d2fa0	58
548cd3ab BH	59	/* Used for Micron flashes only. */
	60	#define SPINOR_OP_RD_EVCR 0x65 /* Read EVCR register */
	61	#define SPINOR_OP_WD_EVCR 0x61 /* Write EVCR register */
	62
f39d2fa0	63	/* Status Register bits. */
becd0cb8 BN	64	#define SR_WIP 1 /* Write in progress */
becd0cb8 BN	65	#define SR_WEL 2 /* Write enable latch */
f39d2fa0	66	/* meaning of other SR_* bits may differ between vendors */
becd0cb8 BN	67	#define SR_BP0 4 /* Block protect 0 */
	68	#define SR_BP1 8 /* Block protect 1 */
	69	#define SR_BP2 0x10 /* Block protect 2 */
	70	#define SR_SRWD 0x80 /* SR write protect */
f39d2fa0	71
becd0cb8	72	#define SR_QUAD_EN_MX 0x40 /* Macronix Quad I/O */
f39d2fa0	73
548cd3ab BH	74	/* Enhanced Volatile Configuration Register bits */
	75	#define EVCR_QUAD_EN_MICRON 0x80 /* Micron Quad I/O */
	76
c14dedde	77	/* Flag Status Register bits */
	78	#define FSR_READY 0x80
	79
f39d2fa0	80	/* Configuration Register bits. */
becd0cb8	81	#define CR_QUAD_EN_SPAN 0x2 /* Spansion Quad I/O */
f39d2fa0	82
6e602ef7 HS	83	enum read_mode {
	84	SPI_NOR_NORMAL = 0,
	85	SPI_NOR_FAST,
	86	SPI_NOR_DUAL,
	87	SPI_NOR_QUAD,
	88	};
	89
	90	/**
	91	* struct spi_nor_xfer_cfg - Structure for defining a Serial Flash transfer
	92	* @wren: command for "Write Enable", or 0x00 for not required
	93	* @cmd: command for operation
	94	* @cmd_pins: number of pins to send @cmd (1, 2, 4)
	95	* @addr: address for operation
	96	* @addr_pins: number of pins to send @addr (1, 2, 4)
	97	* @addr_width: number of address bytes
	98	* (3,4, or 0 for address not required)
	99	* @mode: mode data
	100	* @mode_pins: number of pins to send @mode (1, 2, 4)
	101	* @mode_cycles: number of mode cycles (0 for mode not required)
	102	* @dummy_cycles: number of dummy cycles (0 for dummy not required)
	103	*/
	104	struct spi_nor_xfer_cfg {
	105	u8 wren;
	106	u8 cmd;
	107	u8 cmd_pins;
	108	u32 addr;
	109	u8 addr_pins;
	110	u8 addr_width;
	111	u8 mode;
	112	u8 mode_pins;
	113	u8 mode_cycles;
	114	u8 dummy_cycles;
	115	};
	116
becd0cb8	117	#define SPI_NOR_MAX_CMD_SIZE 8
6e602ef7 HS	118	enum spi_nor_ops {
	119	SPI_NOR_OPS_READ = 0,
	120	SPI_NOR_OPS_WRITE,
	121	SPI_NOR_OPS_ERASE,
	122	SPI_NOR_OPS_LOCK,
	123	SPI_NOR_OPS_UNLOCK,
	124	};
	125
6af91949 BN	126	enum spi_nor_option_flags {
	127	SNOR_F_USE_FSR = BIT(0),
	128	};
	129
a39f1d5e BN	130	struct mtd_info;
a39f1d5e BN	131
6e602ef7 HS	132	/**
	133	* struct spi_nor - Structure for defining a the SPI NOR layer
	134	* @mtd: point to a mtd_info structure
	135	* @lock: the lock for the read/write/erase/lock/unlock operations
	136	* @dev: point to a spi device, or a spi nor controller device.
	137	* @page_size: the page size of the SPI NOR
	138	* @addr_width: number of address bytes
	139	* @erase_opcode: the opcode for erasing a sector
	140	* @read_opcode: the read opcode
	141	* @read_dummy: the dummy needed by the read operation
	142	* @program_opcode: the program opcode
	143	* @flash_read: the mode of the read
	144	* @sst_write_second: used by the SST write operation
6af91949	145	* @flags: flag options for the current SPI-NOR (SNOR_F_*)
6e602ef7 HS	146	* @cfg: used by the read_xfer/write_xfer
	147	* @cmd_buf: used by the write_reg
	148	* @prepare: [OPTIONAL] do some preparations for the
	149	* read/write/erase/lock/unlock operations
	150	* @unprepare: [OPTIONAL] do some post work after the
	151	* read/write/erase/lock/unlock operations
	152	* @read_xfer: [OPTIONAL] the read fundamental primitive
	153	* @write_xfer: [OPTIONAL] the writefundamental primitive
	154	* @read_reg: [DRIVER-SPECIFIC] read out the register
	155	* @write_reg: [DRIVER-SPECIFIC] write data to the register
6e602ef7 HS	156	* @read: [DRIVER-SPECIFIC] read data from the SPI NOR
	157	* @write: [DRIVER-SPECIFIC] write data to the SPI NOR
	158	* @erase: [DRIVER-SPECIFIC] erase a sector of the SPI NOR
	159	* at the offset @offs
8cc7f33a BN	160	* @lock: [FLASH-SPECIFIC] lock a region of the SPI NOR
8cc7f33a BN	161	* @unlock: [FLASH-SPECIFIC] unlock a region of the SPI NOR
6e602ef7 HS	162	* @priv: the private data
	163	*/
	164	struct spi_nor {
	165	struct mtd_info *mtd;
	166	struct mutex lock;
	167	struct device *dev;
	168	u32 page_size;
	169	u8 addr_width;
	170	u8 erase_opcode;
	171	u8 read_opcode;
	172	u8 read_dummy;
	173	u8 program_opcode;
	174	enum read_mode flash_read;
	175	bool sst_write_second;
6af91949	176	u32 flags;
6e602ef7 HS	177	struct spi_nor_xfer_cfg cfg;
	178	u8 cmd_buf[SPI_NOR_MAX_CMD_SIZE];
	179
	180	int (prepare)(struct spi_nor nor, enum spi_nor_ops ops);
	181	void (unprepare)(struct spi_nor nor, enum spi_nor_ops ops);
	182	int (read_xfer)(struct spi_nor nor, struct spi_nor_xfer_cfg *cfg,
	183	u8 *buf, size_t len);
	184	int (write_xfer)(struct spi_nor nor, struct spi_nor_xfer_cfg *cfg,
	185	u8 *buf, size_t len);
	186	int (read_reg)(struct spi_nor nor, u8 opcode, u8 *buf, int len);
	187	int (write_reg)(struct spi_nor nor, u8 opcode, u8 *buf, int len,
	188	int write_enable);
6e602ef7 HS	189
	190	int (read)(struct spi_nor nor, loff_t from,
	191	size_t len, size_t retlen, u_char read_buf);
	192	void (write)(struct spi_nor nor, loff_t to,
	193	size_t len, size_t retlen, const u_char write_buf);
	194	int (erase)(struct spi_nor nor, loff_t offs);
	195
8cc7f33a BN	196	int (flash_lock)(struct spi_nor nor, loff_t ofs, uint64_t len);
	197	int (flash_unlock)(struct spi_nor nor, loff_t ofs, uint64_t len);
	198
6e602ef7 HS	199	void *priv;
6e602ef7 HS	200	};
b199489d HS	201
	202	/**
	203	* spi_nor_scan() - scan the SPI NOR
	204	* @nor: the spi_nor structure
70f3ce05	205	* @name: the chip type name
b199489d HS	206	* @mode: the read mode supported by the driver
	207	*
	208	* The drivers can use this fuction to scan the SPI NOR.
	209	* In the scanning, it will try to get all the necessary information to
	210	* fill the mtd_info{} and the spi_nor{}.
	211	*
70f3ce05	212	* The chip type name can be provided through the @name parameter.
b199489d HS	213	*
	214	* Return: 0 for success, others for failure.
	215	*/
70f3ce05	216	int spi_nor_scan(struct spi_nor nor, const char name, enum read_mode mode);
b199489d	217
f39d2fa0	218	#endif