mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-09-15 02:31:19 +02:00
09d40e0e08
Enforce full include path for includes. Deprecate old paths.
The following folders inside include/lib have been left unchanged:
- include/lib/cpus/${ARCH}
- include/lib/el3_runtime/${ARCH}
The reason for this change is that having a global namespace for
includes isn't a good idea. It defeats one of the advantages of having
folders and it introduces problems that are sometimes subtle (because
you may not know the header you are actually including if there are two
of them).
For example, this patch had to be created because two headers were
called the same way: e0ea0928d5b7 ("Fix gpio includes of mt8173 platform
to avoid collision."). More recently, this patch has had similar
problems: 46f9b2c3a282 ("drivers: add tzc380 support").
This problem was introduced in commit 4ecca33988b9 ("Move include and
source files to logical locations"). At that time, there weren't too
many headers so it wasn't a real issue. However, time has shown that
this creates problems.
Platforms that want to preserve the way they include headers may add the
removed paths to PLAT_INCLUDES, but this is discouraged.
Change-Id: I39dc53ed98f9e297a5966e723d1936d6ccf2fc8f
Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com>
105 lines
2.4 KiB
C
105 lines
2.4 KiB
C
/*
|
|
* Copyright (c) 2014, ARM Limited and Contributors. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
|
|
#ifndef IO_STORAGE_H
|
|
#define IO_STORAGE_H
|
|
|
|
#include <errno.h>
|
|
#include <stdint.h>
|
|
#include <stdio.h> /* For ssize_t */
|
|
|
|
#include <tools_share/uuid.h>
|
|
|
|
/* Device type which can be used to enable policy decisions about which device
|
|
* to access */
|
|
typedef enum {
|
|
IO_TYPE_INVALID,
|
|
IO_TYPE_SEMIHOSTING,
|
|
IO_TYPE_MEMMAP,
|
|
IO_TYPE_DUMMY,
|
|
IO_TYPE_FIRMWARE_IMAGE_PACKAGE,
|
|
IO_TYPE_BLOCK,
|
|
IO_TYPE_MMC,
|
|
IO_TYPE_STM32IMAGE,
|
|
IO_TYPE_MAX
|
|
} io_type_t;
|
|
|
|
|
|
/* Modes used when seeking data on a supported device */
|
|
typedef enum {
|
|
IO_SEEK_INVALID,
|
|
IO_SEEK_SET,
|
|
IO_SEEK_END,
|
|
IO_SEEK_CUR,
|
|
IO_SEEK_MAX
|
|
} io_seek_mode_t;
|
|
|
|
|
|
/* Connector type, providing a means of identifying a device to open */
|
|
struct io_dev_connector;
|
|
|
|
|
|
/* File specification - used to refer to data on a device supporting file-like
|
|
* entities */
|
|
typedef struct io_file_spec {
|
|
const char *path;
|
|
unsigned int mode;
|
|
} io_file_spec_t;
|
|
|
|
/* UUID specification - used to refer to data accessed using UUIDs (i.e. FIP
|
|
* images) */
|
|
typedef struct io_uuid_spec {
|
|
const uuid_t uuid;
|
|
} io_uuid_spec_t;
|
|
|
|
/* Block specification - used to refer to data on a device supporting
|
|
* block-like entities */
|
|
typedef struct io_block_spec {
|
|
size_t offset;
|
|
size_t length;
|
|
} io_block_spec_t;
|
|
|
|
|
|
/* Access modes used when accessing data on a device */
|
|
#define IO_MODE_INVALID (0)
|
|
#define IO_MODE_RO (1 << 0)
|
|
#define IO_MODE_RW (1 << 1)
|
|
|
|
|
|
/* Open a connection to a device */
|
|
int io_dev_open(const struct io_dev_connector *dev_con,
|
|
const uintptr_t dev_spec,
|
|
uintptr_t *handle);
|
|
|
|
|
|
/* Initialise a device explicitly - to permit lazy initialisation or
|
|
* re-initialisation */
|
|
int io_dev_init(uintptr_t dev_handle, const uintptr_t init_params);
|
|
|
|
/* TODO: Consider whether an explicit "shutdown" API should be included */
|
|
|
|
/* Close a connection to a device */
|
|
int io_dev_close(uintptr_t dev_handle);
|
|
|
|
|
|
/* Synchronous operations */
|
|
int io_open(uintptr_t dev_handle, const uintptr_t spec, uintptr_t *handle);
|
|
|
|
int io_seek(uintptr_t handle, io_seek_mode_t mode, ssize_t offset);
|
|
|
|
int io_size(uintptr_t handle, size_t *length);
|
|
|
|
int io_read(uintptr_t handle, uintptr_t buffer, size_t length,
|
|
size_t *length_read);
|
|
|
|
int io_write(uintptr_t handle, const uintptr_t buffer, size_t length,
|
|
size_t *length_written);
|
|
|
|
int io_close(uintptr_t handle);
|
|
|
|
|
|
#endif /* IO_STORAGE_H */
|