blob: d45107e516a83f1c263a85f333869fdb97921919 [file] [log] [blame]
Harry Liebel561cd332014-02-14 14:42:48 +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 <debug.h>
Dan Handley2bd4ef22014-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 Handleya4cb68e2014-04-23 13:47:06 +010045 int in_use;
46 uintptr_t base;
47 size_t file_pos;
Dan Handleye2712bc2014-04-10 15:37:22 +010048} file_state_t;
Harry Liebel561cd332014-02-14 14:42:48 +000049
Dan Handleye2712bc2014-04-10 15:37:22 +010050static file_state_t current_file = {0};
Harry Liebel561cd332014-02-14 14:42:48 +000051
52/* Identify the device type as memmap */
Dan Handleye2712bc2014-04-10 15:37:22 +010053io_type_t device_type_memmap(void)
Harry Liebel561cd332014-02-14 14:42:48 +000054{
55 return IO_TYPE_MEMMAP;
56}
57
58/* Memmap device functions */
Dan Handleya4cb68e2014-04-23 13:47:06 +010059static int memmap_dev_open(const uintptr_t dev_spec, io_dev_info_t **dev_info);
60static int memmap_block_open(io_dev_info_t *dev_info, const uintptr_t spec,
Dan Handleye2712bc2014-04-10 15:37:22 +010061 io_entity_t *entity);
62static int memmap_block_seek(io_entity_t *entity, int mode,
Harry Liebel561cd332014-02-14 14:42:48 +000063 ssize_t offset);
Dan Handleya4cb68e2014-04-23 13:47:06 +010064static int memmap_block_read(io_entity_t *entity, uintptr_t buffer,
Harry Liebel561cd332014-02-14 14:42:48 +000065 size_t length, size_t *length_read);
Dan Handleya4cb68e2014-04-23 13:47:06 +010066static int memmap_block_write(io_entity_t *entity, const uintptr_t buffer,
Harry Liebel561cd332014-02-14 14:42:48 +000067 size_t length, size_t *length_written);
Dan Handleye2712bc2014-04-10 15:37:22 +010068static int memmap_block_close(io_entity_t *entity);
69static int memmap_dev_close(io_dev_info_t *dev_info);
Harry Liebel561cd332014-02-14 14:42:48 +000070
71
Dan Handleya4cb68e2014-04-23 13:47:06 +010072static const io_dev_connector_t memmap_dev_connector = {
Harry Liebel561cd332014-02-14 14:42:48 +000073 .dev_open = memmap_dev_open
74};
75
76
Dan Handleya4cb68e2014-04-23 13:47:06 +010077static const io_dev_funcs_t memmap_dev_funcs = {
Harry Liebel561cd332014-02-14 14:42:48 +000078 .type = device_type_memmap,
79 .open = memmap_block_open,
80 .seek = memmap_block_seek,
81 .size = NULL,
82 .read = memmap_block_read,
83 .write = memmap_block_write,
84 .close = memmap_block_close,
85 .dev_init = NULL,
86 .dev_close = memmap_dev_close,
87};
88
89
Dan Handleya4cb68e2014-04-23 13:47:06 +010090/* No state associated with this device so structure can be const */
91static const io_dev_info_t memmap_dev_info = {
Harry Liebel561cd332014-02-14 14:42:48 +000092 .funcs = &memmap_dev_funcs,
93 .info = (uintptr_t)NULL
94};
95
96
97/* Open a connection to the memmap device */
Dan Handleya4cb68e2014-04-23 13:47:06 +010098static int memmap_dev_open(const uintptr_t dev_spec __attribute__((unused)),
Dan Handleye2712bc2014-04-10 15:37:22 +010099 io_dev_info_t **dev_info)
Harry Liebel561cd332014-02-14 14:42:48 +0000100{
101 assert(dev_info != NULL);
Dan Handleya4cb68e2014-04-23 13:47:06 +0100102 *dev_info = (io_dev_info_t *)&memmap_dev_info; /* cast away const */
Harry Liebel561cd332014-02-14 14:42:48 +0000103
Juan Castillo6e762062015-11-02 10:47:01 +0000104 return 0;
Harry Liebel561cd332014-02-14 14:42:48 +0000105}
106
107
108
109/* Close a connection to the memmap device */
Dan Handleye2712bc2014-04-10 15:37:22 +0100110static int memmap_dev_close(io_dev_info_t *dev_info)
Harry Liebel561cd332014-02-14 14:42:48 +0000111{
112 /* NOP */
113 /* TODO: Consider tracking open files and cleaning them up here */
Juan Castillo6e762062015-11-02 10:47:01 +0000114 return 0;
Harry Liebel561cd332014-02-14 14:42:48 +0000115}
116
117
118/* Open a file on the memmap device */
119/* TODO: Can we do any sensible limit checks on requested memory */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100120static int memmap_block_open(io_dev_info_t *dev_info, const uintptr_t spec,
Dan Handleye2712bc2014-04-10 15:37:22 +0100121 io_entity_t *entity)
Harry Liebel561cd332014-02-14 14:42:48 +0000122{
Juan Castillo6e762062015-11-02 10:47:01 +0000123 int result = -ENOMEM;
Dan Handleye2712bc2014-04-10 15:37:22 +0100124 const io_block_spec_t *block_spec = (io_block_spec_t *)spec;
Harry Liebel561cd332014-02-14 14:42:48 +0000125
126 /* Since we need to track open state for seek() we only allow one open
127 * spec at a time. When we have dynamic memory we can malloc and set
128 * entity->info.
129 */
130 if (current_file.in_use == 0) {
131 assert(block_spec != NULL);
132 assert(entity != NULL);
133
134 current_file.in_use = 1;
135 current_file.base = block_spec->offset;
136 /* File cursor offset for seek and incremental reads etc. */
137 current_file.file_pos = 0;
138 entity->info = (uintptr_t)&current_file;
Juan Castillo6e762062015-11-02 10:47:01 +0000139 result = 0;
Harry Liebel561cd332014-02-14 14:42:48 +0000140 } else {
Jeenu Viswambharan08c28d52014-02-20 12:03:31 +0000141 WARN("A Memmap device is already active. Close first.\n");
Harry Liebel561cd332014-02-14 14:42:48 +0000142 }
143
144 return result;
145}
146
147
148/* Seek to a particular file offset on the memmap device */
Dan Handleye2712bc2014-04-10 15:37:22 +0100149static int memmap_block_seek(io_entity_t *entity, int mode, ssize_t offset)
Harry Liebel561cd332014-02-14 14:42:48 +0000150{
Juan Castillo6e762062015-11-02 10:47:01 +0000151 int result = -ENOENT;
Harry Liebel561cd332014-02-14 14:42:48 +0000152
153 /* We only support IO_SEEK_SET for the moment. */
154 if (mode == IO_SEEK_SET) {
155 assert(entity != NULL);
156
157 /* TODO: can we do some basic limit checks on seek? */
Dan Handleye2712bc2014-04-10 15:37:22 +0100158 ((file_state_t *)entity->info)->file_pos = offset;
Juan Castillo6e762062015-11-02 10:47:01 +0000159 result = 0;
Harry Liebel561cd332014-02-14 14:42:48 +0000160 }
161
162 return result;
163}
164
165
166/* Read data from a file on the memmap device */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100167static int memmap_block_read(io_entity_t *entity, uintptr_t buffer,
Harry Liebel561cd332014-02-14 14:42:48 +0000168 size_t length, size_t *length_read)
169{
Dan Handleye2712bc2014-04-10 15:37:22 +0100170 file_state_t *fp;
Harry Liebel561cd332014-02-14 14:42:48 +0000171
172 assert(entity != NULL);
Dan Handleya4cb68e2014-04-23 13:47:06 +0100173 assert(buffer != (uintptr_t)NULL);
Harry Liebel561cd332014-02-14 14:42:48 +0000174 assert(length_read != NULL);
175
Dan Handleye2712bc2014-04-10 15:37:22 +0100176 fp = (file_state_t *)entity->info;
Harry Liebel561cd332014-02-14 14:42:48 +0000177
Dan Handleya4cb68e2014-04-23 13:47:06 +0100178 memcpy((void *)buffer, (void *)(fp->base + fp->file_pos), length);
Harry Liebel561cd332014-02-14 14:42:48 +0000179
180 *length_read = length;
181 /* advance the file 'cursor' for incremental reads */
182 fp->file_pos += length;
183
Juan Castillo6e762062015-11-02 10:47:01 +0000184 return 0;
Harry Liebel561cd332014-02-14 14:42:48 +0000185}
186
187
188/* Write data to a file on the memmap device */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100189static int memmap_block_write(io_entity_t *entity, const uintptr_t buffer,
Harry Liebel561cd332014-02-14 14:42:48 +0000190 size_t length, size_t *length_written)
191{
Dan Handleye2712bc2014-04-10 15:37:22 +0100192 file_state_t *fp;
Harry Liebel561cd332014-02-14 14:42:48 +0000193
194 assert(entity != NULL);
Dan Handleya4cb68e2014-04-23 13:47:06 +0100195 assert(buffer != (uintptr_t)NULL);
Harry Liebel561cd332014-02-14 14:42:48 +0000196 assert(length_written != NULL);
197
Dan Handleye2712bc2014-04-10 15:37:22 +0100198 fp = (file_state_t *)entity->info;
Harry Liebel561cd332014-02-14 14:42:48 +0000199
Dan Handleya4cb68e2014-04-23 13:47:06 +0100200 memcpy((void *)(fp->base + fp->file_pos), (void *)buffer, length);
Harry Liebel561cd332014-02-14 14:42:48 +0000201
202 *length_written = length;
203
204 /* advance the file 'cursor' for incremental writes */
205 fp->file_pos += length;
206
Juan Castillo6e762062015-11-02 10:47:01 +0000207 return 0;
Harry Liebel561cd332014-02-14 14:42:48 +0000208}
209
210
211/* Close a file on the memmap device */
Dan Handleye2712bc2014-04-10 15:37:22 +0100212static int memmap_block_close(io_entity_t *entity)
Harry Liebel561cd332014-02-14 14:42:48 +0000213{
214 assert(entity != NULL);
215
216 entity->info = 0;
217
218 /* This would be a mem free() if we had malloc.*/
219 memset((void *)&current_file, 0, sizeof(current_file));
220
Juan Castillo6e762062015-11-02 10:47:01 +0000221 return 0;
Harry Liebel561cd332014-02-14 14:42:48 +0000222}
223
224
225/* Exported functions */
226
227/* Register the memmap driver with the IO abstraction */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100228int register_io_dev_memmap(const io_dev_connector_t **dev_con)
Harry Liebel561cd332014-02-14 14:42:48 +0000229{
Juan Castillo6e762062015-11-02 10:47:01 +0000230 int result;
Harry Liebel561cd332014-02-14 14:42:48 +0000231 assert(dev_con != NULL);
232
233 result = io_register_device(&memmap_dev_info);
Juan Castillo6e762062015-11-02 10:47:01 +0000234 if (result == 0)
Harry Liebel561cd332014-02-14 14:42:48 +0000235 *dev_con = &memmap_dev_connector;
236
237 return result;
238}