add const keyword to some APIs

[openocd.git] / src / target / image.h

diff --git a/src/target/image.h b/src/target/image.h
index 75288791a6394a6a2b8f5820c776a669cf86c824..30240d5632c3a801b09c97e417e716353761ae49 100644 (file)
--- a/src/target/image.h
+++ b/src/target/image.h
@@ -2,6 +2,12 @@
  *   Copyright (C) 2007 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   oyvind.harboe@zylin.com                                               *
+ *                                                                         *
+ *   Copyright (C) 2008 by Spencer Oliver                                  *
+ *   spen@spen-soft.co.uk                                                  *
+ *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
@@ -21,28 +27,32 @@
 #define IMAGE_H
 
 #include "fileio.h"
-#include "target.h"
 
-#define IMAGE_MAX_ERROR_STRING         (128)
-#define IMAGE_MAX_SECTIONS                     (128)
+#ifdef HAVE_ELF_H
+#include <elf.h>
+#endif
+
+#define IMAGE_MAX_ERROR_STRING         (256)
+#define IMAGE_MAX_SECTIONS                     (512)
+
+#define IMAGE_MEMORY_CACHE_SIZE                (2048)
 
 typedef enum image_type
 {
-    IMAGE_BINARY,      /* plain binary */
-    IMAGE_IHEX,                /* intel hex-record format */
-    IMAGE_MEMORY,      /* target-memory pseudo-image */
-/*
- * Possible future enhancements:
- * IMAGE_ELF,
- * IMAGE_SRECORD,
- */
+       IMAGE_BINARY,   /* plain binary */
+       IMAGE_IHEX,             /* intel hex-record format */
+       IMAGE_MEMORY,   /* target-memory pseudo-image */
+       IMAGE_ELF,              /* ELF binary */
+       IMAGE_SRECORD,  /* motorola s19 */
+       IMAGE_BUILDER,  /* when building a new image */
 } image_type_t;
 
 typedef struct image_section_s
 {
-       u32 base_address;
-       u32 size;
+       uint32_t base_address;
+       uint32_t size;
        int flags;
+       void *private;          /* private data */
 } image_section_t;
 
 typedef struct image_s
@@ -54,8 +64,7 @@ typedef struct image_s
        int base_address_set;   /* whether the image has a base address set (for relocation purposes) */
        int base_address;               /* base address, if one is set */
        int start_address_set;  /* whether the image has a start address (entry point) associated */
-       u32 start_address;              /* start address, if one is set */
-       char error_str[IMAGE_MAX_ERROR_STRING];
+       uint32_t start_address;         /* start address, if one is set */
 } image_t;
 
 typedef struct image_binary_s
@@ -66,21 +75,45 @@ typedef struct image_binary_s
 typedef struct image_ihex_s
 {
        fileio_t fileio;
-       u8 *buffer;
-       u8 **section_pointer;
+       uint8_t *buffer;
 } image_ihex_t;
 
 typedef struct image_memory_s
 {
-       target_t *target;
+       struct target_s *target;
+       uint8_t *cache;
+       uint32_t cache_address;
 } image_memory_t;
 
-extern int image_open(image_t *image, void *source, enum fileio_access access);
-extern int image_read_section(image_t *image, int section, u32 offset, u32 size, u8 *buffer, u32 *size_read);
-extern int image_close(image_t *image);
-extern int identify_image_type(image_type_t *type, char *type_string);
+typedef struct fileio_elf_s
+{
+       fileio_t fileio;
+       Elf32_Ehdr *header;
+       Elf32_Phdr *segments;
+       uint32_t segment_count;
+       uint8_t endianness;
+} image_elf_t;
+
+typedef struct image_mot_s
+{
+       fileio_t fileio;
+       uint8_t *buffer;
+} image_mot_t;
+
+int image_open(image_t *image, const char *url, const char *type_string);
+int image_read_section(image_t *image, int section, uint32_t offset,
+               uint32_t size, uint8_t *buffer, uint32_t *size_read);
+void image_close(image_t *image);
+
+int image_add_section(image_t *image, uint32_t base, uint32_t size,
+               int flags, uint8_t *data);
+
+int image_calculate_checksum(uint8_t* buffer, uint32_t nbytes,
+               uint32_t* checksum);
 
 #define ERROR_IMAGE_FORMAT_ERROR       (-1400)
 #define ERROR_IMAGE_TYPE_UNKNOWN       (-1401)
+#define ERROR_IMAGE_TEMPORARILY_UNAVAILABLE            (-1402)
+#define ERROR_IMAGE_CHECKSUM           (-1403)
 
 #endif /* IMAGE_H */