share/man/man7d/ses.7d

   1 '\" te
   2 .\"  Copyright (c) 20081 Sun Microsystems. Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH SES 7D "May 27, 2008"
   7 .SH NAME
   8 ses \- SCSI enclosure services device driver
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBses\fR\fI@target\fR\fB,\fR\fIlun\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The  \fBses\fR device driver is an interface to \fBSCSI\fR enclosure services
  19 devices. These devices sense and monitor the physical conditions in an
  20 enclosure as well as allow access to the status reporting and configuration
  21 features of the enclosure (such as indicator \fBLEDs\fR on the enclosure.)
  22 .sp
  23 .LP
  24 \fBioctl\fR(9E) calls may be issued to \fBses\fR to determine the state of the
  25 enclosure and to set parameters on the enclosure services device.
  26 .sp
  27 .LP
  28 No \fBses\fR driver properties are defined. Use the \fBses.conf\fR file to
  29 configure the \fBses\fR driver.
  30 .SH EXAMPLES
  31 .LP
  32 \fBExample 1 \fR\fBses.conf\fR File Format
  33 .sp
  34 .LP
  35 The following is an example of the \fBses.conf\fR file format:
  36
  37 .sp
  38 .in +2
  39 .nf
  40 #
  41 # Copyright (c) 1996, by Sun Microsystems, Inc.
  42 # All rights reserved.
  43 #
  44 #
  45 #ident "@(#)ses.conf 1.1    97/02/10 SMI"
  46 #
  47
  48 name="ses" parent="sf"
  49       target=15;
  50
  51 name="ses" parent="SUNW,pln" port=0 target=15;
  52 name="ses" parent="SUNW,pln" port=1 target=15;
  53 name="ses" parent="SUNW,pln" port=2 target=15;
  54 name="ses" parent="SUNW,pln" port=3 target=15;
  55 name="ses" parent="SUNW,pln" port=4 target=15;
  56 name="ses" parent="SUNW,pln" port=5 target=15;
  57
  58 name="ses" class="scsi"
  59       target=15 lun=0;
  60 .fi
  61 .in -2
  62
  63 .SH IOCTLS
  64 .sp
  65 .LP
  66 The SES driver currently supports the SES, SAFTE and SEN enclosure service
  67 chipsets. SEN and SAFTE protocols are translated internally in the driver into
  68 SES compliant data structures. This enables the SES driver to work seamlessly
  69 with  different protocols and eliminates the need to enhance user applications.
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBSESIOC_GETNOBJ\fR\fR
  74 .ad
  75 .RS 21n
  76 Returns an unsigned integer that represents the number of SES data structures
  77 in the enclosure services chip.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBSESIOC_GETOBJMAP\fR\fR
  84 .ad
  85 .RS 21n
  86 Returns a size array containing \fBses_object\fR elements communicated through
  87 \fBSESIOC_GETNOBJ()\fR. \fBses_object\fR is defined in \fBsesio.h\fR.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBSESIOC_INIT\fR\fR
  94 .ad
  95 .RS 21n
  96 Instructs the device to perform a self-diagnostic test. Currently SES & SEN
  97 devices always return success.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBSESIOC_GETENCSTAT\fR\fR
 104 .ad
 105 .RS 21n
 106 Returns an unsigned character that represents status enclosure as defined by
 107 Table 25 in Section 7.1.2 of the SES specification \fINCITS 305-199\fR\fIx\fR.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBSESIOC_GETOBJSTAT\fR\fR
 114 .ad
 115 .RS 21n
 116 This ioctl is passed an \fBses_objarg\fR containing the \fBobj_id\fR you want
 117 to set, then fills in the remaining fields according to element status page of
 118 the SES specification.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBSESIOC_SETOBJSTAT\fR\fR
 125 .ad
 126 .RS 21n
 127 Sets options in the control field. You set control field options by filling out
 128 all fields in \fBses_objarg\fR. Field definitions are presented in Section
 129 7.2.2 of the SES specification.
 130 .RE
 131
 132 .SH FILES
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fB/kernel/drv/ses.conf\fR\fR
 137 .ad
 138 .RS 24n
 139 Driver configuration file
 140 .RE
 141
 142 .SH ATTRIBUTES
 143 .sp
 144 .LP
 145 See \fBattributes\fR(5) for descriptions of the following attributes:
 146 .sp
 147
 148 .sp
 149 .TS
 150 box;
 151 c | c
 152 l | l .
 153 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 154 _
 155 Architecture    SPARC
 156 .TE
 157
 158 .SH SEE ALSO
 159 .sp
 160 .LP
 161 \fBdriver.conf\fR(4), \fBscsi\fR(4), \fBattributes\fR(5), \fBesp\fR(7D),
 162 \fBisp\fR(7D), \fBioctl\fR(9E)