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