-
Notifications
You must be signed in to change notification settings - Fork 702
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
change man page from roff to rst format
Signed-off-by: Asaf Mazor <[email protected]>
- Loading branch information
Showing
2 changed files
with
103 additions
and
119 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,54 @@ | ||
| .\" -*- nroff -*- | ||
| .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md | ||
| .\" | ||
| .TH UMAD_GET_SMI_GSI_PAIR_BY_CA_NAME 3 "May 21, 2007" "OpenIB" "OpenIB Programmer's Manual" | ||
| .SH NAME | ||
| .B umad_get_smi_gsi_pair_by_ca_name \- | ||
| Retrieve SMI/GSI pair information based on device name and port number | ||
| .SH SYNOPSIS | ||
| .nf | ||
| .B #include <infiniband/umad.h> | ||
| .sp | ||
| .BI "int umad_get_smi_gsi_pair_by_ca_name(const char * " "devname" ", uint8_t " "portnum" ", struct umad_ca_pair " "*ca" ); | ||
| .fi | ||
| .SH DESCRIPTION | ||
| .B umad_get_smi_gsi_pair_by_ca_name() | ||
| fills the provided | ||
| .I ca | ||
| structure with the SMI and GSI pair information for the specified device name and port number. | ||
|
|
||
| The | ||
| .I devname | ||
| parameter specifies the name of the device, and | ||
| .I portnum | ||
| is the associated port number. | ||
|
|
||
| The | ||
| .I struct umad_ca_pair | ||
| is defined in | ||
| .I <infiniband/umad.h> | ||
| and includes the following members: | ||
| .PP | ||
| .nf | ||
| struct umad_ca_pair { | ||
| .in +4 | ||
| char smi_name[UMAD_CA_NAME_LEN]; | ||
| .in +4 | ||
| \" Name of the SMI | ||
| .in -4 | ||
| uint32_t smi_preferred_port; | ||
| .in +4 | ||
| \" Preferred port for the SMI | ||
| .in -4 | ||
| char gsi_name[UMAD_CA_NAME_LEN]; | ||
| .in +4 | ||
| \" Name of the GSI | ||
| .in -4 | ||
| uint32_t gsi_preferred_port; | ||
| .in +4 | ||
| \" Preferred port for the GSI | ||
| .in -8 | ||
| }; | ||
| .fi | ||
| .PP | ||
| The function populates this structure with the relevant data for the given | ||
| .I devname | ||
| and | ||
| .I portnum. | ||
| .SH RETURN VALUE | ||
| .B umad_get_smi_gsi_pair_by_ca_name() | ||
| returns: | ||
| .TP | ||
| 0 | ||
| If the specified device and port are found and the structure is successfully populated. | ||
| .TP | ||
| 1 | ||
| If no matching device or port is found. | ||
| .SH AUTHORS | ||
| .TP | ||
| Asaf Mazor <[email protected]> | ||
| .. -*- rst -*- | ||
| .. Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md | ||
| umad_get_smi_gsi_pair_by_ca_name(3) | ||
| =================================== | ||
|
|
||
| Retrieve SMI/GSI pair information based on device name and port number. | ||
|
|
||
| Synopsis | ||
| -------- | ||
|
|
||
| .. code-block:: c | ||
| #include <infiniband/umad.h> | ||
| int umad_get_smi_gsi_pair_by_ca_name(const char *devname, uint8_t portnum, struct umad_ca_pair *ca); | ||
| Description | ||
| ----------- | ||
|
|
||
| ``umad_get_smi_gsi_pair_by_ca_name()`` fills the provided ``ca`` structure with the SMI and GSI pair information | ||
| for the specified device name and port number. | ||
|
|
||
| The ``devname`` parameter specifies the name of the device, and ``portnum`` is the associated port number. | ||
|
|
||
| The ``struct umad_ca_pair`` is defined in ``<infiniband/umad.h>`` and includes the following members: | ||
|
|
||
| .. code-block:: c | ||
| struct umad_ca_pair { | ||
| char smi_name[UMAD_CA_NAME_LEN]; | ||
| /* Name of the SMI */ | ||
| uint32_t smi_preferred_port; | ||
| /* Preferred port for the SMI */ | ||
| char gsi_name[UMAD_CA_NAME_LEN]; | ||
| /* Name of the GSI */ | ||
| uint32_t gsi_preferred_port; | ||
| /* Preferred port for the GSI */ | ||
| }; | ||
| The function populates this structure with the relevant data for the given ``devname`` and ``portnum``. | ||
|
|
||
| Return Value | ||
| ------------ | ||
|
|
||
| ``umad_get_smi_gsi_pair_by_ca_name()`` returns: | ||
|
|
||
| - **0**: If the specified device and port are found and the structure is successfully populated. | ||
| - **1**: If no matching device or port is found. | ||
|
|
||
| Authors | ||
| ------- | ||
|
|
||
| - Asaf Mazor <[email protected]> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1,50 @@ | ||
| .\" -*- nroff -*- | ||
| .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md | ||
| .\" | ||
| .TH UMAD_GET_SMI_GSI_PAIRS 3 "Dec 1, 2024" "OpenIB" "OpenIB Programmer's Manual" | ||
| .SH "NAME" | ||
| umad_get_smi_gsi_pairs \- get cas as SMI/GSI pairs | ||
| .SH "SYNOPSIS" | ||
| .nf | ||
| .B #include <infiniband/umad.h> | ||
| .sp | ||
| .BI "int umad_get_smi_gsi_pairs(struct umad_ca_pair " "cas[]" ", size_t " "max" ); | ||
| .fi | ||
| .SH "DESCRIPTION" | ||
| .B umad_get_smi_gsi_pairs() | ||
| fill a user allocated array of struct | ||
| .I umad_ca_pair\fr | ||
| it fills up to | ||
| .I max | ||
| devices | ||
| The argument | ||
| .I cas | ||
| is an array of | ||
| .I struct umad_ca_pair as specified in <infiniband/umad.h>. | ||
| .PP | ||
| .nf | ||
| struct umad_ca_pair { | ||
| .in +1 | ||
| char smi_name[UMAD_CA_NAME_LEN]; | ||
| .in +0 | ||
| uint32_t smi_preferred_port; | ||
| .in +0 | ||
| char gsi_name[UMAD_CA_NAME_LEN]; | ||
| .in +0 | ||
| uint32_t gsi_preferred_port; | ||
| .in -2 | ||
| } umad_ca_pair; | ||
| .nf | ||
| .fi | ||
| .PP | ||
|
|
||
| smi_preferred_port/gsi_preferred_port are the first ports found active for SMI/GSI device | ||
|
|
||
| .SH "RETURN VALUE" | ||
| .B umad_get_smi_gsi_pairs() | ||
| returns the number of devices filled, | ||
| or -1 on error. | ||
|
|
||
| .SH "AUTHORS" | ||
| .TP | ||
| Asaf Mazor <[email protected]> | ||
| .. -*- rst -*- | ||
| .. Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md | ||
| umad_get_smi_gsi_pairs(3) | ||
| ========================= | ||
|
|
||
| Get CAs as SMI/GSI pairs. | ||
|
|
||
| Synopsis | ||
| -------- | ||
|
|
||
| .. code-block:: c | ||
| #include <infiniband/umad.h> | ||
| int umad_get_smi_gsi_pairs(struct umad_ca_pair cas[], size_t max); | ||
| Description | ||
| ----------- | ||
|
|
||
| ``umad_get_smi_gsi_pairs()`` fills a user-allocated array of ``struct umad_ca_pair``. | ||
| It fills up to ``max`` devices. | ||
|
|
||
| The argument ``cas`` is an array of ``struct umad_ca_pair`` as specified in ``<infiniband/umad.h>``: | ||
|
|
||
| .. code-block:: c | ||
| struct umad_ca_pair { | ||
| char smi_name[UMAD_CA_NAME_LEN]; | ||
| /* Name of the SMI */ | ||
| uint32_t smi_preferred_port; | ||
| /* Preferred port for the SMI */ | ||
| char gsi_name[UMAD_CA_NAME_LEN]; | ||
| /* Name of the GSI */ | ||
| uint32_t gsi_preferred_port; | ||
| /* Preferred port for the GSI */ | ||
| }; | ||
| The ``smi_preferred_port`` and ``gsi_preferred_port`` fields represent the first ports found active | ||
| for the corresponding SMI/GSI device. | ||
|
|
||
| Return Value | ||
| ------------ | ||
|
|
||
| ``umad_get_smi_gsi_pairs()`` returns the number of devices filled, or **-1** on error. | ||
|
|
||
| Authors | ||
| ------- | ||
|
|
||
| - Asaf Mazor <[email protected]> |