andreika-git
/
ChibiOS
mirror of https://github.com/andreika-git/ChibiOS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@16272 27425a3e-05d8-49a3-a47f-9c15f0e5edd8

This commit is contained in:
Giovanni Di Sirio 2023-05-28 15:57:05 +00:00
parent 97a03916d0
commit c3a772e2f2
3 changed files with 173 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
os/xhal/codegen/hal_block_io.xml Normal file
View File

@ -0,0 +1,39 @@
<?xml version="1.0" encoding="UTF-8"?>
<module xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://www.chibios.org/xml/schema/ccode/modules.xsd"
name="hal_block_io" descr="Block I/O" editcode="false">
<brief>Block devices interface.</brief>
<imports>
<import>oop_base_interface.xml</import>
</imports>
<public>
<types>
<interface name="block_io" namespace="chn"
ancestorname="base_interface" descr="block device">
<brief>Base block device interface.</brief>
<details><![CDATA[This header defines an abstract interface useful
to access generic I/O block devices in a standardized way.]]></details>
<consts>
</consts>
<methods>
<method name="blkIsInserted" shortname="is_inserted" ctype="bool">
<brief>Removable media detection.</brief>
<return>The media state.</return>
<retval value="false">If media not inserted.</retval>
<retval value="true">If media is inserted.</retval>
<api />
</method>
<method name="blkIsWriteProtected" shortname="is_protected" ctype="bool">
<brief>Returns the media write protection status.</brief>
<return>The media state.</return>
<retval value="false">If media is writable.</retval>
<retval value="true">If media is not writable.</retval>
<api />
</method>
</methods>
</interface>
</types>
</public>
<private>
</private>
</module>

2
os/xhal/codegen/modules.xml
View File

@ -2,6 +2,7 @@
<!DOCTYPE doc [
<!ENTITY hal_base_driver SYSTEM "hal_base_driver.xml">
<!ENTITY hal_channels SYSTEM "hal_channels.xml">
<!ENTITY hal_block_io SYSTEM "hal_block_io.xml">
<!ENTITY hal_buffered_serial SYSTEM "hal_buffered_serial.xml">
<!ENTITY hal_sio SYSTEM "hal_sio.xml">
]>
@ -13,6 +14,7 @@
<modules>
&hal_base_driver;
&hal_channels;
&hal_block_io;
&hal_buffered_serial;
&hal_sio;
</modules>

132
os/xhal/include/hal_block_io.h Normal file
View File

@ -0,0 +1,132 @@
/*
ChibiOS - Copyright (C) 2006..2023 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @file hal_block_io.h
* @brief Generated Block I/O header.
* @note This is a generated file, do not edit directly.
*
* @addtogroup HAL_BLOCK_IO
* @brief Block devices interface.
* @{
*/
#ifndef HAL_BLOCK_IO_H
#define HAL_BLOCK_IO_H
/*===========================================================================*/
/* Module constants. */
/*===========================================================================*/
/*===========================================================================*/
/* Module pre-compile time settings. */
/*===========================================================================*/
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
/*===========================================================================*/
/* Module macros. */
/*===========================================================================*/
/*===========================================================================*/
/* Module data structures and types. */
/*===========================================================================*/
/**
* @interface block_io_i
* @extends base_interface_i.
*
* @brief Base block device interface.
* @details This header defines an abstract interface useful to access
* generic I/O block devices in a standardized way.
*
* @name Interface @p block_io_i structures
* @{
*/
/**
* @brief Type of a block device interface.
*/
typedef struct block_io block_io_i;
/**
* @brief Interface @p block_io_i virtual methods table.
*/
struct block_io_vmt {
/* Memory offset between this interface structure and begin of
the implementing class structure.*/
size_t instance_offset;
/* From base_interface_i.*/
/* From block_io_i.*/
bool (*is_inserted)(void *ip);
};
/**
* @brief Structure representing a block device interface.
*/
struct block_io {
/**
* @brief Virtual Methods Table.
*/
const struct block_io_vmt *vmt;
};
/** @} */
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
#ifdef __cplusplus
}
#endif
/*===========================================================================*/
/* Module inline functions. */
/*===========================================================================*/
/**
* @name Virtual methods of block_io_i
* @{
*/
/**
* @memberof block_io_i
* @public
*
* @brief Removable media detection.
*
* @param[in,out] ip Pointer to a @p block_io_i instance.
* @return The media state.
* @retval false If media not inserted.
* @retval true If media is inserted.
*
* @api
*/
CC_FORCE_INLINE
static inline bool blkIsInserted(void *ip) {
block_io_i *self = (block_io_i *)ip;
return self->vmt->is_inserted(ip);
}
/** @} */
#endif /* HAL_BLOCK_IO_H */
/** @} */