sys/sys/chio.h

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