/**************************************************************************
*
* 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    FpgaRO.h
*
* @author  (last)      Sean Nash
* @date    (last)      09-Nov-2024
*
* @author  (original)  Sean Nash
* @date    (original)  09-Nov-2024
*
***************************************************************************/

#ifndef __FPGA_RO_H__
#define __FPGA_RO_H__

#include "ROCommon.h"
#include "FPGA.h"

/**
 *  @defgroup FpgaRO FpgaRO
 *  @brief FPGA service unit for RO firmware.
 *  The FPGA unit contains get/set functions for the RO FPGA registers.
 *
 *  @addtogroup FpgaRO
 *  @{
 */

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

#define MAX_RO_PUMP_PWM                     100U                                ///< Maximum RO pump PWM duty cycle percentage.

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

void initFPGARO( void );

void checkFPGACommFailure( void );
BOOL checkFPGAFEOEFailure( void );

void setFPGAValveStates( U16 valveStates );
U08  getFPGAValveStates( void );

void setROPumpPWMPct( U16 pwm );
U16  getROPumpPWMPct( void );
U16  getROPumpTachCount( void );

/**@}*/

#endif