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  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  25  ***************************************************************************/
  26
  27 #ifndef IMAGE_H
  28 #define IMAGE_H
  29
  30 #include <helper/fileio.h>
  31
  32 #ifdef HAVE_ELF_H
  33 #include <elf.h>
  34 #endif
  35
  36 #define IMAGE_MAX_ERROR_STRING          (256)
  37 #define IMAGE_MAX_SECTIONS                      (512)
  38
  39 #define IMAGE_MEMORY_CACHE_SIZE         (2048)
  40
  41 enum image_type {
  42         IMAGE_BINARY,   /* plain binary */
  43         IMAGE_IHEX,             /* intel hex-record format */
  44         IMAGE_MEMORY,   /* target-memory pseudo-image */
  45         IMAGE_ELF,              /* ELF binary */
  46         IMAGE_SRECORD,  /* motorola s19 */
  47         IMAGE_BUILDER,  /* when building a new image */
  48 };
  49
  50 struct imagesection {
  51         uint32_t base_address;
  52         uint32_t size;
  53         int flags;
  54         void *private;          /* private data */
  55 };
  56
  57 struct image {
  58         enum image_type type;           /* image type (plain, ihex, ...) */
  59         void *type_private;             /* type private data */
  60         int num_sections;               /* number of sections contained in the image */
  61         struct imagesection *sections;  /* array of sections */
  62         int base_address_set;   /* whether the image has a base address set (for relocation purposes) */
  63         long long base_address;         /* base address, if one is set */
  64         int start_address_set;  /* whether the image has a start address (entry point) associated */
  65         uint32_t start_address;         /* start address, if one is set */
  66 };
  67
  68 struct image_binary {
  69         struct fileio fileio;
  70 };
  71
  72 struct image_ihex {
  73         struct fileio fileio;
  74         uint8_t *buffer;
  75 };
  76
  77 struct image_memory {
  78         struct target *target;
  79         uint8_t *cache;
  80         uint32_t cache_address;
  81 };
  82
  83 struct image_elf {
  84         struct fileio fileio;
  85         Elf32_Ehdr *header;
  86         Elf32_Phdr *segments;
  87         uint32_t segment_count;
  88         uint8_t endianness;
  89 };
  90
  91 struct image_mot {
  92         struct fileio fileio;
  93         uint8_t *buffer;
  94 };
  95
  96 int image_open(struct image *image, const char *url, const char *type_string);
  97 int image_read_section(struct image *image, int section, uint32_t offset,
  98                 uint32_t size, uint8_t *buffer, size_t *size_read);
  99 void image_close(struct image *image);
 100
 101 int image_add_section(struct image *image, uint32_t base, uint32_t size,
 102                 int flags, uint8_t const *data);
 103
 104 int image_calculate_checksum(uint8_t *buffer, uint32_t nbytes,
 105                 uint32_t *checksum);
 106
 107 #define ERROR_IMAGE_FORMAT_ERROR        (-1400)
 108 #define ERROR_IMAGE_TYPE_UNKNOWN        (-1401)
 109 #define ERROR_IMAGE_TEMPORARILY_UNAVAILABLE             (-1402)
 110 #define ERROR_IMAGE_CHECKSUM            (-1403)
 111
 112 #endif /* IMAGE_H */