1 /* 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 #ifndef __IO_H__ 32 #define __IO_H__ 33 34 #include <stdint.h> 35 #include <stdio.h> /* For ssize_t */ 36 37 38 /* Device type which can be used to enable policy decisions about which device 39 * to access */ 40 typedef enum { 41 IO_TYPE_INVALID, 42 IO_TYPE_SEMIHOSTING, 43 IO_TYPE_MEMMAP, 44 IO_TYPE_FIRMWARE_IMAGE_PACKAGE, 45 IO_TYPE_MAX 46 } io_type_t; 47 48 49 /* Modes used when seeking data on a supported device */ 50 typedef enum { 51 IO_SEEK_INVALID, 52 IO_SEEK_SET, 53 IO_SEEK_END, 54 IO_SEEK_CUR, 55 IO_SEEK_MAX 56 } io_seek_mode_t; 57 58 59 /* Connector type, providing a means of identifying a device to open */ 60 struct io_dev_connector; 61 62 63 /* File specification - used to refer to data on a device supporting file-like 64 * entities */ 65 typedef struct io_file_spec { 66 const char *path; 67 unsigned int mode; 68 } io_file_spec_t; 69 70 71 /* Block specification - used to refer to data on a device supporting 72 * block-like entities */ 73 typedef struct io_block_spec { 74 size_t offset; 75 size_t length; 76 } io_block_spec_t; 77 78 79 /* Access modes used when accessing data on a device */ 80 #define IO_MODE_INVALID (0) 81 #define IO_MODE_RO (1 << 0) 82 #define IO_MODE_RW (1 << 1) 83 84 85 /* Return codes reported by 'io_*' APIs */ 86 #define IO_SUCCESS (0) 87 #define IO_FAIL (-1) 88 #define IO_NOT_SUPPORTED (-2) 89 #define IO_RESOURCES_EXHAUSTED (-3) 90 91 92 /* Open a connection to a device */ 93 int io_dev_open(const struct io_dev_connector *dev_con, 94 const uintptr_t dev_spec, 95 uintptr_t *dev_handle); 96 97 98 /* Initialise a device explicitly - to permit lazy initialisation or 99 * re-initialisation */ 100 int io_dev_init(uintptr_t dev_handle, const uintptr_t init_params); 101 102 /* TODO: Consider whether an explicit "shutdown" API should be included */ 103 104 /* Close a connection to a device */ 105 int io_dev_close(uintptr_t dev_handle); 106 107 108 /* Synchronous operations */ 109 int io_open(uintptr_t dev_handle, const uintptr_t spec, uintptr_t *handle); 110 111 int io_seek(uintptr_t handle, io_seek_mode_t mode, ssize_t offset); 112 113 int io_size(uintptr_t handle, size_t *length); 114 115 int io_read(uintptr_t handle, uintptr_t buffer, size_t length, 116 size_t *length_read); 117 118 int io_write(uintptr_t handle, const uintptr_t buffer, size_t length, 119 size_t *length_written); 120 121 int io_close(uintptr_t handle); 122 123 124 #endif /* __IO_H__ */ 125