share/man/man4/ses.4

   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 .\"
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  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$
  27 .\"
  28 .Dd November 12, 2019
  29 .Dt SES 4
  30 .Os
  31 .Sh NAME
  32 .Nm ses
  33 .Nd SCSI Environmental Services driver
  34 .Sh SYNOPSIS
  35 .Cd device ses
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 driver provides support for all
  40 .Tn SCSI
  41 devices of the environmental services class that are attached to the system
  42 through a supported
  43 .Tn SCSI
  44 Host Adapter, as well as emulated support for SAF-TE (SCSI Accessible
  45 Fault Tolerant Enclosures).
  46 The environmental services class generally are enclosure devices that
  47 provide environmental information such as number of power supplies (and
  48 state), temperature, device slots, and so on.
  49 .Pp
  50 A
  51 .Tn SCSI
  52 Host
  53 adapter must also be separately configured into the system
  54 before a
  55 .Tn SCSI
  56 Environmental Services device can be configured.
  57 .Sh KERNEL CONFIGURATION
  58 It is only necessary to explicitly configure one
  59 .Nm
  60 device; data structures are dynamically allocated as devices are found
  61 on the
  62 .Tn SCSI
  63 bus.
  64 .Pp
  65 A separate option,
  66 .Va SES_ENABLE_PASSTHROUGH ,
  67 may be specified to allow the
  68 .Nm
  69 driver to perform functions on devices of other classes that claim to
  70 also support
  71 .Nm
  72 functionality.
  73 .Sh IOCTLS
  74 The following
  75 .Xr ioctl 2
  76 calls apply to
  77 .Nm
  78 devices.
  79 They are defined in the header file
  80 .In cam/scsi/scsi_enc.h
  81 (\fIq.v.\fR).
  82 .Bl -tag -width ENCIOC_GETENCSTAT
  83 .It Dv ENCIOC_GETNELM
  84 Used to find out how many
  85 .Nm
  86 elements are driven by this particular device instance.
  87 .It Dv ENCIOC_GETELMMAP
  88 Read, from the kernel, an array of SES elements which contains
  89 the element identifier, which subenclosure it is in, and the
  90 .Nm
  91 type of the element.
  92 .It Dv ENCIOC_GETENCSTAT
  93 Get the overall enclosure status.
  94 .It Dv ENCIOC_SETENCSTAT
  95 Set the overall enclosure status.
  96 .It Dv ENCIOC_GETELMSTAT
  97 Get the status of a particular element.
  98 .It Dv ENCIOC_SETELMSTAT
  99 Set the status of a particular element.
 100 .It Dv ENCIOC_GETTEXT
 101 Get the associated help text for an element (not yet implemented).
 102 .Nm
 103 devices often have descriptive text for an element which can tell
 104 you things like location (e.g., "left power supply").
 105 .It Dv ENCIOC_INIT
 106 Initialize the enclosure.
 107 .It Dv ENCIOC_GETELMDESC
 108 Get the element's descriptor string.
 109 .It Dv ENCIOC_GETELMDEVNAMES
 110 Get the device names, if any, associated with this element.
 111 .It Dv ENCIOC_GETSTRING
 112 Used to read the SES String In Diagnostic Page.
 113 The contents of this page are device-specific.
 114 .It Dv ENCIOC_SETSTRING
 115 Used to set the SES String Out Diagnostic Page.
 116 The contents of this page are device-specific.
 117 .It Dv ENCIOC_GETENCNAME
 118 Used to get the name of the enclosure.
 119 .It Dv ENCIOC_GETENCID
 120 Used to get the Enclosure Logical Identifier.
 121 .El
 122 .Sh EXAMPLE USAGE
 123 The files contained in
 124 .In /usr/share/examples/ses
 125 show simple mechanisms for how to use these interfaces, as well as a
 126 very stupid simple monitoring daemon.
 127 .Sh FILES
 128 .Bl -tag -width /dev/rsdXXXXX -compact
 129 .It Pa /dev/ses Ns Ar N
 130 The
 131 .Em Nth
 132 .Nm SES
 133 device.
 134 .El
 135 .Sh DIAGNOSTICS
 136 When the kernel is configured with
 137 .Tn DEBUG
 138 enabled, the first open to an SES device will spit out overall enclosure
 139 parameters to the console.
 140 .Sh SEE ALSO
 141 .Xr sesutil 8
 142 .Sh HISTORY
 143 The
 144 .Nm
 145 driver was originally written for the
 146 .Tn CAM
 147 .Tn SCSI
 148 subsystem by Matthew Jacob and first released in
 149 .Fx 4.3 .
 150 It was a functional equivalent of a similar
 151 driver available in Solaris, Release 7.
 152 It was largely rewritten by Alexander Motin, Justin Gibbs, and Will Andrews for
 153 .Fx 9.2 .