discreteOut.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_DISCRETE_OUT_H
#define INCLUDED_DISCRETE_OUT_H
 
#include "commonDataTypes.h"
#include "driverStatus.h"
 
#define DOUT_MFB_MAX (2U)
#define DOUT_DEV_MAX (11U)

typedef enum
{
   DOUT_BIT_PASS = 0U, 
   DOUT_BIT_FAIL = 1U 
} DOutBITState;

typedef struct
{
   DOutBITState pbitNotDone[DOUT_MFB_MAX]; 
   DOutBITState checkBank[DOUT_MFB_MAX]; 
   DOutBITState devFault[DOUT_DEV_MAX]; 
} DOutPbitStatus;

typedef struct
{
   DOutBITState dOutGClch1; 
   DOutBITState dOutSClch1; 
   DOutBITState dOutGClch2; 
   DOutBITState dOutSClch2; 
   DOutBITState dOutGClch3; 
   DOutBITState dOutSClch3; 
   DOutBITState dOutGClch4; 
   DOutBITState dOutSClch4; 
} DOutCbit1ChSGSubStatus;

typedef struct
{
   DOutBITState dOutSGClch1; 
   DOutBITState dOutSGClch2; 
   DOutBITState dOutSGClch3; 
   DOutBITState dOutSGClch4; 
} DOutCbit1ChSGStatus;

typedef struct
{
   DOutBITState dOutSoCw1; 
   DOutBITState dOutSoCw2; 
   DOutBITState dOutSoCw3; 
   DOutBITState dOutSoCw4; 
   DOutBITState dOutSoCcw1; 
   DOutBITState dOutSoCcw2; 
   DOutBITState dOutSoCcw3; 
   DOutBITState dOutSoCcw4; 
   DOutBITState dOutSoEn1; 
   DOutBITState dOutSoEn2; 
   DOutBITState dOutSoEn3; 
   DOutBITState dOutSoEn4; 
   DOutBITState dOutSoExc1; 
   DOutBITState dOutSoExc2; 
   DOutBITState dOutSoExc3; 
   DOutBITState dOutSoExc4; 
   DOutBITState dOutOgCh1; 
   DOutBITState dOutOgCh2; 
   DOutBITState dOutOgCh3; 
   DOutBITState dOutOgCh4; 
   DOutBITState dOutOgCh5; 
   DOutBITState dOutOgCh6; 
   DOutBITState dOutOgCh7; 
   DOutBITState dOutOgCh8; 
   DOutBITState dOutOgCh9; 
   DOutBITState dOutOgCh10; 
   DOutBITState dOutOgCh11; 
   DOutBITState dOutOgCh12; 
} DOutCbit1ChStatus;

typedef struct
{
   DOutBITState dOutGExt1; 
   DOutBITState dOutSExt1; 
   DOutBITState dOutGExt2; 
   DOutBITState dOutSExt2; 
   DOutBITState dOutGExt3; 
   DOutBITState dOutSExt3; 
   DOutBITState dOutGExt4; 
   DOutBITState dOutSExt4; 
   DOutBITState dOutGRet1; 
   DOutBITState dOutSRet1; 
   DOutBITState dOutGRet2; 
   DOutBITState dOutSRet2; 
   DOutBITState dOutGRet3; 
   DOutBITState dOutSRet3; 
   DOutBITState dOutGRet4; 
   DOutBITState dOutSRet4; 
   DOutBITState dOutOgCh13; 
   DOutBITState dOutOgCh14; 
   DOutBITState dOutOgCh15; 
   DOutBITState dOutOgCh16; 
   DOutBITState dOutSoCh17; 
   DOutBITState dOutSoCh18; 
   DOutBITState dOutSoCh19; 
   DOutBITState dOutSoCh20; 
   DOutBITState dOutSoCh21; 
   DOutBITState dOutSoCh22; 
} DOutCbit2ChStatus;

typedef struct
{
   DOutBITState dOutGExt1; 
   DOutBITState dOutSExt1; 
   DOutBITState dOutGExt2; 
   DOutBITState dOutSExt2; 
   DOutBITState dOutGExt3; 
   DOutBITState dOutSExt3; 
   DOutBITState dOutGExt4; 
   DOutBITState dOutSExt4; 
   DOutBITState dOutGRet1; 
   DOutBITState dOutSRet1; 
   DOutBITState dOutGRet2; 
   DOutBITState dOutSRet2; 
   DOutBITState dOutGRet3; 
   DOutBITState dOutSRet3; 
   DOutBITState dOutGRet4; 
   DOutBITState dOutSRet4; 
} DOutCbit2ChSGSubStatus;

typedef struct
{
   DOutBITState dOutSGExt1; 
   DOutBITState dOutSGExt2; 
   DOutBITState dOutSGExt3; 
   DOutBITState dOutSGExt4; 
   DOutBITState dOutSGRet1; 
   DOutBITState dOutSGRet2; 
   DOutBITState dOutSGRet3; 
   DOutBITState dOutSGRet4; 
} DOutCbit2ChSGStatus;

typedef struct
{
   DOutBITState notRun; 
   DOutBITState pg3v3; 
   DOutBITState ut; 
   DOutBITState ot; 
   DOutBITState bitUt; 
   DOutBITState bitOt; 
   DOutBITState mainCommErr; 
   DOutBITState lbNotRunIc1; 
   DOutBITState lbNotRunIc2; 
   DOutBITState lbPg3v3Ic1; 
   DOutBITState lbPg3v3Ic2; 
   DOutBITState lbCommErrIc1; 
   DOutBITState lbCommErrIc2; 
   DOutCbit1ChStatus oc1; 
   DOutCbit1ChSGStatus oc2; 
   DOutCbit1ChStatus uld1; 
   DOutCbit1ChSGStatus uld2; 
   DOutCbit1ChStatus int1; 
   DOutCbit1ChSGSubStatus int2; 
   DOutBITState tw[DOUT_DEV_MAX]; 
   DOutBITState psf[DOUT_DEV_MAX]; 
   DOutBITState tsd[DOUT_DEV_MAX]; 
} DOutCbit1Status;

typedef struct
{
   DOutBITState notRun; 
   DOutBITState pg3v3; 
   DOutBITState ut; 
   DOutBITState ot; 
   DOutBITState f3v3; 
   DOutBITState f28V; 
   DOutBITState f3v3Bit; 
   DOutBITState fVwetBit; 
   DOutBITState lbNotRun; 
   DOutBITState lbPg3v3; 
   DOutBITState lbCommErr; 
   DOutCbit2ChStatus oc1; 
   DOutCbit2ChSGStatus oc2; 
   DOutCbit2ChStatus uld1; 
   DOutCbit2ChSGStatus uld2; 
   DOutCbit2ChStatus int1; 
   DOutCbit2ChSGSubStatus int2; 
   DOutBITState tw[DOUT_DEV_MAX]; 
   DOutBITState psf[DOUT_DEV_MAX]; 
   DOutBITState tsd[DOUT_DEV_MAX]; 
} DOutCbit2Status;

typedef struct
{
   DOutCbit1Status b1; 
   DOutCbit2Status b2; 
} DOutCbitStatus;

typedef struct
{
   Bool overVoltage; 
   Bool underLoad; 
} DOutBankCfg;

typedef struct
{
   UInt32 baseAddress; 
   UInt8 cardNum; 
   UInt8 deviceNum; 
} DOutDevHandler;

DriverStatus discreteOut_reset(const DOutDevHandler dOutDevHdl);

DriverStatus discreteOut_getPbit(const DOutDevHandler dOutDevHdl, DOutPbitStatus *pbitStatus,
                                 const UInt8 devNum);

DriverStatus discreteOut_getCbit(const DOutDevHandler dOutDevHdl, DOutCbitStatus *cbitStatus,
                                 const UInt8 devNum);
DriverStatus discreteOut_getTemp(const DOutDevHandler dOutDevHdl, Float32 *temp);

DriverStatus discreteOut_devicesConfig(const DOutDevHandler dOutDevHdl,
                                       const DOutBankCfg bankConfig);

DriverStatus discreteOut_writeChState(const DOutDevHandler dOutDevHdl, const UInt8 channelNum,
                                      const Bool dOutLogic);
 
#endif // INCLUDED_DISCRETE_OUT_H