diff options
author | Giovanni Di Sirio <gdisirio@gmail.com> | 2019-01-21 19:42:49 +0000 |
---|---|---|
committer | Giovanni Di Sirio <gdisirio@gmail.com> | 2019-01-21 19:42:49 +0000 |
commit | a3e9966359c432405c8ab1eb49a27133e5271ba2 (patch) | |
tree | 03216e3986c61339f7ca9ad4c03671b6438a4b27 /os/hal/dox/sio.dox | |
parent | 5a41bbc5e100fc1e946702a046f0802e625a8de5 (diff) | |
download | ChibiOS-a3e9966359c432405c8ab1eb49a27133e5271ba2.tar.gz ChibiOS-a3e9966359c432405c8ab1eb49a27133e5271ba2.tar.bz2 ChibiOS-a3e9966359c432405c8ab1eb49a27133e5271ba2.zip |
More renaming for consistency.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12571 110e8d01-0319-4d1e-a829-52ad28d1bb01
Diffstat (limited to 'os/hal/dox/sio.dox')
-rw-r--r-- | os/hal/dox/sio.dox | 58 |
1 files changed, 0 insertions, 58 deletions
diff --git a/os/hal/dox/sio.dox b/os/hal/dox/sio.dox deleted file mode 100644 index 57ff2bae5..000000000 --- a/os/hal/dox/sio.dox +++ /dev/null @@ -1,58 +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 SIO SIO Driver
- * @brief Generic SIO Driver.
- * @details This driver abstracts a generic serial communication channel,
- * usually an UART, this driver is similar to Serial and UART drivers
- * but follows a different concept:
- * - Very close to HW.
- * - No buffering done in SW, the driver relies on the peripheral
- * internal FIFO, if any.
- * - Asynchronous, the API is always non blocking.
- * - Callbacks capable, operations completion and other events are
- * notified using callbacks.
- * - Very short code paths, especially in ISRs.
- * .
- * @pre In order to use the SIO driver the @p HAL_USE_SIO option
- * must be enabled in @p halconf.h.
- *
- * @section sio_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).
- * @dot
- digraph example {
- rankdir="LR";
- node [shape=circle, fontname=Helvetica, fontsize=8, fixedsize="true", width="0.9", height="0.9"];
- edge [fontname=Helvetica, fontsize=8];
-
- uninit [label="SIO_UNINIT", style="bold"];
- stop [label="SIO_STOP\nLow Power"];
- ready [label="SIO_READY\nClock Enabled"];
-
- uninit -> stop [label="\nsioInit()"];
- stop -> ready [label="\nsioStart()"];
- ready -> ready [label="\nsioStart()"];
- ready -> stop [label="\nsioStop()"];
- stop -> stop [label="\nsioStop()"];
- }
- * @enddot
- *
- * @ingroup HAL_NORMAL_DRIVERS
- */
|