Logo
UNICENS V2.1.0-3491
User Manual and API Reference

Referred types used by XRM service functions. More...

Topics

 XRM SubTypes
 Referred types used in XRM Sockets and Ports description.
 

Data Structures

struct  Ucs_Xrm_InitData_t
 The initialization structure of the Extended Resource Manager. More...
 
struct  Ucs_Xrm_ResultDetails_t
 Detailed information used for Extended Resource Manager results. More...
 
struct  Ucs_Xrm_Result_t
 Result structure of the Extended Resource Manager. More...
 
struct  Ucs_Xrm_ResIdentity_t
 Resources Identity from user point of view. More...
 
struct  Ucs_Xrm_DefaultCreatedPort_t
 Configuration structure of a default created port. This structure is used for ports that are configured via the INIC's Configuration String and are automatically created at startup. More...
 
struct  Ucs_Xrm_MostSocket_t
 Configuration structure of a MOST socket. More...
 
struct  Ucs_Xrm_MlbPort_t
 Configuration structure of a MediaLB port. More...
 
struct  Ucs_Xrm_MlbSocket_t
 Configuration structure of a MediaLB socket. More...
 
struct  Ucs_Xrm_UsbPort_t
 Configuration structure of a USB port. More...
 
struct  Ucs_Xrm_UsbSocket_t
 Configuration structure of a USB socket. More...
 
struct  Ucs_Xrm_RmckPort_t
 Configuration structure of a RMCK port. More...
 
struct  Ucs_Xrm_StrmPort_t
 Configuration structure of a streaming port. More...
 
struct  Ucs_Xrm_StrmSocket_t
 Configuration structure of a streaming data socket. More...
 
struct  Ucs_Xrm_SyncCon_t
 Configuration structure of a synchronous data connection. More...
 
struct  Ucs_Xrm_DfiPhaseCon_t
 Configuration structure of a DiscreteFrame Isochronous streaming phase connection. More...
 
struct  Ucs_Xrm_Combiner_t
 Configuration structure of a combiner resource. More...
 
struct  Ucs_Xrm_Splitter_t
 Configuration structure of a splitter resource. More...
 
struct  Ucs_Xrm_AvpCon_t
 Configuration structure for a A/V Packetized isochronous streaming data connection. More...
 
struct  Ucs_Xrm_QoSCon_t
 Configuration structure for a Quality of Service IP streaming data connection. More...
 

Callback Functions

typedef void Ucs_Xrm_ResObject_t
 INIC Resource Object used for Extended Resource Manager jobs.
 
typedef void(* Ucs_Xrm_Stream_PortCfgResCb_t )(uint16_t node_address, uint8_t index, Ucs_Stream_PortOpMode_t op_mode, Ucs_Stream_PortOption_t port_option, Ucs_Stream_PortClockMode_t clock_mode, Ucs_Stream_PortClockDataDelay_t clock_data_delay, Ucs_StdResult_t result, void *user_ptr)
 Function signature of result callback used by Ucs_Xrm_Stream_SetPortConfig() and Ucs_Xrm_Stream_GetPortConfig().
 
typedef void(* Ucs_Xrm_ResourceDebugCb_t )(Ucs_Xrm_ResourceType_t resource_type, Ucs_Xrm_ResObject_t *resource_ptr, Ucs_Xrm_ResourceInfos_t resource_infos, void *endpoint_inst_ptr, void *user_ptr)
 Function signature used for monitoring the XRM resources.
 

Enumerations

enum  Ucs_Xrm_ResultCode_t {
  UCS_XRM_RES_SUCCESS_BUILD = 0x00U,
  UCS_XRM_RES_SUCCESS_DESTROY = 0x01U,
  UCS_XRM_RES_RC_AUTO_DESTROYED = 0x02U,
  UCS_XRM_RES_ERR_CONFIG = 0x03U,
  UCS_XRM_RES_ERR_BUILD = 0x04U,
  UCS_XRM_RES_ERR_DESTROY = 0x05U,
  UCS_XRM_RES_ERR_INV_LIST = 0x06U,
  UCS_XRM_RES_ERR_SYNC = 0x07U,
  UCS_XRM_RES_UNKNOWN = 0xFFU
}
 Result codes of the Extended Resource Manager. More...
 
enum  Ucs_Xrm_ResourceType_t {
  UCS_XRM_RC_TYPE_DC_PORT = 0x00U,
  UCS_XRM_RC_TYPE_MOST_SOCKET = 0x01U,
  UCS_XRM_RC_TYPE_MLB_PORT = 0x02U,
  UCS_XRM_RC_TYPE_MLB_SOCKET = 0x03U,
  UCS_XRM_RC_TYPE_USB_PORT = 0x04U,
  UCS_XRM_RC_TYPE_USB_SOCKET = 0x05U,
  UCS_XRM_RC_TYPE_RMCK_PORT = 0x06U,
  UCS_XRM_RC_TYPE_STRM_PORT = 0x07U,
  UCS_XRM_RC_TYPE_STRM_SOCKET = 0x08U,
  UCS_XRM_RC_TYPE_SYNC_CON = 0x09U,
  UCS_XRM_RC_TYPE_DFIPHASE_CON = 0x0AU,
  UCS_XRM_RC_TYPE_COMBINER = 0x0BU,
  UCS_XRM_RC_TYPE_SPLITTER = 0x0CU,
  UCS_XRM_RC_TYPE_AVP_CON = 0x0DU,
  UCS_XRM_RC_TYPE_QOS_CON = 0x0EU
}
 INIC resource types used by the Extended Resource Manager. More...
 
enum  Ucs_Xrm_PortType_t {
  UCS_XRM_PORT_TYPE_MLB = 0x0AU,
  UCS_XRM_PORT_TYPE_USB = 0x12U,
  UCS_XRM_PORT_TYPE_STRM = 0x16U
}
 Port types use for default created ports. More...
 
enum  Ucs_Xrm_ResultType_t {
  UCS_XRM_RESULT_TYPE_INT = 0x00U,
  UCS_XRM_RESULT_TYPE_TGT = 0x01U,
  UCS_XRM_RESULT_TYPE_TX = 0x02U
}
 This enumerator specifies the kind of result - Internal, Target or Transmission. More...
 
enum  Ucs_Xrm_ResourceInfos_t {
  UCS_XRM_INFOS_BUILT = 0x00U,
  UCS_XRM_INFOS_DESTROYED = 0x01U,
  UCS_XRM_INFOS_ERR_BUILT = 0x02U,
  UCS_XRM_INFOS_ERR_DESTROYED = 0x03U
}
 This enumerator specifies the type of resources information. More...
 

Detailed Description

Referred types used by XRM service functions.