Index: firmware/App/Services/CommBuffers.h =================================================================== diff -u -rdc0d9b087c609e71cacdb7f0395cccf29d749c00 -r5e0cd9b5be11ff4b2acaadbdcafc4ffe05172aa1 --- firmware/App/Services/CommBuffers.h (.../CommBuffers.h) (revision dc0d9b087c609e71cacdb7f0395cccf29d749c00) +++ firmware/App/Services/CommBuffers.h (.../CommBuffers.h) (revision 5e0cd9b5be11ff4b2acaadbdcafc4ffe05172aa1) @@ -19,29 +19,39 @@ #define __COMM_BUFFERS_H__ #include "DGCommon.h" + +/** + * @defgroup CommBuffers CommBuffers + * @brief Communication buffers service module. Provides communication buffers functionality + * including support functions for adding and clearing communication buffer. + * + * @addtogroup CommBuffers + * @{ + */ -// ********** public definitions ********** - +// ********** public definitions ********** + +/// List of comm buffers. typedef enum Comm_Buffers { - COMM_BUFFER_NOT_USED = 0, // CAN message boxes start at 1 - COMM_BUFFER_IN_CAN_HD_ALARM, - COMM_BUFFER_OUT_CAN_DG_ALARM, - COMM_BUFFER_IN_CAN_UI_ALARM, - COMM_BUFFER_IN_CAN_HD_2_DG, - COMM_BUFFER_OUT_CAN_DG_2_HD, - COMM_BUFFER_IN_CAN_HD_BROADCAST, - COMM_BUFFER_OUT_CAN_DG_BROADCAST, - COMM_BUFFER_IN_CAN_UI_BROADCAST, - COMM_BUFFER_IN_CAN_PC, - COMM_BUFFER_OUT_CAN_PC, - COMM_BUFFER_OUT_CAN_DG_2_UI, - COMM_BUFFER_LAST_CAN_BUFFER = COMM_BUFFER_OUT_CAN_DG_2_UI, + COMM_BUFFER_NOT_USED = 0, ///< Unused buffer - CAN message boxes start at 1 + COMM_BUFFER_IN_CAN_HD_ALARM, ///< Receiving buffer for HD alarm via CAN + COMM_BUFFER_OUT_CAN_DG_ALARM, ///< Transmitting buffer for DG alarm via CAN + COMM_BUFFER_IN_CAN_UI_ALARM, ///< Receiving buffer for UI alarm via CAN + COMM_BUFFER_IN_CAN_HD_2_DG, ///< Receiving buffer for HD to DG communication via CAN + COMM_BUFFER_OUT_CAN_DG_2_HD, ///< Transmitting buffer for DG to HD communication via CAN + COMM_BUFFER_IN_CAN_HD_BROADCAST, ///< Receiving buffer for HD broadcast communication via CAN + COMM_BUFFER_OUT_CAN_DG_BROADCAST, ///< Transmitting buffer for DG broadcast communication via CAN + COMM_BUFFER_IN_CAN_UI_BROADCAST, ///< Receiving buffer for UI broadcast communication via CAN + COMM_BUFFER_IN_CAN_PC, ///< Receiving buffer for PC communication via CAN + COMM_BUFFER_OUT_CAN_PC, ///< Transmitting buffer for PC communication via CAN + COMM_BUFFER_OUT_CAN_DG_2_UI, ///< Transmitting buffer for DG to UI communication via CAN + COMM_BUFFER_LAST_CAN_BUFFER = COMM_BUFFER_OUT_CAN_DG_2_UI, ///< Last CAN communication buffer #ifdef DEBUG_ENABLED - COMM_BUFFER_IN_UART_PC, - COMM_BUFFER_OUT_UART_PC, + COMM_BUFFER_IN_UART_PC, ///< Receiving buffer for PC communication via UART + COMM_BUFFER_OUT_UART_PC, ///< Transmitting buffer for PC communication via UART #endif - NUM_OF_COMM_BUFFERS + NUM_OF_COMM_BUFFERS ///< The number of communication buffers } COMM_BUFFER_T; // ********** public function prototypes ********** @@ -52,5 +62,7 @@ U32 getFromCommBuffer( COMM_BUFFER_T buffer, U08 *data, U32 len ); U32 peekFromCommBuffer( COMM_BUFFER_T buffer, U08 *data, U32 len ); U32 numberOfBytesInCommBuffer( COMM_BUFFER_T buffer ); + +/**@}*/ #endif