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 #include <helper/fileio.h>
  30
  31 #ifdef HAVE_ELF_H
  32 #include <elf.h>
  33 #endif
  34
  35 #define IMAGE_MAX_ERROR_STRING          (256)
  36 #define IMAGE_MAX_SECTIONS                      (512)
  37
  38 #define IMAGE_MEMORY_CACHE_SIZE         (2048)
  39
  40 enum image_type
  41 {
  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 imageection
  51 {
  52         uint32_t base_address;
  53         uint32_t size;
  54         int flags;
  55         void *private;          /* private data */
  56 };
  57
  58 struct image
  59 {
  60         enum image_type type;           /* image type (plain, ihex, ...) */
  61         void *type_private;             /* type private data */
  62         int num_sections;               /* number of sections contained in the image */
  63         struct imageection *sections;   /* array of sections */
  64         int base_address_set;   /* whether the image has a base address set (for relocation purposes) */
  65         int base_address;               /* base address, if one is set */
  66         int start_address_set;  /* whether the image has a start address (entry point) associated */
  67         uint32_t start_address;         /* start address, if one is set */
  68 };
  69
  70 struct image_binary
  71 {
  72         struct fileio fileio;
  73 };
  74
  75 struct image_ihex
  76 {
  77         struct fileio fileio;
  78         uint8_t *buffer;
  79 };
  80
  81 struct image_memory
  82 {
  83         struct target *target;
  84         uint8_t *cache;
  85         uint32_t cache_address;
  86 };
  87
  88 struct image_elf
  89 {
  90         struct fileio fileio;
  91         Elf32_Ehdr *header;
  92         Elf32_Phdr *segments;
  93         uint32_t segment_count;
  94         uint8_t endianness;
  95 };
  96
  97 struct image_mot
  98 {
  99         struct fileio fileio;
 100         uint8_t *buffer;
 101 };
 102
 103 int image_open(struct image *image, const char *url, const char *type_string);
 104 int image_read_section(struct image *image, int section, uint32_t offset,
 105                 uint32_t size, uint8_t *buffer, size_t *size_read);
 106 void image_close(struct image *image);
 107
 108 int image_add_section(struct image *image, uint32_t base, uint32_t size,
 109                 int flags, uint8_t *data);
 110
 111 int image_calculate_checksum(uint8_t* buffer, uint32_t nbytes,
 112                 uint32_t* checksum);
 113
 114 #define ERROR_IMAGE_FORMAT_ERROR        (-1400)
 115 #define ERROR_IMAGE_TYPE_UNKNOWN        (-1401)
 116 #define ERROR_IMAGE_TEMPORARILY_UNAVAILABLE             (-1402)
 117 #define ERROR_IMAGE_CHECKSUM            (-1403)
 118
 119 #endif /* IMAGE_H */