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