include/spi_flash.h

   1 /*
   2  * Common SPI flash Interface
   3  *
   4  * Copyright (C) 2008 Atmel Corporation
   5  * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
   6  *
   7  * See file CREDITS for list of people who contributed to this
   8  * project.
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * version 2 as published by the Free Software Foundation.
  13  */
  14
  15 #ifndef _SPI_FLASH_H_
  16 #define _SPI_FLASH_H_
  17
  18 #include <spi.h>
  19 #include <linux/types.h>
  20 #include <linux/compiler.h>
  21
  22 #ifndef CONFIG_SF_DEFAULT_SPEED
  23 # define CONFIG_SF_DEFAULT_SPEED        1000000
  24 #endif
  25 #ifndef CONFIG_SF_DEFAULT_MODE
  26 # define CONFIG_SF_DEFAULT_MODE         SPI_MODE_3
  27 #endif
  28 #ifndef CONFIG_SF_DEFAULT_CS
  29 # define CONFIG_SF_DEFAULT_CS           0
  30 #endif
  31 #ifndef CONFIG_SF_DEFAULT_BUS
  32 # define CONFIG_SF_DEFAULT_BUS          0
  33 #endif
  34
  35 /* sf param flags */
  36 #define SECT_4K         1 << 1
  37 #define SECT_32K        1 << 2
  38 #define E_FSR           1 << 3
  39 #define WR_QPP          1 << 4
  40
  41 /* Enum list - Full read commands */
  42 enum spi_read_cmds {
  43         ARRAY_SLOW = 1 << 0,
  44         DUAL_OUTPUT_FAST = 1 << 1,
  45         DUAL_IO_FAST = 1 << 2,
  46         QUAD_OUTPUT_FAST = 1 << 3,
  47         QUAD_IO_FAST = 1 << 4,
  48 };
  49 #define RD_EXTN         ARRAY_SLOW | DUAL_OUTPUT_FAST | DUAL_IO_FAST
  50 #define RD_FULL         RD_EXTN | QUAD_OUTPUT_FAST | QUAD_IO_FAST
  51
  52 /* Dual SPI flash memories */
  53 enum spi_dual_flash {
  54         SF_SINGLE_FLASH = 0,
  55         SF_DUAL_STACKED_FLASH = 1 << 0,
  56         SF_DUAL_PARALLEL_FLASH = 1 << 1,
  57 };
  58
  59 /**
  60  * struct spi_flash_params - SPI/QSPI flash device params structure
  61  *
  62  * @name:               Device name ([MANUFLETTER][DEVTYPE][DENSITY][EXTRAINFO])
  63  * @jedec:              Device jedec ID (0x[1byte_manuf_id][2byte_dev_id])
  64  * @ext_jedec:          Device ext_jedec ID
  65  * @sector_size:        Sector size of this device
  66  * @nr_sectors:         No.of sectors on this device
  67  * @e_rd_cmd:           Enum list for read commands
  68  * @flags:              Important param, for flash specific behaviour
  69  */
  70 struct spi_flash_params {
  71         const char *name;
  72         u32 jedec;
  73         u16 ext_jedec;
  74         u32 sector_size;
  75         u32 nr_sectors;
  76         u8 e_rd_cmd;
  77         u16 flags;
  78 };
  79
  80 extern const struct spi_flash_params spi_flash_params_table[];
  81
  82 /**
  83  * struct spi_flash - SPI flash structure
  84  *
  85  * @spi:                SPI slave
  86  * @name:               Name of SPI flash
  87  * @dual_flash:         Indicates dual flash memories - dual stacked, parallel
  88  * @shift:              Flash shift useful in dual parallel
  89  * @size:               Total flash size
  90  * @page_size:          Write (page) size
  91  * @sector_size:        Sector size
  92  * @erase_size:         Erase size
  93  * @bank_read_cmd:      Bank read cmd
  94  * @bank_write_cmd:     Bank write cmd
  95  * @bank_curr:          Current flash bank
  96  * @poll_cmd:           Poll cmd - for flash erase/program
  97  * @erase_cmd:          Erase cmd 4K, 32K, 64K
  98  * @read_cmd:           Read cmd - Array Fast, Extn read and quad read.
  99  * @write_cmd:          Write cmd - page and quad program.
 100  * @dummy_byte:         Dummy cycles for read operation.
 101  * @memory_map:         Address of read-only SPI flash access
 102  * @read:               Flash read ops: Read len bytes at offset into buf
 103  *                      Supported cmds: Fast Array Read
 104  * @write:              Flash write ops: Write len bytes from buf into offset
 105  *                      Supported cmds: Page Program
 106  * @erase:              Flash erase ops: Erase len bytes from offset
 107  *                      Supported cmds: Sector erase 4K, 32K, 64K
 108  * return 0 - Success, 1 - Failure
 109  */
 110 struct spi_flash {
 111         struct spi_slave *spi;
 112         const char *name;
 113         u8 dual_flash;
 114         u8 shift;
 115
 116         u32 size;
 117         u32 page_size;
 118         u32 sector_size;
 119         u32 erase_size;
 120 #ifdef CONFIG_SPI_FLASH_BAR
 121         u8 bank_read_cmd;
 122         u8 bank_write_cmd;
 123         u8 bank_curr;
 124 #endif
 125         u8 poll_cmd;
 126         u8 erase_cmd;
 127         u8 read_cmd;
 128         u8 write_cmd;
 129         u8 dummy_byte;
 130
 131         void *memory_map;
 132         int (*read)(struct spi_flash *flash, u32 offset, size_t len, void *buf);
 133         int (*write)(struct spi_flash *flash, u32 offset, size_t len,
 134                         const void *buf);
 135         int (*erase)(struct spi_flash *flash, u32 offset, size_t len);
 136 };
 137
 138 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
 139                 unsigned int max_hz, unsigned int spi_mode);
 140
 141 /**
 142  * Set up a new SPI flash from an fdt node
 143  *
 144  * @param blob          Device tree blob
 145  * @param slave_node    Pointer to this SPI slave node in the device tree
 146  * @param spi_node      Cached pointer to the SPI interface this node belongs
 147  *                      to
 148  * @return 0 if ok, -1 on error
 149  */
 150 struct spi_flash *spi_flash_probe_fdt(const void *blob, int slave_node,
 151                                       int spi_node);
 152
 153 void spi_flash_free(struct spi_flash *flash);
 154
 155 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
 156                 size_t len, void *buf)
 157 {
 158         return flash->read(flash, offset, len, buf);
 159 }
 160
 161 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
 162                 size_t len, const void *buf)
 163 {
 164         return flash->write(flash, offset, len, buf);
 165 }
 166
 167 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
 168                 size_t len)
 169 {
 170         return flash->erase(flash, offset, len);
 171 }
 172
 173 void spi_boot(void) __noreturn;
 174 void spi_spl_load_image(uint32_t offs, unsigned int size, void *vdst);
 175
 176 #endif /* _SPI_FLASH_H_ */