include/spi_flash.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Common SPI flash Interface
   4  *
   5  * Copyright (C) 2008 Atmel Corporation
   6  * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
   7  */
   8
   9 #ifndef _SPI_FLASH_H_
  10 #define _SPI_FLASH_H_
  11
  12 #include <dm.h> /* Because we dereference struct udevice here */
  13 #include <linux/types.h>
  14
  15 #ifndef CONFIG_SF_DEFAULT_SPEED
  16 # define CONFIG_SF_DEFAULT_SPEED        1000000
  17 #endif
  18 #ifndef CONFIG_SF_DEFAULT_MODE
  19 # define CONFIG_SF_DEFAULT_MODE         SPI_MODE_3
  20 #endif
  21 #ifndef CONFIG_SF_DEFAULT_CS
  22 # define CONFIG_SF_DEFAULT_CS           0
  23 #endif
  24 #ifndef CONFIG_SF_DEFAULT_BUS
  25 # define CONFIG_SF_DEFAULT_BUS          0
  26 #endif
  27
  28 struct spi_slave;
  29
  30 /**
  31  * struct spi_flash - SPI flash structure
  32  *
  33  * @spi:                SPI slave
  34  * @dev:                SPI flash device
  35  * @name:               Name of SPI flash
  36  * @dual_flash:         Indicates dual flash memories - dual stacked, parallel
  37  * @shift:              Flash shift useful in dual parallel
  38  * @flags:              Indication of spi flash flags
  39  * @size:               Total flash size
  40  * @page_size:          Write (page) size
  41  * @sector_size:        Sector size
  42  * @erase_size:         Erase size
  43  * @bank_read_cmd:      Bank read cmd
  44  * @bank_write_cmd:     Bank write cmd
  45  * @bank_curr:          Current flash bank
  46  * @erase_cmd:          Erase cmd 4K, 32K, 64K
  47  * @read_cmd:           Read cmd - Array Fast, Extn read and quad read.
  48  * @write_cmd:          Write cmd - page and quad program.
  49  * @dummy_byte:         Dummy cycles for read operation.
  50  * @memory_map:         Address of read-only SPI flash access
  51  * @flash_lock:         lock a region of the SPI Flash
  52  * @flash_unlock:       unlock a region of the SPI Flash
  53  * @flash_is_locked:    check if a region of the SPI Flash is completely locked
  54  * @read:               Flash read ops: Read len bytes at offset into buf
  55  *                      Supported cmds: Fast Array Read
  56  * @write:              Flash write ops: Write len bytes from buf into offset
  57  *                      Supported cmds: Page Program
  58  * @erase:              Flash erase ops: Erase len bytes from offset
  59  *                      Supported cmds: Sector erase 4K, 32K, 64K
  60  * return 0 - Success, 1 - Failure
  61  */
  62 struct spi_flash {
  63         struct spi_slave *spi;
  64 #ifdef CONFIG_DM_SPI_FLASH
  65         struct udevice *dev;
  66 #endif
  67         const char *name;
  68         u8 dual_flash;
  69         u8 shift;
  70         u16 flags;
  71
  72         u32 size;
  73         u32 page_size;
  74         u32 sector_size;
  75         u32 erase_size;
  76 #ifdef CONFIG_SPI_FLASH_BAR
  77         u8 bank_read_cmd;
  78         u8 bank_write_cmd;
  79         u8 bank_curr;
  80 #endif
  81         u8 erase_cmd;
  82         u8 read_cmd;
  83         u8 write_cmd;
  84         u8 dummy_byte;
  85
  86         void *memory_map;
  87
  88         int (*flash_lock)(struct spi_flash *flash, u32 ofs, size_t len);
  89         int (*flash_unlock)(struct spi_flash *flash, u32 ofs, size_t len);
  90         int (*flash_is_locked)(struct spi_flash *flash, u32 ofs, size_t len);
  91 #ifndef CONFIG_DM_SPI_FLASH
  92         /*
  93          * These are not strictly needed for driver model, but keep them here
  94          * while the transition is in progress.
  95          *
  96          * Normally each driver would provide its own operations, but for
  97          * SPI flash most chips use the same algorithms. One approach is
  98          * to create a 'common' SPI flash device which knows how to talk
  99          * to most devices, and then allow other drivers to be used instead
 100          * if required, perhaps with a way of scanning through the list to
 101          * find the driver that matches the device.
 102          */
 103         int (*read)(struct spi_flash *flash, u32 offset, size_t len, void *buf);
 104         int (*write)(struct spi_flash *flash, u32 offset, size_t len,
 105                         const void *buf);
 106         int (*erase)(struct spi_flash *flash, u32 offset, size_t len);
 107 #endif
 108 };
 109
 110 struct dm_spi_flash_ops {
 111         int (*read)(struct udevice *dev, u32 offset, size_t len, void *buf);
 112         int (*write)(struct udevice *dev, u32 offset, size_t len,
 113                      const void *buf);
 114         int (*erase)(struct udevice *dev, u32 offset, size_t len);
 115 };
 116
 117 /* Access the serial operations for a device */
 118 #define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops)
 119
 120 #ifdef CONFIG_DM_SPI_FLASH
 121 /**
 122  * spi_flash_read_dm() - Read data from SPI flash
 123  *
 124  * @dev:        SPI flash device
 125  * @offset:     Offset into device in bytes to read from
 126  * @len:        Number of bytes to read
 127  * @buf:        Buffer to put the data that is read
 128  * @return 0 if OK, -ve on error
 129  */
 130 int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf);
 131
 132 /**
 133  * spi_flash_write_dm() - Write data to SPI flash
 134  *
 135  * @dev:        SPI flash device
 136  * @offset:     Offset into device in bytes to write to
 137  * @len:        Number of bytes to write
 138  * @buf:        Buffer containing bytes to write
 139  * @return 0 if OK, -ve on error
 140  */
 141 int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len,
 142                        const void *buf);
 143
 144 /**
 145  * spi_flash_erase_dm() - Erase blocks of the SPI flash
 146  *
 147  * Note that @len must be a muiltiple of the flash sector size.
 148  *
 149  * @dev:        SPI flash device
 150  * @offset:     Offset into device in bytes to start erasing
 151  * @len:        Number of bytes to erase
 152  * @return 0 if OK, -ve on error
 153  */
 154 int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len);
 155
 156 int spi_flash_probe_bus_cs(unsigned int busnum, unsigned int cs,
 157                            unsigned int max_hz, unsigned int spi_mode,
 158                            struct udevice **devp);
 159
 160 /* Compatibility function - this is the old U-Boot API */
 161 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
 162                                   unsigned int max_hz, unsigned int spi_mode);
 163
 164 /* Compatibility function - this is the old U-Boot API */
 165 void spi_flash_free(struct spi_flash *flash);
 166
 167 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
 168                                  size_t len, void *buf)
 169 {
 170         return spi_flash_read_dm(flash->dev, offset, len, buf);
 171 }
 172
 173 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
 174                                   size_t len, const void *buf)
 175 {
 176         return spi_flash_write_dm(flash->dev, offset, len, buf);
 177 }
 178
 179 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
 180                                   size_t len)
 181 {
 182         return spi_flash_erase_dm(flash->dev, offset, len);
 183 }
 184
 185 struct sandbox_state;
 186
 187 int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs,
 188                          struct udevice *bus, ofnode node, const char *spec);
 189
 190 void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs);
 191
 192 #else
 193 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
 194                 unsigned int max_hz, unsigned int spi_mode);
 195
 196 void spi_flash_free(struct spi_flash *flash);
 197
 198 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
 199                 size_t len, void *buf)
 200 {
 201         return flash->read(flash, offset, len, buf);
 202 }
 203
 204 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
 205                 size_t len, const void *buf)
 206 {
 207         return flash->write(flash, offset, len, buf);
 208 }
 209
 210 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
 211                 size_t len)
 212 {
 213         return flash->erase(flash, offset, len);
 214 }
 215 #endif
 216
 217 static inline int spi_flash_protect(struct spi_flash *flash, u32 ofs, u32 len,
 218                                         bool prot)
 219 {
 220         if (!flash->flash_lock || !flash->flash_unlock)
 221                 return -EOPNOTSUPP;
 222
 223         if (prot)
 224                 return flash->flash_lock(flash, ofs, len);
 225         else
 226                 return flash->flash_unlock(flash, ofs, len);
 227 }
 228
 229 #endif /* _SPI_FLASH_H_ */