Index: firmware/App/Services/CommBuffers.h =================================================================== diff -u -rb64c49fdcf2b6d95e61e63f8e258c4e600935bbd -r7d4711edd7b40cd3e29f43e766f79a8a09586fe9 --- firmware/App/Services/CommBuffers.h (.../CommBuffers.h) (revision b64c49fdcf2b6d95e61e63f8e258c4e600935bbd) +++ firmware/App/Services/CommBuffers.h (.../CommBuffers.h) (revision 7d4711edd7b40cd3e29f43e766f79a8a09586fe9) @@ -1,52 +1,65 @@ -/************************************************************************** - * - * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. - * - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN - * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. - * - * @file CommBuffers.h - * - * @date 08-Oct-2019 - * @author S. Nash - * - * @brief header file for Communication Buffers service . - * - **************************************************************************/ +/************************************************************************** +* +* Copyright (c) 2019-2024 Diality Inc. - All Rights Reserved. +* +* THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN +* WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. +* +* @file CommBuffers.h +* +* @author (last) Sean Nash +* @date (last) 02-Dec-2021 +* +* @author (original) Dara Navaei +* @date (original) 05-Nov-2019 +* +***************************************************************************/ #ifndef __COMM_BUFFERS_H__ #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, -#ifdef DEBUG_ENABLED - COMM_BUFFER_IN_UART_PC, - COMM_BUFFER_OUT_UART_PC, -#endif - NUM_OF_COMM_BUFFERS + 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_2_UI, ///< Transmitting buffer for DG to UI communication via CAN + COMM_BUFFER_OUT_CAN_DG_BROADCAST, ///< Transmitting buffer for DG broadcast communication via CAN + COMM_BUFFER_IN_CAN_UI_2_DG, ///< Receiving buffer for UI to DG 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_LAST_CAN_BUFFER = COMM_BUFFER_OUT_CAN_PC, ///< Last CAN communication buffer + NUM_OF_COMM_BUFFERS ///< The number of communication buffers } COMM_BUFFER_T; // ********** public function prototypes ********** void initCommBuffers( void ); +void clearBuffer( COMM_BUFFER_T buffer ); BOOL addToCommBuffer( COMM_BUFFER_T buffer, U08 *data, U32 len ); 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