checkpatch: treat jenkins as valid email
[fw/openocd] / src / target / image.h
index 8b70b3b1e40e4b1ea853c9fd834ae02767776c0d..03bc068d62ffa9b50d1fe7f05c61b5ae5f07d388 100644 (file)
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2007 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *   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     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   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.             *
+ *   Copyright (C) 2018 by Advantest                                       *
+ *   florian.meister@advantest.com                                         *
  ***************************************************************************/
-#ifndef IMAGE_H
-#define IMAGE_H
 
-#include "fileio.h"
+#ifndef OPENOCD_TARGET_IMAGE_H
+#define OPENOCD_TARGET_IMAGE_H
+
+#include <helper/fileio.h>
+#include <helper/replacements.h>
 
 #ifdef HAVE_ELF_H
 #include <elf.h>
 
 #define IMAGE_MEMORY_CACHE_SIZE                (2048)
 
-typedef enum image_type
-{
+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
-{
-       uint32_t base_address;
+struct imagesection {
+       target_addr_t base_address;
        uint32_t size;
-       int flags;
+       uint64_t 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 */
-       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 */
+       unsigned int num_sections;              /* number of sections contained in the image */
+       struct imagesection *sections;  /* array of sections */
+       bool base_address_set;  /* whether the image has a base address set (for relocation purposes) */
+       long long base_address;         /* base address, if one is set */
+       bool start_address_set; /* whether the image has a start address (entry point) associated */
        uint32_t start_address;         /* start address, if one is set */
-} image_t;
+};
 
-typedef struct image_binary_s
-{
-       fileio_t fileio;
-} image_binary_t;
+struct image_binary {
+       struct fileio *fileio;
+};
 
-typedef struct image_ihex_s
-{
-       fileio_t fileio;
+struct image_ihex {
+       struct fileio *fileio;
        uint8_t *buffer;
-} image_ihex_t;
+};
 
-typedef struct image_memory_s
-{
-       struct target_s *target;
+struct image_memory {
+       struct target *target;
        uint8_t *cache;
        uint32_t cache_address;
-} image_memory_t;
-
-typedef struct fileio_elf_s
-{
-       fileio_t fileio;
-       Elf32_Ehdr *header;
-       Elf32_Phdr *segments;
+};
+
+struct image_elf {
+       struct fileio *fileio;
+       bool is_64_bit;
+       union {
+               Elf32_Ehdr *header32;
+               Elf64_Ehdr *header64;
+       };
+       union {
+               Elf32_Phdr *segments32;
+               Elf64_Phdr *segments64;
+       };
        uint32_t segment_count;
        uint8_t endianness;
-} image_elf_t;
+};
 
-typedef struct image_mot_s
-{
-       fileio_t fileio;
+struct image_mot {
+       struct fileio *fileio;
        uint8_t *buffer;
-} image_mot_t;
+};
 
-int image_open(image_t *image, char *url, 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_open(struct image *image, const char *url, const char *type_string);
+int image_read_section(struct image *image, int section, target_addr_t offset,
+               uint32_t size, uint8_t *buffer, size_t *size_read);
+void image_close(struct image *image);
 
-int image_add_section(image_t *image, uint32_t base, uint32_t size,
-               int flags, uint8_t *data);
+int image_add_section(struct image *image, target_addr_t base, uint32_t size,
+               uint64_t flags, uint8_t const *data);
 
-int image_calculate_checksum(uint8_t* buffer, uint32_t nbytes,
-               uint32_tchecksum);
+int image_calculate_checksum(const 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 */