| James Morrissey | f2f9bb5 | 2014-02-10 16:18:59 +0000 | [diff] [blame] | 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_DRIVER_H__ |
| 32 | #define __IO_DRIVER_H__ |
| 33 | |
| 34 | #include "platform.h" /* For MAX_IO_DEVICES */ |
| 35 | |
| 36 | |
| 37 | /* Generic IO entity structure,representing an accessible IO construct on the |
| 38 | * device, such as a file */ |
| 39 | struct io_entity { |
| 40 | io_dev_handle dev_handle; |
| 41 | uintptr_t info; |
| 42 | }; |
| 43 | |
| 44 | |
| 45 | /* Device info structure, providing device-specific functions and a means of |
| 46 | * adding driver-specific state */ |
| 47 | struct io_dev_info { |
| 48 | struct io_dev_funcs *funcs; |
| 49 | uintptr_t info; |
| 50 | }; |
| 51 | |
| 52 | |
| 53 | /* Structure used to create a connection to a type of device */ |
| 54 | struct io_dev_connector { |
| 55 | /* dev_open opens a connection to a particular device driver */ |
| 56 | int (*dev_open)(void *spec, struct io_dev_info **dev_info); |
| 57 | }; |
| 58 | |
| 59 | |
| 60 | /* Structure to hold device driver function pointers */ |
| 61 | struct io_dev_funcs { |
| 62 | io_type (*type)(void); |
| 63 | int (*open)(struct io_dev_info *dev_info, const void *spec, |
| 64 | struct io_entity *entity); |
| 65 | int (*seek)(struct io_entity *entity, int mode, ssize_t offset); |
| 66 | int (*size)(struct io_entity *entity, size_t *length); |
| 67 | int (*read)(struct io_entity *entity, void *buffer, size_t length, |
| 68 | size_t *length_read); |
| 69 | int (*write)(struct io_entity *entity, const void *buffer, |
| 70 | size_t length, size_t *length_written); |
| 71 | int (*close)(struct io_entity *entity); |
| 72 | int (*dev_init)(struct io_dev_info *dev_info, const void *init_params); |
| 73 | int (*dev_close)(struct io_dev_info *dev_info); |
| 74 | }; |
| 75 | |
| 76 | |
| 77 | /* IO platform data - used to track devices registered for a specific |
| 78 | * platform */ |
| 79 | struct io_plat_data { |
| 80 | struct io_dev_info *devices[MAX_IO_DEVICES]; |
| 81 | unsigned int dev_count; |
| 82 | }; |
| 83 | |
| 84 | |
| 85 | /* Operations intended to be performed during platform initialisation */ |
| 86 | |
| 87 | /* Initialise the IO layer */ |
| 88 | void io_init(struct io_plat_data *data); |
| 89 | |
| 90 | /* Register a device driver */ |
| 91 | int io_register_device(struct io_dev_info *dev_info); |
| 92 | |
| 93 | #endif /* __IO_DRIVER_H__ */ |