discreteIn.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_IN_H
#define INCLUDED_DISCRETE_IN_H
 
#include "commonDataTypes.h"
#include "driverStatus.h"
 
#define DIN_MFB_MAX (2U)
#define DIN_DEV_MAX (3U)
#define DIN_CH_MAX  (44U)
 
#define DIN_DEV_CH_MAX    (32U)
#define DIN_BANK_MASK     (0x03U)
#define DIN_BANK_SHIFT    (6U)
#define DIN_BANK_OFFSET_0 (0U)
#define DIN_BANK_OFFSET_1 (8U)
#define DIN_BANK_OFFSET_2 (16U)
#define DIN_BANK_OFFSET_3 (24U)
#define DIN_TEMP_MASK     (0xFFFFU)
 

typedef enum
{
   BANK0 = 0x00U, 
   BANK1 = 0x01U, 
   BANK2 = 0x02U, 
   BANK3 = 0x03U 
} DInDevBank;

typedef enum
{
   DIN_BIT_PASS = 0U, 
   DIN_BIT_FAIL = 1U 
} DInBITState;

typedef enum
{
   DIN_BIT_SO_CH1 = 0U, 
   DIN_BIT_SO_CH2, 
   DIN_BIT_SO_CH3, 
   DIN_BIT_SO_CH4, 
   DIN_BIT_SO_CH5, 
   DIN_BIT_SO_CH6, 
   DIN_BIT_SO_CH7, 
   DIN_BIT_SO_CH8, 
   DIN_BIT_SO_CH9, 
   DIN_BIT_SO_CH10, 
   DIN_BIT_SO_CH11, 
   DIN_BIT_SO_CH12, 
   DIN_BIT_SO_CH13, 
   DIN_BIT_SO_CH14, 
   DIN_BIT_SO_CH15, 
   DIN_BIT_SO_CH16, 
   DIN_BIT_SG_CH33_1, 
   DIN_BIT_SG_CH34_1, 
   DIN_BIT_SG_CH35_1, 
   DIN_BIT_SG_CH36_1, 
   DIN_BIT_SG_CH37_1, 
   DIN_BIT_SG_CH38_1, 
   DIN_BIT_GO_CH38_2, 
   DIN_BIT_GO_CH37_2, 
   DIN_BIT_GO_CH36_2, 
   DIN_BIT_GO_CH35_2, 
   DIN_BIT_GO_CH34_2, 
   DIN_BIT_GO_CH33_2, 
   DIN_BIT_OG_CH17, 
   DIN_BIT_OG_CH18, 
   DIN_BIT_OG_CH19, 
   DIN_BIT_OG_CH20, 
   DIN_BIT_OG_CH21, 
   DIN_BIT_OG_CH22, 
   DIN_BIT_OG_CH23, 
   DIN_BIT_OG_CH24, 
   DIN_BIT_OG_CH25, 
   DIN_BIT_OG_CH26, 
   DIN_BIT_OG_CH27, 
   DIN_BIT_OG_CH28, 
   DIN_BIT_OG_CH29, 
   DIN_BIT_OG_CH30, 
   DIN_BIT_OG_CH31, 
   DIN_BIT_OG_CH32 
} DInBitChannel;

typedef struct
{
   DInBITState pbitNotDone[DIN_MFB_MAX]; 
   DInBITState pbitPwr3v3fault[DIN_MFB_MAX]; 
   DInBITState pbitIcCommErr[DIN_DEV_MAX]; 
   DInBITState chPbitStat[DIN_CH_MAX]; 
} DInPbitStatus;

typedef struct
{
   DInBITState cbitNotDone[DIN_MFB_MAX]; 
   DInBITState cbitPwr3v3Fault[DIN_MFB_MAX]; 
   DInBITState cbitIcCommErr[DIN_DEV_MAX]; 
   DInBITState cbitUt[DIN_MFB_MAX]; 
   DInBITState cbitOt[DIN_MFB_MAX]; 
   DInBITState f3v3[DIN_DEV_MAX]; 
   DInBITState fVwet[DIN_DEV_MAX]; 
   DInBITState f3v3Bit[DIN_DEV_MAX]; 
   DInBITState fVwetBit[DIN_DEV_MAX]; 
   DInBITState chCbitStat[DIN_CH_MAX]; 
} DInCbitStatus;

typedef struct
{
   Bool chState[DIN_CH_MAX]; 
} DInDevState;

typedef struct
{
   UInt32 baseAddress; 
} DInDevHandler;

DriverStatus discreteIn_getPbit(const DInDevHandler dInDevHdl, DInPbitStatus *pbitStatus, const UInt8 devNum);

DriverStatus discreteIn_getCbit(const DInDevHandler dInDevHdl, DInCbitStatus *cbitStatus, const UInt8 devNum);

DriverStatus discreteIn_getTemp(const DInDevHandler dInDevHdl, Float32 *temp);

DriverStatus discreteIn_getChSense(const DInDevHandler dInDevHdl, DInDevState *pDevState);
 
#endif // INCLUDED_DISCRETE_IN_H