1 /* $NetBSD: scsiconf.h,v 1.32 1996/09/03 18:20:36 thorpej 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 struct buf; 88 struct scsi_xfer; 89 90 /* 91 * These entrypoints are called by the high-end drivers to get services from 92 * whatever low-end drivers they are attached to each adapter type has one of 93 * these statically allocated. 94 */ 95 struct scsi_adapter { 96 int (*scsi_cmd) __P((struct scsi_xfer *)); 97 void (*scsi_minphys) __P((struct buf *)); 98 int (*open_target_lu) __P((void)); 99 int (*close_target_lu) __P((void)); 100 }; 101 102 /* 103 * return values for scsi_cmd() 104 */ 105 #define SUCCESSFULLY_QUEUED 0 106 #define TRY_AGAIN_LATER 1 107 #define COMPLETE 2 108 #define ESCAPE_NOT_SUPPORTED 3 109 110 /* 111 * These entry points are called by the low-end drivers to get services from 112 * whatever high-end drivers they are attached to. Each device type has one 113 * of these statically allocated. 114 */ 115 struct scsi_device { 116 int (*err_handler) __P((struct scsi_xfer *)); 117 /* returns -1 to say err processing done */ 118 void (*start) __P((void *)); 119 120 int (*async) __P((void)); 121 /* 122 * When called with `0' as the second argument, we expect status 123 * back from the upper-level driver. When called with a `1', 124 * we're simply notifying the upper-level driver that the command 125 * is complete and expect no status back. 126 */ 127 int (*done) __P((struct scsi_xfer *, int)); 128 }; 129 130 /* 131 * This structure describes the connection between an adapter driver and 132 * a device driver, and is used by each to call services provided by 133 * the other, and to allow generic scsi glue code to call these services 134 * as well. 135 * 136 * XXX Given the way NetBSD's autoconfiguration works, this is ... 137 * XXX nasty. 138 */ 139 struct scsi_link { 140 int channel; /* channel, i.e. bus # on controller */ 141 142 u_int8_t scsi_version; /* SCSI-I, SCSI-II, etc. */ 143 u_int8_t scsibus; /* the Nth scsibus */ 144 u_int8_t target; /* targ of this dev */ 145 u_int8_t lun; /* lun of this dev */ 146 u_int8_t adapter_target; /* what are we on the scsi bus */ 147 u_int8_t openings; /* available operations */ 148 u_int8_t active; /* operations in progress */ 149 u_int8_t flags; /* flags that all devices have */ 150 #define SDEV_REMOVABLE 0x01 /* media is removable */ 151 #define SDEV_MEDIA_LOADED 0x02 /* device figures are still valid */ 152 #define SDEV_WAITING 0x04 /* a process is waiting for this */ 153 #define SDEV_OPEN 0x08 /* at least 1 open session */ 154 #define SDEV_DBX 0xf0 /* debuging flags (scsi_debug.h) */ 155 u_int8_t quirks; /* per-device oddities */ 156 #define SDEV_AUTOSAVE 0x01 /* do implicit SAVEDATAPOINTER on disconnect */ 157 #define SDEV_NOSYNCWIDE 0x02 /* does not grok SDTR or WDTR */ 158 #define SDEV_NOLUNS 0x04 /* does not grok LUNs */ 159 #define SDEV_FORCELUNS 0x08 /* prehistoric drive/ctlr groks LUNs */ 160 #define SDEV_NOMODESENSE 0x10 /* removable media/optical drives */ 161 struct scsi_device *device; /* device entry points etc. */ 162 void *device_softc; /* needed for call to foo_start */ 163 struct scsi_adapter *adapter; /* adapter entry points etc. */ 164 void *adapter_softc; /* needed for call to foo_scsi_cmd */ 165 }; 166 167 /* 168 * Other definitions used by autoconfiguration. 169 */ 170 #define scsicf_channel cf_loc[0] 171 #define SCSI_CHANNEL_UNKNOWN -1 172 173 #define SCSI_CHANNEL_ONLY_ONE -1 /* only one channel on controller */ 174 175 int scsiprint __P((void *, const char *)); 176 177 /* 178 * This describes matching information for scsi_inqmatch(). The more things 179 * match, the higher the configuration priority. 180 */ 181 struct scsi_inquiry_pattern { 182 u_int8_t type; 183 boolean removable; 184 char *vendor; 185 char *product; 186 char *revision; 187 }; 188 189 /* 190 * One of these is allocated and filled in for each scsi bus. 191 * it holds pointers to allow the scsi bus to get to the driver 192 * That is running each LUN on the bus 193 * it also has a template entry which is the prototype struct 194 * supplied by the adapter driver, this is used to initialise 195 * the others, before they have the rest of the fields filled in 196 */ 197 struct scsibus_softc { 198 struct device sc_dev; 199 struct scsi_link *adapter_link; /* prototype supplied by adapter */ 200 struct scsi_link *sc_link[8][8]; 201 u_int8_t moreluns; 202 }; 203 204 /* 205 * This is used to pass information from the high-level configuration code 206 * to the device-specific drivers. 207 */ 208 struct scsibus_attach_args { 209 struct scsi_link *sa_sc_link; 210 struct scsi_inquiry_data *sa_inqbuf; 211 }; 212 213 /* 214 * Each scsi transaction is fully described by one of these structures 215 * It includes information about the source of the command and also the 216 * device and adapter for which the command is destined. 217 * (via the scsi_link structure) 218 */ 219 struct scsi_xfer { 220 LIST_ENTRY(scsi_xfer) free_list; 221 int flags; 222 struct scsi_link *sc_link; /* all about our device and adapter */ 223 int retries; /* the number of times to retry */ 224 int timeout; /* in milliseconds */ 225 struct scsi_generic *cmd; /* The scsi command to execute */ 226 int cmdlen; /* how long it is */ 227 u_char *data; /* dma address OR a uio address */ 228 int datalen; /* data len (blank if uio) */ 229 int resid; /* how much buffer was not touched */ 230 int error; /* an error value */ 231 struct buf *bp; /* If we need to associate with a buf */ 232 struct scsi_sense_data sense; /* 32 bytes*/ 233 /* 234 * Believe it or not, Some targets fall on the ground with 235 * anything but a certain sense length. 236 */ 237 int req_sense_length; /* Explicit request sense length */ 238 u_int8_t status; /* SCSI status */ 239 struct scsi_generic cmdstore; /* stash the command in here */ 240 }; 241 242 /* 243 * Per-request Flag values 244 */ 245 #define SCSI_NOSLEEP 0x0001 /* don't sleep */ 246 #define SCSI_POLL 0x0002 /* poll for completion */ 247 #define SCSI_AUTOCONF 0x0003 /* shorthand for SCSI_POLL | SCSI_NOSLEEP */ 248 #define SCSI_USER 0x0004 /* Is a user cmd, call scsi_user_done */ 249 #define ITSDONE 0x0008 /* the transfer is as done as it gets */ 250 #define INUSE 0x0010 /* The scsi_xfer block is in use */ 251 #define SCSI_SILENT 0x0020 /* don't announce NOT READY or MEDIA CHANGE */ 252 #define SCSI_IGNORE_NOT_READY 0x0040 /* ignore NOT READY */ 253 #define SCSI_IGNORE_MEDIA_CHANGE 0x0080 /* ignore MEDIA CHANGE */ 254 #define SCSI_IGNORE_ILLEGAL_REQUEST 0x0100 /* ignore ILLEGAL REQUEST */ 255 #define SCSI_RESET 0x0200 /* Reset the device in question */ 256 #define SCSI_DATA_UIO 0x0400 /* The data address refers to a UIO */ 257 #define SCSI_DATA_IN 0x0800 /* expect data to come INTO memory */ 258 #define SCSI_DATA_OUT 0x1000 /* expect data to flow OUT of memory */ 259 #define SCSI_TARGET 0x2000 /* This defines a TARGET mode op. */ 260 #define SCSI_ESCAPE 0x4000 /* Escape operation */ 261 262 /* 263 * Escape op codes. This provides an extensible setup for operations 264 * that are not scsi commands. They are intended for modal operations. 265 */ 266 267 #define SCSI_OP_TARGET 0x0001 268 #define SCSI_OP_RESET 0x0002 269 #define SCSI_OP_BDINFO 0x0003 270 271 /* 272 * Error values an adapter driver may return 273 */ 274 #define XS_NOERROR 0 /* there is no error, (sense is invalid) */ 275 #define XS_SENSE 1 /* Check the returned sense for the error */ 276 #define XS_DRIVER_STUFFUP 2 /* Driver failed to perform operation */ 277 #define XS_SELTIMEOUT 3 /* The device timed out.. turned off? */ 278 #define XS_TIMEOUT 4 /* The Timeout reported was caught by SW */ 279 #define XS_BUSY 5 /* The device busy, try again later? */ 280 281 caddr_t scsi_inqmatch __P((struct scsi_inquiry_data *, caddr_t, int, int, int *)); 282 283 struct scsi_xfer *scsi_get_xs __P((struct scsi_link *, int)); 284 void scsi_free_xs __P((struct scsi_xfer *, int)); 285 int scsi_execute_xs __P((struct scsi_xfer *)); 286 u_long scsi_size __P((struct scsi_link *, int)); 287 int scsi_test_unit_ready __P((struct scsi_link *, int)); 288 int scsi_change_def __P((struct scsi_link *, int)); 289 int scsi_inquire __P((struct scsi_link *, struct scsi_inquiry_data *, int)); 290 int scsi_prevent __P((struct scsi_link *, int, int)); 291 int scsi_start __P((struct scsi_link *, int, int)); 292 void scsi_done __P((struct scsi_xfer *)); 293 void scsi_user_done __P((struct scsi_xfer *)); 294 int scsi_scsi_cmd __P((struct scsi_link *, struct scsi_generic *, 295 int cmdlen, u_char *data_addr, 296 int datalen, int retries, 297 int timeout, struct buf *bp, 298 int flags)); 299 int scsi_do_ioctl __P((struct scsi_link *, dev_t, u_long, caddr_t, int, struct proc *)); 300 void sc_print_addr __P((struct scsi_link *)); 301 302 void show_scsi_xs __P((struct scsi_xfer *)); 303 void show_scsi_cmd __P((struct scsi_xfer *)); 304 void show_mem __P((u_char *, int)); 305 int scsi_probe_busses __P((int, int, int)); 306 void scsi_strvis __P((u_char *, u_char *, int)); 307 308 static __inline void _lto2b __P((u_int32_t val, u_int8_t *bytes)); 309 static __inline void _lto3b __P((u_int32_t val, u_int8_t *bytes)); 310 static __inline void _lto4b __P((u_int32_t val, u_int8_t *bytes)); 311 static __inline u_int32_t _2btol __P((u_int8_t *bytes)); 312 static __inline u_int32_t _3btol __P((u_int8_t *bytes)); 313 static __inline u_int32_t _4btol __P((u_int8_t *bytes)); 314 315 static __inline void _lto2l __P((u_int32_t val, u_int8_t *bytes)); 316 static __inline void _lto3l __P((u_int32_t val, u_int8_t *bytes)); 317 static __inline void _lto4l __P((u_int32_t val, u_int8_t *bytes)); 318 static __inline u_int32_t _2ltol __P((u_int8_t *bytes)); 319 static __inline u_int32_t _3ltol __P((u_int8_t *bytes)); 320 static __inline u_int32_t _4ltol __P((u_int8_t *bytes)); 321 322 static __inline void 323 _lto2b(val, bytes) 324 u_int32_t val; 325 u_int8_t *bytes; 326 { 327 328 bytes[0] = (val >> 8) & 0xff; 329 bytes[1] = val & 0xff; 330 } 331 332 static __inline void 333 _lto3b(val, bytes) 334 u_int32_t val; 335 u_int8_t *bytes; 336 { 337 338 bytes[0] = (val >> 16) & 0xff; 339 bytes[1] = (val >> 8) & 0xff; 340 bytes[2] = val & 0xff; 341 } 342 343 static __inline void 344 _lto4b(val, bytes) 345 u_int32_t val; 346 u_int8_t *bytes; 347 { 348 349 bytes[0] = (val >> 24) & 0xff; 350 bytes[1] = (val >> 16) & 0xff; 351 bytes[2] = (val >> 8) & 0xff; 352 bytes[3] = val & 0xff; 353 } 354 355 static __inline u_int32_t 356 _2btol(bytes) 357 u_int8_t *bytes; 358 { 359 register u_int32_t rv; 360 361 rv = (bytes[0] << 8) | 362 bytes[1]; 363 return (rv); 364 } 365 366 static __inline u_int32_t 367 _3btol(bytes) 368 u_int8_t *bytes; 369 { 370 register u_int32_t rv; 371 372 rv = (bytes[0] << 16) | 373 (bytes[1] << 8) | 374 bytes[2]; 375 return (rv); 376 } 377 378 static __inline u_int32_t 379 _4btol(bytes) 380 u_int8_t *bytes; 381 { 382 register u_int32_t rv; 383 384 rv = (bytes[0] << 24) | 385 (bytes[1] << 16) | 386 (bytes[2] << 8) | 387 bytes[3]; 388 return (rv); 389 } 390 391 static __inline void 392 _lto2l(val, bytes) 393 u_int32_t val; 394 u_int8_t *bytes; 395 { 396 397 bytes[0] = val & 0xff; 398 bytes[1] = (val >> 8) & 0xff; 399 } 400 401 static __inline void 402 _lto3l(val, bytes) 403 u_int32_t val; 404 u_int8_t *bytes; 405 { 406 407 bytes[0] = val & 0xff; 408 bytes[1] = (val >> 8) & 0xff; 409 bytes[2] = (val >> 16) & 0xff; 410 } 411 412 static __inline void 413 _lto4l(val, bytes) 414 u_int32_t val; 415 u_int8_t *bytes; 416 { 417 418 bytes[0] = val & 0xff; 419 bytes[1] = (val >> 8) & 0xff; 420 bytes[2] = (val >> 16) & 0xff; 421 bytes[3] = (val >> 24) & 0xff; 422 } 423 424 static __inline u_int32_t 425 _2ltol(bytes) 426 u_int8_t *bytes; 427 { 428 register u_int32_t rv; 429 430 rv = bytes[0] | 431 (bytes[1] << 8); 432 return (rv); 433 } 434 435 static __inline u_int32_t 436 _3ltol(bytes) 437 u_int8_t *bytes; 438 { 439 register u_int32_t rv; 440 441 rv = bytes[0] | 442 (bytes[1] << 8) | 443 (bytes[2] << 16); 444 return (rv); 445 } 446 447 static __inline u_int32_t 448 _4ltol(bytes) 449 u_int8_t *bytes; 450 { 451 register u_int32_t rv; 452 453 rv = bytes[0] | 454 (bytes[1] << 8) | 455 (bytes[2] << 16) | 456 (bytes[3] << 24); 457 return (rv); 458 } 459 460 #endif /* SCSI_SCSICONF_H */ 461