2 * Copyright (c) 1996 Jason R. Thorpe <thorpej@and.com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
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 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgements:
15 * This product includes software developed by Jason R. Thorpe
16 * for And Communications, http://www.and.com/
17 * 4. The name of the author may not be used to endorse or promote products
18 * derived from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 #include <sys/types.h>
41 #include <sys/ioccom.h>
44 * Element types. Used as "to" and "from" type indicators in move
45 * and exchange operations.
47 * Note that code in sys/scsi/ch.c relies on these values (uses them
48 * as offsets in an array, and other evil), so don't muck with them
49 * unless you know what you're doing.
51 #define CHET_MT 0 /* medium transport (picker) */
52 #define CHET_ST 1 /* storage transport (slot) */
53 #define CHET_IE 2 /* import/export (portal) */
54 #define CHET_DT 3 /* data transfer (drive) */
55 #define CHET_MAX CHET_DT
58 * Maximum length of a volume identification string
60 #define CH_VOLTAG_MAXLEN 32
63 * Structure used to execute a MOVE MEDIUM command.
66 u_int16_t cm_fromtype; /* element type to move from */
67 u_int16_t cm_fromunit; /* logical unit of from element */
68 u_int16_t cm_totype; /* element type to move to */
69 u_int16_t cm_tounit; /* logical unit of to element */
70 u_int16_t cm_flags; /* misc. flags */
74 #define CM_INVERT 0x01 /* invert media */
77 * Structure used to execute an EXCHANGE MEDIUM command. In an
78 * exchange operation, the following steps occur:
80 * - media from source is moved to first destination.
82 * - media previously occupying first destination is moved
83 * to the second destination.
85 * The second destination may or may not be the same as the source.
86 * In the case of a simple exchange, the source and second destination
89 struct changer_exchange {
90 u_int16_t ce_srctype; /* element type of source */
91 u_int16_t ce_srcunit; /* logical unit of source */
92 u_int16_t ce_fdsttype; /* element type of first destination */
93 u_int16_t ce_fdstunit; /* logical unit of first destination */
94 u_int16_t ce_sdsttype; /* element type of second destination */
95 u_int16_t ce_sdstunit; /* logical unit of second destination */
96 u_int16_t ce_flags; /* misc. flags */
100 #define CE_INVERT1 0x01 /* invert media 1 */
101 #define CE_INVERT2 0x02 /* invert media 2 */
104 * Structure used to execute a POSITION TO ELEMENT command. This
105 * moves the current picker in front of the specified element.
107 struct changer_position {
108 u_int16_t cp_type; /* element type */
109 u_int16_t cp_unit; /* logical unit of element */
110 u_int16_t cp_flags; /* misc. flags */
114 #define CP_INVERT 0x01 /* invert picker */
117 * Data returned by CHIOGPARAMS.
119 struct changer_params {
120 u_int16_t cp_npickers; /* number of pickers */
121 u_int16_t cp_nslots; /* number of slots */
122 u_int16_t cp_nportals; /* number of import/export portals */
123 u_int16_t cp_ndrives; /* number of drives */
127 * Command used to get element status.
130 struct changer_voltag {
131 u_char cv_volid[CH_VOLTAG_MAXLEN+1];
135 typedef struct changer_voltag changer_voltag_t;
138 * Flags definitions for ces_status
139 * Not all flags have meaning for all element types.
142 CES_STATUS_FULL = 0x001, /* element is full */
143 CES_STATUS_IMPEXP = 0x002, /* media deposited by operator */
144 CES_STATUS_EXCEPT = 0x004, /* element in abnormal state */
145 CES_PICKER_MASK = 0x005, /* flags valid for pickers */
146 CES_STATUS_ACCESS = 0x008, /* media accessible by picker */
147 CES_SLOT_MASK = 0x00c, /* flags valid for slots */
148 CES_DRIVE_MASK = 0x00c, /* flags valid for drives */
149 CES_STATUS_EXENAB = 0x010, /* element supports exporting */
150 CES_STATUS_INENAB = 0x020, /* element supports importing */
151 CES_PORTAL_MASK = 0x03f, /* flags valid for portals */
152 CES_INVERT = 0x040, /* invert bit */
153 CES_SOURCE_VALID = 0x080, /* source address (ces_source) valid */
154 CES_SCSIID_VALID = 0x100, /* ces_scsi_id is valid */
155 CES_LUN_VALID = 0x200, /* ces_scsi_lun is valid */
156 CES_PIV = 0x400 /* ces_protocol_id is valid */
159 struct changer_element_status {
160 u_int8_t ces_type; /* element type */
161 u_int16_t ces_addr; /* logical element address */
162 u_int16_t ces_int_addr; /* changer element address */
163 ces_status_flags ces_flags; /*
164 * see CESTATUS definitions
167 u_int8_t ces_sensecode; /*
169 * code for element */
170 u_int8_t ces_sensequal; /*
174 u_int8_t ces_source_type; /*
178 u_int16_t ces_source_addr; /*
179 * source address of medium
181 changer_voltag_t ces_pvoltag; /* primary volume tag */
182 changer_voltag_t ces_avoltag; /* alternate volume tag */
183 u_int8_t ces_scsi_id; /* SCSI id of element */
184 u_int8_t ces_scsi_lun; /* SCSI lun of element */
187 * Data members for SMC3 and later versions
189 u_int8_t ces_medium_type;
190 #define CES_MEDIUM_TYPE_UNKNOWN 0 /* Medium type unspecified */
191 #define CES_MEDIUM_TYPE_DATA 1 /* Data medium */
192 #define CES_MEDIUM_TYPE_CLEANING 2 /* Cleaning medium */
193 #define CES_MEDIUM_TYPE_DIAGNOSTIC 3 /* Diagnostic medium */
194 #define CES_MEDIUM_TYPE_WORM 4 /* WORM medium */
195 #define CES_MEDIUM_TYPE_MICROCODE 5 /* Microcode image medium */
197 u_int8_t ces_protocol_id;
198 #define CES_PROTOCOL_ID_FCP_4 0 /* Fiber channel */
199 #define CES_PROTOCOL_ID_SPI_5 1 /* Parallel SCSI */
200 #define CES_PROTOCOL_ID_SSA_S3P 2 /* SSA */
201 #define CES_PROTOCOL_ID_SBP_3 3 /* IEEE 1394 */
202 #define CES_PROTOCOL_ID_SRP 4 /* SCSI Remote DMA */
203 #define CES_PROTOCOL_ID_ISCSI 5 /* iSCSI */
204 #define CES_PROTOCOL_ID_SPL 6 /* SAS */
205 #define CES_PROTOCOL_ID_ADT_2 7 /* Automation/Drive Interface */
206 #define CES_PROTOCOL_ID_ACS_2 8 /* ATA */
209 #define CES_ASSOC_LOGICAL_UNIT 0
210 #define CES_ASSOC_TARGET_PORT 1
211 #define CES_ASSOC_TARGET_DEVICE 2
213 u_int8_t ces_designator_type;
214 #define CES_DESIGNATOR_TYPE_VENDOR_SPECIFIC 0
215 #define CES_DESIGNATOR_TYPE_T10_VENDOR_ID 1
216 #define CES_DESIGNATOR_TYPE_EUI_64 2
217 #define CES_DESIGNATOR_TYPE_NAA 3
218 #define CES_DESIGNATOR_TYPE_TARGET_PORT_ID 4
219 #define CES_DESIGNATOR_TYPE_TARGET_PORT_GRP 5
220 #define CES_DESIGNATOR_TYPE_LOGICAL_UNIT_GRP 6
221 #define CES_DESIGNATOR_TYPE_MD5_LOGICAL_UNIT_ID 7
222 #define CES_DESIGNATOR_TYPE_SCSI_NAME_STRING 8
224 u_int8_t ces_code_set;
225 #define CES_CODE_SET_RESERVED 0
226 #define CES_CODE_SET_BINARY 1
227 #define CES_CODE_SET_ASCII 2
228 #define CES_CODE_SET_UTF_8 3
230 u_int8_t ces_designator_length;
232 #define CES_MAX_DESIGNATOR_LENGTH (1 << 8)
233 u_int8_t ces_designator[CES_MAX_DESIGNATOR_LENGTH + 1];
236 struct changer_element_status_request {
237 u_int16_t cesr_element_type;
238 u_int16_t cesr_element_base;
239 u_int16_t cesr_element_count;
241 u_int16_t cesr_flags;
242 #define CESR_VOLTAGS 0x01
244 struct changer_element_status *cesr_element_status;
248 struct changer_set_voltag_request {
252 u_int16_t csvr_flags;
253 #define CSVR_MODE_MASK 0x0f /* mode mask, acceptable modes below: */
254 #define CSVR_MODE_SET 0x00 /* set volume tag if not set */
255 #define CSVR_MODE_REPLACE 0x01 /* unconditionally replace volume tag */
256 #define CSVR_MODE_CLEAR 0x02 /* clear volume tag */
258 #define CSVR_ALTERNATE 0x10 /* set to work with alternate voltag */
260 changer_voltag_t csvr_voltag;
264 #define CESTATUS_BITS \
265 "\20\6INEAB\5EXENAB\4ACCESS\3EXCEPT\2IMPEXP\1FULL"
267 #define CHIOMOVE _IOW('c', 0x01, struct changer_move)
268 #define CHIOEXCHANGE _IOW('c', 0x02, struct changer_exchange)
269 #define CHIOPOSITION _IOW('c', 0x03, struct changer_position)
270 #define CHIOGPICKER _IOR('c', 0x04, int)
271 #define CHIOSPICKER _IOW('c', 0x05, int)
272 #define CHIOGPARAMS _IOR('c', 0x06, struct changer_params)
273 #define CHIOIELEM _IOW('c', 0x07, u_int32_t)
274 #define OCHIOGSTATUS _IOW('c', 0x08, struct changer_element_status_request)
275 #define CHIOSETVOLTAG _IOW('c', 0x09, struct changer_set_voltag_request)
276 #define CHIOGSTATUS _IOW('c', 0x0A, struct changer_element_status_request)
278 #endif /* !_SYS_CHIO_H_ */