add const keyword to some APIs
[openocd.git] / src / target / image.c
index af1c4e217f8e79526ed614e55efcfddb482144db..cf7e11ab1c45442ed9106d366e39dfd7d8a659f1 100644 (file)
@@ -2,12 +2,15 @@
  *   Copyright (C) 2007 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
  *   spen@spen-soft.co.uk                                                  *
  *                                                                         *
+ *   Copyright (C) 2009 by Franck Hereson                                  *
+ *   franck.hereson@secad.fr                                               *
+ *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
 
 /* convert ELF header field to host endianness */
 #define field16(elf,field)\
-       ((elf->endianness==ELFDATA2LSB)? \
+       ((elf->endianness == ELFDATA2LSB)? \
                le_to_h_u16((uint8_t*)&field):be_to_h_u16((uint8_t*)&field))
 
 #define field32(elf,field)\
-       ((elf->endianness==ELFDATA2LSB)? \
+       ((elf->endianness == ELFDATA2LSB)? \
                le_to_h_u32((uint8_t*)&field):be_to_h_u32((uint8_t*)&field))
 
-static int autodetect_image_type(image_t *image, char *url)
+static int autodetect_image_type(image_t *image, const char *url)
 {
        int retval;
        fileio_t fileio;
-       u32 read_bytes;
+       uint32_t read_bytes;
        uint8_t buffer[9];
 
        /* read the first 4 bytes of image */
@@ -55,20 +58,20 @@ static int autodetect_image_type(image_t *image, char *url)
        }
        retval = fileio_read(&fileio, 9, buffer, &read_bytes);
 
-       if (retval==ERROR_OK)
+       if (retval == ERROR_OK)
        {
                if (read_bytes != 9)
                {
-                       retval=ERROR_FILEIO_OPERATION_FAILED;
+                       retval = ERROR_FILEIO_OPERATION_FAILED;
                }
        }
        fileio_close(&fileio);
 
-       if (retval!=ERROR_OK)
+       if (retval != ERROR_OK)
                return retval;
 
        /* check header against known signatures */
-       if (strncmp((char*)buffer,ELFMAG,SELFMAG)==0)
+       if (strncmp((char*)buffer,ELFMAG,SELFMAG) == 0)
        {
                LOG_DEBUG("ELF image detected.");
                image->type = IMAGE_ELF;
@@ -81,7 +84,7 @@ static int autodetect_image_type(image_t *image, char *url)
                &&(isxdigit(buffer[5]))
                &&(isxdigit(buffer[6]))
                &&(buffer[7]=='0') /* record type : 00 -> 05 */
-               &&(buffer[8]>='0')&&(buffer[8]<'6'))
+               &&(buffer[8]>='0') && (buffer[8]<'6'))
        {
                LOG_DEBUG("IHEX image detected.");
                image->type = IMAGE_IHEX;
@@ -103,7 +106,7 @@ static int autodetect_image_type(image_t *image, char *url)
        return ERROR_OK;
 }
 
-static int identify_image_type(image_t *image, char *type_string, char *url)
+static int identify_image_type(image_t *image, const char *type_string, const char *url)
 {
        if (type_string)
        {
@@ -148,8 +151,8 @@ static int image_ihex_buffer_complete(image_t *image)
 {
        image_ihex_t *ihex = image->type_private;
        fileio_t *fileio = &ihex->fileio;
-       u32 full_address = 0x0;
-       u32 cooked_bytes;
+       uint32_t full_address = 0x0;
+       uint32_t cooked_bytes;
        int i;
        char lpszLine[1023];
 
@@ -167,14 +170,14 @@ static int image_ihex_buffer_complete(image_t *image)
 
        while (fileio_fgets(fileio, 1023, lpszLine) == ERROR_OK)
        {
-               u32 count;
-               u32 address;
-               u32 record_type;
-               u32 checksum;
+               uint32_t count;
+               uint32_t address;
+               uint32_t record_type;
+               uint32_t checksum;
                uint8_t cal_checksum = 0;
-               u32 bytes_read = 0;
+               uint32_t bytes_read = 0;
 
-               if (sscanf(&lpszLine[bytes_read], ":%2x%4x%2x", &count, &address, &record_type) != 3)
+               if (sscanf(&lpszLine[bytes_read], ":%2" SCNx32 "%4" SCNx32 "%2" SCNx32 , &count, &address, &record_type) != 3)
                {
                        return ERROR_IMAGE_FORMAT_ERROR;
                }
@@ -196,6 +199,12 @@ static int image_ihex_buffer_complete(image_t *image)
                                if (section[image->num_sections].size != 0)
                                {
                                        image->num_sections++;
+                                       if (image->num_sections >= IMAGE_MAX_SECTIONS)
+                                       {
+                                               /* too many sections */
+                                               LOG_ERROR("Too many sections found in IHEX file");
+                                               return ERROR_IMAGE_FORMAT_ERROR;
+                                       }
                                        section[image->num_sections].size = 0x0;
                                        section[image->num_sections].flags = 0;
                                        section[image->num_sections].private = &ihex->buffer[cooked_bytes];
@@ -236,7 +245,7 @@ static int image_ihex_buffer_complete(image_t *image)
                }
                else if (record_type == 2) /* Linear Address Record */
                {
-                       u16 upper_address;
+                       uint16_t upper_address;
 
                        sscanf(&lpszLine[bytes_read], "%4hx", &upper_address);
                        cal_checksum += (uint8_t)(upper_address >> 8);
@@ -252,6 +261,12 @@ static int image_ihex_buffer_complete(image_t *image)
                                if (section[image->num_sections].size != 0)
                                {
                                        image->num_sections++;
+                                       if (image->num_sections >= IMAGE_MAX_SECTIONS)
+                                       {
+                                               /* too many sections */
+                                               LOG_ERROR("Too many sections found in IHEX file");
+                                               return ERROR_IMAGE_FORMAT_ERROR;
+                                       }
                                        section[image->num_sections].size = 0x0;
                                        section[image->num_sections].flags = 0;
                                        section[image->num_sections].private = &ihex->buffer[cooked_bytes];
@@ -263,20 +278,20 @@ static int image_ihex_buffer_complete(image_t *image)
                }
                else if (record_type == 3) /* Start Segment Address Record */
                {
-                       u32 dummy;
+                       uint32_t dummy;
 
                        /* "Start Segment Address Record" will not be supported */
                        /* but we must consume it, and do not create an error.  */
                        while (count-- > 0)
                        {
-                               sscanf(&lpszLine[bytes_read], "%2x", &dummy);
+                               sscanf(&lpszLine[bytes_read], "%2" SCNx32 , &dummy);
                                cal_checksum += (uint8_t)dummy;
                                bytes_read += 2;
                        }
                }
                else if (record_type == 4) /* Extended Linear Address Record */
                {
-                       u16 upper_address;
+                       uint16_t upper_address;
 
                        sscanf(&lpszLine[bytes_read], "%4hx", &upper_address);
                        cal_checksum += (uint8_t)(upper_address >> 8);
@@ -292,6 +307,12 @@ static int image_ihex_buffer_complete(image_t *image)
                                if (section[image->num_sections].size != 0)
                                {
                                        image->num_sections++;
+                                       if (image->num_sections >= IMAGE_MAX_SECTIONS)
+                                       {
+                                               /* too many sections */
+                                               LOG_ERROR("Too many sections found in IHEX file");
+                                               return ERROR_IMAGE_FORMAT_ERROR;
+                                       }
                                        section[image->num_sections].size = 0x0;
                                        section[image->num_sections].flags = 0;
                                        section[image->num_sections].private = &ihex->buffer[cooked_bytes];
@@ -303,9 +324,9 @@ static int image_ihex_buffer_complete(image_t *image)
                }
                else if (record_type == 5) /* Start Linear Address Record */
                {
-                       u32 start_address;
+                       uint32_t start_address;
 
-                       sscanf(&lpszLine[bytes_read], "%8x", &start_address);
+                       sscanf(&lpszLine[bytes_read], "%8" SCNx32, &start_address);
                        cal_checksum += (uint8_t)(start_address >> 24);
                        cal_checksum += (uint8_t)(start_address >> 16);
                        cal_checksum += (uint8_t)(start_address >> 8);
@@ -317,11 +338,11 @@ static int image_ihex_buffer_complete(image_t *image)
                }
                else
                {
-                       LOG_ERROR("unhandled IHEX record type: %i", record_type);
+                 LOG_ERROR("unhandled IHEX record type: %i", (int)record_type);
                        return ERROR_IMAGE_FORMAT_ERROR;
                }
 
-               sscanf(&lpszLine[bytes_read], "%2x", &checksum);
+               sscanf(&lpszLine[bytes_read], "%2" SCNx32 , &checksum);
                bytes_read += 2;
 
                if ((uint8_t)checksum != (uint8_t)(~cal_checksum + 1))
@@ -339,13 +360,13 @@ static int image_ihex_buffer_complete(image_t *image)
 static int image_elf_read_headers(image_t *image)
 {
        image_elf_t *elf = image->type_private;
-       u32 read_bytes;
-       u32 i,j;
+       uint32_t read_bytes;
+       uint32_t i,j;
        int retval;
 
        elf->header = malloc(sizeof(Elf32_Ehdr));
 
-       if(elf->header == NULL)
+       if (elf->header == NULL)
        {
                LOG_ERROR("insufficient memory to perform operation ");
                return ERROR_FILEIO_OPERATION_FAILED;
@@ -362,7 +383,7 @@ static int image_elf_read_headers(image_t *image)
                return ERROR_FILEIO_OPERATION_FAILED;
        }
 
-       if (strncmp((char*)elf->header->e_ident,ELFMAG,SELFMAG)!=0)
+       if (strncmp((char*)elf->header->e_ident,ELFMAG,SELFMAG) != 0)
        {
                LOG_ERROR("invalid ELF file, bad magic number");
                return ERROR_IMAGE_FORMAT_ERROR;
@@ -374,15 +395,15 @@ static int image_elf_read_headers(image_t *image)
        }
 
        elf->endianness = elf->header->e_ident[EI_DATA];
-       if ((elf->endianness!=ELFDATA2LSB)
-                &&(elf->endianness!=ELFDATA2MSB))
+       if ((elf->endianness != ELFDATA2LSB)
+                &&(elf->endianness != ELFDATA2MSB))
        {
                LOG_ERROR("invalid ELF file, unknown endianess setting");
                return ERROR_IMAGE_FORMAT_ERROR;
        }
 
        elf->segment_count = field16(elf,elf->header->e_phnum);
-       if (elf->segment_count==0)
+       if (elf->segment_count == 0)
        {
                LOG_ERROR("invalid ELF file, no program headers");
                return ERROR_IMAGE_FORMAT_ERROR;
@@ -395,7 +416,7 @@ static int image_elf_read_headers(image_t *image)
        }
 
        elf->segments = malloc(elf->segment_count*sizeof(Elf32_Phdr));
-       if(elf->segments == NULL)
+       if (elf->segments == NULL)
        {
                LOG_ERROR("insufficient memory to perform operation ");
                return ERROR_FILEIO_OPERATION_FAILED;
@@ -414,12 +435,12 @@ static int image_elf_read_headers(image_t *image)
 
        /* count useful segments (loadable), ignore BSS section */
        image->num_sections = 0;
-       for (i=0;i<elf->segment_count;i++)
+       for (i = 0;i < elf->segment_count;i++)
                if ((field32(elf, elf->segments[i].p_type) == PT_LOAD) && (field32(elf, elf->segments[i].p_filesz) != 0))
                        image->num_sections++;
        /* alloc and fill sections array with loadable segments */
        image->sections = malloc(image->num_sections * sizeof(image_section_t));
-       for (i=0,j=0;i<elf->segment_count;i++)
+       for (i = 0,j = 0;i < elf->segment_count;i++)
        {
                if ((field32(elf, elf->segments[i].p_type) == PT_LOAD) && (field32(elf, elf->segments[i].p_filesz) != 0))
                {
@@ -437,26 +458,26 @@ static int image_elf_read_headers(image_t *image)
        return ERROR_OK;
 }
 
-static int image_elf_read_section(image_t *image, int section, u32 offset, u32 size, uint8_t *buffer, u32 *size_read)
+static int image_elf_read_section(image_t *image, int section, uint32_t offset, uint32_t size, uint8_t *buffer, uint32_t *size_read)
 {
        image_elf_t *elf = image->type_private;
        Elf32_Phdr *segment = (Elf32_Phdr *)image->sections[section].private;
-       u32 read_size,really_read;
+       uint32_t read_size,really_read;
        int retval;
 
        *size_read = 0;
 
-       LOG_DEBUG("load segment %d at 0x%x (sz=0x%x)",section,offset,size);
+       LOG_DEBUG("load segment %d at 0x%" PRIx32 " (sz = 0x%" PRIx32 ")",section,offset,size);
 
        /* read initialized data in current segment if any */
-       if (offset<field32(elf,segment->p_filesz))
+       if (offset < field32(elf,segment->p_filesz))
        {
                /* maximal size present in file for the current segment */
                read_size = MIN(size, field32(elf,segment->p_filesz)-offset);
-               LOG_DEBUG("read elf: size = 0x%x at 0x%x",read_size,
-                       field32(elf,segment->p_offset)+offset);
+               LOG_DEBUG("read elf: size = 0x%" PRIx32 " at 0x%" PRIx32 "",read_size,
+                       field32(elf,segment->p_offset) + offset);
                /* read initialized area of the segment */
-               if ((retval = fileio_seek(&elf->fileio, field32(elf,segment->p_offset)+offset)) != ERROR_OK)
+               if ((retval = fileio_seek(&elf->fileio, field32(elf,segment->p_offset) + offset)) != ERROR_OK)
                {
                        LOG_ERROR("cannot find ELF segment content, seek failed");
                        return retval;
@@ -482,8 +503,8 @@ static int image_mot_buffer_complete(image_t *image)
 {
        image_mot_t *mot = image->type_private;
        fileio_t *fileio = &mot->fileio;
-       u32 full_address = 0x0;
-       u32 cooked_bytes;
+       uint32_t full_address = 0x0;
+       uint32_t cooked_bytes;
        int i;
        char lpszLine[1023];
 
@@ -501,15 +522,15 @@ static int image_mot_buffer_complete(image_t *image)
 
        while (fileio_fgets(fileio, 1023, lpszLine) == ERROR_OK)
        {
-               u32 count;
-               u32 address;
-               u32 record_type;
-               u32 checksum;
+               uint32_t count;
+               uint32_t address;
+               uint32_t record_type;
+               uint32_t checksum;
                uint8_t cal_checksum = 0;
-               u32 bytes_read = 0;
+               uint32_t bytes_read = 0;
 
                /* get record type and record length */
-               if (sscanf(&lpszLine[bytes_read], "S%1x%2x", &record_type, &count) != 2)
+               if (sscanf(&lpszLine[bytes_read], "S%1" SCNx32 "%2" SCNx32 , &record_type, &count) != 2)
                {
                        return ERROR_IMAGE_FORMAT_ERROR;
                }
@@ -533,11 +554,11 @@ static int image_mot_buffer_complete(image_t *image)
                }
                else if (record_type >= 1 && record_type <= 3)
                {
-                       switch( record_type )
+                       switch (record_type)
                        {
                                case 1:
                                        /* S1 - 16 bit address data record */
-                                       sscanf(&lpszLine[bytes_read], "%4x", &address);
+                                       sscanf(&lpszLine[bytes_read], "%4" SCNx32, &address);
                                        cal_checksum += (uint8_t)(address >> 8);
                                        cal_checksum += (uint8_t)address;
                                        bytes_read += 4;
@@ -546,7 +567,7 @@ static int image_mot_buffer_complete(image_t *image)
 
                                case 2:
                                        /* S2 - 24 bit address data record */
-                                       sscanf(&lpszLine[bytes_read], "%6x", &address);
+                                       sscanf(&lpszLine[bytes_read], "%6" SCNx32 , &address);
                                        cal_checksum += (uint8_t)(address >> 16);
                                        cal_checksum += (uint8_t)(address >> 8);
                                        cal_checksum += (uint8_t)address;
@@ -556,7 +577,7 @@ static int image_mot_buffer_complete(image_t *image)
 
                                case 3:
                                        /* S3 - 32 bit address data record */
-                                       sscanf(&lpszLine[bytes_read], "%8x", &address);
+                                       sscanf(&lpszLine[bytes_read], "%8" SCNx32 , &address);
                                        cal_checksum += (uint8_t)(address >> 24);
                                        cal_checksum += (uint8_t)(address >> 16);
                                        cal_checksum += (uint8_t)(address >> 8);
@@ -599,11 +620,11 @@ static int image_mot_buffer_complete(image_t *image)
                else if (record_type == 5)
                {
                        /* S5 is the data count record, we ignore it */
-                       u32 dummy;
+                       uint32_t dummy;
 
                        while (count-- > 0)
                        {
-                               sscanf(&lpszLine[bytes_read], "%2x", &dummy);
+                               sscanf(&lpszLine[bytes_read], "%2" SCNx32 , &dummy);
                                cal_checksum += (uint8_t)dummy;
                                bytes_read += 2;
                        }
@@ -627,16 +648,16 @@ static int image_mot_buffer_complete(image_t *image)
                }
                else
                {
-                       LOG_ERROR("unhandled S19 record type: %i", record_type);
+                 LOG_ERROR("unhandled S19 record type: %i", (int)(record_type));
                        return ERROR_IMAGE_FORMAT_ERROR;
                }
 
                /* account for checksum, will always be 0xFF */
-               sscanf(&lpszLine[bytes_read], "%2x", &checksum);
+               sscanf(&lpszLine[bytes_read], "%2" SCNx32 , &checksum);
                cal_checksum += (uint8_t)checksum;
                bytes_read += 2;
 
-               if( cal_checksum != 0xFF )
+               if (cal_checksum != 0xFF)
                {
                        /* checksum failed */
                        LOG_ERROR("incorrect record checksum found in S19 file");
@@ -648,7 +669,7 @@ static int image_mot_buffer_complete(image_t *image)
        return ERROR_IMAGE_FORMAT_ERROR;
 }
 
-int image_open(image_t *image, char *url, char *type_string)
+int image_open(image_t *image, const char *url, const char *type_string)
 {
        int retval = ERROR_OK;
 
@@ -762,28 +783,28 @@ int image_open(image_t *image, char *url, char *type_string)
        {
                /* relocate */
                int section;
-               for (section=0; section < image->num_sections; section++)
+               for (section = 0; section < image->num_sections; section++)
                {
-                       image->sections[section].base_address+=image->base_address;
+                       image->sections[section].base_address += image->base_address;
                }
                /* we're done relocating. The two statements below are mainly
                 * for documenation purposes: stop anyone from empirically
                 * thinking they should use these values henceforth. */
-               image->base_address=0;
-               image->base_address_set=0;
+               image->base_address = 0;
+               image->base_address_set = 0;
        }
 
        return retval;
 };
 
-int image_read_section(image_t *image, int section, u32 offset, u32 size, uint8_t *buffer, u32 *size_read)
+int image_read_section(image_t *image, int section, uint32_t offset, uint32_t size, uint8_t *buffer, uint32_t *size_read)
 {
        int retval;
 
        /* don't read past the end of a section */
        if (offset + size > image->sections[section].size)
        {
-               LOG_DEBUG("read past end of section: 0x%8.8x + 0x%8.8x > 0x%8.8x",
+               LOG_DEBUG("read past end of section: 0x%8.8" PRIx32 " + 0x%8.8" PRIx32 " > 0x%8.8" PRIx32 "",
                                offset, size, image->sections[section].size);
                return ERROR_INVALID_ARGUMENTS;
        }
@@ -822,13 +843,13 @@ int image_read_section(image_t *image, int section, u32 offset, u32 size, uint8_
        else if (image->type == IMAGE_MEMORY)
        {
                image_memory_t *image_memory = image->type_private;
-               u32 address = image->sections[section].base_address + offset;
+               uint32_t address = image->sections[section].base_address + offset;
 
                *size_read = 0;
 
                while ((size - *size_read) > 0)
                {
-                       u32 size_in_cache;
+                       uint32_t size_in_cache;
 
                        if (!image_memory->cache
                                || (address < image_memory->cache_address)
@@ -852,7 +873,7 @@ int image_read_section(image_t *image, int section, u32 offset, u32 size, uint8_
                        memcpy(buffer + *size_read,
                                image_memory->cache + (address - image_memory->cache_address),
                                (size_in_cache > size) ? size : size_in_cache
-                               );
+);
 
                        *size_read += (size_in_cache > size) ? size : size_in_cache;
                        address += (size_in_cache > size) ? size : size_in_cache;
@@ -876,7 +897,7 @@ int image_read_section(image_t *image, int section, u32 offset, u32 size, uint8_
        return ERROR_OK;
 }
 
-int image_add_section(image_t *image, u32 base, u32 size, int flags, uint8_t *data)
+int image_add_section(image_t *image, uint32_t base, uint32_t size, int flags, uint8_t *data)
 {
        image_section_t *section;
 
@@ -997,12 +1018,12 @@ void image_close(image_t *image)
        }
 }
 
-int image_calculate_checksum(uint8_t* buffer, u32 nbytes, u32* checksum)
+int image_calculate_checksum(uint8_t* buffer, uint32_t nbytes, uint32_t* checksum)
 {
-       u32 crc = 0xffffffff;
+       uint32_t crc = 0xffffffff;
        LOG_DEBUG("Calculating checksum");
 
-       u32 crc32_table[256];
+       uint32_t crc32_table[256];
 
        /* Initialize the CRC table and the decoding table.  */
        int i, j;
@@ -1015,14 +1036,14 @@ int image_calculate_checksum(uint8_t* buffer, u32 nbytes, u32* checksum)
                crc32_table[i] = c;
        }
 
-       while (nbytes>0)
+       while (nbytes > 0)
        {
-               int run=nbytes;
-               if (run>32768)
+               int run = nbytes;
+               if (run > 32768)
                {
-                       run=32768;
+                       run = 32768;
                }
-               nbytes-=run;
+               nbytes -= run;
                while (run--)
                {
                        /* as per gdb */

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)