Documentation cleanup, not finished.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12567 110e8d01-0319-4d1e-a829-52ad28d1bb01
This commit is contained in:
parent
e15fc5236b
commit
ac1e9f31ce
|
@ -792,7 +792,9 @@ INPUT = ./src \
|
|||
../../os/hal/include \
|
||||
../../os/hal/lib/peripherals/flash \
|
||||
../../os/hal/lib/peripherals/sensors \
|
||||
../../os/hal/lib/streams \
|
||||
../../os/hal/lib/complex/mfs \
|
||||
../../os/hal/lib/complex/serial_nor \
|
||||
../../os/hal/templates \
|
||||
../../os/hal/templates/osal
|
||||
|
||||
|
|
|
@ -792,7 +792,9 @@ INPUT = ./src \
|
|||
../../os/hal/include \
|
||||
../../os/hal/lib/peripherals/flash \
|
||||
../../os/hal/lib/peripherals/sensors \
|
||||
../../os/hal/lib/streams \
|
||||
../../os/hal/lib/complex/mfs \
|
||||
../../os/hal/lib/complex/serial_nor \
|
||||
../../os/hal/templates \
|
||||
../../os/hal/templates/osal
|
||||
|
||||
|
|
|
@ -15,8 +15,8 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @defgroup HAL_FLASH Generic Flash Driver Interface
|
||||
* @brief HAL Generic Flash Driver Interface.
|
||||
* @defgroup HAL_FLASH Generic NOR Flash Interface
|
||||
* @brief HAL Generic NOR Flash Driver Interface.
|
||||
*
|
||||
* @ingroup HAL_ABSTRACT_PERIPHERALS
|
||||
*/
|
||||
|
|
|
@ -15,8 +15,8 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @defgroup HAL_ABSTRACT_PERIPHERALS Abstract Peripheral Interfaces
|
||||
* @defgroup HAL_ABSTRACT_PERIPHERALS Peripheral Interfaces
|
||||
* @brief HAL Abstract Peripheral Interfaces.
|
||||
*
|
||||
* @ingroup HAL_INTERFACES
|
||||
* @ingroup IO
|
||||
*/
|
||||
|
|
|
@ -15,7 +15,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @defgroup MFS Managed Flash Storage Driver
|
||||
* @defgroup HAL_MFS Managed Flash Storage Driver
|
||||
* @brief Managed Flash Storage Driver.
|
||||
* @details This module implements a managed flash storage able to store
|
||||
* a finite number of variable-size records. Records are retrieved
|
||||
|
|
|
@ -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
|
||||
*/
|
||||
|
|
|
@ -18,7 +18,7 @@
|
|||
* @file serial_nor.h
|
||||
* @brief Serial NOR driver header.
|
||||
*
|
||||
* @addtogroup SERIAL_NOR
|
||||
* @addtogroup HAL_SERIAL_NOR
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
|
|
@ -23,7 +23,7 @@
|
|||
* @file chprintf.c
|
||||
* @brief Mini printf-like functionality.
|
||||
*
|
||||
* @addtogroup chprintf
|
||||
* @addtogroup HAL_CHPRINTF
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@
|
|||
* @file chprintf.h
|
||||
* @brief Mini printf-like functionality.
|
||||
*
|
||||
* @addtogroup chprintf
|
||||
* @addtogroup HAL_CHPRINTF
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@
|
|||
* @file memstreams.c
|
||||
* @brief Memory streams code.
|
||||
*
|
||||
* @addtogroup memory_streams
|
||||
* @addtogroup HAL_MEMORY_STREAMS
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@
|
|||
* @file memstreams.h
|
||||
* @brief Memory streams structures and macros.
|
||||
|
||||
* @addtogroup memory_streams
|
||||
* @addtogroup HAL_MEMORY_STREAMS
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@
|
|||
* @file nullstreams.c
|
||||
* @brief Null streams code.
|
||||
*
|
||||
* @addtogroup null_streams
|
||||
* @addtogroup HAL_NULL_STREAMS
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@
|
|||
* @file nullstreams.h
|
||||
* @brief Null streams structures and macros.
|
||||
|
||||
* @addtogroup null_streams
|
||||
* @addtogroup HAL_NULL_STREAMS
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
|
Loading…
Reference in New Issue