git.sur5r.net Git - 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 #include <elf.h>
  24 #include "fileio.h"
  25 #include "target.h"
  26
  27 #define IMAGE_MAX_ERROR_STRING          (256)
  28 #define IMAGE_MAX_SECTIONS                      (128)
  29
  30 #define IMAGE_MEMORY_CACHE_SIZE         (128)
  31
  32 typedef enum image_type
  33 {
  34     IMAGE_BINARY,       /* plain binary */
  35     IMAGE_IHEX,         /* intel hex-record format */
  36     IMAGE_MEMORY,       /* target-memory pseudo-image */
  37     IMAGE_ELF,          /* ELF binary */
  38 /*
  39  * Possible future enhancements:
  40  * IMAGE_SRECORD,
  41  */
  42 } image_type_t;
  43
  44 typedef struct image_section_s
  45 {
  46         u32 base_address;
  47         u32 size;
  48         int flags;
  49         void *private;          /* private data */
  50 } image_section_t;
  51
  52 typedef struct image_s
  53 {
  54         image_type_t type;              /* image type (plain, ihex, ...) */
  55         void *type_private;             /* type private data */
  56         int num_sections;               /* number of sections contained in the image */
  57         image_section_t *sections;      /* array of sections */
  58         int base_address_set;   /* whether the image has a base address set (for relocation purposes) */
  59         int base_address;               /* base address, if one is set */
  60         int start_address_set;  /* whether the image has a start address (entry point) associated */
  61         u32 start_address;              /* start address, if one is set */
  62         char error_str[IMAGE_MAX_ERROR_STRING];
  63 } image_t;
  64
  65 typedef struct image_binary_s
  66 {
  67         fileio_t fileio;
  68 } image_binary_t;
  69
  70 typedef struct image_ihex_s
  71 {
  72         fileio_t fileio;
  73         u8 *buffer;
  74 } image_ihex_t;
  75
  76 typedef struct image_memory_s
  77 {
  78         target_t *target;
  79         u8 *cache;
  80         u32 cache_address;
  81 } image_memory_t;
  82
  83 typedef struct fileio_elf_s
  84 {
  85         fileio_t fileio;
  86         Elf32_Ehdr *header;
  87         Elf32_Phdr *segments;
  88         u32 segment_count;
  89         u8 endianness;
  90 } image_elf_t;
  91
  92 extern int image_open(image_t *image, char *url, char *type_string);
  93 extern int image_read_section(image_t *image, int section, u32 offset, u32 size, u8 *buffer, u32 *size_read);
  94 extern int image_close(image_t *image);
  95
  96 #define ERROR_IMAGE_FORMAT_ERROR        (-1400)
  97 #define ERROR_IMAGE_TYPE_UNKNOWN        (-1401)
  98 #define ERROR_IMAGE_TEMPORARILY_UNAVAILABLE             (-1402)
  99
 100 #endif /* IMAGE_H */