1.\" Copyright (c) 2000
2.\" Matthew Jacob <mjacob@FreeBSD.org>. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
--- 9 unchanged lines hidden (view full) ---
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD: head/share/man/man4/ses.4 68962 2000-11-20 18:41:33Z ru $
27.\"
28.Dd January 29, 2000
29.Dt SES 4
30.Os FreeBSD
31.Sh NAME
32.Nm ses
33.Nd SCSI Environmental Services Driver
34.Sh SYNOPSIS
--- 23 unchanged lines hidden (view full) ---
58It is only necessary to explicitly configure one
59.Nm
60device; data structures are dynamically allocated as devices are found
61on the
62.Tn SCSI
63bus.
64.Pp
65A separate option,
66.B SES_ENABLE_PASSTHROUGH ,
67may be specified to allow the
68.Nm
69driver to perform functions on devices of other classes that claim to
70also support
71.B SES
72functionality.
73.Sh IOCTLS
74The following
75.Xr ioctl 2
76calls apply to
77.B SES
78devices.
79They are defined in the header file
80.Aq Pa cam/scsi/scsi_ses.h
81(\fIq.v.\fR).
82.Pp
83.Bl -tag -width SESIOC_GETENCSTAT
84.It Dv SESIOC_GETNOBJ
85Used to find out how many
86.B SES
87objects are driven by this particular device instance.
88.It Dv SESIOC_GETOBJMAP
89Read, from the kernel, an array of SES objects which contains
90the object identifier, which subenclosure it is in, and the
91.B SES
92type of the object.
93.It Dv SESIOC_GETENCSTAT
94Get the overall enclosure status.
95.It Dv SESIOC_SETENCSTAT
96Set the overall enclosure status.
97.It Dv SESIOC_GETOBJSTAT
98Get the status of a particular object.
99.It Dv SESIOC_SETOBJSTAT
100Set the status of a particular object.
101.It Dv SESIOC_GETTEXT
102Get the associated help text for an object (not yet implemented).
103.B SES
104devices often have descriptive text for an object which can tell
105you things like location (e.g, "left power supply").
106.It Dv SESIOC_INIT
107Initialize the enclosure.
108.Sh EXAMPLE USAGE
109The files contained in
110.Aq Pa usr/share/examples/ses
111show simple mechanisms for how to use these interfaces, as well as a
112very stupid simple monitoring daemon.
113.Sh FILES
114.Bl -tag -width /dev/rsdXXXXX -compact
115.It Pa /dev/ses Ns Ar N
116The
117.Em Nth
118.Nm SES
119device.
120.Sh DIAGNOSTICS
121When the kernel is configured with
122.Tn DEBUG
123enabled, the first open to an SES device will spit out overall enclosure
124parameters to the console.
125.Sh HISTORY
126The
127.Nm
128driver was written for the
129.Tn CAM
130.Tn SCSI
131subsystem by Matthew Jacob.
132This is a functional equivalent of a similar
133driver available in Solaris, Release 7.
2.\" Matthew Jacob <mjacob@FreeBSD.org>. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
--- 9 unchanged lines hidden (view full) ---
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD: head/share/man/man4/ses.4 68962 2000-11-20 18:41:33Z ru $
27.\"
28.Dd January 29, 2000
29.Dt SES 4
30.Os FreeBSD
31.Sh NAME
32.Nm ses
33.Nd SCSI Environmental Services Driver
34.Sh SYNOPSIS
--- 23 unchanged lines hidden (view full) ---
58It is only necessary to explicitly configure one
59.Nm
60device; data structures are dynamically allocated as devices are found
61on the
62.Tn SCSI
63bus.
64.Pp
65A separate option,
66.B SES_ENABLE_PASSTHROUGH ,
67may be specified to allow the
68.Nm
69driver to perform functions on devices of other classes that claim to
70also support
71.B SES
72functionality.
73.Sh IOCTLS
74The following
75.Xr ioctl 2
76calls apply to
77.B SES
78devices.
79They are defined in the header file
80.Aq Pa cam/scsi/scsi_ses.h
81(\fIq.v.\fR).
82.Pp
83.Bl -tag -width SESIOC_GETENCSTAT
84.It Dv SESIOC_GETNOBJ
85Used to find out how many
86.B SES
87objects are driven by this particular device instance.
88.It Dv SESIOC_GETOBJMAP
89Read, from the kernel, an array of SES objects which contains
90the object identifier, which subenclosure it is in, and the
91.B SES
92type of the object.
93.It Dv SESIOC_GETENCSTAT
94Get the overall enclosure status.
95.It Dv SESIOC_SETENCSTAT
96Set the overall enclosure status.
97.It Dv SESIOC_GETOBJSTAT
98Get the status of a particular object.
99.It Dv SESIOC_SETOBJSTAT
100Set the status of a particular object.
101.It Dv SESIOC_GETTEXT
102Get the associated help text for an object (not yet implemented).
103.B SES
104devices often have descriptive text for an object which can tell
105you things like location (e.g, "left power supply").
106.It Dv SESIOC_INIT
107Initialize the enclosure.
108.Sh EXAMPLE USAGE
109The files contained in
110.Aq Pa usr/share/examples/ses
111show simple mechanisms for how to use these interfaces, as well as a
112very stupid simple monitoring daemon.
113.Sh FILES
114.Bl -tag -width /dev/rsdXXXXX -compact
115.It Pa /dev/ses Ns Ar N
116The
117.Em Nth
118.Nm SES
119device.
120.Sh DIAGNOSTICS
121When the kernel is configured with
122.Tn DEBUG
123enabled, the first open to an SES device will spit out overall enclosure
124parameters to the console.
125.Sh HISTORY
126The
127.Nm
128driver was written for the
129.Tn CAM
130.Tn SCSI
131subsystem by Matthew Jacob.
132This is a functional equivalent of a similar
133driver available in Solaris, Release 7.