blob: 90b8e2573c345805d86c0e3cbd8728ccf97e38b1 [file] [log] [blame]
Harry Liebel561cd332014-02-14 14:42:48 +00001/*
Jeenu Viswambharan69c043b2017-02-13 13:06:18 +00002 * Copyright (c) 2014-2017, ARM Limited and Contributors. All rights reserved.
Harry Liebel561cd332014-02-14 14:42:48 +00003 *
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 Handley35e98e52014-04-09 13:13:04 +010032#include <debug.h>
Dan Handley97043ac2014-04-09 13:14:54 +010033#include <io_driver.h>
34#include <io_storage.h>
35#include <string.h>
Harry Liebel561cd332014-02-14 14:42:48 +000036
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 */
41typedef struct {
42 /* Use the 'in_use' flag as any value for base and file_pos could be
43 * valid.
44 */
Dan Handley625de1d2014-04-23 13:47:06 +010045 int in_use;
46 uintptr_t base;
47 size_t file_pos;
Gerald Lejeune6d70bfa2015-03-18 14:41:42 +010048 size_t size;
Dan Handleyfb037bf2014-04-10 15:37:22 +010049} file_state_t;
Harry Liebel561cd332014-02-14 14:42:48 +000050
Dan Handleyfb037bf2014-04-10 15:37:22 +010051static file_state_t current_file = {0};
Harry Liebel561cd332014-02-14 14:42:48 +000052
53/* Identify the device type as memmap */
Dan Handleyfb037bf2014-04-10 15:37:22 +010054io_type_t device_type_memmap(void)
Harry Liebel561cd332014-02-14 14:42:48 +000055{
56 return IO_TYPE_MEMMAP;
57}
58
59/* Memmap device functions */
Dan Handley625de1d2014-04-23 13:47:06 +010060static int memmap_dev_open(const uintptr_t dev_spec, io_dev_info_t **dev_info);
61static int memmap_block_open(io_dev_info_t *dev_info, const uintptr_t spec,
Dan Handleyfb037bf2014-04-10 15:37:22 +010062 io_entity_t *entity);
63static int memmap_block_seek(io_entity_t *entity, int mode,
Harry Liebel561cd332014-02-14 14:42:48 +000064 ssize_t offset);
Gerald Lejeune6d70bfa2015-03-18 14:41:42 +010065static int memmap_block_len(io_entity_t *entity, size_t *length);
Dan Handley625de1d2014-04-23 13:47:06 +010066static int memmap_block_read(io_entity_t *entity, uintptr_t buffer,
Harry Liebel561cd332014-02-14 14:42:48 +000067 size_t length, size_t *length_read);
Dan Handley625de1d2014-04-23 13:47:06 +010068static int memmap_block_write(io_entity_t *entity, const uintptr_t buffer,
Harry Liebel561cd332014-02-14 14:42:48 +000069 size_t length, size_t *length_written);
Dan Handleyfb037bf2014-04-10 15:37:22 +010070static int memmap_block_close(io_entity_t *entity);
71static int memmap_dev_close(io_dev_info_t *dev_info);
Harry Liebel561cd332014-02-14 14:42:48 +000072
73
Dan Handley625de1d2014-04-23 13:47:06 +010074static const io_dev_connector_t memmap_dev_connector = {
Harry Liebel561cd332014-02-14 14:42:48 +000075 .dev_open = memmap_dev_open
76};
77
78
Dan Handley625de1d2014-04-23 13:47:06 +010079static const io_dev_funcs_t memmap_dev_funcs = {
Harry Liebel561cd332014-02-14 14:42:48 +000080 .type = device_type_memmap,
81 .open = memmap_block_open,
82 .seek = memmap_block_seek,
Gerald Lejeune6d70bfa2015-03-18 14:41:42 +010083 .size = memmap_block_len,
Harry Liebel561cd332014-02-14 14:42:48 +000084 .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
Dan Handley625de1d2014-04-23 13:47:06 +010092/* No state associated with this device so structure can be const */
93static const io_dev_info_t memmap_dev_info = {
Harry Liebel561cd332014-02-14 14:42:48 +000094 .funcs = &memmap_dev_funcs,
95 .info = (uintptr_t)NULL
96};
97
98
99/* Open a connection to the memmap device */
Soren Brinkmann65cd2992016-01-14 10:11:05 -0800100static int memmap_dev_open(const uintptr_t dev_spec __unused,
Dan Handleyfb037bf2014-04-10 15:37:22 +0100101 io_dev_info_t **dev_info)
Harry Liebel561cd332014-02-14 14:42:48 +0000102{
103 assert(dev_info != NULL);
Dan Handley625de1d2014-04-23 13:47:06 +0100104 *dev_info = (io_dev_info_t *)&memmap_dev_info; /* cast away const */
Harry Liebel561cd332014-02-14 14:42:48 +0000105
Juan Castilloe098e242015-11-02 10:47:01 +0000106 return 0;
Harry Liebel561cd332014-02-14 14:42:48 +0000107}
108
109
110
111/* Close a connection to the memmap device */
Dan Handleyfb037bf2014-04-10 15:37:22 +0100112static int memmap_dev_close(io_dev_info_t *dev_info)
Harry Liebel561cd332014-02-14 14:42:48 +0000113{
114 /* NOP */
115 /* TODO: Consider tracking open files and cleaning them up here */
Juan Castilloe098e242015-11-02 10:47:01 +0000116 return 0;
Harry Liebel561cd332014-02-14 14:42:48 +0000117}
118
119
120/* Open a file on the memmap device */
Dan Handley625de1d2014-04-23 13:47:06 +0100121static int memmap_block_open(io_dev_info_t *dev_info, const uintptr_t spec,
Dan Handleyfb037bf2014-04-10 15:37:22 +0100122 io_entity_t *entity)
Harry Liebel561cd332014-02-14 14:42:48 +0000123{
Juan Castilloe098e242015-11-02 10:47:01 +0000124 int result = -ENOMEM;
Dan Handleyfb037bf2014-04-10 15:37:22 +0100125 const io_block_spec_t *block_spec = (io_block_spec_t *)spec;
Harry Liebel561cd332014-02-14 14:42:48 +0000126
Jeenu Viswambharan69c043b2017-02-13 13:06:18 +0000127 assert(block_spec->length >= 0);
128
Harry Liebel561cd332014-02-14 14:42:48 +0000129 /* 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;
Gerald Lejeune6d70bfa2015-03-18 14:41:42 +0100141 current_file.size = block_spec->length;
Harry Liebel561cd332014-02-14 14:42:48 +0000142 entity->info = (uintptr_t)&current_file;
Juan Castilloe098e242015-11-02 10:47:01 +0000143 result = 0;
Harry Liebel561cd332014-02-14 14:42:48 +0000144 } else {
Jeenu Viswambharan08c28d52014-02-20 12:03:31 +0000145 WARN("A Memmap device is already active. Close first.\n");
Harry Liebel561cd332014-02-14 14:42:48 +0000146 }
147
148 return result;
149}
150
151
152/* Seek to a particular file offset on the memmap device */
Dan Handleyfb037bf2014-04-10 15:37:22 +0100153static int memmap_block_seek(io_entity_t *entity, int mode, ssize_t offset)
Harry Liebel561cd332014-02-14 14:42:48 +0000154{
Juan Castilloe098e242015-11-02 10:47:01 +0000155 int result = -ENOENT;
Jeenu Viswambharan69c043b2017-02-13 13:06:18 +0000156 file_state_t *fp;
Harry Liebel561cd332014-02-14 14:42:48 +0000157
158 /* We only support IO_SEEK_SET for the moment. */
159 if (mode == IO_SEEK_SET) {
160 assert(entity != NULL);
161
Jeenu Viswambharan69c043b2017-02-13 13:06:18 +0000162 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;
Juan Castilloe098e242015-11-02 10:47:01 +0000169 result = 0;
Harry Liebel561cd332014-02-14 14:42:48 +0000170 }
171
172 return result;
173}
174
175
Gerald Lejeune6d70bfa2015-03-18 14:41:42 +0100176/* Return the size of a file on the memmap device */
177static 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
Harry Liebel561cd332014-02-14 14:42:48 +0000188/* Read data from a file on the memmap device */
Dan Handley625de1d2014-04-23 13:47:06 +0100189static int memmap_block_read(io_entity_t *entity, uintptr_t buffer,
Harry Liebel561cd332014-02-14 14:42:48 +0000190 size_t length, size_t *length_read)
191{
Dan Handleyfb037bf2014-04-10 15:37:22 +0100192 file_state_t *fp;
Jeenu Viswambharan69c043b2017-02-13 13:06:18 +0000193 size_t pos_after;
Harry Liebel561cd332014-02-14 14:42:48 +0000194
195 assert(entity != NULL);
Dan Handley625de1d2014-04-23 13:47:06 +0100196 assert(buffer != (uintptr_t)NULL);
Harry Liebel561cd332014-02-14 14:42:48 +0000197 assert(length_read != NULL);
198
Jeenu Viswambharan69c043b2017-02-13 13:06:18 +0000199 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));
Harry Liebel561cd332014-02-14 14:42:48 +0000204
Dan Handley625de1d2014-04-23 13:47:06 +0100205 memcpy((void *)buffer, (void *)(fp->base + fp->file_pos), length);
Harry Liebel561cd332014-02-14 14:42:48 +0000206
207 *length_read = length;
Jeenu Viswambharan69c043b2017-02-13 13:06:18 +0000208
209 /* Set file position after read */
210 fp->file_pos = pos_after;
Harry Liebel561cd332014-02-14 14:42:48 +0000211
Juan Castilloe098e242015-11-02 10:47:01 +0000212 return 0;
Harry Liebel561cd332014-02-14 14:42:48 +0000213}
214
215
216/* Write data to a file on the memmap device */
Dan Handley625de1d2014-04-23 13:47:06 +0100217static int memmap_block_write(io_entity_t *entity, const uintptr_t buffer,
Harry Liebel561cd332014-02-14 14:42:48 +0000218 size_t length, size_t *length_written)
219{
Dan Handleyfb037bf2014-04-10 15:37:22 +0100220 file_state_t *fp;
Jeenu Viswambharan69c043b2017-02-13 13:06:18 +0000221 size_t pos_after;
Harry Liebel561cd332014-02-14 14:42:48 +0000222
223 assert(entity != NULL);
Dan Handley625de1d2014-04-23 13:47:06 +0100224 assert(buffer != (uintptr_t)NULL);
Harry Liebel561cd332014-02-14 14:42:48 +0000225 assert(length_written != NULL);
226
Jeenu Viswambharan69c043b2017-02-13 13:06:18 +0000227 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));
Harry Liebel561cd332014-02-14 14:42:48 +0000232
Dan Handley625de1d2014-04-23 13:47:06 +0100233 memcpy((void *)(fp->base + fp->file_pos), (void *)buffer, length);
Harry Liebel561cd332014-02-14 14:42:48 +0000234
235 *length_written = length;
236
Jeenu Viswambharan69c043b2017-02-13 13:06:18 +0000237 /* Set file position after write */
238 fp->file_pos = pos_after;
Harry Liebel561cd332014-02-14 14:42:48 +0000239
Juan Castilloe098e242015-11-02 10:47:01 +0000240 return 0;
Harry Liebel561cd332014-02-14 14:42:48 +0000241}
242
243
244/* Close a file on the memmap device */
Dan Handleyfb037bf2014-04-10 15:37:22 +0100245static int memmap_block_close(io_entity_t *entity)
Harry Liebel561cd332014-02-14 14:42:48 +0000246{
247 assert(entity != NULL);
248
249 entity->info = 0;
250
251 /* This would be a mem free() if we had malloc.*/
252 memset((void *)&current_file, 0, sizeof(current_file));
253
Juan Castilloe098e242015-11-02 10:47:01 +0000254 return 0;
Harry Liebel561cd332014-02-14 14:42:48 +0000255}
256
257
258/* Exported functions */
259
260/* Register the memmap driver with the IO abstraction */
Dan Handley625de1d2014-04-23 13:47:06 +0100261int register_io_dev_memmap(const io_dev_connector_t **dev_con)
Harry Liebel561cd332014-02-14 14:42:48 +0000262{
Juan Castilloe098e242015-11-02 10:47:01 +0000263 int result;
Harry Liebel561cd332014-02-14 14:42:48 +0000264 assert(dev_con != NULL);
265
266 result = io_register_device(&memmap_dev_info);
Juan Castilloe098e242015-11-02 10:47:01 +0000267 if (result == 0)
Harry Liebel561cd332014-02-14 14:42:48 +0000268 *dev_con = &memmap_dev_connector;
269
270 return result;
271}