Always use named structs in header files
Add tag names to all unnamed structs in header files. This
allows forward declaration of structs, which is necessary to
reduce header file nesting (to be implemented in a subsequent
commit).
Also change the typedef names across the codebase to use the _t
suffix to be more conformant with the Linux coding style. The
coding style actually prefers us not to use typedefs at all but
this is considered a step too far for Trusted Firmware.
Also change the IO framework structs defintions to use typedef'd
structs to be consistent with the rest of the codebase.
Change-Id: I722b2c86fc0d92e4da3b15e5cab20373dd26786f
diff --git a/lib/io_storage.c b/lib/io_storage.c
index cd9c2bd..c3b94bb 100644
--- a/lib/io_storage.c
+++ b/lib/io_storage.c
@@ -40,24 +40,24 @@
/* Storage for a fixed maximum number of IO entities, definable by platform */
-static struct io_entity entity_pool[MAX_IO_HANDLES];
+static io_entity_t entity_pool[MAX_IO_HANDLES];
/* Simple way of tracking used storage - each entry is NULL or a pointer to an
* entity */
-static struct io_entity *entity_map[MAX_IO_HANDLES];
+static io_entity_t *entity_map[MAX_IO_HANDLES];
/* Track number of allocated entities */
static unsigned int entity_count;
/* Used to keep a reference to platform-specific data */
-static struct io_plat_data *platform_data;
+static io_plat_data_t *platform_data;
#if DEBUG /* Extra validation functions only used in debug builds */
/* Return a boolean value indicating whether a device connector is valid */
-static int is_valid_dev_connector(const struct io_dev_connector *dev_con)
+static int is_valid_dev_connector(const io_dev_connector_t *dev_con)
{
int result = (dev_con != NULL) && (dev_con->dev_open != NULL);
return result;
@@ -67,7 +67,7 @@
/* Return a boolean value indicating whether a device handle is valid */
static int is_valid_dev(io_dev_handle handle)
{
- const struct io_dev_info *dev = handle;
+ const io_dev_info_t *dev = handle;
int result = (dev != NULL) && (dev->funcs != NULL) &&
(dev->funcs->type != NULL) &&
(dev->funcs->type() < IO_TYPE_MAX);
@@ -78,14 +78,14 @@
/* Return a boolean value indicating whether an IO entity is valid */
static int is_valid_entity(io_handle handle)
{
- const struct io_entity *entity = handle;
+ const io_entity_t *entity = handle;
int result = (entity != NULL) && (is_valid_dev(entity->dev_handle));
return result;
}
/* Return a boolean value indicating whether a seek mode is valid */
-static int is_valid_seek_mode(io_seek_mode mode)
+static int is_valid_seek_mode(io_seek_mode_t mode)
{
return ((mode != IO_SEEK_INVALID) && (mode < IO_SEEK_MAX));
}
@@ -94,8 +94,8 @@
/* Open a connection to a specific device */
-static int dev_open(const struct io_dev_connector *dev_con, void *dev_spec,
- struct io_dev_info **dev_info)
+static int dev_open(const io_dev_connector_t *dev_con, void *dev_spec,
+ io_dev_info_t **dev_info)
{
int result = IO_FAIL;
assert(dev_info != NULL);
@@ -107,7 +107,7 @@
/* Set a handle to track an entity */
-static void set_handle(io_handle *handle, struct io_entity *entity)
+static void set_handle(io_handle *handle, io_entity_t *entity)
{
assert(handle != NULL);
*handle = entity;
@@ -217,7 +217,7 @@
assert(dev_handle != NULL);
assert(is_valid_dev(dev_handle));
- struct io_dev_info *dev = dev_handle;
+ io_dev_info_t *dev = dev_handle;
if (dev->funcs->dev_init != NULL) {
result = dev->funcs->dev_init(dev, init_params);
@@ -238,7 +238,7 @@
assert(dev_handle != NULL);
assert(is_valid_dev(dev_handle));
- struct io_dev_info *dev = dev_handle;
+ io_dev_info_t *dev = dev_handle;
if (dev->funcs->dev_close != NULL) {
result = dev->funcs->dev_close(dev);
@@ -261,8 +261,8 @@
assert((spec != NULL) && (handle != NULL));
assert(is_valid_dev(dev_handle));
- struct io_dev_info *dev = dev_handle;
- struct io_entity *entity;
+ io_dev_info_t *dev = dev_handle;
+ io_entity_t *entity;
result = allocate_entity(&entity);
@@ -281,14 +281,14 @@
/* Seek to a specific position in an IO entity */
-int io_seek(io_handle handle, io_seek_mode mode, ssize_t offset)
+int io_seek(io_handle handle, io_seek_mode_t mode, ssize_t offset)
{
int result = IO_FAIL;
assert(is_valid_entity(handle) && is_valid_seek_mode(mode));
- struct io_entity *entity = handle;
+ io_entity_t *entity = handle;
- struct io_dev_info *dev = entity->dev_handle;
+ io_dev_info_t *dev = entity->dev_handle;
if (dev->funcs->seek != NULL)
result = dev->funcs->seek(entity, mode, offset);
@@ -305,9 +305,9 @@
int result = IO_FAIL;
assert(is_valid_entity(handle) && (length != NULL));
- struct io_entity *entity = handle;
+ io_entity_t *entity = handle;
- struct io_dev_info *dev = entity->dev_handle;
+ io_dev_info_t *dev = entity->dev_handle;
if (dev->funcs->size != NULL)
result = dev->funcs->size(entity, length);
@@ -324,9 +324,9 @@
int result = IO_FAIL;
assert(is_valid_entity(handle) && (buffer != NULL));
- struct io_entity *entity = handle;
+ io_entity_t *entity = handle;
- struct io_dev_info *dev = entity->dev_handle;
+ io_dev_info_t *dev = entity->dev_handle;
if (dev->funcs->read != NULL)
result = dev->funcs->read(entity, buffer, length, length_read);
@@ -344,9 +344,9 @@
int result = IO_FAIL;
assert(is_valid_entity(handle) && (buffer != NULL));
- struct io_entity *entity = handle;
+ io_entity_t *entity = handle;
- struct io_dev_info *dev = entity->dev_handle;
+ io_dev_info_t *dev = entity->dev_handle;
if (dev->funcs->write != NULL) {
result = dev->funcs->write(entity, buffer, length,
@@ -364,9 +364,9 @@
int result = IO_FAIL;
assert(is_valid_entity(handle));
- struct io_entity *entity = handle;
+ io_entity_t *entity = handle;
- struct io_dev_info *dev = entity->dev_handle;
+ io_dev_info_t *dev = entity->dev_handle;
if (dev->funcs->close != NULL)
result = dev->funcs->close(entity);