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 <linux/types.h>
  13 #include <linux/mtd/spi-nor.h>
  14
  15 struct udevice;
  16
  17 struct spi_slave;
  18
  19 struct dm_spi_flash_ops {
  20         int (*read)(struct udevice *dev, u32 offset, size_t len, void *buf);
  21         int (*write)(struct udevice *dev, u32 offset, size_t len,
  22                      const void *buf);
  23         int (*erase)(struct udevice *dev, u32 offset, size_t len);
  24         /**
  25          * get_sw_write_prot() - Check state of software write-protect feature
  26          *
  27          * SPI flash chips can lock a region of the flash defined by a
  28          * 'protected area'. This function checks if this protected area is
  29          * defined.
  30          *
  31          * @dev:        SPI flash device
  32          * @return 0 if no region is write-protected, 1 if a region is
  33          *      write-protected, -ENOSYS if the driver does not implement this,
  34          *      other -ve value on error
  35          */
  36         int (*get_sw_write_prot)(struct udevice *dev);
  37 };
  38
  39 /* Access the serial operations for a device */
  40 #define sf_get_ops(dev) ((struct dm_spi_flash_ops *)(dev)->driver->ops)
  41
  42 #if CONFIG_IS_ENABLED(DM_SPI_FLASH)
  43 /**
  44  * spi_flash_read_dm() - Read data from SPI flash
  45  *
  46  * @dev:        SPI flash device
  47  * @offset:     Offset into device in bytes to read from
  48  * @len:        Number of bytes to read
  49  * @buf:        Buffer to put the data that is read
  50  * @return 0 if OK, -ve on error
  51  */
  52 int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf);
  53
  54 /**
  55  * spi_flash_write_dm() - Write data to SPI flash
  56  *
  57  * @dev:        SPI flash device
  58  * @offset:     Offset into device in bytes to write to
  59  * @len:        Number of bytes to write
  60  * @buf:        Buffer containing bytes to write
  61  * @return 0 if OK, -ve on error
  62  */
  63 int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len,
  64                        const void *buf);
  65
  66 /**
  67  * spi_flash_erase_dm() - Erase blocks of the SPI flash
  68  *
  69  * Note that @len must be a muiltiple of the flash sector size.
  70  *
  71  * @dev:        SPI flash device
  72  * @offset:     Offset into device in bytes to start erasing
  73  * @len:        Number of bytes to erase
  74  * @return 0 if OK, -ve on error
  75  */
  76 int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len);
  77
  78 /**
  79  * spl_flash_get_sw_write_prot() - Check state of software write-protect feature
  80  *
  81  * SPI flash chips can lock a region of the flash defined by a
  82  * 'protected area'. This function checks if this protected area is
  83  * defined.
  84  *
  85  * @dev:        SPI flash device
  86  * @return 0 if no region is write-protected, 1 if a region is
  87  *      write-protected, -ENOSYS if the driver does not implement this,
  88  *      other -ve value on error
  89  */
  90 int spl_flash_get_sw_write_prot(struct udevice *dev);
  91
  92 /**
  93  * spi_flash_std_probe() - Probe a SPI flash device
  94  *
  95  * This is the standard internal method for probing a SPI flash device to
  96  * determine its type. It can be used in chip-specific drivers which need to
  97  * do this, typically with of-platdata
  98  *
  99  * @dev: SPI-flash device to probe
 100  * @return 0 if OK, -ve on error
 101  */
 102 int spi_flash_std_probe(struct udevice *dev);
 103
 104 int spi_flash_probe_bus_cs(unsigned int busnum, unsigned int cs,
 105                            unsigned int max_hz, unsigned int spi_mode,
 106                            struct udevice **devp);
 107
 108 /* Compatibility function - this is the old U-Boot API */
 109 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
 110                                   unsigned int max_hz, unsigned int spi_mode);
 111
 112 /* Compatibility function - this is the old U-Boot API */
 113 static inline void spi_flash_free(struct spi_flash *flash)
 114 {
 115 }
 116
 117 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
 118                                  size_t len, void *buf)
 119 {
 120         return spi_flash_read_dm(flash->dev, offset, len, buf);
 121 }
 122
 123 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
 124                                   size_t len, const void *buf)
 125 {
 126         return spi_flash_write_dm(flash->dev, offset, len, buf);
 127 }
 128
 129 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
 130                                   size_t len)
 131 {
 132         return spi_flash_erase_dm(flash->dev, offset, len);
 133 }
 134
 135 struct sandbox_state;
 136
 137 int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs,
 138                          struct udevice *bus, ofnode node, const char *spec);
 139
 140 void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs);
 141
 142 #else
 143 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
 144                 unsigned int max_hz, unsigned int spi_mode);
 145
 146 void spi_flash_free(struct spi_flash *flash);
 147
 148 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
 149                 size_t len, void *buf)
 150 {
 151         struct mtd_info *mtd = &flash->mtd;
 152         size_t retlen;
 153
 154         if (!len)
 155                 return 0;
 156
 157         return mtd->_read(mtd, offset, len, &retlen, buf);
 158 }
 159
 160 static inline int spi_flash_write(struct spi_flash *flash, u32 offset,
 161                 size_t len, const void *buf)
 162 {
 163         struct mtd_info *mtd = &flash->mtd;
 164         size_t retlen;
 165
 166         if (!len)
 167                 return 0;
 168
 169         return mtd->_write(mtd, offset, len, &retlen, buf);
 170 }
 171
 172 static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
 173                 size_t len)
 174 {
 175         struct mtd_info *mtd = &flash->mtd;
 176         struct erase_info instr;
 177
 178         if (offset % mtd->erasesize || len % mtd->erasesize) {
 179                 printf("SF: Erase offset/length not multiple of erase size\n");
 180                 return -EINVAL;
 181         }
 182
 183         if (!len)
 184                 return 0;
 185
 186         memset(&instr, 0, sizeof(instr));
 187         instr.addr = offset;
 188         instr.len = len;
 189
 190         return mtd->_erase(mtd, &instr);
 191 }
 192 #endif
 193
 194 static inline int spi_flash_protect(struct spi_flash *flash, u32 ofs, u32 len,
 195                                         bool prot)
 196 {
 197         if (!flash->flash_lock || !flash->flash_unlock)
 198                 return -EOPNOTSUPP;
 199
 200         if (prot)
 201                 return flash->flash_lock(flash, ofs, len);
 202         else
 203                 return flash->flash_unlock(flash, ofs, len);
 204 }
 205
 206 #endif /* _SPI_FLASH_H_ */