blob: 8e62be1d961c31c1370c367226d69c01c04f6d6d [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{
87 int result = IO_SUCCESS;
88 assert(dev_info != NULL);
Dan Handleya4cb68e2014-04-23 13:47:06 +010089 *dev_info = (io_dev_info_t *)&sh_dev_info; /* cast away const */
James Morrissey9d72b4e2014-02-10 17:04:32 +000090 return result;
91}
92
93
94/* Open a file on the semi-hosting device */
Dan Handleye2712bc2014-04-10 15:37:22 +010095static int sh_file_open(io_dev_info_t *dev_info __attribute__((unused)),
Dan Handleya4cb68e2014-04-23 13:47:06 +010096 const uintptr_t spec, io_entity_t *entity)
James Morrissey9d72b4e2014-02-10 17:04:32 +000097{
98 int result = IO_FAIL;
Ryan Harkincd529322014-02-10 17:17:04 +000099 long sh_result = -1;
Dan Handleya4cb68e2014-04-23 13:47:06 +0100100 const io_file_spec_t *file_spec = (const io_file_spec_t *)spec;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000101
102 assert(file_spec != NULL);
103 assert(entity != NULL);
104
105 sh_result = semihosting_file_open(file_spec->path, file_spec->mode);
106
107 if (sh_result > 0) {
Ryan Harkincd529322014-02-10 17:17:04 +0000108 entity->info = (uintptr_t)sh_result;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000109 result = IO_SUCCESS;
110 } else {
111 result = IO_FAIL;
112 }
113 return result;
114}
115
116
117/* Seek to a particular file offset on the semi-hosting device */
Dan Handleye2712bc2014-04-10 15:37:22 +0100118static int sh_file_seek(io_entity_t *entity, int mode, ssize_t offset)
James Morrissey9d72b4e2014-02-10 17:04:32 +0000119{
120 int result = IO_FAIL;
Ryan Harkincd529322014-02-10 17:17:04 +0000121 long file_handle, sh_result;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000122
123 assert(entity != NULL);
124
Ryan Harkincd529322014-02-10 17:17:04 +0000125 file_handle = (long)entity->info;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000126
127 sh_result = semihosting_file_seek(file_handle, offset);
128
129 result = (sh_result == 0) ? IO_SUCCESS : IO_FAIL;
130
131 return result;
132}
133
134
135/* Return the size of a file on the semi-hosting device */
Dan Handleye2712bc2014-04-10 15:37:22 +0100136static int sh_file_len(io_entity_t *entity, size_t *length)
James Morrissey9d72b4e2014-02-10 17:04:32 +0000137{
138 int result = IO_FAIL;
139
140 assert(entity != NULL);
141 assert(length != NULL);
142
Ryan Harkincd529322014-02-10 17:17:04 +0000143 long sh_handle = (long)entity->info;
144 long sh_result = semihosting_file_length(sh_handle);
James Morrissey9d72b4e2014-02-10 17:04:32 +0000145
146 if (sh_result >= 0) {
147 result = IO_SUCCESS;
148 *length = (size_t)sh_result;
149 }
150
151 return result;
152}
153
154
155/* Read data from a file on the semi-hosting device */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100156static int sh_file_read(io_entity_t *entity, uintptr_t buffer, size_t length,
James Morrissey9d72b4e2014-02-10 17:04:32 +0000157 size_t *length_read)
158{
159 int result = IO_FAIL;
Ryan Harkincd529322014-02-10 17:17:04 +0000160 long sh_result = -1;
161 size_t bytes = length;
162 long file_handle;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000163
164 assert(entity != NULL);
Dan Handleya4cb68e2014-04-23 13:47:06 +0100165 assert(buffer != (uintptr_t)NULL);
James Morrissey9d72b4e2014-02-10 17:04:32 +0000166 assert(length_read != NULL);
167
Ryan Harkincd529322014-02-10 17:17:04 +0000168 file_handle = (long)entity->info;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000169
170 sh_result = semihosting_file_read(file_handle, &bytes, buffer);
171
172 if (sh_result >= 0) {
173 *length_read = (bytes != length) ? bytes : length;
174 result = IO_SUCCESS;
175 } else
176 result = IO_FAIL;
177
178 return result;
179}
180
181
182/* Write data to a file on the semi-hosting device */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100183static int sh_file_write(io_entity_t *entity, const uintptr_t buffer,
James Morrissey9d72b4e2014-02-10 17:04:32 +0000184 size_t length, size_t *length_written)
185{
Ryan Harkincd529322014-02-10 17:17:04 +0000186 long sh_result = -1;
187 long file_handle;
188 size_t bytes = length;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000189
190 assert(entity != NULL);
Dan Handleya4cb68e2014-04-23 13:47:06 +0100191 assert(buffer != (uintptr_t)NULL);
James Morrissey9d72b4e2014-02-10 17:04:32 +0000192 assert(length_written != NULL);
193
Ryan Harkincd529322014-02-10 17:17:04 +0000194 file_handle = (long)entity->info;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000195
196 sh_result = semihosting_file_write(file_handle, &bytes, buffer);
197
Juan Castillo03fe10c2015-07-07 15:36:33 +0100198 *length_written = length - bytes;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000199
Juan Castillo03fe10c2015-07-07 15:36:33 +0100200 return (sh_result == 0) ? IO_SUCCESS : IO_FAIL;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000201}
202
203
204/* Close a file on the semi-hosting device */
Dan Handleye2712bc2014-04-10 15:37:22 +0100205static int sh_file_close(io_entity_t *entity)
James Morrissey9d72b4e2014-02-10 17:04:32 +0000206{
207 int result = IO_FAIL;
Ryan Harkincd529322014-02-10 17:17:04 +0000208 long sh_result = -1;
209 long file_handle;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000210
211 assert(entity != NULL);
212
Ryan Harkincd529322014-02-10 17:17:04 +0000213 file_handle = (long)entity->info;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000214
215 sh_result = semihosting_file_close(file_handle);
216
217 result = (sh_result >= 0) ? IO_SUCCESS : IO_FAIL;
218
219 return result;
220}
221
222
223/* Exported functions */
224
225/* Register the semi-hosting driver with the IO abstraction */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100226int register_io_dev_sh(const io_dev_connector_t **dev_con)
James Morrissey9d72b4e2014-02-10 17:04:32 +0000227{
228 int result = IO_FAIL;
229 assert(dev_con != NULL);
230
231 result = io_register_device(&sh_dev_info);
232 if (result == IO_SUCCESS)
233 *dev_con = &sh_dev_connector;
234
235 return result;
236}