sunxi: usb: Switch to Generic host controllers
[platform/kernel/u-boot.git] / include / spi_flash.h
index 4312d3d..e427e96 100644 (file)
@@ -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_
@@ -54,6 +48,9 @@ struct spi_slave;
  * @write_cmd:         Write cmd - page and quad program.
  * @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
@@ -87,6 +84,10 @@ struct spi_flash {
        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
@@ -111,6 +112,19 @@ struct dm_spi_flash_ops {
        int (*write)(struct udevice *dev, u32 offset, size_t len,
                     const void *buf);
        int (*erase)(struct udevice *dev, u32 offset, size_t len);
+       /**
+        * get_sw_write_prot() - Check state of software write-protect feature
+        *
+        * SPI flash chips can lock a region of the flash defined by a
+        * 'protected area'. This function checks if this protected area is
+        * defined.
+        *
+        * @dev:        SPI flash device
+        * @return 0 if no region is write-protected, 1 if a region is
+        *      write-protected, -ENOSYS if the driver does not implement this,
+        *      other -ve value on error
+        */
+       int (*get_sw_write_prot)(struct udevice *dev);
 };
 
 /* Access the serial operations for a device */
@@ -152,6 +166,20 @@ int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len,
  */
 int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len);
 
+/**
+ * spl_flash_get_sw_write_prot() - Check state of software write-protect feature
+ *
+ * SPI flash chips can lock a region of the flash defined by a
+ * 'protected area'. This function checks if this protected area is
+ * defined.
+ *
+ * @dev:       SPI flash device
+ * @return 0 if no region is write-protected, 1 if a region is
+ *     write-protected, -ENOSYS if the driver does not implement this,
+ *     other -ve value on error
+ */
+int spl_flash_get_sw_write_prot(struct udevice *dev);
+
 int spi_flash_probe_bus_cs(unsigned int busnum, unsigned int cs,
                           unsigned int max_hz, unsigned int spi_mode,
                           struct udevice **devp);
@@ -163,8 +191,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 +212,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 +220,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 +241,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_ */