1 /* $NetBSD: scsipiconf.h,v 1.122 2014/07/13 17:12:23 dholland Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 1999, 2000, 2004 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Charles M. Hannum; by Jason R. Thorpe of the Numerical Aerospace 9 * Simulation Facility, NASA Ames Research Center. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 /* 34 * Originally written by Julian Elischer (julian@tfs.com) 35 * for TRW Financial Systems for use under the MACH(2.5) operating system. 36 * 37 * TRW Financial Systems, in accordance with their agreement with Carnegie 38 * Mellon University, makes this software available to CMU to distribute 39 * or use in any manner that they see fit as long as this message is kept with 40 * the software. For this reason TFS also grants any other persons or 41 * organisations permission to use or modify this software. 42 * 43 * TFS supplies this software to be publicly redistributed 44 * on the understanding that TFS is not responsible for the correct 45 * functioning of this software in any circumstances. 46 * 47 * Ported to run under 386BSD by Julian Elischer (julian@tfs.com) Sept 1992 48 */ 49 50 #ifndef _DEV_SCSIPI_SCSIPICONF_H_ 51 #define _DEV_SCSIPI_SCSIPICONF_H_ 52 53 typedef int boolean; 54 55 #include <sys/callout.h> 56 #include <sys/queue.h> 57 #include <dev/scsipi/scsi_spc.h> 58 #include <dev/scsipi/scsipi_debug.h> 59 60 struct buf; 61 struct proc; 62 struct device; 63 struct scsipi_channel; 64 struct scsipi_periph; 65 struct scsipi_xfer; 66 67 /* 68 * The following defines the scsipi_xfer queue. 69 */ 70 TAILQ_HEAD(scsipi_xfer_queue, scsipi_xfer); 71 72 struct scsipi_generic { 73 u_int8_t opcode; 74 u_int8_t bytes[15]; 75 }; 76 77 78 /* 79 * scsipi_async_event_t: 80 * 81 * Asynchronous events from the adapter to the mid-layer and 82 * peripheral. 83 * 84 * Arguments: 85 * 86 * ASYNC_EVENT_MAX_OPENINGS scsipi_max_openings * -- max 87 * openings, device specified in 88 * parameters 89 * 90 * ASYNC_EVENT_XFER_MODE scsipi_xfer_mode * -- xfer mode 91 * parameters changed for I_T Nexus 92 * ASYNC_EVENT_RESET NULL - channel has been reset 93 */ 94 typedef enum { 95 ASYNC_EVENT_MAX_OPENINGS, /* set max openings on periph */ 96 ASYNC_EVENT_XFER_MODE, /* xfer mode update for I_T */ 97 ASYNC_EVENT_RESET /* channel reset */ 98 } scsipi_async_event_t; 99 100 /* 101 * scsipi_max_openings: 102 * 103 * Argument for an ASYNC_EVENT_MAX_OPENINGS event. 104 */ 105 struct scsipi_max_openings { 106 int mo_target; /* openings are for this target... */ 107 int mo_lun; /* ...and this lun */ 108 int mo_openings; /* openings value */ 109 }; 110 111 /* 112 * scsipi_xfer_mode: 113 * 114 * Argument for an ASYNC_EVENT_XFER_MODE event. 115 */ 116 struct scsipi_xfer_mode { 117 int xm_target; /* target, for I_T Nexus */ 118 int xm_mode; /* PERIPH_CAP* bits */ 119 int xm_period; /* sync period */ 120 int xm_offset; /* sync offset */ 121 }; 122 123 124 /* 125 * scsipi_adapter_req_t: 126 * 127 * Requests that can be made of an adapter. 128 * 129 * Arguments: 130 * 131 * ADAPTER_REQ_RUN_XFER scsipi_xfer * -- the xfer which 132 * is to be run 133 * 134 * ADAPTER_REQ_GROW_RESOURCES no argument 135 * 136 * ADAPTER_REQ_SET_XFER_MODE scsipi_xfer_mode * -- set the xfer 137 * mode for the I_T Nexus according to 138 * this 139 */ 140 typedef enum { 141 ADAPTER_REQ_RUN_XFER, /* run a scsipi_xfer */ 142 ADAPTER_REQ_GROW_RESOURCES, /* grow xfer execution resources */ 143 ADAPTER_REQ_SET_XFER_MODE /* set xfer mode */ 144 } scsipi_adapter_req_t; 145 146 #ifdef _KERNEL 147 /* 148 * scsipi_periphsw: 149 * 150 * Callbacks into periph driver from midlayer. 151 * 152 * psw_error Called by the bustype's interpret-sense routine 153 * to do periph-specific sense handling. 154 * 155 * psw_start Called by midlayer to restart a device once 156 * more command openings become available. 157 * 158 * psw_async Called by midlayer when an asynchronous event 159 * from the adapter occurs. 160 * 161 * psw_done Called by the midlayer when an xfer has completed. 162 */ 163 struct scsipi_periphsw { 164 int (*psw_error)(struct scsipi_xfer *); 165 void (*psw_start)(struct scsipi_periph *); 166 int (*psw_async)(struct scsipi_periph *, 167 scsipi_async_event_t, void *); 168 void (*psw_done)(struct scsipi_xfer *, int); 169 }; 170 171 struct disk_parms; 172 struct scsipi_inquiry_pattern; 173 174 /* 175 * scsipi_adapter: 176 * 177 * This structure describes an instance of a SCSIPI adapter. 178 * 179 * Note that `adapt_openings' is used by (the common case of) adapters 180 * which have per-adapter resources. If an adapter's command resources 181 * are associated with a channel, then the `chan_openings' below will 182 * be used instead. 183 * 184 * Note that all adapter entry points take a pointer to a channel, 185 * as an adapter may have more than one channel, and the channel 186 * structure contains the channel number. 187 */ 188 struct scsipi_adapter { 189 device_t adapt_dev; /* pointer to adapter's device */ 190 int adapt_nchannels; /* number of adapter channels */ 191 int adapt_refcnt; /* adapter's reference count */ 192 int adapt_openings; /* total # of command openings */ 193 int adapt_max_periph; /* max openings per periph */ 194 int adapt_flags; 195 196 void (*adapt_request)(struct scsipi_channel *, 197 scsipi_adapter_req_t, void *); 198 void (*adapt_minphys)(struct buf *); 199 int (*adapt_ioctl)(struct scsipi_channel *, u_long, 200 void *, int, struct proc *); 201 int (*adapt_enable)(device_t, int); 202 int (*adapt_getgeom)(struct scsipi_periph *, 203 struct disk_parms *, u_long); 204 int (*adapt_accesschk)(struct scsipi_periph *, 205 struct scsipi_inquiry_pattern *); 206 }; 207 #endif 208 209 /* adapt_flags */ 210 #define SCSIPI_ADAPT_POLL_ONLY 0x01 /* Adaptor can't do interrupts. */ 211 212 #define scsipi_adapter_minphys(chan, bp) \ 213 (*(chan)->chan_adapter->adapt_minphys)((bp)) 214 215 #define scsipi_adapter_request(chan, req, arg) \ 216 (*(chan)->chan_adapter->adapt_request)((chan), (req), (arg)) 217 218 #define scsipi_adapter_ioctl(chan, cmd, data, flag, p) \ 219 (*(chan)->chan_adapter->adapt_ioctl)((chan), (cmd), (data), (flag), (p)) 220 221 #define scsipi_adapter_enable(chan, enable) \ 222 (*(chan)->chan_adapt->adapt_enable)((chan), (enable)) 223 224 225 /* 226 * scsipi_bustype: 227 * 228 * This structure describes a SCSIPI bus type. 229 * The bustype_type member is shared with struct ata_bustype 230 * (because we can ata, atapi or scsi busses to the same controller) 231 */ 232 struct scsipi_bustype { 233 int bustype_type; /* symbolic name of type */ 234 235 void (*bustype_cmd)(struct scsipi_xfer *); 236 int (*bustype_interpret_sense)(struct scsipi_xfer *); 237 void (*bustype_printaddr)(struct scsipi_periph *); 238 void (*bustype_kill_pending)(struct scsipi_periph *); 239 void (*bustype_async_event_xfer_mode)(struct scsipi_channel *, 240 void *); 241 }; 242 243 /* bustype_type */ 244 /* type is stored in the first byte */ 245 #define SCSIPI_BUSTYPE_TYPE_SHIFT 0 246 #define SCSIPI_BUSTYPE_TYPE(x) (((x) >> SCSIPI_BUSTYPE_TYPE_SHIFT) & 0xff) 247 #define SCSIPI_BUSTYPE_SCSI 0 /* parallel SCSI */ 248 #define SCSIPI_BUSTYPE_ATAPI 1 249 /* #define SCSIPI_BUSTYPE_ATA 2 */ 250 /* subtype is stored in the second byte */ 251 #define SCSIPI_BUSTYPE_SUBTYPE_SHIFT 8 252 #define SCSIPI_BUSTYPE_SUBTYPE(x) (((x) >> SCSIPI_BUSTYPE_SUBTYPE_SHIFT) & 0xff) 253 254 #define SCSIPI_BUSTYPE_BUSTYPE(t, s) \ 255 ((t) << SCSIPI_BUSTYPE_TYPE_SHIFT | (s) << SCSIPI_BUSTYPE_SUBTYPE_SHIFT) 256 /* subtypes are defined in each bus type headers */ 257 258 /* 259 * scsipi_channel: 260 * 261 * This structure describes a single channel of a SCSIPI adapter. 262 * An adapter may have one or more channels. See the comment above 263 * regarding the resource counter. 264 * Note: chan_bustype has to be first member, as its bustype_type member 265 * is shared with the aa_bustype member of struct ata_atapi_attach. 266 */ 267 268 #define SCSIPI_CHAN_PERIPH_BUCKETS 16 269 #define SCSIPI_CHAN_PERIPH_HASHMASK (SCSIPI_CHAN_PERIPH_BUCKETS - 1) 270 271 #ifdef _KERNEL 272 struct scsipi_channel { 273 const struct scsipi_bustype *chan_bustype; /* channel's bus type */ 274 const char *chan_name; /* this channel's name */ 275 276 struct scsipi_adapter *chan_adapter; /* pointer to our adapter */ 277 278 /* Periphs for this channel. */ 279 LIST_HEAD(, scsipi_periph) chan_periphtab[SCSIPI_CHAN_PERIPH_BUCKETS]; 280 281 int chan_channel; /* channel number */ 282 int chan_flags; /* channel flags */ 283 int chan_openings; /* number of command openings */ 284 int chan_max_periph; /* max openings per periph */ 285 286 int chan_ntargets; /* number of targets */ 287 int chan_nluns; /* number of luns */ 288 int chan_id; /* adapter's ID for this channel */ 289 290 int chan_defquirks; /* default device's quirks */ 291 292 struct lwp *chan_thread; /* completion thread */ 293 int chan_tflags; /* flags for the completion thread */ 294 295 int chan_qfreeze; /* freeze count for queue */ 296 297 /* Job queue for this channel. */ 298 struct scsipi_xfer_queue chan_queue; 299 300 /* Completed (async) jobs. */ 301 struct scsipi_xfer_queue chan_complete; 302 303 /* callback we may have to call from completion thread */ 304 void (*chan_callback)(struct scsipi_channel *, void *); 305 void *chan_callback_arg; 306 307 /* callback we may have to call after forking the kthread */ 308 void (*chan_init_cb)(struct scsipi_channel *, void *); 309 void *chan_init_cb_arg; 310 }; 311 #endif 312 313 /* chan_flags */ 314 #define SCSIPI_CHAN_OPENINGS 0x01 /* use chan_openings */ 315 #define SCSIPI_CHAN_CANGROW 0x02 /* channel can grow resources */ 316 #define SCSIPI_CHAN_NOSETTLE 0x04 /* don't wait for devices to settle */ 317 #define SCSIPI_CHAN_TACTIVE 0x08 /* completion thread is active */ 318 319 /* chan thread flags (chan_tflags) */ 320 #define SCSIPI_CHANT_SHUTDOWN 0x01 /* channel is shutting down */ 321 #define SCSIPI_CHANT_CALLBACK 0x02 /* has to call chan_callback() */ 322 #define SCSIPI_CHANT_KICK 0x04 /* need to run queues */ 323 #define SCSIPI_CHANT_GROWRES 0x08 /* call ADAPTER_REQ_GROW_RESOURCES */ 324 325 #define SCSIPI_CHAN_MAX_PERIPH(chan) \ 326 (((chan)->chan_flags & SCSIPI_CHAN_OPENINGS) ? \ 327 (chan)->chan_max_periph : (chan)->chan_adapter->adapt_max_periph) 328 329 330 #define scsipi_printaddr(periph) \ 331 (*(periph)->periph_channel->chan_bustype->bustype_printaddr)((periph)) 332 333 #define scsipi_periph_bustype(periph) \ 334 (periph)->periph_channel->chan_bustype->bustype_type 335 336 337 /* 338 * Number of tag words in a periph structure: 339 * 340 * n_tag_words = ((256 / NBBY) / sizeof(u_int32_t)) 341 */ 342 #define PERIPH_NTAGWORDS ((256 / 8) / sizeof(u_int32_t)) 343 344 345 #ifdef _KERNEL 346 /* 347 * scsipi_periph: 348 * 349 * This structure describes the path between a peripheral device 350 * and an adapter. It contains a pointer to the adapter channel 351 * which in turn contains a pointer to the adapter. 352 * 353 * XXX Given the way NetBSD's autoconfiguration works, this is ... 354 * XXX nasty. 355 * 356 * Well, it's a lot nicer than it used to be, but there could 357 * still be an improvement. 358 */ 359 struct scsipi_periph { 360 device_t periph_dev; /* pointer to peripheral's device */ 361 struct scsipi_channel *periph_channel; /* channel we're connected to */ 362 363 /* link in channel's table of periphs */ 364 LIST_ENTRY(scsipi_periph) periph_hash; 365 366 const struct scsipi_periphsw *periph_switch; /* peripheral's entry 367 points */ 368 int periph_openings; /* max # of outstanding commands */ 369 int periph_active; /* current # of outstanding commands */ 370 int periph_sent; /* current # of commands sent to adapt*/ 371 372 int periph_mode; /* operation modes, CAP bits */ 373 int periph_period; /* sync period (factor) */ 374 int periph_offset; /* sync offset */ 375 376 /* 377 * Information gleaned from the inquiry data. 378 */ 379 u_int8_t periph_type; /* basic device type */ 380 int periph_cap; /* capabilities */ 381 int periph_quirks; /* device's quirks */ 382 383 int periph_flags; /* misc. flags */ 384 int periph_dbflags; /* debugging flags */ 385 386 int periph_target; /* target ID (drive # on ATAPI) */ 387 int periph_lun; /* LUN (not used on ATAPI) */ 388 389 int periph_version; /* ANSI SCSI version */ 390 391 int periph_qfreeze; /* queue freeze count */ 392 393 /* Bitmap of free command tags. */ 394 u_int32_t periph_freetags[PERIPH_NTAGWORDS]; 395 396 /* Pending scsipi_xfers on this peripheral. */ 397 struct scsipi_xfer_queue periph_xferq; 398 399 callout_t periph_callout; 400 401 /* xfer which has a pending CHECK_CONDITION */ 402 struct scsipi_xfer *periph_xscheck; 403 404 }; 405 #endif 406 407 /* 408 * Macro to return the current xfer mode of a periph. 409 */ 410 #define PERIPH_XFER_MODE(periph) \ 411 (((periph)->periph_flags & PERIPH_MODE_VALID) ? \ 412 (periph)->periph_mode : 0) 413 414 /* periph_cap */ 415 #define PERIPH_CAP_ANEC 0x0001 /* async event notification */ 416 #define PERIPH_CAP_TERMIOP 0x0002 /* terminate i/o proc. messages */ 417 #define PERIPH_CAP_RELADR 0x0004 /* relative addressing */ 418 #define PERIPH_CAP_WIDE32 0x0008 /* wide-32 transfers */ 419 #define PERIPH_CAP_WIDE16 0x0010 /* wide-16 transfers */ 420 /* XXX 0x0020 reserved for ATAPI_CFG_DRQ_MASK */ 421 /* XXX 0x0040 reserved for ATAPI_CFG_DRQ_MASK */ 422 #define PERIPH_CAP_SYNC 0x0080 /* synchronous transfers */ 423 #define PERIPH_CAP_LINKCMDS 0x0100 /* linked commands */ 424 #define PERIPH_CAP_TQING 0x0200 /* tagged queueing */ 425 #define PERIPH_CAP_SFTRESET 0x0400 /* soft RESET condition response */ 426 #define PERIPH_CAP_CMD16 0x0800 /* 16 byte commands (ATAPI) */ 427 #define PERIPH_CAP_DT 0x1000 /* supports DT clock */ 428 #define PERIPH_CAP_QAS 0x2000 /* supports quick arbit. and select. */ 429 #define PERIPH_CAP_IUS 0x4000 /* supports information unit xfers */ 430 431 /* periph_flags */ 432 #define PERIPH_REMOVABLE 0x0001 /* media is removable */ 433 #define PERIPH_MEDIA_LOADED 0x0002 /* media is loaded */ 434 #define PERIPH_WAITING 0x0004 /* process waiting for opening */ 435 #define PERIPH_OPEN 0x0008 /* device is open */ 436 #define PERIPH_WAITDRAIN 0x0010 /* waiting for pending xfers to drain */ 437 #define PERIPH_GROW_OPENINGS 0x0020 /* allow openings to grow */ 438 #define PERIPH_MODE_VALID 0x0040 /* periph_mode is valid */ 439 #define PERIPH_RECOVERING 0x0080 /* periph is recovering */ 440 #define PERIPH_RECOVERY_ACTIVE 0x0100 /* a recovery command is active */ 441 #define PERIPH_KEEP_LABEL 0x0200 /* retain label after 'full' close */ 442 #define PERIPH_SENSE 0x0400 /* periph has sense pending */ 443 #define PERIPH_UNTAG 0x0800 /* untagged command running */ 444 445 /* periph_quirks */ 446 #define PQUIRK_AUTOSAVE 0x00000001 /* do implicit SAVE POINTERS */ 447 #define PQUIRK_NOSYNC 0x00000002 /* does not grok SDTR */ 448 #define PQUIRK_NOWIDE 0x00000004 /* does not grok WDTR */ 449 #define PQUIRK_NOTAG 0x00000008 /* does not grok tagged cmds */ 450 #define PQUIRK_NOLUNS 0x00000010 /* DTWT with LUNs */ 451 #define PQUIRK_FORCELUNS 0x00000020 /* prehistoric device groks 452 LUNs */ 453 #define PQUIRK_NOMODESENSE 0x00000040 /* device doesn't do MODE SENSE 454 properly */ 455 #define PQUIRK_NOSYNCCACHE 0x00000100 /* do not issue SYNC CACHE */ 456 #define PQUIRK_LITTLETOC 0x00000400 /* audio TOC is little-endian */ 457 #define PQUIRK_NOCAPACITY 0x00000800 /* no READ CD CAPACITY */ 458 #define PQUIRK_NOTUR 0x00001000 /* no TEST UNIT READY */ 459 #define PQUIRK_NODOORLOCK 0x00002000 /* can't lock door */ 460 #define PQUIRK_NOSENSE 0x00004000 /* can't REQUEST SENSE */ 461 #define PQUIRK_ONLYBIG 0x00008000 /* only use SCSI_{R,W}_BIG */ 462 #define PQUIRK_NOBIGMODESENSE 0x00040000 /* has no big mode-sense op */ 463 #define PQUIRK_CAP_SYNC 0x00080000 /* SCSI device with ST sync op*/ 464 #define PQUIRK_CAP_WIDE16 0x00100000 /* SCSI device with ST wide op*/ 465 #define PQUIRK_CAP_NODT 0x00200000 /* signals DT, but can't. */ 466 #define PQUIRK_START 0x00400000 /* needs start before tur */ 467 468 469 /* 470 * Error values an adapter driver may return 471 */ 472 typedef enum { 473 XS_NOERROR, /* there is no error, (sense is invalid) */ 474 XS_SENSE, /* Check the returned sense for the error */ 475 XS_SHORTSENSE, /* Check the ATAPI sense for the error */ 476 XS_DRIVER_STUFFUP, /* Driver failed to perform operation */ 477 XS_RESOURCE_SHORTAGE, /* adapter resource shortage */ 478 XS_SELTIMEOUT, /* The device timed out.. turned off? */ 479 XS_TIMEOUT, /* The Timeout reported was caught by SW */ 480 XS_BUSY, /* The device busy, try again later? */ 481 XS_RESET, /* bus was reset; possible retry command */ 482 XS_REQUEUE /* requeue this command */ 483 } scsipi_xfer_result_t; 484 485 /* 486 * Each scsipi transaction is fully described by one of these structures 487 * It includes information about the source of the command and also the 488 * device and adapter for which the command is destined. 489 * 490 * Before the HBA is given this transaction, channel_q is the linkage on 491 * the related channel's chan_queue. 492 * 493 * When the this transaction is taken off the channel's chan_queue and 494 * the HBA's request entry point is called with this transaction, the 495 * HBA can use the channel_q tag for whatever it likes until it calls 496 * scsipi_done for this transaction, at which time it has to stop 497 * using channel_q. 498 * 499 * After scsipi_done is called with this transaction and if there was an 500 * error on it, channel_q then becomes the linkage on the related channel's 501 * chan_complete cqueue. 502 * 503 * The device_q member is maintained by the scsipi middle layer. When 504 * a device issues a command, the xfer is placed on that device's 505 * pending commands queue. When an xfer is done and freed, it is taken 506 * off the device's queue. This allows for a device to wait for all of 507 * its pending commands to complete. 508 */ 509 struct scsipi_xfer { 510 TAILQ_ENTRY(scsipi_xfer) channel_q; /* entry on channel queue */ 511 TAILQ_ENTRY(scsipi_xfer) device_q; /* device's pending xfers */ 512 callout_t xs_callout; /* callout for adapter use */ 513 int xs_control; /* control flags */ 514 volatile int xs_status; /* status flags */ 515 struct scsipi_periph *xs_periph;/* peripheral doing the xfer */ 516 int xs_retries; /* the number of times to retry */ 517 int xs_requeuecnt; /* number of requeues */ 518 int timeout; /* in milliseconds */ 519 struct scsipi_generic *cmd; /* The scsipi command to execute */ 520 int cmdlen; /* how long it is */ 521 u_char *data; /* DMA address OR a uio address */ 522 int datalen; /* data len (blank if uio) */ 523 int resid; /* how much buffer was not touched */ 524 scsipi_xfer_result_t error; /* an error value */ 525 struct buf *bp; /* If we need to associate with */ 526 /* a buf */ 527 union { 528 struct scsi_sense_data scsi_sense; /* 32 bytes */ 529 u_int32_t atapi_sense; 530 } sense; 531 532 struct scsipi_xfer *xs_sensefor;/* we are requesting sense for this */ 533 /* xfer */ 534 535 u_int8_t status; /* SCSI status */ 536 537 /* 538 * Info for tagged command queueing. This may or may not 539 * be used by a given adapter driver. These are the same 540 * as the bytes in the tag message. 541 */ 542 u_int8_t xs_tag_type; /* tag type */ 543 u_int8_t xs_tag_id; /* tag ID */ 544 545 struct scsipi_generic cmdstore 546 __aligned(4); /* stash the command in here */ 547 }; 548 549 /* 550 * scsipi_xfer control flags 551 * 552 * To do: 553 * 554 * - figure out what to do with XS_CTL_ESCAPE 555 * 556 * - replace XS_CTL_URGENT with an `xs_priority' field? 557 */ 558 #define XS_CTL_NOSLEEP 0x00000001 /* don't sleep */ 559 #define XS_CTL_POLL 0x00000002 /* poll for completion */ 560 #define XS_CTL_DISCOVERY 0x00000004 /* doing device discovery */ 561 #define XS_CTL_ASYNC 0x00000008 /* command completes 562 asynchronously */ 563 #define XS_CTL_USERCMD 0x00000010 /* user issued command */ 564 #define XS_CTL_SILENT 0x00000020 /* don't print sense info */ 565 #define XS_CTL_IGNORE_NOT_READY 0x00000040 /* ignore NOT READY */ 566 #define XS_CTL_IGNORE_MEDIA_CHANGE \ 567 0x00000080 /* ignore media change */ 568 #define XS_CTL_IGNORE_ILLEGAL_REQUEST \ 569 0x00000100 /* ignore ILLEGAL REQUEST */ 570 #define XS_CTL_SILENT_NODEV 0x00000200 /* don't print sense info 571 if sense info is nodev */ 572 #define XS_CTL_RESET 0x00000400 /* reset the device */ 573 #define XS_CTL_DATA_UIO 0x00000800 /* xs_data points to uio */ 574 #define XS_CTL_DATA_IN 0x00001000 /* data coming into memory */ 575 #define XS_CTL_DATA_OUT 0x00002000 /* data going out of memory */ 576 #define XS_CTL_TARGET 0x00004000 /* target mode operation */ 577 #define XS_CTL_ESCAPE 0x00008000 /* escape operation */ 578 #define XS_CTL_URGENT 0x00010000 /* urgent (recovery) 579 operation */ 580 #define XS_CTL_SIMPLE_TAG 0x00020000 /* use a Simple Tag */ 581 #define XS_CTL_ORDERED_TAG 0x00040000 /* use an Ordered Tag */ 582 #define XS_CTL_HEAD_TAG 0x00080000 /* use a Head of Queue Tag */ 583 #define XS_CTL_THAW_PERIPH 0x00100000 /* thaw periph once enqueued */ 584 #define XS_CTL_FREEZE_PERIPH 0x00200000 /* freeze periph when done */ 585 #define XS_CTL_REQSENSE 0x00800000 /* xfer is a request sense */ 586 587 #define XS_CTL_TAGMASK (XS_CTL_SIMPLE_TAG|XS_CTL_ORDERED_TAG|XS_CTL_HEAD_TAG) 588 589 #define XS_CTL_TAGTYPE(xs) ((xs)->xs_control & XS_CTL_TAGMASK) 590 591 /* 592 * scsipi_xfer status flags 593 */ 594 #define XS_STS_DONE 0x00000001 /* scsipi_xfer is done */ 595 #define XS_STS_PRIVATE 0xf0000000 /* reserved for HBA's use */ 596 597 /* 598 * This describes matching information for scsipi_inqmatch(). The more things 599 * match, the higher the configuration priority. 600 */ 601 struct scsipi_inquiry_pattern { 602 u_int8_t type; 603 boolean removable; 604 const char *vendor; 605 const char *product; 606 const char *revision; 607 }; 608 609 /* 610 * This is used to pass information from the high-level configuration code 611 * to the device-specific drivers. 612 */ 613 struct scsipibus_attach_args { 614 struct scsipi_periph *sa_periph; 615 struct scsipi_inquiry_pattern sa_inqbuf; 616 struct scsipi_inquiry_data *sa_inqptr; 617 union { /* bus-type specific infos */ 618 u_int8_t scsi_version; /* SCSI version */ 619 } scsipi_info; 620 }; 621 622 /* 623 * this describes a quirk entry 624 */ 625 struct scsi_quirk_inquiry_pattern { 626 struct scsipi_inquiry_pattern pattern; 627 int quirks; 628 }; 629 630 /* 631 * Default number of retries, used for generic routines. 632 */ 633 #define SCSIPIRETRIES 4 634 635 636 #ifdef _KERNEL 637 void scsipi_init(void); 638 void scsipi_load_verbose(void); 639 int scsipi_command(struct scsipi_periph *, struct scsipi_generic *, int, 640 u_char *, int, int, int, struct buf *, int); 641 void scsipi_create_completion_thread(void *); 642 const void *scsipi_inqmatch(struct scsipi_inquiry_pattern *, const void *, 643 size_t, size_t, int *); 644 const char *scsipi_dtype(int); 645 void scsipi_strvis(u_char *, int, const u_char *, int); 646 int scsipi_execute_xs(struct scsipi_xfer *); 647 int scsipi_test_unit_ready(struct scsipi_periph *, int); 648 int scsipi_prevent(struct scsipi_periph *, int, int); 649 int scsipi_inquire(struct scsipi_periph *, 650 struct scsipi_inquiry_data *, int); 651 int scsipi_mode_select(struct scsipi_periph *, int, 652 struct scsi_mode_parameter_header_6 *, int, int, int, int); 653 int scsipi_mode_select_big(struct scsipi_periph *, int, 654 struct scsi_mode_parameter_header_10 *, int, int, int, int); 655 int scsipi_mode_sense(struct scsipi_periph *, int, int, 656 struct scsi_mode_parameter_header_6 *, int, int, int, int); 657 int scsipi_mode_sense_big(struct scsipi_periph *, int, int, 658 struct scsi_mode_parameter_header_10 *, int, int, int, int); 659 int scsipi_start(struct scsipi_periph *, int, int); 660 void scsipi_done(struct scsipi_xfer *); 661 void scsipi_user_done(struct scsipi_xfer *); 662 int scsipi_interpret_sense(struct scsipi_xfer *); 663 void scsipi_wait_drain(struct scsipi_periph *); 664 void scsipi_kill_pending(struct scsipi_periph *); 665 struct scsipi_periph *scsipi_alloc_periph(int); 666 667 /* Function pointers for scsiverbose module */ 668 extern int (*scsipi_print_sense)(struct scsipi_xfer *, int); 669 extern void (*scsipi_print_sense_data)(struct scsi_sense_data *, int); 670 671 int scsipi_print_sense_stub(struct scsipi_xfer *, int); 672 void scsipi_print_sense_data_stub(struct scsi_sense_data *, int); 673 674 extern int scsi_verbose_loaded; 675 676 void scsipi_print_cdb(struct scsipi_generic *cmd); 677 int scsipi_thread_call_callback(struct scsipi_channel *, 678 void (*callback)(struct scsipi_channel *, void *), 679 void *); 680 void scsipi_async_event(struct scsipi_channel *, 681 scsipi_async_event_t, void *); 682 int scsipi_do_ioctl(struct scsipi_periph *, dev_t, u_long, void *, 683 int, struct lwp *); 684 685 void scsipi_set_xfer_mode(struct scsipi_channel *, int, int); 686 687 int scsipi_channel_init(struct scsipi_channel *); 688 void scsipi_channel_shutdown(struct scsipi_channel *); 689 690 void scsipi_insert_periph(struct scsipi_channel *, 691 struct scsipi_periph *); 692 void scsipi_remove_periph(struct scsipi_channel *, 693 struct scsipi_periph *); 694 struct scsipi_periph *scsipi_lookup_periph(struct scsipi_channel *, 695 int, int); 696 int scsipi_target_detach(struct scsipi_channel *, int, int, int); 697 698 int scsipi_adapter_addref(struct scsipi_adapter *); 699 void scsipi_adapter_delref(struct scsipi_adapter *); 700 701 void scsipi_channel_freeze(struct scsipi_channel *, int); 702 void scsipi_channel_thaw(struct scsipi_channel *, int); 703 void scsipi_channel_timed_thaw(void *); 704 705 void scsipi_periph_freeze(struct scsipi_periph *, int); 706 void scsipi_periph_thaw(struct scsipi_periph *, int); 707 void scsipi_periph_timed_thaw(void *); 708 709 int scsipi_sync_period_to_factor(int); 710 int scsipi_sync_factor_to_period(int); 711 int scsipi_sync_factor_to_freq(int); 712 713 void show_scsipi_xs(struct scsipi_xfer *); 714 void show_scsipi_cmd(struct scsipi_xfer *); 715 void show_mem(u_char *, int); 716 #endif /* _KERNEL */ 717 718 static __inline void 719 _lto2b(u_int32_t val, u_int8_t *bytes) 720 { 721 722 bytes[0] = (val >> 8) & 0xff; 723 bytes[1] = val & 0xff; 724 } 725 726 static __inline void 727 _lto3b(u_int32_t val, u_int8_t *bytes) 728 { 729 730 bytes[0] = (val >> 16) & 0xff; 731 bytes[1] = (val >> 8) & 0xff; 732 bytes[2] = val & 0xff; 733 } 734 735 static __inline void 736 _lto4b(u_int32_t val, u_int8_t *bytes) 737 { 738 739 bytes[0] = (val >> 24) & 0xff; 740 bytes[1] = (val >> 16) & 0xff; 741 bytes[2] = (val >> 8) & 0xff; 742 bytes[3] = val & 0xff; 743 } 744 745 static __inline void 746 _lto8b(u_int64_t val, u_int8_t *bytes) 747 { 748 749 bytes[0] = (val >> 56) & 0xff; 750 bytes[1] = (val >> 48) & 0xff; 751 bytes[2] = (val >> 40) & 0xff; 752 bytes[3] = (val >> 32) & 0xff; 753 bytes[4] = (val >> 24) & 0xff; 754 bytes[5] = (val >> 16) & 0xff; 755 bytes[6] = (val >> 8) & 0xff; 756 bytes[7] = val & 0xff; 757 } 758 759 static __inline u_int32_t 760 _2btol(const u_int8_t *bytes) 761 { 762 u_int32_t rv; 763 764 rv = (bytes[0] << 8) | 765 bytes[1]; 766 return (rv); 767 } 768 769 static __inline u_int32_t 770 _3btol(const u_int8_t *bytes) 771 { 772 u_int32_t rv; 773 774 rv = (bytes[0] << 16) | 775 (bytes[1] << 8) | 776 bytes[2]; 777 return (rv); 778 } 779 780 static __inline u_int32_t 781 _4btol(const u_int8_t *bytes) 782 { 783 u_int32_t rv; 784 785 rv = (bytes[0] << 24) | 786 (bytes[1] << 16) | 787 (bytes[2] << 8) | 788 bytes[3]; 789 return (rv); 790 } 791 792 static __inline u_int64_t 793 _5btol(const u_int8_t *bytes) 794 { 795 u_int64_t rv; 796 797 rv = ((u_int64_t)bytes[0] << 32) | 798 ((u_int64_t)bytes[1] << 24) | 799 ((u_int64_t)bytes[2] << 16) | 800 ((u_int64_t)bytes[3] << 8) | 801 (u_int64_t)bytes[4]; 802 return (rv); 803 } 804 805 static __inline u_int64_t 806 _8btol(const u_int8_t *bytes) 807 { 808 u_int64_t rv; 809 810 rv = ((u_int64_t)bytes[0] << 56) | 811 ((u_int64_t)bytes[1] << 48) | 812 ((u_int64_t)bytes[2] << 40) | 813 ((u_int64_t)bytes[3] << 32) | 814 ((u_int64_t)bytes[4] << 24) | 815 ((u_int64_t)bytes[5] << 16) | 816 ((u_int64_t)bytes[6] << 8) | 817 (u_int64_t)bytes[7]; 818 return (rv); 819 } 820 821 static __inline void 822 _lto2l(u_int32_t val, u_int8_t *bytes) 823 { 824 825 bytes[0] = val & 0xff; 826 bytes[1] = (val >> 8) & 0xff; 827 } 828 829 static __inline void 830 _lto3l(u_int32_t val, u_int8_t *bytes) 831 { 832 833 bytes[0] = val & 0xff; 834 bytes[1] = (val >> 8) & 0xff; 835 bytes[2] = (val >> 16) & 0xff; 836 } 837 838 static __inline void 839 _lto4l(u_int32_t val, u_int8_t *bytes) 840 { 841 842 bytes[0] = val & 0xff; 843 bytes[1] = (val >> 8) & 0xff; 844 bytes[2] = (val >> 16) & 0xff; 845 bytes[3] = (val >> 24) & 0xff; 846 } 847 848 static __inline u_int32_t 849 _2ltol(const u_int8_t *bytes) 850 { 851 u_int32_t rv; 852 853 rv = bytes[0] | 854 (bytes[1] << 8); 855 return (rv); 856 } 857 858 static __inline u_int32_t 859 _3ltol(const u_int8_t *bytes) 860 { 861 u_int32_t rv; 862 863 rv = bytes[0] | 864 (bytes[1] << 8) | 865 (bytes[2] << 16); 866 return (rv); 867 } 868 869 static __inline u_int32_t 870 _4ltol(const u_int8_t *bytes) 871 { 872 u_int32_t rv; 873 874 rv = bytes[0] | 875 (bytes[1] << 8) | 876 (bytes[2] << 16) | 877 (bytes[3] << 24); 878 return (rv); 879 } 880 881 #endif /* _DEV_SCSIPI_SCSIPICONF_H_ */ 882