git.gag.com Git - fw/openocd/blob - src/target/image.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #ifndef IMAGE_H
  21 #define IMAGE_H
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26
  27 #ifdef HAVE_ELF_H
  28 #include <elf.h>
  29 #endif
  30 #include "replacements.h"
  31 #include "fileio.h"
  32 #include "target.h"
  33
  34 #define IMAGE_MAX_ERROR_STRING          (256)
  35 #define IMAGE_MAX_SECTIONS                      (128)
  36
  37 #define IMAGE_MEMORY_CACHE_SIZE         (128)
  38
  39 typedef enum image_type
  40 {
  41     IMAGE_BINARY,       /* plain binary */
  42     IMAGE_IHEX,         /* intel hex-record format */
  43     IMAGE_MEMORY,       /* target-memory pseudo-image */
  44     IMAGE_ELF,          /* ELF binary */
  45 /*
  46  * Possible future enhancements:
  47  * IMAGE_SRECORD,
  48  */
  49 } image_type_t;
  50
  51 typedef struct image_section_s
  52 {
  53         u32 base_address;
  54         u32 size;
  55         int flags;
  56         void *private;          /* private data */
  57 } image_section_t;
  58
  59 typedef struct image_s
  60 {
  61         image_type_t type;              /* image type (plain, ihex, ...) */
  62         void *type_private;             /* type private data */
  63         int num_sections;               /* number of sections contained in the image */
  64         image_section_t *sections;      /* array of sections */
  65         int base_address_set;   /* whether the image has a base address set (for relocation purposes) */
  66         int base_address;               /* base address, if one is set */
  67         int start_address_set;  /* whether the image has a start address (entry point) associated */
  68         u32 start_address;              /* start address, if one is set */
  69         char error_str[IMAGE_MAX_ERROR_STRING];
  70 } image_t;
  71
  72 typedef struct image_binary_s
  73 {
  74         fileio_t fileio;
  75 } image_binary_t;
  76
  77 typedef struct image_ihex_s
  78 {
  79         fileio_t fileio;
  80         u8 *buffer;
  81 } image_ihex_t;
  82
  83 typedef struct image_memory_s
  84 {
  85         target_t *target;
  86         u8 *cache;
  87         u32 cache_address;
  88 } image_memory_t;
  89
  90 typedef struct fileio_elf_s
  91 {
  92         fileio_t fileio;
  93         Elf32_Ehdr *header;
  94         Elf32_Phdr *segments;
  95         u32 segment_count;
  96         u8 endianness;
  97 } image_elf_t;
  98
  99 extern int image_open(image_t *image, char *url, char *type_string);
 100 extern int image_read_section(image_t *image, int section, u32 offset, u32 size, u8 *buffer, u32 *size_read);
 101 extern int image_close(image_t *image);
 102
 103 #define ERROR_IMAGE_FORMAT_ERROR        (-1400)
 104 #define ERROR_IMAGE_TYPE_UNKNOWN        (-1401)
 105 #define ERROR_IMAGE_TEMPORARILY_UNAVAILABLE             (-1402)
 106
 107 #endif /* IMAGE_H */