Merge branch 'master' of git://git.denx.de/u-boot-sunxi

[u-boot] / include / spi_flash.h

diff --git a/include/spi_flash.h b/include/spi_flash.h
index f2814ef41a0b3c27b2e82352190de831559422c9..0ec98fb55df5b63300f5941ad831840400211a7c 100644 (file)
--- a/include/spi_flash.h
+++ b/include/spi_flash.h
@@ -1,15 +1,9 @@
+/* SPDX-License-Identifier: GPL-2.0 */
 /*
  * Common SPI flash Interface
  *
  * Copyright (C) 2008 Atmel Corporation
  * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
- *
- * See file CREDITS for list of people who contributed to this
- * project.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * version 2 as published by the Free Software Foundation.
  */
 
 #ifndef _SPI_FLASH_H_
@@ -37,22 +31,26 @@ struct spi_slave;
  * struct spi_flash - SPI flash structure
  *
  * @spi:               SPI slave
+ * @dev:               SPI flash device
  * @name:              Name of SPI flash
- * @dual_flash:        Indicates dual flash memories - dual stacked, parallel
+ * @dual_flash:                Indicates dual flash memories - dual stacked, parallel
  * @shift:             Flash shift useful in dual parallel
+ * @flags:             Indication of spi flash flags
  * @size:              Total flash size
  * @page_size:         Write (page) size
  * @sector_size:       Sector size
- * @erase_size:        Erase size
+ * @erase_size:                Erase size
  * @bank_read_cmd:     Bank read cmd
  * @bank_write_cmd:    Bank write cmd
  * @bank_curr:         Current flash bank
- * @poll_cmd:          Poll cmd - for flash erase/program
  * @erase_cmd:         Erase cmd 4K, 32K, 64K
  * @read_cmd:          Read cmd - Array Fast, Extn read and quad read.
  * @write_cmd:         Write cmd - page and quad program.
- * @dummy_byte:        Dummy cycles for read operation.
- * @memory_map:        Address of read-only SPI flash access
+ * @dummy_byte:                Dummy cycles for read operation.
+ * @memory_map:                Address of read-only SPI flash access
+ * @flash_lock:                lock a region of the SPI Flash
+ * @flash_unlock:      unlock a region of the SPI Flash
+ * @flash_is_locked:   check if a region of the SPI Flash is completely locked
  * @read:              Flash read ops: Read len bytes at offset into buf
  *                     Supported cmds: Fast Array Read
  * @write:             Flash write ops: Write len bytes from buf into offset
@@ -65,11 +63,11 @@ struct spi_flash {
        struct spi_slave *spi;
 #ifdef CONFIG_DM_SPI_FLASH
        struct udevice *dev;
-       u16 flags;
 #endif
        const char *name;
        u8 dual_flash;
        u8 shift;
+       u16 flags;
 
        u32 size;
        u32 page_size;
@@ -80,13 +78,16 @@ struct spi_flash {
        u8 bank_write_cmd;
        u8 bank_curr;
 #endif
-       u8 poll_cmd;
        u8 erase_cmd;
        u8 read_cmd;
        u8 write_cmd;
        u8 dummy_byte;
 
        void *memory_map;
+
+       int (*flash_lock)(struct spi_flash *flash, u32 ofs, size_t len);
+       int (*flash_unlock)(struct spi_flash *flash, u32 ofs, size_t len);
+       int (*flash_is_locked)(struct spi_flash *flash, u32 ofs, size_t len);
 #ifndef CONFIG_DM_SPI_FLASH
        /*
         * These are not strictly needed for driver model, but keep them here
@@ -163,8 +164,6 @@ struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
 /* Compatibility function - this is the old U-Boot API */
 void spi_flash_free(struct spi_flash *flash);
 
-int spi_flash_remove(struct udevice *flash);
-
 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
                                 size_t len, void *buf)
 {
@@ -186,7 +185,7 @@ static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
 struct sandbox_state;
 
 int sandbox_sf_bind_emul(struct sandbox_state *state, int busnum, int cs,
-                        struct udevice *bus, int of_offset, const char *spec);
+                        struct udevice *bus, ofnode node, const char *spec);
 
 void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs);
 
@@ -194,18 +193,6 @@ void sandbox_sf_unbind_emul(struct sandbox_state *state, int busnum, int cs);
 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
                unsigned int max_hz, unsigned int spi_mode);
 
-/**
- * Set up a new SPI flash from an fdt node
- *
- * @param blob         Device tree blob
- * @param slave_node   Pointer to this SPI slave node in the device tree
- * @param spi_node     Cached pointer to the SPI interface this node belongs
- *                     to
- * @return 0 if ok, -1 on error
- */
-struct spi_flash *spi_flash_probe_fdt(const void *blob, int slave_node,
-                                     int spi_node);
-
 void spi_flash_free(struct spi_flash *flash);
 
 static inline int spi_flash_read(struct spi_flash *flash, u32 offset,
@@ -227,7 +214,16 @@ static inline int spi_flash_erase(struct spi_flash *flash, u32 offset,
 }
 #endif
 
-void spi_boot(void) __noreturn;
-void spi_spl_load_image(uint32_t offs, unsigned int size, void *vdst);
+static inline int spi_flash_protect(struct spi_flash *flash, u32 ofs, u32 len,
+                                       bool prot)
+{
+       if (!flash->flash_lock || !flash->flash_unlock)
+               return -EOPNOTSUPP;
+
+       if (prot)
+               return flash->flash_lock(flash, ofs, len);
+       else
+               return flash->flash_unlock(flash, ofs, len);
+}
 
 #endif /* _SPI_FLASH_H_ */