a429.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 Malaysia.
 */

 
#ifndef INCLUDED_A429_H
#define INCLUDED_A429_H
 
#include "commonDataTypes.h"
#include "driverStatus.h"

typedef enum
{
   A429_BIT_PASS = 0U, 
   A429_BIT_FAIL = 1U 
} A429BITState;

typedef enum
{
   TX_CH_SPEED_HIGH, 
   TX_CH_SPEED_LOW 
} TxSpeedRate;

typedef enum
{
   RX_CH_SPEED_HIGH, 
   RX_CH_SPEED_LOW 
} RxSpeedRate;

typedef enum
{
   MSG_PARITY_ODD, 
   MSG_PARITY_EVEN 
} MsgParityType;

typedef enum
{
   TX_CH_PARITY_ODD, 
   TX_CH_PARITY_EVEN, 
   TX_CH_PARITY_DISABLE 
} TxChParityMode;

typedef enum
{
   RX_CH_PARITY_ODD, 
   RX_CH_PARITY_EVEN, 
   RX_CH_PARITY_DISABLE 
} RxChParityMode;

typedef enum
{
   CH_ENABLE, 
   CH_DISABLE 
} ChStatus;

typedef struct
{
   A429BITState pwrFault; 
   A429BITState icNotReady; 
   A429BITState commErr; 
   A429BITState bistErr; 
   A429BITState loopbackTxCh1Err; 
   A429BITState loopbackTxCh2Err; 
   A429BITState loopbackTxCh3Err; 
   A429BITState loopbackTxCh4Err; 
   A429BITState loopbackRxCh1Err; 
   A429BITState loopbackRxCh2Err; 
   A429BITState loopbackRxCh3Err; 
   A429BITState loopbackRxCh4Err; 
   A429BITState loopbackRxCh5Err; 
   A429BITState loopbackRxCh6Err; 
   A429BITState loopbackRxCh7Err; 
   A429BITState pbitNotDone; 
   A429BITState ramBistNotDone; 
   A429BITState ramBistFail; 
   A429BITState ramBistUpperbitFail; 
   A429BITState ramBistLowerbitFail; 
} A429PbitStatus;

typedef struct
{
   A429BITState cbitNotDone; 
   A429BITState pwrFault3V3; 
   A429BITState pwrFaultBIT; 
   A429BITState pwrFaultISO; 
   A429BITState pwrFaultTxDrv; 
   A429BITState ut; 
   A429BITState ovt; 
   A429BITState icNotReady; 
   A429BITState commErr; 
   A429BITState txLoopbackNotReady; 
   A429BITState txLoopbackcommErr; 
   A429BITState rxLoopbackNotReady; 
   A429BITState rxLoopbackcommErr; 
   A429BITState mismatchTxCh1; 
   A429BITState mismatchTxCh2; 
   A429BITState mismatchTxCh3; 
   A429BITState mismatchTxCh4; 
   A429BITState mismatchRxCh1; 
   A429BITState mismatchRxCh2; 
   A429BITState mismatchRxCh3; 
   A429BITState mismatchRxCh4; 
   A429BITState mismatchRxCh5; 
   A429BITState mismatchRxCh6; 
   A429BITState mismatchRxCh7; 
   A429BITState receiveErrTxCh1; 
   A429BITState receiveErrTxCh2; 
   A429BITState receiveErrTxCh3; 
   A429BITState receiveErrTxCh4; 
   A429BITState receiveErrRxCh1; 
   A429BITState receiveErrRxCh2; 
   A429BITState receiveErrRxCh3; 
   A429BITState receiveErrRxCh4; 
   A429BITState receiveErrRxCh5; 
   A429BITState receiveErrRxCh6; 
   A429BITState receiveErrRxCh7; 
} A429CbitStatus;

typedef struct
{
   UInt32 baseAddress; 
} A429DevHandler;

DriverStatus a429_reset(const A429DevHandler a429DevHdl);

DriverStatus a429_configMCR(const A429DevHandler a429DevHdl, const UInt32 mcrValue);

DriverStatus a429_txEnableChannel(const A429DevHandler a429DevHdl, const UInt8 txChannelNum);

DriverStatus a429_txDisableChannel(const A429DevHandler a429DevHdl, const UInt8 txChannelNum);

DriverStatus a429_txGetState(const A429DevHandler a429DevHdl, const UInt8 txChannelNum,
                             ChStatus *txStatusPtr);

DriverStatus a429_txEnableParity(const A429DevHandler a429DevHdl, const UInt8 txChannelNum,
                                 const TxChParityMode parityType);

DriverStatus a429_txDisableParity(const A429DevHandler a429DevHdl, const UInt8 txChannelNum);

DriverStatus a429_txSetSpeed(const A429DevHandler a429DevHdl, const UInt8 txChannelNum,
                             const TxSpeedRate dataRate);

DriverStatus a429_txFIFOMsg(const A429DevHandler a429DevHdl, const UInt8 txChannelNum,
                            const UInt32 *FIFOMsgPtr, const UInt32 msgCount);

DriverStatus a429_rxEnableChannel(const A429DevHandler a429DevHdl, const UInt8 rxChannelNum);

DriverStatus a429_rxDisableChannel(const A429DevHandler a429DevHdl, const UInt8 rxChannelNum);

DriverStatus a429_rxGetState(const A429DevHandler a429DevHdl, const UInt8 rxChannelNum,
                             ChStatus *rxStatusPtr);

DriverStatus a429_rxEnableParity(const A429DevHandler a429DevHdl, const UInt8 rxChannelNum,
                                 const RxChParityMode parityType);

DriverStatus a429_rxDisableParity(const A429DevHandler a429DevHdl, const UInt8 rxChannelNum);

DriverStatus a429_rxSetSpeed(const A429DevHandler a429DevHdl, const UInt8 rxChannelNum,
                             const RxSpeedRate dataRate);

DriverStatus a429_rxSetLabelFilter(const A429DevHandler a429DevHdl, const UInt8 rxChannelNum,
                                   const UInt8 *filterLabelPtr, const UInt8 filterCount);

DriverStatus a429_rxClearLabelFilter(const A429DevHandler a429DevHdl, const UInt8 rxChannelNum);

DriverStatus a429_rxSetSDIFilter(const A429DevHandler a429DevHdl, const UInt8 rxChannelNum,
                                 const UInt8 sdiValue);

DriverStatus a429_rxDisableSDIFilter(const A429DevHandler a429DevHdl, const UInt8 rxChannelNum);

DriverStatus a429_rxGetFIFOMsgs(const A429DevHandler a429DevHdl, const UInt8 rxChannelNum,
                                UInt32 *recvMsgsPtr, UInt32 *recvMsgCountPtr);

DriverStatus a429_getPbit(const A429DevHandler a429DevHdl, A429PbitStatus *a429PbitPtr);

DriverStatus a429_getCbit(const A429DevHandler a429DevHdl, A429CbitStatus *a429CbitPtr);

DriverStatus a429_getTemp(const A429DevHandler a429DevHdl, Float32 *temp);
 
#endif // INCLUDED_A429_H