From cf36ed9eff8f603164c263dcd614283bd23213d9 Mon Sep 17 00:00:00 2001 From: sleybo Date: Sun, 12 Nov 2006 14:46:06 +0000 Subject: [PATCH] [INC] cosmetic changes for docs auto generation git-svn-id: svn://openib.tc.cornell.edu/gen1@540 ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86 --- trunk/inc/complib/comp_lib.h | 4 +- trunk/inc/kernel/iba/ib_al_ifc.h | 4 +- trunk/inc/kernel/iba/ib_ci_ifc.h | 35 ++++++++++++++-- trunk/inc/kernel/iba/ioc_ifc.h | 28 +++++++++++-- trunk/inc/kernel/iba/iou_ifc.h | 42 +++++++++++++++----- trunk/inc/kernel/iba/ipoib_ifc.h | 32 +++++++++++++-- trunk/inc/user/iba/ib_uvp.h | 2 +- trunk/ulp/opensm/user/include/iba/ib_types.h | 3 +- 8 files changed, 124 insertions(+), 26 deletions(-) diff --git a/trunk/inc/complib/comp_lib.h b/trunk/inc/complib/comp_lib.h index ce439e0b..39f5e0cb 100644 --- a/trunk/inc/complib/comp_lib.h +++ b/trunk/inc/complib/comp_lib.h @@ -44,9 +44,9 @@ #define _CL_LIB_H_ -/****h* Component Library/Overview +/****h* Component Library/Component Library * NAME -* Overview +* component library * * DESCRIPTION * The component library is a collection of components that can be used to diff --git a/trunk/inc/kernel/iba/ib_al_ifc.h b/trunk/inc/kernel/iba/ib_al_ifc.h index c28bc9ff..7b15737f 100644 --- a/trunk/inc/kernel/iba/ib_al_ifc.h +++ b/trunk/inc/kernel/iba/ib_al_ifc.h @@ -38,9 +38,9 @@ #include -/****h* Access Layer/ib_al_ifc.h +/****h* Access Layer/AL Interface * NAME -* ib_al_ifc.h +* AL Interface * * DESCRIPTION * Header file for the interface exported to ICT client drivers for access to diff --git a/trunk/inc/kernel/iba/ib_ci_ifc.h b/trunk/inc/kernel/iba/ib_ci_ifc.h index e5c1bab4..00ceaf94 100644 --- a/trunk/inc/kernel/iba/ib_ci_ifc.h +++ b/trunk/inc/kernel/iba/ib_ci_ifc.h @@ -38,9 +38,9 @@ #include "iba/ib_ci.h" -/****h* Access Layer/ib_ci_ifc.h +/****h* Access Layer/AL Channel Interface * NAME -* ib_ci_ifc.h +* AL Channel Interface * * DESCRIPTION * Header file for the interface exported to HCA drivers to allow them @@ -78,9 +78,18 @@ typedef const char* IN ib_api_status_t status ); + +/****s* Access Layer: AL Channel Interface/ib_ci_ifc_t +* NAME +* ib_ci_ifc_t +* +* DESCRIPTION +* +* SYNOPSIS +*/ typedef struct _ib_ci_ifc { - /* Standard interface header. */ + INTERFACE wdm; ib_pfn_register_ca_t register_ca; @@ -89,6 +98,26 @@ typedef struct _ib_ci_ifc ib_pfn_get_err_str_t get_err_str; } ib_ci_ifc_t; +/* +* FIELDS +* wdmr. +* Standard interface header. +* +* register_ca +* Pointer to ib_pfn_register_ca_t function +* +* deregister_ca +* Pointer to ib_pfn_deregister_ca_t function +* +* get_relations +* Pointer to ib_pfn_get_relations_t function +* +* get_err_str +* Pointer to ib_pfn_get_err_str_t function +* +* SEE ALSO +* ib_register_ca,ib_deregister_ca, +*********/ #endif /* !defined _IB_CI_IFC_H_ */ diff --git a/trunk/inc/kernel/iba/ioc_ifc.h b/trunk/inc/kernel/iba/ioc_ifc.h index 990f88dd..6ea9328b 100644 --- a/trunk/inc/kernel/iba/ioc_ifc.h +++ b/trunk/inc/kernel/iba/ioc_ifc.h @@ -38,9 +38,9 @@ #define _IOC_IFC_H_ -/****h* Access Layer/ioc_ifc.h +/****h* Access Layer/IO Controler Interface * NAME -* ioc_ifc.h +* IO Controler Interface * * DESCRIPTION * Header file for the interface exported to IOC client drivers to retrieve @@ -53,13 +53,35 @@ #define IOC_INTERFACE_DATA_VERSION (3) -/* Interface definitions */ + +/****s* Access Layer: IO Controler Interface/ioc_ifc_data_t +* NAME +* ioc_ifc_data_t +* +* DESCRIPTION +* I/O Controler interface data. +* +* The ioc_ifc_data_t structure +* +* SYNOPSIS +*/ typedef struct _ioc_ifc_data { net64_t ca_guid; net64_t guid; } ioc_ifc_data_t; +/* +* FIELDS +* ca_guid +* Local CA GUID through which IOC is accessible. +* +* guid +* IOC GUID. +* +* SEE ALSO +* +*********/ #endif /* !defined _IOC_IFC_H_ */ diff --git a/trunk/inc/kernel/iba/iou_ifc.h b/trunk/inc/kernel/iba/iou_ifc.h index 44c5c2c9..2741397a 100644 --- a/trunk/inc/kernel/iba/iou_ifc.h +++ b/trunk/inc/kernel/iba/iou_ifc.h @@ -38,9 +38,9 @@ #define _IOU_IFC_H_ -/****h* Access Layer/iou_ifc.h +/****h* Access Layer/ IO Unit Interface * NAME -* iou_ifc.h +* IO Unit Interface * * DESCRIPTION * Header file for the interface exported to IOU client drivers to retrieve @@ -53,21 +53,43 @@ #define IOU_INTERFACE_DATA_VERSION (4) -/* Interface definitions */ + +/****s* Access Layer: IO Unit Interface/iou_ifc_data_t +* NAME +* iou_ifc_data_t +* +* DESCRIPTION +* I/O Unit interface data. +* +* The iou_ifc_data_t structure +* +* SYNOPSIS +*/ typedef struct _iou_ifc_data { - /* Local CA GUID through which IOU is accessible. */ net64_t ca_guid; - - /* Chassis GUID and slot number */ net64_t chassis_guid; uint8_t slot; - - /* IOU GUID. */ - net64_t guid; + net64_t guid; } iou_ifc_data_t; - +/* +* FIELDS +* ca_guid +* Local CA GUID through which IOU is accessible. +* +* chassis_guid +* IOU chassis GUID. +* +* slot +* IOU slot. +* +* guid +* IOU GUID. +* +* SEE ALSO +* +*********/ #endif /* !defined _IOU_IFC_H_ */ diff --git a/trunk/inc/kernel/iba/ipoib_ifc.h b/trunk/inc/kernel/iba/ipoib_ifc.h index f680f775..f19d0c11 100644 --- a/trunk/inc/kernel/iba/ipoib_ifc.h +++ b/trunk/inc/kernel/iba/ipoib_ifc.h @@ -38,9 +38,9 @@ #define _IPOIB_IFC_H_ -/****h* Access Layer/ipoib_ifc.h +/****h* Access Layer/IPoIB Interface * NAME -* ipoib_ifc.h +* IPoIB Interface * * DESCRIPTION * Header file for the interface exported to IPoIB client drivers for access @@ -54,15 +54,39 @@ #define IPOIB_INTERFACE_DATA_VERSION (5) -/* Interface definitions */ +/****s* Access Layer: IPoIB Interface/ipoib_ifc_data_t +* NAME +* ipoib_ifc_data_t +* +* DESCRIPTION +* IPoIB interface datat. +* +* The ipoib_ifc_data_t structure +* +* SYNOPSIS +*/ typedef struct _ipoib_ifc_data { - /* HCA and Port GUID */ net64_t ca_guid; net64_t port_guid; uint8_t port_num; } ipoib_ifc_data_t; +/* +* FIELDS +* ca_guid +* HCA GUID for this IPoIB interface +* +* port_guid +* Port GUID for this IPoIB interface +* +* port_num +* Port Number GUID for this IPoIB interface +* +* SEE ALSO +* +*********/ + #endif /* !defined _IPOIB_IFC_H_ */ diff --git a/trunk/inc/user/iba/ib_uvp.h b/trunk/inc/user/iba/ib_uvp.h index edc98154..495c1712 100644 --- a/trunk/inc/user/iba/ib_uvp.h +++ b/trunk/inc/user/iba/ib_uvp.h @@ -37,7 +37,7 @@ #include #include -/****h* UAL_UVP_Interface/Overview user-mode Verbs +/****h* UAL_UVP_Interface/user-mode Verbs * NAME * User-mode Verbs -- User-mode Verbs implements the HCA specific * user-mode functions to plug in to the Usermode Access Layer diff --git a/trunk/ulp/opensm/user/include/iba/ib_types.h b/trunk/ulp/opensm/user/include/iba/ib_types.h index 136c673f..f14ffc68 100644 --- a/trunk/ulp/opensm/user/include/iba/ib_types.h +++ b/trunk/ulp/opensm/user/include/iba/ib_types.h @@ -9793,4 +9793,5 @@ END_C_DECLS #include #endif -#endif // __IB_TYPES_H__ +#endif /* __IB_TYPES_H__ */ + -- 2.41.0