1 /* $NetBSD: scsiconf.h,v 1.20 1995/01/26 12:05:52 mycroft Exp $ */ 2 3 /* 4 * Copyright (c) 1993, 1994, 1995 Charles Hannum. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. All advertising materials mentioning features or use of this software 15 * must display the following acknowledgement: 16 * This product includes software developed by Charles Hannum. 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. 19 * 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, BUT 25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 /* 33 * Originally written by Julian Elischer (julian@tfs.com) 34 * for TRW Financial Systems for use under the MACH(2.5) operating system. 35 * 36 * TRW Financial Systems, in accordance with their agreement with Carnegie 37 * Mellon University, makes this software available to CMU to distribute 38 * or use in any manner that they see fit as long as this message is kept with 39 * the software. For this reason TFS also grants any other persons or 40 * organisations permission to use or modify this software. 41 * 42 * TFS supplies this software to be publicly redistributed 43 * on the understanding that TFS is not responsible for the correct 44 * functioning of this software in any circumstances. 45 * 46 * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992 47 */ 48 49 #ifndef SCSI_SCSICONF_H 50 #define SCSI_SCSICONF_H 1 51 52 typedef int boolean; 53 54 #include <sys/queue.h> 55 #include <machine/cpu.h> 56 #include <scsi/scsi_debug.h> 57 58 /* 59 * The following documentation tries to describe the relationship between the 60 * various structures defined in this file: 61 * 62 * each adapter type has a scsi_adapter struct. This describes the adapter and 63 * identifies routines that can be called to use the adapter. 64 * each device type has a scsi_device struct. This describes the device and 65 * identifies routines that can be called to use the device. 66 * each existing device position (scsibus + target + lun) 67 * can be described by a scsi_link struct. 68 * Only scsi positions that actually have devices, have a scsi_link 69 * structure assigned. so in effect each device has scsi_link struct. 70 * The scsi_link structure contains information identifying both the 71 * device driver and the adapter driver for that position on that scsi bus, 72 * and can be said to 'link' the two. 73 * each individual scsi bus has an array that points to all the scsi_link 74 * structs associated with that scsi bus. Slots with no device have 75 * a NULL pointer. 76 * each individual device also knows the address of it's own scsi_link 77 * structure. 78 * 79 * ------------- 80 * 81 * The key to all this is the scsi_link structure which associates all the 82 * other structures with each other in the correct configuration. The 83 * scsi_link is the connecting information that allows each part of the 84 * scsi system to find the associated other parts. 85 */ 86 87 88 /* 89 * These entrypoints are called by the high-end drivers to get services from 90 * whatever low-end drivers they are attached to each adapter type has one of 91 * these statically allocated. 92 */ 93 struct scsi_adapter { 94 /* 4*/ int (*scsi_cmd)(); 95 /* 8*/ void (*scsi_minphys)(); 96 /*12*/ int (*open_target_lu)(); 97 /*16*/ int (*close_target_lu)(); 98 }; 99 100 /* 101 * return values for scsi_cmd() 102 */ 103 #define SUCCESSFULLY_QUEUED 0 104 #define TRY_AGAIN_LATER 1 105 #define COMPLETE 2 106 #define ESCAPE_NOT_SUPPORTED 3 107 108 /* 109 * These entry points are called by the low-end drivers to get services from 110 * whatever high-end drivers they are attached to. Each device type has one 111 * of these statically allocated. 112 */ 113 struct scsi_device { 114 /* 4*/ int (*err_handler)(); /* returns -1 to say err processing complete */ 115 /* 8*/ void (*start)(); 116 /* 12*/ int (*async)(); 117 /* 16*/ int (*done)(); /* returns -1 to say done processing complete */ 118 }; 119 120 /* 121 * This structure describes the connection between an adapter driver and 122 * a device driver, and is used by each to call services provided by 123 * the other, and to allow generic scsi glue code to call these services 124 * as well. 125 */ 126 struct scsi_link { 127 /* 1*/ u_int8_t scsibus; /* the Nth scsibus */ 128 /* 2*/ u_int8_t target; /* targ of this dev */ 129 /* 3*/ u_int8_t lun; /* lun of this dev */ 130 /* 4*/ u_int8_t adapter_target; /* what are we on the scsi bus */ 131 /* 5*/ u_int8_t openings; /* available operations */ 132 /* 6*/ u_int8_t active; /* operations in progress */ 133 /* 7*/ u_int8_t flags; /* flags that all devices have */ 134 #define SDEV_REMOVABLE 0x01 /* media is removable */ 135 #define SDEV_MEDIA_LOADED 0x02 /* device figures are still valid */ 136 #define SDEV_WAITING 0x04 /* a process is waiting for this */ 137 #define SDEV_OPEN 0x08 /* at least 1 open session */ 138 #define SDEV_DBX 0xf0 /* debuging flags (scsi_debug.h) */ 139 /* 8*/ u_int8_t quirks; /* per-device oddities */ 140 #define SDEV_AUTOSAVE 0x01 /* do implicit SAVEDATAPOINTER on disconnect */ 141 #define SDEV_NOSYNCWIDE 0x02 /* does not grok SDTR or WDTR */ 142 #define SDEV_NOLUNS 0x04 /* does not grok LUNs */ 143 /* 12*/ struct scsi_device *device; /* device entry points etc. */ 144 /* 16*/ void *device_softc; /* needed for call to foo_start */ 145 /* 20*/ struct scsi_adapter *adapter; /* adapter entry points etc. */ 146 /* 24*/ void *adapter_softc; /* needed for call to foo_scsi_cmd */ 147 }; 148 149 /* 150 * This describes matching information for scsi_inqmatch(). The more things 151 * match, the higher the configuration priority. 152 */ 153 struct scsi_inquiry_pattern { 154 u_int8_t type; 155 boolean removable; 156 char *vendor; 157 char *product; 158 char *revision; 159 }; 160 161 /* 162 * One of these is allocated and filled in for each scsi bus. 163 * it holds pointers to allow the scsi bus to get to the driver 164 * That is running each LUN on the bus 165 * it also has a template entry which is the prototype struct 166 * supplied by the adapter driver, this is used to initialise 167 * the others, before they have the rest of the fields filled in 168 */ 169 struct scsibus_softc { 170 struct device sc_dev; 171 struct scsi_link *adapter_link; /* prototype supplied by adapter */ 172 struct scsi_link *sc_link[8][8]; 173 u_int8_t moreluns; 174 }; 175 176 /* 177 * This is used to pass information from the high-level configuration code 178 * to the device-specific drivers. 179 */ 180 struct scsibus_attach_args { 181 struct scsi_link *sa_sc_link; 182 struct scsi_inquiry_data *sa_inqbuf; 183 }; 184 185 /* 186 * Each scsi transaction is fully described by one of these structures 187 * It includes information about the source of the command and also the 188 * device and adapter for which the command is destined. 189 * (via the scsi_link structure) 190 */ 191 struct scsi_xfer { 192 /* 4*/ LIST_ENTRY(scsi_xfer) free_list; 193 /*12*/ int flags; 194 /*16*/ struct scsi_link *sc_link; /* all about our device and adapter */ 195 /*20*/ int retries; /* the number of times to retry */ 196 /*24*/ int timeout; /* in milliseconds */ 197 /*28*/ struct scsi_generic *cmd; /* The scsi command to execute */ 198 /*32*/ int cmdlen; /* how long it is */ 199 /*36*/ u_char *data; /* dma address OR a uio address */ 200 /*40*/ int datalen; /* data len (blank if uio) */ 201 /*44*/ int resid; /* how much buffer was not touched */ 202 /*48*/ int error; /* an error value */ 203 /*52*/ struct buf *bp; /* If we need to associate with a buf */ 204 /*84*/ struct scsi_sense_data sense; /* 32 bytes*/ 205 /* 206 * Believe it or not, Some targets fall on the ground with 207 * anything but a certain sense length. 208 */ 209 /*88*/ int req_sense_length; /* Explicit request sense length */ 210 /*92*/ u_int8_t status; /* SCSI status */ 211 /*104*/ struct scsi_generic cmdstore; /* stash the command in here */ 212 }; 213 214 /* 215 * Per-request Flag values 216 */ 217 #define SCSI_NOSLEEP 0x0001 /* don't sleep */ 218 #define SCSI_POLL 0x0002 /* poll for completion */ 219 #define SCSI_AUTOCONF 0x0003 /* shorthand for SCSI_POLL | SCSI_NOSLEEP */ 220 #define SCSI_USER 0x0004 /* Is a user cmd, call scsi_user_done */ 221 #define ITSDONE 0x0008 /* the transfer is as done as it gets */ 222 #define INUSE 0x0010 /* The scsi_xfer block is in use */ 223 #define SCSI_SILENT 0x0020 /* don't announce NOT READY or MEDIA CHANGE */ 224 #define SCSI_IGNORE_NOT_READY 0x0040 /* ignore NOT READY */ 225 #define SCSI_IGNORE_MEDIA_CHANGE 0x0080 /* ignore MEDIA CHANGE */ 226 #define SCSI_IGNORE_ILLEGAL_REQUEST 0x0100 /* ignore ILLEGAL REQUEST */ 227 #define SCSI_RESET 0x0200 /* Reset the device in question */ 228 #define SCSI_DATA_UIO 0x0400 /* The data address refers to a UIO */ 229 #define SCSI_DATA_IN 0x0800 /* expect data to come INTO memory */ 230 #define SCSI_DATA_OUT 0x1000 /* expect data to flow OUT of memory */ 231 #define SCSI_TARGET 0x2000 /* This defines a TARGET mode op. */ 232 #define SCSI_ESCAPE 0x4000 /* Escape operation */ 233 234 /* 235 * Escape op codes. This provides an extensible setup for operations 236 * that are not scsi commands. They are intended for modal operations. 237 */ 238 239 #define SCSI_OP_TARGET 0x0001 240 #define SCSI_OP_RESET 0x0002 241 #define SCSI_OP_BDINFO 0x0003 242 243 /* 244 * Error values an adapter driver may return 245 */ 246 #define XS_NOERROR 0 /* there is no error, (sense is invalid) */ 247 #define XS_SENSE 1 /* Check the returned sense for the error */ 248 #define XS_DRIVER_STUFFUP 2 /* Driver failed to perform operation */ 249 #define XS_SELTIMEOUT 3 /* The device timed out.. turned off? */ 250 #define XS_TIMEOUT 4 /* The Timeout reported was caught by SW */ 251 #define XS_BUSY 5 /* The device busy, try again later? */ 252 253 caddr_t scsi_inqmatch __P((struct scsi_inquiry_data *, caddr_t, int, int, int *)); 254 255 struct scsi_xfer *scsi_get_xs __P((struct scsi_link *, int)); 256 void scsi_free_xs __P((struct scsi_xfer *, int)); 257 int scsi_execute_xs __P((struct scsi_xfer *)); 258 u_long scsi_size __P((struct scsi_link *, int)); 259 int scsi_test_unit_ready __P((struct scsi_link *, int)); 260 int scsi_change_def __P((struct scsi_link *, int)); 261 int scsi_inquire __P((struct scsi_link *, struct scsi_inquiry_data *, int)); 262 int scsi_prevent __P((struct scsi_link *, int, int)); 263 int scsi_start __P((struct scsi_link *, int, int)); 264 void scsi_done __P((struct scsi_xfer *)); 265 int scsi_scsi_cmd __P((struct scsi_link *, struct scsi_generic *, 266 int cmdlen, u_char *data_addr, 267 int datalen, int retries, 268 int timeout, struct buf *bp, 269 int flags)); 270 int scsi_do_ioctl __P((struct scsi_link *, dev_t, u_long, caddr_t, int, struct proc *)); 271 void sc_print_addr __P((struct scsi_link *)); 272 273 void show_scsi_xs __P((struct scsi_xfer *)); 274 void show_scsi_cmd __P((struct scsi_xfer *)); 275 void show_mem __P((u_char *, int)); 276 277 void lto3b __P((u_int32_t val, u_int8_t *bytes)); 278 u_int32_t _3btol __P((u_int8_t *bytes)); 279 280 #endif /* SCSI_SCSICONF_H */ 281