#define _CL_LIB_H_\r
\r
\r
-/****h* Component Library/Overview\r
+/****h* Component Library/Component Library \r
* NAME\r
-* Overview\r
+* component library \r
*\r
* DESCRIPTION\r
* The component library is a collection of components that can be used to\r
#include <iba/ib_al.h>\r
\r
\r
-/****h* Access Layer/ib_al_ifc.h\r
+/****h* Access Layer/AL Interface\r
* NAME\r
-* ib_al_ifc.h\r
+* AL Interface\r
*\r
* DESCRIPTION\r
* Header file for the interface exported to ICT client drivers for access to\r
#include "iba/ib_ci.h"\r
\r
\r
-/****h* Access Layer/ib_ci_ifc.h\r
+/****h* Access Layer/AL Channel Interface\r
* NAME\r
-* ib_ci_ifc.h\r
+* AL Channel Interface\r
*\r
* DESCRIPTION\r
* Header file for the interface exported to HCA drivers to allow them\r
IN ib_api_status_t status );\r
\r
\r
+\r
+/****s* Access Layer: AL Channel Interface/ib_ci_ifc_t\r
+* NAME\r
+* ib_ci_ifc_t\r
+*\r
+* DESCRIPTION\r
+* \r
+* SYNOPSIS\r
+*/\r
typedef struct _ib_ci_ifc\r
{\r
- /* Standard interface header. */\r
+\r
INTERFACE wdm;\r
\r
ib_pfn_register_ca_t register_ca;\r
ib_pfn_get_err_str_t get_err_str;\r
\r
} ib_ci_ifc_t;\r
+/*\r
+* FIELDS\r
+* wdmr.\r
+* Standard interface header.\r
+*\r
+* register_ca\r
+* Pointer to ib_pfn_register_ca_t function\r
+*\r
+* deregister_ca\r
+* Pointer to ib_pfn_deregister_ca_t function\r
+*\r
+* get_relations\r
+* Pointer to ib_pfn_get_relations_t function\r
+*\r
+* get_err_str\r
+* Pointer to ib_pfn_get_err_str_t function\r
+*\r
+* SEE ALSO\r
+* ib_register_ca,ib_deregister_ca,\r
+*********/\r
\r
\r
#endif /* !defined _IB_CI_IFC_H_ */\r
#define _IOC_IFC_H_\r
\r
\r
-/****h* Access Layer/ioc_ifc.h\r
+/****h* Access Layer/IO Controler Interface\r
* NAME\r
-* ioc_ifc.h\r
+* IO Controler Interface\r
*\r
* DESCRIPTION\r
* Header file for the interface exported to IOC client drivers to retrieve\r
#define IOC_INTERFACE_DATA_VERSION (3)\r
\r
\r
-/* Interface definitions */\r
+\r
+/****s* Access Layer: IO Controler Interface/ioc_ifc_data_t\r
+* NAME\r
+* ioc_ifc_data_t\r
+*\r
+* DESCRIPTION\r
+* I/O Controler interface data.\r
+*\r
+* The ioc_ifc_data_t structure \r
+*\r
+* SYNOPSIS\r
+*/\r
typedef struct _ioc_ifc_data\r
{\r
net64_t ca_guid;\r
net64_t guid;\r
\r
} ioc_ifc_data_t;\r
+/*\r
+* FIELDS\r
+* ca_guid\r
+* Local CA GUID through which IOC is accessible.\r
+*\r
+* guid\r
+* IOC GUID.\r
+*\r
+* SEE ALSO\r
+* \r
+*********/\r
\r
\r
#endif /* !defined _IOC_IFC_H_ */\r
#define _IOU_IFC_H_\r
\r
\r
-/****h* Access Layer/iou_ifc.h\r
+/****h* Access Layer/ IO Unit Interface\r
* NAME\r
-* iou_ifc.h\r
+* IO Unit Interface\r
*\r
* DESCRIPTION\r
* Header file for the interface exported to IOU client drivers to retrieve\r
#define IOU_INTERFACE_DATA_VERSION (4)\r
\r
\r
-/* Interface definitions */\r
+\r
+/****s* Access Layer: IO Unit Interface/iou_ifc_data_t\r
+* NAME\r
+* iou_ifc_data_t\r
+*\r
+* DESCRIPTION\r
+* I/O Unit interface data.\r
+*\r
+* The iou_ifc_data_t structure \r
+*\r
+* SYNOPSIS\r
+*/\r
typedef struct _iou_ifc_data\r
{\r
- /* Local CA GUID through which IOU is accessible. */\r
net64_t ca_guid;\r
-\r
- /* Chassis GUID and slot number */\r
net64_t chassis_guid;\r
uint8_t slot;\r
-\r
- /* IOU GUID. */\r
- net64_t guid;\r
+ net64_t guid;\r
\r
} iou_ifc_data_t;\r
-\r
+/*\r
+* FIELDS\r
+* ca_guid\r
+* Local CA GUID through which IOU is accessible.\r
+*\r
+* chassis_guid\r
+* IOU chassis GUID.\r
+*\r
+* slot\r
+* IOU slot.\r
+*\r
+* guid\r
+* IOU GUID.\r
+*\r
+* SEE ALSO\r
+* \r
+*********/\r
\r
#endif /* !defined _IOU_IFC_H_ */\r
\r
#define _IPOIB_IFC_H_\r
\r
\r
-/****h* Access Layer/ipoib_ifc.h\r
+/****h* Access Layer/IPoIB Interface\r
* NAME\r
-* ipoib_ifc.h\r
+* IPoIB Interface\r
*\r
* DESCRIPTION\r
* Header file for the interface exported to IPoIB client drivers for access\r
#define IPOIB_INTERFACE_DATA_VERSION (5)\r
\r
\r
-/* Interface definitions */\r
+/****s* Access Layer: IPoIB Interface/ipoib_ifc_data_t\r
+* NAME\r
+* ipoib_ifc_data_t\r
+*\r
+* DESCRIPTION\r
+* IPoIB interface datat.\r
+*\r
+* The ipoib_ifc_data_t structure \r
+*\r
+* SYNOPSIS\r
+*/\r
typedef struct _ipoib_ifc_data\r
{\r
- /* HCA and Port GUID */\r
net64_t ca_guid;\r
net64_t port_guid;\r
uint8_t port_num;\r
\r
} ipoib_ifc_data_t;\r
+/*\r
+* FIELDS\r
+* ca_guid\r
+* HCA GUID for this IPoIB interface\r
+*\r
+* port_guid\r
+* Port GUID for this IPoIB interface\r
+*\r
+* port_num\r
+* Port Number GUID for this IPoIB interface\r
+*\r
+* SEE ALSO\r
+* \r
+*********/\r
+\r
\r
\r
#endif /* !defined _IPOIB_IFC_H_ */\r
#include <iba/ib_types.h>\r
#include <iba/ib_ci.h>\r
\r
-/****h* UAL_UVP_Interface/Overview user-mode Verbs\r
+/****h* UAL_UVP_Interface/user-mode Verbs\r
* NAME\r
* User-mode Verbs -- User-mode Verbs implements the HCA specific\r
* user-mode functions to plug in to the Usermode Access Layer\r
#include <iba/ib_types_extended.h>
#endif
-#endif // __IB_TYPES_H__
+#endif /* __IB_TYPES_H__ */
+