11.\" smc_pnet.8
22.\"
33.\"
4- .\" Copyright IBM Corp. 2017
4+ .\" Copyright IBM Corp. 2017, 2019
55.\" Author(s): Thomas Richter <tmricht@linux.ibm.com>
66.\" Ursula Braun <ubraun@linux.ibm.com>
77.\" ----------------------------------------------------------------------
@@ -15,30 +15,46 @@ smc_pnet \- create, destroy, and change the SMC PNET table.
1515.SH SYNOPSIS
1616
1717.B smc_pnet
18- .RB { \-\- add | \- a " } {" \-\- interface | \- I " } <ethernet-interface> {" \-\- ibdevice | \- D " } <infiniband-device> [ {" \-\- ibport | \- P " <infiniband-port> ] } <pnetid>"
18+ { \fB \- a \fR | \fB \-\- add \fR \fI <pnetid> \fR }
19+ { \fB \- I \fR | \fB \-\- interface \fR <ethernet-interface> }
1920.P
2021.B smc_pnet
21- .RB { \-\- show | -s } <pnetid>
22+ { \fB \- a \fR | \fB \-\- add \fR \fI <pnetid> \fR }
23+ { \fB \- D \fR | \fB \-\- ibdevice \fR <infiniband-or-ISM-device> }
24+ [ \fB \- P \fR | \fB \-\- ibport \fR <infiniband-port> ]
2225.P
2326.B smc_pnet
24- .RB { \-\- delete | \- d } <pnetid>
27+ { \fB \- a \fR | \fB \-\- add \fR \fI <pnetid> \fR }
28+ { \fB \- I \fR | \fB \-\- interface \fR <ethernet-interface> }
29+ { \fB \- D \fR | \fB \-\- ibdevice \fR <infiniband-or-ISM-device> }
30+ [ \fB \- P \fR | \fB \-\- ibport \fR <infiniband-port> ]
2531.P
2632.B smc_pnet
27- . RB { \-\- flush | \- f }
33+ { \fB \- s \fR | \fB \-\- show \fR \fI <pnetid> \fR }
2834.P
2935.B smc_pnet
30- . RB { \-\- version | \- v }
36+ { \fB \- d \fR | \fB \-\- delete \fR \fI <pnetid> \fR }
3137.P
3238.B smc_pnet
33- .RB { \-\- help | \- h }
39+ { \fB \- f \fR | \fB \-\- flush \fR }
40+ .P
41+ .B smc_pnet
42+ { \fB \- v \fR | \fB \-\- version \fR }
43+ .P
44+ .B smc_pnet
45+ { \fB \- h \fR | \fB \-\- help \fR }
3446
3547.SH DESCRIPTION
36- The SMC protocol requires grouping of standard Ethernet and RoCE networks.
48+ The SMC protocol requires grouping of standard Ethernet and RoCE networks or ISM
49+ devices.
3750Such groups are called \fI Physical Networks \fR (PNETs). The mapping is configured
3851within a table called \fI pnet table \fR . Any available Ethernet interface can be
39- combined with an available RDMA-capable network interface card (RNIC), if they
52+ combined with an available RDMA-capable network interface card (RNIC) or a
53+ DMA-capable ISM device, if they
4054belong to the same Converged Ethernet fabric. To configure mapping of a RoCE Adapter
41- port to a standard Ethernet interface, an entry in the pnet table must be created.
55+ port or an ISM device to a standard Ethernet interface, both devices need to have
56+ the same pnetid; either hardware-defined or user-defined using the pnet table.
57+ Hardware-defined pnetids cannot be overwritten.
4258.P
4359The
4460.B smc_pnet
@@ -49,16 +65,15 @@ By default,
4965.B smc_pnet
5066shows all entries of the pnet table.
5167.TP
52- .BR <pnetid>
53- defines a name for a grouping of Ethernet interface and RNIC .
68+ .IR <pnetid>
69+ defines a name for a grouping of Ethernet interface and RNICs or ISM devices .
5470A pnetid name consists of up to 16 alphanumeric uppercase characters without blanks.
5571.TP
5672.BR " \- a, \-\- add"
5773creates a new pnetid definition to the pnet table (if it does not already exist).
5874Only one pnetid can be defined for a certain
59- Ethernet interface and for a certain infiniband device port.
60- Adding an ethernet interface or an infiniband device port more than once
61- fails.
75+ Ethernet interface, a certain InfiniBand device port or a certain ISM device.
76+ Adding more than one pnetid fails. Hardware defined pnetids cannot be overwritten.
6277.TP
6378.BR " \- s, \-\- show"
6479shows a certain pnetid definition in the pnet table.
@@ -73,11 +88,11 @@ removes all pnetid definitions from the pnet table.
7388specifies the name of the Ethernet interface to be added for a certain pnetid
7489definition.
7590.TP
76- .BR " \- D, \-\- ibdevice <infiniband-device>"
77- specifies the name of the Infiniband device.
91+ .BR " \- D, \-\- ibdevice <infiniband-or-ISM- device>"
92+ specifies the ID of the InfiniBand device or ISM device.
7893.TP
7994.BR " \- P, \-\- ibport <infiniband-port>"
80- specifies the port number of the Infiniband device port. Valid numbers are
95+ specifies the port number of the InfiniBand device port. Valid numbers are
81961 or 2.
8297The default value is 1.
8398.TP
@@ -88,31 +103,57 @@ displays smc_pnet program version.
88103displays a brief smc_pnet usage information.
89104
90105.SH EXAMPLES
91- .B Create a pnetid ABC with ethernet interface name encf500, infiniband
92- .B device name mlx4_0 and port number 2:
106+ .B Define pnetid ABC for the ethernet device names encf500 and bond0, and define
107+ .B pnetid ABC for the InfiniBand device ID 0001:00:00.0 (port 2) and the ISM
108+ .B device ID 0004:00:00.0:
93109.RS 4
94110.PP
95- $ smc_pnet \- a ABC \- I encf500 \- D mlx4_0 \- P 2
111+ .nf
112+ $ smc_pnet \- a ABC \- I encf500
113+ $ smc_pnet \- a ABC \- I bond0
114+ $ smc_pnet \- a ABC \- D 0001:00:00:00.0 \- P 2
115+ $ smc_pnet \- a ABC \- D 0004:00:00:00.0
96116.RE
97117.PP
98118.
99- .B Delete a pnet table entry with pnetid named ABC :
119+ .B Show all pnet table entries :
100120.RS 4
101121.PP
102- $ smc_pnet \- d ABC
122+ .nf
123+ $ smc_pnet
124+ ABC encf500 n/a 255
125+ ABC bond0 n/a 255
126+ ABC n/a 0001:00:00.0 2
127+ ABC n/a 0004:00:00.0 1
128+ .RE
129+ .PP
130+ .
131+ .B Define pnetid XYZ for the ethernet interface name vlan0201 and the InfiniBand
132+ .B device ID 0001:00:00.0 (port 1):
133+ .RS 4
134+ .PP
135+ $ smc_pnet \- a XYZ \- I vlan0201 \- D 0001:00:00.0 \- P 1
103136.RE
104137.PP
105138.
106- .B Show the mapping of ethernet interface name and infiniband device port for pnetid ABC :
139+ .B Show all entries for pnetid XYZ :
107140.RS 4
108141.PP
109142.nf
110- $ smc_pnet \- s ABC
111- ABC encf500 mlx4_0 2
143+ $ smc_pnet \- s XYZ
144+ XYZ vlan0201 n/a 255
145+ XYZ n/a 0001:00:00.0 1
146+ .RE
147+ .PP
148+ .
149+ .B Delete all pnet table entries with pnetid named ABC:
150+ .RS 4
151+ .PP
152+ $ smc_pnet \- d ABC
112153.RE
113154.PP
114155.
115- .B Delete all entries in the pnet table
156+ .B Delete all entries in the pnet table:
116157.RS 4
117158.PP
118159$ smc_pnet \- f
@@ -121,13 +162,9 @@ $ smc_pnet \-f
121162.
122163.
123164.SH RETURN CODES
124- Successful
125- .IR smc_pnet
126- commands return 0.
127- If an error occurs,
128- .IR smc_pnet
129- writes a message to stderr and completes with a return code
130- other than 0.
165+ Successful \fB smc_pnet \fR commands return 0.
166+ If an error occurs, \fB smc_pnet \fR writes a message to stderr and
167+ completes with a return code other than 0.
131168.P
132169.SH SEE ALSO
133170.BR af_smc (7),
0 commit comments