/**************************************************************************
 *
 *  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 MsgQueues.c
 *
 *  @date 08-Oct-2019
 *  @author S. Nash
 *
 *  @brief MsgQueues service module.  Provides message queue functionality. \n
 *  These queues are NOT thread safe.  However, these queue functions are \n
 *  intended to be called from the General Task thread so no thread safety \n
 *  is required.
 *
 **************************************************************************/

#include <HDCommon.h>
#include "MsgQueues.h"

// ********** private definitions **********

#define MAX_MSG_QUEUE_SIZE          100      // messages

// ********** private data **********

static U32 msgQueueCounts[ NUM_OF_MSG_QUEUES ];
static U32 msgQueueStarts[ NUM_OF_MSG_QUEUES ];
static U32 msgQueueNexts[ NUM_OF_MSG_QUEUES ];
static MESSAGE_WRAPPER_T msgQueues[ NUM_OF_MSG_QUEUES ][ MAX_MSG_QUEUE_SIZE ];

// ********** private function prototypes **********

/*************************************************************************
 * @brief initMsgQueues
 * The initMsgQueues function initializes the MsgQueues module.
 * @details
 * Inputs : none
 * Outputs : none
 * @param none
 * @return none
 *************************************************************************/
void initMsgQueues( void )
{
    U32 q, m;

    // reset message queues
    for ( q = 0; q < NUM_OF_MSG_QUEUES; q++ )
    {
        msgQueueCounts[ q ] = 0;
        msgQueueStarts[ q ] = 0;
        msgQueueNexts[ q ] = 0;
        for ( m = 0; m < MAX_MSG_QUEUE_SIZE; m++ )
        {
            blankMessageInWrapper( &msgQueues[ q ][ m ] );
        }
    }
}

/*************************************************************************
 * @brief addToMsgQueue
 * The addToMsgQueue function adds a message to a given message queue. \n
 * This function should only be called from the General Task.
 * @details
 * Inputs : none
 * Outputs : message added to queue
 * @param queue : the message queue to add to
 * @param msg : a pointer to a message structure to add to the queue
 * @return TRUE if message added to queue, FALSE if could not
 *************************************************************************/
BOOL addToMsgQueue( MSG_QUEUE_T queue, MESSAGE_WRAPPER_T *msg )
{
    BOOL result = FALSE;

    // verify given message queue
    if ( queue < NUM_OF_MSG_QUEUES )
    {
        if ( FALSE == isMsgQueueFull( queue ) )
        {
            result = TRUE;
            // add message to queue
            msgQueues[ queue ][ msgQueueNexts[ queue ] ] = *msg;
            // increment next index to add to
            msgQueueNexts[ queue ] = INC_WRAP( msgQueueNexts[ queue ], 0, MAX_MSG_QUEUE_SIZE - 1 );
            // increment queue count
            msgQueueCounts[ queue ]++;
        }
        else // msg queue is full
        {
            SET_ALARM_WITH_1_U32_DATA( ALARM_ID_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_ADD_QUEUE_FULL )
        }
    }
    else // invalid message queue
    {
        SET_ALARM_WITH_2_U32_DATA( ALARM_ID_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_ADD_INVALID_QUEUE, queue )
    }

    return result;
}

/*************************************************************************
 * @brief getFromMsgQueue
 * The getFromMsgQueue function retrieves the next message from a given \n
 * message queue.  This function should only be called from the General Task.
 * @details
 * Inputs : queue
 * Outputs : message retrieved from the queue
 * @param queue : the message queue to retrieve from
 * @param msg : a pointer to a message structure to populate with the retrieved \n
 * message.
 * @return TRUE if a message was found to retrieve, FALSE if not
 *************************************************************************/
BOOL getFromMsgQueue( MSG_QUEUE_T queue, MESSAGE_WRAPPER_T *msg )
{
    BOOL result = FALSE;

    // verify given message queue
    if ( queue < NUM_OF_MSG_QUEUES )
    {
        if ( FALSE == isMsgQueueEmpty( queue ) )
        {
            result = TRUE;
            // get message from queue
            *msg = msgQueues[ queue ][ msgQueueStarts[ queue ] ];
            // increment queue next index to get from
            msgQueueStarts[ queue ] = INC_WRAP( msgQueueStarts[ queue ], 0, MAX_MSG_QUEUE_SIZE - 1 );
            // decrement queue count
            msgQueueCounts[ queue ]--;
        }
        else // message queue is empty
        {
            // result already set to FALSE
        }
    }
    else // invalid message queue
    {
        SET_ALARM_WITH_2_U32_DATA( ALARM_ID_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_GET_INVALID_QUEUE, queue )
    }

    return result;
}

/*************************************************************************
 * @brief isMsgQueueEmpty
 * The isMsgQueueEmpty function determines whether a given message queue is empty.
 * @details
 * Inputs : none
 * Outputs : none
 * @param queue : the message queue to check
 * @return TRUE if a given message queue is empty, FALSE if not
 *************************************************************************/
BOOL isMsgQueueEmpty( MSG_QUEUE_T queue )
{
    BOOL result = FALSE;

    // verify given message queue
    if ( queue < NUM_OF_MSG_QUEUES )
    {
        if ( msgQueueCounts[ queue ] == 0 )
        {
            result = TRUE;
        }
    }
    else // invalid message queue
    {
        SET_ALARM_WITH_2_U32_DATA( ALARM_ID_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_IS_EMPTY_INVALID_QUEUE, queue )
    }

    return result;
}

/*************************************************************************
 * @brief isMsgQueueFull
 * The isMsgQueueFull function determines whether a given message queue is full.
 * @details
 * Inputs : none
 * Outputs : none
 * @param queue : the message queue to check
 * @return TRUE if the given message queue is full, FALSE if not
 *************************************************************************/
BOOL isMsgQueueFull( MSG_QUEUE_T queue )
{
    BOOL result = TRUE;

    // verify given message queue
    if ( queue < NUM_OF_MSG_QUEUES )
    {
        if ( msgQueueCounts[ queue ] < MAX_MSG_QUEUE_SIZE )
        {
            result = FALSE;
        }
    }
    else // invalid message queue
    {
        SET_ALARM_WITH_2_U32_DATA( ALARM_ID_SOFTWARE_FAULT, SW_FAULT_ID_MSG_QUEUES_IS_FULL_INVALID_QUEUE, queue )
    }

    return result;
}

/*************************************************************************
 * @brief blankMessage
 * The blankMessage function blanks a given message.
 * @details
 * Inputs : none
 * Outputs : none
 * @param message : Pointer to the message to blank.
 * @return none
 *************************************************************************/
void blankMessage( MESSAGE_T *message )
{
    U32 i;
    U32 msgSize = sizeof(MESSAGE_T);
    U08 *msgContent = (U08*)message;

    // zero out the message
    for ( i = 0; i < msgSize; i++ )
    {
        *msgContent++ = 0x0;
    }
}

/*************************************************************************
 * @brief blankMessageInWrapper
 * The blankMessageInWrapper function blanks a given message in a wrapper.
 * @details
 * Inputs : none
 * Outputs : none
 * @param message : Pointer to the message in a wrapper to blank.
 * @return none
 *************************************************************************/
void blankMessageInWrapper( MESSAGE_WRAPPER_T *message )
{
    U32 i;
    U32 msgSize = sizeof(MESSAGE_T);
    U08 *msgContent = (U08*)message;

    // zero out the message
    for ( i = 0; i < msgSize; i++ )
    {
        *msgContent++ = 0x0;
    }

    // set msg ID out of bounds in case blank message goes somewhere
    message->msg.hdr.msgID = 0xFFFF;
}