GitHub-Mirror/u-boot
2
0
Fork 0
mirror of https://github.com/Fishwaldo/u-boot.git synced 2025-03-21 14:41:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

sf: spi_flash cleanups

Browse source 
More cleanups on spi_flash side:
- Removed unneeded comments.
- Rearranged macros in proper location.
- Rearranged func declerations
- Renamed few function names.
- Added License headers.

Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
This commit is contained in:
Jagannadha Sutradharudu Teki 2013-10-02 19:38:49 +05:30
parent 30b0ca6318
commit a5e8199a13
5 changed files with 85 additions and 74 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
drivers/mtd/spi/Makefile
View file

@ -17,8 +17,8 @@ endif
ifdef CONFIG_CMD_SF ifdef CONFIG_CMD_SF
COBJS-y += spi_flash.o COBJS-y += spi_flash.o
endif endif
COBJS-$(CONFIG_SPI_FLASH) += spi_flash_probe.o spi_flash_ops.o COBJS-$(CONFIG_SPI_FLASH) += spi_flash_probe.o spi_flash_ops.o
COBJS-$(CONFIG_SPI_FRAM_RAMTRON) += ramtron.o COBJS-$(CONFIG_SPI_FRAM_RAMTRON) += ramtron.o
COBJS-$(CONFIG_SPI_M95XXX) += eeprom_m95xxx.o COBJS-$(CONFIG_SPI_M95XXX) += eeprom_m95xxx.o
COBJS := $(COBJS-y) COBJS := $(COBJS-y)

119
drivers/mtd/spi/spi_flash_internal.h
View file

@ -2,37 +2,43 @@
* SPI flash internal definitions * SPI flash internal definitions
* *
* Copyright (C) 2008 Atmel Corporation * Copyright (C) 2008 Atmel Corporation
* Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
*
* Licensed under the GPL-2 or later.
*/ */
/* Common parameters -- kind of high, but they should only occur when there #ifndef _SPI_FLASH_INTERNAL_H_
* is a problem (and well your system already is broken), so err on the side #define _SPI_FLASH_INTERNAL_H_
* of caution in case we're dealing with slower SPI buses and/or processors.
*/
#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 SPI_FLASH_16MB_BOUN 0x1000000
#define CMD_READ_ID 0x9f
#define CMD_READ_ARRAY_SLOW 0x03 /* SECT flags */
#define CMD_READ_ARRAY_FAST 0x0b #define SECT_4K (1 << 1)
#define SECT_32K (1 << 2)
#define E_FSR (1 << 3)
/* Erase commands */
#define CMD_ERASE_4K 0x20
#define CMD_ERASE_32K 0x52
#define CMD_ERASE_CHIP 0xc7
#define CMD_ERASE_64K 0xd8
/* Write commands */
#define CMD_WRITE_STATUS 0x01 #define CMD_WRITE_STATUS 0x01
#define CMD_PAGE_PROGRAM 0x02 #define CMD_PAGE_PROGRAM 0x02
#define CMD_WRITE_DISABLE 0x04 #define CMD_WRITE_DISABLE 0x04
#define CMD_READ_STATUS 0x05 #define CMD_READ_STATUS 0x05
#define CMD_FLAG_STATUS 0x70
#define CMD_WRITE_ENABLE 0x06 #define CMD_WRITE_ENABLE 0x06
#define CMD_ERASE_4K 0x20 #define CMD_READ_CONFIG 0x35
#define CMD_ERASE_32K 0x52 #define CMD_FLAG_STATUS 0x70
#define CMD_ERASE_64K 0xd8
#define CMD_ERASE_CHIP 0xc7
#define SPI_FLASH_16MB_BOUN 0x1000000 /* Read commands */
#define CMD_READ_ARRAY_SLOW 0x03
#define CMD_READ_ARRAY_FAST 0x0b
#define CMD_READ_ID 0x9f
#ifdef CONFIG_SPI_FLASH_BAR
/* Bank addr access commands */ /* Bank addr access commands */
#ifdef CONFIG_SPI_FLASH_BAR
# define CMD_BANKADDR_BRWR 0x17 # define CMD_BANKADDR_BRWR 0x17
# define CMD_BANKADDR_BRRD 0x16 # define CMD_BANKADDR_BRRD 0x16
# define CMD_EXTNADDR_WREAR 0xC5 # define CMD_EXTNADDR_WREAR 0xC5
@ -43,6 +49,21 @@
#define STATUS_WIP 0x01 #define STATUS_WIP 0x01
#define STATUS_PEC 0x80 #define STATUS_PEC 0x80
/* Flash timeout values */
#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)
/* SST specific */
#ifdef CONFIG_SPI_FLASH_SST
# define SST_WP 0x01 /* Supports AAI word program */
# define CMD_SST_BP 0x02 /* Byte Program */
# define CMD_SST_AAI_WP 0xAD /* Auto Address Incr Word Program */
int sst_write_wp(struct spi_flash *flash, u32 offset, size_t len,
const void *buf);
#endif
/* Send a single-byte command to the device and read the response */ /* 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(struct spi_slave *spi, u8 cmd, void *response, size_t len);
@ -53,9 +74,6 @@ int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len);
int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd, int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
size_t cmd_len, void *data, size_t data_len); size_t cmd_len, void *data, size_t data_len);
int spi_flash_cmd_read_fast(struct spi_flash *flash, u32 offset,
size_t len, void *data);
/* /*
* Send a multi-byte command to the device followed by (optional) * Send a multi-byte command to the device followed by (optional)
* data. Used for programming the flash array, etc. * data. Used for programming the flash array, etc.
@ -63,43 +81,34 @@ int spi_flash_cmd_read_fast(struct spi_flash *flash, u32 offset,
int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len, int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
const void *data, size_t data_len); const void *data, size_t data_len);
/*
* Write the requested data out breaking it up into multiple write
* commands as needed per the write size.
*/
int spi_flash_cmd_write_multi(struct spi_flash *flash, u32 offset,
size_t len, const void *buf);
#ifdef CONFIG_SPI_FLASH_SST /* Flash erase(sectors) operation, support all possible erase commands */
int sst_write_wp(struct spi_flash *flash, u32 offset, size_t len, int spi_flash_cmd_erase_ops(struct spi_flash *flash, u32 offset, size_t len);
const void *buf);
#endif
/* /* Program the status register */
* Enable writing on the SPI flash. int spi_flash_cmd_write_status(struct spi_flash *flash, u8 sr);
*/
/* Set quad enbale bit */
int spi_flash_set_qeb(struct spi_flash *flash);
/* Enable writing on the SPI flash */
static inline int spi_flash_cmd_write_enable(struct spi_flash *flash) static inline int spi_flash_cmd_write_enable(struct spi_flash *flash)
{ {
return spi_flash_cmd(flash->spi, CMD_WRITE_ENABLE, NULL, 0); return spi_flash_cmd(flash->spi, CMD_WRITE_ENABLE, NULL, 0);
} }
/* /* Disable writing on the SPI flash */
* Disable writing on the SPI flash.
*/
static inline int spi_flash_cmd_write_disable(struct spi_flash *flash) static inline int spi_flash_cmd_write_disable(struct spi_flash *flash)
{ {
return spi_flash_cmd(flash->spi, CMD_WRITE_DISABLE, NULL, 0); return spi_flash_cmd(flash->spi, CMD_WRITE_DISABLE, NULL, 0);
} }
/* Program the status register. */
int spi_flash_cmd_write_status(struct spi_flash *flash, u8 sr);
/* /*
* Same as spi_flash_cmd_read() except it also claims/releases the SPI * Send the read status command to the device and wait for the wip
* bus. Used as common part of the ->read() operation. * (write-in-progress) bit to clear itself.
*/ */
int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd, int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout);
size_t cmd_len, void *data, size_t data_len);
/* /*
* Used for spi_flash write operation * Used for spi_flash write operation
* - SPI claim * - SPI claim
@ -112,10 +121,22 @@ int spi_flash_write_common(struct spi_flash *flash, const u8 *cmd,
size_t cmd_len, const void *buf, size_t buf_len); size_t cmd_len, const void *buf, size_t buf_len);
/* /*
* Send the read status command to the device and wait for the wip * Flash write operation, support all possible write commands.
* (write-in-progress) bit to clear itself. * Write the requested data out breaking it up into multiple write
* commands as needed per the write size.
*/ */
int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout); int spi_flash_cmd_write_ops(struct spi_flash *flash, u32 offset,
size_t len, const void *buf);
/* Erase sectors. */ /*
int spi_flash_cmd_erase(struct spi_flash *flash, u32 offset, size_t len); * Same as spi_flash_cmd_read() except it also claims/releases the SPI
* bus. Used as common part of the ->read() operation.
*/
int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
size_t cmd_len, void *data, size_t data_len);
/* Flash read operation, support all possible read commands */
int spi_flash_cmd_read_ops(struct spi_flash *flash, u32 offset,
size_t len, void *data);
#endif /* _SPI_FLASH_INTERNAL_H_ */

6
drivers/mtd/spi/spi_flash_ops.c
View file

@ -147,7 +147,7 @@ int spi_flash_write_common(struct spi_flash *flash, const u8 *cmd,
return ret; return ret;
} }
int spi_flash_cmd_erase(struct spi_flash *flash, u32 offset, size_t len) int spi_flash_cmd_erase_ops(struct spi_flash *flash, u32 offset, size_t len)
{ {
u32 erase_size; u32 erase_size;
u8 cmd[4]; u8 cmd[4];
@ -190,7 +190,7 @@ int spi_flash_cmd_erase(struct spi_flash *flash, u32 offset, size_t len)
return ret; return ret;
} }
int spi_flash_cmd_write_multi(struct spi_flash *flash, u32 offset, int spi_flash_cmd_write_ops(struct spi_flash *flash, u32 offset,
size_t len, const void *buf) size_t len, const void *buf)
{ {
unsigned long byte_addr, page_size; unsigned long byte_addr, page_size;
@ -260,7 +260,7 @@ int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
return ret; return ret;
} }
int spi_flash_cmd_read_fast(struct spi_flash *flash, u32 offset, int spi_flash_cmd_read_ops(struct spi_flash *flash, u32 offset,
size_t len, void *data) size_t len, void *data)
{ {
u8 cmd[5], bank_sel = 0; u8 cmd[5], bank_sel = 0;

14
drivers/mtd/spi/spi_flash_probe.c
View file

@ -18,7 +18,7 @@
DECLARE_GLOBAL_DATA_PTR; DECLARE_GLOBAL_DATA_PTR;
/* /**
* struct spi_flash_params - SPI/QSPI flash device params structure * struct spi_flash_params - SPI/QSPI flash device params structure
* *
* @name: Device name ([MANUFLETTER][DEVTYPE][DENSITY][EXTRAINFO]) * @name: Device name ([MANUFLETTER][DEVTYPE][DENSITY][EXTRAINFO])
@ -151,7 +151,7 @@ static const struct spi_flash_params spi_flash_params_table[] = {
*/ */
}; };
struct spi_flash *spi_flash_validate_ids(struct spi_slave *spi, u8 *idcode) struct spi_flash *spi_flash_validate_params(struct spi_slave *spi, u8 *idcode)
{ {
const struct spi_flash_params *params; const struct spi_flash_params *params;
struct spi_flash *flash; struct spi_flash *flash;
@ -190,13 +190,13 @@ struct spi_flash *spi_flash_validate_ids(struct spi_slave *spi, u8 *idcode)
flash->name = params->name; flash->name = params->name;
/* Assign spi_flash ops */ /* Assign spi_flash ops */
flash->write = spi_flash_cmd_write_multi; flash->write = spi_flash_cmd_write_ops;
#ifdef CONFIG_SPI_FLASH_SST #ifdef CONFIG_SPI_FLASH_SST
if (params->flags & SST_WP) if (params->flags & SST_WP)
flash->write = sst_write_wp; flash->write = sst_write_wp;
#endif #endif
flash->erase = spi_flash_cmd_erase; flash->erase = spi_flash_cmd_erase_ops;
flash->read = spi_flash_cmd_read_fast; flash->read = spi_flash_cmd_read_ops;
/* Compute the flash size */ /* Compute the flash size */
flash->page_size = (ext_jedec == 0x4d00) ? 512 : 256; flash->page_size = (ext_jedec == 0x4d00) ? 512 : 256;
@ -314,8 +314,8 @@ struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
print_buffer(0, idcode, 1, sizeof(idcode), 0); print_buffer(0, idcode, 1, sizeof(idcode), 0);
#endif #endif
/* Validate ID's from flash dev table */ /* Validate params from spi_flash_params table */
flash = spi_flash_validate_ids(spi, idcode); flash = spi_flash_validate_params(spi, idcode);
if (!flash) if (!flash)
goto err_read_id; goto err_read_id;

16
include/spi_flash.h
View file

@ -1,7 +1,8 @@
/* /*
* Interface to SPI flash * Common SPI flash Interface
* *
* Copyright (C) 2008 Atmel Corporation * Copyright (C) 2008 Atmel Corporation
* Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
* *
* See file CREDITS for list of people who contributed to this * See file CREDITS for list of people who contributed to this
* project. * project.
@ -10,6 +11,7 @@
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
* version 2 as published by the Free Software Foundation. * version 2 as published by the Free Software Foundation.
*/ */
#ifndef _SPI_FLASH_H_ #ifndef _SPI_FLASH_H_
#define _SPI_FLASH_H_ #define _SPI_FLASH_H_
@ -17,18 +19,6 @@
#include <linux/types.h> #include <linux/types.h>
#include <linux/compiler.h> #include <linux/compiler.h>
/* SECT flags */
#define SECT_4K (1 << 1)
#define SECT_32K (1 << 2)
#define E_FSR (1 << 3)
/* SST specific macros */
#ifdef CONFIG_SPI_FLASH_SST
# define SST_WP 0x01 /* Supports AAI word program */
# define CMD_SST_BP 0x02 /* Byte Program */
# define CMD_SST_AAI_WP 0xAD /* Auto Address Incr Word Program */
#endif
/** /**
* struct spi_flash - SPI flash structure * struct spi_flash - SPI flash structure
* *