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 "fileio.h"
  24 #include "target.h"
  25
  26 #define IMAGE_MAX_ERROR_STRING          (128)
  27
  28 typedef enum image_type
  29 {
  30     IMAGE_BINARY,       /* plain binary */
  31     IMAGE_IHEX, /* intel hex-record format */
  32     IMAGE_MEMORY,       /* target-memory pseudo-image */
  33 /*
  34  * Possible future enhancements:
  35  * IMAGE_ELF,
  36  * IMAGE_SRECORD,
  37  */
  38 } image_type_t;
  39
  40 typedef struct image_s
  41 {
  42         image_type_t type;              /* image type (plain, ihex, ...) */
  43         void *type_private;             /* type private data */
  44         int base_address_set;   /* whether the image start address has been set */
  45         u32 base_address;               /* base address of image in target memory */
  46         int start_address_set;  /* whether the image has a start address (entry point) associated */
  47         u32 start_address;              /* start address, if one is set */
  48         u32 size;                               /* image size in byte */
  49         char error_str[IMAGE_MAX_ERROR_STRING];
  50 } image_t;
  51
  52 typedef struct image_binary_s
  53 {
  54         fileio_t fileio;
  55 } image_binary_t;
  56
  57 typedef struct image_ihex_s
  58 {
  59         fileio_t fileio;
  60         u32 position;
  61         u32 raw_size;
  62         u8 *buffer;
  63 } image_ihex_t;
  64
  65 typedef struct image_memory_s
  66 {
  67         target_t *target;
  68 } image_memory_t;
  69
  70 extern int image_open(image_t *image, void *source, enum fileio_access access);
  71 extern int image_read(image_t *image, u32 size, u8 *buffer, u32 *size_written);
  72 extern int image_write(image_t *image, u32 size, u8 *buffer, u32 *size_written);
  73 extern int image_close(image_t *image);
  74 extern int identify_image_type(image_type_t *type, char *type_string);
  75
  76 #define ERROR_IMAGE_FORMAT_ERROR        (-1400)
  77 #define ERROR_IMAGE_TYPE_UNKNOWN        (-1401)
  78
  79 #endif /* IMAGE_H */