/**************************************************************************
 *
 *  Copyright (c) 2019-2019 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 FPGA.c
 *
 *  @date 22-Oct-2019
 *  @author S. Nash
 *
 *  @brief Communications Interrupts service module.  Provides communication \n
 *  interrupt handling functions.
 *
 **************************************************************************/

#include "can.h"
#include "sci.h"
#include "sys_dma.h"

#include "CommInterrupts.h"
#include "FPGA.h"
#include "SystemComm.h"

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


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

static U32 frameErrorCnt = 0;
static U32 overrunErrorCnt = 0;


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


/*************************************************************************
 * @brief canMessageNotification
 * The canMessageNotification function handles CAN message notifications.
 * @details
 * Inputs : none
 * Outputs : CAN message notification handled.
 * @param node : which CAN controller
 * @param messageBox : which message box triggered the message notification
 * @return none
 *************************************************************************/
void canMessageNotification(canBASE_t *node, uint32 messageBox)
{
    handleCANMsgInterrupt( (CAN_MESSAGE_BOX_T)messageBox );
}

/*************************************************************************
 * @brief sciNotification
 * The sciNotification function handles UART communication error interrupts. \n
 * Frame and Over-run errors are handled.
 * @details
 * Inputs : none
 * Outputs : UART error interrupts handled.
 * @param sci : Pointer to the SCI peripheral that detected the error
 * @param flags : error flag(s)
 * @return none
 *************************************************************************/
void sciNotification(sciBASE_t *sci, uint32 flags)
{
    if ( ( flags & SCI_FE_INT ) != 0 )
    {
        frameErrorCnt++;
    }
    if ( ( flags & SCI_OE_INT ) != 0 )
    {
        overrunErrorCnt++;
    }
}

/*************************************************************************
 * @brief dmaGroupANotification
 * The dmaGroupANotification function handles communication DMA interrupts.
 * @details
 * Inputs : none
 * Outputs : DMA interrupt is handled.
 * @param inttype : type of DMA interrupt
 * @param channel : DMA channel that caused the interrupt
 * @return none
 *************************************************************************/
void dmaGroupANotification(dmaInterrupt_t inttype, uint32 channel)
{
    if ( inttype == BTC )  // block transfer completed interrupt
    {
        switch ( channel )
        {
            case DMA_CH0:  // FPGA receive channel
                // clear DMA receipt
                scilinREG->CLEARINT = SCI_DMA_RECEIVE_INT;
                signalFPGAReceiptCompleted();
                break;

            case DMA_CH1:  // PC receive channel
                // clear DMA receipt
                sciREG->CLEARINT = SCI_DMA_RECEIVE_INT;
                // handle received packet from PC
                handleUARTMsgRecvPacketInterrupt();
                break;

            case DMA_CH2:  // FPGA transmit channel
                // clear DMA xmit
                scilinREG->CLEARINT = SCI_DMA_TRANSMIT_INT;
                signalFPGATransmitCompleted();
                break;

            case DMA_CH3:  // PC transmit channel
                // clear DMA xmit
                sciREG->CLEARINT = SCI_DMA_TRANSMIT_INT;
                // send next pending packet to PC (if any)
                handleUARTMsgXmitPacketInterrupt();
                break;

            default:
                // TODO - ignore?
                break;
        }
    }
}