summaryrefslogtreecommitdiff
path: root/share/man/man4/ses.4
diff options
context:
space:
mode:
authormjacob <mjacob@cvs.openbsd.org>2000-02-22 23:35:28 +0000
committermjacob <mjacob@cvs.openbsd.org>2000-02-22 23:35:28 +0000
commitc71482aa07c129dadfd0a3c1f93eb19e4b386b14 (patch)
tree2429e01bc67b3b6c9fb9731daa1cc615176dd5bd /share/man/man4/ses.4
parent4950f8020759a8c064d3e12230ae2c146827f251 (diff)
add ses.4 man page
Diffstat (limited to 'share/man/man4/ses.4')
-rw-r--r--share/man/man4/ses.4113
1 files changed, 113 insertions, 0 deletions
diff --git a/share/man/man4/ses.4 b/share/man/man4/ses.4
new file mode 100644
index 00000000000..453014062a7
--- /dev/null
+++ b/share/man/man4/ses.4
@@ -0,0 +1,113 @@
+.\" Copyright (c) 2000
+.\" Matthew Jacob <mjacob@openbsd.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.
+.\"
+.\" $OpenBSD: ses.4,v 1.1 2000/02/22 23:35:27 mjacob Exp $
+.\"
+.Dd February 22, 2000
+.Dt SES 4
+.Os OpenBSD
+.Sh NAME
+.Nm ses
+.Nd SCSI Environmental Services Driver
+.Sh SYNOPSIS
+.Sh SYNOPSIS
+.Cd ses* at scsibus? target ? lun ?
+.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 IOCTLS
+The following
+.Xr ioctl 2
+calls apply to
+.B SES
+devices.
+They are defined in the header file
+.Aq Pa 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 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 SEE ALSO
+.Xr sesd 8 ,
+.Xr getencstat 8 ,
+.Xr setenctsat 8 ,
+.Xr setobjstat 8
+.Sh HISTORY
+The
+.Nm
+driver was written for the
+.Tn SCSI
+subsystem by Matthew Jacob. This is the functional equivalent of a similar
+driver available in Solaris, Release 7.