Make #include guard naming consistent
[openocd.git] / src / target / image.h
index ec52acb4ff394bdb9df636bea8e4eb88a63e2065..9bf7af35d82b2947350eb2ce0bce138d67cb4353 100644 (file)
@@ -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     *
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
-#ifndef IMAGE_H
-#define IMAGE_H
 
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
+#ifndef OPENOCD_TARGET_IMAGE_H
+#define OPENOCD_TARGET_IMAGE_H
+
+#include <helper/fileio.h>
 
 #ifdef HAVE_ELF_H
 #include <elf.h>
 #endif
-#include "replacements.h"
-#include "fileio.h"
-#include "target.h"
 
 #define IMAGE_MAX_ERROR_STRING         (256)
-#define IMAGE_MAX_SECTIONS                     (128)
-
-#define IMAGE_MEMORY_CACHE_SIZE                (1024)
-
-typedef enum image_type
-{
-    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;
+#define IMAGE_MAX_SECTIONS                     (512)
+
+#define IMAGE_MEMORY_CACHE_SIZE                (2048)
+
+enum image_type {
+       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 */
+};
+
+struct imagesection {
+       uint32_t base_address;
+       uint32_t size;
        int flags;
        void *private;          /* private data */
-} image_section_t;
+};
 
-typedef struct image_s
-{
-       image_type_t type;              /* image type (plain, ihex, ...) */
+struct image {
+       enum image_type type;           /* image type (plain, ihex, ...) */
        void *type_private;             /* type private data */
        int num_sections;               /* number of sections contained in the image */
-       image_section_t *sections;      /* array of sections */
+       struct imagesection *sections;  /* array of sections */
        int base_address_set;   /* whether the image has a base address set (for relocation purposes) */
-       int base_address;               /* base address, if one is set */
+       long long 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];
-} image_t;
-
-typedef struct image_binary_s
-{
-       fileio_t fileio;
-} image_binary_t;
-
-typedef struct image_ihex_s
-{
-       fileio_t fileio;
-       u8 *buffer;
-} image_ihex_t;
-
-typedef struct image_memory_s
-{
-       target_t *target;
-       u8 *cache;
-       u32 cache_address;
-} image_memory_t;
-
-typedef struct fileio_elf_s
-{
-       fileio_t fileio;
+       uint32_t start_address;         /* start address, if one is set */
+};
+
+struct image_binary {
+       struct fileio *fileio;
+};
+
+struct image_ihex {
+       struct fileio *fileio;
+       uint8_t *buffer;
+};
+
+struct image_memory {
+       struct target *target;
+       uint8_t *cache;
+       uint32_t cache_address;
+};
+
+struct image_elf {
+       struct fileio *fileio;
        Elf32_Ehdr *header;
        Elf32_Phdr *segments;
-       u32 segment_count;
-       u8 endianness;
-} image_elf_t;
+       uint32_t segment_count;
+       uint8_t endianness;
+};
+
+struct image_mot {
+       struct fileio *fileio;
+       uint8_t *buffer;
+};
+
+int image_open(struct image *image, const char *url, const char *type_string);
+int image_read_section(struct image *image, int section, uint32_t offset,
+               uint32_t size, uint8_t *buffer, size_t *size_read);
+void image_close(struct image *image);
 
-typedef struct image_mot_s
-{
-       fileio_t fileio;
-       u8 *buffer;
-} image_mot_t;
+int image_add_section(struct image *image, uint32_t base, uint32_t size,
+               int flags, uint8_t const *data);
 
-extern int image_open(image_t *image, char *url, char *type_string);
-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 image_add_section(image_t *image, u32 base, u32 size, int flags, u8 *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 */
+#endif /* OPENOCD_TARGET_IMAGE_H */

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)