diff options
Diffstat (limited to 'os/hal/src/can.c')
-rw-r--r-- | os/hal/src/can.c | 53 |
1 files changed, 27 insertions, 26 deletions
diff --git a/os/hal/src/can.c b/os/hal/src/can.c index e70c25617..a4da35b8e 100644 --- a/os/hal/src/can.c +++ b/os/hal/src/can.c @@ -18,8 +18,9 @@ */
/**
- * @file CAN.c
- * @brief CAN Driver code.
+ * @file can.c
+ * @brief CAN Driver code.
+ *
* @addtogroup CAN
* @{
*/
@@ -46,7 +47,7 @@ /*===========================================================================*/
/**
- * @brief CAN Driver initialization.
+ * @brief CAN Driver initialization.
*/
void canInit(void) {
@@ -54,7 +55,7 @@ void canInit(void) { }
/**
- * @brief Initializes the standard part of a @p CANDriver structure.
+ * @brief Initializes the standard part of a @p CANDriver structure.
*
* @param[in] canp pointer to the @p CANDriver object
*/
@@ -75,7 +76,7 @@ void canObjectInit(CANDriver *canp) { }
/**
- * @brief Configures and activates the CAN peripheral.
+ * @brief Configures and activates the CAN peripheral.
*
* @param[in] canp pointer to the @p CANDriver object
* @param[in] config pointer to the @p CANConfig object
@@ -101,7 +102,7 @@ void canStart(CANDriver *canp, const CANConfig *config) { }
/**
- * @brief Deactivates the CAN peripheral.
+ * @brief Deactivates the CAN peripheral.
*
* @param[in] canp pointer to the @p CANDriver object
*/
@@ -123,10 +124,10 @@ void canStop(CANDriver *canp) { }
/**
- * @brief Can frame transmission.
+ * @brief Can frame transmission.
* @details The specified frame is queued for transmission, if the hardware
* 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[in] canp pointer to the @p CANDriver object * @param[in] ctfp pointer to the CAN frame to be transmitted @@ -135,10 +136,10 @@ void canStop(CANDriver *canp) { * - @a TIME_IMMEDIATE immediate timeout.
* - @a TIME_INFINITE no timeout.
* .
- * @return The operation result.
- * @retval RDY_OK the frame has been queued for transmission.
- * @retval RDY_TIMEOUT operation not finished within the specified time.
- * @retval RDY_RESET driver stopped while waiting.
+ * @return The operation result.
+ * @retval RDY_OK the frame has been queued for transmission.
+ * @retval RDY_TIMEOUT operation not finished within the specified time.
+ * @retval RDY_RESET driver stopped while waiting.
*/
msg_t canTransmit(CANDriver *canp, const CANTxFrame *ctfp, systime_t timeout) {
@@ -161,9 +162,9 @@ msg_t canTransmit(CANDriver *canp, const CANTxFrame *ctfp, systime_t timeout) { }
/**
- * @brief Can frame receive.
+ * @brief Can frame receive.
* @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[in] canp pointer to the @p CANDriver object
* @param[out] crfp pointer to the buffer where the CAN frame is copied
@@ -174,11 +175,12 @@ msg_t canTransmit(CANDriver *canp, const CANTxFrame *ctfp, systime_t timeout) { * for I/O).
* - @a TIME_INFINITE no timeout.
* .
- * @return The operation result.
- * @retval RDY_OK a frame has been received and placed in the buffer.
- * @retval RDY_TIMEOUT operation not finished within the specified time or
- * frame not immediately available if invoked using @p TIME_IMMEDIATE.
- * @retval RDY_RESET driver stopped while waiting.
+ * @return The operation result.
+ * @retval RDY_OK a frame has been received and placed in the buffer.
+ * @retval RDY_TIMEOUT operation not finished within the specified time or
+ * frame not immediately available if invoked using
+ * @p TIME_IMMEDIATE.
+ * @retval RDY_RESET driver stopped while waiting.
*/
msg_t canReceive(CANDriver *canp, CANRxFrame *crfp, systime_t timeout) {
@@ -201,11 +203,10 @@ msg_t canReceive(CANDriver *canp, CANRxFrame *crfp, systime_t timeout) { }
/**
- * @brief Returns the current status mask and clears it. + * @brief Returns the current status mask and clears it. *
* @param[in] canp pointer to the @p CANDriver object
- *
- * @return The status flags mask.
+ * @return The status flags mask.
*/
canstatus_t canGetAndClearFlags(CANDriver *canp) {
canstatus_t status;
@@ -219,7 +220,7 @@ canstatus_t canGetAndClearFlags(CANDriver *canp) { #if CAN_USE_SLEEP_MODE || defined(__DOXYGEN__)
/**
- * @brief Enters the sleep mode. + * @brief Enters the sleep mode. *
* @param[in] canp pointer to the @p CANDriver object
*/
@@ -241,9 +242,9 @@ void canSleep(CANDriver *canp) { }
/**
- * @brief Enforces leaving the sleep mode.
- * @note The sleep mode is supposed to be usually exited automatically by an
- * hardware event. + * @brief Enforces leaving the sleep mode.
+ * @note The sleep mode is supposed to be usually exited automatically by
+ * an hardware event. *
* @param[in] canp pointer to the @p CANDriver object
*/
|