aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/dox/norflash.dox
diff options
context:
space:
mode:
authorGiovanni Di Sirio <gdisirio@gmail.com>2019-01-20 16:23:16 +0000
committerGiovanni Di Sirio <gdisirio@gmail.com>2019-01-20 16:23:16 +0000
commitac1e9f31ced461e6a999e71eb1bc50965e1a1597 (patch)
tree4eaefa2d9f053ed4c1740ec9b052b09418acb2cd /os/hal/dox/norflash.dox
parente15fc5236be4f5b091ba3a946acaad5dda1d7904 (diff)
downloadChibiOS-ac1e9f31ced461e6a999e71eb1bc50965e1a1597.tar.gz
ChibiOS-ac1e9f31ced461e6a999e71eb1bc50965e1a1597.tar.bz2
ChibiOS-ac1e9f31ced461e6a999e71eb1bc50965e1a1597.zip
Documentation cleanup, not finished.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12567 110e8d01-0319-4d1e-a829-52ad28d1bb01
Diffstat (limited to 'os/hal/dox/norflash.dox')
-rw-r--r--os/hal/dox/norflash.dox27
1 files changed, 5 insertions, 22 deletions
diff --git a/os/hal/dox/norflash.dox b/os/hal/dox/norflash.dox
index 1cc4a758a..2196363bd 100644
--- a/os/hal/dox/norflash.dox
+++ b/os/hal/dox/norflash.dox
@@ -15,9 +15,10 @@
*/
/**
- * @defgroup NOR_FLASH Abstract NOR Flash Class
- * @brief Generic NOR Flash interface.
- * @details This module implements a generic class for NOR Flash devices.
+ * @defgroup HAL_SERIAL_NOR Serial NOR Flash Driver
+ * @brief Serial NOR Flash driver.
+ * @details This module implements a generic driver for serial NOR Flash
+ * devices.
*
* @section flash_1 Driver State Machine
* The flash driver implements a state machine internally, not all the driver
@@ -53,23 +54,5 @@
}
* @enddot
*
- * @section flash_2 Flash Operations.
- * This driver abstracts a generic PWM timer composed of:
- * - A clock prescaler.
- * - A main up counter.
- * - A comparator register that resets the main counter to zero when the limit
- * is reached. An optional callback can be generated when this happens.
- * - An array of @p PWM_CHANNELS PWM channels, each channel has an output,
- * a comparator and is able to invoke an optional callback when a comparator
- * match with the main counter happens.
- * .
- * A PWM channel output can be in two different states:
- * - <b>IDLE</b>, when the channel is disabled or after a match occurred.
- * - <b>ACTIVE</b>, when the channel is enabled and a match didn't occur yet
- * in the current PWM cycle.
- * .
- * Note that the two states can be associated to both logical zero or one in
- * the @p PWMChannelConfig structure.
- *
- * @ingroup HAL_INTERFACES
+ * @ingroup HAL_COMPLEX_DRIVERS
*/