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