diff options
Diffstat (limited to 'os/hal/templates/can_lld.c')
-rw-r--r-- | os/hal/templates/can_lld.c | 45 |
1 files changed, 22 insertions, 23 deletions
diff --git a/os/hal/templates/can_lld.c b/os/hal/templates/can_lld.c index f1945c350..3d3897e3d 100644 --- a/os/hal/templates/can_lld.c +++ b/os/hal/templates/can_lld.c @@ -18,8 +18,9 @@ */
/**
- * @file templates/can_lld.c
- * @brief CAN Driver subsystem low level driver source template.
+ * @file templates/can_lld.c
+ * @brief CAN Driver subsystem low level driver source template.
+ *
* @addtogroup CAN_LLD
* @{
*/
@@ -50,25 +51,25 @@ /*===========================================================================*/
/**
- * @brief Low level CAN driver initialization.
+ * @brief Low level CAN driver initialization.
*/
void can_lld_init(void) {
}
/**
- * @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] canp pointer to the @p CANDriver object
*/
void can_lld_start(CANDriver *canp) {
}
/**
- * @brief Deactivates the CAN peripheral.
+ * @brief Deactivates the CAN peripheral.
*
- * @param[in] canp pointer to the @p CANDriver object
+ * @param[in] canp pointer to the @p CANDriver object
*/
void can_lld_stop(CANDriver *canp) {
@@ -80,13 +81,12 @@ void can_lld_stop(CANDriver *canp) { /**
- * @brief Determines whether a frame can be transmitted.
+ * @brief Determines whether a frame can be transmitted.
* - * @param[in] canp pointer to the @p CANDriver object
- *
- * @return The queue space availability.
- * @retval FALSE no space in the transmit queue.
- * @retval TRUE transmit slot available. + * @param[in] canp pointer to the @p CANDriver object
+ * @return The queue space availability.
+ * @retval FALSE no space in the transmit queue.
+ * @retval TRUE transmit slot available. */
bool_t can_lld_can_transmit(CANDriver *canp) {
@@ -94,7 +94,7 @@ 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[in] canp pointer to the @p CANDriver object
* @param[in] ctfp pointer to the CAN frame to be transmitted
@@ -104,13 +104,12 @@ void can_lld_transmit(CANDriver *canp, const CANTxFrame *ctfp) { }
/**
- * @brief Determines whether a frame has been received.
- *
- * @param[in] canp pointer to the @p CANDriver object
+ * @brief Determines whether a frame has been received.
*
- * @return The queue space availability.
- * @retval FALSE no space in the transmit queue.
- * @retval TRUE transmit slot available.
+ * @param[in] canp pointer to the @p CANDriver object
+ * @return The queue space availability.
+ * @retval FALSE no space in the transmit queue.
+ * @retval TRUE transmit slot available.
*/
bool_t can_lld_can_receive(CANDriver *canp) {
@@ -118,7 +117,7 @@ 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[in] canp pointer to the @p CANDriver object
* @param[out] crfp pointer to the buffer where the CAN frame is copied
@@ -129,7 +128,7 @@ void can_lld_receive(CANDriver *canp, CANRxFrame *crfp) { #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
*/
@@ -138,7 +137,7 @@ void can_lld_sleep(CANDriver *canp) { }
/**
- * @brief Enforces leaving the sleep mode.
+ * @brief Enforces leaving the sleep mode.
*
* @param[in] canp pointer to the @p CANDriver object
*/
|