modInfo.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_INFO_H
#define INCLUDED_MOD_INFO_H
 
#include "modStatus.h"
#include "commonDataTypes.h"
 
#define MOD_INFO_MAX_MIO      (5U) // MAX IO module on each MFB Brd
#define MOD_INFO_MAX_MOD_CHAR (5U) // Maximum Char for module/model/gen name
#define MOD_INFO_MAX_MOD_TYPE (8U) // Maximum number of module types
 
#define MOD_INFO_MAX_CARD     (3U)
#define MOD_INFO_MAX_MFB_CARD (2U)
#define MOD_INFO_MFB1_VPX     (0U)
#define MOD_INFO_MFB2_VPX     (1U)
#define MOD_INFO_PSU_VPX      (2U)
 
// MFB1 IO Index
#define MOD_INFO_MIODIN1  (0U)
#define MOD_INFO_MIODOUT1 (1U)
#define MOD_INFO_MIOPWM   (2U)
#define MOD_INFO_MIOANIN  (3U)
 
// MFB2 IO Index
#define MOD_INFO_MIODIN2  (0U)
#define MOD_INFO_MIODOUT2 (1U)
#define MOD_INFO_MIOA429  (2U)
#define MOD_INFO_MIORVDT  (3U)
 
// PSU Index
#define MOD_INFO_MIOPSU (0U)
 
#define MOD_INFO_STR_LEN_4     (4U) // char caount
#define MOD_INFO_MODEL_STR_LEN (5U) // string length for VPX68
#define MOD_INFO_GEN_STR_LEN   (1U) // string length for A
 
// Byte masks
#define MOD_INFO_BYTE_MASK_0 (0x000000FFU)
#define MOD_INFO_BYTE_MASK_1 (0x0000FF00U)
#define MOD_INFO_BYTE_MASK_2 (0x00FF0000U)
#define MOD_INFO_BYTE_MASK_3 (0xFF000000U)
 
// Bit shifts
#define MOD_INFO_SHIFT_BYTE_0 (0U)
#define MOD_INFO_SHIFT_BYTE_1 (8U)
#define MOD_INFO_SHIFT_BYTE_2 (16U)
#define MOD_INFO_SHIFT_BYTE_3 (24U)
 
// Driver/HW Info

typedef enum
{
   NA_CARD = 0U, 
   MFB1_CARD, 
   MFB2_CARD, 
   PSU_CARD, 
} CardType;

typedef enum
{
   DEFAULT, 
   OPEN, 
   CLOSE, 
   INIT, 
   RESET 
} ModeState;
 
// Module Mask Enum for the module type

typedef enum
{
   MOD_NA = 0x00U, 
   MOD_A429 = 0x02U, 
   MOD_ANIN = 0x04U, 
   MOD_DIN = 0x08U, 
   MOD_DOUT = 0x10U, 
   MOD_PWM = 0x20U, 
   MOD_RVDT = 0x40U, 
   MOD_PSU = 0x80U 
} ModType;

typedef struct
{
   UInt8 major; 
   UInt8 minor; 
   UInt8 patch; 
   UInt8 release; 
} Version;
 
// Card Type
 
// Module Info

typedef struct
{
   ModType type; 
   Char *name; 
   ModeState state; 
} ModInfoType;
 
// MIO card Info

typedef struct
{
   UInt8 busIndex; 
   UInt8 number; 
   CardType type; 
   ModeState state; 
   ModInfoType mod[MOD_INFO_MAX_MIO]; 
   UInt32 memBaseAddr; 
   UInt32 modCount; 
} CardInfo;
 
// MIO board Info

typedef struct
{
   CardType type; 
   ModeState state; 
   UInt32 serialNum; 
   Char platform[MOD_INFO_MAX_MOD_CHAR]; 
   Char model[MOD_INFO_MAX_MOD_CHAR]; 
   Char generation[MOD_INFO_MAX_MOD_CHAR]; 
   Char mainBrdRevision[MOD_INFO_MAX_MOD_CHAR]; 
   Version cpldVersion; 
   Version fpgaVersion; 
   Char modId[MOD_INFO_MAX_MIO][MOD_INFO_MAX_MOD_CHAR]; 
   UInt32 modCount; 
} BoardInfo;

typedef struct
{
   Version version; 
} DLMInfo;

ModStatus modInfo_getDLMInfo(DLMInfo *dlmInfo);

ModStatus modInfo_getBrdInfo(CardType cardType, BoardInfo *brdInfoPtr);
 
#endif // INCLUDED_MOD_INFO_H