1 /* 2 * Copyright (c) 2014-2017, 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> 32 #include <debug.h> 33 #include <io_driver.h> 34 #include <io_storage.h> 35 #include <string.h> 36 37 /* As we need to be able to keep state for seek, only one file can be open 38 * at a time. Make this a structure and point to the entity->info. When we 39 * can malloc memory we can change this to support more open files. 40 */ 41 typedef struct { 42 /* Use the 'in_use' flag as any value for base and file_pos could be 43 * valid. 44 */ 45 int in_use; 46 uintptr_t base; 47 size_t file_pos; 48 size_t size; 49 } file_state_t; 50 51 static file_state_t current_file = {0}; 52 53 /* Identify the device type as memmap */ 54 io_type_t device_type_memmap(void) 55 { 56 return IO_TYPE_MEMMAP; 57 } 58 59 /* Memmap device functions */ 60 static int memmap_dev_open(const uintptr_t dev_spec, io_dev_info_t **dev_info); 61 static int memmap_block_open(io_dev_info_t *dev_info, const uintptr_t spec, 62 io_entity_t *entity); 63 static int memmap_block_seek(io_entity_t *entity, int mode, 64 ssize_t offset); 65 static int memmap_block_len(io_entity_t *entity, size_t *length); 66 static int memmap_block_read(io_entity_t *entity, uintptr_t buffer, 67 size_t length, size_t *length_read); 68 static int memmap_block_write(io_entity_t *entity, const uintptr_t buffer, 69 size_t length, size_t *length_written); 70 static int memmap_block_close(io_entity_t *entity); 71 static int memmap_dev_close(io_dev_info_t *dev_info); 72 73 74 static const io_dev_connector_t memmap_dev_connector = { 75 .dev_open = memmap_dev_open 76 }; 77 78 79 static const io_dev_funcs_t memmap_dev_funcs = { 80 .type = device_type_memmap, 81 .open = memmap_block_open, 82 .seek = memmap_block_seek, 83 .size = memmap_block_len, 84 .read = memmap_block_read, 85 .write = memmap_block_write, 86 .close = memmap_block_close, 87 .dev_init = NULL, 88 .dev_close = memmap_dev_close, 89 }; 90 91 92 /* No state associated with this device so structure can be const */ 93 static const io_dev_info_t memmap_dev_info = { 94 .funcs = &memmap_dev_funcs, 95 .info = (uintptr_t)NULL 96 }; 97 98 99 /* Open a connection to the memmap device */ 100 static int memmap_dev_open(const uintptr_t dev_spec __unused, 101 io_dev_info_t **dev_info) 102 { 103 assert(dev_info != NULL); 104 *dev_info = (io_dev_info_t *)&memmap_dev_info; /* cast away const */ 105 106 return 0; 107 } 108 109 110 111 /* Close a connection to the memmap device */ 112 static int memmap_dev_close(io_dev_info_t *dev_info) 113 { 114 /* NOP */ 115 /* TODO: Consider tracking open files and cleaning them up here */ 116 return 0; 117 } 118 119 120 /* Open a file on the memmap device */ 121 static int memmap_block_open(io_dev_info_t *dev_info, const uintptr_t spec, 122 io_entity_t *entity) 123 { 124 int result = -ENOMEM; 125 const io_block_spec_t *block_spec = (io_block_spec_t *)spec; 126 127 assert(block_spec->length >= 0); 128 129 /* Since we need to track open state for seek() we only allow one open 130 * spec at a time. When we have dynamic memory we can malloc and set 131 * entity->info. 132 */ 133 if (current_file.in_use == 0) { 134 assert(block_spec != NULL); 135 assert(entity != NULL); 136 137 current_file.in_use = 1; 138 current_file.base = block_spec->offset; 139 /* File cursor offset for seek and incremental reads etc. */ 140 current_file.file_pos = 0; 141 current_file.size = block_spec->length; 142 entity->info = (uintptr_t)¤t_file; 143 result = 0; 144 } else { 145 WARN("A Memmap device is already active. Close first.\n"); 146 } 147 148 return result; 149 } 150 151 152 /* Seek to a particular file offset on the memmap device */ 153 static int memmap_block_seek(io_entity_t *entity, int mode, ssize_t offset) 154 { 155 int result = -ENOENT; 156 file_state_t *fp; 157 158 /* We only support IO_SEEK_SET for the moment. */ 159 if (mode == IO_SEEK_SET) { 160 assert(entity != NULL); 161 162 fp = (file_state_t *) entity->info; 163 164 /* Assert that new file position is valid */ 165 assert((offset >= 0) && (offset < fp->size)); 166 167 /* Reset file position */ 168 fp->file_pos = offset; 169 result = 0; 170 } 171 172 return result; 173 } 174 175 176 /* Return the size of a file on the memmap device */ 177 static int memmap_block_len(io_entity_t *entity, size_t *length) 178 { 179 assert(entity != NULL); 180 assert(length != NULL); 181 182 *length = ((file_state_t *)entity->info)->size; 183 184 return 0; 185 } 186 187 188 /* Read data from a file on the memmap device */ 189 static int memmap_block_read(io_entity_t *entity, uintptr_t buffer, 190 size_t length, size_t *length_read) 191 { 192 file_state_t *fp; 193 size_t pos_after; 194 195 assert(entity != NULL); 196 assert(buffer != (uintptr_t)NULL); 197 assert(length_read != NULL); 198 199 fp = (file_state_t *) entity->info; 200 201 /* Assert that file position is valid for this read operation */ 202 pos_after = fp->file_pos + length; 203 assert((pos_after >= fp->file_pos) && (pos_after <= fp->size)); 204 205 memcpy((void *)buffer, (void *)(fp->base + fp->file_pos), length); 206 207 *length_read = length; 208 209 /* Set file position after read */ 210 fp->file_pos = pos_after; 211 212 return 0; 213 } 214 215 216 /* Write data to a file on the memmap device */ 217 static int memmap_block_write(io_entity_t *entity, const uintptr_t buffer, 218 size_t length, size_t *length_written) 219 { 220 file_state_t *fp; 221 size_t pos_after; 222 223 assert(entity != NULL); 224 assert(buffer != (uintptr_t)NULL); 225 assert(length_written != NULL); 226 227 fp = (file_state_t *) entity->info; 228 229 /* Assert that file position is valid for this write operation */ 230 pos_after = fp->file_pos + length; 231 assert((pos_after >= fp->file_pos) && (pos_after <= fp->size)); 232 233 memcpy((void *)(fp->base + fp->file_pos), (void *)buffer, length); 234 235 *length_written = length; 236 237 /* Set file position after write */ 238 fp->file_pos = pos_after; 239 240 return 0; 241 } 242 243 244 /* Close a file on the memmap device */ 245 static int memmap_block_close(io_entity_t *entity) 246 { 247 assert(entity != NULL); 248 249 entity->info = 0; 250 251 /* This would be a mem free() if we had malloc.*/ 252 memset((void *)¤t_file, 0, sizeof(current_file)); 253 254 return 0; 255 } 256 257 258 /* Exported functions */ 259 260 /* Register the memmap driver with the IO abstraction */ 261 int register_io_dev_memmap(const io_dev_connector_t **dev_con) 262 { 263 int result; 264 assert(dev_con != NULL); 265 266 result = io_register_device(&memmap_dev_info); 267 if (result == 0) 268 *dev_con = &memmap_dev_connector; 269 270 return result; 271 } 272