1 /***************************************************************************
2  *   Copyright (C) 2007 by Dominic Rath                                    *
3  *   Dominic.Rath@gmx.de                                                   *
4  *                                                                         *
5  *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
6  *   oyvind.harboe@zylin.com                                               *
7  *                                                                         *
8  *   Copyright (C) 2008 by Spencer Oliver                                  *
9  *   spen@spen-soft.co.uk                                                  *
10  *                                                                         *
11  *   This program is free software; you can redistribute it and/or modify  *
12  *   it under the terms of the GNU General Public License as published by  *
13  *   the Free Software Foundation; either version 2 of the License, or     *
14  *   (at your option) any later version.                                   *
15  *                                                                         *
16  *   This program is distributed in the hope that it will be useful,       *
17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
19  *   GNU General Public License for more details.                          *
20  *                                                                         *
21  *   You should have received a copy of the GNU General Public License     *
22  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
23  ***************************************************************************/
24 
25 #ifndef OPENOCD_TARGET_IMAGE_H
26 #define OPENOCD_TARGET_IMAGE_H
27 
28 #include <helper/fileio.h>
29 
30 #ifdef HAVE_ELF_H
31 #include <elf.h>
32 #endif
33 
34 #define IMAGE_MAX_ERROR_STRING		(256)
35 #define IMAGE_MAX_SECTIONS			(512)
36 
37 #define IMAGE_MEMORY_CACHE_SIZE		(2048)
38 
39 enum image_type {
40 	IMAGE_BINARY,	/* plain binary */
41 	IMAGE_IHEX,		/* intel hex-record format */
42 	IMAGE_MEMORY,	/* target-memory pseudo-image */
43 	IMAGE_ELF,		/* ELF binary */
44 	IMAGE_SRECORD,	/* motorola s19 */
45 	IMAGE_BUILDER,	/* when building a new image */
46 };
47 
48 struct imagesection {
49 	target_addr_t base_address;
50 	uint32_t size;
51 	int flags;
52 	void *private;		/* private data */
53 };
54 
55 struct image {
56 	enum image_type type;		/* image type (plain, ihex, ...) */
57 	void *type_private;		/* type private data */
58 	unsigned int num_sections;		/* number of sections contained in the image */
59 	struct imagesection *sections;	/* array of sections */
60 	bool base_address_set;	/* whether the image has a base address set (for relocation purposes) */
61 	long long base_address;		/* base address, if one is set */
62 	bool start_address_set;	/* whether the image has a start address (entry point) associated */
63 	uint32_t start_address;		/* start address, if one is set */
64 };
65 
66 struct image_binary {
67 	struct fileio *fileio;
68 };
69 
70 struct image_ihex {
71 	struct fileio *fileio;
72 	uint8_t *buffer;
73 };
74 
75 struct image_memory {
76 	struct target *target;
77 	uint8_t *cache;
78 	uint32_t cache_address;
79 };
80 
81 struct image_elf {
82 	struct fileio *fileio;
83 	Elf32_Ehdr *header;
84 	Elf32_Phdr *segments;
85 	uint32_t segment_count;
86 	uint8_t endianness;
87 };
88 
89 struct image_mot {
90 	struct fileio *fileio;
91 	uint8_t *buffer;
92 };
93 
94 int image_open(struct image *image, const char *url, const char *type_string);
95 int image_read_section(struct image *image, int section, uint32_t offset,
96 		uint32_t size, uint8_t *buffer, size_t *size_read);
97 void image_close(struct image *image);
98 
99 int image_add_section(struct image *image, uint32_t base, uint32_t size,
100 		int flags, uint8_t const *data);
101 
102 int image_calculate_checksum(const uint8_t *buffer, uint32_t nbytes,
103 		uint32_t *checksum);
104 
105 #define ERROR_IMAGE_FORMAT_ERROR	(-1400)
106 #define ERROR_IMAGE_TYPE_UNKNOWN	(-1401)
107 #define ERROR_IMAGE_TEMPORARILY_UNAVAILABLE		(-1402)
108 #define ERROR_IMAGE_CHECKSUM		(-1403)
109 
110 #endif /* OPENOCD_TARGET_IMAGE_H */
111