Flash, FRAM and EEPROM driver for STM32 QUAD-/OCTOSPI interface
[fw/openocd] / src / flash / nor / core.c
index 043ff13c8dfa69a087c213a08f265d79927a8b31..c162c7097ba30a7a9bf39a936def640265e870c3 100644 (file)
 
 static struct flash_bank *flash_banks;
 
-int flash_driver_erase(struct flash_bank *bank, int first, int last)
+int flash_driver_erase(struct flash_bank *bank, unsigned int first,
+               unsigned int last)
 {
        int retval;
 
        retval = bank->driver->erase(bank, first, last);
        if (retval != ERROR_OK)
-               LOG_ERROR("failed erasing sectors %d to %d", first, last);
+               LOG_ERROR("failed erasing sectors %u to %u", first, last);
 
        return retval;
 }
 
-int flash_driver_protect(struct flash_bank *bank, int set, int first, int last)
+int flash_driver_protect(struct flash_bank *bank, int set, unsigned int first,
+               unsigned int last)
 {
        int retval;
-       int num_blocks;
+       unsigned int num_blocks;
 
        if (bank->num_prot_blocks)
                num_blocks = bank->num_prot_blocks;
@@ -60,7 +62,7 @@ int flash_driver_protect(struct flash_bank *bank, int set, int first, int last)
 
 
        /* callers may not supply illegal parameters ... */
-       if (first < 0 || first > last || last >= num_blocks) {
+       if (first > last || last >= num_blocks) {
                LOG_ERROR("illegal protection block range");
                return ERROR_FAIL;
        }
@@ -86,13 +88,13 @@ int flash_driver_protect(struct flash_bank *bank, int set, int first, int last)
         */
        retval = bank->driver->protect(bank, set, first, last);
        if (retval != ERROR_OK)
-               LOG_ERROR("failed setting protection for blocks %d to %d", first, last);
+               LOG_ERROR("failed setting protection for blocks %u to %u", first, last);
 
        return retval;
 }
 
 int flash_driver_write(struct flash_bank *bank,
-       uint8_t *buffer, uint32_t offset, uint32_t count)
+       const uint8_t *buffer, uint32_t offset, uint32_t count)
 {
        int retval;
 
@@ -133,6 +135,43 @@ int default_flash_read(struct flash_bank *bank,
        return target_read_buffer(bank->target, offset + bank->base, count, buffer);
 }
 
+int flash_driver_verify(struct flash_bank *bank,
+       const uint8_t *buffer, uint32_t offset, uint32_t count)
+{
+       int retval;
+
+       retval = bank->driver->verify ? bank->driver->verify(bank, buffer, offset, count) :
+               default_flash_verify(bank, buffer, offset, count);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("verify failed in bank at " TARGET_ADDR_FMT " starting at 0x%8.8" PRIx32,
+                       bank->base, offset);
+       }
+
+       return retval;
+}
+
+int default_flash_verify(struct flash_bank *bank,
+       const uint8_t *buffer, uint32_t offset, uint32_t count)
+{
+       uint32_t target_crc, image_crc;
+       int retval;
+
+       retval = image_calculate_checksum(buffer, count, &image_crc);
+       if (retval != ERROR_OK)
+               return retval;
+
+       retval = target_checksum_memory(bank->target, offset + bank->base, count, &target_crc);
+       if (retval != ERROR_OK)
+               return retval;
+
+       LOG_DEBUG("addr " TARGET_ADDR_FMT ", len 0x%08" PRIx32 ", crc 0x%08" PRIx32 " 0x%08" PRIx32,
+               offset + bank->base, count, ~image_crc, ~target_crc);
+       if (target_crc == image_crc)
+               return ERROR_OK;
+       else
+               return ERROR_FAIL;
+}
+
 void flash_bank_add(struct flash_bank *bank)
 {
        /* put flash bank in linked list */
@@ -157,10 +196,10 @@ struct flash_bank *flash_bank_list(void)
        return flash_banks;
 }
 
-struct flash_bank *get_flash_bank_by_num_noprobe(int num)
+struct flash_bank *get_flash_bank_by_num_noprobe(unsigned int num)
 {
        struct flash_bank *p;
-       int i = 0;
+       unsigned int i = 0;
 
        for (p = flash_banks; p; p = p->next) {
                if (i++ == num)
@@ -170,10 +209,10 @@ struct flash_bank *get_flash_bank_by_num_noprobe(int num)
        return NULL;
 }
 
-int flash_get_bank_count(void)
+unsigned int flash_get_bank_count(void)
 {
        struct flash_bank *p;
-       int i = 0;
+       unsigned int i = 0;
        for (p = flash_banks; p; p = p->next)
                i++;
        return i;
@@ -249,7 +288,7 @@ int get_flash_bank_by_name(const char *name, struct flash_bank **bank_result)
        return ERROR_OK;
 }
 
-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)
 {
        struct flash_bank *p = get_flash_bank_by_num_noprobe(num);
        int retval;
@@ -306,7 +345,6 @@ static int default_flash_mem_blank_check(struct flash_bank *bank)
 {
        struct target *target = bank->target;
        const int buffer_size = 1024;
-       int i;
        uint32_t nBytes;
        int retval = ERROR_OK;
 
@@ -317,7 +355,7 @@ static int default_flash_mem_blank_check(struct flash_bank *bank)
 
        uint8_t *buffer = malloc(buffer_size);
 
-       for (i = 0; i < bank->num_sectors; i++) {
+       for (unsigned int i = 0; i < bank->num_sectors; i++) {
                uint32_t j;
                bank->sectors[i].is_erased = 1;
 
@@ -353,7 +391,6 @@ done:
 int default_flash_blank_check(struct flash_bank *bank)
 {
        struct target *target = bank->target;
-       int i;
        int retval;
 
        if (bank->target->state != TARGET_HALTED) {
@@ -366,14 +403,14 @@ int default_flash_blank_check(struct flash_bank *bank)
        if (block_array == NULL)
                return default_flash_mem_blank_check(bank);
 
-       for (i = 0; i < bank->num_sectors; i++) {
+       for (unsigned int i = 0; i < bank->num_sectors; i++) {
                block_array[i].address = bank->base + bank->sectors[i].offset;
                block_array[i].size = bank->sectors[i].size;
                block_array[i].result = UINT32_MAX; /* erase state unknown */
        }
 
        bool fast_check = true;
-       for (i = 0; i < bank->num_sectors; ) {
+       for (unsigned int i = 0; i < bank->num_sectors; ) {
                retval = target_blank_check_memory(target,
                                block_array + i, bank->num_sectors - i,
                                bank->erased_value);
@@ -388,7 +425,7 @@ int default_flash_blank_check(struct flash_bank *bank)
        }
 
        if (fast_check) {
-               for (i = 0; i < bank->num_sectors; i++)
+               for (unsigned int i = 0; i < bank->num_sectors; i++)
                        bank->sectors[i].is_erased = block_array[i].result;
                retval = ERROR_OK;
        } else {
@@ -418,7 +455,8 @@ int default_flash_blank_check(struct flash_bank *bank)
 static int flash_iterate_address_range_inner(struct target *target,
        char *pad_reason, target_addr_t addr, uint32_t length,
        bool iterate_protect_blocks,
-       int (*callback)(struct flash_bank *bank, int first, int last))
+       int (*callback)(struct flash_bank *bank, unsigned int first,
+               unsigned int last))
 {
        struct flash_bank *c;
        struct flash_sector *block_array;
@@ -547,7 +585,8 @@ static int flash_iterate_address_range_inner(struct target *target,
 static int flash_iterate_address_range(struct target *target,
        char *pad_reason, target_addr_t addr, uint32_t length,
        bool iterate_protect_blocks,
-       int (*callback)(struct flash_bank *bank, int first, int last))
+       int (*callback)(struct flash_bank *bank, unsigned int first,
+               unsigned int last))
 {
        struct flash_bank *c;
        int retval = ERROR_OK;
@@ -585,7 +624,8 @@ int flash_erase_address_range(struct target *target,
                addr, length, false, &flash_driver_erase);
 }
 
-static int flash_driver_unprotect(struct flash_bank *bank, int first, int last)
+static int flash_driver_unprotect(struct flash_bank *bank, unsigned int first,
+               unsigned int last)
 {
        return flash_driver_protect(bank, 0, first, last);
 }
@@ -627,8 +667,7 @@ target_addr_t flash_write_align_start(struct flash_bank *bank, target_addr_t add
        if (bank->write_start_alignment == FLASH_WRITE_ALIGN_SECTOR) {
                uint32_t offset = addr - bank->base;
                uint32_t aligned = 0;
-               int sect;
-               for (sect = 0; sect < bank->num_sectors; sect++) {
+               for (unsigned int sect = 0; sect < bank->num_sectors; sect++) {
                        if (bank->sectors[sect].offset > offset)
                                break;
 
@@ -652,8 +691,7 @@ target_addr_t flash_write_align_end(struct flash_bank *bank, target_addr_t addr)
        if (bank->write_end_alignment == FLASH_WRITE_ALIGN_SECTOR) {
                uint32_t offset = addr - bank->base;
                uint32_t aligned = 0;
-               int sect;
-               for (sect = 0; sect < bank->num_sectors; sect++) {
+               for (unsigned int sect = 0; sect < bank->num_sectors; sect++) {
                        aligned = bank->sectors[sect].offset + bank->sectors[sect].size - 1;
                        if (aligned >= offset)
                                break;
@@ -676,7 +714,7 @@ static bool flash_write_check_gap(struct flash_bank *bank,
                return false;
 
        if (bank->minimal_write_gap == FLASH_WRITE_GAP_SECTOR) {
-               int sect;
+               unsigned int sect;
                uint32_t offset1 = addr1 - bank->base;
                /* find the sector following the one containing addr1 */
                for (sect = 0; sect < bank->num_sectors; sect++) {
@@ -696,12 +734,12 @@ static bool flash_write_check_gap(struct flash_bank *bank,
 }
 
 
-int flash_write_unlock(struct target *target, struct image *image,
-       uint32_t *written, int erase, bool unlock)
+int flash_write_unlock_verify(struct target *target, struct image *image,
+       uint32_t *written, bool erase, bool unlock, bool write, bool verify)
 {
        int retval = ERROR_OK;
 
-       int section;
+       unsigned int section;
        uint32_t section_offset;
        struct flash_bank *c;
        int *padding;
@@ -726,8 +764,8 @@ int flash_write_unlock(struct target *target, struct image *image,
         * whereas an image can have sections out of order. */
        struct imagesection **sections = malloc(sizeof(struct imagesection *) *
                        image->num_sections);
-       int i;
-       for (i = 0; i < image->num_sections; i++)
+
+       for (unsigned int i = 0; i < image->num_sections; i++)
                sections[i] = &image->sections[i];
 
        qsort(sections, image->num_sections, sizeof(struct imagesection *),
@@ -737,7 +775,7 @@ int flash_write_unlock(struct target *target, struct image *image,
        while (section < image->num_sections) {
                uint32_t buffer_idx;
                uint8_t *buffer;
-               int section_last;
+               unsigned int section_last;
                target_addr_t run_address = sections[section]->base_address + section_offset;
                uint32_t run_size = sections[section]->size - section_offset;
                int pad_bytes = 0;
@@ -824,7 +862,7 @@ int flash_write_unlock(struct target *target, struct image *image,
                                LOG_WARNING("Section start address " TARGET_ADDR_FMT
                                        " breaks the required alignment of flash bank %s",
                                        run_address, c->name);
-                               LOG_WARNING("Padding %d bytes from " TARGET_ADDR_FMT,
+                               LOG_WARNING("Padding %" PRIu32 " bytes from " TARGET_ADDR_FMT,
                                        padding_at_start, aligned_start);
 
                                run_address -= padding_at_start;
@@ -847,12 +885,11 @@ int flash_write_unlock(struct target *target, struct image *image,
                        /* If we're applying any sector automagic, then pad this
                         * (maybe-combined) segment to the end of its last sector.
                         */
-                       int sector;
                        uint32_t offset_start = run_address - c->base;
                        uint32_t offset_end = offset_start + run_size;
                        uint32_t end = offset_end, delta;
 
-                       for (sector = 0; sector < c->num_sectors; sector++) {
+                       for (unsigned int sector = 0; sector < c->num_sectors; sector++) {
                                end = c->sectors[sector].offset
                                        + c->sectors[sector].size;
                                if (offset_end <= end)
@@ -932,8 +969,17 @@ int flash_write_unlock(struct target *target, struct image *image,
                }
 
                if (retval == ERROR_OK) {
-                       /* write flash sectors */
-                       retval = flash_driver_write(c, buffer, run_address - c->base, run_size);
+                       if (write) {
+                               /* write flash sectors */
+                               retval = flash_driver_write(c, buffer, run_address - c->base, run_size);
+                       }
+               }
+
+               if (retval == ERROR_OK) {
+                       if (verify) {
+                               /* verify flash sectors */
+                               retval = flash_driver_verify(c, buffer, run_address - c->base, run_size);
+                       }
                }
 
                free(buffer);
@@ -955,20 +1001,19 @@ done:
 }
 
 int flash_write(struct target *target, struct image *image,
-       uint32_t *written, int erase)
+       uint32_t *written, bool erase)
 {
-       return flash_write_unlock(target, image, written, erase, false);
+       return flash_write_unlock_verify(target, image, written, erase, false, true, false);
 }
 
-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)
 {
-       int i;
-
        struct flash_sector *array = calloc(num_blocks, sizeof(struct flash_sector));
        if (array == NULL)
                return NULL;
 
-       for (i = 0; i < num_blocks; i++) {
+       for (unsigned int i = 0; i < num_blocks; i++) {
                array[i].offset = offset;
                array[i].size = size;
                array[i].is_erased = -1;