/**************************************************************************
*
* Copyright (c) 2024-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    CpldIO.h
*
* @author  (last)      Sean
* @date    (last)      07-Aug-2024
*
* @author  (original)  Sean
* @date    (original)  07-Aug-2024
*
***************************************************************************/

#ifndef __CPLD_IO_H__
#define __CPLD_IO_H__

#include "TDCommon.h"

/**
 *  @defgroup CPLD_IO CPLD_IO
 *  @brief The CPLD IO module provides definitions and GPIO pin access macros
 *  to provide low-level GPIO interface to CPLD.
 *
 *  @addtogroup CPLD_IO
 *  @{
 */

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

// GIO port A pin assignments for pins connected to CPLD
#define OFF_BUTTON_GIO_PORT_PIN     0U                      ///< GPIO pin ID on port A for off button input signal.
#define STOP_BUTTON_GIO_PORT_PIN    1U                      ///< GPIO pin ID on port A for stop button input signal.
#define SAFETY_GIO_PORT_PIN         3U                      ///< GPIO pin ID on port A for safety shutdown output signal

// GIO port B pin assignments for pins connected to CPLD
#define OFF_REQUEST_GIO_PORT_PIN    0U                      ///< GPIO pin ID on port B for power off request output signal.
#define WD_PET_GIO_PORT_PIN         1U                      ///< GPIO pin ID on port B for watchdog pet output signal.
#define WD_EXP_GIO_PORT_PIN         2U                      ///< GPIO pin ID on port B for watchdog expired input signal.

// MIBSPI5 port pin assignments for pins connected to CPLD
#define GREEN_SPI5_PORT_MASK        0x00000200              ///< (CLK     - re-purposed as output GPIO) for green alarm lamp signal.
#define BLUE_SPI5_PORT_MASK         0x00000400              ///< (SIMO[0] - re-purposed as output GPIO) for blue alarm lamp signal.
#define RED_SPI5_PORT_MASK          0x00000800              ///< (SOMI[0] - re-purposed as output GPIO) for red alarm lamp signal.
#define AC_PRESENT_SPI5_PORT_MASK   0x00000001              ///< (SOMI[0] - re-purposed as output GPIO) for red alarm lamp signal.

// CPLD pin I/O macros
#define GET_OFF()          (PIN_SIGNAL_STATE_T)(gioGetBit(gioPORTA, OFF_BUTTON_GIO_PORT_PIN))   ///< Macro to get off button signal state.
#define GET_STOP()         (PIN_SIGNAL_STATE_T)(gioGetBit(gioPORTA, STOP_BUTTON_GIO_PORT_PIN))  ///< Macro to get stop button signal state.
#define GET_WD_EXP()       (PIN_SIGNAL_STATE_T)(gioGetBit(gioPORTB, WD_EXP_GIO_PORT_PIN))       ///< Macro to get watchdog expired signal state.
#define GET_AC_PRESENT()   (PIN_SIGNAL_STATE_T)(mibspiREG5->PC2 & AC_PRESENT_SPI5_PORT_MASK)    ///< Macro to get A/C power present signal state.

#define TGL_WD_PET()       gioToggleBit( gioPORTB, WD_PET_GIO_PORT_PIN )                        ///< Macro to toggle watchdog pet signal state.
#define TGL_OFF_REQ()      gioToggleBit( gioPORTB, OFF_REQUEST_GIO_PORT_PIN)                    ///< Macro to toggle power off request signal state.
#define SET_WD_PET()       gioSetBit( gioPORTB, WD_PET_GIO_PORT_PIN, PIN_SIGNAL_HIGH )          ///< Macro to set watchdog pet signal state high.
#define SET_OFF_REQ()      gioSetBit( gioPORTB, OFF_REQUEST_GIO_PORT_PIN, PIN_SIGNAL_HIGH )     ///< Macro to set power off request signal state high.
#define SET_GREEN()        {mibspiREG5->PC3 |= GREEN_SPI5_PORT_MASK;}                           ///< Macro to set green alarm lamp signal state high.
#define SET_BLUE()         {mibspiREG5->PC3 |= BLUE_SPI5_PORT_MASK;}                            ///< Macro to set blue alarm lamp signal state high.
#define SET_RED()          {mibspiREG5->PC3 |= RED_SPI5_PORT_MASK;}                             ///< Macro to set red alarm lamp signal state high.

#define CLR_WD_PET()       gioSetBit( gioPORTB, WD_PET_GIO_PORT_PIN, PIN_SIGNAL_LOW )           ///< Macro to set watchdog pet signal state low.
#define CLR_OFF_REQ()      gioSetBit( gioPORTB, OFF_REQUEST_GIO_PORT_PIN, PIN_SIGNAL_LOW )      ///< Macro to set power off request signal state low.
#define CLR_GREEN()        {mibspiREG5->PC3 &= ~GREEN_SPI5_PORT_MASK;}                          ///< Macro to set green alarm lamp signal state low.
#define CLR_BLUE()         {mibspiREG5->PC3 &= ~BLUE_SPI5_PORT_MASK;}                           ///< Macro to set blue alarm lamp signal state low.
#define CLR_RED()          {mibspiREG5->PC3 &= ~RED_SPI5_PORT_MASK;}                            ///< Macro to set red alarm lamp signal state low.

// CPLD pin I/O macros
#define SET_SAFETY_SHUTDOWN()               gioSetBit( gioPORTB, SAFETY_GIO_PORT_PIN, PIN_SIGNAL_HIGH )
#define CLR_SAFETY_SHUTDOWN()               gioSetBit( gioPORTB, SAFETY_GIO_PORT_PIN, PIN_SIGNAL_LOW )

/**@}*/

#endif