James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 1 | /* |
Roberto Vargas | 7fabe1a | 2018-02-12 12:36:17 +0000 | [diff] [blame] | 2 | * Copyright (c) 2014-2018, ARM Limited and Contributors. All rights reserved. |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 3 | * |
dp-arm | 82cb2c1 | 2017-05-03 09:38:09 +0100 | [diff] [blame] | 4 | * SPDX-License-Identifier: BSD-3-Clause |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 5 | */ |
| 6 | |
| 7 | #include <assert.h> |
Antonio Nino Diaz | 09d40e0 | 2018-12-14 00:18:21 +0000 | [diff] [blame] | 8 | |
Konstantin Porotchkin | 255f5c8 | 2018-05-07 12:52:48 +0300 | [diff] [blame] | 9 | #include <platform_def.h> |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 10 | |
Antonio Nino Diaz | 09d40e0 | 2018-12-14 00:18:21 +0000 | [diff] [blame] | 11 | #include <drivers/io/io_driver.h> |
| 12 | #include <drivers/io/io_semihosting.h> |
| 13 | #include <drivers/io/io_storage.h> |
| 14 | #include <lib/semihosting.h> |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 15 | |
| 16 | /* Identify the device type as semihosting */ |
Dan Handley | fb037bf | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 17 | static io_type_t device_type_sh(void) |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 18 | { |
| 19 | return IO_TYPE_SEMIHOSTING; |
| 20 | } |
| 21 | |
| 22 | |
| 23 | /* Semi-hosting functions, device info and handle */ |
| 24 | |
Dan Handley | 625de1d | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 25 | static int sh_dev_open(const uintptr_t dev_spec, io_dev_info_t **dev_info); |
| 26 | static int sh_file_open(io_dev_info_t *dev_info, const uintptr_t spec, |
Dan Handley | fb037bf | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 27 | io_entity_t *entity); |
| 28 | static int sh_file_seek(io_entity_t *entity, int mode, ssize_t offset); |
| 29 | static int sh_file_len(io_entity_t *entity, size_t *length); |
Dan Handley | 625de1d | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 30 | static int sh_file_read(io_entity_t *entity, uintptr_t buffer, size_t length, |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 31 | size_t *length_read); |
Dan Handley | 625de1d | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 32 | static int sh_file_write(io_entity_t *entity, const uintptr_t buffer, |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 33 | size_t length, size_t *length_written); |
Dan Handley | fb037bf | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 34 | static int sh_file_close(io_entity_t *entity); |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 35 | |
Dan Handley | 625de1d | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 36 | static const io_dev_connector_t sh_dev_connector = { |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 37 | .dev_open = sh_dev_open |
| 38 | }; |
| 39 | |
| 40 | |
Dan Handley | 625de1d | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 41 | static const io_dev_funcs_t sh_dev_funcs = { |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 42 | .type = device_type_sh, |
| 43 | .open = sh_file_open, |
| 44 | .seek = sh_file_seek, |
| 45 | .size = sh_file_len, |
| 46 | .read = sh_file_read, |
| 47 | .write = sh_file_write, |
| 48 | .close = sh_file_close, |
| 49 | .dev_init = NULL, /* NOP */ |
| 50 | .dev_close = NULL, /* NOP */ |
| 51 | }; |
| 52 | |
| 53 | |
Dan Handley | 625de1d | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 54 | /* No state associated with this device so structure can be const */ |
| 55 | static const io_dev_info_t sh_dev_info = { |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 56 | .funcs = &sh_dev_funcs, |
| 57 | .info = (uintptr_t)NULL |
| 58 | }; |
| 59 | |
| 60 | |
| 61 | /* Open a connection to the semi-hosting device */ |
Dan Handley | 625de1d | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 62 | static int sh_dev_open(const uintptr_t dev_spec __unused, |
| 63 | io_dev_info_t **dev_info) |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 64 | { |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 65 | assert(dev_info != NULL); |
Dan Handley | 625de1d | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 66 | *dev_info = (io_dev_info_t *)&sh_dev_info; /* cast away const */ |
Juan Castillo | e098e24 | 2015-11-02 10:47:01 +0000 | [diff] [blame] | 67 | return 0; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 68 | } |
| 69 | |
| 70 | |
| 71 | /* Open a file on the semi-hosting device */ |
Soren Brinkmann | 65cd299 | 2016-01-14 10:11:05 -0800 | [diff] [blame] | 72 | static int sh_file_open(io_dev_info_t *dev_info __unused, |
Dan Handley | 625de1d | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 73 | const uintptr_t spec, io_entity_t *entity) |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 74 | { |
Juan Castillo | e098e24 | 2015-11-02 10:47:01 +0000 | [diff] [blame] | 75 | int result = -ENOENT; |
dp-arm | dae695a | 2017-02-09 10:25:29 +0000 | [diff] [blame] | 76 | long sh_result; |
Dan Handley | 625de1d | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 77 | const io_file_spec_t *file_spec = (const io_file_spec_t *)spec; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 78 | |
| 79 | assert(file_spec != NULL); |
| 80 | assert(entity != NULL); |
| 81 | |
| 82 | sh_result = semihosting_file_open(file_spec->path, file_spec->mode); |
| 83 | |
| 84 | if (sh_result > 0) { |
Ryan Harkin | cd52932 | 2014-02-10 17:17:04 +0000 | [diff] [blame] | 85 | entity->info = (uintptr_t)sh_result; |
Juan Castillo | e098e24 | 2015-11-02 10:47:01 +0000 | [diff] [blame] | 86 | result = 0; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 87 | } |
| 88 | return result; |
| 89 | } |
| 90 | |
| 91 | |
| 92 | /* Seek to a particular file offset on the semi-hosting device */ |
Dan Handley | fb037bf | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 93 | static int sh_file_seek(io_entity_t *entity, int mode, ssize_t offset) |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 94 | { |
Ryan Harkin | cd52932 | 2014-02-10 17:17:04 +0000 | [diff] [blame] | 95 | long file_handle, sh_result; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 96 | |
| 97 | assert(entity != NULL); |
| 98 | |
Ryan Harkin | cd52932 | 2014-02-10 17:17:04 +0000 | [diff] [blame] | 99 | file_handle = (long)entity->info; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 100 | |
| 101 | sh_result = semihosting_file_seek(file_handle, offset); |
| 102 | |
Juan Castillo | e098e24 | 2015-11-02 10:47:01 +0000 | [diff] [blame] | 103 | return (sh_result == 0) ? 0 : -ENOENT; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 104 | } |
| 105 | |
| 106 | |
| 107 | /* Return the size of a file on the semi-hosting device */ |
Dan Handley | fb037bf | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 108 | static int sh_file_len(io_entity_t *entity, size_t *length) |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 109 | { |
Juan Castillo | e098e24 | 2015-11-02 10:47:01 +0000 | [diff] [blame] | 110 | int result = -ENOENT; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 111 | |
| 112 | assert(entity != NULL); |
| 113 | assert(length != NULL); |
| 114 | |
Ryan Harkin | cd52932 | 2014-02-10 17:17:04 +0000 | [diff] [blame] | 115 | long sh_handle = (long)entity->info; |
| 116 | long sh_result = semihosting_file_length(sh_handle); |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 117 | |
| 118 | if (sh_result >= 0) { |
Juan Castillo | e098e24 | 2015-11-02 10:47:01 +0000 | [diff] [blame] | 119 | result = 0; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 120 | *length = (size_t)sh_result; |
| 121 | } |
| 122 | |
| 123 | return result; |
| 124 | } |
| 125 | |
| 126 | |
| 127 | /* Read data from a file on the semi-hosting device */ |
Dan Handley | 625de1d | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 128 | static int sh_file_read(io_entity_t *entity, uintptr_t buffer, size_t length, |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 129 | size_t *length_read) |
| 130 | { |
Juan Castillo | e098e24 | 2015-11-02 10:47:01 +0000 | [diff] [blame] | 131 | int result = -ENOENT; |
dp-arm | dae695a | 2017-02-09 10:25:29 +0000 | [diff] [blame] | 132 | long sh_result; |
Ryan Harkin | cd52932 | 2014-02-10 17:17:04 +0000 | [diff] [blame] | 133 | size_t bytes = length; |
| 134 | long file_handle; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 135 | |
| 136 | assert(entity != NULL); |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 137 | assert(length_read != NULL); |
| 138 | |
Ryan Harkin | cd52932 | 2014-02-10 17:17:04 +0000 | [diff] [blame] | 139 | file_handle = (long)entity->info; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 140 | |
| 141 | sh_result = semihosting_file_read(file_handle, &bytes, buffer); |
| 142 | |
| 143 | if (sh_result >= 0) { |
| 144 | *length_read = (bytes != length) ? bytes : length; |
Juan Castillo | e098e24 | 2015-11-02 10:47:01 +0000 | [diff] [blame] | 145 | result = 0; |
| 146 | } |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 147 | |
| 148 | return result; |
| 149 | } |
| 150 | |
| 151 | |
| 152 | /* Write data to a file on the semi-hosting device */ |
Dan Handley | 625de1d | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 153 | static int sh_file_write(io_entity_t *entity, const uintptr_t buffer, |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 154 | size_t length, size_t *length_written) |
| 155 | { |
dp-arm | dae695a | 2017-02-09 10:25:29 +0000 | [diff] [blame] | 156 | long sh_result; |
Ryan Harkin | cd52932 | 2014-02-10 17:17:04 +0000 | [diff] [blame] | 157 | long file_handle; |
| 158 | size_t bytes = length; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 159 | |
| 160 | assert(entity != NULL); |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 161 | assert(length_written != NULL); |
| 162 | |
Ryan Harkin | cd52932 | 2014-02-10 17:17:04 +0000 | [diff] [blame] | 163 | file_handle = (long)entity->info; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 164 | |
| 165 | sh_result = semihosting_file_write(file_handle, &bytes, buffer); |
| 166 | |
Juan Castillo | 31833af | 2015-07-07 15:36:33 +0100 | [diff] [blame] | 167 | *length_written = length - bytes; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 168 | |
Juan Castillo | e098e24 | 2015-11-02 10:47:01 +0000 | [diff] [blame] | 169 | return (sh_result == 0) ? 0 : -ENOENT; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 170 | } |
| 171 | |
| 172 | |
| 173 | /* Close a file on the semi-hosting device */ |
Dan Handley | fb037bf | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 174 | static int sh_file_close(io_entity_t *entity) |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 175 | { |
dp-arm | dae695a | 2017-02-09 10:25:29 +0000 | [diff] [blame] | 176 | long sh_result; |
Ryan Harkin | cd52932 | 2014-02-10 17:17:04 +0000 | [diff] [blame] | 177 | long file_handle; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 178 | |
| 179 | assert(entity != NULL); |
| 180 | |
Ryan Harkin | cd52932 | 2014-02-10 17:17:04 +0000 | [diff] [blame] | 181 | file_handle = (long)entity->info; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 182 | |
| 183 | sh_result = semihosting_file_close(file_handle); |
| 184 | |
Juan Castillo | e098e24 | 2015-11-02 10:47:01 +0000 | [diff] [blame] | 185 | return (sh_result >= 0) ? 0 : -ENOENT; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 186 | } |
| 187 | |
| 188 | |
| 189 | /* Exported functions */ |
| 190 | |
| 191 | /* Register the semi-hosting driver with the IO abstraction */ |
Dan Handley | 625de1d | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 192 | int register_io_dev_sh(const io_dev_connector_t **dev_con) |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 193 | { |
Juan Castillo | e098e24 | 2015-11-02 10:47:01 +0000 | [diff] [blame] | 194 | int result; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 195 | assert(dev_con != NULL); |
| 196 | |
| 197 | result = io_register_device(&sh_dev_info); |
Juan Castillo | e098e24 | 2015-11-02 10:47:01 +0000 | [diff] [blame] | 198 | if (result == 0) |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 199 | *dev_con = &sh_dev_connector; |
| 200 | |
| 201 | return result; |
| 202 | } |