modInfo.h File Reference

#include "modStatus.h"
#include "commonDataTypes.h"

Include dependency graph for modInfo.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	Version
	DLM Software and Firmware Version Identifier Structure (Major, Minor, Patch, Release). More...
struct	ModInfoType
	Device Library Module Functional Subsystem Identification and State Structure. More...
struct	CardInfo
	Multi-IO Carrier Card Configuration, Subsystems, and Memory Mapping Structure. More...
struct	BoardInfo
	Multi-IO Hardware Board Manufacturing and Firmware Version Telemetry Structure. More...
struct	DLMInfo
	Device Library Module (DLM) Core Software Release Version Telemetry Structure. More...

Macros
#define	MOD_INFO_MAX_MIO   (5U)
#define	MOD_INFO_MAX_MOD_CHAR   (5U)
#define	MOD_INFO_MAX_MOD_TYPE   (8U)
#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)
#define	MOD_INFO_MIODIN1   (0U)
#define	MOD_INFO_MIODOUT1   (1U)
#define	MOD_INFO_MIOPWM   (2U)
#define	MOD_INFO_MIOANIN   (3U)
#define	MOD_INFO_MIODIN2   (0U)
#define	MOD_INFO_MIODOUT2   (1U)
#define	MOD_INFO_MIOA429   (2U)
#define	MOD_INFO_MIORVDT   (3U)
#define	MOD_INFO_MIOPSU   (0U)
#define	MOD_INFO_STR_LEN_4   (4U)
#define	MOD_INFO_MODEL_STR_LEN   (5U)
#define	MOD_INFO_GEN_STR_LEN   (1U)
#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)
#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)

Enumerations
enum	CardType { NA_CARD = 0U , MFB1_CARD , MFB2_CARD , PSU_CARD }
	This is enum definition for Card Type. More...
enum	ModeState {   DEFAULT , OPEN , CLOSE , INIT ,   RESET }
	This is enum definition for Mode Status. More...
enum	ModType {   MOD_NA = 0x00U , MOD_A429 = 0x02U , MOD_ANIN = 0x04U , MOD_DIN = 0x08U ,   MOD_DOUT = 0x10U , MOD_PWM = 0x20U , MOD_RVDT = 0x40U , MOD_PSU = 0x80U }
	This is enum definition for Module mask enum for the module type. More...

Functions
ModStatus	modInfo_getDLMInfo (DLMInfo *dlmInfo)
	modInfo_getDLMInfo.
ModStatus	modInfo_getBrdInfo (CardType cardType, BoardInfo *brdInfoPtr)
	modInfo_getBrdInfo.

Detailed Description

Author

Qamaruddin Yunus qamar.nosp@m.uddi.nosp@m.n.yun.nosp@m.us@t.nosp@m.usas..nosp@m.my

Info Module

Macro Definition Documentation

MOD_INFO_BYTE_MASK_0

#define MOD_INFO_BYTE_MASK_0   (0x000000FFU)

MOD_INFO_BYTE_MASK_1

#define MOD_INFO_BYTE_MASK_1   (0x0000FF00U)

MOD_INFO_BYTE_MASK_2

#define MOD_INFO_BYTE_MASK_2   (0x00FF0000U)

MOD_INFO_BYTE_MASK_3

#define MOD_INFO_BYTE_MASK_3   (0xFF000000U)

MOD_INFO_GEN_STR_LEN

#define MOD_INFO_GEN_STR_LEN   (1U)

MOD_INFO_MAX_CARD

#define MOD_INFO_MAX_CARD   (3U)

MOD_INFO_MAX_MFB_CARD

#define MOD_INFO_MAX_MFB_CARD   (2U)

MOD_INFO_MAX_MIO

#define MOD_INFO_MAX_MIO   (5U)

MOD_INFO_MAX_MOD_CHAR

#define MOD_INFO_MAX_MOD_CHAR   (5U)

MOD_INFO_MAX_MOD_TYPE

#define MOD_INFO_MAX_MOD_TYPE   (8U)

MOD_INFO_MFB1_VPX

#define MOD_INFO_MFB1_VPX   (0U)

MOD_INFO_MFB2_VPX

#define MOD_INFO_MFB2_VPX   (1U)

MOD_INFO_MIOA429

#define MOD_INFO_MIOA429   (2U)

MOD_INFO_MIOANIN

#define MOD_INFO_MIOANIN   (3U)

MOD_INFO_MIODIN1

#define MOD_INFO_MIODIN1   (0U)

MOD_INFO_MIODIN2

#define MOD_INFO_MIODIN2   (0U)

MOD_INFO_MIODOUT1

#define MOD_INFO_MIODOUT1   (1U)

MOD_INFO_MIODOUT2

#define MOD_INFO_MIODOUT2   (1U)

MOD_INFO_MIOPSU

#define MOD_INFO_MIOPSU   (0U)

MOD_INFO_MIOPWM

#define MOD_INFO_MIOPWM   (2U)

MOD_INFO_MIORVDT

#define MOD_INFO_MIORVDT   (3U)

MOD_INFO_MODEL_STR_LEN

#define MOD_INFO_MODEL_STR_LEN   (5U)

MOD_INFO_PSU_VPX

#define MOD_INFO_PSU_VPX   (2U)

MOD_INFO_SHIFT_BYTE_0

#define MOD_INFO_SHIFT_BYTE_0   (0U)

MOD_INFO_SHIFT_BYTE_1

#define MOD_INFO_SHIFT_BYTE_1   (8U)

MOD_INFO_SHIFT_BYTE_2

#define MOD_INFO_SHIFT_BYTE_2   (16U)

MOD_INFO_SHIFT_BYTE_3

#define MOD_INFO_SHIFT_BYTE_3   (24U)

MOD_INFO_STR_LEN_4

#define MOD_INFO_STR_LEN_4   (4U)

Enumeration Type Documentation

CardType

enum CardType

This is enum definition for Card Type.

Enumerator
NA_CARD	Card type not applicable or uninitialized.
MFB1_CARD	Main Flight Board 1 (MFB1) processor card.
MFB2_CARD	Main Flight Board 2 (MFB2) processor card.
PSU_CARD	Power Supply Unit (PSU) hardware card.

ModeState

enum ModeState

This is enum definition for Mode Status.

Enumerator
DEFAULT	Default uninitialized operating mode state.
OPEN	Device opened and operational mode state.
CLOSE	Device closed and unmapped mode state.
INIT	Device initialization mode state.
RESET	Reset mode state. Device reset mode state.

ModType

enum ModType

This is enum definition for Module mask enum for the module type.

Enumerator
MOD_NA	No module mask selected (0x00).
MOD_A429	ARINC 429 module identification bitmask (0x02).
MOD_ANIN	Analog Input module identification bitmask (0x04).
MOD_DIN	Discrete Input module identification bitmask (0x08).
MOD_DOUT	Discrete Output module identification bitmask (0x10).
MOD_PWM	Pulse Width Modulation module identification bitmask (0x20).
MOD_RVDT	RVDT module identification bitmask (0x40).
MOD_PSU	Power Supply Unit module identification bitmask (0x80). Power Supply Unit module identification bitmask (0x80).

Function Documentation

modInfo_getBrdInfo()

ModStatus modInfo_getBrdInfo	(	CardType	cardType,
		BoardInfo *	brdInfoPtr )

modInfo_getBrdInfo.

Get board information.

Parameters

[in]	cardType	Card type to access.
[out]	brdInfoPtr	Board information.

Returns

ModStatus - Module status return code, If no error occurs during the operation of the function, it returns MD_SUCCESS. Otherwise related error message is returned.

Return values

MD_SUCCESS	: Success.
MD_INVALID_PARAM	: The provided address pointer is invalid.
MD_OPEN_FAILED	: Channel number is not valid.

Low-Level Software Requirements (LLR)

Low-Level Requirement Specification: modInfo_getBrdInfo

Requirement ID	Parent HLR ID	Detailed Low-Level Requirement Statement (EARS Format)	Software Unit Reference	Verification Method	Status
LLR_INFO_MODINFO_GETBRDINFO_01	HLR_IO_31356	WHEN the pointer brdInfoPtr is NULL (invalid), the modInfo_getBrdInfo() function SHALL abort processing and return MD_INVALID_PARAM.	modInfo.c:modInfo_getBrdInfo()	Test	Closed
LLR_INFO_MODINFO_GETBRDINFO_02	HLR_IO_31356	WHEN cardType is not one of MFB1_CARD through PSU_CARD, the modInfo_getBrdInfo() function SHALL abort processing and return MD_INVALID_CARD.	modInfo.c:modInfo_getBrdInfo()	Test	Closed
LLR_INFO_MODINFO_GETBRDINFO_03	HLR_IO_31356	WHEN the requested card is in OPEN operating state, the modInfo_getBrdInfo() function SHALL read card information registers and populate brdInfoPtr using extractInfo().	modInfo.c:modInfo_getBrdInfo()	Test	Closed
LLR_INFO_MODINFO_GETBRDINFO_04	HLR_IO_31356	WHEN all operational processing completes successfully, the modInfo_getBrdInfo() function SHALL return MD_SUCCESS.	modInfo.c:modInfo_getBrdInfo()	Test	Closed

Control Coupling Diagram (CCD)

Control Coupling Structure Chart

Data Coupling Diagram (DCD)

Data Coupling Structure Chart

Control Flow Diagram (CFD)

Control Flow Diagram

Data Flow Diagram (DFD)

Data Flow Diagram

Here is the call graph for this function:

Here is the caller graph for this function:

modInfo_getDLMInfo()

ModStatus modInfo_getDLMInfo

(

DLMInfo *

dlmInfo

)

modInfo_getDLMInfo.

Get Device Library Module Information.

Parameters

[out]

dlmInfo

DLM Information.

Returns

ModStatus - Module status return code, If no error occurs during the operation of the function, it returns MD_SUCCESS. Otherwise related error message is returned.

Return values

MD_SUCCESS	: Success.
MD_INVALID_PARAM	: The provided address pointer is invalid.

Low-Level Software Requirements (LLR)

Low-Level Requirement Specification: modInfo_getDLMInfo

Requirement ID	Parent HLR ID	Detailed Low-Level Requirement Statement (EARS Format)	Software Unit Reference	Verification Method	Status
LLR_INFO_MODINFO_GETDLMINFO_01	HLR_IO_31356	WHEN the pointer dlmInfo is NULL (invalid), the modInfo_getDLMInfo() function SHALL abort processing and return MD_INVALID_PARAM.	modInfo.c:modInfo_getDLMInfo()	Test	Closed
LLR_INFO_MODINFO_GETDLMINFO_02	HLR_IO_31356	WHEN preconditions are satisfied, the modInfo_getDLMInfo() function SHALL invoke routine memoryOper_set() to execute target subsystem hardware operation.	modInfo.c:modInfo_getDLMInfo()	Test	Closed
LLR_INFO_MODINFO_GETDLMINFO_03	HLR_IO_31356	WHEN all operational processing completes successfully, the modInfo_getDLMInfo() function SHALL return MD_SUCCESS.	modInfo.c:modInfo_getDLMInfo()	Test	Closed

Control Coupling Diagram (CCD)

Control Coupling Structure Chart

Data Coupling Diagram (DCD)

Data Coupling Structure Chart

Control Flow Diagram (CFD)

Control Flow Diagram

Data Flow Diagram (DFD)

Data Flow Diagram

Here is the call graph for this function:

Here is the caller graph for this function: