add a minimal man page for the SES driver

1 files changed, 129 insertions, 0 deletions

diff --git a/share/man/man4/ses.4 b/share/man/man4/ses.4
new file mode 100644
index 0000000..617d237
--- /dev/null
+++ b/share/man/man4/ses.4
@@ -0,0 +1,129 @@
+.\" Copyright (c) 2000
+.\"	Matthew Jacob <mjacob@freebsd.org>.  All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\"
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd January 29, 2000
+.Dt SES 4
+.Os FreeBSD
+.Sh NAME
+.Nm ses
+.Nd SCSI Environmental Services Driver
+.Sh SYNOPSIS
+.Cd device ses
+.Sh DESCRIPTION
+The
+.Nm ses
+driver provides support for all
+.Tn SCSI
+devices of the environmental services class that are attached to the system
+through a supported
+.Tn SCSI
+Host Adapter, as well as emulated support for SAF-TE (SCSI Accessible
+Fault Tolerant Enclosures).
+The environmental services class generally are enclosure devices that
+provide environmental information such as number of power supplies (and
+state), temperature, device slots, and so on.
+.Pp
+A
+.Tn SCSI
+Host
+adapter must also be separately configured into the system
+before a
+.Tn SCSI
+SCSI Environmental Services device can be configured.
+.Sh KERNEL CONFIGURATION
+It is only necessary to explicitly configure one
+.Nm ses
+device; data structures are dynamically allocated as devices are found
+on the
+.Tn SCSI
+bus.
+.Pp
+A separate option,
+.B SES_ENABLE_PASSTHROUGH ,
+may be specified to allow the
+.Nm
+driver to perform functions on devices of other classes that claim to
+also support
+.B SES
+functionality.
+.Sh IOCTLS
+The following
+.Xr ioctl 2
+calls apply to
+.B SES
+devices.
+They are defined in the header file
+.Aq Pa cam/scsi/scsi_ses.h
+(\fIq.v.\fR).
+.Pp
+.Bl -tag -width SESIOC_GETENCSTAT
+.It Dv SESIOC_GETNOBJ
+Used to find out how many
+.B SES
+objects are driven by this particular device instance.
+.It Dv SESIOC_GETOBJMAP
+Read, from the kernel, an array of SES objects which contains
+the object identifier, which subenclosure it is in, and the
+.B SES
+type of the object.
+.It Dv SESIOC_GETENCSTAT
+Get the overall enclosure status.
+.It Dv SESIOC_SETENCSTAT
+Set the overall enclosure status.
+.It Dv SESIOC_GETOBJSTAT
+Get the status of a particular object.
+.It Dv SESIOC_SETOBJSTAT
+Set the status of a particular object.
+.It Dv SESIOC_GETTEXT
+Get the associated help text for an object (not yet implemented).
+.B SES
+devices often have descriptive text for an object which can tell
+you things like location (e.g, "left power supply").
+.It Dv SESIOC_INIT
+Initialize the enclosure.
+.Sh EXANPLE USAGE
+The files contained in
+.Aq Pa usr/share/examples/ses
+show simple mechanisms for how to use these interfaces, as well as a
+very stupid simple monitoring daemon.
+.Sh FILES
+.Bl -tag -width /dev/rsdXXXXX -compact
+.It Pa /dev/ses Ns Ar N
+The \fINth\fR \fBSES\fR device.
+.Sh DIAGNOSTICS
+When the kernel is configured with
+.Tn DEBUG
+enabled, the first open to an SES device will spit out overall enclosure
+parameters to the console.
+.Sh HISTORY
+The
+.Nm
+driver was written for the
+.Tn CAM
+.Tn SCSI
+subsystem by Matthew Jacob. This is a functional equivalent of a similar
+driver available in Solaris, Relase 7.