summaryrefslogtreecommitdiff
path: root/static/netbsd/man4/ses.4 4.html
blob: 72f67114c83aaae45131a1c183cbf113beb3e21a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<table class="head">
  <tr>
    <td class="head-ltitle">SES(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">SES(4)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">ses</code> &#x2014; <span class="Nd">SCSI
    Environmental Services Driver</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="Cd">ses* at scsibus? target ? lun ?</code></p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">ses</code> driver provides support for all
    SCSI devices of the environmental services class that are attached to the
    system through a supported 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.</p>
<p class="Pp">A SCSI Host adapter must also be separately configured into the
    system before a SCSI Environmental Services device can be configured.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="IOCTLS"><a class="permalink" href="#IOCTLS">IOCTLS</a></h1>
<p class="Pp">The following <a class="Xr">ioctl(2)</a> calls apply to
    <i class="Em">SES</i> devices. They are defined in the header file
    <code class="In">&lt;<a class="In">scsipi/ses.h</a>&gt;</code> (q.v.).</p>
<dl class="Bl-tag">
  <dt id="SESIOC_GETNOBJ"><a class="permalink" href="#SESIOC_GETNOBJ"><code class="Dv">SESIOC_GETNOBJ</code></a></dt>
  <dd>Used to find out how many <i class="Em">SES</i> objects are driven by this
      particular device instance.</dd>
  <dt id="SESIOC_GETOBJMAP"><a class="permalink" href="#SESIOC_GETOBJMAP"><code class="Dv">SESIOC_GETOBJMAP</code></a></dt>
  <dd>Read, from the kernel, an array of SES objects which contains the object
      identifier, which sub-enclosure it is in, and the <i class="Em">SES</i>
      type of the object.</dd>
  <dt id="SESIOC_GETENCSTAT"><a class="permalink" href="#SESIOC_GETENCSTAT"><code class="Dv">SESIOC_GETENCSTAT</code></a></dt>
  <dd>Get the overall enclosure status.</dd>
  <dt id="SESIOC_SETENCSTAT"><a class="permalink" href="#SESIOC_SETENCSTAT"><code class="Dv">SESIOC_SETENCSTAT</code></a></dt>
  <dd>Set the overall enclosure status.</dd>
  <dt id="SESIOC_GETOBJSTAT"><a class="permalink" href="#SESIOC_GETOBJSTAT"><code class="Dv">SESIOC_GETOBJSTAT</code></a></dt>
  <dd>Get the status of a particular object.</dd>
  <dt id="SESIOC_SETOBJSTAT"><a class="permalink" href="#SESIOC_SETOBJSTAT"><code class="Dv">SESIOC_SETOBJSTAT</code></a></dt>
  <dd>Set the status of a particular object.</dd>
  <dt id="SESIOC_GETTEXT"><a class="permalink" href="#SESIOC_GETTEXT"><code class="Dv">SESIOC_GETTEXT</code></a></dt>
  <dd>Get the associated help text for an object (not yet implemented).
      <i class="Em">SES</i> devices often have descriptive text for an object
      which can tell you things like location (e.g, &quot;left power
      supply&quot;).</dd>
  <dt id="SESIOC_INIT"><a class="permalink" href="#SESIOC_INIT"><code class="Dv">SESIOC_INIT</code></a></dt>
  <dd>Initialize the enclosure.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
<dl class="Bl-tag Bl-compact">
  <dt id="Nth"><span class="Pa">/dev/ses</span><var class="Ar">N</var></dt>
  <dd>The <a class="permalink" href="#Nth"><i class="Em">Nth</i></a>
      <code class="Nm">ses</code> device.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOSTICS</a></h1>
<p class="Pp">When the kernel is configured with DEBUG enabled, the first open
    to an SES device will spit out overall enclosure parameters to the
  console.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">getencstat(8)</a>, <a class="Xr">sesd(8)</a>,
    <a class="Xr">setencstat(8)</a>, <a class="Xr">setobjstat(8)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">ses</code> driver was written for the SCSI
    subsystem by Matthew Jacob. This is the functional equivalent of a similar
    driver available in Solaris, Release 7.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">May 24, 2007</td>
    <td class="foot-os">NetBSD 10.1</td>
  </tr>
</table>