diff options
Diffstat (limited to 'static/freebsd/man4/ses.4 3.html')
| -rw-r--r-- | static/freebsd/man4/ses.4 3.html | 128 |
1 files changed, 128 insertions, 0 deletions
diff --git a/static/freebsd/man4/ses.4 3.html b/static/freebsd/man4/ses.4 3.html new file mode 100644 index 00000000..c2aad7c5 --- /dev/null +++ b/static/freebsd/man4/ses.4 3.html @@ -0,0 +1,128 @@ +<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> — <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">device ses</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="KERNEL_CONFIGURATION"><a class="permalink" href="#KERNEL_CONFIGURATION">KERNEL + CONFIGURATION</a></h1> +<p class="Pp">It is only necessary to explicitly configure one + <code class="Nm">ses</code> device; data structures are dynamically + allocated as devices are found on the SCSI bus.</p> +<p class="Pp">A separate option, <var class="Va">SES_ENABLE_PASSTHROUGH</var>, + may be specified to allow the <code class="Nm">ses</code> driver to perform + functions on devices of other classes that claim to also support + <code class="Nm">ses</code> functionality.</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 + <code class="Nm">ses</code> devices. They are defined in the header file + <code class="In"><<a class="In">cam/scsi/scsi_enc.h</a>></code> + (<i>q.v.</i>).</p> +<dl class="Bl-tag"> + <dt id="ENCIOC_GETNELM"><a class="permalink" href="#ENCIOC_GETNELM"><code class="Dv">ENCIOC_GETNELM</code></a></dt> + <dd>Used to find out how many <code class="Nm">ses</code> elements are driven + by this particular device instance.</dd> + <dt id="ENCIOC_GETELMMAP"><a class="permalink" href="#ENCIOC_GETELMMAP"><code class="Dv">ENCIOC_GETELMMAP</code></a></dt> + <dd>Read, from the kernel, an array of SES elements which contains the element + identifier, which subenclosure it is in, and the + <code class="Nm">ses</code> type of the element.</dd> + <dt id="ENCIOC_GETENCSTAT"><a class="permalink" href="#ENCIOC_GETENCSTAT"><code class="Dv">ENCIOC_GETENCSTAT</code></a></dt> + <dd>Get the overall enclosure status.</dd> + <dt id="ENCIOC_SETENCSTAT"><a class="permalink" href="#ENCIOC_SETENCSTAT"><code class="Dv">ENCIOC_SETENCSTAT</code></a></dt> + <dd>Set the overall enclosure status.</dd> + <dt id="ENCIOC_GETELMSTAT"><a class="permalink" href="#ENCIOC_GETELMSTAT"><code class="Dv">ENCIOC_GETELMSTAT</code></a></dt> + <dd>Get the status of a particular element.</dd> + <dt id="ENCIOC_SETELMSTAT"><a class="permalink" href="#ENCIOC_SETELMSTAT"><code class="Dv">ENCIOC_SETELMSTAT</code></a></dt> + <dd>Set the status of a particular element.</dd> + <dt id="ENCIOC_GETTEXT"><a class="permalink" href="#ENCIOC_GETTEXT"><code class="Dv">ENCIOC_GETTEXT</code></a></dt> + <dd>Get the associated help text for an element (not yet implemented). + <code class="Nm">ses</code> devices often have descriptive text for an + element which can tell you things like location (e.g., "left power + supply").</dd> + <dt id="ENCIOC_INIT"><a class="permalink" href="#ENCIOC_INIT"><code class="Dv">ENCIOC_INIT</code></a></dt> + <dd>Initialize the enclosure.</dd> + <dt id="ENCIOC_GETELMDESC"><a class="permalink" href="#ENCIOC_GETELMDESC"><code class="Dv">ENCIOC_GETELMDESC</code></a></dt> + <dd>Get the element's descriptor string.</dd> + <dt id="ENCIOC_GETELMDEVNAMES"><a class="permalink" href="#ENCIOC_GETELMDEVNAMES"><code class="Dv">ENCIOC_GETELMDEVNAMES</code></a></dt> + <dd>Get the device names, if any, associated with this element.</dd> + <dt id="ENCIOC_GETSTRING"><a class="permalink" href="#ENCIOC_GETSTRING"><code class="Dv">ENCIOC_GETSTRING</code></a></dt> + <dd>Used to read the SES String In Diagnostic Page. The contents of this page + are device-specific.</dd> + <dt id="ENCIOC_SETSTRING"><a class="permalink" href="#ENCIOC_SETSTRING"><code class="Dv">ENCIOC_SETSTRING</code></a></dt> + <dd>Used to set the SES String Out Diagnostic Page. The contents of this page + are device-specific.</dd> + <dt id="ENCIOC_GETENCNAME"><a class="permalink" href="#ENCIOC_GETENCNAME"><code class="Dv">ENCIOC_GETENCNAME</code></a></dt> + <dd>Used to get the name of the enclosure.</dd> + <dt id="ENCIOC_GETENCID"><a class="permalink" href="#ENCIOC_GETENCID"><code class="Dv">ENCIOC_GETENCID</code></a></dt> + <dd>Used to get the Enclosure Logical Identifier.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="EXAMPLE_USAGE"><a class="permalink" href="#EXAMPLE_USAGE">EXAMPLE + USAGE</a></h1> +<p class="Pp">The files contained in + <code class="In"><<a class="In">/usr/share/examples/ses</a>></code> + show simple mechanisms for how to use these interfaces, as well as a very + stupid simple monitoring daemon.</p> +</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">sesutil(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 originally written for + the CAM SCSI subsystem by Matthew Jacob and first released in + <span class="Ux">FreeBSD 4.3</span>. It was a functional equivalent of a + similar driver available in Solaris, Release 7. It was largely rewritten by + Alexander Motin, Justin Gibbs, and Will Andrews for <span class="Ux">FreeBSD + 9.2</span>.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">November 12, 2019</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |