blob: e33a044df4a6f01d44e86c862197cfb4205a56a6 [file] [log] [blame]
James Morrissey9d72b4e2014-02-10 17:04:32 +00001/*
2 * Copyright (c) 2014, ARM Limited and Contributors. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * Redistributions of source code must retain the above copyright notice, this
8 * list of conditions and the following disclaimer.
9 *
10 * Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 *
14 * Neither the name of ARM nor the names of its contributors may be used
15 * to endorse or promote products derived from this software without specific
16 * prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#include <assert.h>
Dan Handley714a0d22014-04-09 13:13:04 +010032#include <io_driver.h>
Dan Handley2bd4ef22014-04-09 13:14:54 +010033#include <io_storage.h>
Dan Handley714a0d22014-04-09 13:13:04 +010034#include <semihosting.h>
James Morrissey9d72b4e2014-02-10 17:04:32 +000035
36
37
38/* Identify the device type as semihosting */
Dan Handleye2712bc2014-04-10 15:37:22 +010039static io_type_t device_type_sh(void)
James Morrissey9d72b4e2014-02-10 17:04:32 +000040{
41 return IO_TYPE_SEMIHOSTING;
42}
43
44
45/* Semi-hosting functions, device info and handle */
46
Dan Handleya4cb68e2014-04-23 13:47:06 +010047static int sh_dev_open(const uintptr_t dev_spec, io_dev_info_t **dev_info);
48static int sh_file_open(io_dev_info_t *dev_info, const uintptr_t spec,
Dan Handleye2712bc2014-04-10 15:37:22 +010049 io_entity_t *entity);
50static int sh_file_seek(io_entity_t *entity, int mode, ssize_t offset);
51static int sh_file_len(io_entity_t *entity, size_t *length);
Dan Handleya4cb68e2014-04-23 13:47:06 +010052static int sh_file_read(io_entity_t *entity, uintptr_t buffer, size_t length,
James Morrissey9d72b4e2014-02-10 17:04:32 +000053 size_t *length_read);
Dan Handleya4cb68e2014-04-23 13:47:06 +010054static int sh_file_write(io_entity_t *entity, const uintptr_t buffer,
James Morrissey9d72b4e2014-02-10 17:04:32 +000055 size_t length, size_t *length_written);
Dan Handleye2712bc2014-04-10 15:37:22 +010056static int sh_file_close(io_entity_t *entity);
James Morrissey9d72b4e2014-02-10 17:04:32 +000057
Dan Handleya4cb68e2014-04-23 13:47:06 +010058static const io_dev_connector_t sh_dev_connector = {
James Morrissey9d72b4e2014-02-10 17:04:32 +000059 .dev_open = sh_dev_open
60};
61
62
Dan Handleya4cb68e2014-04-23 13:47:06 +010063static const io_dev_funcs_t sh_dev_funcs = {
James Morrissey9d72b4e2014-02-10 17:04:32 +000064 .type = device_type_sh,
65 .open = sh_file_open,
66 .seek = sh_file_seek,
67 .size = sh_file_len,
68 .read = sh_file_read,
69 .write = sh_file_write,
70 .close = sh_file_close,
71 .dev_init = NULL, /* NOP */
72 .dev_close = NULL, /* NOP */
73};
74
75
Dan Handleya4cb68e2014-04-23 13:47:06 +010076/* No state associated with this device so structure can be const */
77static const io_dev_info_t sh_dev_info = {
James Morrissey9d72b4e2014-02-10 17:04:32 +000078 .funcs = &sh_dev_funcs,
79 .info = (uintptr_t)NULL
80};
81
82
83/* Open a connection to the semi-hosting device */
Dan Handleya4cb68e2014-04-23 13:47:06 +010084static int sh_dev_open(const uintptr_t dev_spec __unused,
85 io_dev_info_t **dev_info)
James Morrissey9d72b4e2014-02-10 17:04:32 +000086{
James Morrissey9d72b4e2014-02-10 17:04:32 +000087 assert(dev_info != NULL);
Dan Handleya4cb68e2014-04-23 13:47:06 +010088 *dev_info = (io_dev_info_t *)&sh_dev_info; /* cast away const */
Juan Castillo6e762062015-11-02 10:47:01 +000089 return 0;
James Morrissey9d72b4e2014-02-10 17:04:32 +000090}
91
92
93/* Open a file on the semi-hosting device */
Soren Brinkmann46dd1702016-01-14 10:11:05 -080094static int sh_file_open(io_dev_info_t *dev_info __unused,
Dan Handleya4cb68e2014-04-23 13:47:06 +010095 const uintptr_t spec, io_entity_t *entity)
James Morrissey9d72b4e2014-02-10 17:04:32 +000096{
Juan Castillo6e762062015-11-02 10:47:01 +000097 int result = -ENOENT;
dp-arm8b6e3d32017-02-09 10:25:29 +000098 long sh_result;
Dan Handleya4cb68e2014-04-23 13:47:06 +010099 const io_file_spec_t *file_spec = (const io_file_spec_t *)spec;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000100
101 assert(file_spec != NULL);
102 assert(entity != NULL);
103
104 sh_result = semihosting_file_open(file_spec->path, file_spec->mode);
105
106 if (sh_result > 0) {
Ryan Harkincd529322014-02-10 17:17:04 +0000107 entity->info = (uintptr_t)sh_result;
Juan Castillo6e762062015-11-02 10:47:01 +0000108 result = 0;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000109 }
110 return result;
111}
112
113
114/* Seek to a particular file offset on the semi-hosting device */
Dan Handleye2712bc2014-04-10 15:37:22 +0100115static int sh_file_seek(io_entity_t *entity, int mode, ssize_t offset)
James Morrissey9d72b4e2014-02-10 17:04:32 +0000116{
Ryan Harkincd529322014-02-10 17:17:04 +0000117 long file_handle, sh_result;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000118
119 assert(entity != NULL);
120
Ryan Harkincd529322014-02-10 17:17:04 +0000121 file_handle = (long)entity->info;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000122
123 sh_result = semihosting_file_seek(file_handle, offset);
124
Juan Castillo6e762062015-11-02 10:47:01 +0000125 return (sh_result == 0) ? 0 : -ENOENT;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000126}
127
128
129/* Return the size of a file on the semi-hosting device */
Dan Handleye2712bc2014-04-10 15:37:22 +0100130static int sh_file_len(io_entity_t *entity, size_t *length)
James Morrissey9d72b4e2014-02-10 17:04:32 +0000131{
Juan Castillo6e762062015-11-02 10:47:01 +0000132 int result = -ENOENT;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000133
134 assert(entity != NULL);
135 assert(length != NULL);
136
Ryan Harkincd529322014-02-10 17:17:04 +0000137 long sh_handle = (long)entity->info;
138 long sh_result = semihosting_file_length(sh_handle);
James Morrissey9d72b4e2014-02-10 17:04:32 +0000139
140 if (sh_result >= 0) {
Juan Castillo6e762062015-11-02 10:47:01 +0000141 result = 0;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000142 *length = (size_t)sh_result;
143 }
144
145 return result;
146}
147
148
149/* Read data from a file on the semi-hosting device */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100150static int sh_file_read(io_entity_t *entity, uintptr_t buffer, size_t length,
James Morrissey9d72b4e2014-02-10 17:04:32 +0000151 size_t *length_read)
152{
Juan Castillo6e762062015-11-02 10:47:01 +0000153 int result = -ENOENT;
dp-arm8b6e3d32017-02-09 10:25:29 +0000154 long sh_result;
Ryan Harkincd529322014-02-10 17:17:04 +0000155 size_t bytes = length;
156 long file_handle;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000157
158 assert(entity != NULL);
Dan Handleya4cb68e2014-04-23 13:47:06 +0100159 assert(buffer != (uintptr_t)NULL);
James Morrissey9d72b4e2014-02-10 17:04:32 +0000160 assert(length_read != NULL);
161
Ryan Harkincd529322014-02-10 17:17:04 +0000162 file_handle = (long)entity->info;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000163
164 sh_result = semihosting_file_read(file_handle, &bytes, buffer);
165
166 if (sh_result >= 0) {
167 *length_read = (bytes != length) ? bytes : length;
Juan Castillo6e762062015-11-02 10:47:01 +0000168 result = 0;
169 }
James Morrissey9d72b4e2014-02-10 17:04:32 +0000170
171 return result;
172}
173
174
175/* Write data to a file on the semi-hosting device */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100176static int sh_file_write(io_entity_t *entity, const uintptr_t buffer,
James Morrissey9d72b4e2014-02-10 17:04:32 +0000177 size_t length, size_t *length_written)
178{
dp-arm8b6e3d32017-02-09 10:25:29 +0000179 long sh_result;
Ryan Harkincd529322014-02-10 17:17:04 +0000180 long file_handle;
181 size_t bytes = length;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000182
183 assert(entity != NULL);
Dan Handleya4cb68e2014-04-23 13:47:06 +0100184 assert(buffer != (uintptr_t)NULL);
James Morrissey9d72b4e2014-02-10 17:04:32 +0000185 assert(length_written != NULL);
186
Ryan Harkincd529322014-02-10 17:17:04 +0000187 file_handle = (long)entity->info;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000188
189 sh_result = semihosting_file_write(file_handle, &bytes, buffer);
190
Juan Castillo03fe10c2015-07-07 15:36:33 +0100191 *length_written = length - bytes;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000192
Juan Castillo6e762062015-11-02 10:47:01 +0000193 return (sh_result == 0) ? 0 : -ENOENT;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000194}
195
196
197/* Close a file on the semi-hosting device */
Dan Handleye2712bc2014-04-10 15:37:22 +0100198static int sh_file_close(io_entity_t *entity)
James Morrissey9d72b4e2014-02-10 17:04:32 +0000199{
dp-arm8b6e3d32017-02-09 10:25:29 +0000200 long sh_result;
Ryan Harkincd529322014-02-10 17:17:04 +0000201 long file_handle;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000202
203 assert(entity != NULL);
204
Ryan Harkincd529322014-02-10 17:17:04 +0000205 file_handle = (long)entity->info;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000206
207 sh_result = semihosting_file_close(file_handle);
208
Juan Castillo6e762062015-11-02 10:47:01 +0000209 return (sh_result >= 0) ? 0 : -ENOENT;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000210}
211
212
213/* Exported functions */
214
215/* Register the semi-hosting driver with the IO abstraction */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100216int register_io_dev_sh(const io_dev_connector_t **dev_con)
James Morrissey9d72b4e2014-02-10 17:04:32 +0000217{
Juan Castillo6e762062015-11-02 10:47:01 +0000218 int result;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000219 assert(dev_con != NULL);
220
221 result = io_register_device(&sh_dev_info);
Juan Castillo6e762062015-11-02 10:47:01 +0000222 if (result == 0)
James Morrissey9d72b4e2014-02-10 17:04:32 +0000223 *dev_con = &sh_dev_connector;
224
225 return result;
226}