diff options
author | John Levon <john.levon@joyent.com> | 2020-05-26 13:57:13 +0000 |
---|---|---|
committer | John Levon <john.levon@joyent.com> | 2020-05-26 13:57:13 +0000 |
commit | 5b2acc0949194447bba6e45a0fa44d0b5f42f208 (patch) | |
tree | 7ea9eb87bc68fee386dd39035ce715e87a0e673c /usr/src/man/man9e | |
parent | 8ca018083101bf1cb175869679bc123187fb1bab (diff) | |
parent | 2a1277d3064386cd5c4e372301007aa330bf1d5e (diff) | |
download | illumos-joyent-gcc9.tar.gz |
mergegcc9
Diffstat (limited to 'usr/src/man/man9e')
-rw-r--r-- | usr/src/man/man9e/_fini.9e | 23 | ||||
-rw-r--r-- | usr/src/man/man9e/ioctl.9e | 21 | ||||
-rw-r--r-- | usr/src/man/man9e/mac.9e | 54 |
3 files changed, 62 insertions, 36 deletions
diff --git a/usr/src/man/man9e/_fini.9e b/usr/src/man/man9e/_fini.9e index 19cd7b665f..72bfbb8979 100644 --- a/usr/src/man/man9e/_fini.9e +++ b/usr/src/man/man9e/_fini.9e @@ -3,11 +3,10 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH _FINI 9E "Jan 22, 2002" +.TH _FINI 9E "May 06, 2020" .SH NAME _fini, _info, _init \- loadable module configuration entry points .SH SYNOPSIS -.LP .nf #include <sys/modctl.h> @@ -27,13 +26,10 @@ _fini, _info, _init \- loadable module configuration entry points .fi .SH INTERFACE LEVEL -.sp -.LP Solaris DDI specific (Solaris DDI). These entry points are required. You must write them. .SH PARAMETERS .SS "_info(\|)" -.sp .ne 2 .na \fB\fImodinfop\fR \fR @@ -43,8 +39,6 @@ A pointer to an opaque \fBmodinfo\fR structure. .RE .SH DESCRIPTION -.sp -.LP \fB_init()\fR initializes a loadable module. It is called before any other routine in a loadable module. \fB_init()\fR returns the value returned by \fBmod_install\fR(9F). The module may optionally perform some other work before @@ -61,10 +55,10 @@ returns the value returned by \fBmod_info\fR(9F). system wants to unload a module. If the module determines that it can be unloaded, then \fB_fini()\fR returns the value returned by \fBmod_remove\fR(9F). Upon successful return from \fB_fini()\fR no other -routine in the module will be called before \fB_init()\fR is called. +routine in the module will be called before \fB_init()\fR is called. If +\fB_init()\fR did not successfully complete, \fB_fini()\fR will not be +called. .SH RETURN VALUES -.sp -.LP \fB_init()\fR should return the appropriate error number if there is an error, otherwise it should return the return value from \fBmod_install\fR(9F). .sp @@ -79,7 +73,6 @@ resources, such as mutexes and calls to \fBddi_soft_state_fini\fR(9F), should only be destroyed in \fB_fini()\fR after \fBmod_remove()\fR returns successfully. .SH EXAMPLES -.LP \fBExample 1 \fRInitializing and Freeing a Mutex .sp .LP @@ -158,8 +151,6 @@ _fini(void) .in -2 .SH SEE ALSO -.sp -.LP \fBadd_drv\fR(1M), \fBmod_info\fR(9F), \fBmod_install\fR(9F), \fBmod_remove\fR(9F), \fBmutex\fR(9F), \fBmodldrv\fR(9S), \fBmodlinkage\fR(9S), \fBmodlstrmod\fR(9S) @@ -167,17 +158,11 @@ _fini(void) .LP \fIWriting Device Drivers\fR .SH WARNINGS -.sp -.LP Do not change the structures referred to by the \fBmodlinkage\fR structure after the call to \fBmod_install()\fR, as the system may copy or change them. .SH NOTES -.sp -.LP Even though the identifiers \fB_fini()\fR, \fB_info()\fR, and \fB_init()\fR appear to be declared as globals, their scope is restricted by the kernel to the module that they are defined in. .SH BUGS -.sp -.LP On some implementations \fB_info()\fR may be called before \fB_init()\fR. diff --git a/usr/src/man/man9e/ioctl.9e b/usr/src/man/man9e/ioctl.9e index afb43407d0..796d92a37f 100644 --- a/usr/src/man/man9e/ioctl.9e +++ b/usr/src/man/man9e/ioctl.9e @@ -3,11 +3,10 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH IOCTL 9E "Dec 3, 1996" +.TH IOCTL 9E "May 6, 2020" .SH NAME ioctl \- control a character device .SH SYNOPSIS -.LP .nf #include <sys/cred.h> #include <sys/file.h> @@ -23,11 +22,8 @@ ioctl \- control a character device .fi .SH INTERFACE LEVEL -.sp -.LP Architecture independent level 1 (DDI/DKI). This entry point is \fBoptional\fR. .SH ARGUMENTS -.sp .ne 2 .na \fB\fIdev\fR\fR @@ -112,8 +108,6 @@ value which is valid only if the \fBioctl()\fR succeeds. .RE .SH DESCRIPTION -.sp -.LP \fBioctl()\fR provides character-access drivers with an alternate entry point that can be used for almost any operation other than a simple transfer of characters in and out of buffers. Most often, \fBioctl()\fR is used to control @@ -132,7 +126,10 @@ I/O control commands are used to implement the terminal settings passed from \fBttymon\fR(1M) and \fBstty\fR(1), to format disk devices, to implement a trace driver for debugging, and to clean up character queues. Since the kernel does not interpret the command type that defines the operation, a driver is -free to define its own commands. +free to define its own commands. Drivers must be prepared to receive commands +that they do not recognize or are in contexts that they do not expect. In the +case where \fIcmd\fR is unknown, it is recommended that the driver return +\fBENOTTY\fR. .sp .LP Drivers that use an \fBioctl()\fR routine typically have a command to ``read'' @@ -205,13 +202,10 @@ action that should be taken. However, the command passed to the driver by the user process is an integer value associated with the command name in the header. .SH RETURN VALUES -.sp -.LP \fBioctl()\fR should return \fB0\fR on success, or the appropriate error number. The driver may also set the value returned to the calling process through \fIrval_p\fR. .SH EXAMPLES -.LP \fBExample 1 \fR\fBioctl()\fR entry point .sp .LP @@ -263,8 +257,6 @@ xxioctl(dev_t dev, int cmd, intptr_t arg, int mode, .in -2 .SH SEE ALSO -.sp -.LP \fBstty\fR(1), \fBttymon\fR(1M), \fBdkio\fR(7I), \fBfbio\fR(7I), \fBtermio\fR(7I), \fBopen\fR(9E), \fBput\fR(9E), \fBsrv\fR(9E), \fBcopyin\fR(9F), \fBcopyout\fR(9F), \fBddi_copyin\fR(9F), @@ -273,7 +265,6 @@ xxioctl(dev_t dev, int cmd, intptr_t arg, int mode, .LP \fIWriting Device Drivers\fR .SH WARNINGS -.sp .LP Non-STREAMS driver \fBioctl()\fR routines must make sure that user data is copied into or out of the kernel address space explicitly using @@ -288,8 +279,6 @@ even when in user context. Failure to use the appropriate copying routines can result in panics under load on some platforms, and reproducible panics on others. .SH NOTES -.sp -.LP STREAMS drivers do not have \fBioctl()\fR routines. The stream head converts I/O control commands to \fBM_IOCTL\fR messages, which are handled by the driver's \fBput\fR(9E) or \fBsrv\fR(9E) routine. 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 |