diff options
author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-11-26 21:19:03 +0000 |
---|---|---|
committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-11-26 21:19:03 +0000 |
commit | 7f06b944cda28d334d790969c6483a11ed3b04d4 (patch) | |
tree | 0f81ea8f067ff36ca59f3652f88772c789ad27b8 /os/io | |
parent | 780110bd2cbfd2adae472c5fcd7e014289559204 (diff) | |
download | ChibiOS-7f06b944cda28d334d790969c6483a11ed3b04d4.tar.gz ChibiOS-7f06b944cda28d334d790969c6483a11ed3b04d4.tar.bz2 ChibiOS-7f06b944cda28d334d790969c6483a11ed3b04d4.zip |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1328 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/io')
-rw-r--r-- | os/io/can.c | 12 | ||||
-rw-r--r-- | os/io/io.dox | 2 | ||||
-rw-r--r-- | os/io/platforms/AT91SAM7X/mac_lld.c | 6 | ||||
-rw-r--r-- | os/io/platforms/AT91SAM7X/mac_lld.h | 6 | ||||
-rw-r--r-- | os/io/platforms/AT91SAM7X/mii_lld.c | 6 | ||||
-rw-r--r-- | os/io/platforms/AT91SAM7X/mii_lld.h | 6 | ||||
-rw-r--r-- | os/io/platforms/AT91SAM7X/pal_lld.c | 6 | ||||
-rw-r--r-- | os/io/platforms/AT91SAM7X/pal_lld.h | 6 | ||||
-rw-r--r-- | os/io/platforms/AT91SAM7X/platform.dox | 30 | ||||
-rw-r--r-- | os/io/platforms/AT91SAM7X/serial_lld.c | 6 | ||||
-rw-r--r-- | os/io/platforms/AT91SAM7X/serial_lld.h | 8 | ||||
-rw-r--r-- | os/io/templates/can_lld.c | 12 |
12 files changed, 53 insertions, 53 deletions
diff --git a/os/io/can.c b/os/io/can.c index 3dd0c99c3..4c88f9c71 100644 --- a/os/io/can.c +++ b/os/io/can.c @@ -98,8 +98,8 @@ void canStop(CANDriver *canp) { * queue is full then the invoking thread is queued.
* @note Trying to transmit while in sleep mode simply enqueues the thread.
* - * @param canp[in] pointer to the @p CANDriver object - * @param cfp[in] pointer to the CAN frame to be transmitted + * @param[in] canp pointer to the @p CANDriver object + * @param[in] cfp pointer to the CAN frame to be transmitted * @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed:
* - @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.
* @note Trying to receive while in sleep mode simply enqueues the thread.
*
- * @param canp[in] pointer to the @p CANDriver object
- * @param cfp[out] pointer to the buffer where the CAN frame is copied
+ * @param[in] canp pointer to the @p CANDriver object
+ * @param[out] cfp pointer to the buffer where the CAN frame is copied
* @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed:
* - @a TIME_IMMEDIATE immediate timeout.
@@ -173,7 +173,7 @@ msg_t canReceive(CANDriver *canp, CANFrame *cfp, systime_t timeout) { /**
* @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) {
@@ -197,7 +197,7 @@ void canSleep(CANDriver *canp) { * @note The sleep mode is supposed to be usually exited automatically by an
* hardware event. *
- * @param canp[in] pointer to the @p CANDriver object
+ * @param[in] canp pointer to the @p CANDriver object
*/
void canWakeup(CANDriver *canp) {
diff --git a/os/io/io.dox b/os/io/io.dox index 0fd14786b..ea90d8ff6 100644 --- a/os/io/io.dox +++ b/os/io/io.dox @@ -50,7 +50,7 @@ * - @ref ADC.
* - @ref MAC.
* - @ref MII.
- * - @ref MMC.
+ * - @ref MMC_SPI.
* .
*/
diff --git a/os/io/platforms/AT91SAM7X/mac_lld.c b/os/io/platforms/AT91SAM7X/mac_lld.c index 85d2812e8..fea915ede 100644 --- a/os/io/platforms/AT91SAM7X/mac_lld.c +++ b/os/io/platforms/AT91SAM7X/mac_lld.c @@ -18,9 +18,9 @@ */
/**
- * @file AT91SAM7X/mac_lld.c
- * @brief AT91SAM7X low level MAC driver code
- * @addtogroup AT91SAM7X_MAC
+ * @file AT91SAM7/mac_lld.c
+ * @brief AT91SAM7 low level MAC driver code
+ * @addtogroup AT91SAM7_MAC
* @{
*/
diff --git a/os/io/platforms/AT91SAM7X/mac_lld.h b/os/io/platforms/AT91SAM7X/mac_lld.h index 60780a65b..5184be954 100644 --- a/os/io/platforms/AT91SAM7X/mac_lld.h +++ b/os/io/platforms/AT91SAM7X/mac_lld.h @@ -18,9 +18,9 @@ */
/**
- * @file AT91SAM7X/mac_lld.h
- * @brief AT91SAM7X low level MAC driver header
- * @addtogroup AT91SAM7X_MAC
+ * @file AT91SAM7/mac_lld.h
+ * @brief AT91SAM7 low level MAC driver header
+ * @addtogroup AT91SAM7_MAC
* @{
*/
diff --git a/os/io/platforms/AT91SAM7X/mii_lld.c b/os/io/platforms/AT91SAM7X/mii_lld.c index c4f3ac3eb..3662979fb 100644 --- a/os/io/platforms/AT91SAM7X/mii_lld.c +++ b/os/io/platforms/AT91SAM7X/mii_lld.c @@ -18,9 +18,9 @@ */
/**
- * @file AT91SAM7X/mii_lld.c
- * @brief AT91SAM7X low level MII driver code
- * @addtogroup AT91SAM7X_MII
+ * @file AT91SAM7/mii_lld.c
+ * @brief AT91SAM7 low level MII driver code
+ * @addtogroup AT91SAM7_MII
* @{
*/
diff --git a/os/io/platforms/AT91SAM7X/mii_lld.h b/os/io/platforms/AT91SAM7X/mii_lld.h index 7f052720f..0e2f4ca51 100644 --- a/os/io/platforms/AT91SAM7X/mii_lld.h +++ b/os/io/platforms/AT91SAM7X/mii_lld.h @@ -18,9 +18,9 @@ */
/**
- * @file AT91SAM7X/mii_lld.h
- * @brief AT91SAM7X low level MII driver header
- * @addtogroup AT91SAM7X_MII
+ * @file AT91SAM7/mii_lld.h
+ * @brief AT91SAM7 low level MII driver header
+ * @addtogroup AT91SAM7_MII
* @{
*/
diff --git a/os/io/platforms/AT91SAM7X/pal_lld.c b/os/io/platforms/AT91SAM7X/pal_lld.c index 2eb13c7d2..9545c976c 100644 --- a/os/io/platforms/AT91SAM7X/pal_lld.c +++ b/os/io/platforms/AT91SAM7X/pal_lld.c @@ -18,9 +18,9 @@ */
/**
- * @file AT91SAM7X/pal_lld.c
- * @brief AT91SAM7X PIO low level driver code
- * @addtogroup AT91SAM7X_PAL
+ * @file AT91SAM7/pal_lld.c
+ * @brief AT91SAM7 PIO low level driver code
+ * @addtogroup AT91SAM7_PAL
* @{
*/
diff --git a/os/io/platforms/AT91SAM7X/pal_lld.h b/os/io/platforms/AT91SAM7X/pal_lld.h index 3797ba51c..950f3a52f 100644 --- a/os/io/platforms/AT91SAM7X/pal_lld.h +++ b/os/io/platforms/AT91SAM7X/pal_lld.h @@ -18,9 +18,9 @@ */
/**
- * @file AT91SAM7X/pal_lld.h
- * @brief AT91SAM7X PIO low level driver header
- * @addtogroup AT91SAM7X_PAL
+ * @file AT91SAM7/pal_lld.h
+ * @brief AT91SAM7 PIO low level driver header
+ * @addtogroup AT91SAM7_PAL
* @{
*/
diff --git a/os/io/platforms/AT91SAM7X/platform.dox b/os/io/platforms/AT91SAM7X/platform.dox index 2a2aa4a47..60940201d 100644 --- a/os/io/platforms/AT91SAM7X/platform.dox +++ b/os/io/platforms/AT91SAM7X/platform.dox @@ -18,9 +18,9 @@ */
/**
- * @defgroup AT91SAM7X AT91SAM7X Support
- * @brief AT91SAM7X specific support.
- * @details The AT91SAM7X support includes:
+ * @defgroup AT91SAM7 AT91SAM7 Support
+ * @brief AT91SAM7 specific support.
+ * @details The AT91SAM7 support includes:
* - Buffered, interrupt driven, serial driver.
* - EMAC driver with MII support.
* - 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.
- * @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):
* - 32 bits wide ports.
* - Atomic set/reset functions.
@@ -55,31 +55,31 @@ * - Pad/port toggling operations are 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.
- * @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.
- * @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.
- * @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
* only the Micrel KS8721 PHY module.
*
- * @ingroup AT91SAM7X
+ * @ingroup AT91SAM7
*/
diff --git a/os/io/platforms/AT91SAM7X/serial_lld.c b/os/io/platforms/AT91SAM7X/serial_lld.c index d22f82986..91a0558c0 100644 --- a/os/io/platforms/AT91SAM7X/serial_lld.c +++ b/os/io/platforms/AT91SAM7X/serial_lld.c @@ -18,9 +18,9 @@ */
/**
- * @file AT91SAM7X/serial_lld.c
- * @brief AT91SAM7X low level serial driver code
- * @addtogroup AT91SAM7X_SERIAL
+ * @file AT91SAM7/serial_lld.c
+ * @brief AT91SAM7 low level serial driver code
+ * @addtogroup AT91SAM7_SERIAL
* @{
*/
diff --git a/os/io/platforms/AT91SAM7X/serial_lld.h b/os/io/platforms/AT91SAM7X/serial_lld.h index 184f13186..cc16d1122 100644 --- a/os/io/platforms/AT91SAM7X/serial_lld.h +++ b/os/io/platforms/AT91SAM7X/serial_lld.h @@ -18,9 +18,9 @@ */
/**
- * @file AT91SAM7X/serial_lld.h
- * @brief AT91SAM7X low level serial driver header
- * @addtogroup AT91SAM7X_SERIAL
+ * @file AT91SAM7/serial_lld.h
+ * @brief AT91SAM7 low level serial driver header
+ * @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()
* in order to configure and start a serial driver operations.
*/
diff --git a/os/io/templates/can_lld.c b/os/io/templates/can_lld.c index 4fc0ae7d0..e1c4243b0 100644 --- a/os/io/templates/can_lld.c +++ b/os/io/templates/can_lld.c @@ -93,8 +93,8 @@ bool_t can_lld_can_transmit(CANDriver *canp) { /**
* @brief Inserts a frame into the transmit queue.
* - * @param canp[in] pointer to the @p CANDriver object
- * @param cfp[in] pointer to the CAN frame to be transmitted
+ * @param[in] canp pointer to the @p CANDriver object
+ * @param[in] cfp pointer to the CAN frame to be transmitted
*
* @return The operation status.
* @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.
* - * @param canp[in] pointer to the @p CANDriver object
- * @param cfp[out] pointer to the buffer where the CAN frame is copied
+ * @param[in] canp pointer to the @p CANDriver object
+ * @param[out] cfp pointer to the buffer where the CAN frame is copied
*
* @return The operation status.
* @retval RDY_OK frame received.
@@ -136,7 +136,7 @@ msg_t can_lld_receive(CANDriver *canp, CANFrame *cfp) { /**
* @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) {
@@ -145,7 +145,7 @@ void can_lld_sleep(CANDriver *canp) { /**
* @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) {
|