More renaming for consistency.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12571 110e8d01-0319-4d1e-a829-52ad28d1bb01
This commit is contained in:
Giovanni Di Sirio 2019-01-21 19:42:49 +00:00
parent 5a41bbc5e1
commit a3e9966359
41 changed files with 30 additions and 82 deletions

View File

@ -1,82 +0,0 @@
/*
ChibiOS - Copyright (C) 2006..2018 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.
*/
/**
* @defgroup EXT EXT Driver
* @brief Generic EXT Driver.
* @details This module implements a generic EXT (EXTernal) driver.
* @note This driver is obsolete. Use the Event and Callback functions
* of the @ref PAL driver instead.
* @pre In order to use the EXT driver the @p HAL_USE_EXT option
* must be enabled in @p halconf.h.
*
* @section ext_1 Driver State Machine
* The driver implements a state machine internally, not all the driver
* functionalities can be used in any moment, any transition not explicitly
* shown in the following diagram has to be considered an error and shall
* be captured by an assertion (if enabled).
* @if LATEX_PDF
* @dot
digraph example {
size="5, 7";
rankdir="LR";
node [shape=circle, fontname=Sans, fontsize=8, fixedsize="true", width="0.9", height="0.9"];
edge [fontname=Sans, fontsize=8];
uninit [label="EXT_UNINIT", style="bold"];
stop [label="EXT_STOP\nLow Power"];
active [label="EXT_ACTIVE"];
uninit -> stop [label="extInit()"];
stop -> stop [label="\nextStop()"];
stop -> active [label="\nextStart()"];
active -> stop [label="\nextStop()"];
active -> active [label="\nextStart()"];
}
* @enddot
* @else
* @dot
digraph example {
rankdir="LR";
node [shape=circle, fontname=Sans, fontsize=8, fixedsize="true", width="0.9", height="0.9"];
edge [fontname=Sans, fontsize=8];
uninit [label="EXT_UNINIT", style="bold"];
stop [label="EXT_STOP\nLow Power"];
active [label="EXT_ACTIVE"];
uninit -> stop [label="extInit()"];
stop -> stop [label="\nextStop()"];
stop -> active [label="\nextStart()"];
active -> stop [label="\nextStop()"];
active -> active [label="\nextStart()"];
}
* @enddot
* @endif
*
* @section ext_2 EXT Operations.
* This driver abstracts generic external interrupt sources, a callback
* is invoked when a programmable transition is detected on one of the
* configured channels. Several channel modes are possible.
* - <b>EXT_CH_MODE_DISABLED</b>, channel not used.
* - <b>EXT_CH_MODE_RISING_EDGE</b>, callback on a rising edge.
* - <b>EXT_CH_MODE_FALLING_EDGE</b>, callback on a falling edge.
* - <b>EXT_CH_MODE_BOTH_EDGES</b>, callback on a both edges.
* .
* @ingroup HAL_NORMAL_DRIVERS
*/

25
os/hal/dox/hal_trng.dox Normal file
View File

@ -0,0 +1,25 @@
/*
ChibiOS - Copyright (C) 2006..2018 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.
*/
/**
* @defgroup CRYPTO Crypto Driver
* @brief Generic Crypto Driver.
* @details This module implements a generic Cryptography driver.
* @pre In order to use the crypto driver the @p HAL_USE_CRY option
* must be enabled in @p halconf.h.
*
* @ingroup HAL_NORMAL_DRIVERS
*/

View File

@ -19,6 +19,9 @@
* @brief Generic persistent storage class header.
*
* @addtogroup HAL_PERSISTENT
* @details This module define an abstract interface for generic persistent
* storage. Such storage has a fixed size and can be read and
* written.
* @{
*/

View File

@ -19,6 +19,7 @@
* @brief Memory streams code.
*
* @addtogroup HAL_MEMORY_STREAMS
* @details Memory buffers handled as streams.
* @{
*/

View File

@ -19,6 +19,7 @@
* @brief Null streams code.
*
* @addtogroup HAL_NULL_STREAMS
* @details A null streams.
* @{
*/