More renaming for consistency.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12571 110e8d01-0319-4d1e-a829-52ad28d1bb01

41 files changed, 30 insertions, 82 deletions

diff --git a/os/hal/dox/ext.dox b/os/hal/dox/ext.dox
deleted file mode 100644
index b59269c43..000000000
--- a/os/hal/dox/ext.dox
+++ /dev/null
@@ -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

- */

diff --git a/os/hal/dox/accelerometer.dox b/os/hal/dox/hal_accelerometer.dox
index e93a64c3b..e93a64c3b 100644
--- a/os/hal/dox/accelerometer.dox
+++ b/os/hal/dox/hal_accelerometer.dox
diff --git a/os/hal/dox/adc.dox b/os/hal/dox/hal_adc.dox
index c80a0b495..c80a0b495 100644
--- a/os/hal/dox/adc.dox
+++ b/os/hal/dox/hal_adc.dox
diff --git a/os/hal/dox/barometer.dox b/os/hal/dox/hal_barometer.dox
index 4a472fa11..4a472fa11 100644
--- a/os/hal/dox/barometer.dox
+++ b/os/hal/dox/hal_barometer.dox
diff --git a/os/hal/dox/can.dox b/os/hal/dox/hal_can.dox
index 5dd8104b0..5dd8104b0 100644
--- a/os/hal/dox/can.dox
+++ b/os/hal/dox/hal_can.dox
diff --git a/os/hal/dox/compass.dox b/os/hal/dox/hal_compass.dox
index 4f16af784..4f16af784 100644
--- a/os/hal/dox/compass.dox
+++ b/os/hal/dox/hal_compass.dox
diff --git a/os/hal/dox/crypto.dox b/os/hal/dox/hal_crypto.dox
index a04267123..a04267123 100644
--- a/os/hal/dox/crypto.dox
+++ b/os/hal/dox/hal_crypto.dox
diff --git a/os/hal/dox/dac.dox b/os/hal/dox/hal_dac.dox
index c81f3a0bd..c81f3a0bd 100644
--- a/os/hal/dox/dac.dox
+++ b/os/hal/dox/hal_dac.dox
diff --git a/os/hal/dox/flash.dox b/os/hal/dox/hal_flash.dox
index 4cf395292..4cf395292 100644
--- a/os/hal/dox/flash.dox
+++ b/os/hal/dox/hal_flash.dox
diff --git a/os/hal/dox/gpt.dox b/os/hal/dox/hal_gpt.dox
index d75dab2b8..d75dab2b8 100644
--- a/os/hal/dox/gpt.dox
+++ b/os/hal/dox/hal_gpt.dox
diff --git a/os/hal/dox/gyro.dox b/os/hal/dox/hal_gyro.dox
index 66f3c6fa8..66f3c6fa8 100644
--- a/os/hal/dox/gyro.dox
+++ b/os/hal/dox/hal_gyro.dox
diff --git a/os/hal/dox/hygrometer.dox b/os/hal/dox/hal_hygrometer.dox
index b8eeb66de..b8eeb66de 100644
--- a/os/hal/dox/hygrometer.dox
+++ b/os/hal/dox/hal_hygrometer.dox
diff --git a/os/hal/dox/i2c.dox b/os/hal/dox/hal_i2c.dox
index c5a39f341..c5a39f341 100644
--- a/os/hal/dox/i2c.dox
+++ b/os/hal/dox/hal_i2c.dox
diff --git a/os/hal/dox/i2s.dox b/os/hal/dox/hal_i2s.dox
index 629b5e95b..629b5e95b 100644
--- a/os/hal/dox/i2s.dox
+++ b/os/hal/dox/hal_i2s.dox
diff --git a/os/hal/dox/icu.dox b/os/hal/dox/hal_icu.dox
index 710c388ae..710c388ae 100644
--- a/os/hal/dox/icu.dox
+++ b/os/hal/dox/hal_icu.dox
diff --git a/os/hal/dox/mac.dox b/os/hal/dox/hal_mac.dox
index c5e9c643b..c5e9c643b 100644
--- a/os/hal/dox/mac.dox
+++ b/os/hal/dox/hal_mac.dox
diff --git a/os/hal/dox/mfs.dox b/os/hal/dox/hal_mfs.dox
index 88b80468a..88b80468a 100644
--- a/os/hal/dox/mfs.dox
+++ b/os/hal/dox/hal_mfs.dox
diff --git a/os/hal/dox/mii.dox b/os/hal/dox/hal_mii.dox
index cfd7a1ec6..cfd7a1ec6 100644
--- a/os/hal/dox/mii.dox
+++ b/os/hal/dox/hal_mii.dox
diff --git a/os/hal/dox/mmc_spi.dox b/os/hal/dox/hal_mmc_spi.dox
index 1dc4b27b8..1dc4b27b8 100644
--- a/os/hal/dox/mmc_spi.dox
+++ b/os/hal/dox/hal_mmc_spi.dox
diff --git a/os/hal/dox/mmcsd.dox b/os/hal/dox/hal_mmcsd.dox
index 3b8017cb4..3b8017cb4 100644
--- a/os/hal/dox/mmcsd.dox
+++ b/os/hal/dox/hal_mmcsd.dox
diff --git a/os/hal/dox/norflash.dox b/os/hal/dox/hal_norflash.dox
index 2196363bd..2196363bd 100644
--- a/os/hal/dox/norflash.dox
+++ b/os/hal/dox/hal_norflash.dox
diff --git a/os/hal/dox/pal.dox b/os/hal/dox/hal_pal.dox
index d37fd091d..d37fd091d 100644
--- a/os/hal/dox/pal.dox
+++ b/os/hal/dox/hal_pal.dox
diff --git a/os/hal/dox/pwm.dox b/os/hal/dox/hal_pwm.dox
index 39e0128b1..39e0128b1 100644
--- a/os/hal/dox/pwm.dox
+++ b/os/hal/dox/hal_pwm.dox
diff --git a/os/hal/dox/rtc.dox b/os/hal/dox/hal_rtc.dox
index 0923e61e7..0923e61e7 100644
--- a/os/hal/dox/rtc.dox
+++ b/os/hal/dox/hal_rtc.dox
diff --git a/os/hal/dox/sdc.dox b/os/hal/dox/hal_sdc.dox
index 1a2600659..1a2600659 100644
--- a/os/hal/dox/sdc.dox
+++ b/os/hal/dox/hal_sdc.dox
diff --git a/os/hal/dox/sensor.dox b/os/hal/dox/hal_sensor.dox
index 036f7f7ac..036f7f7ac 100644
--- a/os/hal/dox/sensor.dox
+++ b/os/hal/dox/hal_sensor.dox
diff --git a/os/hal/dox/serial.dox b/os/hal/dox/hal_serial.dox
index 9acb0bccb..9acb0bccb 100644
--- a/os/hal/dox/serial.dox
+++ b/os/hal/dox/hal_serial.dox
diff --git a/os/hal/dox/serial_usb.dox b/os/hal/dox/hal_serial_usb.dox
index 028d8bbd0..028d8bbd0 100644
--- a/os/hal/dox/serial_usb.dox
+++ b/os/hal/dox/hal_serial_usb.dox
diff --git a/os/hal/dox/sio.dox b/os/hal/dox/hal_sio.dox
index 57ff2bae5..57ff2bae5 100644
--- a/os/hal/dox/sio.dox
+++ b/os/hal/dox/hal_sio.dox
diff --git a/os/hal/dox/spi.dox b/os/hal/dox/hal_spi.dox
index 4307bacd9..4307bacd9 100644
--- a/os/hal/dox/spi.dox
+++ b/os/hal/dox/hal_spi.dox
diff --git a/os/hal/dox/st.dox b/os/hal/dox/hal_st.dox
index c6a8a6471..c6a8a6471 100644
--- a/os/hal/dox/st.dox
+++ b/os/hal/dox/hal_st.dox
diff --git a/os/hal/dox/thermometer.dox b/os/hal/dox/hal_thermometer.dox
index 70cf0bb7b..70cf0bb7b 100644
--- a/os/hal/dox/thermometer.dox
+++ b/os/hal/dox/hal_thermometer.dox
diff --git a/os/hal/dox/hal_trng.dox b/os/hal/dox/hal_trng.dox
new file mode 100644
index 000000000..b9ad2b157
--- /dev/null
+++ b/os/hal/dox/hal_trng.dox
@@ -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

+ */

diff --git a/os/hal/dox/uart.dox b/os/hal/dox/hal_uart.dox
index 8af312787..8af312787 100644
--- a/os/hal/dox/uart.dox
+++ b/os/hal/dox/hal_uart.dox
diff --git a/os/hal/dox/usb.dox b/os/hal/dox/hal_usb.dox
index 82de6ccfc..82de6ccfc 100644
--- a/os/hal/dox/usb.dox
+++ b/os/hal/dox/hal_usb.dox
diff --git a/os/hal/dox/usb_cdc.dox b/os/hal/dox/hal_usb_cdc.dox
index c480c95a8..c480c95a8 100644
--- a/os/hal/dox/usb_cdc.dox
+++ b/os/hal/dox/hal_usb_cdc.dox
diff --git a/os/hal/dox/wdg.dox b/os/hal/dox/hal_wdg.dox
index 75293203c..75293203c 100644
--- a/os/hal/dox/wdg.dox
+++ b/os/hal/dox/hal_wdg.dox
diff --git a/os/hal/dox/wspi.dox b/os/hal/dox/hal_wspi.dox
index 5cf29d9bc..5cf29d9bc 100755
--- a/os/hal/dox/wspi.dox
+++ b/os/hal/dox/hal_wspi.dox
diff --git a/os/hal/include/hal_persistent.h b/os/hal/include/hal_persistent.h
index f6ba14e82..99697f131 100644
--- a/os/hal/include/hal_persistent.h
+++ b/os/hal/include/hal_persistent.h
@@ -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.

  * @{

  */

 

diff --git a/os/hal/lib/streams/memstreams.c b/os/hal/lib/streams/memstreams.c
index a06b0a3a1..98b3fe6d5 100644
--- a/os/hal/lib/streams/memstreams.c
+++ b/os/hal/lib/streams/memstreams.c
@@ -19,6 +19,7 @@
  * @brief   Memory streams code.

  *

  * @addtogroup HAL_MEMORY_STREAMS

+ * @details Memory buffers handled as streams.

  * @{

  */

 

diff --git a/os/hal/lib/streams/nullstreams.c b/os/hal/lib/streams/nullstreams.c
index 51206e943..dcfd42442 100644
--- a/os/hal/lib/streams/nullstreams.c
+++ b/os/hal/lib/streams/nullstreams.c
@@ -19,6 +19,7 @@
  * @brief   Null streams code.

  *

  * @addtogroup HAL_NULL_STREAMS

+ * @details A null streams.

  * @{

  */