diff options
Diffstat (limited to 'usr/src/man')
| -rw-r--r-- | usr/src/man/man1m/dladm.1m | 85 | ||||
| -rw-r--r-- | usr/src/man/man9e/mac.9e | 54 |
2 files changed, 124 insertions, 15 deletions
diff --git a/usr/src/man/man1m/dladm.1m b/usr/src/man/man1m/dladm.1m index ffe36dfa07..77bf045e08 100644 --- a/usr/src/man/man1m/dladm.1m +++ b/usr/src/man/man1m/dladm.1m @@ -42,12 +42,12 @@ .\" .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved .\" Copyright 2017 Joyent, Inc. +.\" Copyright 2020 RackTop Systems, Inc. .\" -.TH DLADM 1M "Dec 6, 2017" +.TH DLADM 1M "May 4, 2020" .SH NAME dladm \- administer data links .SH SYNOPSIS -.LP .nf \fBdladm show-link\fR [\fB-P\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIlink\fR] \fBdladm rename-link\fR [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fIlink\fR \fInew-link\fR @@ -189,7 +189,6 @@ dladm \- administer data links .fi .SH DESCRIPTION -.LP The \fBdladm\fR command is used to administer data-links. A data-link is represented in the system as a \fBSTREAMS DLPI\fR (v2) interface which can be plumbed under protocol stacks such as \fBTCP/IP\fR. Each data-link relies on @@ -356,7 +355,6 @@ other hosts. For more information on overlay devices, see \fBoverlay\fR(5). .RE .SS "Options" -.LP Each \fBdladm\fR subcommand has its own set of options. However, many of the subcommands have the following as a common option: .sp @@ -371,7 +369,6 @@ deletion, or renaming-should apply. .RE .SS "SUBCOMMANDS" -.LP The following subcommands are supported: .sp .ne 2 @@ -4872,7 +4869,6 @@ display network usage for all links. .RE .SS "Parsable Output Format" -.LP Many \fBdladm\fR subcommands have an option that displays output in a machine-parsable format. The output format is one or more lines of colon (\fB:\fR) delimited fields. The fields displayed are specific to the subcommand @@ -4888,7 +4884,6 @@ by using shell \fBread\fR(1) functions with the environment variable \fBIFS=:\fR (see \fBEXAMPLES\fR, below). Note that escaping is not done when you request only a single field. .SS "General Link Properties" -.LP The following general link properties are supported: .sp .ne 2 @@ -5275,7 +5270,6 @@ currently running on the system. By default, the zone binding is as per .RE .SS "Wifi Link Properties" -.LP The following \fBWiFi\fR link properties are supported. Note that the ability to set a given property to a given value depends on the driver and hardware. .sp @@ -5327,7 +5321,6 @@ is no fixed speed. .RE .SS "Ethernet Link Properties" -.LP The following MII Properties, as documented in \fBieee802.3\fR(5), are supported in read-only mode: .RS +4 @@ -5488,6 +5481,75 @@ capabilities allowed by the device and the link partner. .sp .ne 2 .na +\fB\fBen_fec_cap\fR\fR +.ad +.sp .6 +.RS 4n +Sets the Forward Error Correct (FEC) code(s) to be advertised by the +device. +Valid values are: +.sp +.ne 2 +.na +\fB\fBnone\fR\fR +.ad +.sp .6 +.RS 4n +Allow the device not to use FEC. +.RE + +.sp +.ne 2 +.na +\fB\fBauto\fR\fR +.ad +.sp .6 +.RS 4n +The device will automatically decide which FEC code to use. +.RE + +.sp +.ne 2 +.na +\fB\fBrs\fR\fR +.ad +.sp .6 +.RS 4n +Allow Reed-Solomon FEC code. +.RE + +.sp +.ne 2 +.na +\fB\fBbase-r\fR\fR +.ad +.sp .6 +.RS 4n +Allow Base-R (also known as FireCode) code. +.RE + +Valid input is either \fBauto\fR as a single value, or a comma separated +combination of \fBnone\fR, \fBrs\fR and \fBbase-r\fR. +The default value is \fBauto\fR. +.sp +.LP +Note the actual FEC settings and combinations are constrained by the +capabilities allowed by the device and the link partner. +.RE + +.sp +.ne 2 +.na +\fB\fBadv_fec_cap\fR\fR +.ad +.sp .6 +.RS 4n +(read only) The current negotiated Forward Error Correction code. +.RE + +.sp +.ne 2 +.na \fB\fBsecondary-macs\fR\fR .ad .sp .6 @@ -5542,7 +5604,6 @@ The default value is \fBvlanonly\fR. .RE .SS "IP Tunnel Link Properties" -.LP The following IP tunnel link properties are supported. .sp .ne 2 @@ -5569,7 +5630,6 @@ default value is 4. A value of 0 disables the encapsulation limit. .RE .SH EXAMPLES -.LP \fBExample 1 \fRConfiguring an Aggregation .sp .LP @@ -6044,7 +6104,6 @@ interface. See \fBifconfig\fR(1M) for a description of how IPv6 addresses are configured on 6to4 tunnel links. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp .LP @@ -6077,7 +6136,6 @@ Interface Stability Committed .TE .SH SEE ALSO -.LP \fBacctadm\fR(1M), \fBautopush\fR(1M), \fBifconfig\fR(1M), \fBipsecconf\fR(1M), \fBndd\fR(1M), \fBpsrset\fR(1M), \fBwpad\fR(1M), \fBzonecfg\fR(1M), \fBattributes\fR(5), \fBieee802.3\fR(5), \fBoverlay\fR(5), \fBdlpi\fR(7P) @@ -6092,7 +6150,6 @@ T. Lemon, B. Sommerfeld. February 2006. \fIRFC 4361: Node-specific Client Identifiers for Dynamic Host Configuration Protocol Version Four (DHCPv4)\fR. The Internet Society. January 2006. .SH NOTES -.LP The preferred method of referring to an aggregation in the aggregation subcommands is by its link name. Referring to an aggregation by its integer \fIkey\fR is supported for backward compatibility, but is not necessary. When diff --git a/usr/src/man/man9e/mac.9e b/usr/src/man/man9e/mac.9e index 56762b7856..d3d066a564 100644 --- a/usr/src/man/man9e/mac.9e +++ b/usr/src/man/man9e/mac.9e @@ -10,8 +10,9 @@ .\" .\" .\" Copyright 2019 Joyent, Inc. +.\" Copyright 2020 RackTop Systems, Inc. .\" -.Dd July 22, 2019 +.Dd May 11, 2020 .Dt MAC 9E .Os .Sh NAME @@ -894,6 +895,57 @@ it has configured the device, not what the device has actually negotiated. When setting the property, it should update the hardware and allow the link to potentially perform auto-negotiation again. +.It Sy MAC_PROP_EN_FEC_CAP +.Bd -filled -compact +Type: +.Sy link_fec_t | +Permissions: +.Sy Read/Write +.Ed +.Pp +The +.Sy MAC_PROP_EN_FEC_CAP +property indicates which Forward Error Correction (FEC) code is advertised +by the device. +.Pp +The +.Sy link_fec_t +is an enumeration that may be a combination of the following bit values: +.Bl -tag -width Ds +.It Sy LINK_FEC_NONE +No FEC over the link. +.It Sy LINK_FEC_AUTO +The FEC coding to use is auto-negotiated, +.Sy LINK_FEC_AUTO +cannot be set along with any of the other values. +This is the default setting the device driver should use. +.It Sy LINK_FEC_RS +The link may use Reed-Solomon FEC coding. +.It Sy LINK_FEC_BASE_R +The link may use Base-R coding, also common referred to as FireCode. +.El +.Pp +When setting the property, it should update the hardware with the requested, or +combination of requested codings. +If a particular combination of codings is not supported by the hardware, +the device driver should return +.Er EINVAL . +When retrieving this property, the device driver should return the current +value of the property. +.It Sy MAC_PROP_ADV_FEC_CAP +.Bd -filled -compact +Type: +.Sy link_fec_t | +Permissions: +.Sy Read-Only +.Ed +.Pp +The +.Sy MAC_PROP_ADV_FEC_CAP +has the same values as +.Sy MAC_PROP_EN_FEC_CAP . +The property indicates which Forward Error Correction (FEC) code has been +negotiated over the link. .El .Pp The remaining properties are all about various auto-negotiation link |