blob: cade5e706991bfc942f804cb24db6b61e2706d16 [file] [log] [blame]
James Morrisseyf2f9bb52014-02-10 16:18:59 +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#ifndef __IO_DRIVER_H__
32#define __IO_DRIVER_H__
33
Dan Handley35e98e52014-04-09 13:13:04 +010034#include <platform.h> /* For MAX_IO_DEVICES */
James Morrisseyf2f9bb52014-02-10 16:18:59 +000035
36
37/* Generic IO entity structure,representing an accessible IO construct on the
38 * device, such as a file */
Dan Handleyfb037bf2014-04-10 15:37:22 +010039typedef struct io_entity {
James Morrisseyf2f9bb52014-02-10 16:18:59 +000040 io_dev_handle dev_handle;
41 uintptr_t info;
Dan Handleyfb037bf2014-04-10 15:37:22 +010042} io_entity_t;
James Morrisseyf2f9bb52014-02-10 16:18:59 +000043
44
45/* Device info structure, providing device-specific functions and a means of
46 * adding driver-specific state */
Dan Handleyfb037bf2014-04-10 15:37:22 +010047typedef struct io_dev_info {
James Morrisseyf2f9bb52014-02-10 16:18:59 +000048 struct io_dev_funcs *funcs;
49 uintptr_t info;
Dan Handleyfb037bf2014-04-10 15:37:22 +010050} io_dev_info_t;
James Morrisseyf2f9bb52014-02-10 16:18:59 +000051
52
53/* Structure used to create a connection to a type of device */
Dan Handleyfb037bf2014-04-10 15:37:22 +010054typedef struct io_dev_connector {
James Morrisseyf2f9bb52014-02-10 16:18:59 +000055 /* dev_open opens a connection to a particular device driver */
Dan Handleyfb037bf2014-04-10 15:37:22 +010056 int (*dev_open)(void *spec, io_dev_info_t **dev_info);
57} io_dev_connector_t;
James Morrisseyf2f9bb52014-02-10 16:18:59 +000058
59
60/* Structure to hold device driver function pointers */
Dan Handleyfb037bf2014-04-10 15:37:22 +010061typedef struct io_dev_funcs {
62 io_type_t (*type)(void);
63 int (*open)(io_dev_info_t *dev_info, const void *spec,
64 io_entity_t *entity);
65 int (*seek)(io_entity_t *entity, int mode, ssize_t offset);
66 int (*size)(io_entity_t *entity, size_t *length);
67 int (*read)(io_entity_t *entity, void *buffer, size_t length,
James Morrisseyf2f9bb52014-02-10 16:18:59 +000068 size_t *length_read);
Dan Handleyfb037bf2014-04-10 15:37:22 +010069 int (*write)(io_entity_t *entity, const void *buffer,
James Morrisseyf2f9bb52014-02-10 16:18:59 +000070 size_t length, size_t *length_written);
Dan Handleyfb037bf2014-04-10 15:37:22 +010071 int (*close)(io_entity_t *entity);
72 int (*dev_init)(io_dev_info_t *dev_info, const void *init_params);
73 int (*dev_close)(io_dev_info_t *dev_info);
74} io_dev_funcs_t;
James Morrisseyf2f9bb52014-02-10 16:18:59 +000075
76
77/* IO platform data - used to track devices registered for a specific
78 * platform */
Dan Handleyfb037bf2014-04-10 15:37:22 +010079typedef struct io_plat_data {
80 io_dev_info_t *devices[MAX_IO_DEVICES];
James Morrisseyf2f9bb52014-02-10 16:18:59 +000081 unsigned int dev_count;
Dan Handleyfb037bf2014-04-10 15:37:22 +010082} io_plat_data_t;
James Morrisseyf2f9bb52014-02-10 16:18:59 +000083
84
85/* Operations intended to be performed during platform initialisation */
86
87/* Initialise the IO layer */
Dan Handleyfb037bf2014-04-10 15:37:22 +010088void io_init(io_plat_data_t *data);
James Morrisseyf2f9bb52014-02-10 16:18:59 +000089
90/* Register a device driver */
Dan Handleyfb037bf2014-04-10 15:37:22 +010091int io_register_device(io_dev_info_t *dev_info);
James Morrisseyf2f9bb52014-02-10 16:18:59 +000092
93#endif /* __IO_DRIVER_H__ */