/**************************************************************************
 *
 *  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 .
 *
 **************************************************************************/

#ifndef __COMM_BUFFERS_H__
#define __COMM_BUFFERS_H__

#include "../HDCommon.h"

// ********** public definitions **********

typedef enum Comm_Buffers
{
    COMM_BUFFER_NOT_USED = 0,           // CAN message boxes start at 1
    COMM_BUFFER_OUT_CAN_HD_ALARM,
    COMM_BUFFER_IN_CAN_DG_ALARM,
    COMM_BUFFER_IN_CAN_UI_ALARM,
    COMM_BUFFER_OUT_CAN_HD_2_DG,
    COMM_BUFFER_IN_CAN_DG_2_HD,
    COMM_BUFFER_OUT_CAN_HD_2_UI,
    COMM_BUFFER_OUT_CAN_HD_BROADCAST,
    COMM_BUFFER_IN_CAN_DG_BROADCAST,
    COMM_BUFFER_IN_CAN_UI_2_HD,
    COMM_BUFFER_IN_CAN_UI_BROADCAST,
    COMM_BUFFER_IN_CAN_PC,
    COMM_BUFFER_OUT_CAN_PC,
    COMM_BUFFER_IN_UART_PC,
    COMM_BUFFER_OUT_UART_PC,
    NUM_OF_COMM_BUFFERS
} COMM_BUFFER_T;

// ********** public function prototypes **********

void initCommBuffers( void );
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