1 /* $NetBSD: scsipiconf.h,v 1.59 2001/09/21 13:54:47 fvdl Exp $ */ 2 3 /*- 4 * Copyright (c) 1998, 1999, 2000 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) __P((struct scsipi_xfer *)); 171 void (*psw_start) __P((struct scsipi_periph *)); 172 int (*psw_async) __P((struct scsipi_periph *, 173 scsipi_async_event_t, void *)); 174 void (*psw_done) __P((struct scsipi_xfer *)); 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, the 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; /* numnber 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) __P((struct scsipi_channel *, 203 scsipi_adapter_req_t, void *)); 204 void (*adapt_minphys) __P((struct buf *)); 205 int (*adapt_ioctl) __P((struct scsipi_channel *, u_long, 206 caddr_t, int, struct proc *)); 207 int (*adapt_enable) __P((struct device *, int)); 208 int (*adapt_getgeom) __P((struct scsipi_periph *, 209 struct disk_parms *, u_long)); 210 int (*adapt_accesschk) __P((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 */ 235 struct scsipi_bustype { 236 int bustype_type; /* symbolic name of type */ 237 238 int (*bustype_cmd) __P((struct scsipi_periph *, 239 struct scsipi_generic *, int, void *, size_t, int, 240 int, struct buf *, int)); 241 int (*bustype_interpret_sense) __P((struct scsipi_xfer *)); 242 void (*bustype_printaddr) __P((struct scsipi_periph *)); 243 void (*bustype_kill_pending) __P((struct scsipi_periph *)); 244 }; 245 246 /* bustype_type */ 247 #define SCSIPI_BUSTYPE_SCSI 0 248 #define SCSIPI_BUSTYPE_ATAPI 1 249 250 251 /* 252 * scsipi_channel: 253 * 254 * This structure describes a single channel of a SCSIPI adapter. 255 * An adapter may have one or more channels. See the comment above 256 * regarding the resource counter. 257 */ 258 struct scsipi_channel { 259 u_int8_t type; /* XXX will die, compat with ata_atapi_attach for umass */ 260 #define BUS_SCSI 0 261 #define BUS_ATAPI 1 262 /*define BUS_ATA 2*/ 263 264 struct scsipi_adapter *chan_adapter; /* pointer to our adapter */ 265 266 const struct scsipi_bustype *chan_bustype; /* channel's bus type */ 267 268 /* 269 * Periphs for this channel. 2-dimensional array is dynamically 270 * allocated. 271 * 272 * XXX Consider a different data structure to save space. 273 */ 274 struct scsipi_periph ***chan_periphs; 275 276 int chan_channel; /* channel number */ 277 int chan_flags; /* channel flags */ 278 int chan_openings; /* number of command openings */ 279 int chan_max_periph; /* max openings per periph */ 280 281 int chan_ntargets; /* number of targets */ 282 int chan_nluns; /* number of luns */ 283 int chan_id; /* adapter's ID for this channel */ 284 285 int chan_defquirks; /* default device's quirks */ 286 287 struct proc *chan_thread; /* completion thread */ 288 289 int chan_qfreeze; /* freeze count for queue */ 290 291 /* Job queue for this channel. */ 292 struct scsipi_xfer_queue chan_queue; 293 294 /* Completed (async) jobs. */ 295 struct scsipi_xfer_queue chan_complete; 296 297 /* callback we may have to call from completion thread */ 298 void (*chan_callback) __P((struct scsipi_channel *, void *)); 299 void *chan_callback_arg; 300 }; 301 302 /* chan_flags */ 303 #define SCSIPI_CHAN_SHUTDOWN 0x01 /* channel is shutting down */ 304 #define SCSIPI_CHAN_OPENINGS 0x02 /* use chan_openings */ 305 #define SCSIPI_CHAN_CANGROW 0x04 /* channel can grow resources */ 306 #define SCSIPI_CHAN_NOSETTLE 0x08 /* don't wait for devices to settle */ 307 #define SCSIPI_CHAN_CALLBACK 0x10 /* has to call chan_callback() */ 308 309 #define SCSIPI_CHAN_MAX_PERIPH(chan) \ 310 (((chan)->chan_flags & SCSIPI_CHAN_OPENINGS) ? \ 311 (chan)->chan_max_periph : (chan)->chan_adapter->adapt_max_periph) 312 313 314 #define scsipi_printaddr(periph) \ 315 (*(periph)->periph_channel->chan_bustype->bustype_printaddr)((periph)) 316 317 #define scsipi_periph_bustype(periph) \ 318 (periph)->periph_channel->chan_bustype->bustype_type 319 320 321 /* 322 * Number of tag words in a periph structure: 323 * 324 * n_tag_words = ((256 / NBBY) / sizeof(u_int32_t)) 325 */ 326 #define PERIPH_NTAGWORDS ((256 / 8) / sizeof(u_int32_t)) 327 328 329 /* 330 * scsipi_periph: 331 * 332 * This structure describes the path between a peripherial device 333 * and an adapter. It contains a pointer to the adapter channel 334 * which in turn contains a pointer to the adapter. 335 * 336 * XXX Given the way NetBSD's autoconfiguration works, this is ... 337 * XXX nasty. 338 * 339 * Well, it's a lot nicer than it used to be, but there could 340 * still be an improvement. 341 */ 342 struct scsipi_periph { 343 struct device *periph_dev; /* pointer to peripherial's device */ 344 struct scsipi_channel *periph_channel; /* channel we're connected to */ 345 346 const struct scsipi_periphsw *periph_switch; /* peripherial's entry 347 points */ 348 int periph_openings; /* max # of outstanding commands */ 349 int periph_active; /* current # of outstanding commands */ 350 int periph_sent; /* current # of commands sent to adapt*/ 351 352 int periph_mode; /* operation modes, CAP bits */ 353 int periph_period; /* sync period (factor) */ 354 int periph_offset; /* sync offset */ 355 356 /* 357 * Information gleaned from the inquiry data. 358 */ 359 u_int8_t periph_type; /* basic device type */ 360 int periph_cap; /* capabilities */ 361 int periph_quirks; /* device's quirks */ 362 363 int periph_flags; /* misc. flags */ 364 int periph_dbflags; /* debugging flags */ 365 366 int periph_target; /* target ID (drive # on ATAPI) */ 367 int periph_lun; /* LUN (not used on ATAPI) */ 368 369 int periph_version; /* ANSI SCSI version */ 370 371 int periph_qfreeze; /* queue freeze count */ 372 373 /* Bitmap of free command tags. */ 374 u_int32_t periph_freetags[PERIPH_NTAGWORDS]; 375 376 /* Pending scsipi_xfers on this peripherial. */ 377 struct scsipi_xfer_queue periph_xferq; 378 379 struct callout periph_callout; 380 381 /* xfer which has a pending CHECK_CONDITION */ 382 struct scsipi_xfer *periph_xscheck; 383 384 }; 385 386 /* 387 * Macro to return the current xfer mode of a periph. 388 */ 389 #define PERIPH_XFER_MODE(periph) \ 390 (((periph)->periph_flags & PERIPH_MODE_VALID) ? \ 391 (periph)->periph_mode : 0) 392 393 /* periph_cap */ 394 #define PERIPH_CAP_ANEC 0x0001 /* async event notification */ 395 #define PERIPH_CAP_TERMIOP 0x0002 /* terminate i/o proc. messages */ 396 #define PERIPH_CAP_RELADR 0x0004 /* relative addressing */ 397 #define PERIPH_CAP_WIDE32 0x0008 /* wide-32 transfers */ 398 #define PERIPH_CAP_WIDE16 0x0010 /* wide-16 transfers */ 399 /* XXX 0x0020 reserved for ATAPI_CFG_DRQ_MASK */ 400 /* XXX 0x0040 reserved for ATAPI_CFG_DRQ_MASK */ 401 #define PERIPH_CAP_SYNC 0x0080 /* synchronous transfers */ 402 #define PERIPH_CAP_LINKCMDS 0x0100 /* linked commands */ 403 #define PERIPH_CAP_TQING 0x0200 /* tagged queueing */ 404 #define PERIPH_CAP_SFTRESET 0x0400 /* soft RESET condition response */ 405 #define PERIPH_CAP_CMD16 0x0800 /* 16 byte commands (ATAPI) */ 406 407 /* periph_flags */ 408 #define PERIPH_REMOVABLE 0x0001 /* media is removable */ 409 #define PERIPH_MEDIA_LOADED 0x0002 /* media is loaded */ 410 #define PERIPH_WAITING 0x0004 /* process waiting for opening */ 411 #define PERIPH_OPEN 0x0008 /* device is open */ 412 #define PERIPH_WAITDRAIN 0x0010 /* waiting for pending xfers to drain */ 413 #define PERIPH_GROW_OPENINGS 0x0020 /* allow openings to grow */ 414 #define PERIPH_MODE_VALID 0x0040 /* periph_mode is valid */ 415 #define PERIPH_RECOVERING 0x0080 /* periph is recovering */ 416 #define PERIPH_RECOVERY_ACTIVE 0x0100 /* a recovery command is active */ 417 #define PERIPH_KEEP_LABEL 0x0200 /* retain label after 'full' close */ 418 #define PERIPH_SENSE 0x0400 /* periph has sense pending */ 419 #define PERIPH_UNTAG 0x0800 /* untagged command running */ 420 421 /* periph_quirks */ 422 #define PQUIRK_AUTOSAVE 0x00000001 /* do implicit SAVE POINTERS */ 423 #define PQUIRK_NOSYNC 0x00000002 /* does not grok SDTR */ 424 #define PQUIRK_NOWIDE 0x00000004 /* does not grok WDTR */ 425 #define PQUIRK_NOTAG 0x00000008 /* does not grok tagged cmds */ 426 #define PQUIRK_NOLUNS 0x00000010 /* DTWT with LUNs */ 427 #define PQUIRK_FORCELUNS 0x00000020 /* prehistoric device groks 428 LUNs */ 429 #define PQUIRK_NOMODESENSE 0x00000040 /* device doesn't do MODE SENSE 430 properly */ 431 #define PQUIRK_NOSTARTUNIT 0x00000080 /* do not issue START UNIT */ 432 #define PQUIRK_NOSYNCCACHE 0x00000100 /* do not issue SYNC CACHE */ 433 #define PQUIRK_CDROM 0x00000200 /* device is a CD-ROM, no 434 matter what else it claims */ 435 #define PQUIRK_LITTLETOC 0x00000400 /* audio TOC is little-endian */ 436 #define PQUIRK_NOCAPACITY 0x00000800 /* no READ CD CAPACITY */ 437 #define PQUIRK_NOTUR 0x00001000 /* no TEST UNIT READY */ 438 #define PQUIRK_NODOORLOCK 0x00002000 /* can't lock door */ 439 #define PQUIRK_NOSENSE 0x00004000 /* can't REQUEST SENSE */ 440 #define PQUIRK_ONLYBIG 0x00008000 /* only use SCSI_{R,W}_BIG */ 441 #define PQUIRK_BYTE5_ZERO 0x00010000 /* byte5 in capacity is wrong */ 442 #define PQUIRK_NO_FLEX_PAGE 0x00020000 /* does not support flex geom page */ 443 #define PQUIRK_NOBIGMODESENSE 0x00040000 /* has no big mode-sense op */ 444 445 446 /* 447 * Error values an adapter driver may return 448 */ 449 typedef enum { 450 XS_NOERROR, /* there is no error, (sense is invalid) */ 451 XS_SENSE, /* Check the returned sense for the error */ 452 XS_SHORTSENSE, /* Check the ATAPI sense for the error */ 453 XS_DRIVER_STUFFUP, /* Driver failed to perform operation */ 454 XS_RESOURCE_SHORTAGE, /* adapter resource shortage */ 455 XS_SELTIMEOUT, /* The device timed out.. turned off? */ 456 XS_TIMEOUT, /* The Timeout reported was caught by SW */ 457 XS_BUSY, /* The device busy, try again later? */ 458 XS_RESET, /* bus was reset; possible retry command */ 459 XS_REQUEUE /* requeue this command */ 460 } scsipi_xfer_result_t; 461 462 /* 463 * Each scsipi transaction is fully described by one of these structures 464 * It includes information about the source of the command and also the 465 * device and adapter for which the command is destined. 466 * 467 * Before the HBA is given this transaction, channel_q is the linkage on 468 * the related channel's chan_queue. 469 * 470 * When the this transaction is taken off the channel's chan_queue and 471 * the HBA's request entry point is called with this transaction, the 472 * HBA can use the channel_q tag for whatever it likes until it calls 473 * scsipi_done for this transaction, at which time it has to stop 474 * using channel_q. 475 * 476 * After scsipi_done is called with this transaction and if there was an 477 * error on it, channel_q then becomes the linkage on the related channel's 478 * chan_complete cqueue. 479 * 480 * The device_q member is maintained by the scsipi middle layer. When 481 * a device issues a command, the xfer is placed on that device's 482 * pending commands queue. When an xfer is done and freed, it is taken 483 * off the device's queue. This allows for a device to wait for all of 484 * its pending commands to complete. 485 */ 486 struct scsipi_xfer { 487 TAILQ_ENTRY(scsipi_xfer) channel_q; /* entry on channel queue */ 488 TAILQ_ENTRY(scsipi_xfer) device_q; /* device's pending xfers */ 489 struct callout xs_callout; /* callout for adapter use */ 490 int xs_control; /* control flags */ 491 __volatile int xs_status; /* status flags */ 492 struct scsipi_periph *xs_periph;/* peripherial doing the xfer */ 493 int xs_retries; /* the number of times to retry */ 494 int xs_requeuecnt; /* number of requeues */ 495 int timeout; /* in milliseconds */ 496 struct scsipi_generic *cmd; /* The scsipi command to execute */ 497 int cmdlen; /* how long it is */ 498 u_char *data; /* dma address OR a uio address */ 499 int datalen; /* data len (blank if uio) */ 500 int resid; /* how much buffer was not touched */ 501 scsipi_xfer_result_t error; /* an error value */ 502 struct buf *bp; /* If we need to associate with */ 503 /* a buf */ 504 union { 505 struct scsipi_sense_data scsi_sense; /* 32 bytes */ 506 u_int32_t atapi_sense; 507 } sense; 508 509 struct scsipi_xfer *xs_sensefor;/* we are requesting sense for this */ 510 /* xfer */ 511 512 u_int8_t status; /* SCSI status */ 513 514 /* 515 * Info for tagged command queueing. This may or may not 516 * be used by a given adapter driver. These are the same 517 * as the bytes in the tag message. 518 */ 519 u_int8_t xs_tag_type; /* tag type */ 520 u_int8_t xs_tag_id; /* tag ID */ 521 522 struct scsipi_generic cmdstore 523 __attribute__ ((aligned (4)));/* stash the command in here */ 524 }; 525 526 /* 527 * scsipi_xfer control flags 528 * 529 * To do: 530 * 531 * - figure out what to do with XS_CTL_ESCAPE 532 * 533 * - replace XS_CTL_URGENT with an `xs_priority' field? 534 */ 535 #define XS_CTL_NOSLEEP 0x00000001 /* don't sleep */ 536 #define XS_CTL_POLL 0x00000002 /* poll for completion */ 537 #define XS_CTL_DISCOVERY 0x00000004 /* doing device discovery */ 538 #define XS_CTL_ASYNC 0x00000008 /* command completes 539 asynchronously */ 540 #define XS_CTL_USERCMD 0x00000010 /* user issued command */ 541 #define XS_CTL_SILENT 0x00000020 /* don't print sense info */ 542 #define XS_CTL_IGNORE_NOT_READY 0x00000040 /* ignore NOT READY */ 543 #define XS_CTL_IGNORE_MEDIA_CHANGE \ 544 0x00000080 /* ignore media change */ 545 #define XS_CTL_IGNORE_ILLEGAL_REQUEST \ 546 0x00000100 /* ignore ILLEGAL REQUEST */ 547 #define XS_CTL_SILENT_NODEV 0x00000200 /* don't print sense info 548 if sense info is nodev */ 549 #define XS_CTL_RESET 0x00000400 /* reset the device */ 550 #define XS_CTL_DATA_UIO 0x00000800 /* xs_data points to uio */ 551 #define XS_CTL_DATA_IN 0x00001000 /* data coming into memory */ 552 #define XS_CTL_DATA_OUT 0x00002000 /* data going out of memory */ 553 #define XS_CTL_TARGET 0x00004000 /* target mode operation */ 554 #define XS_CTL_ESCAPE 0x00008000 /* escape operation */ 555 #define XS_CTL_URGENT 0x00010000 /* urgent (recovery) 556 operation */ 557 #define XS_CTL_SIMPLE_TAG 0x00020000 /* use a Simple Tag */ 558 #define XS_CTL_ORDERED_TAG 0x00040000 /* use an Ordered Tag */ 559 #define XS_CTL_HEAD_TAG 0x00080000 /* use a Head of Queue Tag */ 560 #define XS_CTL_THAW_PERIPH 0x00100000 /* thaw periph once enqueued */ 561 #define XS_CTL_FREEZE_PERIPH 0x00200000 /* freeze periph when done */ 562 #define XS_CTL_DATA_ONSTACK 0x00400000 /* data is alloc'ed on stack */ 563 #define XS_CTL_REQSENSE 0x00800000 /* xfer is a request sense */ 564 565 #define XS_CTL_TAGMASK (XS_CTL_SIMPLE_TAG|XS_CTL_ORDERED_TAG|XS_CTL_HEAD_TAG) 566 567 #define XS_CTL_TAGTYPE(xs) ((xs)->xs_control & XS_CTL_TAGMASK) 568 569 /* 570 * scsipi_xfer status flags 571 */ 572 #define XS_STS_DONE 0x00000001 /* scsipi_xfer is done */ 573 #define XS_STS_PRIVATE 0xf0000000 /* reserved for HBA's use */ 574 575 /* 576 * This describes matching information for scsipi_inqmatch(). The more things 577 * match, the higher the configuration priority. 578 */ 579 struct scsipi_inquiry_pattern { 580 u_int8_t type; 581 boolean removable; 582 char *vendor; 583 char *product; 584 char *revision; 585 }; 586 587 /* 588 * This is used to pass information from the high-level configuration code 589 * to the device-specific drivers. 590 */ 591 struct scsipibus_attach_args { 592 struct scsipi_periph *sa_periph; 593 struct scsipi_inquiry_pattern sa_inqbuf; 594 struct scsipi_inquiry_data *sa_inqptr; 595 union { /* bus-type specific infos */ 596 u_int8_t scsi_version; /* SCSI version */ 597 } scsipi_info; 598 }; 599 600 /* 601 * this describes a quirk entry 602 */ 603 struct scsi_quirk_inquiry_pattern { 604 struct scsipi_inquiry_pattern pattern; 605 int quirks; 606 }; 607 608 /* 609 * Default number of retries, used for generic routines. 610 */ 611 #define SCSIPIRETRIES 4 612 613 614 #ifdef _KERNEL 615 void scsipi_init __P((void)); 616 int scsipi_command __P((struct scsipi_periph *, 617 struct scsipi_generic *, int, u_char *, int, 618 int, int, struct buf *, int)); 619 void scsipi_create_completion_thread __P((void *)); 620 caddr_t scsipi_inqmatch __P((struct scsipi_inquiry_pattern *, caddr_t, 621 int, int, int *)); 622 char *scsipi_dtype __P((int)); 623 void scsipi_strvis __P((u_char *, int, u_char *, int)); 624 int scsipi_execute_xs __P((struct scsipi_xfer *)); 625 u_long scsipi_size __P((struct scsipi_periph *, int)); 626 int scsipi_test_unit_ready __P((struct scsipi_periph *, int)); 627 int scsipi_prevent __P((struct scsipi_periph *, int, int)); 628 int scsipi_inquire __P((struct scsipi_periph *, 629 struct scsipi_inquiry_data *, int)); 630 int scsipi_mode_select __P((struct scsipi_periph *, int, 631 struct scsipi_mode_header *, int, int, int, int)); 632 int scsipi_mode_select_big __P((struct scsipi_periph *, int, 633 struct scsipi_mode_header_big *, int, int, int, int)); 634 int scsipi_mode_sense __P((struct scsipi_periph *, int, int, 635 struct scsipi_mode_header *, int, int, int, int)); 636 int scsipi_mode_sense_big __P((struct scsipi_periph *, int, int, 637 struct scsipi_mode_header_big *, int, int, int, int)); 638 int scsipi_start __P((struct scsipi_periph *, int, int)); 639 void scsipi_done __P((struct scsipi_xfer *)); 640 void scsipi_user_done __P((struct scsipi_xfer *)); 641 int scsipi_interpret_sense __P((struct scsipi_xfer *)); 642 void scsipi_wait_drain __P((struct scsipi_periph *)); 643 void scsipi_kill_pending __P((struct scsipi_periph *)); 644 struct scsipi_periph *scsipi_alloc_periph __P((int)); 645 #ifdef SCSIVERBOSE 646 void scsipi_print_sense __P((struct scsipi_xfer *, int)); 647 void scsipi_print_sense_data __P((struct scsipi_sense_data *, int)); 648 char *scsipi_decode_sense __P((void *, int)); 649 #endif 650 int scsipi_thread_call_callback __P((struct scsipi_channel *, 651 void (*callback) __P((struct scsipi_channel *, void *)), 652 void *)); 653 void scsipi_async_event __P((struct scsipi_channel *, 654 scsipi_async_event_t, void *)); 655 int scsipi_do_ioctl __P((struct scsipi_periph *, dev_t, u_long, caddr_t, 656 int, struct proc *)); 657 658 void scsipi_print_xfer_mode __P((struct scsipi_periph *)); 659 void scsipi_set_xfer_mode __P((struct scsipi_channel *, int, int)); 660 661 int scsipi_channel_init __P((struct scsipi_channel *)); 662 void scsipi_channel_shutdown __P((struct scsipi_channel *)); 663 664 void scsipi_insert_periph __P((struct scsipi_channel *, 665 struct scsipi_periph *)); 666 void scsipi_remove_periph __P((struct scsipi_channel *, 667 struct scsipi_periph *)); 668 struct scsipi_periph *scsipi_lookup_periph __P((struct scsipi_channel *, 669 int, int)); 670 int scsipi_target_detach __P((struct scsipi_channel *, int, int, int)); 671 672 int scsipi_adapter_addref __P((struct scsipi_adapter *)); 673 void scsipi_adapter_delref __P((struct scsipi_adapter *)); 674 675 void scsipi_channel_freeze __P((struct scsipi_channel *, int)); 676 void scsipi_channel_thaw __P((struct scsipi_channel *, int)); 677 void scsipi_channel_timed_thaw __P((void *)); 678 679 void scsipi_periph_freeze __P((struct scsipi_periph *, int)); 680 void scsipi_periph_thaw __P((struct scsipi_periph *, int)); 681 void scsipi_periph_timed_thaw __P((void *)); 682 683 int scsipi_sync_period_to_factor __P((int)); 684 int scsipi_sync_factor_to_period __P((int)); 685 int scsipi_sync_factor_to_freq __P((int)); 686 687 void show_scsipi_xs __P((struct scsipi_xfer *)); 688 void show_scsipi_cmd __P((struct scsipi_xfer *)); 689 void show_mem __P((u_char *, int)); 690 #endif /* _KERNEL */ 691 692 static __inline void _lto2b __P((u_int32_t val, u_int8_t *bytes)) 693 __attribute__ ((unused)); 694 static __inline void _lto3b __P((u_int32_t val, u_int8_t *bytes)) 695 __attribute__ ((unused)); 696 static __inline void _lto4b __P((u_int32_t val, u_int8_t *bytes)) 697 __attribute__ ((unused)); 698 static __inline u_int32_t _2btol __P((const u_int8_t *bytes)) 699 __attribute__ ((unused)); 700 static __inline u_int32_t _3btol __P((const u_int8_t *bytes)) 701 __attribute__ ((unused)); 702 static __inline u_int32_t _4btol __P((const u_int8_t *bytes)) 703 __attribute__ ((unused)); 704 705 static __inline void _lto2l __P((u_int32_t val, u_int8_t *bytes)) 706 __attribute__ ((unused)); 707 static __inline void _lto3l __P((u_int32_t val, u_int8_t *bytes)) 708 __attribute__ ((unused)); 709 static __inline void _lto4l __P((u_int32_t val, u_int8_t *bytes)) 710 __attribute__ ((unused)); 711 static __inline u_int32_t _2ltol __P((const u_int8_t *bytes)) 712 __attribute__ ((unused)); 713 static __inline u_int32_t _3ltol __P((const u_int8_t *bytes)) 714 __attribute__ ((unused)); 715 static __inline u_int32_t _4ltol __P((const u_int8_t *bytes)) 716 __attribute__ ((unused)); 717 718 static __inline void 719 _lto2b(val, bytes) 720 u_int32_t val; 721 u_int8_t *bytes; 722 { 723 724 bytes[0] = (val >> 8) & 0xff; 725 bytes[1] = val & 0xff; 726 } 727 728 static __inline void 729 _lto3b(val, bytes) 730 u_int32_t val; 731 u_int8_t *bytes; 732 { 733 734 bytes[0] = (val >> 16) & 0xff; 735 bytes[1] = (val >> 8) & 0xff; 736 bytes[2] = val & 0xff; 737 } 738 739 static __inline void 740 _lto4b(val, bytes) 741 u_int32_t val; 742 u_int8_t *bytes; 743 { 744 745 bytes[0] = (val >> 24) & 0xff; 746 bytes[1] = (val >> 16) & 0xff; 747 bytes[2] = (val >> 8) & 0xff; 748 bytes[3] = val & 0xff; 749 } 750 751 static __inline u_int32_t 752 _2btol(bytes) 753 const u_int8_t *bytes; 754 { 755 u_int32_t rv; 756 757 rv = (bytes[0] << 8) | 758 bytes[1]; 759 return (rv); 760 } 761 762 static __inline u_int32_t 763 _3btol(bytes) 764 const u_int8_t *bytes; 765 { 766 u_int32_t rv; 767 768 rv = (bytes[0] << 16) | 769 (bytes[1] << 8) | 770 bytes[2]; 771 return (rv); 772 } 773 774 static __inline u_int32_t 775 _4btol(bytes) 776 const u_int8_t *bytes; 777 { 778 u_int32_t rv; 779 780 rv = (bytes[0] << 24) | 781 (bytes[1] << 16) | 782 (bytes[2] << 8) | 783 bytes[3]; 784 return (rv); 785 } 786 787 static __inline void 788 _lto2l(val, bytes) 789 u_int32_t val; 790 u_int8_t *bytes; 791 { 792 793 bytes[0] = val & 0xff; 794 bytes[1] = (val >> 8) & 0xff; 795 } 796 797 static __inline void 798 _lto3l(val, bytes) 799 u_int32_t val; 800 u_int8_t *bytes; 801 { 802 803 bytes[0] = val & 0xff; 804 bytes[1] = (val >> 8) & 0xff; 805 bytes[2] = (val >> 16) & 0xff; 806 } 807 808 static __inline void 809 _lto4l(val, bytes) 810 u_int32_t val; 811 u_int8_t *bytes; 812 { 813 814 bytes[0] = val & 0xff; 815 bytes[1] = (val >> 8) & 0xff; 816 bytes[2] = (val >> 16) & 0xff; 817 bytes[3] = (val >> 24) & 0xff; 818 } 819 820 static __inline u_int32_t 821 _2ltol(bytes) 822 const u_int8_t *bytes; 823 { 824 u_int32_t rv; 825 826 rv = bytes[0] | 827 (bytes[1] << 8); 828 return (rv); 829 } 830 831 static __inline u_int32_t 832 _3ltol(bytes) 833 const u_int8_t *bytes; 834 { 835 u_int32_t rv; 836 837 rv = bytes[0] | 838 (bytes[1] << 8) | 839 (bytes[2] << 16); 840 return (rv); 841 } 842 843 static __inline u_int32_t 844 _4ltol(bytes) 845 const u_int8_t *bytes; 846 { 847 u_int32_t rv; 848 849 rv = bytes[0] | 850 (bytes[1] << 8) | 851 (bytes[2] << 16) | 852 (bytes[3] << 24); 853 return (rv); 854 } 855 856 #endif /* _DEV_SCSIPI_SCSIPICONF_H_ */ 857