119 lines
4.4 KiB
C
119 lines
4.4 KiB
C
/*
|
|
ChibiOS - Copyright (C) 2006,2007,2008,2009,2010,2011,2012,2013,2014,
|
|
2015,2016,2017,2018,2019,2020,2021 Giovanni Di Sirio.
|
|
|
|
This file is part of ChibiOS.
|
|
|
|
ChibiOS is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation version 3 of the License.
|
|
|
|
ChibiOS is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/**
|
|
* @file vfs/include/vfsnodes.h
|
|
* @brief VFS nodes header file.
|
|
*
|
|
* @addtogroup VFS_NODES
|
|
* @{
|
|
*/
|
|
|
|
#ifndef VFSNODES_H
|
|
#define VFSNODES_H
|
|
|
|
/*===========================================================================*/
|
|
/* Module constants. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Module pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Module data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/* Forward declaration because nodes holds references to drivers.*/
|
|
typedef struct vfs_driver vfs_driver_t;
|
|
|
|
/**
|
|
* @brief Type of a VFS node.
|
|
*/
|
|
typedef enum {
|
|
VFS_NODE_TYPE_DIRECTORY = 0,/**< VFS_NODE_TYPE_DIRECTORY */
|
|
VFS_NODE_TYPE_FILE = 1 /**< VFS_NODE_TYPE_FILE */
|
|
} vfs_node_type_t;
|
|
|
|
/**
|
|
* @brief @p vfs_node_t specific methods.
|
|
*/
|
|
#define __vfs_node_methods \
|
|
/* Instance offset, used for multiple inheritance, normally zero. It
|
|
represents the offset between the current object and the container
|
|
object*/ \
|
|
size_t instance_offset; \
|
|
/* Node release, the object is disposed when the counter reaches zero.*/ \
|
|
void (*release)(void *instance); \
|
|
/* Node type getter function.*/ \
|
|
vfs_node_type_t (*get_type)(void *instance); \
|
|
/* Node name getter function.*/ \
|
|
char (*get_name)(void *instance);
|
|
|
|
/**
|
|
* @brief @p vfs_node_t specific data.
|
|
*/
|
|
#define __vfs_node_data \
|
|
/* Number of references to this node.*/ \
|
|
unsigned references_counter; \
|
|
/* Driver handling this node.*/ \
|
|
vfs_driver_t *driver;
|
|
|
|
/**
|
|
* @brief @p vfs_node_t virtual methods table.
|
|
*/
|
|
struct vfs_node_vmt {
|
|
__vfs_node_methods
|
|
};
|
|
|
|
/**
|
|
* @brief Type of a structure representing a VFS node.
|
|
*/
|
|
typedef struct vfs_node {
|
|
/**
|
|
* @brief Virtual Methods Table.
|
|
*/
|
|
const struct vfs_node_vmt *vmt;
|
|
__vfs_node_data
|
|
} vfs_node_t;
|
|
|
|
/*===========================================================================*/
|
|
/* Module macros. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* VFSNODES_H */
|
|
|
|
/** @} */
|