2014-04-10 08:27:28 +00:00
|
|
|
/*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2014-02-24 10:37:35 +00:00
|
|
|
#ifndef __LINUX_MTD_SPI_NOR_H
|
|
|
|
#define __LINUX_MTD_SPI_NOR_H
|
|
|
|
|
2015-09-01 19:57:06 +00:00
|
|
|
#include <linux/bitops.h>
|
2015-09-01 19:57:08 +00:00
|
|
|
#include <linux/mtd/cfi.h>
|
2015-11-26 08:05:04 +00:00
|
|
|
#include <linux/mtd/mtd.h>
|
2015-09-01 19:57:08 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Manufacturer IDs
|
|
|
|
*
|
|
|
|
* The first byte returned from the flash after sending opcode SPINOR_OP_RDID.
|
|
|
|
* Sometimes these are the same as CFI IDs, but sometimes they aren't.
|
|
|
|
*/
|
|
|
|
#define SNOR_MFR_ATMEL CFI_MFR_ATMEL
|
2016-05-06 15:37:41 +00:00
|
|
|
#define SNOR_MFR_GIGADEVICE 0xc8
|
2015-09-01 19:57:08 +00:00
|
|
|
#define SNOR_MFR_INTEL CFI_MFR_INTEL
|
|
|
|
#define SNOR_MFR_MICRON CFI_MFR_ST /* ST Micro <--> Micron */
|
|
|
|
#define SNOR_MFR_MACRONIX CFI_MFR_MACRONIX
|
|
|
|
#define SNOR_MFR_SPANSION CFI_MFR_AMD
|
|
|
|
#define SNOR_MFR_SST CFI_MFR_SST
|
2015-12-15 18:48:20 +00:00
|
|
|
#define SNOR_MFR_WINBOND 0xef /* Also used by some Spansion */
|
2015-09-01 19:57:06 +00:00
|
|
|
|
2014-04-09 02:16:49 +00:00
|
|
|
/*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2014-02-24 10:37:35 +00:00
|
|
|
/* Flash opcodes. */
|
2014-04-09 01:15:31 +00:00
|
|
|
#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 */
|
2014-04-09 02:16:49 +00:00
|
|
|
#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) */
|
2014-04-09 01:15:31 +00:00
|
|
|
#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 */
|
2014-04-29 15:29:51 +00:00
|
|
|
#define SPINOR_OP_RDFSR 0x70 /* Read flag status register */
|
2014-02-24 10:37:35 +00:00
|
|
|
|
|
|
|
/* 4-byte address opcodes - used on Spansion and some Macronix flashes. */
|
2014-04-09 02:16:49 +00:00
|
|
|
#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) */
|
2014-04-09 01:15:31 +00:00
|
|
|
#define SPINOR_OP_PP_4B 0x12 /* Page program (up to 256 bytes) */
|
|
|
|
#define SPINOR_OP_SE_4B 0xdc /* Sector erase (usually 64KiB) */
|
2014-02-24 10:37:35 +00:00
|
|
|
|
|
|
|
/* Used for SST flashes only. */
|
2014-04-09 01:15:31 +00:00
|
|
|
#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 */
|
2014-02-24 10:37:35 +00:00
|
|
|
|
|
|
|
/* Used for Macronix and Winbond flashes. */
|
2014-04-09 01:15:31 +00:00
|
|
|
#define SPINOR_OP_EN4B 0xb7 /* Enter 4-byte mode */
|
|
|
|
#define SPINOR_OP_EX4B 0xe9 /* Exit 4-byte mode */
|
2014-02-24 10:37:35 +00:00
|
|
|
|
|
|
|
/* Used for Spansion flashes only. */
|
2014-04-09 01:15:31 +00:00
|
|
|
#define SPINOR_OP_BRWR 0x17 /* Bank register write */
|
2014-02-24 10:37:35 +00:00
|
|
|
|
2014-12-17 07:35:45 +00:00
|
|
|
/* Used for Micron flashes only. */
|
|
|
|
#define SPINOR_OP_RD_EVCR 0x65 /* Read EVCR register */
|
|
|
|
#define SPINOR_OP_WD_EVCR 0x61 /* Write EVCR register */
|
|
|
|
|
2014-02-24 10:37:35 +00:00
|
|
|
/* Status Register bits. */
|
2015-09-01 19:57:07 +00:00
|
|
|
#define SR_WIP BIT(0) /* Write in progress */
|
|
|
|
#define SR_WEL BIT(1) /* Write enable latch */
|
2014-02-24 10:37:35 +00:00
|
|
|
/* meaning of other SR_* bits may differ between vendors */
|
2015-09-01 19:57:07 +00:00
|
|
|
#define SR_BP0 BIT(2) /* Block protect 0 */
|
|
|
|
#define SR_BP1 BIT(3) /* Block protect 1 */
|
|
|
|
#define SR_BP2 BIT(4) /* Block protect 2 */
|
2016-01-29 19:25:36 +00:00
|
|
|
#define SR_TB BIT(5) /* Top/Bottom protect */
|
2015-09-01 19:57:07 +00:00
|
|
|
#define SR_SRWD BIT(7) /* SR write protect */
|
2014-02-24 10:37:35 +00:00
|
|
|
|
2015-09-01 19:57:07 +00:00
|
|
|
#define SR_QUAD_EN_MX BIT(6) /* Macronix Quad I/O */
|
2014-02-24 10:37:35 +00:00
|
|
|
|
2014-12-17 07:35:45 +00:00
|
|
|
/* Enhanced Volatile Configuration Register bits */
|
2015-09-01 19:57:07 +00:00
|
|
|
#define EVCR_QUAD_EN_MICRON BIT(7) /* Micron Quad I/O */
|
2014-12-17 07:35:45 +00:00
|
|
|
|
2014-04-29 15:29:51 +00:00
|
|
|
/* Flag Status Register bits */
|
2015-09-01 19:57:07 +00:00
|
|
|
#define FSR_READY BIT(7)
|
2014-04-29 15:29:51 +00:00
|
|
|
|
2014-02-24 10:37:35 +00:00
|
|
|
/* Configuration Register bits. */
|
2015-09-01 19:57:07 +00:00
|
|
|
#define CR_QUAD_EN_SPAN BIT(1) /* Spansion Quad I/O */
|
2014-02-24 10:37:35 +00:00
|
|
|
|
2014-02-24 10:37:36 +00:00
|
|
|
enum read_mode {
|
|
|
|
SPI_NOR_NORMAL = 0,
|
|
|
|
SPI_NOR_FAST,
|
|
|
|
SPI_NOR_DUAL,
|
|
|
|
SPI_NOR_QUAD,
|
|
|
|
};
|
|
|
|
|
2014-04-09 01:10:23 +00:00
|
|
|
#define SPI_NOR_MAX_CMD_SIZE 8
|
2014-02-24 10:37:36 +00:00
|
|
|
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,
|
|
|
|
};
|
|
|
|
|
2014-08-07 01:16:58 +00:00
|
|
|
enum spi_nor_option_flags {
|
|
|
|
SNOR_F_USE_FSR = BIT(0),
|
2016-01-29 19:25:36 +00:00
|
|
|
SNOR_F_HAS_SR_TB = BIT(1),
|
2014-08-07 01:16:58 +00:00
|
|
|
};
|
|
|
|
|
2014-02-24 10:37:36 +00:00
|
|
|
/**
|
|
|
|
* 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
|
2014-08-07 01:16:58 +00:00
|
|
|
* @flags: flag options for the current SPI-NOR (SNOR_F_*)
|
2014-02-24 10:37:36 +00:00
|
|
|
* @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_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
|
2015-11-10 20:15:27 +00:00
|
|
|
* at the offset @offs; if not provided by the driver,
|
|
|
|
* spi-nor will send the erase opcode via write_reg()
|
2015-09-01 19:57:10 +00:00
|
|
|
* @flash_lock: [FLASH-SPECIFIC] lock a region of the SPI NOR
|
|
|
|
* @flash_unlock: [FLASH-SPECIFIC] unlock a region of the SPI NOR
|
2015-09-01 19:57:12 +00:00
|
|
|
* @flash_is_locked: [FLASH-SPECIFIC] check if a region of the SPI NOR is
|
|
|
|
* completely locked
|
2014-02-24 10:37:36 +00:00
|
|
|
* @priv: the private data
|
|
|
|
*/
|
|
|
|
struct spi_nor {
|
2015-08-13 22:46:05 +00:00
|
|
|
struct mtd_info mtd;
|
2014-02-24 10:37:36 +00:00
|
|
|
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;
|
2014-08-07 01:16:58 +00:00
|
|
|
u32 flags;
|
2014-02-24 10:37:36 +00:00
|
|
|
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_reg)(struct spi_nor *nor, u8 opcode, u8 *buf, int len);
|
2015-08-19 09:56:44 +00:00
|
|
|
int (*write_reg)(struct spi_nor *nor, u8 opcode, u8 *buf, int len);
|
2014-02-24 10:37:36 +00:00
|
|
|
|
2016-05-06 00:31:47 +00:00
|
|
|
ssize_t (*read)(struct spi_nor *nor, loff_t from,
|
2016-05-06 00:31:53 +00:00
|
|
|
size_t len, u_char *read_buf);
|
2016-05-06 00:31:47 +00:00
|
|
|
ssize_t (*write)(struct spi_nor *nor, loff_t to,
|
2016-05-06 00:31:53 +00:00
|
|
|
size_t len, const u_char *write_buf);
|
2014-02-24 10:37:36 +00:00
|
|
|
int (*erase)(struct spi_nor *nor, loff_t offs);
|
|
|
|
|
2015-03-13 07:38:39 +00:00
|
|
|
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);
|
2015-09-01 19:57:12 +00:00
|
|
|
int (*flash_is_locked)(struct spi_nor *nor, loff_t ofs, uint64_t len);
|
2015-03-13 07:38:39 +00:00
|
|
|
|
2014-02-24 10:37:36 +00:00
|
|
|
void *priv;
|
|
|
|
};
|
2014-02-24 10:37:37 +00:00
|
|
|
|
2015-10-31 03:33:20 +00:00
|
|
|
static inline void spi_nor_set_flash_node(struct spi_nor *nor,
|
|
|
|
struct device_node *np)
|
|
|
|
{
|
2015-10-31 03:33:27 +00:00
|
|
|
mtd_set_of_node(&nor->mtd, np);
|
2015-10-31 03:33:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline struct device_node *spi_nor_get_flash_node(struct spi_nor *nor)
|
|
|
|
{
|
2015-10-31 03:33:27 +00:00
|
|
|
return mtd_get_of_node(&nor->mtd);
|
2015-10-31 03:33:20 +00:00
|
|
|
}
|
|
|
|
|
2014-02-24 10:37:37 +00:00
|
|
|
/**
|
|
|
|
* spi_nor_scan() - scan the SPI NOR
|
|
|
|
* @nor: the spi_nor structure
|
2014-09-29 09:47:54 +00:00
|
|
|
* @name: the chip type name
|
2014-02-24 10:37:37 +00:00
|
|
|
* @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{}.
|
|
|
|
*
|
2014-09-29 09:47:54 +00:00
|
|
|
* The chip type name can be provided through the @name parameter.
|
2014-02-24 10:37:37 +00:00
|
|
|
*
|
|
|
|
* Return: 0 for success, others for failure.
|
|
|
|
*/
|
2014-09-29 09:47:54 +00:00
|
|
|
int spi_nor_scan(struct spi_nor *nor, const char *name, enum read_mode mode);
|
2014-02-24 10:37:37 +00:00
|
|
|
|
2014-02-24 10:37:35 +00:00
|
|
|
#endif
|