Index: firmware/App/Services/SystemComm.c =================================================================== diff -u -re8511af1e4e9d91cfd3378471869fb0246110870 -rc74c1d99a011dd0fb7f98f183faecda675221fce --- firmware/App/Services/SystemComm.c (.../SystemComm.c) (revision e8511af1e4e9d91cfd3378471869fb0246110870) +++ firmware/App/Services/SystemComm.c (.../SystemComm.c) (revision c74c1d99a011dd0fb7f98f183faecda675221fce) @@ -1,21 +1,40 @@ -/* - * SysComm.c - * - * Created on: Aug 20, 2024 - * Author: fw - */ #include "can.h" #include "CommBuffers.h" #include "SystemComm.h" +/** + * @addtogroup SystemComm + * @{ + */ +// ********** private definitions ********** + +/*********************************************************************//** + * @brief + * The initSystemComm function initializes the SystemComm unit. + * @details \b Inputs: none + * @details \b Outputs: SystemComm unit variables initialized. + * @return none + *************************************************************************/ void initSystemComm( void ) { } +/*********************************************************************//** + * @brief + * The handleCANMsgInterrupt function handles a CAN frame interrupt from + * a given CAN mail box. + * This may have occurred because a CAN frame transmission has completed + * or because a CAN frame has been received. The appropriate handler is + * called. + * @details \b Inputs: none + * @details \b Outputs: message interrupt handled + * @param mailbox which CAN mail box triggered this interrupt + * @return none + *************************************************************************/ void handleCANMsgInterrupt( SW_UPDATE_CAN_MAIL_BOX_T mailBox ) { // TODO do we need check the range of the messages? @@ -52,6 +71,15 @@ } } +/*********************************************************************//** + * @brief + * The sendAckNackStatusFromFirmware function sends the ack or nack status + * of a received message. + * @details \b Inputs: none + * @details \b Outputs: none + * @param data pointer to the data to be sent + * @return TRUE if the CAN transmit was successful otherwise, FALSE + *************************************************************************/ BOOL sendAckNackStatusFromFirmware( U08* data ) { BOOL status = FALSE; @@ -64,10 +92,12 @@ return status; } -BOOL broadcastDataTestRemove( U08* data ) +BOOL broadcastDataTestRemove( U08* data ) // TODO remove { canTransmit( canREG1, (U32)SW_TEST, data ); return TRUE; } +/**@}*/ +