Index: firmware/App/Services/CommBuffers.h =================================================================== diff -u -rf2652e85c8676d0356fea2690cfd9cac716ca795 -rc74c1d99a011dd0fb7f98f183faecda675221fce --- firmware/App/Services/CommBuffers.h (.../CommBuffers.h) (revision f2652e85c8676d0356fea2690cfd9cac716ca795) +++ firmware/App/Services/CommBuffers.h (.../CommBuffers.h) (revision c74c1d99a011dd0fb7f98f183faecda675221fce) @@ -1,25 +1,33 @@ -/* - * CommBuffers.h - * - * Created on: Aug 2, 2024 - * Author: fw - */ #ifndef __COMMBUFFERS_H__ #define __COMMBUFFERS_H__ #include "BLCommon.h" +/** + * @defgroup CommBuffers CommBuffers + * @brief The communication buffers unit provides buffering services for + * incoming and outgoing CAN data. A separate buffer is provided for each + * CAN ID (channel) so that frame order is maintained for a given channel. + * + * @addtogroup CommBuffers + * @{ + */ + +// ********** public definitions ********** + +// ********** public function prototypes ********** + void initCommBuffers( void ); -void handleCANMsgInterrupt( SW_UPDATE_CAN_MAIL_BOXES_T MailBox ); +BOOL addToCommBuffer( SW_UPDATE_CAN_MAIL_BOX_T mailBox, U08* data, U32 len ); -void getSWUpdateBufferStatus( SW_UPDATE_BUFFER_STATUS_T* status ); +BOOL getCommBuffer( SW_UPDATE_CAN_MAIL_BOX_T mailBox, U08* data, U32 len ); -void getSWUpdateBuffer( U08* data ); +S32 getNumberOfBytesInBuffer( SW_UPDATE_CAN_MAIL_BOX_T mailBox ); -void sendAckNackStatusFromFirmware( ACK_NACK_STATUS_T status, BOOL cmd ); +void clearCommBuffer( SW_UPDATE_CAN_MAIL_BOX_T mailBox ); -void clearSWUpdateBuffer( BOOL cmd ); +/**@}*/ #endif