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