b5aec1424d
At present it is difficult to extend the SPI flash structure since all devices allocate it themselves, and few of them zero all fields. Add a new function spi_flash_alloc() which can be used by SPI devices to perform this allocation, and thus ensure that all devices can better cope with SPI structure changes. Signed-off-by: Simon Glass <sjg@chromium.org>
113 lines
3.1 KiB
C
113 lines
3.1 KiB
C
/*
|
|
* Interface to SPI flash
|
|
*
|
|
* Copyright (C) 2008 Atmel Corporation
|
|
*
|
|
* See file CREDITS for list of people who contributed to this
|
|
* project.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* version 2 as published by the Free Software Foundation.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*/
|
|
#ifndef _SPI_FLASH_H_
|
|
#define _SPI_FLASH_H_
|
|
|
|
#include <spi.h>
|
|
#include <linux/types.h>
|
|
#include <linux/compiler.h>
|
|
|
|
struct spi_flash {
|
|
struct spi_slave *spi;
|
|
|
|
const char *name;
|
|
|
|
/* Total flash size */
|
|
u32 size;
|
|
/* Write (page) size */
|
|
u32 page_size;
|
|
/* Erase (sector) size */
|
|
u32 sector_size;
|
|
|
|
int (*read)(struct spi_flash *flash, u32 offset,
|
|
size_t len, void *buf);
|
|
int (*write)(struct spi_flash *flash, u32 offset,
|
|
size_t len, const void *buf);
|
|
int (*erase)(struct spi_flash *flash, u32 offset,
|
|
size_t len);
|
|
};
|
|
|
|
/**
|
|
* spi_flash_do_alloc - Allocate a new spi flash structure
|
|
*
|
|
* The structure is allocated and cleared with default values for
|
|
* read, write and erase, which the caller can modify. The caller must set
|
|
* up size, page_size and sector_size.
|
|
*
|
|
* Use the helper macro spi_flash_alloc() to call this.
|
|
*
|
|
* @offset: Offset of struct spi_slave within slave structure
|
|
* @size: Size of slave structure
|
|
* @spi: SPI slave
|
|
* @name: Name of SPI flash device
|
|
*/
|
|
void *spi_flash_do_alloc(int offset, int size, struct spi_slave *spi,
|
|
const char *name);
|
|
|
|
/**
|
|
* spi_flash_alloc - Allocate a new SPI flash structure
|
|
*
|
|
* @_struct: Name of structure to allocate (e.g. struct ramtron_spi_fram). This
|
|
* structure must contain a member 'struct spi_flash *flash'.
|
|
* @spi: SPI slave
|
|
* @name: Name of SPI flash device
|
|
*/
|
|
#define spi_flash_alloc(_struct, spi, name) \
|
|
spi_flash_do_alloc(offsetof(_struct, flash), sizeof(_struct), \
|
|
spi, name)
|
|
|
|
/**
|
|
* spi_flash_alloc_base - Allocate a new SPI flash structure with no private data
|
|
*
|
|
* @spi: SPI slave
|
|
* @name: Name of SPI flash device
|
|
*/
|
|
#define spi_flash_alloc_base(spi, name) \
|
|
spi_flash_do_alloc(0, sizeof(struct spi_flash), spi, name)
|
|
|
|
struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
|
|
unsigned int max_hz, unsigned int spi_mode);
|
|
void spi_flash_free(struct spi_flash *flash);
|
|
|
|
static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
|
|
size_t len, void *buf)
|
|
{
|
|
return flash->read(flash, offset, len, buf);
|
|
}
|
|
|
|
static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
|
|
size_t len, const void *buf)
|
|
{
|
|
return flash->write(flash, offset, len, buf);
|
|
}
|
|
|
|
static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
|
|
size_t len)
|
|
{
|
|
return flash->erase(flash, offset, len);
|
|
}
|
|
|
|
void spi_boot(void) __noreturn;
|
|
|
|
#endif /* _SPI_FLASH_H_ */
|