243 system manual pages should live with the software

Reviewed by: garrett@nexenta.com
Reviewed by: gwr@nexenta.com
Reviewed by: trisk@opensolaris.org
Approved by: gwr@nexenta.com

--HG--
extra : rebase_source : 0c599d0bec0dc8865fbba67721a7a6cd6b1feefb

4 files changed, 487 insertions, 0 deletions

diff --git a/usr/src/man/man3fcoe/FCOE_CreatePort.3fcoe b/usr/src/man/man3fcoe/FCOE_CreatePort.3fcoe
new file mode 100644
index 0000000000..03e0754762
--- /dev/null
+++ b/usr/src/man/man3fcoe/FCOE_CreatePort.3fcoe
@@ -0,0 +1,234 @@
+'\" te
+.\" Copyright (c) 2009, Sun Microsystems Inc. All Rights Reserved.
+.\" 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 FCOE_CreatePort 3FCOE "1 Apr 2009" "SunOS 5.11" "FCoE Port Management Library Functions"
+.SH NAME
+FCOE_CreatePort \- create an FCoE port
+.SH SYNOPSIS
+.LP
+.nf
+cc [ \fIflag\fR... ] \fIfile\fR... -lfcoe [ \fIlibrary\fR... ]
+#include <libfcoe.h>
+
+\fBint\fR \fBFCOE_CreatePort\fR(\fBconst char *\fR\fImacLinkName\fR, \fBint\fR \fIportType\fR,
+     \fBstruct fcoe_port_wwn\fR \fIpwwn\fR, \fBstruct fcoe_port_wwn\fR \fInwwn\fR,
+     \fBint\fR \fIpromiscuous\fR);
+.fi
+
+.SH PARAMETERS
+.sp
+.ne 2
+.mk
+.na
+\fB\fImacLinkName\fR\fR
+.ad
+.RS 15n
+.rt  
+The name of the MAC link on which to create the FCoE port.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIportType\fR\fR
+.ad
+.RS 15n
+.rt  
+This parameter should always be \fBFCOE_PORTTYPE_TARGET\fR.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIpwwn\fR\fR
+.ad
+.RS 15n
+.rt  
+The Port WorldWideName to be used for the FCoE port. Fill the structure with
+zeros to let the \fBfcoe\fR driver generate a valid Port WWN from the MAC
+address of the underlying NIC hardware.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fInwwn\fR\fR
+.ad
+.RS 15n
+.rt  
+The Node WorldWideName to be used for the FCoE port. Fill the structure with
+zeros to let the \fBfcoe\fR driver generate a valid Node WWN from the MAC
+address of the underlying NIC hardware.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIpromiscuous\fR\fR
+.ad
+.RS 15n
+.rt  
+A non-zero value to enable promiscuous mode on the underlying NIC hardware. A
+value of 0 indicates use of the multiple unicast address feature of the
+underlying NIC hardware.
+.RE
+
+.SH DESCRIPTION
+.sp
+.LP
+The \fBFCOE_CreatePort()\fR function creates an FCoE port over the specified
+MAC link.
+.SH RETURN VALUES
+.sp
+.LP
+The following values are returned:
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_ERROR_BUSY\fR\fR
+.ad
+.sp .6
+.RS 4n
+The \fBfcoe\fR driver is busy and cannot complete the operation.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_ERROR_ALREADY\fR\fR
+.ad
+.sp .6
+.RS 4n
+An existing FCoE port was found over the specified MAC link.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_ERROR_OPEN_DEV\fR\fR
+.ad
+.sp .6
+.RS 4n
+Failed to open \fBfcoe\fR device.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_ERROR_WWN_SAME\fR\fR
+.ad
+.sp .6
+.RS 4n
+The specified Port WWN is same as the specified Node WWN.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_ERROR_MAC_LEN\fR\fR
+.ad
+.sp .6
+.RS 4n
+MAC link name exceeds the maximum length.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_ERROR_PWWN_CONFLICTED\fR\fR
+.ad
+.sp .6
+.RS 4n
+The specified Port WWN is already in use.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_ERROR_NWWN_CONFLICTED\fR\fR
+.ad
+.sp .6
+.RS 4n
+The specified Node WWN is already in use.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_ERROR_NEED_JUMBO_FRAME\fR\fR
+.ad
+.sp .6
+.RS 4n
+The MTU size of the specified MAC link needs to be increased to 2500 or above.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_ERROR_OPEN_MAC\fR\fR
+.ad
+.sp .6
+.RS 4n
+Failed to open the specified MAC link.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_ERROR_CREATE_PORT\fR\fR
+.ad
+.sp .6
+.RS 4n
+Failed to create FCoE port on the specified MAC link.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_OK\fR\fR
+.ad
+.sp .6
+.RS 4n
+The API call was successful.
+.RE
+
+.SH ATTRIBUTES
+.sp
+.LP
+See \fBattributes\fR(5) for descriptions of the following attributes:
+.sp
+
+.sp
+.TS
+tab() box;
+cw(2.75i) |cw(2.75i) 
+lw(2.75i) |lw(2.75i) 
+.
+ATTRIBUTE TYPEATTRIBUTE VALUE
+_
+Interface StabilityCommitted
+_
+MT-LevelSafe
+.TE
+
+.SH SEE ALSO
+.sp
+.LP
+\fBlibfcoe\fR(3LIB), \fBattributes\fR(5)
diff --git a/usr/src/man/man3fcoe/FCOE_DeletePort.3fcoe b/usr/src/man/man3fcoe/FCOE_DeletePort.3fcoe
new file mode 100644
index 0000000000..48c582b069
--- /dev/null
+++ b/usr/src/man/man3fcoe/FCOE_DeletePort.3fcoe
@@ -0,0 +1,105 @@
+'\" te
+.\" Copyright (c) 2009, Sun Microsystems Inc. All Rights Reserved.
+.\" 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 FCOE_DeletePort 3FCOE "1 Apr 2009" "SunOS 5.11" "FCoE Port Management Library Functions"
+.SH NAME
+FCOE_DeletePort \- delete an FCoE port
+.SH SYNOPSIS
+.LP
+.nf
+cc [ \fIflag\fR... ] \fIfile\fR... -lfcoe [ \fIlibrary\fR... ]
+#include <libfcoe.h>
+
+\fBint\fR \fBFCOE_DeletePort\fR(\fBconst char *\fR\fImacLinkName\fR);
+.fi
+
+.SH PARAMETERS
+.sp
+.ne 2
+.mk
+.na
+\fB\fImacLinkName\fR\fR
+.ad
+.RS 15n
+.rt  
+The name of the MAC link from which to delete the FCoE port.
+.RE
+
+.SH DESCRIPTION
+.sp
+.LP
+The \fBFCOE_DeletePort()\fR function deletes an FCoE port from the specified
+MAC link.
+.SH RETURN VALUES
+.sp
+.LP
+The following values are returned:
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_ERROR_BUSY\fR\fR
+.ad
+.sp .6
+.RS 4n
+The \fBfcoe\fR driver is busy and cannot complete the operation.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_ERROR_MAC_LEN\fR\fR
+.ad
+.sp .6
+.RS 4n
+The MAC link name exceeds the maximum length.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_MAC_NOT_FOUND\fR\fR
+.ad
+.sp .6
+.RS 4n
+The FCoE port was not found on the specified MAC link.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_OK\fR\fR
+.ad
+.sp .6
+.RS 4n
+The API call was successful.
+.RE
+
+.SH ATTRIBUTES
+.sp
+.LP
+See \fBattributes\fR(5) for descriptions of the following attributes:
+.sp
+
+.sp
+.TS
+tab() box;
+cw(2.75i) |cw(2.75i) 
+lw(2.75i) |lw(2.75i) 
+.
+ATTRIBUTE TYPEATTRIBUTE VALUE
+_
+Interface StabilityCommitted
+_
+MT-LevelSafe
+.TE
+
+.SH SEE ALSO
+.sp
+.LP
+\fBlibfcoe\fR(3LIB), \fBattributes\fR(5)
diff --git a/usr/src/man/man3fcoe/FCOE_GetPortList.3fcoe b/usr/src/man/man3fcoe/FCOE_GetPortList.3fcoe
new file mode 100644
index 0000000000..1fae4e2b58
--- /dev/null
+++ b/usr/src/man/man3fcoe/FCOE_GetPortList.3fcoe
@@ -0,0 +1,120 @@
+'\" te
+.\" Copyright (c) 2009, Sun Microsystems Inc. All Rights Reserved.
+.\" 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 FCOE_GetPortList 3FCOE "1 Apr 2009" "SunOS 5.11" "FCoE Port Management Library Functions"
+.SH NAME
+FCOE_GetPortList \- get a list of FCoE ports
+.SH SYNOPSIS
+.LP
+.nf
+cc [ \fIflag\fR... ] \fIfile\fR... -lfcoe [ \fIlibrary\fR... ]
+#include <libfcoe.h>
+
+\fBint\fR \fBFCOE_GetPortList\fR(\fBunsigned int *\fR\fIport_num\fR,
+     \fBstruct fcoe_port_attr **\fR\fIportlist\fR);
+.fi
+
+.SH PARAMETERS
+.sp
+.ne 2
+.mk
+.na
+\fB\fIport_num\fR\fR
+.ad
+.RS 12n
+.rt  
+A pointer to an integer that, on successful return, contains the number of FCoE
+ports in the system.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIportlist\fR\fR
+.ad
+.RS 12n
+.rt  
+A pointer to a pointer to an \fBfcoe_port_attr\fR structure that, on successful
+return, contains a list of the FCoE ports in the system.
+.RE
+
+.SH DESCRIPTION
+.sp
+.LP
+The \fBFCOE_GetPortList()\fR function retrieves a list of FCoE ports. When the
+caller is finished using the list, it must free the memory used by the list by
+calling \fBfree\fR(3C).
+.SH RETURN VALUES
+.sp
+.LP
+The following values are returned:
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_ERROR_BUSY\fR\fR
+.ad
+.sp .6
+.RS 4n
+The \fBfcoe\fR driver is busy and cannot complete the operation.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_ERROR_INVAL_ARG\fR\fR
+.ad
+.sp .6
+.RS 4n
+The value specified for \fIport_num\fR or \fIportlist\fR was not valid.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_ERROR_OPEN_DEV\fR\fR
+.ad
+.sp .6
+.RS 4n
+Failed to open \fBfcoe\fR device.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBFCOE_STATUS_OK\fR\fR
+.ad
+.sp .6
+.RS 4n
+The API call was successful.
+.RE
+
+.SH ATTRIBUTES
+.sp
+.LP
+See \fBattributes\fR(5) for descriptions of the following attributes:
+.sp
+
+.sp
+.TS
+tab() box;
+cw(2.75i) |cw(2.75i) 
+lw(2.75i) |lw(2.75i) 
+.
+ATTRIBUTE TYPEATTRIBUTE VALUE
+_
+Interface StabilityCommitted
+_
+MT-LevelSafe
+.TE
+
+.SH SEE ALSO
+.sp
+.LP
+\fBfree\fR(3C), \fBlibfcoe\fR(3LIB), \fBattributes\fR(5)
diff --git a/usr/src/man/man3fcoe/Makefile b/usr/src/man/man3fcoe/Makefile
new file mode 100644
index 0000000000..cd9a550873
--- /dev/null
+++ b/usr/src/man/man3fcoe/Makefile
@@ -0,0 +1,28 @@
+#
+# This file and its contents are supplied under the terms of the
+# Common Development and Distribution License ("CDDL"), version 1.0.
+# You may only use this file in accordance with the terms of version
+# 1.0 of the CDDL.
+#
+# A full copy of the text of the CDDL should have accompanied this
+# source.  A copy of the CDDL is also available via the Internet
+# at http://www.illumos.org/license/CDDL.
+#
+
+# Copyright 2011, Richard Lowe
+
+include ../../Makefile.master
+
+MANSECT = 	3fcoe
+
+MANFILES = 	FCOE_CreatePort.3fcoe	\
+		FCOE_DeletePort.3fcoe	\
+		FCOE_GetPortList.3fcoe
+
+.KEEP_STATE:
+
+include ../Makefile.man
+
+install: $(ROOTMANFILES)
+
+