c28984d9ea
RW flag was added to spi_slave structure to get around a requirement on
some AMD flash controllers that need to group together all spi volatile
operations (write/erase). This rw flag is not a property or attribute of
the SPI slave or controller. Thus, instead of saving it in spi_slave
structure, clean up the SPI flash driver interface. This allows
chipsets/mainboards (that require volatile operations to be grouped) to
indicate beginning and end of such grouped operations.
New user APIs are added to allow users to perform probe, read, write,
erase, volatile group begin and end operations. Callbacks defined in
spi_flash structure are expected to be used only by the SPI flash
driver. Any chipset that requires grouping of volatile operations can
select the newly added Kconfig option SPI_FLASH_HAS_VOLATILE_GROUP and
define callbacks for chipset_volatile_group_{begin,end}.
spi_claim_bus/spi_release_bus calls have been removed from the SPI flash
chip drivers which end up calling do_spi_flash_cmd since it already has
required calls for claiming and releasing SPI bus before performing a
read/write operation.
BUG=None
BRANCH=None
TEST=Compiles successfully.
Change-Id: Idfc052e82ec15b6c9fa874cee7a61bd06e923fbf
Signed-off-by: Furquan Shaikh <furquan@chromium.org>
Reviewed-on: https://review.coreboot.org/17462
Tested-by: build bot (Jenkins)
Reviewed-by: Aaron Durbin <adurbin@chromium.org>
80 lines
2.9 KiB
C
80 lines
2.9 KiB
C
/*
|
|
* SPI flash internal definitions
|
|
*
|
|
* Copyright (C) 2008 Atmel Corporation
|
|
*/
|
|
|
|
#ifndef SPI_FLASH_INTERNAL_H
|
|
#define SPI_FLASH_INTERNAL_H
|
|
|
|
/* Common parameters -- kind of high, but they should only occur when there
|
|
* is a problem (and well your system already is broken), so err on the side
|
|
* of caution in case we're dealing with slower SPI buses and/or processors.
|
|
*/
|
|
#define CONFIG_SYS_HZ 100
|
|
#define SPI_FLASH_PROG_TIMEOUT (2 * CONFIG_SYS_HZ)
|
|
#define SPI_FLASH_PAGE_ERASE_TIMEOUT (5 * CONFIG_SYS_HZ)
|
|
#define SPI_FLASH_SECTOR_ERASE_TIMEOUT (10 * CONFIG_SYS_HZ)
|
|
|
|
/* Common commands */
|
|
#define CMD_READ_ID 0x9f
|
|
|
|
#define CMD_READ_ARRAY_SLOW 0x03
|
|
#define CMD_READ_ARRAY_FAST 0x0b
|
|
#define CMD_READ_ARRAY_LEGACY 0xe8
|
|
|
|
#define CMD_READ_STATUS 0x05
|
|
#define CMD_WRITE_ENABLE 0x06
|
|
|
|
#define CMD_BLOCK_ERASE 0xD8
|
|
|
|
/* Common status */
|
|
#define STATUS_WIP 0x01
|
|
|
|
/* Send a single-byte command to the device and read the response */
|
|
int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len);
|
|
|
|
int spi_flash_cmd_read_fast(const struct spi_flash *flash, u32 offset,
|
|
size_t len, void *data);
|
|
|
|
int spi_flash_cmd_read_slow(const struct spi_flash *flash, u32 offset,
|
|
size_t len, void *data);
|
|
|
|
/*
|
|
* Send a multi-byte command to the device followed by (optional)
|
|
* data. Used for programming the flash array, etc.
|
|
*/
|
|
int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
|
|
const void *data, size_t data_len);
|
|
|
|
/* Send a command to the device and wait for some bit to clear itself. */
|
|
int spi_flash_cmd_poll_bit(const struct spi_flash *flash, unsigned long timeout,
|
|
u8 cmd, u8 poll_bit);
|
|
|
|
/*
|
|
* Send the read status command to the device and wait for the wip
|
|
* (write-in-progress) bit to clear itself.
|
|
*/
|
|
int spi_flash_cmd_wait_ready(const struct spi_flash *flash, unsigned long timeout);
|
|
|
|
/* Erase sectors. */
|
|
int spi_flash_cmd_erase(const struct spi_flash *flash, u32 offset, size_t len);
|
|
|
|
/* Read status register. */
|
|
int spi_flash_cmd_status(const struct spi_flash *flash, u8 *reg);
|
|
|
|
/* Manufacturer-specific probe functions */
|
|
struct spi_flash *spi_flash_probe_spansion(struct spi_slave *spi, u8 *idcode);
|
|
struct spi_flash *spi_flash_probe_amic(struct spi_slave *spi, u8 *idcode);
|
|
struct spi_flash *spi_flash_probe_atmel(struct spi_slave *spi, u8 *idcode);
|
|
struct spi_flash *spi_flash_probe_eon(struct spi_slave *spi, u8 *idcode);
|
|
struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode);
|
|
struct spi_flash *spi_flash_probe_sst(struct spi_slave *spi, u8 *idcode);
|
|
struct spi_flash *spi_flash_probe_stmicro(struct spi_slave *spi, u8 *idcode);
|
|
struct spi_flash *spi_flash_probe_winbond(struct spi_slave *spi, u8 *idcode);
|
|
struct spi_flash *spi_flash_probe_gigadevice(struct spi_slave *spi,
|
|
u8 *idcode);
|
|
struct spi_flash *spi_flash_probe_adesto(struct spi_slave *spi, u8 *idcode);
|
|
struct spi_flash *spi_fram_probe_ramtron(struct spi_slave *spi, u8 *idcode);
|
|
|
|
#endif /* SPI_FLASH_INTERNAL_H */
|