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
  28 struct spi_flash_region {
  29         unsigned int    count;
  30         unsigned int    size;
  31 };
  32
  33 struct spi_flash {
  34         struct spi_slave *spi;
  35
  36         const char      *name;
  37
  38         u32             size;
  39
  40         int             (*read)(struct spi_flash *flash, u32 offset,
  41                                 size_t len, void *buf);
  42         int             (*write)(struct spi_flash *flash, u32 offset,
  43                                 size_t len, const void *buf);
  44         int             (*erase)(struct spi_flash *flash, u32 offset,
  45                                 size_t len);
  46 };
  47
  48 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
  49                 unsigned int max_hz, unsigned int spi_mode);
  50 void spi_flash_free(struct spi_flash *flash);
  51
  52 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
  53                 size_t len, void *buf)
  54 {
  55         return flash->read(flash, offset, len, buf);
  56 }
  57
  58 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
  59                 size_t len, const void *buf)
  60 {
  61         return flash->write(flash, offset, len, buf);
  62 }
  63
  64 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
  65                 size_t len)
  66 {
  67         return flash->erase(flash, offset, len);
  68 }
  69
  70 #endif /* _SPI_FLASH_H_ */