analogIn.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_ANALOG_IN_H
#define INCLUDED_ANALOG_IN_H
 
#include "commonDataTypes.h"
#include "driverStatus.h"

typedef enum
{
   AIN_BIT_PASS = 0U, 
   AIN_BIT_FAIL = 1U  
} AInBITState;

typedef struct
{
   AInBITState incompleted; 
   AInBITState pbitFault3v3; 
   AInBITState pbitFault5v; 
   AInBITState pbitFault15v; 
   AInBITState pbitUtBank0; 
   AInBITState pbitOtBank0; 
   AInBITState pbitUtBank1; 
   AInBITState pbitOtBank1; 
   AInBITState pbitIcCommErrCh1; 
   AInBITState pbitIcCommErrCh2; 
   AInBITState pbitIcCommErrCh3; 
   AInBITState pbitIcCommErrCh4; 
   AInBITState pbitIcCommErrCh5; 
   AInBITState pbitIcCommErrCh6; 
   AInBITState pbitIcCommErrCh7; 
   AInBITState pbitIcCommErrCh8; 
   AInBITState pbitIcCommErrLbBank0; 
   AInBITState pbitIcCommErrLbBank1; 
} PbitStat;

typedef struct
{
   AInBITState pbitOvpCh1; 
   AInBITState pbitOvpCh2; 
   AInBITState pbitOvpCh3; 
   AInBITState pbitOvpCh4; 
   AInBITState pbitOvpCh5; 
   AInBITState pbitOvpCh6; 
   AInBITState pbitOvpCh7; 
   AInBITState pbitOvpCh8; 
} PbitOverVoltage;

typedef struct
{
   AInBITState pbitIvrErrCh1; 
   AInBITState pbitIvrErrCh2; 
   AInBITState pbitIvrErrCh3; 
   AInBITState pbitIvrErrCh4; 
   AInBITState pbitIvrErrCh5; 
   AInBITState pbitIvrErrCh6; 
   AInBITState pbitIvrErrCh7; 
   AInBITState pbitIvrErrCh8; 
} PbitIvr;

typedef struct
{
   PbitStat pbitStatus; 
   PbitOverVoltage pbitOverVoltage; 
   PbitIvr pbitIvrErrorStatus; 
} AnalogInPbitStatus;

typedef struct
{
   AInBITState notRun; 
   AInBITState cbitFault3v3; 
   AInBITState cbitFault5v; 
   AInBITState cbitFault15v; 
   AInBITState cbitUtBank0; 
   AInBITState cbitOtBank0; 
   AInBITState cbitUtBank1; 
   AInBITState cbitOtBank1; 
   AInBITState cbitIcCommErrCh1; 
   AInBITState cbitIcCommErrCh2; 
   AInBITState cbitIcCommErrCh3; 
   AInBITState cbitIcCommErrCh4; 
   AInBITState cbitIcCommErrCh5; 
   AInBITState cbitIcCommErrCh6; 
   AInBITState cbitIcCommErrCh7; 
   AInBITState cbitIcCommErrCh8; 
   AInBITState cbitIcCommErrLbBank0; 
   AInBITState cbitIcCommErrLbBank1; 
} CbitStat;

typedef struct
{
   AInBITState cbitOvpCh1; 
   AInBITState cbitOvpCh2; 
   AInBITState cbitOvpCh3; 
   AInBITState cbitOvpCh4; 
   AInBITState cbitOvpCh5; 
   AInBITState cbitOvpCh6; 
   AInBITState cbitOvpCh7; 
   AInBITState cbitOvpCh8; 
} CbitOverVoltage;

typedef struct
{
   AInBITState cbitIvrErrCh1; 
   AInBITState cbitIvrErrCh2; 
   AInBITState cbitIvrErrCh3; 
   AInBITState cbitIvrErrCh4; 
   AInBITState cbitIvrErrCh5; 
   AInBITState cbitIvrErrCh6; 
   AInBITState cbitIvrErrCh7; 
   AInBITState cbitIvrErrCh8; 
} CbitIvr;

typedef struct
{
   CbitStat cbitStatus; 
   CbitOverVoltage cbitOverVoltage; 
   CbitIvr cbitIvrErrorStatus; 
} AnalogInCbitStatus;

typedef struct
{
   UInt32 baseAddress; 
} AnalogInDevHandler;

DriverStatus analogIn_getPbit(const AnalogInDevHandler analogInDevHdl,
                              AnalogInPbitStatus *pbitStatus);

DriverStatus analogIn_getCbit(const AnalogInDevHandler analogInDevHdl,
                              AnalogInCbitStatus *cbitStatus);

DriverStatus analogIn_getTemp(const AnalogInDevHandler analogInDevHdl, Float32 *temp5v,
                              Float32 *temp10v);

DriverStatus analogIn_enableDisableCh(const AnalogInDevHandler analogInDevHdl, const UInt8 chNum,
                                      const Bool flag);

DriverStatus analogIn_getInputRange(const AnalogInDevHandler analogInDevHdl, const UInt8 bank,
                                    UInt32 *range);

DriverStatus analogIn_getAdcReading(const AnalogInDevHandler analogInDevHdl, const UInt8 chNum,
                                    Float32 *adcValue);

DriverStatus analogIn_getChannelStatus(const AnalogInDevHandler analogInDevHdl, const UInt8 chNum,
                                       Bool *status);
 
#endif // INCLUDED_ANALOG_IN_H