summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Mustacchi <rm@fingolfin.org>2021-02-25 06:36:16 -0800
committerRobert Mustacchi <rm@fingolfin.org>2021-02-27 12:59:48 -0800
commit3be0d903330def6576e70a1a8a028f5828c9ea45 (patch)
treed3bc0ee9b6b73d59bb7ec9e0a64b85c4b9f6b2a4
parent25a9a7aaf35c7e4a2b5a57d3875af906147710d5 (diff)
downloadillumos-joyent-3be0d903330def6576e70a1a8a028f5828c9ea45.tar.gz
13174 mac_prop_info_set_default_fec should be added to mac_prop_info(9F)
Reviewed by: Peter Tribble <peter.tribble@gmail.com> Reviewed by: Yuri Pankov <yuripv@yuripv.dev> Reviewed by: Paul Winder <paul@winder.uk.net> Approved by: Dan McDonald <danmcd@joyent.com>
-rw-r--r--usr/src/man/man9f/Makefile3
-rw-r--r--usr/src/man/man9f/mac_prop_info.9f50
-rw-r--r--usr/src/pkg/manifests/system-kernel.man9f.inc2
3 files changed, 45 insertions, 10 deletions
diff --git a/usr/src/man/man9f/Makefile b/usr/src/man/man9f/Makefile
index 4b4dd80396..361fefe4aa 100644
--- a/usr/src/man/man9f/Makefile
+++ b/usr/src/man/man9f/Makefile
@@ -1026,6 +1026,7 @@ MANLINKS= AVL_NEXT.9f \
mac_fini_ops.9f \
mac_free.9f \
mac_hcksum_set.9f \
+ mac_prop_info_set_default_fec.9f \
mac_prop_info_set_default_link_flowctrl.9f \
mac_prop_info_set_default_str.9f \
mac_prop_info_set_default_uint32.9f \
@@ -1908,6 +1909,8 @@ list_tail.9f := LINKSRC = list_create.9f
mac_free.9f := LINKSRC = mac_alloc.9f
mac_hcksum_set.9f := LINKSRC = mac_hcksum_get.9f
mac_fini_ops.9f := LINKSRC = mac_init_ops.9f
+
+mac_prop_info_set_default_fec.9f := LINKSRC = mac_prop_info.9f
mac_prop_info_set_default_link_flowctrl.9f := LINKSRC = mac_prop_info.9f
mac_prop_info_set_default_str.9f := LINKSRC = mac_prop_info.9f
mac_prop_info_set_default_uint8.9f := LINKSRC = mac_prop_info.9f
diff --git a/usr/src/man/man9f/mac_prop_info.9f b/usr/src/man/man9f/mac_prop_info.9f
index 0582665ce3..b24ee63694 100644
--- a/usr/src/man/man9f/mac_prop_info.9f
+++ b/usr/src/man/man9f/mac_prop_info.9f
@@ -10,12 +10,14 @@
.\"
.\"
.\" Copyright 2016 Joyent, Inc.
+.\" Copyright 2021 Oxide Computer Company
.\"
-.Dd May 31, 2016
+.Dd February 25, 2021
.Dt MAC_PROP_INFO 9F
.Os
.Sh NAME
.Nm mac_prop_info ,
+.Nm mac_prop_info_set_default_fec ,
.Nm mac_prop_info_set_default_link_flowctrl ,
.Nm mac_prop_info_set_default_str ,
.Nm mac_prop_info_set_default_uint8 ,
@@ -27,6 +29,11 @@
.Sh SYNOPSIS
.In sys/mac_provider.h
.Ft void
+.Fo mac_prop_info_set_default_fec
+.Fa "mac_prop_info_handle_t hdl"
+.Fa "link_fec_t fec"
+.Fc
+.Ft void
.Fo mac_prop_info_set_default_link_flowctrl
.Fa "mac_prop_info_handle_t hdl"
.Fa "link_flowctrl_t fctl"
@@ -66,9 +73,9 @@
illumos DDI specific
.Sh PARAMETERS
.Bl -tag -width Ds
-.It Ft hdl
+.It Fa hdl
A pointer to the MAC property information handle.
-.It Ft fctl
+.It Fa fctl
A valid link flow control entry.
Valid values are documented in the
.Sy MAC_PROP_FLOWCTRL
@@ -76,16 +83,26 @@ property description in the
.Sx PROPERTIES
section of
.Xr mac 9E .
-.It Ft str
+.It Fa fec
+A valid link forward error correction
+.Pq fec
+scheme.
+Valid values are documented in the
+.Sy MAC_PROP_EN_FEC_CAP
+property description in the
+.Sx PROPERTIES
+section of
+.Xr mac 9E .
+.It Fa str
A null-terminated ASCII character string that describes that contains a
value of a property.
-.It Ft u8
+.It Fa u8
An 8-bit unsigned value.
-.It Ft u16
+.It Fa u16
An 16-bit unsigned value.
-.It Ft u32
+.It Fa u32
An 32-bit unsigned value.
-.It Ft perm
+.It Fa perm
An 8-bit unsigned value which is the bitwise inclusive OR of the
following values:
.Bl -tag -width Ds
@@ -105,10 +122,10 @@ This is equivalent to specifying both
and
.Sy MAC_PROP_PERM_WRITE .
.El
-.It Ft low
+.It Fa low
A 32-bit unsigned value that represents the lowest possible value of an
integer property, generally inclusive.
-.It Ft high
+.It Fa high
A 32-bit unsigned value that represents the highest possible value an
integer property, generally inclusive.
.El
@@ -156,6 +173,7 @@ function is called, a new property range is added, allowing for multiple
disjoint ranges to be specified for a given property.
.Pp
The remaining functions,
+.Fn mac_prop_info_set_default_fec ,
.Fn mac_prop_info_set_default_link_flowctrl ,
.Fn mac_prop_info_set_default_str ,
.Fn mac_prop_info_set_uint8 ,
@@ -193,6 +211,18 @@ and
.Fn mac_prop_info_set_default_uint32
functions set the default value for values whose properties are 8-, 16-,
and 32-bit unsigned values respectively.
+.Pp
+The
+.Fn mac_prop_info_set_default_fec
+function is used for properties that describe link forward error
+correction values such as
+.Dv MAC_PROP_EN_FEC_CAP
+and
+.Dv MAC_PROP_ADV_FEC_CAP .
+The various values of a
+.Ft link_fec_t
+are documented in
+.Xr mac 9E .
.Sh CONTEXT
These functions are generally called on a handle passed into the
.Xr mc_propinfo 9E
diff --git a/usr/src/pkg/manifests/system-kernel.man9f.inc b/usr/src/pkg/manifests/system-kernel.man9f.inc
index 78107ef373..d3b6ff9d32 100644
--- a/usr/src/pkg/manifests/system-kernel.man9f.inc
+++ b/usr/src/pkg/manifests/system-kernel.man9f.inc
@@ -1036,6 +1036,8 @@ link path=usr/share/man/man9f/list_tail.9f target=list_create.9f
link path=usr/share/man/man9f/mac_fini_ops.9f target=mac_init_ops.9f
link path=usr/share/man/man9f/mac_free.9f target=mac_alloc.9f
link path=usr/share/man/man9f/mac_hcksum_set.9f target=mac_hcksum_get.9f
+link path=usr/share/man/man9f/mac_prop_info_set_default_fec.9f \
+ target=mac_prop_info.9f
link path=usr/share/man/man9f/mac_prop_info_set_default_link_flowctrl.9f \
target=mac_prop_info.9f
link path=usr/share/man/man9f/mac_prop_info_set_default_str.9f \