blob: 867abbfa32c06728bfa1ec90d4082701f7e3ac12 [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 Handley2bd4ef22014-04-09 13:14:54 +010034#include <io_storage.h>
Dan Handleyed6ff952014-05-14 17:44:19 +010035#include <platform_def.h> /* For MAX_IO_DEVICES */
Dan Handley2bd4ef22014-04-09 13:14:54 +010036#include <stdint.h>
James Morrisseyf2f9bb52014-02-10 16:18:59 +000037
38
39/* Generic IO entity structure,representing an accessible IO construct on the
40 * device, such as a file */
Dan Handleye2712bc2014-04-10 15:37:22 +010041typedef struct io_entity {
Dan Handleya4cb68e2014-04-23 13:47:06 +010042 struct io_dev_info *dev_handle;
James Morrisseyf2f9bb52014-02-10 16:18:59 +000043 uintptr_t info;
Dan Handleye2712bc2014-04-10 15:37:22 +010044} io_entity_t;
James Morrisseyf2f9bb52014-02-10 16:18:59 +000045
46
47/* Device info structure, providing device-specific functions and a means of
48 * adding driver-specific state */
Dan Handleye2712bc2014-04-10 15:37:22 +010049typedef struct io_dev_info {
Dan Handleya4cb68e2014-04-23 13:47:06 +010050 const struct io_dev_funcs *funcs;
James Morrisseyf2f9bb52014-02-10 16:18:59 +000051 uintptr_t info;
Dan Handleye2712bc2014-04-10 15:37:22 +010052} io_dev_info_t;
James Morrisseyf2f9bb52014-02-10 16:18:59 +000053
54
55/* Structure used to create a connection to a type of device */
Dan Handleye2712bc2014-04-10 15:37:22 +010056typedef struct io_dev_connector {
James Morrisseyf2f9bb52014-02-10 16:18:59 +000057 /* dev_open opens a connection to a particular device driver */
Dan Handleya4cb68e2014-04-23 13:47:06 +010058 int (*dev_open)(const uintptr_t dev_spec, io_dev_info_t **dev_info);
Dan Handleye2712bc2014-04-10 15:37:22 +010059} io_dev_connector_t;
James Morrisseyf2f9bb52014-02-10 16:18:59 +000060
61
62/* Structure to hold device driver function pointers */
Dan Handleye2712bc2014-04-10 15:37:22 +010063typedef struct io_dev_funcs {
64 io_type_t (*type)(void);
Dan Handleya4cb68e2014-04-23 13:47:06 +010065 int (*open)(io_dev_info_t *dev_info, const uintptr_t spec,
Dan Handleye2712bc2014-04-10 15:37:22 +010066 io_entity_t *entity);
67 int (*seek)(io_entity_t *entity, int mode, ssize_t offset);
68 int (*size)(io_entity_t *entity, size_t *length);
Dan Handleya4cb68e2014-04-23 13:47:06 +010069 int (*read)(io_entity_t *entity, uintptr_t buffer, size_t length,
James Morrisseyf2f9bb52014-02-10 16:18:59 +000070 size_t *length_read);
Dan Handleya4cb68e2014-04-23 13:47:06 +010071 int (*write)(io_entity_t *entity, const uintptr_t buffer,
James Morrisseyf2f9bb52014-02-10 16:18:59 +000072 size_t length, size_t *length_written);
Dan Handleye2712bc2014-04-10 15:37:22 +010073 int (*close)(io_entity_t *entity);
Dan Handleya4cb68e2014-04-23 13:47:06 +010074 int (*dev_init)(io_dev_info_t *dev_info, const uintptr_t init_params);
Dan Handleye2712bc2014-04-10 15:37:22 +010075 int (*dev_close)(io_dev_info_t *dev_info);
76} io_dev_funcs_t;
James Morrisseyf2f9bb52014-02-10 16:18:59 +000077
78
79/* IO platform data - used to track devices registered for a specific
80 * platform */
Dan Handleye2712bc2014-04-10 15:37:22 +010081typedef struct io_plat_data {
Dan Handleya4cb68e2014-04-23 13:47:06 +010082 const io_dev_info_t *devices[MAX_IO_DEVICES];
James Morrisseyf2f9bb52014-02-10 16:18:59 +000083 unsigned int dev_count;
Dan Handleye2712bc2014-04-10 15:37:22 +010084} io_plat_data_t;
James Morrisseyf2f9bb52014-02-10 16:18:59 +000085
86
87/* Operations intended to be performed during platform initialisation */
88
89/* Initialise the IO layer */
Dan Handleye2712bc2014-04-10 15:37:22 +010090void io_init(io_plat_data_t *data);
James Morrisseyf2f9bb52014-02-10 16:18:59 +000091
92/* Register a device driver */
Dan Handleya4cb68e2014-04-23 13:47:06 +010093int io_register_device(const io_dev_info_t *dev_info);
James Morrisseyf2f9bb52014-02-10 16:18:59 +000094
95#endif /* __IO_DRIVER_H__ */