| 1 | /* $NetBSD: scsipiconf.h,v 1.124 2016/11/20 15:37:19 mlelstv 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 <sys/condvar.h> |
| 58 | #include <dev/scsipi/scsi_spc.h> |
| 59 | #include <dev/scsipi/scsipi_debug.h> |
| 60 | |
| 61 | struct buf; |
| 62 | struct proc; |
| 63 | struct device; |
| 64 | struct scsipi_channel; |
| 65 | struct scsipi_periph; |
| 66 | struct scsipi_xfer; |
| 67 | |
| 68 | /* |
| 69 | * The following defines the scsipi_xfer queue. |
| 70 | */ |
| 71 | TAILQ_HEAD(scsipi_xfer_queue, scsipi_xfer); |
| 72 | |
| 73 | struct scsipi_generic { |
| 74 | u_int8_t opcode; |
| 75 | u_int8_t bytes[15]; |
| 76 | }; |
| 77 | |
| 78 | |
| 79 | /* |
| 80 | * scsipi_async_event_t: |
| 81 | * |
| 82 | * Asynchronous events from the adapter to the mid-layer and |
| 83 | * peripheral. |
| 84 | * |
| 85 | * Arguments: |
| 86 | * |
| 87 | * ASYNC_EVENT_MAX_OPENINGS scsipi_max_openings * -- max |
| 88 | * openings, device specified in |
| 89 | * parameters |
| 90 | * |
| 91 | * ASYNC_EVENT_XFER_MODE scsipi_xfer_mode * -- xfer mode |
| 92 | * parameters changed for I_T Nexus |
| 93 | * ASYNC_EVENT_RESET NULL - channel has been reset |
| 94 | */ |
| 95 | typedef enum { |
| 96 | ASYNC_EVENT_MAX_OPENINGS, /* set max openings on periph */ |
| 97 | ASYNC_EVENT_XFER_MODE, /* xfer mode update for I_T */ |
| 98 | ASYNC_EVENT_RESET /* channel reset */ |
| 99 | } scsipi_async_event_t; |
| 100 | |
| 101 | /* |
| 102 | * scsipi_max_openings: |
| 103 | * |
| 104 | * Argument for an ASYNC_EVENT_MAX_OPENINGS event. |
| 105 | */ |
| 106 | struct scsipi_max_openings { |
| 107 | int mo_target; /* openings are for this target... */ |
| 108 | int mo_lun; /* ...and this lun */ |
| 109 | int mo_openings; /* openings value */ |
| 110 | }; |
| 111 | |
| 112 | /* |
| 113 | * scsipi_xfer_mode: |
| 114 | * |
| 115 | * Argument for an ASYNC_EVENT_XFER_MODE event. |
| 116 | */ |
| 117 | struct scsipi_xfer_mode { |
| 118 | int xm_target; /* target, for I_T Nexus */ |
| 119 | int xm_mode; /* PERIPH_CAP* bits */ |
| 120 | int xm_period; /* sync period */ |
| 121 | int xm_offset; /* sync offset */ |
| 122 | }; |
| 123 | |
| 124 | |
| 125 | /* |
| 126 | * scsipi_adapter_req_t: |
| 127 | * |
| 128 | * Requests that can be made of an adapter. |
| 129 | * |
| 130 | * Arguments: |
| 131 | * |
| 132 | * ADAPTER_REQ_RUN_XFER scsipi_xfer * -- the xfer which |
| 133 | * is to be run |
| 134 | * |
| 135 | * ADAPTER_REQ_GROW_RESOURCES no argument |
| 136 | * |
| 137 | * ADAPTER_REQ_SET_XFER_MODE scsipi_xfer_mode * -- set the xfer |
| 138 | * mode for the I_T Nexus according to |
| 139 | * this |
| 140 | */ |
| 141 | typedef enum { |
| 142 | ADAPTER_REQ_RUN_XFER, /* run a scsipi_xfer */ |
| 143 | ADAPTER_REQ_GROW_RESOURCES, /* grow xfer execution resources */ |
| 144 | ADAPTER_REQ_SET_XFER_MODE /* set xfer mode */ |
| 145 | } scsipi_adapter_req_t; |
| 146 | |
| 147 | #ifdef _KERNEL |
| 148 | /* |
| 149 | * scsipi_periphsw: |
| 150 | * |
| 151 | * Callbacks into periph driver from midlayer. |
| 152 | * |
| 153 | * psw_error Called by the bustype's interpret-sense routine |
| 154 | * to do periph-specific sense handling. |
| 155 | * |
| 156 | * psw_start Called by midlayer to restart a device once |
| 157 | * more command openings become available. |
| 158 | * |
| 159 | * psw_async Called by midlayer when an asynchronous event |
| 160 | * from the adapter occurs. |
| 161 | * |
| 162 | * psw_done Called by the midlayer when an xfer has completed. |
| 163 | */ |
| 164 | struct scsipi_periphsw { |
| 165 | int (*psw_error)(struct scsipi_xfer *); |
| 166 | void (*psw_start)(struct scsipi_periph *); |
| 167 | int (*psw_async)(struct scsipi_periph *, |
| 168 | scsipi_async_event_t, void *); |
| 169 | void (*psw_done)(struct scsipi_xfer *, int); |
| 170 | }; |
| 171 | |
| 172 | struct disk_parms; |
| 173 | struct scsipi_inquiry_pattern; |
| 174 | |
| 175 | /* |
| 176 | * scsipi_adapter: |
| 177 | * |
| 178 | * This structure describes an instance of a SCSIPI adapter. |
| 179 | * |
| 180 | * Note that `adapt_openings' is used by (the common case of) adapters |
| 181 | * which have per-adapter resources. If an adapter's command resources |
| 182 | * are associated with a channel, then the `chan_openings' below will |
| 183 | * be used instead. |
| 184 | * |
| 185 | * Note that all adapter entry points take a pointer to a channel, |
| 186 | * as an adapter may have more than one channel, and the channel |
| 187 | * structure contains the channel number. |
| 188 | */ |
| 189 | struct scsipi_adapter { |
| 190 | device_t adapt_dev; /* pointer to adapter's device */ |
| 191 | int adapt_nchannels; /* number of adapter channels */ |
| 192 | volatile int adapt_refcnt; /* adapter's reference count */ |
| 193 | int adapt_openings; /* total # of command openings */ |
| 194 | int adapt_max_periph; /* max openings per periph */ |
| 195 | int adapt_flags; |
| 196 | |
| 197 | void (*adapt_request)(struct scsipi_channel *, |
| 198 | scsipi_adapter_req_t, void *); |
| 199 | void (*adapt_minphys)(struct buf *); |
| 200 | int (*adapt_ioctl)(struct scsipi_channel *, u_long, |
| 201 | void *, int, struct proc *); |
| 202 | int (*adapt_enable)(device_t, int); |
| 203 | int (*adapt_getgeom)(struct scsipi_periph *, |
| 204 | struct disk_parms *, u_long); |
| 205 | int (*adapt_accesschk)(struct scsipi_periph *, |
| 206 | struct scsipi_inquiry_pattern *); |
| 207 | |
| 208 | kmutex_t adapt_mtx; |
| 209 | bool adapt_running; /* attachment initialized */ |
| 210 | }; |
| 211 | #endif |
| 212 | |
| 213 | /* adapt_flags */ |
| 214 | #define SCSIPI_ADAPT_POLL_ONLY 0x01 /* Adaptor can't do interrupts. */ |
| 215 | #define SCSIPI_ADAPT_MPSAFE 0x02 /* Adaptor doesn't need kernel lock */ |
| 216 | |
| 217 | void scsipi_adapter_minphys(struct scsipi_channel *, struct buf *); |
| 218 | void scsipi_adapter_request(struct scsipi_channel *, |
| 219 | scsipi_adapter_req_t, void *); |
| 220 | int scsipi_adapter_ioctl(struct scsipi_channel *, u_long, |
| 221 | void *, int, struct proc *); |
| 222 | int scsipi_adapter_enable(struct scsipi_adapter *, int); |
| 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 | kcondvar_t chan_cv_comp; |
| 312 | kcondvar_t chan_cv_thr; |
| 313 | kcondvar_t chan_cv_xs; |
| 314 | |
| 315 | #define chan_cv_complete(ch) (&(ch)->chan_cv_comp) |
| 316 | #define chan_cv_thread(ch) (&(ch)->chan_cv_thr) |
| 317 | }; |
| 318 | |
| 319 | #define chan_running(ch) ((ch)->chan_adapter->adapt_running) |
| 320 | #define chan_mtx(ch) (&(ch)->chan_adapter->adapt_mtx) |
| 321 | #endif |
| 322 | |
| 323 | /* chan_flags */ |
| 324 | #define SCSIPI_CHAN_OPENINGS 0x01 /* use chan_openings */ |
| 325 | #define SCSIPI_CHAN_CANGROW 0x02 /* channel can grow resources */ |
| 326 | #define SCSIPI_CHAN_NOSETTLE 0x04 /* don't wait for devices to settle */ |
| 327 | #define SCSIPI_CHAN_TACTIVE 0x08 /* completion thread is active */ |
| 328 | |
| 329 | /* chan thread flags (chan_tflags) */ |
| 330 | #define SCSIPI_CHANT_SHUTDOWN 0x01 /* channel is shutting down */ |
| 331 | #define SCSIPI_CHANT_CALLBACK 0x02 /* has to call chan_callback() */ |
| 332 | #define SCSIPI_CHANT_KICK 0x04 /* need to run queues */ |
| 333 | #define SCSIPI_CHANT_GROWRES 0x08 /* call ADAPTER_REQ_GROW_RESOURCES */ |
| 334 | |
| 335 | #define SCSIPI_CHAN_MAX_PERIPH(chan) \ |
| 336 | (((chan)->chan_flags & SCSIPI_CHAN_OPENINGS) ? \ |
| 337 | (chan)->chan_max_periph : (chan)->chan_adapter->adapt_max_periph) |
| 338 | |
| 339 | |
| 340 | #define scsipi_printaddr(periph) \ |
| 341 | (*(periph)->periph_channel->chan_bustype->bustype_printaddr)((periph)) |
| 342 | |
| 343 | #define scsipi_periph_bustype(periph) \ |
| 344 | (periph)->periph_channel->chan_bustype->bustype_type |
| 345 | |
| 346 | |
| 347 | /* |
| 348 | * Number of tag words in a periph structure: |
| 349 | * |
| 350 | * n_tag_words = ((256 / NBBY) / sizeof(u_int32_t)) |
| 351 | */ |
| 352 | #define PERIPH_NTAGWORDS ((256 / 8) / sizeof(u_int32_t)) |
| 353 | |
| 354 | |
| 355 | #ifdef _KERNEL |
| 356 | /* |
| 357 | * scsipi_periph: |
| 358 | * |
| 359 | * This structure describes the path between a peripheral device |
| 360 | * and an adapter. It contains a pointer to the adapter channel |
| 361 | * which in turn contains a pointer to the adapter. |
| 362 | * |
| 363 | * XXX Given the way NetBSD's autoconfiguration works, this is ... |
| 364 | * XXX nasty. |
| 365 | * |
| 366 | * Well, it's a lot nicer than it used to be, but there could |
| 367 | * still be an improvement. |
| 368 | */ |
| 369 | struct scsipi_periph { |
| 370 | device_t periph_dev; /* pointer to peripheral's device */ |
| 371 | struct scsipi_channel *periph_channel; /* channel we're connected to */ |
| 372 | |
| 373 | /* link in channel's table of periphs */ |
| 374 | LIST_ENTRY(scsipi_periph) periph_hash; |
| 375 | |
| 376 | const struct scsipi_periphsw *periph_switch; /* peripheral's entry |
| 377 | points */ |
| 378 | int periph_openings; /* max # of outstanding commands */ |
| 379 | int periph_active; /* current # of outstanding commands */ |
| 380 | int periph_sent; /* current # of commands sent to adapt*/ |
| 381 | |
| 382 | int periph_mode; /* operation modes, CAP bits */ |
| 383 | int periph_period; /* sync period (factor) */ |
| 384 | int periph_offset; /* sync offset */ |
| 385 | |
| 386 | /* |
| 387 | * Information gleaned from the inquiry data. |
| 388 | */ |
| 389 | u_int8_t periph_type; /* basic device type */ |
| 390 | int periph_cap; /* capabilities */ |
| 391 | int periph_quirks; /* device's quirks */ |
| 392 | |
| 393 | int periph_flags; /* misc. flags */ |
| 394 | int periph_dbflags; /* debugging flags */ |
| 395 | |
| 396 | int periph_target; /* target ID (drive # on ATAPI) */ |
| 397 | int periph_lun; /* LUN (not used on ATAPI) */ |
| 398 | |
| 399 | int periph_version; /* ANSI SCSI version */ |
| 400 | |
| 401 | int periph_qfreeze; /* queue freeze count */ |
| 402 | |
| 403 | /* Bitmap of free command tags. */ |
| 404 | u_int32_t periph_freetags[PERIPH_NTAGWORDS]; |
| 405 | |
| 406 | /* Pending scsipi_xfers on this peripheral. */ |
| 407 | struct scsipi_xfer_queue periph_xferq; |
| 408 | |
| 409 | callout_t periph_callout; |
| 410 | |
| 411 | /* xfer which has a pending CHECK_CONDITION */ |
| 412 | struct scsipi_xfer *periph_xscheck; |
| 413 | |
| 414 | kcondvar_t periph_cv; |
| 415 | #define periph_cv_periph(p) (&(p)->periph_cv) |
| 416 | #define periph_cv_active(p) (&(p)->periph_cv) |
| 417 | }; |
| 418 | #endif |
| 419 | |
| 420 | /* |
| 421 | * Macro to return the current xfer mode of a periph. |
| 422 | */ |
| 423 | #define PERIPH_XFER_MODE(periph) \ |
| 424 | (((periph)->periph_flags & PERIPH_MODE_VALID) ? \ |
| 425 | (periph)->periph_mode : 0) |
| 426 | |
| 427 | /* periph_cap */ |
| 428 | #define PERIPH_CAP_ANEC 0x0001 /* async event notification */ |
| 429 | #define PERIPH_CAP_TERMIOP 0x0002 /* terminate i/o proc. messages */ |
| 430 | #define PERIPH_CAP_RELADR 0x0004 /* relative addressing */ |
| 431 | #define PERIPH_CAP_WIDE32 0x0008 /* wide-32 transfers */ |
| 432 | #define PERIPH_CAP_WIDE16 0x0010 /* wide-16 transfers */ |
| 433 | /* XXX 0x0020 reserved for ATAPI_CFG_DRQ_MASK */ |
| 434 | /* XXX 0x0040 reserved for ATAPI_CFG_DRQ_MASK */ |
| 435 | #define PERIPH_CAP_SYNC 0x0080 /* synchronous transfers */ |
| 436 | #define PERIPH_CAP_LINKCMDS 0x0100 /* linked commands */ |
| 437 | #define PERIPH_CAP_TQING 0x0200 /* tagged queueing */ |
| 438 | #define PERIPH_CAP_SFTRESET 0x0400 /* soft RESET condition response */ |
| 439 | #define PERIPH_CAP_CMD16 0x0800 /* 16 byte commands (ATAPI) */ |
| 440 | #define PERIPH_CAP_DT 0x1000 /* supports DT clock */ |
| 441 | #define PERIPH_CAP_QAS 0x2000 /* supports quick arbit. and select. */ |
| 442 | #define PERIPH_CAP_IUS 0x4000 /* supports information unit xfers */ |
| 443 | |
| 444 | /* periph_flags */ |
| 445 | #define PERIPH_REMOVABLE 0x0001 /* media is removable */ |
| 446 | #define PERIPH_MEDIA_LOADED 0x0002 /* media is loaded */ |
| 447 | #define PERIPH_WAITING 0x0004 /* process waiting for opening */ |
| 448 | #define PERIPH_OPEN 0x0008 /* device is open */ |
| 449 | #define PERIPH_WAITDRAIN 0x0010 /* waiting for pending xfers to drain */ |
| 450 | #define PERIPH_GROW_OPENINGS 0x0020 /* allow openings to grow */ |
| 451 | #define PERIPH_MODE_VALID 0x0040 /* periph_mode is valid */ |
| 452 | #define PERIPH_RECOVERING 0x0080 /* periph is recovering */ |
| 453 | #define PERIPH_RECOVERY_ACTIVE 0x0100 /* a recovery command is active */ |
| 454 | #define PERIPH_KEEP_LABEL 0x0200 /* retain label after 'full' close */ |
| 455 | #define PERIPH_SENSE 0x0400 /* periph has sense pending */ |
| 456 | #define PERIPH_UNTAG 0x0800 /* untagged command running */ |
| 457 | |
| 458 | /* periph_quirks */ |
| 459 | #define PQUIRK_AUTOSAVE 0x00000001 /* do implicit SAVE POINTERS */ |
| 460 | #define PQUIRK_NOSYNC 0x00000002 /* does not grok SDTR */ |
| 461 | #define PQUIRK_NOWIDE 0x00000004 /* does not grok WDTR */ |
| 462 | #define PQUIRK_NOTAG 0x00000008 /* does not grok tagged cmds */ |
| 463 | #define PQUIRK_NOLUNS 0x00000010 /* DTWT with LUNs */ |
| 464 | #define PQUIRK_FORCELUNS 0x00000020 /* prehistoric device groks |
| 465 | LUNs */ |
| 466 | #define PQUIRK_NOMODESENSE 0x00000040 /* device doesn't do MODE SENSE |
| 467 | properly */ |
| 468 | #define PQUIRK_NOSYNCCACHE 0x00000100 /* do not issue SYNC CACHE */ |
| 469 | #define PQUIRK_LITTLETOC 0x00000400 /* audio TOC is little-endian */ |
| 470 | #define PQUIRK_NOCAPACITY 0x00000800 /* no READ CD CAPACITY */ |
| 471 | #define PQUIRK_NOTUR 0x00001000 /* no TEST UNIT READY */ |
| 472 | #define PQUIRK_NODOORLOCK 0x00002000 /* can't lock door */ |
| 473 | #define PQUIRK_NOSENSE 0x00004000 /* can't REQUEST SENSE */ |
| 474 | #define PQUIRK_ONLYBIG 0x00008000 /* only use SCSI_{R,W}_BIG */ |
| 475 | #define PQUIRK_NOBIGMODESENSE 0x00040000 /* has no big mode-sense op */ |
| 476 | #define PQUIRK_CAP_SYNC 0x00080000 /* SCSI device with ST sync op*/ |
| 477 | #define PQUIRK_CAP_WIDE16 0x00100000 /* SCSI device with ST wide op*/ |
| 478 | #define PQUIRK_CAP_NODT 0x00200000 /* signals DT, but can't. */ |
| 479 | #define PQUIRK_START 0x00400000 /* needs start before tur */ |
| 480 | |
| 481 | |
| 482 | /* |
| 483 | * Error values an adapter driver may return |
| 484 | */ |
| 485 | typedef enum { |
| 486 | XS_NOERROR, /* there is no error, (sense is invalid) */ |
| 487 | XS_SENSE, /* Check the returned sense for the error */ |
| 488 | XS_SHORTSENSE, /* Check the ATAPI sense for the error */ |
| 489 | XS_DRIVER_STUFFUP, /* Driver failed to perform operation */ |
| 490 | XS_RESOURCE_SHORTAGE, /* adapter resource shortage */ |
| 491 | XS_SELTIMEOUT, /* The device timed out.. turned off? */ |
| 492 | XS_TIMEOUT, /* The Timeout reported was caught by SW */ |
| 493 | XS_BUSY, /* The device busy, try again later? */ |
| 494 | XS_RESET, /* bus was reset; possible retry command */ |
| 495 | XS_REQUEUE /* requeue this command */ |
| 496 | } scsipi_xfer_result_t; |
| 497 | |
| 498 | #ifdef _KERNEL |
| 499 | /* |
| 500 | * Each scsipi transaction is fully described by one of these structures |
| 501 | * It includes information about the source of the command and also the |
| 502 | * device and adapter for which the command is destined. |
| 503 | * |
| 504 | * Before the HBA is given this transaction, channel_q is the linkage on |
| 505 | * the related channel's chan_queue. |
| 506 | * |
| 507 | * When the this transaction is taken off the channel's chan_queue and |
| 508 | * the HBA's request entry point is called with this transaction, the |
| 509 | * HBA can use the channel_q tag for whatever it likes until it calls |
| 510 | * scsipi_done for this transaction, at which time it has to stop |
| 511 | * using channel_q. |
| 512 | * |
| 513 | * After scsipi_done is called with this transaction and if there was an |
| 514 | * error on it, channel_q then becomes the linkage on the related channel's |
| 515 | * chan_complete cqueue. |
| 516 | * |
| 517 | * The device_q member is maintained by the scsipi middle layer. When |
| 518 | * a device issues a command, the xfer is placed on that device's |
| 519 | * pending commands queue. When an xfer is done and freed, it is taken |
| 520 | * off the device's queue. This allows for a device to wait for all of |
| 521 | * its pending commands to complete. |
| 522 | */ |
| 523 | struct scsipi_xfer { |
| 524 | TAILQ_ENTRY(scsipi_xfer) channel_q; /* entry on channel queue */ |
| 525 | TAILQ_ENTRY(scsipi_xfer) device_q; /* device's pending xfers */ |
| 526 | callout_t xs_callout; /* callout for adapter use */ |
| 527 | int xs_control; /* control flags */ |
| 528 | volatile int xs_status; /* status flags */ |
| 529 | struct scsipi_periph *xs_periph;/* peripheral doing the xfer */ |
| 530 | int xs_retries; /* the number of times to retry */ |
| 531 | int xs_requeuecnt; /* number of requeues */ |
| 532 | int timeout; /* in milliseconds */ |
| 533 | struct scsipi_generic *cmd; /* The scsipi command to execute */ |
| 534 | int cmdlen; /* how long it is */ |
| 535 | u_char *data; /* DMA address OR a uio address */ |
| 536 | int datalen; /* data len (blank if uio) */ |
| 537 | int resid; /* how much buffer was not touched */ |
| 538 | scsipi_xfer_result_t error; /* an error value */ |
| 539 | struct buf *bp; /* If we need to associate with */ |
| 540 | /* a buf */ |
| 541 | union { |
| 542 | struct scsi_sense_data scsi_sense; /* 32 bytes */ |
| 543 | u_int32_t atapi_sense; |
| 544 | } sense; |
| 545 | |
| 546 | struct scsipi_xfer *xs_sensefor;/* we are requesting sense for this */ |
| 547 | /* xfer */ |
| 548 | |
| 549 | u_int8_t status; /* SCSI status */ |
| 550 | |
| 551 | /* |
| 552 | * Info for tagged command queueing. This may or may not |
| 553 | * be used by a given adapter driver. These are the same |
| 554 | * as the bytes in the tag message. |
| 555 | */ |
| 556 | u_int8_t xs_tag_type; /* tag type */ |
| 557 | u_int8_t xs_tag_id; /* tag ID */ |
| 558 | |
| 559 | struct scsipi_generic cmdstore |
| 560 | __aligned(4); /* stash the command in here */ |
| 561 | |
| 562 | #define xs_cv(xs) (&(xs)->xs_periph->periph_channel->chan_cv_xs) |
| 563 | }; |
| 564 | #endif |
| 565 | |
| 566 | /* |
| 567 | * scsipi_xfer control flags |
| 568 | * |
| 569 | * To do: |
| 570 | * |
| 571 | * - figure out what to do with XS_CTL_ESCAPE |
| 572 | * |
| 573 | * - replace XS_CTL_URGENT with an `xs_priority' field? |
| 574 | */ |
| 575 | #define XS_CTL_NOSLEEP 0x00000001 /* don't sleep */ |
| 576 | #define XS_CTL_POLL 0x00000002 /* poll for completion */ |
| 577 | #define XS_CTL_DISCOVERY 0x00000004 /* doing device discovery */ |
| 578 | #define XS_CTL_ASYNC 0x00000008 /* command completes |
| 579 | asynchronously */ |
| 580 | #define XS_CTL_USERCMD 0x00000010 /* user issued command */ |
| 581 | #define XS_CTL_SILENT 0x00000020 /* don't print sense info */ |
| 582 | #define XS_CTL_IGNORE_NOT_READY 0x00000040 /* ignore NOT READY */ |
| 583 | #define XS_CTL_IGNORE_MEDIA_CHANGE \ |
| 584 | 0x00000080 /* ignore media change */ |
| 585 | #define XS_CTL_IGNORE_ILLEGAL_REQUEST \ |
| 586 | 0x00000100 /* ignore ILLEGAL REQUEST */ |
| 587 | #define XS_CTL_SILENT_NODEV 0x00000200 /* don't print sense info |
| 588 | if sense info is nodev */ |
| 589 | #define XS_CTL_RESET 0x00000400 /* reset the device */ |
| 590 | #define XS_CTL_DATA_UIO 0x00000800 /* xs_data points to uio */ |
| 591 | #define XS_CTL_DATA_IN 0x00001000 /* data coming into memory */ |
| 592 | #define XS_CTL_DATA_OUT 0x00002000 /* data going out of memory */ |
| 593 | #define XS_CTL_TARGET 0x00004000 /* target mode operation */ |
| 594 | #define XS_CTL_ESCAPE 0x00008000 /* escape operation */ |
| 595 | #define XS_CTL_URGENT 0x00010000 /* urgent (recovery) |
| 596 | operation */ |
| 597 | #define XS_CTL_SIMPLE_TAG 0x00020000 /* use a Simple Tag */ |
| 598 | #define XS_CTL_ORDERED_TAG 0x00040000 /* use an Ordered Tag */ |
| 599 | #define XS_CTL_HEAD_TAG 0x00080000 /* use a Head of Queue Tag */ |
| 600 | #define XS_CTL_THAW_PERIPH 0x00100000 /* thaw periph once enqueued */ |
| 601 | #define XS_CTL_FREEZE_PERIPH 0x00200000 /* freeze periph when done */ |
| 602 | #define XS_CTL_REQSENSE 0x00800000 /* xfer is a request sense */ |
| 603 | |
| 604 | #define XS_CTL_TAGMASK (XS_CTL_SIMPLE_TAG|XS_CTL_ORDERED_TAG|XS_CTL_HEAD_TAG) |
| 605 | |
| 606 | #define XS_CTL_TAGTYPE(xs) ((xs)->xs_control & XS_CTL_TAGMASK) |
| 607 | |
| 608 | /* |
| 609 | * scsipi_xfer status flags |
| 610 | */ |
| 611 | #define XS_STS_DONE 0x00000001 /* scsipi_xfer is done */ |
| 612 | #define XS_STS_PRIVATE 0xf0000000 /* reserved for HBA's use */ |
| 613 | |
| 614 | /* |
| 615 | * This describes matching information for scsipi_inqmatch(). The more things |
| 616 | * match, the higher the configuration priority. |
| 617 | */ |
| 618 | struct scsipi_inquiry_pattern { |
| 619 | u_int8_t type; |
| 620 | boolean removable; |
| 621 | const char *vendor; |
| 622 | const char *product; |
| 623 | const char *revision; |
| 624 | }; |
| 625 | |
| 626 | /* |
| 627 | * This is used to pass information from the high-level configuration code |
| 628 | * to the device-specific drivers. |
| 629 | */ |
| 630 | struct scsipibus_attach_args { |
| 631 | struct scsipi_periph *sa_periph; |
| 632 | struct scsipi_inquiry_pattern sa_inqbuf; |
| 633 | struct scsipi_inquiry_data *sa_inqptr; |
| 634 | union { /* bus-type specific infos */ |
| 635 | u_int8_t scsi_version; /* SCSI version */ |
| 636 | } scsipi_info; |
| 637 | }; |
| 638 | |
| 639 | /* |
| 640 | * this describes a quirk entry |
| 641 | */ |
| 642 | struct scsi_quirk_inquiry_pattern { |
| 643 | struct scsipi_inquiry_pattern pattern; |
| 644 | int quirks; |
| 645 | }; |
| 646 | |
| 647 | /* |
| 648 | * Default number of retries, used for generic routines. |
| 649 | */ |
| 650 | #define SCSIPIRETRIES 4 |
| 651 | |
| 652 | |
| 653 | #ifdef _KERNEL |
| 654 | void scsipi_init(void); |
| 655 | void scsipi_ioctl_init(void); |
| 656 | void scsipi_load_verbose(void); |
| 657 | int scsipi_command(struct scsipi_periph *, struct scsipi_generic *, int, |
| 658 | u_char *, int, int, int, struct buf *, int); |
| 659 | void scsipi_create_completion_thread(void *); |
| 660 | const void *scsipi_inqmatch(struct scsipi_inquiry_pattern *, const void *, |
| 661 | size_t, size_t, int *); |
| 662 | const char *scsipi_dtype(int); |
| 663 | int scsipi_execute_xs(struct scsipi_xfer *); |
| 664 | int scsipi_test_unit_ready(struct scsipi_periph *, int); |
| 665 | int scsipi_prevent(struct scsipi_periph *, int, int); |
| 666 | int scsipi_inquire(struct scsipi_periph *, |
| 667 | struct scsipi_inquiry_data *, int); |
| 668 | int scsipi_mode_select(struct scsipi_periph *, int, |
| 669 | struct scsi_mode_parameter_header_6 *, int, int, int, int); |
| 670 | int scsipi_mode_select_big(struct scsipi_periph *, int, |
| 671 | struct scsi_mode_parameter_header_10 *, int, int, int, int); |
| 672 | int scsipi_mode_sense(struct scsipi_periph *, int, int, |
| 673 | struct scsi_mode_parameter_header_6 *, int, int, int, int); |
| 674 | int scsipi_mode_sense_big(struct scsipi_periph *, int, int, |
| 675 | struct scsi_mode_parameter_header_10 *, int, int, int, int); |
| 676 | int scsipi_start(struct scsipi_periph *, int, int); |
| 677 | void scsipi_done(struct scsipi_xfer *); |
| 678 | void scsipi_user_done(struct scsipi_xfer *); |
| 679 | int scsipi_interpret_sense(struct scsipi_xfer *); |
| 680 | void scsipi_wait_drain(struct scsipi_periph *); |
| 681 | void scsipi_kill_pending(struct scsipi_periph *); |
| 682 | struct scsipi_periph *scsipi_alloc_periph(int); |
| 683 | void scsipi_free_periph(struct scsipi_periph *); |
| 684 | |
| 685 | /* Function pointers for scsiverbose module */ |
| 686 | extern int (*scsipi_print_sense)(struct scsipi_xfer *, int); |
| 687 | extern void (*scsipi_print_sense_data)(struct scsi_sense_data *, int); |
| 688 | |
| 689 | int scsipi_print_sense_stub(struct scsipi_xfer *, int); |
| 690 | void scsipi_print_sense_data_stub(struct scsi_sense_data *, int); |
| 691 | |
| 692 | extern int scsi_verbose_loaded; |
| 693 | |
| 694 | void scsipi_print_cdb(struct scsipi_generic *cmd); |
| 695 | int scsipi_thread_call_callback(struct scsipi_channel *, |
| 696 | void (*callback)(struct scsipi_channel *, void *), |
| 697 | void *); |
| 698 | void scsipi_async_event(struct scsipi_channel *, |
| 699 | scsipi_async_event_t, void *); |
| 700 | int scsipi_do_ioctl(struct scsipi_periph *, dev_t, u_long, void *, |
| 701 | int, struct lwp *); |
| 702 | |
| 703 | void scsipi_set_xfer_mode(struct scsipi_channel *, int, int); |
| 704 | |
| 705 | int scsipi_channel_init(struct scsipi_channel *); |
| 706 | void scsipi_channel_shutdown(struct scsipi_channel *); |
| 707 | |
| 708 | void scsipi_insert_periph(struct scsipi_channel *, |
| 709 | struct scsipi_periph *); |
| 710 | void scsipi_remove_periph(struct scsipi_channel *, |
| 711 | struct scsipi_periph *); |
| 712 | struct scsipi_periph *scsipi_lookup_periph(struct scsipi_channel *, |
| 713 | int, int); |
| 714 | struct scsipi_periph *scsipi_lookup_periph_locked(struct scsipi_channel *, |
| 715 | int, int); |
| 716 | int scsipi_target_detach(struct scsipi_channel *, int, int, int); |
| 717 | |
| 718 | int scsipi_adapter_addref(struct scsipi_adapter *); |
| 719 | void scsipi_adapter_delref(struct scsipi_adapter *); |
| 720 | |
| 721 | void scsipi_channel_freeze(struct scsipi_channel *, int); |
| 722 | void scsipi_channel_thaw(struct scsipi_channel *, int); |
| 723 | void scsipi_channel_timed_thaw(void *); |
| 724 | |
| 725 | void scsipi_periph_freeze(struct scsipi_periph *, int); |
| 726 | void scsipi_periph_thaw(struct scsipi_periph *, int); |
| 727 | void scsipi_periph_timed_thaw(void *); |
| 728 | |
| 729 | void scsipi_periph_freeze_locked(struct scsipi_periph *, int); |
| 730 | void scsipi_periph_thaw_locked(struct scsipi_periph *, int); |
| 731 | |
| 732 | int scsipi_sync_period_to_factor(int); |
| 733 | int scsipi_sync_factor_to_period(int); |
| 734 | int scsipi_sync_factor_to_freq(int); |
| 735 | |
| 736 | void show_scsipi_xs(struct scsipi_xfer *); |
| 737 | void show_scsipi_cmd(struct scsipi_xfer *); |
| 738 | void show_mem(u_char *, int); |
| 739 | #endif /* _KERNEL */ |
| 740 | |
| 741 | static __inline void |
| 742 | _lto2b(u_int32_t val, u_int8_t *bytes) |
| 743 | { |
| 744 | |
| 745 | bytes[0] = (val >> 8) & 0xff; |
| 746 | bytes[1] = val & 0xff; |
| 747 | } |
| 748 | |
| 749 | static __inline void |
| 750 | _lto3b(u_int32_t val, u_int8_t *bytes) |
| 751 | { |
| 752 | |
| 753 | bytes[0] = (val >> 16) & 0xff; |
| 754 | bytes[1] = (val >> 8) & 0xff; |
| 755 | bytes[2] = val & 0xff; |
| 756 | } |
| 757 | |
| 758 | static __inline void |
| 759 | _lto4b(u_int32_t val, u_int8_t *bytes) |
| 760 | { |
| 761 | |
| 762 | bytes[0] = (val >> 24) & 0xff; |
| 763 | bytes[1] = (val >> 16) & 0xff; |
| 764 | bytes[2] = (val >> 8) & 0xff; |
| 765 | bytes[3] = val & 0xff; |
| 766 | } |
| 767 | |
| 768 | static __inline void |
| 769 | _lto8b(u_int64_t val, u_int8_t *bytes) |
| 770 | { |
| 771 | |
| 772 | bytes[0] = (val >> 56) & 0xff; |
| 773 | bytes[1] = (val >> 48) & 0xff; |
| 774 | bytes[2] = (val >> 40) & 0xff; |
| 775 | bytes[3] = (val >> 32) & 0xff; |
| 776 | bytes[4] = (val >> 24) & 0xff; |
| 777 | bytes[5] = (val >> 16) & 0xff; |
| 778 | bytes[6] = (val >> 8) & 0xff; |
| 779 | bytes[7] = val & 0xff; |
| 780 | } |
| 781 | |
| 782 | static __inline u_int32_t |
| 783 | _2btol(const u_int8_t *bytes) |
| 784 | { |
| 785 | u_int32_t rv; |
| 786 | |
| 787 | rv = (bytes[0] << 8) | |
| 788 | bytes[1]; |
| 789 | return (rv); |
| 790 | } |
| 791 | |
| 792 | static __inline u_int32_t |
| 793 | _3btol(const u_int8_t *bytes) |
| 794 | { |
| 795 | u_int32_t rv; |
| 796 | |
| 797 | rv = (bytes[0] << 16) | |
| 798 | (bytes[1] << 8) | |
| 799 | bytes[2]; |
| 800 | return (rv); |
| 801 | } |
| 802 | |
| 803 | static __inline u_int32_t |
| 804 | _4btol(const u_int8_t *bytes) |
| 805 | { |
| 806 | u_int32_t rv; |
| 807 | |
| 808 | rv = (bytes[0] << 24) | |
| 809 | (bytes[1] << 16) | |
| 810 | (bytes[2] << 8) | |
| 811 | bytes[3]; |
| 812 | return (rv); |
| 813 | } |
| 814 | |
| 815 | static __inline u_int64_t |
| 816 | _5btol(const u_int8_t *bytes) |
| 817 | { |
| 818 | u_int64_t rv; |
| 819 | |
| 820 | rv = ((u_int64_t)bytes[0] << 32) | |
| 821 | ((u_int64_t)bytes[1] << 24) | |
| 822 | ((u_int64_t)bytes[2] << 16) | |
| 823 | ((u_int64_t)bytes[3] << 8) | |
| 824 | (u_int64_t)bytes[4]; |
| 825 | return (rv); |
| 826 | } |
| 827 | |
| 828 | static __inline u_int64_t |
| 829 | _8btol(const u_int8_t *bytes) |
| 830 | { |
| 831 | u_int64_t rv; |
| 832 | |
| 833 | rv = ((u_int64_t)bytes[0] << 56) | |
| 834 | ((u_int64_t)bytes[1] << 48) | |
| 835 | ((u_int64_t)bytes[2] << 40) | |
| 836 | ((u_int64_t)bytes[3] << 32) | |
| 837 | ((u_int64_t)bytes[4] << 24) | |
| 838 | ((u_int64_t)bytes[5] << 16) | |
| 839 | ((u_int64_t)bytes[6] << 8) | |
| 840 | (u_int64_t)bytes[7]; |
| 841 | return (rv); |
| 842 | } |
| 843 | |
| 844 | static __inline void |
| 845 | _lto2l(u_int32_t val, u_int8_t *bytes) |
| 846 | { |
| 847 | |
| 848 | bytes[0] = val & 0xff; |
| 849 | bytes[1] = (val >> 8) & 0xff; |
| 850 | } |
| 851 | |
| 852 | static __inline void |
| 853 | _lto3l(u_int32_t val, u_int8_t *bytes) |
| 854 | { |
| 855 | |
| 856 | bytes[0] = val & 0xff; |
| 857 | bytes[1] = (val >> 8) & 0xff; |
| 858 | bytes[2] = (val >> 16) & 0xff; |
| 859 | } |
| 860 | |
| 861 | static __inline void |
| 862 | _lto4l(u_int32_t val, u_int8_t *bytes) |
| 863 | { |
| 864 | |
| 865 | bytes[0] = val & 0xff; |
| 866 | bytes[1] = (val >> 8) & 0xff; |
| 867 | bytes[2] = (val >> 16) & 0xff; |
| 868 | bytes[3] = (val >> 24) & 0xff; |
| 869 | } |
| 870 | |
| 871 | static __inline u_int32_t |
| 872 | _2ltol(const u_int8_t *bytes) |
| 873 | { |
| 874 | u_int32_t rv; |
| 875 | |
| 876 | rv = bytes[0] | |
| 877 | (bytes[1] << 8); |
| 878 | return (rv); |
| 879 | } |
| 880 | |
| 881 | static __inline u_int32_t |
| 882 | _3ltol(const u_int8_t *bytes) |
| 883 | { |
| 884 | u_int32_t rv; |
| 885 | |
| 886 | rv = bytes[0] | |
| 887 | (bytes[1] << 8) | |
| 888 | (bytes[2] << 16); |
| 889 | return (rv); |
| 890 | } |
| 891 | |
| 892 | static __inline u_int32_t |
| 893 | _4ltol(const u_int8_t *bytes) |
| 894 | { |
| 895 | u_int32_t rv; |
| 896 | |
| 897 | rv = bytes[0] | |
| 898 | (bytes[1] << 8) | |
| 899 | (bytes[2] << 16) | |
| 900 | (bytes[3] << 24); |
| 901 | return (rv); |
| 902 | } |
| 903 | |
| 904 | #endif /* _DEV_SCSIPI_SCSIPICONF_H_ */ |
| 905 | |