rvdt.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_RVDT_H
#define INCLUDED_RVDT_H
 
#include "commonDataTypes.h"
#include "driverStatus.h"
 
#define RVDT_DEV_CH_MAX (4U)

typedef enum
{
   RVDT_BIT_PASS = 0U, 
   RVDT_BIT_FAIL = 1U 
} RvdtBITState;

typedef enum
{
   GAIN_CTRL_1000 = 0x00U, 
   GAIN_CTRL_1180 = 0x10U, 
   GAIN_CTRL_1400 = 0x20U, 
   GAIN_CTRL_1670 = 0x30U 
} RefGain;

typedef enum
{
   DIFFERENTIAL_WAVE = 0x00U, 
   SINGLE_ENDED_WAVE = 0x80U 
} WaveformMode;

typedef enum
{
   DACVCM_CTRL_820mV = 0U, 
   DACVCM_CTRL_840mV, 
   DACVCM_CTRL_860mV, 
   DACVCM_CTRL_880mV 
} DacVcm;

typedef enum
{
   DIFFERENTIAL_AMPLIFIER_OUTPUT_COMMON_MODE_VOLTAGE_750mV =
      0U, 
   DIFFERENTIAL_AMPLIFIER_OUTPUT_COMMON_MODE_VOLTAGE_1000mV =
      4U, 
   DIFFERENTIAL_AMPLIFIER_OUTPUT_COMMON_MODE_VOLTAGE_1250mV =
      8U, 
   DIFFERENTIAL_AMPLIFIER_OUTPUT_COMMON_MODE_VOLTAGE_1500mV =
      12U 
} DiffVocm;

typedef enum
{
   S1_GAIN_1000mV = 0U, 
   S1_GAIN_1330mV, 
   S1_GAIN_1670mV, 
   S1_GAIN_2000mV 
} S1Gain;

typedef enum
{
   S2_GAIN_1000mV = 0U, 
   S2_GAIN_1330mV, 
   S2_GAIN_1670mV, 
   S2_GAIN_2000mV 
} S2Gain;

typedef enum
{
   S1_DIFFERENTIAL = 0U, 
   S1_SINGLE_ENDED = 64U 
} S1WaveformMode;

typedef enum
{
   S2_DIFFERENTIAL = 0U, 
   S2_SINGLE_ENDED = 64U 
} S2WaveformMode;

typedef enum
{
   VCM_BIAS_500mV = 0U, 
   VCM_BIAS_625mV, 
   VCM_BIAS_750mV, 
   VCM_BIAS_825mV 
} VCMBias;

typedef enum
{
   OUTPUT_RATE_128US = 0U, 
   OUTPUT_RATE_256US = 4U, 
} DEMODOutputRate;

typedef struct
{
   RvdtBITState done; 
   RvdtBITState wramFail[RVDT_DEV_CH_MAX]; 
   RvdtBITState ramFail[RVDT_DEV_CH_MAX]; 
   RvdtBITState icCommFail[RVDT_DEV_CH_MAX]; 
   RvdtBITState bitDone; 
   RvdtBITState bitIcComFail; 
   RvdtBITState bitRamFail; 
   RvdtBITState bitWramFail; 
   RvdtBITState ioExpDone; 
   RvdtBITState ioExpIcComFail; 
} RvdtPbitStatus;

typedef struct
{
   RvdtBITState start; 
   RvdtBITState pg3v3; 
   RvdtBITState ovt; 
   RvdtBITState f3v3; 
   RvdtBITState pgCh[RVDT_DEV_CH_MAX]; 
   RvdtBITState f3v3Bit; 
   RvdtBITState pgBit; 
   RvdtBITState icCommFail[RVDT_DEV_CH_MAX]; 
   RvdtBITState pg3v3Bit; 
   RvdtBITState pg15vIo; 
   RvdtBITState pg15vBit; 
   RvdtBITState f3v3Iso; 
   RvdtBITState f3v3BitIso; 
   RvdtBITState cbitUnderTemp; 
   RvdtBITState s1Fault[RVDT_DEV_CH_MAX]; 
   RvdtBITState s2Fault[RVDT_DEV_CH_MAX]; 
   RvdtBITState excFault[RVDT_DEV_CH_MAX]; 
   RvdtBITState refOverVolt[RVDT_DEV_CH_MAX]; 
   RvdtBITState refUnderVolt[RVDT_DEV_CH_MAX]; 
   RvdtBITState primary1OverVolt[RVDT_DEV_CH_MAX]; 
   RvdtBITState primary1UnderVolt[RVDT_DEV_CH_MAX]; 
   RvdtBITState primary1OverCurr[RVDT_DEV_CH_MAX]; 
   RvdtBITState primary2OverVolt[RVDT_DEV_CH_MAX]; 
   RvdtBITState primary2UnderVolt[RVDT_DEV_CH_MAX]; 
   RvdtBITState primary2OverCurr[RVDT_DEV_CH_MAX]; 
   RvdtBITState s1gainOverVolt[RVDT_DEV_CH_MAX]; 
   RvdtBITState s2gainOverVolt[RVDT_DEV_CH_MAX]; 
   RvdtBITState bitIcCommFail; 
   RvdtBITState ioExpCommFail; 
} RvdtCbitStatus;

typedef struct
{
   UInt32 size; 
   UInt32 amplitude[256]; 
} ExcWaveformTable;

typedef struct
{
   UInt32 filterNum; 
   Float32 centerFreq; 
   Float32 bandwidth; 
   Float32 b[3]; 
   Float32 a[3]; 
   Float32 scaledCenterFreq; 
   Float32 scaledBandwidth; 
   UInt32 b1; 
   UInt32 a2; 
   UInt32 a3; 
} BPFData;

typedef struct
{
   Float64 a[2]; 
   Float64 b[2]; 
} LPFFilterCoeffs;

typedef struct
{
   Float64 a[3]; 
   Float64 b[3]; 
} BPFFilterCoeffs;

typedef struct
{
   UInt32 baseAddress; 
} RvdtDevHandler;

DriverStatus rvdt_getPbit(const RvdtDevHandler rvdtDevHdl, RvdtPbitStatus *pbitStatus);

DriverStatus rvdt_getCbit(const RvdtDevHandler rvdtDevHdl, RvdtCbitStatus *cbitStatus);

DriverStatus rvdt_getTemp(const RvdtDevHandler rvdtDevHdl, Float32 *temp);

DriverStatus rvdt_initDev(const RvdtDevHandler rvdtDevHdl);

DriverStatus rvdt_getRefStatus(const RvdtDevHandler rvdtDevHdl, Bool *opStatus);

DriverStatus rvdt_setPowerEnable(const RvdtDevHandler rvdtDevHdl, const Bool enable);

DriverStatus rvdt_setTestMux(const RvdtDevHandler rvdtDevHdl, const Bool enable);

DriverStatus rvdt_setRefWaveEnable(const RvdtDevHandler rvdtDevHdl, const Bool enable);

DriverStatus rvdt_configWaveformGeneration(const RvdtDevHandler rvdtDevHdl, const UInt8 dacvcm,
                                           const UInt8 vocm, const UInt8 gain, const UInt8 mode,
                                           const Float32 voltageRms, const Float32 frequency);

DriverStatus rvdt_getSenseStatus(const RvdtDevHandler rvdtDevHdl, Bool *opStatus);

DriverStatus rvdt_setSenseEnable(const RvdtDevHandler rvdtDevHdl, const Bool enable);

DriverStatus rvdt_setS1s2Config(const RvdtDevHandler rvdtDevHdl, const UInt8 vcmBias);

DriverStatus rvdt_configSec1(const RvdtDevHandler rvdtDevHdl, const UInt8 sense, const UInt8 gain,
                             const UInt8 rate);

DriverStatus rvdt_configSec2(const RvdtDevHandler rvdtDevHdl, const UInt8 sense, const UInt8 gain,
                             const UInt8 rate);

DriverStatus rvdt_configLpfCoefficient(const RvdtDevHandler rvdtDevHdl, const UInt32 lpfFreq,
                                       const UInt32 lpfRate);

DriverStatus rvdt_configBpfCoefficient(const RvdtDevHandler rvdtDevHdl, const UInt32 bpfFreq,
                                       const UInt32 bpfBandwidth);

DriverStatus rvdt_setRefConfigCommand(const RvdtDevHandler rvdtDevHdl);

DriverStatus rvdt_setSenseConfigCommand(const RvdtDevHandler rvdtDevHdl);

DriverStatus rvdt_setSenseFilterCommand(const RvdtDevHandler rvdtDevHdl);

DriverStatus rvdt_getSensePosition(const RvdtDevHandler rvdtDevHdl, Float32 *demod1Ptr,
                                   Float32 *demod2Ptr, Float32 *deltaVal, UInt32 *adcVal1,
                                   UInt32 *adcVal2);
 
#endif // INCLUDED_RVDT_H