1 /* 2 * Structure and function declartaions for the 3 * SCSI Sequential Access Peripheral driver for CAM. 4 * 5 * Copyright (c) 1997 Justin T. Gibbs 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions, and the following disclaimer, 13 * without modification, immediately at the beginning of the file. 14 * 2. The name of the author may not be used to endorse or promote products 15 * derived from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 21 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * $Id$ 30 */ 31 32 #ifndef _SCSI_SCSI_SA_H 33 #define _SCSI_SCSI_SA_H 1 34 35 #include <sys/cdefs.h> 36 37 struct scsi_read_block_limits 38 { 39 u_int8_t opcode; 40 u_int8_t byte2; 41 u_int8_t unused[3]; 42 u_int8_t control; 43 }; 44 45 struct scsi_read_block_limits_data 46 { 47 u_int8_t gran; 48 #define RBL_GRAN_MASK 0x1F 49 #define RBL_GRAN(rblim) ((rblim)->gran & RBL_GRAN_MASK) 50 u_int8_t maximum[3]; 51 u_int8_t minimum[2]; 52 }; 53 54 struct scsi_sa_rw 55 { 56 u_int8_t opcode; 57 u_int8_t sli_fixed; 58 #define SAR_SLI 0x02 59 #define SARW_FIXED 0x01 60 u_int8_t length[3]; 61 u_int8_t control; 62 }; 63 64 struct scsi_load_unload 65 { 66 u_int8_t opcode; 67 u_int8_t immediate; 68 #define SLU_IMMED 0x01 69 u_int8_t reserved[2]; 70 u_int8_t eot_reten_load; 71 #define SLU_EOT 0x04 72 #define SLU_RETEN 0x02 73 #define SLU_LOAD 0x01 74 u_int8_t control; 75 }; 76 77 struct scsi_rewind 78 { 79 u_int8_t opcode; 80 u_int8_t immediate; 81 #define SREW_IMMED 0x01 82 u_int8_t reserved[3]; 83 u_int8_t control; 84 }; 85 86 typedef enum { 87 SS_BLOCKS, 88 SS_FILEMARKS, 89 SS_SEQFILEMARKS, 90 SS_EOD, 91 SS_SETMARKS, 92 SS_SEQSETMARKS 93 } scsi_space_code; 94 95 struct scsi_space 96 { 97 u_int8_t opcode; 98 u_int8_t code; 99 #define SREW_IMMED 0x01 100 u_int8_t count[3]; 101 u_int8_t control; 102 }; 103 104 struct scsi_write_filemarks 105 { 106 u_int8_t opcode; 107 u_int8_t byte2; 108 #define SWFMRK_IMMED 0x01 109 #define SWFMRK_WSMK 0x02 110 u_int8_t num_marks[3]; 111 u_int8_t control; 112 }; 113 114 /* 115 * Reserve and release unit have the same exact cdb format, but different 116 * opcodes. 117 */ 118 struct scsi_reserve_release_unit 119 { 120 u_int8_t opcode; 121 u_int8_t lun_thirdparty; 122 #define SRRU_LUN_MASK 0xE0 123 #define SRRU_3RD_PARTY 0x10 124 #define SRRU_3RD_SHAMT 1 125 #define SRRU_3RD_MASK 0xE 126 u_int8_t reserved[3]; 127 u_int8_t control; 128 }; 129 130 /* 131 * Erase a tape 132 */ 133 struct scsi_erase 134 { 135 u_int8_t opcode; 136 u_int8_t lun_imm_long; 137 #define SE_LUN_MASK 0xE0 138 #define SE_LONG 0x1 139 #define SE_IMMED 0x2 140 u_int8_t reserved[3]; 141 u_int8_t control; 142 }; 143 144 /* 145 * Dev specific mode page masks. 146 */ 147 #define SMH_SA_WP 0x80 148 #define SMH_SA_BUF_MODE_MASK 0x70 149 #define SMH_SA_BUF_MODE_NOBUF 0x00 150 #define SMH_SA_BUF_MODE_SIBUF 0x10 /* Single-Initiator buffering */ 151 #define SMH_SA_BUF_MODE_MIBUF 0x20 /* Multi-Initiator buffering */ 152 #define SMH_SA_SPEED_MASK 0x0F 153 #define SMH_SA_SPEED_DEFAULT 0x00 154 155 /* 156 * Sequential-access specific mode page numbers. 157 */ 158 #define SA_DATA_COMPRESSION_PAGE 0x0f 159 #define SA_DEVICE_CONFIGURATION_PAGE 0x10 160 #define SA_MEDIUM_PARTITION_PAGE_1 0x11 161 #define SA_MEDIUM_PARTITION_PAGE_2 0x12 162 #define SA_MEDIUM_PARTITION_PAGE_3 0x13 163 #define SA_MEDIUM_PARTITION_PAGE_4 0x14 164 165 /* 166 * Mode page definitions. 167 */ 168 169 struct scsi_data_compression_page { 170 u_int8_t page_code; 171 u_int8_t page_length; 172 #define SA_DCP_DCE 0x80 /* Data compression enable */ 173 #define SA_DCP_DCC 0x40 /* Data compression capable */ 174 u_int8_t dce_and_dcc; 175 #define SA_DCP_DDE 0x80 /* Data decompression enable */ 176 #define SA_DCP_RED_MASK 0x60 /* Report Exception on Decomp. */ 177 #define SA_DCP_RED_SHAMT 5 178 #define SA_DCP_RED_0 0x00 179 #define SA_DCP_RED_1 0x20 180 #define SA_DCP_RED_2 0x40 181 u_int8_t dde_and_red; 182 u_int8_t comp_algorithm[4]; 183 u_int8_t decomp_algorithm[4]; 184 u_int8_t reserved[4]; 185 }; 186 187 /* 188 * Opcodes 189 */ 190 #define REWIND 0x01 191 #define READ_BLOCK_LIMITS 0x05 192 #define SA_READ 0x08 193 #define SA_WRITE 0x0A 194 #define WRITE_FILEMARKS 0x10 195 #define SPACE 0x11 196 #define RESERVE_UNIT 0x16 197 #define RELEASE_UNIT 0x17 198 #define ERASE 0x19 199 #define LOAD_UNLOAD 0x1B 200 201 __BEGIN_DECLS 202 void scsi_read_block_limits(struct ccb_scsiio *, u_int32_t, 203 void (*cbfcnp)(struct cam_periph *, union ccb *), 204 u_int8_t, struct scsi_read_block_limits_data *, 205 u_int8_t , u_int32_t); 206 207 void scsi_sa_read_write(struct ccb_scsiio *csio, u_int32_t retries, 208 void (*cbfcnp)(struct cam_periph *, union ccb *), 209 u_int8_t tag_action, int readop, int sli, 210 int fixed, u_int32_t length, u_int8_t *data_ptr, 211 u_int32_t dxfer_len, u_int8_t sense_len, 212 u_int32_t timeout); 213 214 void scsi_rewind(struct ccb_scsiio *csio, u_int32_t retries, 215 void (*cbfcnp)(struct cam_periph *, union ccb *), 216 u_int8_t tag_action, int immediate, u_int8_t sense_len, 217 u_int32_t timeout); 218 219 void scsi_space(struct ccb_scsiio *csio, u_int32_t retries, 220 void (*cbfcnp)(struct cam_periph *, union ccb *), 221 u_int8_t tag_action, scsi_space_code code, 222 u_int32_t count, u_int8_t sense_len, u_int32_t timeout); 223 224 void scsi_load_unload(struct ccb_scsiio *csio, u_int32_t retries, 225 void (*cbfcnp)(struct cam_periph *, union ccb *), 226 u_int8_t tag_action, int immediate, int eot, 227 int reten, int load, u_int8_t sense_len, 228 u_int32_t timeout); 229 230 void scsi_write_filemarks(struct ccb_scsiio *csio, u_int32_t retries, 231 void (*cbfcnp)(struct cam_periph *, union ccb *), 232 u_int8_t tag_action, int immediate, int setmark, 233 u_int32_t num_marks, u_int8_t sense_len, 234 u_int32_t timeout); 235 236 void scsi_reserve_release_unit(struct ccb_scsiio *csio, u_int32_t retries, 237 void (*cbfcnp)(struct cam_periph *, 238 union ccb *), u_int8_t tag_action, 239 int third_party, int third_party_id, 240 u_int8_t sense_len, u_int32_t timeout, 241 int reserve); 242 243 void scsi_erase(struct ccb_scsiio *csio, u_int32_t retries, 244 void (*cbfcnp)(struct cam_periph *, union ccb *), 245 u_int8_t tag_action, int immediate, int long_erase, 246 u_int8_t sense_len, u_int32_t timeout); 247 248 void scsi_data_comp_page(struct scsi_data_compression_page *page, 249 u_int8_t dce, u_int8_t dde, u_int8_t red, 250 u_int32_t comp_algorithm, 251 u_int32_t decomp_algorithm); 252 __END_DECLS 253 254 #endif /* _SCSI_SCSI_SA_H */ 255