summaryrefslogtreecommitdiff
path: root/arch/arm/lib/semihosting.c
blob: cb5dc26ac3fa283ab58c27c2876cddedc94b0efc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
/*
 * Copyright 2014 Broadcom Corporation
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

/*
 * Minimal semihosting implementation for reading files into memory. If more
 * features like writing files or console output are required they can be
 * added later. This code has been tested on arm64/aarch64 fastmodel only.
 * An untested placeholder exists for armv7 architectures, but since they
 * are commonly available in silicon now, fastmodel usage makes less sense
 * for them.
 */
#include <common.h>
#include <asm/semihosting.h>

#define SYSOPEN		0x01
#define SYSCLOSE	0x02
#define SYSREAD		0x06
#define SYSFLEN		0x0C

#define MODE_READ	0x0
#define MODE_READBIN	0x1

/*
 * Call the handler
 */
static int smh_trap(unsigned int sysnum, void *addr)
{
	register int result asm("r0");
#if defined(CONFIG_ARM64)
	asm volatile ("hlt #0xf000" : "=r" (result) : "0"(sysnum), "r"(addr));
#else
	/* Note - untested placeholder */
	asm volatile ("svc #0x123456" : "=r" (result) : "0"(sysnum), "r"(addr));
#endif
	return result;
}

/*
 * Open, load a file into memory, and close it. Check that the available space
 * is sufficient to store the entire file. Return the bytes actually read from
 * the file as seen by the read function. The verbose flag enables some extra
 * printing of successful read status.
 */
int smh_load(const char *fname, void *memp, int avail, int verbose)
{
	int ret, fd, len;

	ret = -1;

	debug("%s: fname \'%s\', avail %u, memp %p\n", __func__, fname,
	      avail, memp);

	/* Open the file */
	fd = smh_open(fname, "rb");
	if (fd == -1)
		return ret;

	/* Get the file length */
	ret = smh_len_fd(fd);
	if (ret == -1) {
		smh_close(fd);
		return ret;
	}

	/* Check that the file will fit in the supplied buffer */
	if (ret > avail) {
		printf("%s: ERROR ret %d, avail %u\n", __func__, ret,
		       avail);
		smh_close(fd);
		return ret;
	}

	len = ret;

	/* Read the file into the buffer */
	ret = smh_read(fd, memp, len);
	if (ret == 0) {
		/* Print successful load information if requested */
		if (verbose) {
			printf("\n%s\n", fname);
			printf("    0x%8p dest\n", memp);
			printf("    0x%08x size\n", len);
			printf("    0x%08x avail\n", avail);
		}
	}

	/* Close the file */
	smh_close(fd);

	return ret;
}

/*
 * Read 'len' bytes of file into 'memp'. Returns 0 on success, else failure
 */
int smh_read(int fd, void *memp, int len)
{
	int ret;
	struct smh_read_s {
		int fd;
		void *memp;
		int len;
	} read;

	debug("%s: fd %d, memp %p, len %d\n", __func__, fd, memp, len);

	read.fd = fd;
	read.memp = memp;
	read.len = len;

	ret = smh_trap(SYSREAD, &read);
	if (ret == 0) {
		return 0;
	} else {
		/*
		 * The ARM handler allows for returning partial lengths,
		 * but in practice this never happens so rather than create
		 * hard to maintain partial read loops and such, just fail
		 * with an error message.
		 */
		printf("%s: ERROR ret %d, fd %d, len %u memp %p\n",
		       __func__, ret, fd, len, memp);
	}
	return ret;
}

/*
 * Open a file on the host. Mode is "r" or "rb" currently. Returns a file
 * descriptor or -1 on error.
 */
int smh_open(const char *fname, char *modestr)
{
	int ret, fd, mode;
	struct smh_open_s {
		const char *fname;
		unsigned int mode;
		unsigned int len;
	} open;

	debug("%s: file \'%s\', mode \'%s\'\n", __func__, fname, modestr);

	ret = -1;

	/* Check the file mode */
	if (!(strcmp(modestr, "r"))) {
		mode = MODE_READ;
	} else if (!(strcmp(modestr, "rb"))) {
		mode = MODE_READBIN;
	} else {
		printf("%s: ERROR mode \'%s\' not supported\n", __func__,
		       modestr);
		return ret;
	}

	open.fname = fname;
	open.len = strlen(fname);
	open.mode = mode;

	/* Open the file on the host */
	fd = smh_trap(SYSOPEN, &open);
	if (fd == -1)
		printf("%s: ERROR fd %d for file \'%s\'\n", __func__, fd,
		       fname);

	return fd;
}

/*
 * Close the file using the file descriptor
 */
int smh_close(int fd)
{
	int ret;
	long fdlong;

	debug("%s: fd %d\n", __func__, fd);

	fdlong = (long)fd;
	ret = smh_trap(SYSCLOSE, &fdlong);
	if (ret == -1)
		printf("%s: ERROR fd %d\n", __func__, fd);

	return ret;
}

/*
 * Get the file length from the file descriptor
 */
int smh_len_fd(int fd)
{
	int ret;
	long fdlong;

	debug("%s: fd %d\n", __func__, fd);

	fdlong = (long)fd;
	ret = smh_trap(SYSFLEN, &fdlong);
	if (ret == -1)
		printf("%s: ERROR ret %d\n", __func__, ret);

	return ret;
}

/*
 * Get the file length from the filename
 */
int smh_len(const char *fname)
{
	int ret, fd, len;

	debug("%s: file \'%s\'\n", __func__, fname);

	/* Open the file */
	fd = smh_open(fname, "rb");
	if (fd == -1)
		return fd;

	/* Get the file length */
	len = smh_len_fd(fd);

	/* Close the file */
	ret = smh_close(fd);
	if (ret == -1)
		return ret;

	debug("%s: returning len %d\n", __func__, len);

	/* Return the file length (or -1 error indication) */
	return len;
}