openocd: src: replace the GPL and BSD-Source-Code license tags
[fw/openocd] / src / flash / nor / core.h
index ff5cb60c421a301fcf6183ede85140134ab73379..97a368e8e812daf47b13ef1b042584d9508d778b 100644 (file)
@@ -93,12 +93,12 @@ struct flash_bank {
        const struct flash_driver *driver; /**< Driver for this bank. */
        void *driver_priv; /**< Private driver storage pointer */
 
-       int bank_number; /**< The 'bank' (or chip number) of this instance. */
+       unsigned int bank_number; /**< The 'bank' (or chip number) of this instance. */
        target_addr_t base; /**< The base address of this bank */
        uint32_t size; /**< The size of this chip bank, in bytes */
 
-       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) */
+       unsigned int chip_width; /**< Width of the chip in bytes (1,2,4 bytes) */
+       unsigned int bus_width; /**< Maximum bus width, in bytes (1,2,4 bytes) */
 
        /** Erased value. Defaults to 0xFF. */
        uint8_t erased_value;
@@ -124,7 +124,7 @@ struct flash_bank {
         * be set initially to 0, and the flash driver must set this to
         * some non-zero value during "probe()" or "auto_probe()".
         */
-       int num_sectors;
+       unsigned int num_sectors;
        /** Array of sectors, allocated and initialized by the flash driver */
        struct flash_sector *sectors;
 
@@ -134,7 +134,7 @@ struct flash_bank {
         * Driver probe can set protection blocks array to work with
         * protection granularity different than sector size.
         */
-       int num_prot_blocks;
+       unsigned int num_prot_blocks;
        /** Array of protection blocks, allocated and initialized by the flash driver */
        struct flash_sector *prot_blocks;
 
@@ -179,12 +179,12 @@ target_addr_t flash_write_align_end(struct flash_bank *bank, target_addr_t addr)
  * @param target The target with the flash to be programmed.
  * @param image The image that will be programmed to flash.
  * @param written On return, contains the number of bytes written.
- * @param erase If non-zero, indicates the flash driver should first
+ * @param erase Indicates whether the flash driver should first
  * erase the corresponding banks or sectors before programming.
  * @returns ERROR_OK if successful; otherwise, an error code.
  */
 int flash_write(struct target *target,
-               struct image *image, uint32_t *written, int erase);
+               struct image *image, uint32_t *written, bool erase);
 
 /**
  * Forces targets to re-examine their erase/protection state.
@@ -193,13 +193,14 @@ int flash_write(struct target *target,
 void flash_set_dirty(void);
 
 /** @returns The number of flash banks currently defined. */
-int flash_get_bank_count(void);
+unsigned 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.
@@ -210,6 +211,18 @@ void flash_free_all_banks(void);
  */
 int default_flash_read(struct flash_bank *bank,
                uint8_t *buffer, uint32_t offset, uint32_t count);
+
+/**
+ * Provides default verify implementation for flash memory.
+ * @param bank The bank to verify.
+ * @param buffer The data bytes to verify.
+ * @param offset The offset into the chip to verify.
+ * @param count The number of bytes to verify.
+ * @returns ERROR_OK if successful; otherwise, an error code.
+ */
+int default_flash_verify(struct flash_bank *bank,
+               const uint8_t *buffer, uint32_t offset, uint32_t count);
+
 /**
  * Provides default erased-bank check handling. Checks to see if
  * the flash driver knows they are erased; if things look uncertain,
@@ -217,7 +230,6 @@ int default_flash_read(struct flash_bank *bank,
  * @returns ERROR_OK if successful; otherwise, an error code.
  */
 int default_flash_blank_check(struct flash_bank *bank);
-
 /**
  * Returns the flash bank specified by @a name, which matches the
  * driver name and a suffix (option) specify the driver-specific
@@ -240,7 +252,7 @@ struct flash_bank *get_flash_bank_by_name_noprobe(const char *name);
  * @param bank returned bank if fn returns ERROR_OK
  * @returns ERROR_OK if successful
  */
-int get_flash_bank_by_num(int num, struct flash_bank **bank);
+int get_flash_bank_by_num(unsigned int num, struct flash_bank **bank);
 /**
  * Retrieves @a bank from a command argument, reporting errors parsing
  * the bank identifier or retrieving the specified bank.  The bank
@@ -248,7 +260,7 @@ int get_flash_bank_by_num(int num, struct flash_bank **bank);
  * @a instance is driver-specific.
  * @param name_index The index to the string in args containing the
  * bank identifier.
- * @param bank On output, contians a pointer to the bank or NULL.
+ * @param bank On output, contains a pointer to the bank or NULL.
  * @returns ERROR_OK on success, or an error indicating the problem.
  */
 COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
@@ -258,13 +270,14 @@ COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
  * @param num The flash bank number.
  * @returns A struct flash_bank for flash bank @a num, or NULL.
  */
-struct flash_bank *get_flash_bank_by_num_noprobe(int num);
+struct flash_bank *get_flash_bank_by_num_noprobe(unsigned int num);
 /**
  * Returns the flash bank located at a specified address.
  * @param target The target, presumed to contain one or more banks.
  * @param addr An address that is within the range of the bank.
  * @param check return ERROR_OK and result_bank NULL if the bank does not exist
- * @returns The struct flash_bank located at @a addr, or NULL.
+ * @param result_bank The struct flash_bank located at @a addr, or NULL.
+ * @returns ERROR_OK on success, or an error indicating the problem.
  */
 int get_flash_bank_by_addr(struct target *target, target_addr_t addr, bool check,
                struct flash_bank **result_bank);
@@ -275,6 +288,7 @@ int get_flash_bank_by_addr(struct target *target, target_addr_t addr, bool check
  * @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);
+struct flash_sector *alloc_block_array(uint32_t offset, uint32_t size,
+               unsigned int num_blocks);
 
 #endif /* OPENOCD_FLASH_NOR_CORE_H */