flash/nor: implement flash bank deallocation on OpenOCD exit

[openocd.git] / src / flash / nor / core.h

diff --git a/src/flash/nor/core.h b/src/flash/nor/core.h
index 929ebdbea025cd0c81d67fd280b846636b6c942f..1bfe1ab977641828a47efe0f9869833e17ceb776 100644 (file)
--- a/src/flash/nor/core.h
+++ b/src/flash/nor/core.h
@@ -46,6 +46,8 @@ struct flash_sector {
        /**
         * Indication of erasure status: 0 = not erased, 1 = erased,
         * other = unknown.  Set by @c flash_driver_s::erase_check.
+        *
+        * Flag is not used in protection block
         */
        int is_erased;
        /**
@@ -56,6 +58,9 @@ struct flash_sector {
         * This information must be considered stale immediately.
         * A million things could make it stale: power cycle,
         * reset of target, code running on target, etc.
+        *
+        * If a flash_bank uses an extra array of protection blocks,
+        * protection flag is not valid in sector array
         */
        int is_protected;
 };
@@ -71,7 +76,7 @@ struct flash_sector {
  * per-bank basis, if required.
  */
 struct flash_bank {
-       const char *name;
+       char *name;
 
        struct target *target; /**< Target to which this bank belongs. */
 
@@ -85,6 +90,9 @@ struct flash_bank {
        int chip_width; /**< Width of the chip in bytes (1,2,4 bytes) */
        int bus_width; /**< Maximum bus width, in bytes (1,2,4 bytes) */
 
+       /** Erased value. Defaults to 0xFF. */
+       uint8_t erased_value;
+
        /** Default padded value used, normally this matches the  flash
         * erased value. Defaults to 0xFF. */
        uint8_t default_padded_value;
@@ -95,9 +103,19 @@ struct flash_bank {
         * some non-zero value during "probe()" or "auto_probe()".
         */
        int num_sectors;
-       /** Array of sectors, allocated and initilized by the flash driver */
+       /** Array of sectors, allocated and initialized by the flash driver */
        struct flash_sector *sectors;
 
+       /**
+        * The number of protection blocks in this bank. This value
+        * is set intially to 0 and sectors are used as protection blocks.
+        * Driver probe can set protection blocks array to work with
+        * protection granularity different than sector size.
+        */
+       int num_prot_blocks;
+       /** Array of protection blocks, allocated and initilized by the flash driver */
+       struct flash_sector *prot_blocks;
+
        struct flash_bank *next; /**< The next flash bank on this chip */
 };
 
@@ -135,8 +153,15 @@ int flash_write(struct target *target,
  * This routine must be called when the system may modify the status.
  */
 void flash_set_dirty(void);
+
 /** @returns The number of flash banks currently defined. */
 int flash_get_bank_count(void);
+
+/** Deallocates bank->driver_priv */
+void default_flash_free_driver_priv(struct flash_bank *bank);
+
+/** Deallocates all flash banks */
+void flash_free_all_banks(void);
 /**
  * Provides default read implementation for flash memory.
  * @param bank The bank to read.
@@ -205,5 +230,13 @@ struct flash_bank *get_flash_bank_by_num_noprobe(int num);
  */
 int get_flash_bank_by_addr(struct target *target, uint32_t addr, bool check,
                struct flash_bank **result_bank);
+/**
+ * Allocate and fill an array of sectors or protection blocks.
+ * @param offset Offset of first block.
+ * @param size Size of each block.
+ * @param num_blocks Number of blocks in array.
+ * @returns A struct flash_sector pointer or NULL when allocation failed.
+ */
+struct flash_sector *alloc_block_array(uint32_t offset, uint32_t size, int num_blocks);
 
 #endif /* OPENOCD_FLASH_NOR_CORE_H */