include/spi_flash.h

   1 /*
   2  * Interface to SPI flash
   3  *
   4  * Copyright (C) 2008 Atmel Corporation
   5  *
   6  * See file CREDITS for list of people who contributed to this
   7  * project.
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * version 2 as published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  21  * MA 02111-1307 USA
  22  */
  23 #ifndef _SPI_FLASH_H_
  24 #define _SPI_FLASH_H_
  25
  26 #include <spi.h>
  27 #include <linux/types.h>
  28 #include <linux/compiler.h>
  29
  30 struct spi_flash {
  31         struct spi_slave *spi;
  32
  33         const char      *name;
  34
  35         /* Total flash size */
  36         u32             size;
  37         /* Write (page) size */
  38         u32             page_size;
  39         /* Erase (sector) size */
  40         u32             sector_size;
  41         /* Bank read cmd */
  42         u8              bank_read_cmd;
  43         /* Bank write cmd */
  44         u8              bank_write_cmd;
  45         /* Current flash bank */
  46         u8              bank_curr;
  47
  48         void *memory_map;       /* Address of read-only SPI flash access */
  49         int             (*read)(struct spi_flash *flash, u32 offset,
  50                                 size_t len, void *buf);
  51         int             (*write)(struct spi_flash *flash, u32 offset,
  52                                 size_t len, const void *buf);
  53         int             (*erase)(struct spi_flash *flash, u32 offset,
  54                                 size_t len);
  55 };
  56
  57 /**
  58  * spi_flash_do_alloc - Allocate a new spi flash structure
  59  *
  60  * The structure is allocated and cleared with default values for
  61  * read, write and erase, which the caller can modify. The caller must set
  62  * up size, page_size and sector_size.
  63  *
  64  * Use the helper macro spi_flash_alloc() to call this.
  65  *
  66  * @offset: Offset of struct spi_slave within slave structure
  67  * @size: Size of slave structure
  68  * @spi: SPI slave
  69  * @name: Name of SPI flash device
  70  */
  71 void *spi_flash_do_alloc(int offset, int size, struct spi_slave *spi,
  72                          const char *name);
  73
  74 /**
  75  * spi_flash_alloc - Allocate a new SPI flash structure
  76  *
  77  * @_struct: Name of structure to allocate (e.g. struct ramtron_spi_fram). This
  78  *      structure must contain a member 'struct spi_flash *flash'.
  79  * @spi: SPI slave
  80  * @name: Name of SPI flash device
  81  */
  82 #define spi_flash_alloc(_struct, spi, name) \
  83         spi_flash_do_alloc(offsetof(_struct, flash), sizeof(_struct), \
  84                                 spi, name)
  85
  86 /**
  87  * spi_flash_alloc_base - Allocate a new SPI flash structure with no private data
  88  *
  89  * @spi: SPI slave
  90  * @name: Name of SPI flash device
  91  */
  92 #define spi_flash_alloc_base(spi, name) \
  93         spi_flash_do_alloc(0, sizeof(struct spi_flash), spi, name)
  94
  95 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
  96                 unsigned int max_hz, unsigned int spi_mode);
  97 void spi_flash_free(struct spi_flash *flash);
  98
  99 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
 100                 size_t len, void *buf)
 101 {
 102         return flash->read(flash, offset, len, buf);
 103 }
 104
 105 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
 106                 size_t len, const void *buf)
 107 {
 108         return flash->write(flash, offset, len, buf);
 109 }
 110
 111 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
 112                 size_t len)
 113 {
 114         return flash->erase(flash, offset, len);
 115 }
 116
 117 void spi_boot(void) __noreturn;
 118
 119 #endif /* _SPI_FLASH_H_ */