fileio: improve API types
[openocd.git] / src / target / image.c
index 66bcc95f376a7dccdcfda443f3b7ccb4dabddde7..8774c2517ba6e1f500e1f353466d348503e1595a 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(struct image *image, const char *url)
 {
        int retval;
-       fileio_t fileio;
-       uint32_t read_bytes;
+       struct fileio fileio;
+       size_t read_bytes;
        uint8_t buffer[9];
 
        /* read the first 4 bytes of image */
@@ -55,11 +58,11 @@ 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);
@@ -68,7 +71,7 @@ static int autodetect_image_type(image_t *image, char *url)
                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(struct image *image, const char *type_string, const char *url)
 {
        if (type_string)
        {
@@ -144,10 +147,10 @@ static int identify_image_type(image_t *image, char *type_string, char *url)
        return ERROR_OK;
 }
 
-static int image_ihex_buffer_complete(image_t *image)
+static int image_ihex_buffer_complete(struct image *image)
 {
-       image_ihex_t *ihex = image->type_private;
-       fileio_t *fileio = &ihex->fileio;
+       struct image_ihex *ihex = image->type_private;
+       struct fileio *fileio = &ihex->fileio;
        uint32_t full_address = 0x0;
        uint32_t cooked_bytes;
        int i;
@@ -155,7 +158,7 @@ static int image_ihex_buffer_complete(image_t *image)
 
        /* we can't determine the number of sections that we'll have to create ahead of time,
         * so we locally hold them until parsing is finished */
-       image_section_t section[IMAGE_MAX_SECTIONS];
+       struct imageection section[IMAGE_MAX_SECTIONS];
 
        ihex->buffer = malloc(fileio->size >> 1);
        cooked_bytes = 0x0;
@@ -172,7 +175,7 @@ static int image_ihex_buffer_complete(image_t *image)
                uint32_t record_type;
                uint32_t checksum;
                uint8_t cal_checksum = 0;
-               uint32_t bytes_read = 0;
+               size_t bytes_read = 0;
 
                if (sscanf(&lpszLine[bytes_read], ":%2" SCNx32 "%4" SCNx32 "%2" SCNx32 , &count, &address, &record_type) != 3)
                {
@@ -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];
@@ -223,7 +232,7 @@ static int image_ihex_buffer_complete(image_t *image)
                        image->num_sections++;
 
                        /* copy section information */
-                       image->sections = malloc(sizeof(image_section_t) * image->num_sections);
+                       image->sections = malloc(sizeof(struct imageection) * image->num_sections);
                        for (i = 0; i < image->num_sections; i++)
                        {
                                image->sections[i].private = section[i].private;
@@ -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];
@@ -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];
@@ -336,10 +357,10 @@ static int image_ihex_buffer_complete(image_t *image)
        return ERROR_IMAGE_FORMAT_ERROR;
 }
 
-static int image_elf_read_headers(image_t *image)
+static int image_elf_read_headers(struct image *image)
 {
-       image_elf_t *elf = image->type_private;
-       uint32_t read_bytes;
+       struct image_elf *elf = image->type_private;
+       size_t read_bytes;
        uint32_t i,j;
        int retval;
 
@@ -382,7 +403,7 @@ static int image_elf_read_headers(image_t *image)
        }
 
        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;
@@ -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++)
+       image->sections = malloc(image->num_sections * sizeof(struct imageection));
+       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, uint32_t offset, uint32_t size, uint8_t *buffer, uint32_t *size_read)
+static int image_elf_read_section(struct image *image, int section, uint32_t offset, uint32_t size, uint8_t *buffer, size_t *size_read)
 {
-       image_elf_t *elf = image->type_private;
+       struct image_elf *elf = image->type_private;
        Elf32_Phdr *segment = (Elf32_Phdr *)image->sections[section].private;
-       uint32_t read_size,really_read;
+       size_t read_size,really_read;
        int retval;
 
        *size_read = 0;
 
-       LOG_DEBUG("load segment %d at 0x%" PRIx32 " (sz=0x%" PRIx32 ")",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%" PRIx32 " at 0x%" PRIx32 "",read_size,
-                       field32(elf,segment->p_offset)+offset);
+               LOG_DEBUG("read elf: size = 0x%zu 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;
@@ -478,10 +499,10 @@ static int image_elf_read_section(image_t *image, int section, uint32_t offset,
        return ERROR_OK;
 }
 
-static int image_mot_buffer_complete(image_t *image)
+static int image_mot_buffer_complete(struct image *image)
 {
-       image_mot_t *mot = image->type_private;
-       fileio_t *fileio = &mot->fileio;
+       struct image_mot *mot = image->type_private;
+       struct fileio *fileio = &mot->fileio;
        uint32_t full_address = 0x0;
        uint32_t cooked_bytes;
        int i;
@@ -489,7 +510,7 @@ static int image_mot_buffer_complete(image_t *image)
 
        /* we can't determine the number of sections that we'll have to create ahead of time,
         * so we locally hold them until parsing is finished */
-       image_section_t section[IMAGE_MAX_SECTIONS];
+       struct imageection section[IMAGE_MAX_SECTIONS];
 
        mot->buffer = malloc(fileio->size >> 1);
        cooked_bytes = 0x0;
@@ -533,7 +554,7 @@ 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 */
@@ -614,7 +635,7 @@ static int image_mot_buffer_complete(image_t *image)
                        image->num_sections++;
 
                        /* copy section information */
-                       image->sections = malloc(sizeof(image_section_t) * image->num_sections);
+                       image->sections = malloc(sizeof(struct imageection) * image->num_sections);
                        for (i = 0; i < image->num_sections; i++)
                        {
                                image->sections[i].private = section[i].private;
@@ -636,7 +657,7 @@ static int image_mot_buffer_complete(image_t *image)
                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(struct image *image, const char *url, const char *type_string)
 {
        int retval = ERROR_OK;
 
@@ -659,9 +680,9 @@ int image_open(image_t *image, char *url, char *type_string)
 
        if (image->type == IMAGE_BINARY)
        {
-               image_binary_t *image_binary;
+               struct image_binary *image_binary;
 
-               image_binary = image->type_private = malloc(sizeof(image_binary_t));
+               image_binary = image->type_private = malloc(sizeof(struct image_binary));
 
                if ((retval = fileio_open(&image_binary->fileio, url, FILEIO_READ, FILEIO_BINARY)) != ERROR_OK)
                {
@@ -669,16 +690,16 @@ int image_open(image_t *image, char *url, char *type_string)
                }
 
                image->num_sections = 1;
-               image->sections = malloc(sizeof(image_section_t));
+               image->sections = malloc(sizeof(struct imageection));
                image->sections[0].base_address = 0x0;
                image->sections[0].size = image_binary->fileio.size;
                image->sections[0].flags = 0;
        }
        else if (image->type == IMAGE_IHEX)
        {
-               image_ihex_t *image_ihex;
+               struct image_ihex *image_ihex;
 
-               image_ihex = image->type_private = malloc(sizeof(image_ihex_t));
+               image_ihex = image->type_private = malloc(sizeof(struct image_ihex));
 
                if ((retval = fileio_open(&image_ihex->fileio, url, FILEIO_READ, FILEIO_TEXT)) != ERROR_OK)
                {
@@ -694,9 +715,9 @@ int image_open(image_t *image, char *url, char *type_string)
        }
        else if (image->type == IMAGE_ELF)
        {
-               image_elf_t *image_elf;
+               struct image_elf *image_elf;
 
-               image_elf = image->type_private = malloc(sizeof(image_elf_t));
+               image_elf = image->type_private = malloc(sizeof(struct image_elf));
 
                if ((retval = fileio_open(&image_elf->fileio, url, FILEIO_READ, FILEIO_BINARY)) != ERROR_OK)
                {
@@ -711,7 +732,7 @@ int image_open(image_t *image, char *url, char *type_string)
        }
        else if (image->type == IMAGE_MEMORY)
        {
-               target_t *target = get_target(url);
+               struct target *target = get_target(url);
 
                if (target == NULL)
                {
@@ -719,15 +740,15 @@ int image_open(image_t *image, char *url, char *type_string)
                        return ERROR_FAIL;
                }
 
-               image_memory_t *image_memory;
+               struct image_memory *image_memory;
 
                image->num_sections = 1;
-               image->sections = malloc(sizeof(image_section_t));
+               image->sections = malloc(sizeof(struct imageection));
                image->sections[0].base_address = 0x0;
                image->sections[0].size = 0xffffffff;
                image->sections[0].flags = 0;
 
-               image_memory = image->type_private = malloc(sizeof(image_memory_t));
+               image_memory = image->type_private = malloc(sizeof(struct image_memory));
 
                image_memory->target = target;
                image_memory->cache = NULL;
@@ -735,9 +756,9 @@ int image_open(image_t *image, char *url, char *type_string)
        }
        else if (image->type == IMAGE_SRECORD)
        {
-               image_mot_t *image_mot;
+               struct image_mot *image_mot;
 
-               image_mot = image->type_private = malloc(sizeof(image_mot_t));
+               image_mot = image->type_private = malloc(sizeof(struct image_mot));
 
                if ((retval = fileio_open(&image_mot->fileio, url, FILEIO_READ, FILEIO_TEXT)) != ERROR_OK)
                {
@@ -762,21 +783,21 @@ 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, uint32_t offset, uint32_t size, uint8_t *buffer, uint32_t *size_read)
+int image_read_section(struct image *image, int section, uint32_t offset, uint32_t size, uint8_t *buffer, size_t *size_read)
 {
        int retval;
 
@@ -790,7 +811,7 @@ int image_read_section(image_t *image, int section, uint32_t offset, uint32_t si
 
        if (image->type == IMAGE_BINARY)
        {
-               image_binary_t *image_binary = image->type_private;
+               struct image_binary *image_binary = image->type_private;
 
                /* only one section in a plain binary */
                if (section != 0)
@@ -821,7 +842,7 @@ int image_read_section(image_t *image, int section, uint32_t offset, uint32_t si
        }
        else if (image->type == IMAGE_MEMORY)
        {
-               image_memory_t *image_memory = image->type_private;
+               struct image_memory *image_memory = image->type_private;
                uint32_t address = image->sections[section].base_address + offset;
 
                *size_read = 0;
@@ -852,7 +873,7 @@ int image_read_section(image_t *image, int section, uint32_t offset, uint32_t si
                        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,9 +897,9 @@ int image_read_section(image_t *image, int section, uint32_t offset, uint32_t si
        return ERROR_OK;
 }
 
-int image_add_section(image_t *image, uint32_t base, uint32_t size, int flags, uint8_t *data)
+int image_add_section(struct image *image, uint32_t base, uint32_t size, int flags, uint8_t *data)
 {
-       image_section_t *section;
+       struct imageection *section;
 
        /* only image builder supports adding sections */
        if (image->type != IMAGE_BUILDER)
@@ -902,7 +923,7 @@ int image_add_section(image_t *image, uint32_t base, uint32_t size, int flags, u
 
        /* allocate new section */
        image->num_sections++;
-       image->sections = realloc(image->sections, sizeof(image_section_t) * image->num_sections);
+       image->sections = realloc(image->sections, sizeof(struct imageection) * image->num_sections);
        section = &image->sections[image->num_sections - 1];
        section->base_address = base;
        section->size = size;
@@ -913,17 +934,17 @@ int image_add_section(image_t *image, uint32_t base, uint32_t size, int flags, u
        return ERROR_OK;
 }
 
-void image_close(image_t *image)
+void image_close(struct image *image)
 {
        if (image->type == IMAGE_BINARY)
        {
-               image_binary_t *image_binary = image->type_private;
+               struct image_binary *image_binary = image->type_private;
 
                fileio_close(&image_binary->fileio);
        }
        else if (image->type == IMAGE_IHEX)
        {
-               image_ihex_t *image_ihex = image->type_private;
+               struct image_ihex *image_ihex = image->type_private;
 
                fileio_close(&image_ihex->fileio);
 
@@ -935,7 +956,7 @@ void image_close(image_t *image)
        }
        else if (image->type == IMAGE_ELF)
        {
-               image_elf_t *image_elf = image->type_private;
+               struct image_elf *image_elf = image->type_private;
 
                fileio_close(&image_elf->fileio);
 
@@ -953,7 +974,7 @@ void image_close(image_t *image)
        }
        else if (image->type == IMAGE_MEMORY)
        {
-               image_memory_t *image_memory = image->type_private;
+               struct image_memory *image_memory = image->type_private;
 
                if (image_memory->cache)
                {
@@ -963,7 +984,7 @@ void image_close(image_t *image)
        }
        else if (image->type == IMAGE_SRECORD)
        {
-               image_mot_t *image_mot = image->type_private;
+               struct image_mot *image_mot = image->type_private;
 
                fileio_close(&image_mot->fileio);
 
@@ -1015,12 +1036,12 @@ int image_calculate_checksum(uint8_t* buffer, uint32_t nbytes, uint32_t* checksu
                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;
                while (run--)

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)