ori.h

/**
* @file ori.h
* @brief Open Radio Interface (ORI) C library header file.
* @author AW2S (http://www.aw2s.com)
* @version 1.8
* @date January 18, 2022
*
* This file is the AW2S REC ORI C library header, and contains all necessary
* functions prototypes, enumerations, data structures and type definitions
* to implement the ORI shared library in an user application.
*/

#ifndef ORI_H_
#define ORI_H_

#define ORILIB_VERSION_MAJOR 1
#define ORILIB_VERSION_MINOR 8

#include <stdint.h>

/*-----------------------------------------------------------------------------------------
 * ORI_RESULT ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_Result_e
 * @brief ORI result codes enumeration.
 */
typedef enum
{
	ORI_Result_SUCCESS = 0,								/**< */
	ORI_Result_FAIL_SYNTAX_ERROR,						/**< */
	ORI_Result_FAIL_UNRECOGNIZED_MESSAGE,				/**< */
	ORI_Result_FAIL_RE_BUSY,							/**< */
	ORI_Result_FAIL_MISSING_PARAMETER,					/**< */
	ORI_Result_FAIL_PARAMETER_ERROR,					/**< */
	ORI_Result_FAIL_FRAME_ERROR,						/**< */
	ORI_Result_FAIL_INVALID_TIMEDATA,					/**< */
	ORI_Result_SUCCESS_SOFTWARE_ALREADY_EXISTING,		/**< */
	ORI_Result_FAIL_FTP_ERROR,							/**< */
	ORI_Result_FAIL_BROKEN_IMAGE,						/**< */
	ORI_Result_FAIL_NO_COMPATIBLE_IMAGE,				/**< */
	ORI_Result_FAIL_CANNOT_STORE,						/**< */
	ORI_Result_FAIL_NOSUCH_IMAGE,						/**< */
	ORI_Result_FAIL_UNKNOWN_OBJECT,						/**< */
	ORI_Result_FAIL_UNKNOWN_PARAM,						/**< */
	ORI_Result_FAIL_PARAMETER_FAIL,						/**< */
	ORI_Result_FAIL_NOSUCH_RESOURCE,					/**< */
	ORI_Result_FAIL_PARAM_READONLY,						/**< */
	ORI_Result_FAIL_PARAM_LOCKREQUIRED,					/**< */
	ORI_Result_FAIL_VALUE_OUTOF_RANGE,					/**< */
	ORI_Result_FAIL_VALUE_TYPE_ERROR,					/**< */
	ORI_Result_FAIL_UNKNOWN_OBJTYPE,					/**< */
	ORI_Result_FAIL_STATIC_OBJTYPE,						/**< */
	ORI_Result_FAIL_CHILD_NOTALLOWED,					/**< */
	ORI_Result_FAIL_OUTOF_RESOURCES,					/**< */
	ORI_Result_FAIL_LOCKREQUIRED,						/**< */
	ORI_Result_FAIL_UNKNOWN_STATETYPE,					/**< */
	ORI_Result_FAIL_UNKNOWN_STATEVALUE,					/**< */
	ORI_Result_FAIL_STATE_READONLY,						/**< */
	ORI_Result_FAIL_RESOURCE_UNAVAILABLE,				/**< */
	ORI_Result_FAIL_RESOURCE_INUSE,						/**< */
	ORI_Result_FAIL_PARENT_CHILD_CONFLICT,				/**< */
	ORI_Result_FAIL_PRECONDITION_NOTMET,				/**< */
	ORI_Result_FAIL_NOSUCH_FILE,						/**< */
	ORI_Result_FAIL_SIZE_LIMIT,							/**< */
	ORI_Result_FAIL_ACTIVATION_ERROR,					/**< */
	ORI_Result_FAIL_ALD_UNAVAILABLE,					/**< */
	ORI_Result_FAIL_BUS_UNAVAILABLE,					/**< */
	ORI_Result_OsError,									/**< */
	ORI_Result_BadParameter,							/**< */
	ORI_Result_InvalidIpAddress,						/**< */
	ORI_Result_ConnectionFailed,						/**< */
	ORI_Result_ConnectionTimedOut,						/**< */
	ORI_Result_NotConnected,							/**< */
	ORI_Result_Unknown,									/**< */
} ORI_Result_e;

/**
 * @brief Get a string describing an ::ORI_Result_e.
 * @param result The ::ORI_Result_e.
 * @return The describing string.
 */
const char * 					ORI_Result_Print(ORI_Result_e result);

/**
 * @brief Get an ::ORI_Result_e from a string.
 * @param resultString The string to match.
 * @return The matched ::ORI_Result_e, or ::ORI_Result_Unknown if failure.
 */
ORI_Result_e 					ORI_Result_Enum(const char * resultString);



/*-----------------------------------------------------------------------------------------
 * ORI_INDICATIONTYPE ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_IndicationType_e
 * @brief ORI indication type enumeration.
 */
typedef enum
{
	ORI_IndicationType_FileTransferComplete = 0,		/**< */
	ORI_IndicationType_ObjectStateChange,				/**< */
	ORI_IndicationType_FaultChange,						/**< */
	ORI_IndicationType_FileAvailable,					/**< */
	ORI_IndicationType_UploadFileCmpl,					/**< */
	ORI_IndicationType_AisgScanDeviceCompl,				/**< */
	ORI_IndicationType_AisgAldRx,						/**< */
	ORI_IndicationType_Unknown,							/**< */
} ORI_IndicationType_e;

/**
 * @brief Get a string describing an ::ORI_IndicationType_e.
 * @param indicationType The ::ORI_IndicationType_e.
 * @return The describing string.
 */
const char * 					ORI_IndicationType_Print(ORI_IndicationType_e indicationType);

/**
 * @brief Get an ::ORI_IndicationType_e from a string.
 * @param indicationTypeString The string to match.
 * @return The matched ::ORI_IndicationType_e, or ::ORI_IndicationType_Unknown if failure.
 */
ORI_IndicationType_e 			ORI_IndicationType_Enum(const char * indicationTypeString);



/*-----------------------------------------------------------------------------------------
 * ORI_OBJECTTYPE ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_ObjectType_e
 * @brief ORI object type enumeration.
 */
typedef enum
{
	ORI_ObjectType_RE = 0,								/**< */
	ORI_ObjectType_AntennaPort,							/**< */
	ORI_ObjectType_TxUtra,								/**< */
	ORI_ObjectType_TxEUtraFDD,							/**< */
	ORI_ObjectType_TxEUtraTDD,							/**< */
	ORI_ObjectType_TxGSM,								/**< */
	ORI_ObjectType_TxNRFDD,								/**< */
	ORI_ObjectType_TxNRTDD,								/**< */
	ORI_ObjectType_RxUtra,								/**< */
	ORI_ObjectType_RxEUtraFDD,							/**< */
	ORI_ObjectType_RxEUtraTDD,							/**< */
	ORI_ObjectType_RxGSM,								/**< */
	ORI_ObjectType_RxNRFDD,								/**< */
	ORI_ObjectType_RxNRTDD,								/**< */
	ORI_ObjectType_ORILink,								/**< */
	ORI_ObjectType_ExternalEventPort,					/**< */
	ORI_ObjectType_AISGPort,							/**< */
	ORI_ObjectType_AISGALD,								/**< */
	ORI_ObjectType_Log,									/**< */
	ORI_ObjectType_DLRoutedIQData,						/**< */
	ORI_ObjectType_ULRoutedIQData,						/**< */
	ORI_ObjectType_DLRoutedCWBlock,						/**< */
	ORI_ObjectType_ULRoutedCWBlock,						/**< */
	ORI_ObjectType_Invalid,								/**< */
} ORI_ObjectType_e;

/**
 * @brief Get a string describing an ::ORI_ObjectType_e.
 * @param objectType The ::ORI_ObjectType_e.
 * @return The describing string.
 */
const char * 					ORI_ObjectType_Print(ORI_ObjectType_e objectType);

/**
 * @brief Get an ::ORI_ObjectType_e from a string.
 * @param objectTypeString The string to match.
 * @return The matched ::ORI_ObjectType_e, or ::ORI_ObjectType_Invalid if failure.
 */
ORI_ObjectType_e 				ORI_ObjectType_Enum(const char * objectTypeString);



/*-----------------------------------------------------------------------------------------
 * ORI_OBJECTPARAM ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_ObjectParam_e
 * @brief ORI object parameter enumeration.
 *
 * All the parameters of all objects are in this list, but only once
 * (therefore some parameters will be used by several object types).
 */
typedef enum
{
	ORI_ObjectParam_RE_VendorID = 0,					/**< */
	ORI_ObjectParam_RE_ProductID,						/**< */
	ORI_ObjectParam_RE_ProductRevision,					/**< */
	ORI_ObjectParam_RE_SerialNumber,					/**< */
	ORI_ObjectParam_RE_ProtocolVer,						/**< */
	ORI_ObjectParam_RE_AGCTargetLevCfgGran,				/**< */
	ORI_ObjectParam_RE_AGCSettlingTimeCfgGran,			/**< */
	ORI_ObjectParam_RE_AGCSettlingTimeCap,				/**< */
	ORI_ObjectParam_RE_AWS_uptime,						/**< */
	ORI_ObjectParam_RE_AWS_inputVoltage,				/**< */
	ORI_ObjectParam_RE_AWS_inputCurrent,				/**< */
	ORI_ObjectParam_RE_AWS_productTemp,					/**< */
	ORI_ObjectParam_RE_AWS_cpuTemp,						/**< */
	ORI_ObjectParam_RE_AWS_paTemp,						/**< */
	ORI_ObjectParam_RE_AWS_rxPwrOffset,					/**< */
	ORI_ObjectParam_Port_portLabel,						/**< */
	ORI_ObjectParam_Port_AWS_outputPwr,					/**< */
	ORI_ObjectParam_Port_AWS_inputPwr,					/**< */
	ORI_ObjectParam_Port_AWS_returnLoss,				/**< */
	ORI_ObjectParam_SigPath_axcW,						/**< */
	ORI_ObjectParam_SigPath_axcB,						/**< */
	ORI_ObjectParam_SigPath_oriLink,					/**< */
	ORI_ObjectParam_SigPath_uarfcn,						/**< */
	ORI_ObjectParam_SigPath_antPort,					/**< */
	ORI_ObjectParam_SigPath_chanBW,						/**< */
	ORI_ObjectParam_SigPath_tddSpecialSFConfig,			/**< */
	ORI_ObjectParam_SigPath_tddULDLConfig,				/**< */
	ORI_ObjectParam_SigPath_earfcn,						/**< */
	ORI_ObjectParam_SigPath_freqBandInd,				/**< */
	ORI_ObjectParam_SigPath_sigmaIQ,					/**< */
	ORI_ObjectParam_SigPath_AWS_enableCompRateChange,	/**< */
	ORI_ObjectParam_SigPath_AWS_enableCompBitChange,	/**< */
	ORI_ObjectParam_SigPath_AWS_measuredPwr,			/**< */
	ORI_ObjectParam_SigPath_AWS_axcIncr,				/**< */
	ORI_ObjectParam_SigPath_AWS_arfcn,					/**< */
	ORI_ObjectParam_TxSigPath_t2a,						/**< */
	ORI_ObjectParam_TxSigPath_maxTxPwr,					/**< */
	ORI_ObjectParam_TxSigPath_dlCalRE,					/**< */
	ORI_ObjectParam_TxSigPath_tddCPLengthDL,			/**< */
	ORI_ObjectParam_TxSigPath_dlCalREMax,				/**< */
	ORI_ObjectParam_TxSigPath_enableIQDLComp,			/**< */
	ORI_ObjectParam_TxSigPath_AWS_enPeakCancel,			/**< */
	ORI_ObjectParam_RxSigPath_ulCalREMax,				/**< */
	ORI_ObjectParam_RxSigPath_ta3,						/**< */
	ORI_ObjectParam_RxSigPath_ulCalRE,					/**< */
	ORI_ObjectParam_RxSigPath_rtwpGroup,				/**< */
	ORI_ObjectParam_RxSigPath_tddCPLengthUL,			/**< */
	ORI_ObjectParam_RxSigPath_ulFeedAdj,				/**< */
	ORI_ObjectParam_RxSigPath_ulTgtRMSLvl,				/**< */
	ORI_ObjectParam_RxSigPath_ulAGCSetlgTime,			/**< */
	ORI_ObjectParam_RxSigPath_TxSigPath,				/**< */
	ORI_ObjectParam_RxSigPath_enableIQULComp,			/**< */
	ORI_ObjectParam_ORILink_portRoleCapability,			/**< */
	ORI_ObjectParam_ORILink_portRole,					/**< */
	ORI_ObjectParam_ORILink_bitRateSupport,				/**< */
	ORI_ObjectParam_ORILink_bitRateRequested,			/**< */
	ORI_ObjectParam_ORILink_bitRateOperational,			/**< */
	ORI_ObjectParam_ORILink_localPortID,				/**< */
	ORI_ObjectParam_ORILink_remotePortID,				/**< */
	ORI_ObjectParam_ORILink_toffset,					/**< */
	ORI_ObjectParam_ORILink_oriLinkType,				/**< */
	ORI_ObjectParam_ORILink_AWS_localMAC,				/**< */
	ORI_ObjectParam_ORILink_AWS_remoteMAC,				/**< */
	ORI_ObjectParam_ORILink_AWS_t14,					/**< */
	ORI_ObjectParam_ORILink_AWS_sfpTxPow,				/**< */
	ORI_ObjectParam_ORILink_AWS_sfpRxPow,				/**< */
	ORI_ObjectParam_ORILink_AWS_remoteIP,				/**< */
	ORI_ObjectParam_ORILink_AWS_localIP,				/**< */
	ORI_ObjectParam_ORILink_AWS_remoteUdpPort,			/**< */
	ORI_ObjectParam_ORILink_AWS_localUdpPort,			/**< */
	ORI_ObjectParam_AISGPort_busPowerEnable,			/**< */
	ORI_ObjectParam_AISGALD_deviceType,					/**< */
	ORI_ObjectParam_AISGALD_UID,						/**< */
	ORI_ObjectParam_AISGALD_releaseID,					/**< */
	ORI_ObjectParam_AISGALD_aisgVersion,				/**< */
	ORI_ObjectParam_AISGALD_deviceTypeVersion,			/**< */
	ORI_ObjectParam_AISGALD_frameLength,				/**< */
	ORI_ObjectParam_AISGALD_hdlcAdress,					/**< */
	ORI_ObjectParam_Log_logTypeID,						/**< */
	ORI_ObjectParam_Log_description,					/**< */
	ORI_ObjectParam_Log_logCategory,					/**< */
	ORI_ObjectParam_Log_maxREfileSize,					/**< */
	ORI_ObjectParam_Log_maxRECfileSize,					/**< */
	ORI_ObjectParam_Log_enableNotification,				/**< */
	ORI_ObjectParam_Log_fileAvailable,					/**< */
	ORI_ObjectParam_Log_overflowBehaviour,				/**< */
	ORI_ObjectParam_Log_recordingEnabled,				/**< */
	ORI_ObjectParam_Log_logPeriod,						/**< */
	ORI_ObjectParam_Log_timerType,						/**< */
	ORI_ObjectParam_Routed_MasterPortOriLink,			/**< */
	ORI_ObjectParam_Routed_SlavePortOriLink,			/**< */
	ORI_ObjectParam_RoutedIQData_IQsubBlockSize,		/**< */
	ORI_ObjectParam_RoutedIQData_MasterPortIQblkW,		/**< */
	ORI_ObjectParam_RoutedIQData_MasterPortIQblkB,		/**< */
	ORI_ObjectParam_RoutedIQData_SlavePortIQW,			/**< */
	ORI_ObjectParam_RoutedIQData_SlavePortIQB,			/**< */
	ORI_ObjectParam_RoutedIQData_TBDelayDL,				/**< */
	ORI_ObjectParam_RoutedIQData_TBDelayUL,				/**< */
	ORI_ObjectParam_RoutedCWBlock_CtrlBlockSize,		/**< */
	ORI_ObjectParam_RoutedCWBlock_SubChannelStart,		/**< */
	ORI_ObjectParam_RoutedCWBlock_Ydepth,				/**< */
	ORI_ObjectParam_RoutedCWBlock_SlavePortYoffset,		/**< */
	ORI_ObjectParam_RoutedCWBlock_MasterPortYoffset,	/**< */
	ORI_ObjectParam_All,								/**< */
	ORI_ObjectParam_Invalid,							/**< */
} ORI_ObjectParam_e;

/**
 * @brief Get a string describing an ::ORI_ObjectParam_e.
 * @param objectParam The ::ORI_ObjectParam_e.
 * @return The describing string.
 */
const char * 					ORI_ObjectParam_Print(ORI_ObjectParam_e objectParam);

/**
 * @brief Get an ::ORI_ObjectParam_e from a string.
 * @param objectParamString The string to match.
 * @return The matched ::ORI_ObjectParam_e, or ::ORI_ObjectParam_Invalid if failure.
 */
ORI_ObjectParam_e 				ORI_ObjectParam_Enum(const char * objectParamString);



/*-----------------------------------------------------------------------------------------
 * ORI_STATETYPE ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_StateType_e
 * @brief ORI state type enumeration.
 */
typedef enum
{
	ORI_StateType_AST = 0,								/**< */
	ORI_StateType_FST,									/**< */
	ORI_StateType_All,									/**< */
	ORI_StateType_Invalid,								/**< */
} ORI_StateType_e;

/**
 * @brief Get a string describing an ::ORI_StateType_e.
 * @param stateType The ::ORI_StateType_e.
 * @return The describing string.
 */
const char * 					ORI_StateType_Print(ORI_StateType_e stateType);

/**
 * @brief Get an ::ORI_StateType_e from a string.
 * @param stateTypeString The string to match.
 * @return The matched ::ORI_StateType_e, or ::ORI_StateType_Invalid if failure.
 */
ORI_StateType_e 				ORI_StateType_Enum(const char * stateTypeString);



/*-----------------------------------------------------------------------------------------
 * ORI_AST ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_AST_e
 * @brief ORI AST enumeration.
 */
typedef enum
{
	ORI_AST_Locked = 0,									/**< */
	ORI_AST_Unlocked,									/**< */
	ORI_AST_Invalid,									/**< */
} ORI_AST_e;

/**
 * @brief Get a string describing an ::ORI_AST_e.
 * @param ast The ::ORI_AST_e.
 * @return The describing string.
 */
const char * 					ORI_AST_Print(ORI_AST_e ast);

/**
 * @brief Get an ::ORI_AST_e from a string.
 * @param astString The string to match.
 * @return The matched ::ORI_AST_e, or ::ORI_AST_Invalid if failure.
 */
ORI_AST_e 						ORI_AST_Enum(const char * astString);



/*-----------------------------------------------------------------------------------------
 * ORI_FST ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_FST_e
 * @brief ORI FST enumeration.
 */
typedef enum
{
	ORI_FST_PreOperational = 0,							/**< */
	ORI_FST_Operational,								/**< */
	ORI_FST_Degraded,									/**< */
	ORI_FST_Failed,										/**< */
	ORI_FST_NotOperational,								/**< */
	ORI_FST_Disabled,									/**< */
	ORI_FST_Invalid,									/**< */
} ORI_FST_e;

/**
 * @brief Get a string describing an ::ORI_FST_e.
 * @param fst The ::ORI_FST_e.
 * @return The describing string.
 */
const char * 					ORI_FST_Print(ORI_FST_e fst);

/**
 * @brief Get an ::ORI_FST_e from a string.
 * @param fstString The string to match.
 * @return The matched ::ORI_FST_e, or ::ORI_FST_Invalid if failure.
 */
ORI_FST_e 						ORI_FST_Enum(const char * fstString);



/*-----------------------------------------------------------------------------------------
 * ORI_AGCGRANULARITY ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_agcGranularity_e
 * @brief AGC granularity capability enumeration.
 */
typedef enum
{
	ORI_agcGranularity_RxSigPath = 0,					/**< */
	ORI_agcGranularity_RE,								/**< */
	ORI_agcGranularity_Invalid,							/**< */
} ORI_agcGranularity_e;

/**
 * @brief Get a string describing an ::ORI_agcGranularity_e.
 * @param agcGranularity The ::ORI_agcGranularity_e.
 * @return The describing string.
 */
const char * 					ORI_agcGranularity_Print(ORI_agcGranularity_e agcGranularity);

/**
 * @brief Get an ::ORI_agcGranularity_e from a string.
 * @param agcGranularityString The string to match.
 * @return The matched ::ORI_agcGranularity_e, or ::ORI_agcGranularity_Invalid if failure.
 */
ORI_agcGranularity_e 			ORI_agcGranularity_Enum(const char * agcGranularityString);



/*-----------------------------------------------------------------------------------------
 * ORI_TDDCPLENGTH ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_tddCPLength_e
 * @brief TDD cyclic prefix length enumeration.
 */
typedef enum
{
	ORI_tddCPLength_Normal = 0,							/**< */
	ORI_tddCPLength_Extended,							/**< */
	ORI_tddCPLength_Invalid,							/**< */
} ORI_tddCPLength_e;

/**
 * @brief Get a string describing an ::ORI_tddCPLength_e.
 * @param tddCPLength The ::ORI_tddCPLength_e.
 * @return The describing string.
 */
const char * 					ORI_tddCPLength_Print(ORI_tddCPLength_e tddCPLength);

/**
 * @brief Get a ::ORI_tddCPLength_e from a string.
 * @param tddCPLengthString The string to match.
 * @return The matched ::ORI_tddCPLength_e, or ::ORI_tddCPLength_Invalid if failure.
 */
ORI_tddCPLength_e 				ORI_tddCPLength_Enum(const char * tddCPLengthString);



/*-----------------------------------------------------------------------------------------
 * ORI_FREQBAND ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_freqBand_e
 * @brief GSM frequency band enumeration.
 */
typedef enum
{
	ORI_freqBand_GSM850 = 0,							/**< */
	ORI_freqBand_PGSM900,								/**< */
	ORI_freqBand_DCS1800,								/**< */
	ORI_freqBand_PCS1900,								/**< */
	ORI_freqBand_Invalid,								/**< */
} ORI_freqBand_e;

/**
 * @brief Get a string describing an ::ORI_freqBand_e.
 * @param freqBand The ::ORI_freqBand_e.
 * @return The describing string.
 */
const char * 					ORI_freqBand_Print(ORI_freqBand_e freqBand);

/**
 * @brief Get a ::ORI_freqBand_e from a string.
 * @param freqBandString The string to match.
 * @return The matched ::ORI_freqBand_e, or ::ORI_freqBand_Invalid if failure.
 */
ORI_freqBand_e 					ORI_freqBand_Enum(const char * freqBandString);



/*-----------------------------------------------------------------------------------------
 * ORI_PORTROLE ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_portRole_e
 * @brief ORI link port role enumeration.
 */
typedef enum
{
	ORI_portRole_Master = 0,							/**< */
	ORI_portRole_Slave,									/**< */
	ORI_portRole_Invalid,								/**< */
} ORI_portRole_e;

/**
 * @brief Get a string describing an ::ORI_portRole_e.
 * @param portRole The ::ORI_portRole_e.
 * @return The describing string.
 */
const char * 					ORI_portRole_Print(ORI_portRole_e portRole);

/**
 * @brief Get a ::ORI_portRole_e from a string.
 * @param portRoleString The string to match.
 * @return The matched ::ORI_portRole_e, or ::ORI_portRole_Invalid if failure.
 */
ORI_portRole_e 					ORI_portRole_Enum(const char * portRoleString);



/*-----------------------------------------------------------------------------------------
 * ORI_PORTROLECAPABILITY ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_portRoleCapability_e
 * @brief ORI Link port role capability enumeration.
 */
typedef enum
{
	ORI_portRoleCapability_MO = 0,						/**< */
	ORI_portRoleCapability_SO,							/**< */
	ORI_portRoleCapability_MS,							/**< */
	ORI_portRoleCapability_Invalid,						/**< */
} ORI_portRoleCapability_e;

/**
 * @brief Get a string describing an ::ORI_portRoleCapability_e.
 * @param portRoleCapability The ::ORI_portRoleCapability_e.
 * @return The describing string.
 */
const char * 					ORI_portRoleCapability_Print(ORI_portRoleCapability_e portRoleCapability);

/**
 * @brief Get an ::ORI_portRoleCapability_e from a string.
 * @param portRoleCapabilityString The string to match.
 * @return The matched ::ORI_portRoleCapability_e, or ::ORI_portRoleCapability_Invalid if failure.
 */
ORI_portRoleCapability_e 		ORI_portRoleCapability_Enum(const char * portRoleCapabilityString);



/*-----------------------------------------------------------------------------------------
 * ORI_LINKTYPE ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_linkType_e
 * @brief ORI Link type enumeration.
 */
typedef enum
{
	ORI_linkType_Active = 0,							/**< */
	ORI_linkType_Passive,								/**< */
	ORI_linkType_Invalid,								/**< */
} ORI_linkType_e;


/**
 * @brief Get a string describing an ::ORI_linkType_e.
 * @param linkType The ::ORI_linkType_e.
 * @return The describing string.
 */
const char * 					ORI_linkType_Print(ORI_linkType_e linkType);

/**
 * @brief Get an ::ORI_linkType_e from a string.
 * @param linkTypeString The string to match.
 * @return The matched ::ORI_linkType_e, or ::ORI_linkType_Invalid if failure.
 */
ORI_linkType_e 					ORI_linkType_Enum(const char * linkTypeString);



/*-----------------------------------------------------------------------------------------
 * ORI_BOOLEAN ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_Boolean_e
 * @brief ORI boolean enumeration.
 */
typedef enum
{
	ORI_Boolean_False = 0,								/**< */
	ORI_Boolean_True,									/**< */
	ORI_Boolean_Invalid,								/**< */
} ORI_Boolean_e;

/**
 * @brief Get a string describing an ::ORI_Boolean_e.
 * @param boolean The ::ORI_Boolean_e.
 * @return The describing string.
 */
const char * 					ORI_Boolean_Print(ORI_Boolean_e boolean);

/**
 * @brief Get an ::ORI_Boolean_e from a string.
 * @param booleanString The string to match.
 * @return The matched ::ORI_Boolean_e, or ::ORI_Boolean_Invalid if failure.
 */
ORI_Boolean_e 					ORI_Boolean_Enum(const char * booleanString);



/*-----------------------------------------------------------------------------------------
 * ORI_LOGCATEGORY ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_logCategory_e
 * @brief Log category enumeration.
 *
 */
typedef enum
{
	ORI_logCategory_Fault = 0,							/**< */
	ORI_logCategory_Perf,								/**< */
	ORI_logCategory_System,								/**< */
	ORI_logCategory_Crash,								/**< */
	ORI_logCategory_Application,						/**< */
	ORI_logCategory_Debug,								/**< */
	ORI_logCategory_Other,								/**< */
	ORI_logCategory_Invalid,							/**< */
} ORI_logCategory_e;

/**
 * @brief Get a string describing an ::ORI_logCategory_e.
 * @param logCategory The ::ORI_logCategory_e.
 * @return The describing string.
 */
const char * 					ORI_logCategory_Print(ORI_logCategory_e logCategory);

/**
 * @brief Get an ::ORI_logCategory_e from a string.
 * @param logCategoryString The string to match.
 * @return The matched ::ORI_logCategory_e, or ::ORI_logCategory_Invalid if failure.
 */
ORI_logCategory_e 				ORI_logCategory_Enum(const char * logCategoryString);



/*-----------------------------------------------------------------------------------------
 * ORI_OVERFLOWBEHAVIOUR ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_overflowBehaviour_e
 * @brief Log overflow behaviour enumeration.
 *
 */
typedef enum
{
	ORI_overflowBehaviour_Stop = 0,						/**< */
	ORI_overflowBehaviour_Fifo,							/**< */
	ORI_overflowBehaviour_Invalid,						/**< */
} ORI_overflowBehaviour_e;

/**
 * @brief Get a string describing an ::ORI_overflowBehaviour_e.
 * @param overflowBehaviour The ::ORI_overflowBehaviour_e.
 * @return The describing string.
 */
const char * 					ORI_overflowBehaviour_Print(ORI_overflowBehaviour_e overflowBehaviour);

/**
 * @brief Get an ::ORI_overflowBehaviour_e from a string.
 * @param overflowBehaviourString The string to match.
 * @return The matched ::ORI_overflowBehaviour_e, or ::ORI_overflowBehaviour_Invalid if failure.
 */
ORI_overflowBehaviour_e 		ORI_overflowBehaviour_Enum(const char * overflowBehaviourString);



/*-----------------------------------------------------------------------------------------
 * ORI_TIMERTYPE ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_timerType_e
 * @brief Log timer type enumeration.
 */
typedef enum
{
	ORI_timerType_OneShot = 0,							/**< */
	ORI_timerType_Periodic,								/**< */
	ORI_timerType_Invalid,								/**< */
} ORI_timerType_e;

/**
 * @brief Get a string describing an ::ORI_timerType_e.
 * @param timerType The ::ORI_timerType_e.
 * @return The describing string.
 */
const char * 					ORI_timerType_Print(ORI_timerType_e timerType);

/**
 * @brief Get an ::ORI_timerType_e from a string.
 * @param timerTypeString The string to match.
 * @return The matched ::ORI_timerType_e, or ::ORI_timerType_Invalid if failure.
 */
ORI_timerType_e 				ORI_timerType_Enum(const char * timerTypeString);



/*-----------------------------------------------------------------------------------------
 *	ORI_FAULTTYPE ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_FaultType_e
 * @brief ORI fault types enumeration.
 */
typedef enum
{
	ORI_FaultType_RE_ExtSupplyUnderVolt = 0,			/**< */
	ORI_FaultType_RE_OverTemp,							/**< */
	ORI_FaultType_RE_DigInOverdrive,					/**< */
	ORI_FaultType_RE_RFOutOverdrive,					/**< */
	ORI_FaultType_RE_TXGainFail,						/**< */
	ORI_FaultType_RE_RXGainFail,						/**< */
	ORI_FaultType_AntennaPort_VSWROutOfRange,			/**< */
	ORI_FaultType_AntennaPort_NonAisgTmaMalfct,			/**< */
	ORI_FaultType_ORILink_LinkFail,						/**< */
	ORI_FaultType_ORILink_PortFail,						/**< */
	ORI_FaultType_ORILink_SyncFail,						/**< */
	ORI_FaultType_AISGPort_AisgMalfct,					/**< */
	ORI_FaultType_Invalid,
} ORI_FaultType_e;

/**
 * @brief Get a string describing an ::ORI_FaultType_e.
 * @param faultType The ::ORI_FaultType_e.
 * @return The describing string.
 */
const char * 					ORI_FaultType_Print(ORI_FaultType_e faultType);

/**
 * @brief Get an ::ORI_FaultType_e from a string.
 * @param faultTypeString The string to match.
 * @return The matched ::ORI_FaultType_e, or ::ORI_FaultType_Invalid if failure.
 */
ORI_FaultType_e 				ORI_FaultType_Enum(const char * faultTypeString);



/*-----------------------------------------------------------------------------------------
 * ORI_FAULTSTATE ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_FaultState_e
 * @brief ORI RE fault state enumeration.
 */
typedef enum
{
    ORI_FaultState_Cleared = 0,							/**< */
    ORI_FaultState_Active,								/**< */
    ORI_FaultState_Unknown,								/**< */
} ORI_FaultState_e;

/**
 * @brief Get a string describing an ::ORI_FaultState_e.
 * @param faultState The ::ORI_FaultState_e.
 * @return The describing string.
 */
const char * 					ORI_FaultState_Print(ORI_FaultState_e faultState);

/**
 * @brief Get an ::ORI_FaultState_e from a string.
 * @param faultStateString The string to match.
 * @return The matched ::ORI_FaultState_e, or ::ORI_FaultState_Unknown if failure.
 */
ORI_FaultState_e 				ORI_FaultState_Enum(const char * faultStateString);



/*-----------------------------------------------------------------------------------------
 * ORI_FAULTSEVERITY ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_FaultSeverity_e
 * @brief ORI RE fault severity enumeration.
 */
typedef enum
{
	ORI_FaultSeverity_Failed = 0,						/**< */
	ORI_FaultSeverity_Degraded,							/**< */
	ORI_FaultSeverity_Warning,							/**< */
	ORI_FaultSeverity_Unknown,							/**< */
} ORI_FaultSeverity_e;

/**
 * @brief Get a string describing an ::ORI_FaultSeverity_e.
 * @param faultSeverity The ::ORI_FaultSeverity_e.
 * @return The describing string.
 */
const char * 					ORI_FaultSeverity_Print(ORI_FaultSeverity_e faultSeverity);

/**
 * @brief Get an ::ORI_FaultSeverity_e from a string.
 * @param faultSeverityString The string to match.
 * @return The matched ::ORI_FaultSeverity_e, or ::ORI_FaultSeverity_Unknown if failure.
 */
ORI_FaultSeverity_e 			ORI_FaultSeverity_Enum(const char * faultSeverityString);



/*-----------------------------------------------------------------------------------------
 * ORI_EVENTDRIVENREPORT ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_EventDrivenReport_e
 * @brief Event driven reporting enumeration.
 */
typedef enum
{
	ORI_EventDrivenReport_NoModify = 0,					/**< */
	ORI_EventDrivenReport_True,							/**< */
	ORI_EventDrivenReport_False,						/**< */
	ORI_EventDrivenReport_Invalid,						/**< */
} ORI_EventDrivenReport_e;



/*-----------------------------------------------------------------------------------------
 * ORI_AISGLAYER7COMMAND ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_AisgLayer7Command_e
 * @brief Aisg Layer7 commands byte code enumeration.
 */
typedef enum
{
	ORI_AisgLayer7Command_Unknown 					= 0,			/**< */
	/* Common procedures */
	ORI_AisgLayer7Command_Reset						= 0x03,			/**< */
	ORI_AisgLayer7Command_GetAlarmStatus			= 0x04,			/**< */
	ORI_AisgLayer7Command_GetInfo 					= 0x05,			/**< */
	ORI_AisgLayer7Command_ClearActiveAlarms			= 0x06,			/**< */
	ORI_AisgLayer7Command_SelfTest					= 0x0A,			/**< */
	ORI_AisgLayer7Command_ReadUserData				= 0x10,			/**< */
	ORI_AisgLayer7Command_WriteUserData				= 0x11,			/**< */
	ORI_AisgLayer7Command_AlarmSubscribe			= 0x12,			/**< */
	ORI_AisgLayer7Command_DownloadStart				= 0x40,			/**< */
	ORI_AisgLayer7Command_DownloadApplication		= 0x41,			/**< */
	ORI_AisgLayer7Command_DownloadEnd				= 0x42,			/**< */
	/* Single Antenna RET procedures */
	ORI_AisgLayer7Command_RetSingle_AlarmIndication	= 0x07,			/**< */
	ORI_AisgLayer7Command_RetSingle_SetDeviceData	= 0x0E,			/**< */
	ORI_AisgLayer7Command_RetSingle_GetDeviceData	= 0x0F,			/**< */
	ORI_AisgLayer7Command_RetSingle_Calibrate 		= 0x31,			/**< */
	ORI_AisgLayer7Command_RetSingle_SendConfigData	= 0x32,			/**< */
	ORI_AisgLayer7Command_RetSingle_SetTilt 		= 0x33,			/**< */
	ORI_AisgLayer7Command_RetSingle_GetTilt 		= 0x34,			/**< */
	/* Multi Antenna RET procedures */
	ORI_AisgLayer7Command_RetMulti_Calibrate 		= 0x80,			/**< */
	ORI_AisgLayer7Command_RetMulti_SetTilt 			= 0x81,			/**< */
	ORI_AisgLayer7Command_RetMulti_GetTilt 			= 0x82,			/**< */
	ORI_AisgLayer7Command_RetMulti_SetDeviceData	= 0x83,			/**< */
	ORI_AisgLayer7Command_RetMulti_GetDeviceData	= 0x84,			/**< */
	ORI_AisgLayer7Command_RetMulti_AlarmIndication	= 0x85,			/**< */
	ORI_AisgLayer7Command_RetMulti_ClearActiveAlarms= 0x86,			/**< */
	ORI_AisgLayer7Command_RetMulti_GetAlarmStatus	= 0x87,			/**< */
	ORI_AisgLayer7Command_RetMulti_GetNbrAntenna	= 0x88,			/**< */
	ORI_AisgLayer7Command_RetMulti_SendConfigData	= 0x89,			/**< */
	/* added specific command to check the existence of the aisg port from the model (this is not a real aisg command!) */
	ORI_AisgLayer7Command_CheckAisgPortExist		= 0xFE,			/**< */
	/* added specific command to get the aisg ALD device type from the model (this is not a real aisg command!) */
	ORI_AisgLayer7Command_GetDeviceType				= 0xFF,			/**< */
} ORI_AisgLayer7Command_e;


/*-----------------------------------------------------------------------------------------
 * ORI_AISGRETURNCODE ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_AisgReturnCode_e
 * @brief Aisg return code enumeration.
 */
typedef enum
{
	ORI_AisgReturnCode_OK 					= 0,			/**< */
	ORI_AisgReturnCode_MotorJam				= 0x02,			/**< */
	ORI_AisgReturnCode_ActuatorJam			= 0x03,			/**< */
	ORI_AisgReturnCode_Busy 				= 0x05,			/**< */
	ORI_AisgReturnCode_Checksum 			= 0x06,			/**< */
	ORI_AisgReturnCode_FAIL 				= 0x0B,			/**< */
	ORI_AisgReturnCode_NotCalibrated		= 0x0E,			/**< */
	ORI_AisgReturnCode_NotConfigured		= 0x0F,			/**< */
	ORI_AisgReturnCode_Hardware				= 0x11,			/**< */
	ORI_AisgReturnCode_OutOfRange			= 0x13,			/**< */
	ORI_AisgReturnCode_UnknownProcedure		= 0x19,			/**< */
	ORI_AisgReturnCode_ReadOnly 			= 0x1D,			/**< */
	ORI_AisgReturnCode_UnknownParameter		= 0x1E,			/**< */
	ORI_AisgReturnCode_WorkingSWMissing		= 0x21,			/**< */
	ORI_AisgReturnCode_InvalidFileContent	= 0x22,			/**< */
	ORI_AisgReturnCode_FormatError 			= 0x24,			/**< */
	ORI_AisgReturnCode_UnsupportedProcedure	= 0x25,			/**< */
	ORI_AisgReturnCode_InvalidProcedureSeq	= 0x26,			/**< */
	ORI_AisgReturnCode_ActuatorInterference	= 0x27,			/**< */
	ORI_AisgReturnCode_Unknown,
} ORI_AisgReturnCode_e;

/**
 * @brief Get a string describing an ::ORI_AisgReturnCode_e.
 * @param returnCode The ::ORI_AisgReturnCode_e.
 * @return The describing string.
 */
const char * 					ORI_AisgReturnCode_Print(ORI_AisgReturnCode_e returnCode);

/**
 * @brief Get an ::ORI_AisgReturnCode_e from a string.
 * @param returnCodeString The string to match.
 * @return The matched ::ORI_AisgReturnCode_e, or ::ORI_AisgReturnCode_Unknown if failure.
 */
ORI_AisgReturnCode_e 			ORI_AisgReturnCode_Enum(const char * returnCodeString);


/*-----------------------------------------------------------------------------------------
 * ORI_AISGDEVICEDATA ENUMERATION
 *-----------------------------------------------------------------------------------------*/

/**
 * @enum ORI_AisgDeviceData_e
 * @brief Aisg device data fields enumeration.
 */
typedef enum
{
	ORI_AisgDeviceData_AntennaModelNbr		= 1,			/**< */
	ORI_AisgDeviceData_AntennaSerialNbr		= 2,			/**< */
	ORI_AisgDeviceData_AntennaFreqBand		= 3,			/**< */
	ORI_AisgDeviceData_BeamwidthBand		= 4,			/**< */
	ORI_AisgDeviceData_GainBand				= 5,			/**< */
	ORI_AisgDeviceData_MaxTilt				= 6,			/**< */
	ORI_AisgDeviceData_MinTilt				= 7,			/**< */
	ORI_AisgDeviceData_InstallationDate		= 0x21,			/**< */
	ORI_AisgDeviceData_InstallerID			= 0x22,			/**< */
	ORI_AisgDeviceData_BasestationID		= 0x23,			/**< */
	ORI_AisgDeviceData_SectorID				= 0x24,			/**< */
	ORI_AisgDeviceData_AntennaBearing		= 0x25,			/**< */
	ORI_AisgDeviceData_MechanicalTilt		= 0x26,			/**< */
	ORI_AisgDeviceData_Unknown,
} ORI_AisgDeviceData_e;

/**
 * @brief Get a string describing an ::ORI_AisgDeviceData_e.
 * @param field The ::ORI_AisgDeviceData_e.
 * @return The describing string.
 */
const char * 					ORI_AisgDeviceDataField_Print(ORI_AisgDeviceData_e field);

/**
 * @brief Get an ::ORI_AisgDeviceData_e from a string.
 * @param fieldString The string to match.
 * @return The matched ::ORI_AisgDeviceData_e, or ::ORI_AisgDeviceData_Unknown if failure.
 */
ORI_AisgDeviceData_e 			ORI_AisgDeviceDataField_Enum(const char * fieldString);



/*-----------------------------------------------------------------------------------------
 * OBJECT TYPE REFERENCE
 *-----------------------------------------------------------------------------------------*/