modHsb.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025, TUSAS Malaysia
 * All rights reserved. 
 * This file contains proprietary information. This
 * file shall not be duplicated, used, modified,
 * or disclosed in whole or in part without
 * the express written consent of TUSAS.
 */

 
#ifndef INCLUDED_MOD_HSB_H
#define INCLUDED_MOD_HSB_H
 
#include "commonDataTypes.h"
#include "modStatus.h"
#include "modConfig.h"
#include "modHsbCommon.h"

typedef enum
{
   BIT_OK = 1U, 
   BIT_FAULT = 0U 
} BITState;

typedef enum
{
   DO_CH_DISABLE = 0x00U, 
   DO_CH_OVERCURRENT = 0x01U, 
   DO_CH_UNDERLOAD = 0x02U, 
   DO_CH_ENABLE = 0x03U 
} DOutChannelState;

typedef enum
{
   PWM_CH_DISABLE = 0x00U, 
   PWM_CH_OVERCURRENT = 0x01U, 
   PWM_CH_UNDERLOAD = 0x02U, 
   PWM_CH_ENABLE = 0x03U 
} PwmChannelState;

typedef enum
{
   HSB_PSU_NORMAL = 0x01U, 
   HSB_PSU_LOWER_NON_CRITICAL, 
   HSB_PSU_LOWER_CRITICAL, 
   HSB_PSU_LOWER_NON_RECOVERABLE, 
   HSB_PSU_UPPER_NON_CRITICAL, 
   HSB_PSU_UPPER_CRITICAL, 
   HSB_PSU_UPPER_NON_RECOVERABLE, 
} PsuDiagState;

typedef struct
{
   Float32 coreTemp; 
   Float32 dramTemp; 
   Float32 fpgaTemp; 
   Float32 efuseTemp; 
   Float32 dcdcTemp; 
} MfbTempValues;

typedef struct
{
   BITState thermalShutdown; 
   BITState overCurrentShutdown; 
   BITState powerSupplyFail; 
   BITState underLoadShutdown; 
   BITState thermalWarning; 
   DOutChannelState outHBStatus[6]; 
} DiscreteOutDiag;

typedef struct
{
   BITState thermalShutdown; 
   BITState overCurrentShutdown; 
   BITState powerSupplyFail; 
   BITState underLoadShutdown; 
   BITState thermalWarning; 
   PwmChannelState outHBStatus; 
} PwmDiag;

typedef struct
{
   PsuDiagState inputAmp; 
   PsuDiagState output12VAmp; 
   PsuDiagState output3V3Amp; 
   PsuDiagState output5VAmp; 
   PsuDiagState outputN12VAuxAmp; 
   PsuDiagState outputP12VAuxAmp; 
   PsuDiagState output3V3AuxAmp; 
} DiagCurrent;

typedef struct
{
   PsuDiagState inputVolt; 
   PsuDiagState output12VVolt; 
   PsuDiagState output3V3Volt; 
   PsuDiagState output5VVolt; 
   PsuDiagState outputN12VAuxVolt; 
   PsuDiagState outputP12VAuxVolt; 
   PsuDiagState output3V3AuxVolt; 
} DiagVoltage;

typedef struct
{
   PsuDiagState boardTemp; 
   PsuDiagState output12VTemp; 
   PsuDiagState output3V3Temp; 
   PsuDiagState output5VTemp; 
   PsuDiagState outputN12VAuxTemp; 
   PsuDiagState outputP12VAuxTemp; 
   PsuDiagState output3V3AuxTemp; 
   PsuDiagState primaryTransTemp; 
} DiagTemp;

typedef struct
{
   DiagCurrent current; 
   DiagVoltage voltage; 
   DiagTemp temp; 
} PsuDiag;

ModStatus modHsb_getMfbPbit(MfbPBITFailResult *mfbPBITFailResultPtr);

ModStatus modHsb_getMfbCbit(MfbCBITFailResult *mfbCBITFailResultPtr, MfbTempValues *mfb1TempPtr,
                            MfbTempValues *mfb2TempPtr);

ModStatus modHsb_getA429Pbit(A429PBITFailResult *a429PBITFailResultPtr);

ModStatus modHsb_writeA429Pbit(const A429PBITFailResult a429PBITFailResultPtr);

ModStatus modHsb_readA429Pbit(A429PBITFailResult *a429PBITFailResultPtr, Float64 *timestampPtr);    

ModStatus modHsb_getA429Cbit(A429CBITFailResult *a429CBITFailResultPtr, Float32 *temp);

ModStatus modHsb_writeA429Cbit(const A429CBITFailResult a429CBITFailResultPtr);

ModStatus modHsb_readA429Cbit(A429CBITFailResult *a429CBITFailResultPtr, Float64 *timestampPtr);

ModStatus modHsb_getAnalogInPbit(AInPBITFailResult *aInPBITFailResultPtr);

ModStatus modHsb_writeAnalogInPbit(const AInPBITFailResult aInPBITFailResultPtr);

ModStatus modHsb_readAnalogInPbit(AInPBITFailResult *aInPBITFailResultPtr, Float64 *timestampPtr);

ModStatus modHsb_getAnalogInCbit(AInCBITFailResult *aInCBITFailResultPtr, Float32 *tempBank5V,
                                 Float32 *tempBank10V);

ModStatus modHsb_writeAnalogInCbit(const AInCBITFailResult aInCBITFailResult);

ModStatus modHsb_readAnalogInCbit(AInCBITFailResult *analogInBitResultPtr, Float64 *timestampPtr);

ModStatus modHsb_getDiscreteInPbit(DInPBITFailResult *dInPBITFailResultPtr);

ModStatus modHsb_writeDiscreteInPbit(const DInPBITFailResult dInPBITFailResultPtr);

ModStatus modHsb_readDiscreteInPbit(DInPBITFailResult *dInPBITFailResultPtr,
                                    Float64 *timestampPtr);

ModStatus modHsb_getDiscreteInCbit(DInCBITFailResult *dInCBITFailResultPtr, Float32 *temp1,
                                   Float32 *temp2);

ModStatus modHsb_writeDiscreteInCbit(const DInCBITFailResult dInCBITFailResult);

ModStatus modHsb_readDiscreteInCbit(DInCBITFailResult *dInCBITFailResultPtr,
                                    Float64 *timestampPtr);

ModStatus modHsb_getDiscreteOutPbit(DOutPBITFailResult *dOutPBITFailResultPtr);

ModStatus modHsb_writeDiscreteOutPbit(const DOutPBITFailResult dOutPBITFailResult);

ModStatus modHsb_readDiscreteOutPbit(DOutPBITFailResult *dOutPBITFailResultPtr,
                                     Float64 *timestampPtr);

ModStatus modHsb_getDiscreteOutCbit(DOutCBITFailResult *dOutCBITFailResultPtr, Float32 *temp1,
                                    Float32 *temp2);

ModStatus modHsb_writeDiscreteOutCbit(const DOutCBITFailResult dOutCBITFailResult);

ModStatus modHsb_readDiscreteOutCbit(DOutCBITFailResult *dOutCBITFailResultPtr,
                                     Float64 *timestampPtr);

ModStatus modHsb_getPwmPbit(PwmPBITFailResult *pwmPbitResult);

ModStatus modHsb_writePwmPbit(const PwmPBITFailResult pwmPbitResult);

ModStatus modHsb_readPwmPbit(PwmPBITFailResult *pwmPbitResultPtr, Float64 *timestamp);

ModStatus modHsb_getPwmCbit(PwmCBITFailResult *pwmPbitResult, Float32 *temp);

ModStatus modHsb_writePwmCbit(const PwmCBITFailResult pwmPbitResult);

ModStatus modHsb_readPwmCbit(PwmCBITFailResult *pwmPbitResultPtr, Float64 *timestamp);

ModStatus modHsb_getRvdtPbit(RvdtPBITFailResult *rvdtPBITFailResultPtr);

ModStatus modHsb_writeRvdtPbit(const RvdtPBITFailResult rvdtPBITFailResult);

ModStatus modHsb_readRvdtPbit(RvdtPBITFailResult *rvdtPBITFailResultPtr, Float64 *timestampPtr);

ModStatus modHsb_getRvdtCbit(RvdtCBITFailResult *rvdtBitResult, Float32 *temp);

ModStatus modHsb_writeRvdtCbit(const RvdtCBITFailResult rvdtCBITFailResult);

ModStatus modHsb_readRvdtCbit(RvdtCBITFailResult *rvdtCBITFailResultPtr, Float64 *timestampPtr);

ModStatus modHsb_getPsuDiag(PsuDiag *psuDiagPtr);

ModStatus modHsb_getPsuCbit(PsuCBITFailResult *psuBitResult);

ModStatus modHsb_writePsuCbit(const PsuCBITFailResult psuBitResult);

ModStatus modHsb_readPsuCbit(PsuCBITFailResult *psuBitResult, Float64 *timestamp);

ModStatus modHsb_getPowerFail(BITState *powerFailStatePtr);

ModStatus modHsb_writePowerFail(BITState powerFailResult);

ModStatus modHsb_readPowerFail(BITState *powerFailResult, Float64 *timestamp);
 
#endif // INCLUDED_MOD_HSB_H