modRvdt.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_RVDT_H
#define INCLUDED_MOD_RVDT_H
 
#include "commonDataTypes.h"
#include "modStatus.h"
#include "modConfig.h"

typedef enum
{
   GAIN_1 = 0U, 
   GAIN_1_33, 
   GAIN_1_67, 
   GAIN_2 
} SenseGain;

typedef enum
{
   SENSE_DEMOD_OUTPUT_RATE_128US = 0U, 
   SENSE_DEMOD_OUTPUT_RATE_256US, 
} SenseDemodOutputRate;

typedef enum
{
   BPF_CENTRE_FREQUENCY_1000Hz = 1000U, 
   BPF_CENTRE_FREQUENCY_1500Hz = 1500U, 
   BPF_CENTRE_FREQUENCY_2000Hz = 2000U, 
   BPF_CENTRE_FREQUENCY_2500Hz = 2500U, 
   BPF_CENTRE_FREQUENCY_3000Hz = 3000U, 
   BPF_CENTRE_FREQUENCY_3500Hz = 3500U, 
   BPF_CENTRE_FREQUENCY_4000Hz = 4000U 
} BPFCentreFrequency;

typedef enum
{
   BPF_BANDWIDTH_FREQUENCY_20Hz = 20U, 
   BPF_BANDWIDTH_FREQUENCY_100Hz = 100U, 
   BPF_BANDWIDTH_FREQUENCY_250Hz = 250U 
} BPFBandwidthFrequency;

typedef enum
{
   LPF_OUTPUT_RATE_128US = 0U, 
   LPF_OUTPUT_RATE_256US, 
} LPFOutputRate;

typedef enum
{
   LPF_CUTOFF_FREQUENCY_20Hz = 20U, 
   LPF_CUTOFF_FREQUENCY_100Hz = 100U, 
   LPF_CUTOFF_FREQUENCY_250Hz = 250U, 
} LPFCutoffFrequency;

typedef enum
{
   ACREF_FREQ_1000_HZ = 1000U, 
   ACREF_FREQ_1500_HZ = 1500U, 
   ACREF_FREQ_2000_HZ = 2000U, 
   ACREF_FREQ_2500_HZ = 2500U, 
   ACREF_FREQ_3000_HZ = 3000U, 
   ACREF_FREQ_3500_HZ = 3500U, 
   ACREF_FREQ_4000_HZ = 4000U 
} RvdtACRefFreq;

typedef enum
{
   ACREF_AMPL_1000_MVRMS = 1000U, 
   ACREF_AMPL_1500_MVRMS = 1500U, 
   ACREF_AMPL_2000_MVRMS = 2000U, 
   ACREF_AMPL_2500_MVRMS = 2500U, 
   ACREF_AMPL_3000_MVRMS = 3000U, 
   ACREF_AMPL_3500_MVRMS = 3500U, 
   ACREF_AMPL_4000_MVRMS = 4000U, 
   ACREF_AMPL_4500_MVRMS = 4500U, 
   ACREF_AMPL_5000_MVRMS = 5000U 
} RvdtACRefAmplitude;

typedef struct
{
   BPFCentreFrequency bpfCenterFreq; 
   BPFBandwidthFrequency bpfBandwidth; 
} BPFBandwidth;

typedef struct
{
   LPFOutputRate lpfOutRate; 
   LPFCutoffFrequency lpfCutOffFreq; 
} LPFFrequency;

typedef struct
{
   SenseGain sec1SenseGain; 
   SenseGain sec2SenseGain; 
   SenseDemodOutputRate sec1DemodOutputRate; 
   SenseDemodOutputRate sec2DemodOutputRate; 
} RvdtSenseConfig;

typedef struct
{
   Float32 secV1; 
   Float32 secV2; 
   Float32 secDeltaV; 
   UInt32 secADC1; 
   UInt32 secADC2; 
} RvdtSenseData;

typedef struct
{
   RvdtACRefFreq acRefFreq; 
   RvdtACRefAmplitude acRefAmplitude; 
} RvdtRefConfig;

ModStatus modRvdt_SetRefConfig(const RVDTChannelNum rvdtChannel,
                               const RvdtRefConfig rvdtRefConfig);

ModStatus modRvdt_RefEnable(const RVDTChannelNum rvdtChannel);

ModStatus modRvdt_RefDisable(const RVDTChannelNum rvdtChannel);

ModStatus modRvdt_SetSenseConfig(const RVDTChannelNum rvdtChannel,
                                 const RvdtSenseConfig rvdtSenseConfig);

ModStatus modRvdt_SetSenseFilter(const RVDTChannelNum rvdtChannel,
                                 const BPFBandwidth bpfConfiguration,
                                 const LPFFrequency lpfConfiguration);

ModStatus modRvdt_SenseEnable(const RVDTChannelNum rvdtChannel);

ModStatus modRvdt_SenseDisable(const RVDTChannelNum rvdtChannel);

ModStatus modRvdt_SenseRead(const RVDTChannelNum rvdtChannel, RvdtSenseData *pRvdtSenseData);
 
#endif // INCLUDED_MOD_RVDT_H