1 /***************************************************************************
2 * Copyright (C) 2007 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
11 * Copyright (C) 2018 by Advantest *
12 * florian.meister@advantest.com *
14 * This program is free software; you can redistribute it and/or modify *
15 * it under the terms of the GNU General Public License as published by *
16 * the Free Software Foundation; either version 2 of the License, or *
17 * (at your option) any later version. *
19 * This program is distributed in the hope that it will be useful, *
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
22 * GNU General Public License for more details. *
24 * You should have received a copy of the GNU General Public License *
25 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
26 ***************************************************************************/
28 #ifndef OPENOCD_TARGET_IMAGE_H
29 #define OPENOCD_TARGET_IMAGE_H
31 #include <helper/fileio.h>
32 #include <helper/replacements.h>
38 #define IMAGE_MAX_ERROR_STRING (256)
39 #define IMAGE_MAX_SECTIONS (512)
41 #define IMAGE_MEMORY_CACHE_SIZE (2048)
44 IMAGE_BINARY, /* plain binary */
45 IMAGE_IHEX, /* intel hex-record format */
46 IMAGE_MEMORY, /* target-memory pseudo-image */
47 IMAGE_ELF, /* ELF binary */
48 IMAGE_SRECORD, /* motorola s19 */
49 IMAGE_BUILDER, /* when building a new image */
53 target_addr_t base_address;
56 void *private; /* private data */
60 enum image_type type; /* image type (plain, ihex, ...) */
61 void *type_private; /* type private data */
62 unsigned int num_sections; /* number of sections contained in the image */
63 struct imagesection *sections; /* array of sections */
64 bool base_address_set; /* whether the image has a base address set (for relocation purposes) */
65 long long base_address; /* base address, if one is set */
66 bool start_address_set; /* whether the image has a start address (entry point) associated */
67 uint32_t start_address; /* start address, if one is set */
71 struct fileio *fileio;
75 struct fileio *fileio;
80 struct target *target;
82 uint32_t cache_address;
86 struct fileio *fileio;
93 Elf32_Phdr *segments32;
94 Elf64_Phdr *segments64;
96 uint32_t segment_count;
101 struct fileio *fileio;
105 int image_open(struct image *image, const char *url, const char *type_string);
106 int image_read_section(struct image *image, int section, target_addr_t offset,
107 uint32_t size, uint8_t *buffer, size_t *size_read);
108 void image_close(struct image *image);
110 int image_add_section(struct image *image, target_addr_t base, uint32_t size,
111 int flags, uint8_t const *data);
113 int image_calculate_checksum(const uint8_t *buffer, uint32_t nbytes,
116 #define ERROR_IMAGE_FORMAT_ERROR (-1400)
117 #define ERROR_IMAGE_TYPE_UNKNOWN (-1401)
118 #define ERROR_IMAGE_TEMPORARILY_UNAVAILABLE (-1402)
119 #define ERROR_IMAGE_CHECKSUM (-1403)
121 #endif /* OPENOCD_TARGET_IMAGE_H */