git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1328 35acf78f-673a-0410-8e92-d51de3d6d3f4

master
gdisirio 2009-11-26 21:19:03 +00:00
parent 780110bd2c
commit 7f06b944cd
12 changed files with 53 additions and 53 deletions

View File

@ -98,8 +98,8 @@ void canStop(CANDriver *canp) {
* queue is full then the invoking thread is queued. * queue is full then the invoking thread is queued.
* @note Trying to transmit while in sleep mode simply enqueues the thread. * @note Trying to transmit while in sleep mode simply enqueues the thread.
* *
* @param canp[in] pointer to the @p CANDriver object * @param[in] canp pointer to the @p CANDriver object
* @param cfp[in] pointer to the CAN frame to be transmitted * @param[in] cfp pointer to the CAN frame to be transmitted
* @param[in] timeout the number of ticks before the operation timeouts, * @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed: * the following special values are allowed:
* - @a TIME_IMMEDIATE immediate timeout. * - @a TIME_IMMEDIATE immediate timeout.
@ -136,8 +136,8 @@ msg_t canTransmit(CANDriver *canp, const CANFrame *cfp, systime_t timeout) {
* @details The function waits until a frame is received. * @details The function waits until a frame is received.
* @note Trying to receive while in sleep mode simply enqueues the thread. * @note Trying to receive while in sleep mode simply enqueues the thread.
* *
* @param canp[in] pointer to the @p CANDriver object * @param[in] canp pointer to the @p CANDriver object
* @param cfp[out] pointer to the buffer where the CAN frame is copied * @param[out] cfp pointer to the buffer where the CAN frame is copied
* @param[in] timeout the number of ticks before the operation timeouts, * @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed: * the following special values are allowed:
* - @a TIME_IMMEDIATE immediate timeout. * - @a TIME_IMMEDIATE immediate timeout.
@ -173,7 +173,7 @@ msg_t canReceive(CANDriver *canp, CANFrame *cfp, systime_t timeout) {
/** /**
* @brief Enters the sleep mode. * @brief Enters the sleep mode.
* *
* @param canp[in] pointer to the @p CANDriver object * @param[in] canp pointer to the @p CANDriver object
*/ */
void canSleep(CANDriver *canp) { void canSleep(CANDriver *canp) {
@ -197,7 +197,7 @@ void canSleep(CANDriver *canp) {
* @note The sleep mode is supposed to be usually exited automatically by an * @note The sleep mode is supposed to be usually exited automatically by an
* hardware event. * hardware event.
* *
* @param canp[in] pointer to the @p CANDriver object * @param[in] canp pointer to the @p CANDriver object
*/ */
void canWakeup(CANDriver *canp) { void canWakeup(CANDriver *canp) {

View File

@ -50,7 +50,7 @@
* - @ref ADC. * - @ref ADC.
* - @ref MAC. * - @ref MAC.
* - @ref MII. * - @ref MII.
* - @ref MMC. * - @ref MMC_SPI.
* . * .
*/ */

View File

@ -18,9 +18,9 @@
*/ */
/** /**
* @file AT91SAM7X/mac_lld.c * @file AT91SAM7/mac_lld.c
* @brief AT91SAM7X low level MAC driver code * @brief AT91SAM7 low level MAC driver code
* @addtogroup AT91SAM7X_MAC * @addtogroup AT91SAM7_MAC
* @{ * @{
*/ */

View File

@ -18,9 +18,9 @@
*/ */
/** /**
* @file AT91SAM7X/mac_lld.h * @file AT91SAM7/mac_lld.h
* @brief AT91SAM7X low level MAC driver header * @brief AT91SAM7 low level MAC driver header
* @addtogroup AT91SAM7X_MAC * @addtogroup AT91SAM7_MAC
* @{ * @{
*/ */

View File

@ -18,9 +18,9 @@
*/ */
/** /**
* @file AT91SAM7X/mii_lld.c * @file AT91SAM7/mii_lld.c
* @brief AT91SAM7X low level MII driver code * @brief AT91SAM7 low level MII driver code
* @addtogroup AT91SAM7X_MII * @addtogroup AT91SAM7_MII
* @{ * @{
*/ */

View File

@ -18,9 +18,9 @@
*/ */
/** /**
* @file AT91SAM7X/mii_lld.h * @file AT91SAM7/mii_lld.h
* @brief AT91SAM7X low level MII driver header * @brief AT91SAM7 low level MII driver header
* @addtogroup AT91SAM7X_MII * @addtogroup AT91SAM7_MII
* @{ * @{
*/ */

View File

@ -18,9 +18,9 @@
*/ */
/** /**
* @file AT91SAM7X/pal_lld.c * @file AT91SAM7/pal_lld.c
* @brief AT91SAM7X PIO low level driver code * @brief AT91SAM7 PIO low level driver code
* @addtogroup AT91SAM7X_PAL * @addtogroup AT91SAM7_PAL
* @{ * @{
*/ */

View File

@ -18,9 +18,9 @@
*/ */
/** /**
* @file AT91SAM7X/pal_lld.h * @file AT91SAM7/pal_lld.h
* @brief AT91SAM7X PIO low level driver header * @brief AT91SAM7 PIO low level driver header
* @addtogroup AT91SAM7X_PAL * @addtogroup AT91SAM7_PAL
* @{ * @{
*/ */

View File

@ -18,9 +18,9 @@
*/ */
/** /**
* @defgroup AT91SAM7X AT91SAM7X Support * @defgroup AT91SAM7 AT91SAM7 Support
* @brief AT91SAM7X specific support. * @brief AT91SAM7 specific support.
* @details The AT91SAM7X support includes: * @details The AT91SAM7 support includes:
* - Buffered, interrupt driven, serial driver. * - Buffered, interrupt driven, serial driver.
* - EMAC driver with MII support. * - EMAC driver with MII support.
* - A demo supporting the kernel test suite. * - A demo supporting the kernel test suite.
@ -30,9 +30,9 @@
*/ */
/** /**
* @defgroup AT91SAM7X_PAL AT91SAM7X I/O Ports Support * @defgroup AT91SAM7_PAL AT91SAM7 I/O Ports Support
* @brief I/O Ports peripherals support. * @brief I/O Ports peripherals support.
* @details This module supports the AT91SAM7X PIO controller. The controller * @details This module supports the AT91SAM7 PIO controller. The controller
* supports the following features (see @ref PAL): * supports the following features (see @ref PAL):
* - 32 bits wide ports. * - 32 bits wide ports.
* - Atomic set/reset functions. * - Atomic set/reset functions.
@ -55,31 +55,31 @@
* - Pad/port toggling operations are not atomic. * - Pad/port toggling operations are not atomic.
* - Pad/group mode setup is not atomic. * - Pad/group mode setup is not atomic.
* . * .
* @ingroup AT91SAM7X * @ingroup AT91SAM7
*/ */
/** /**
* @defgroup AT91SAM7X_SERIAL AT91SAM7X USART Support * @defgroup AT91SAM7_SERIAL AT91SAM7 USART Support
* @brief USART peripherals support. * @brief USART peripherals support.
* @details The serial driver supports the AT91SAM7X USART peripherals. * @details The serial driver supports the AT91SAM7 USART peripherals.
* *
* @ingroup AT91SAM7X * @ingroup AT91SAM7
*/ */
/** /**
* @defgroup AT91SAM7X_MAC AT91SAM7X EMAC Support * @defgroup AT91SAM7_MAC AT91SAM7 EMAC Support
* @brief EMAC peripheral support. * @brief EMAC peripheral support.
* @details the @ref MAC supports the AT91SAM7X EMAC peripheral. * @details the @ref MAC supports the AT91SAM7 EMAC peripheral.
* *
* @ingroup AT91SAM7X * @ingroup AT91SAM7
*/ */
/** /**
* @defgroup AT91SAM7X_MII AT91SAM7X MII Support * @defgroup AT91SAM7_MII AT91SAM7 MII Support
* @brief EMAC peripheral support. * @brief EMAC peripheral support.
* @details the @ref MII supports the AT91SAM7X EMAC peripheral communicating * @details the @ref MII supports the AT91SAM7 EMAC peripheral communicating
* with an external PHY transceiver. The driver currently supports * with an external PHY transceiver. The driver currently supports
* only the Micrel KS8721 PHY module. * only the Micrel KS8721 PHY module.
* *
* @ingroup AT91SAM7X * @ingroup AT91SAM7
*/ */

View File

@ -18,9 +18,9 @@
*/ */
/** /**
* @file AT91SAM7X/serial_lld.c * @file AT91SAM7/serial_lld.c
* @brief AT91SAM7X low level serial driver code * @brief AT91SAM7 low level serial driver code
* @addtogroup AT91SAM7X_SERIAL * @addtogroup AT91SAM7_SERIAL
* @{ * @{
*/ */

View File

@ -18,9 +18,9 @@
*/ */
/** /**
* @file AT91SAM7X/serial_lld.h * @file AT91SAM7/serial_lld.h
* @brief AT91SAM7X low level serial driver header * @brief AT91SAM7 low level serial driver header
* @addtogroup AT91SAM7X_SERIAL * @addtogroup AT91SAM7_SERIAL
* @{ * @{
*/ */
@ -120,7 +120,7 @@ struct _serial_driver_data {
}; };
/** /**
* @brief AT91SAM7X Serial Driver configuration structure. * @brief AT91SAM7 Serial Driver configuration structure.
* @details An instance of this structure must be passed to @p sdStart() * @details An instance of this structure must be passed to @p sdStart()
* in order to configure and start a serial driver operations. * in order to configure and start a serial driver operations.
*/ */

View File

@ -93,8 +93,8 @@ bool_t can_lld_can_transmit(CANDriver *canp) {
/** /**
* @brief Inserts a frame into the transmit queue. * @brief Inserts a frame into the transmit queue.
* *
* @param canp[in] pointer to the @p CANDriver object * @param[in] canp pointer to the @p CANDriver object
* @param cfp[in] pointer to the CAN frame to be transmitted * @param[in] cfp pointer to the CAN frame to be transmitted
* *
* @return The operation status. * @return The operation status.
* @retval RDY_OK frame transmitted. * @retval RDY_OK frame transmitted.
@ -121,8 +121,8 @@ bool_t can_lld_can_receive(CANDriver *canp) {
/** /**
* @brief Receives a frame from the input queue. * @brief Receives a frame from the input queue.
* *
* @param canp[in] pointer to the @p CANDriver object * @param[in] canp pointer to the @p CANDriver object
* @param cfp[out] pointer to the buffer where the CAN frame is copied * @param[out] cfp pointer to the buffer where the CAN frame is copied
* *
* @return The operation status. * @return The operation status.
* @retval RDY_OK frame received. * @retval RDY_OK frame received.
@ -136,7 +136,7 @@ msg_t can_lld_receive(CANDriver *canp, CANFrame *cfp) {
/** /**
* @brief Enters the sleep mode. * @brief Enters the sleep mode.
* *
* @param canp[in] pointer to the @p CANDriver object * @param[in] canp pointer to the @p CANDriver object
*/ */
void can_lld_sleep(CANDriver *canp) { void can_lld_sleep(CANDriver *canp) {
@ -145,7 +145,7 @@ void can_lld_sleep(CANDriver *canp) {
/** /**
* @brief Enforces leaving the sleep mode. * @brief Enforces leaving the sleep mode.
* *
* @param canp[in] pointer to the @p CANDriver object * @param[in] canp pointer to the @p CANDriver object
*/ */
void can_lld_wakeup(CANDriver *canp) { void can_lld_wakeup(CANDriver *canp) {