sys/dev/disk/nata/atapi-cam.c

   1 /*-
   2  * Copyright (c) 2001-2003 Thomas Quinot <thomas@cuivre.fr.eu.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer,
  10  *    without modification, immediately at the beginning of the file.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. The name of the author may not be used to endorse or promote products
  15  *    derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * $FreeBSD: src/sys/dev/ata/atapi-cam.c,v 1.44 2006/03/31 08:09:05 sos Exp $
  29  * $DragonFly: src/sys/dev/disk/nata/atapi-cam.c,v 1.5 2007/05/01 00:05:17 dillon Exp $
  30  */
  31
  32 #include "opt_ata.h"
  33 #include "opt_scsi.h"
  34
  35 #include <sys/param.h>
  36 #include <sys/bus.h>
  37 #include <sys/libkern.h>
  38 #include <sys/lock.h>           /* for {get,rel}_mplock() */
  39 #include <sys/malloc.h>
  40 #include <sys/module.h>
  41 #include <sys/nata.h>
  42 #include <sys/spinlock.h>
  43 #include <sys/spinlock2.h>
  44 #include <sys/queue.h>
  45 #include <sys/systm.h>
  46 #include <sys/thread2.h>
  47
  48 #include <bus/cam/cam.h>
  49 #include <bus/cam/cam_ccb.h>
  50 #include <bus/cam/cam_periph.h>
  51 #include <bus/cam/cam_sim.h>
  52 #include <bus/cam/cam_xpt_sim.h>
  53 #include <bus/cam/cam_debug.h>
  54 #include <bus/cam/scsi/scsi_all.h>
  55
  56 #include "ata-all.h"
  57 #include "ata_if.h"
  58
  59 /* private data associated with an ATA bus */
  60 struct atapi_xpt_softc {
  61     struct ata_device   atapi_cam_dev;  /* must be first */
  62     device_t            dev;
  63     device_t            parent;
  64     struct ata_channel  *ata_ch;
  65     struct cam_path     *path;
  66     struct cam_sim      *sim;
  67     int                 flags;
  68 #define BUS_REGISTERED          0x01
  69 #define RESOURCE_SHORTAGE       0x02
  70 #define DETACHING               0x04
  71
  72     TAILQ_HEAD(,atapi_hcb) pending_hcbs;
  73     struct ata_device   *atadev[2];
  74     struct spinlock     state_lock;
  75 };
  76
  77 /* hardware command descriptor block */
  78 struct atapi_hcb {
  79     struct atapi_xpt_softc *softc;
  80     int                 unit;
  81     int                 bus;
  82     int                 target;
  83     int                 lun;
  84     union ccb           *ccb;
  85     int                 flags;
  86 #define QUEUED          0x0001
  87 #define AUTOSENSE       0x0002
  88     char                *dxfer_alloc;
  89     TAILQ_ENTRY(atapi_hcb) chain;
  90 };
  91
  92 enum reinit_reason { ATTACH, RESET };
  93
  94 /* Device methods */
  95 static void atapi_cam_identify(device_t *dev, device_t parent);
  96 static int atapi_cam_probe(device_t dev);
  97 static int atapi_cam_attach(device_t dev);
  98 static int atapi_cam_detach(device_t dev);
  99 static int atapi_cam_reinit(device_t dev);
 100
 101 /* CAM XPT methods */
 102 static void atapi_action(struct cam_sim *, union ccb *);
 103 static void atapi_poll(struct cam_sim *);
 104 static void atapi_async(void *, u_int32_t, struct cam_path *, void *);
 105 static void atapi_cb(struct ata_request *);
 106
 107 /* Module methods */
 108 static int atapi_cam_event_handler(module_t mod, int what, void *arg);
 109
 110 /* internal functions */
 111 static void reinit_bus(struct atapi_xpt_softc *scp, enum reinit_reason reason);
 112 static void setup_async_cb(struct atapi_xpt_softc *, uint32_t);
 113 static void cam_rescan_callback(struct cam_periph *, union ccb *);
 114 static void cam_rescan(struct cam_sim *);
 115 static void free_hcb_and_ccb_done(struct atapi_hcb *, u_int32_t);
 116 static struct atapi_hcb *allocate_hcb(struct atapi_xpt_softc *, int, int, union ccb *);
 117 static void free_hcb(struct atapi_hcb *hcb);
 118 static void free_softc(struct atapi_xpt_softc *scp);
 119
 120 static MALLOC_DEFINE(M_ATACAM, "ata_cam", "ATA driver CAM-XPT layer");
 121
 122 static device_method_t atapi_cam_methods[] = {
 123         DEVMETHOD(device_identify,      atapi_cam_identify),
 124         DEVMETHOD(device_probe,         atapi_cam_probe),
 125         DEVMETHOD(device_attach,        atapi_cam_attach),
 126         DEVMETHOD(device_detach,        atapi_cam_detach),
 127         DEVMETHOD(ata_reinit,           atapi_cam_reinit),
 128         {0, 0}
 129 };
 130
 131 static driver_t atapi_cam_driver = {
 132         "atapicam",
 133         atapi_cam_methods,
 134         sizeof(struct atapi_xpt_softc)
 135 };
 136
 137 static devclass_t       atapi_cam_devclass;
 138 DRIVER_MODULE(atapicam, ata,
 139         atapi_cam_driver,
 140         atapi_cam_devclass,
 141         atapi_cam_event_handler,
 142         /*arg*/NULL);
 143 MODULE_VERSION(atapicam, 1);
 144 MODULE_DEPEND(atapicam, ata, 1, 1, 1);
 145 MODULE_DEPEND(atapicam, cam, 1, 1, 1);
 146
 147 static void
 148 atapi_cam_identify(device_t *dev, device_t parent)
 149 {
 150         struct atapi_xpt_softc *scp =
 151             kmalloc(sizeof(struct atapi_xpt_softc), M_ATACAM, M_NOWAIT|M_ZERO);
 152         device_t child;
 153
 154         if (scp == NULL) {
 155                 /* XXX TGEN Use device_printf()? */
 156                 kprintf("atapi_cam_identify: out of memory");
 157                 return;
 158         }
 159
 160         /* Assume one atapicam instance per parent channel instance. */
 161         child = device_add_child(parent, "atapicam", -1);
 162         if (child == NULL) {
 163                 /* XXX TGEN Use device_printf()? */
 164                 kprintf("atapi_cam_identify: out of memory, can't add child");
 165                 kfree(scp, M_ATACAM);
 166                 return;
 167         }
 168         scp->atapi_cam_dev.unit = -1;
 169         scp->atapi_cam_dev.dev = child;
 170         device_quiet(child);
 171         device_set_softc(child, scp);
 172 }
 173
 174 static int
 175 atapi_cam_probe(device_t dev)
 176 {
 177         struct ata_device *atadev = device_get_softc (dev);
 178
 179         KASSERT(atadev != NULL, ("expect valid struct ata_device"));
 180         if (atadev->unit < 0) {
 181                 device_set_desc(dev, "ATAPI CAM Attachment");
 182                 return(0);
 183         } else {
 184                 return ENXIO;
 185         }
 186 }
 187
 188 static int
 189 atapi_cam_attach(device_t dev)
 190 {
 191     struct atapi_xpt_softc *scp = NULL;
 192     struct cam_devq *devq = NULL;
 193     struct cam_sim *sim = NULL;
 194     struct cam_path *path = NULL;
 195     int unit, error;
 196
 197     scp = (struct atapi_xpt_softc *)device_get_softc(dev);
 198     if (scp == NULL) {
 199         device_printf(dev, "Cannot get softc\n");
 200         return ENOMEM;
 201     }
 202
 203     spin_init(&scp->state_lock);
 204
 205     scp->dev = dev;
 206     scp->parent = device_get_parent(dev);
 207     scp->ata_ch = device_get_softc(scp->parent);
 208     TAILQ_INIT(&scp->pending_hcbs);
 209     unit = device_get_unit(dev);
 210
 211     if ((devq = cam_simq_alloc(16)) == NULL) {
 212         error = ENOMEM;
 213         goto out;
 214     }
 215
 216     if ((sim = cam_sim_alloc(atapi_action, atapi_poll, "ata",
 217                  (void *)scp, unit, 1, 1, devq)) == NULL) {
 218         error = ENOMEM;
 219         goto out;
 220     }
 221     scp->sim = sim;
 222
 223     if (xpt_bus_register(sim, 0) != CAM_SUCCESS) {
 224         error = EINVAL;
 225         goto out;
 226     }
 227     scp->flags |= BUS_REGISTERED;
 228
 229     if (xpt_create_path(&path, /*periph*/ NULL,
 230                 cam_sim_path(sim), CAM_TARGET_WILDCARD,
 231                 CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
 232         error = ENOMEM;
 233         goto out;
 234     }
 235     scp->path = path;
 236
 237     CAM_DEBUG(path, CAM_DEBUG_TRACE, ("Registered SIM for ata%d\n", unit));
 238
 239     setup_async_cb(scp, AC_LOST_DEVICE);
 240     reinit_bus(scp, ATTACH);
 241     error = 0;
 242
 243 out:
 244     if (error != 0)
 245         free_softc(scp);
 246
 247     return(error);
 248 }
 249
 250 static int
 251 atapi_cam_detach(device_t dev)
 252 {
 253     struct atapi_xpt_softc *scp = device_get_softc(dev);
 254
 255     get_mplock();
 256     xpt_freeze_simq(scp->sim, 1 /*count*/);
 257     rel_mplock();
 258     spin_lock_wr(&scp->state_lock);
 259     scp->flags |= DETACHING;
 260     spin_unlock_wr(&scp->state_lock);
 261     free_softc(scp);
 262     return (0);
 263 }
 264
 265 static int
 266 atapi_cam_reinit(device_t dev) {
 267     struct atapi_xpt_softc *scp = device_get_softc(dev);
 268
 269     /*
 270      * scp might be null if the bus is being reinitialised during
 271      * the boot-up sequence, before the ATAPI bus is registered.
 272      */
 273
 274     if (scp != NULL) {
 275         reinit_bus(scp, RESET);
 276     }
 277     return 0;
 278 }
 279
 280 static void
 281 reinit_bus(struct atapi_xpt_softc *scp, enum reinit_reason reason) {
 282     struct ata_device *atadev;
 283     device_t *children;
 284     int nchildren, i;
 285
 286     if (device_get_children(scp->parent, &children, &nchildren) != 0) {
 287         return;
 288     }
 289
 290     spin_lock_wr(&scp->state_lock);
 291     scp->atadev[0] = NULL;
 292     scp->atadev[1] = NULL;
 293
 294     for (i = 0; i < nchildren; i++) {
 295         /* XXX Does the child need to actually be attached yet? */
 296         if (children[i] != NULL) {
 297             atadev = device_get_softc(children[i]);
 298             if ((atadev->unit == ATA_MASTER) &&
 299                 (scp->ata_ch->devices & ATA_ATAPI_MASTER) != 0)
 300                 scp->atadev[0] = atadev;
 301             if ((atadev->unit == ATA_SLAVE) &&
 302                 (scp->ata_ch->devices & ATA_ATAPI_SLAVE) != 0)
 303                 scp->atadev[1] = atadev;
 304         }
 305     }
 306     spin_unlock_wr(&scp->state_lock);
 307     kfree(children, M_TEMP);
 308
 309     switch (reason) {
 310         case RESET:
 311             xpt_async(AC_BUS_RESET, scp->path, NULL);
 312             /*FALLTHROUGH*/
 313         case ATTACH:
 314             cam_rescan(scp->sim);
 315             break;
 316     }
 317 }
 318
 319 static void
 320 setup_async_cb(struct atapi_xpt_softc *scp, uint32_t events)
 321 {
 322     struct ccb_setasync csa;
 323
 324     get_mplock();
 325     xpt_setup_ccb(&csa.ccb_h, scp->path, /*priority*/ 5);
 326     csa.ccb_h.func_code = XPT_SASYNC_CB;
 327     csa.event_enable = events;
 328     csa.callback = &atapi_async;
 329     csa.callback_arg = scp->sim;
 330     xpt_action((union ccb *) &csa);
 331     rel_mplock();
 332 }
 333
 334 static void
 335 atapi_action(struct cam_sim *sim, union ccb *ccb)
 336 {
 337     struct atapi_xpt_softc *softc = (struct atapi_xpt_softc*)cam_sim_softc(sim);
 338     struct ccb_hdr *ccb_h = &ccb->ccb_h;
 339     struct atapi_hcb *hcb = NULL;
 340     struct ata_request *request = NULL;
 341     int unit = cam_sim_unit(sim);
 342     int bus = cam_sim_bus(sim);
 343     int len;
 344     char *buf;
 345
 346     switch (ccb_h->func_code) {
 347     case XPT_PATH_INQ: {
 348         struct ccb_pathinq *cpi = &ccb->cpi;
 349         int tid = ccb_h->target_id;
 350
 351         cpi->version_num = 1;
 352         cpi->hba_inquiry = 0;
 353         cpi->target_sprt = 0;
 354         cpi->hba_misc = PIM_NO_6_BYTE;
 355         cpi->hba_eng_cnt = 0;
 356         bzero(cpi->vuhba_flags, sizeof(cpi->vuhba_flags));
 357         cpi->max_target = 1;
 358         cpi->max_lun = 0;
 359         cpi->async_flags = 0;
 360         cpi->hpath_id = 0;
 361         cpi->initiator_id = 7;
 362         strncpy(cpi->sim_vid, "FreeBSD", sizeof(cpi->sim_vid));
 363         strncpy(cpi->hba_vid, "ATAPI", sizeof(cpi->hba_vid));
 364         strncpy(cpi->dev_name, cam_sim_name(sim), sizeof cpi->dev_name);
 365         cpi->unit_number = cam_sim_unit(sim);
 366         cpi->bus_id = cam_sim_bus(sim);
 367         cpi->base_transfer_speed = 3300;
 368
 369         if (softc->ata_ch && tid != CAM_TARGET_WILDCARD) {
 370             spin_lock_wr(&softc->state_lock);
 371             if (softc->atadev[tid] == NULL) {
 372                 ccb->ccb_h.status = CAM_DEV_NOT_THERE;
 373                 xpt_done(ccb);
 374                 spin_unlock_wr(&softc->state_lock);
 375                 return;
 376             }
 377             switch (softc->atadev[ccb_h->target_id]->mode) {
 378             case ATA_PIO1:
 379                 cpi->base_transfer_speed = 5200;
 380                 break;
 381             case ATA_PIO2:
 382                 cpi->base_transfer_speed = 7000;
 383                 break;
 384             case ATA_PIO3:
 385                 cpi->base_transfer_speed = 11000;
 386                 break;
 387             case ATA_PIO4:
 388             case ATA_DMA:
 389             case ATA_WDMA2:
 390                 cpi->base_transfer_speed = 16000;
 391                 break;
 392             case ATA_UDMA2:
 393                 cpi->base_transfer_speed = 33000;
 394                 break;
 395             case ATA_UDMA4:
 396                 cpi->base_transfer_speed = 66000;
 397                 break;
 398             case ATA_UDMA5:
 399                 cpi->base_transfer_speed = 100000;
 400                 break;
 401             case ATA_UDMA6:
 402                 cpi->base_transfer_speed = 133000;
 403                 break;
 404             default:
 405                 break;
 406             }
 407             spin_unlock_wr(&softc->state_lock);
 408         }
 409         ccb->ccb_h.status = CAM_REQ_CMP;
 410         xpt_done(ccb);
 411         return;
 412     }
 413
 414     case XPT_RESET_DEV: {
 415         int tid = ccb_h->target_id;
 416
 417         CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_SUBTRACE, ("dev reset\n"));
 418         ata_controlcmd(softc->atadev[tid]->dev, ATA_DEVICE_RESET, 0, 0, 0);
 419         ccb->ccb_h.status = CAM_REQ_CMP;
 420         xpt_done(ccb);
 421         return;
 422     }
 423
 424     case XPT_RESET_BUS:
 425         CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_SUBTRACE, ("bus reset\n"));
 426         ata_reinit(softc->parent);
 427         ccb->ccb_h.status = CAM_REQ_CMP;
 428         xpt_done(ccb);
 429         return;
 430
 431     case XPT_SET_TRAN_SETTINGS:
 432         /* ignore these, we're not doing SCSI here */
 433         CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_SUBTRACE,
 434                   ("SET_TRAN_SETTINGS not supported\n"));
 435         ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
 436         xpt_done(ccb);
 437         return;
 438
 439     case XPT_GET_TRAN_SETTINGS: {
 440         struct ccb_trans_settings *cts = &ccb->cts;
 441
 442         /*
 443          * XXX The default CAM transport code is very SCSI-specific and
 444          * doesn't understand IDE speeds very well. Be silent about it
 445          * here and let it default to what is set in XPT_PATH_INQ
 446          */
 447         CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_SUBTRACE, ("GET_TRAN_SETTINGS\n"));
 448         cts->valid = (CCB_TRANS_DISC_VALID | CCB_TRANS_TQ_VALID);
 449         cts->flags &= ~(CCB_TRANS_DISC_ENB | CCB_TRANS_TAG_ENB);
 450         ccb->ccb_h.status = CAM_REQ_CMP;
 451         xpt_done(ccb);
 452         return;
 453     }
 454
 455     case XPT_CALC_GEOMETRY: {
 456         CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_SUBTRACE, ("CALC_GEOMETRY\n"));
 457         cam_calc_geometry(&ccb->ccg, /*extended*/1);
 458         xpt_done(ccb);
 459         return;
 460     }
 461
 462     case XPT_SCSI_IO: {
 463         struct ccb_scsiio *csio = &ccb->csio;
 464         int tid = ccb_h->target_id, lid = ccb_h->target_lun;
 465         int request_flags = ATA_R_QUIET | ATA_R_ATAPI;
 466
 467         CAM_DEBUG(ccb_h->path, CAM_DEBUG_SUBTRACE, ("XPT_SCSI_IO\n"));
 468
 469         spin_lock_wr(&softc->state_lock);
 470         if (softc->flags & DETACHING) {
 471             ccb->ccb_h.status = CAM_REQ_ABORTED;
 472             xpt_done(ccb);
 473             spin_unlock_wr(&softc->state_lock);
 474             return;
 475         }
 476
 477         if (softc->atadev[tid] == NULL) {
 478             ccb->ccb_h.status = CAM_DEV_NOT_THERE;
 479             xpt_done(ccb);
 480             spin_unlock_wr(&softc->state_lock);
 481             return;
 482         }
 483
 484         /* check that this request was not aborted already */
 485         if ((ccb_h->status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
 486             kprintf("XPT_SCSI_IO received but already in progress?\n");
 487             xpt_done(ccb);
 488             spin_unlock_wr(&softc->state_lock);
 489             return;
 490         }
 491         if (lid > 0) {
 492             CAM_DEBUG(ccb_h->path, CAM_DEBUG_SUBTRACE,
 493                       ("SCSI IO received for invalid lun %d\n", lid));
 494             goto action_invalid;
 495         }
 496         if (csio->cdb_len > sizeof request->u.atapi.ccb) {
 497             CAM_DEBUG(ccb_h->path, CAM_DEBUG_SUBTRACE,
 498                 ("CAM CCB too long for ATAPI"));
 499             goto action_invalid;
 500         }
 501         if ((ccb_h->flags & CAM_SCATTER_VALID)) {
 502             /* scatter-gather not supported */
 503             xpt_print_path(ccb_h->path);
 504             kprintf("ATAPI/CAM does not support scatter-gather yet!\n");
 505             goto action_invalid;
 506         }
 507
 508         switch (ccb_h->flags & CAM_DIR_MASK) {
 509         case CAM_DIR_IN:
 510              request_flags |= ATA_R_READ|ATA_R_DMA;
 511              break;
 512         case CAM_DIR_OUT:
 513              request_flags |= ATA_R_WRITE|ATA_R_DMA;
 514              break;
 515         case CAM_DIR_NONE:
 516              /* No flags need to be set */
 517              break;
 518         default:
 519              device_printf(softc->dev, "unknown IO operation\n");
 520              goto action_invalid;
 521         }
 522         if (softc->atadev[tid]->mode < ATA_DMA)
 523             request_flags &= ~ATA_R_DMA;
 524
 525         if ((hcb = allocate_hcb(softc, unit, bus, ccb)) == NULL) {
 526             kprintf("cannot allocate ATAPI/CAM hcb\n");
 527             goto action_oom;
 528         }
 529         if ((request = ata_alloc_request()) == NULL) {
 530             kprintf("cannot allocate ATAPI/CAM request\n");
 531             goto action_oom;
 532         }
 533
 534         bcopy((ccb_h->flags & CAM_CDB_POINTER) ?
 535               csio->cdb_io.cdb_ptr : csio->cdb_io.cdb_bytes,
 536               request->u.atapi.ccb, csio->cdb_len);
 537 #ifdef CAMDEBUG
 538         if (CAM_DEBUGGED(ccb_h->path, CAM_DEBUG_CDB)) {
 539                 char cdb_str[(SCSI_MAX_CDBLEN * 3) + 1];
 540
 541                 kprintf("atapi_action: hcb@%p: %s\n", hcb,
 542                        scsi_cdb_string(request->u.atapi.ccb, cdb_str, sizeof(cdb_str)));
 543         }
 544 #endif
 545
 546         len = csio->dxfer_len;
 547         buf = csio->data_ptr;
 548
 549         /* some SCSI commands require special processing */
 550         switch (request->u.atapi.ccb[0]) {
 551         case INQUIRY: {
 552             /*
 553              * many ATAPI devices seem to report more than
 554              * SHORT_INQUIRY_LENGTH bytes of available INQUIRY
 555              * information, but respond with some incorrect condition
 556              * when actually asked for it, so we are going to pretend
 557              * that only SHORT_INQUIRY_LENGTH are expected, anyway.
 558              */
 559             struct scsi_inquiry *inq = (struct scsi_inquiry *) &request->u.atapi.ccb[0];
 560
 561             if (inq->byte2 == 0 && inq->page_code == 0 &&
 562                 inq->length > SHORT_INQUIRY_LENGTH) {
 563                 bzero(buf, len);
 564                 len = inq->length = SHORT_INQUIRY_LENGTH;
 565             }
 566             break;
 567         }
 568         case READ_6:
 569             /* FALLTHROUGH */
 570
 571         case WRITE_6:
 572             CAM_DEBUG(ccb_h->path, CAM_DEBUG_SUBTRACE,
 573                       ("Translating %s into _10 equivalent\n",
 574                       (request->u.atapi.ccb[0] == READ_6) ? "READ_6" : "WRITE_6"));
 575             request->u.atapi.ccb[0] |= 0x20;
 576             request->u.atapi.ccb[9] = request->u.atapi.ccb[5];
 577             request->u.atapi.ccb[8] = request->u.atapi.ccb[4];
 578             request->u.atapi.ccb[7] = 0;
 579             request->u.atapi.ccb[6] = 0;
 580             request->u.atapi.ccb[5] = request->u.atapi.ccb[3];
 581             request->u.atapi.ccb[4] = request->u.atapi.ccb[2];
 582             request->u.atapi.ccb[3] = request->u.atapi.ccb[1] & 0x1f;
 583             request->u.atapi.ccb[2] = 0;
 584             request->u.atapi.ccb[1] = 0;
 585             break;
 586         }
 587
 588         if ((ccb_h->flags & CAM_DIR_MASK) == CAM_DIR_IN && (len & 1)) {
 589             /* ATA always transfers an even number of bytes */
 590             if ((buf = hcb->dxfer_alloc
 591                  = kmalloc(++len, M_ATACAM, M_NOWAIT | M_ZERO)) == NULL) {
 592                 kprintf("cannot allocate ATAPI/CAM buffer\n");
 593                 goto action_oom;
 594             }
 595         }
 596         request->dev = softc->atadev[tid]->dev;
 597         request->driver = hcb;
 598         request->data = buf;
 599         request->bytecount = len;
 600         request->transfersize = min(request->bytecount, 65534);
 601         request->timeout = ccb_h->timeout / 1000; /* XXX lost granularity */
 602         request->retries = 2;
 603         request->callback = &atapi_cb;
 604         request->flags = request_flags;
 605
 606         TAILQ_INSERT_TAIL(&softc->pending_hcbs, hcb, chain);
 607         hcb->flags |= QUEUED;
 608         ccb_h->status |= CAM_SIM_QUEUED;
 609         spin_unlock_wr(&softc->state_lock);
 610
 611         ata_queue_request(request);
 612         return;
 613     }
 614
 615     default:
 616         CAM_DEBUG(ccb_h->path, CAM_DEBUG_SUBTRACE,
 617                   ("unsupported function code 0x%02x\n", ccb_h->func_code));
 618         goto action_invalid;
 619     }
 620
 621     /* NOTREACHED */
 622
 623 action_oom:
 624     if (request != NULL)
 625         ata_free_request(request);
 626     if (hcb != NULL)
 627         free_hcb(hcb);
 628     spin_unlock_wr(&softc->state_lock);
 629     get_mplock();
 630     xpt_print_path(ccb_h->path);
 631     kprintf("out of memory, freezing queue.\n");
 632     softc->flags |= RESOURCE_SHORTAGE;
 633     xpt_freeze_simq(sim, /*count*/ 1);
 634     rel_mplock();
 635     ccb_h->status = CAM_REQUEUE_REQ;
 636     xpt_done(ccb);
 637     return;
 638
 639 action_invalid:
 640     spin_unlock_wr(&softc->state_lock);
 641     ccb_h->status = CAM_REQ_INVALID;
 642     xpt_done(ccb);
 643     return;
 644 }
 645
 646 static void
 647 atapi_poll(struct cam_sim *sim)
 648 {
 649     /* do nothing - we do not actually service any interrupts */
 650     kprintf("atapi_poll called!\n");
 651 }
 652
 653 static void
 654 atapi_cb(struct ata_request *request)
 655 {
 656     struct atapi_xpt_softc *scp;
 657     struct atapi_hcb *hcb;
 658     struct ccb_scsiio *csio;
 659     u_int32_t rc;
 660
 661     hcb = (struct atapi_hcb *)request->driver;
 662     scp = hcb->softc;
 663     csio = &hcb->ccb->csio;
 664
 665 #ifdef CAMDEBUG
 666 # define err (request->u.atapi.sense.key)
 667     if (CAM_DEBUGGED(csio->ccb_h.path, CAM_DEBUG_CDB)) {
 668         kprintf("atapi_cb: hcb@%p error = %02x: (sk = %02x%s%s%s)\n",
 669                hcb, err, err >> 4,
 670                (err & 4) ? " ABRT" : "",
 671                (err & 2) ? " EOM" : "",
 672                (err & 1) ? " ILI" : "");
 673         kprintf("dev %s: cmd %02x status %02x result %02x\n",
 674             device_get_nameunit(request->dev), request->u.atapi.ccb[0],
 675             request->status, request->result);
 676     }
 677 #endif
 678
 679     if ((hcb->flags & AUTOSENSE) != 0) {
 680         rc = CAM_SCSI_STATUS_ERROR;
 681         if (request->result == 0) {
 682             csio->ccb_h.status |= CAM_AUTOSNS_VALID;
 683         }
 684     } else if (request->result != 0) {
 685         rc = CAM_SCSI_STATUS_ERROR;
 686         csio->scsi_status = SCSI_STATUS_CHECK_COND;
 687
 688         if ((csio->ccb_h.flags & CAM_DIS_AUTOSENSE) == 0) {
 689 #if 0
 690             static const int8_t ccb[16] = { ATAPI_REQUEST_SENSE, 0, 0, 0,
 691                 sizeof(struct atapi_sense), 0, 0, 0, 0, 0, 0,
 692                 0, 0, 0, 0, 0 };
 693
 694             bcopy (ccb, request->u.atapi.ccb, sizeof ccb);
 695             request->data = (caddr_t)&csio->sense_data;
 696             request->bytecount = sizeof(struct atapi_sense);
 697             request->transfersize = min(request->bytecount, 65534);
 698             request->timeout = csio->ccb_h.timeout / 1000;
 699             request->retries = 2;
 700             request->flags = ATA_R_QUIET|ATA_R_ATAPI|ATA_R_IMMEDIATE;
 701             hcb->flags |= AUTOSENSE;
 702
 703             ata_queue_request(request);
 704             return;
 705 #else
 706             /* The ATA driver has already requested sense for us. */
 707             if (request->error == 0) {
 708                 /* The ATA autosense suceeded. */
 709                 bcopy (&request->u.atapi.sense, &csio->sense_data, sizeof(struct atapi_sense));
 710                 csio->ccb_h.status |= CAM_AUTOSNS_VALID;
 711             }
 712 #endif
 713         }
 714     } else {
 715         rc = CAM_REQ_CMP;
 716         csio->scsi_status = SCSI_STATUS_OK;
 717         if (((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_IN) &&
 718             hcb->dxfer_alloc != NULL)
 719         {
 720             bcopy(hcb->dxfer_alloc, csio->data_ptr, csio->dxfer_len);
 721         }
 722     }
 723
 724     spin_lock_wr(&scp->state_lock);
 725     free_hcb_and_ccb_done(hcb, rc);
 726     spin_unlock_wr(&scp->state_lock);
 727
 728     ata_free_request(request);
 729 }
 730
 731 static void
 732 free_hcb_and_ccb_done(struct atapi_hcb *hcb, u_int32_t status)
 733 {
 734     struct atapi_xpt_softc *softc;
 735     union ccb *ccb;
 736
 737     if (hcb == NULL)
 738         return;
 739
 740     softc = hcb->softc;
 741     ccb = hcb->ccb;
 742
 743     /* we're about to free a hcb, so the shortage has ended */
 744     if (softc->flags & RESOURCE_SHORTAGE) {
 745         softc->flags &= ~RESOURCE_SHORTAGE;
 746         status |= CAM_RELEASE_SIMQ;
 747     }
 748     free_hcb(hcb);
 749     ccb->ccb_h.status =
 750         status | (ccb->ccb_h.status & ~(CAM_STATUS_MASK | CAM_SIM_QUEUED));
 751     xpt_done(ccb);
 752 }
 753
 754 static void
 755 atapi_async(void *callback_arg, u_int32_t code,
 756              struct cam_path* path, void *arg)
 757 {
 758     struct atapi_xpt_softc *softc;
 759     struct cam_sim *sim;
 760     int targ;
 761
 762     crit_enter();
 763
 764     sim = (struct cam_sim *) callback_arg;
 765     softc = (struct atapi_xpt_softc *) cam_sim_softc(sim);
 766     switch (code) {
 767     case AC_LOST_DEVICE:
 768         targ = xpt_path_target_id(path);
 769         xpt_print_path(path);
 770         if (targ == -1)
 771                 kprintf("Lost host adapter\n");
 772         else
 773                 kprintf("Lost target %d???\n", targ);
 774         break;
 775
 776     default:
 777         break;
 778     }
 779
 780     crit_exit();
 781 }
 782
 783 static void
 784 cam_rescan_callback(struct cam_periph *periph, union ccb *ccb)
 785 {
 786         if (ccb->ccb_h.status != CAM_REQ_CMP) {
 787             CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_TRACE,
 788                       ("Rescan failed, 0x%04x\n", ccb->ccb_h.status));
 789         } else {
 790             CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_TRACE,
 791                       ("Rescan succeeded\n"));
 792         }
 793         xpt_free_path(ccb->ccb_h.path);
 794         kfree(ccb, M_ATACAM);
 795 }
 796
 797 static void
 798 cam_rescan(struct cam_sim *sim)
 799 {
 800     struct cam_path *path;
 801     union ccb *ccb = kmalloc(sizeof(union ccb), M_ATACAM, M_WAITOK | M_ZERO);
 802
 803     get_mplock();
 804     if (xpt_create_path(&path, xpt_periph, cam_sim_path(sim),
 805                         CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
 806         rel_mplock();
 807         kfree(ccb, M_ATACAM);
 808         return;
 809     }
 810
 811     CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_TRACE, ("Rescanning ATAPI bus.\n"));
 812     xpt_setup_ccb(&ccb->ccb_h, path, 5/*priority (low)*/);
 813     ccb->ccb_h.func_code = XPT_SCAN_BUS;
 814     ccb->ccb_h.cbfcnp = cam_rescan_callback;
 815     ccb->crcn.flags = CAM_FLAG_NONE;
 816     xpt_action(ccb);
 817     /* scan is in progress now */
 818     rel_mplock();
 819 }
 820
 821 static struct atapi_hcb *
 822 allocate_hcb(struct atapi_xpt_softc *softc, int unit, int bus, union ccb *ccb)
 823 {
 824     struct atapi_hcb *hcb = (struct atapi_hcb *)
 825     kmalloc(sizeof(struct atapi_hcb), M_ATACAM, M_NOWAIT | M_ZERO);
 826
 827     if (hcb != NULL) {
 828         hcb->softc = softc;
 829         hcb->unit = unit;
 830         hcb->bus = bus;
 831         hcb->ccb = ccb;
 832     }
 833     return hcb;
 834 }
 835
 836 static void
 837 free_hcb(struct atapi_hcb *hcb)
 838 {
 839     if ((hcb->flags & QUEUED) != 0)
 840         TAILQ_REMOVE(&hcb->softc->pending_hcbs, hcb, chain);
 841     if (hcb->dxfer_alloc != NULL)
 842         kfree(hcb->dxfer_alloc, M_ATACAM);
 843     kfree(hcb, M_ATACAM);
 844 }
 845
 846 static void
 847 free_softc(struct atapi_xpt_softc *scp)
 848 {
 849     struct atapi_hcb *hcb;
 850
 851     if (scp != NULL) {
 852         spin_lock_wr(&scp->state_lock);
 853         TAILQ_FOREACH(hcb, &scp->pending_hcbs, chain) {
 854             free_hcb_and_ccb_done(hcb, CAM_UNREC_HBA_ERROR);
 855         }
 856         spin_unlock_wr(&scp->state_lock);
 857         get_mplock();
 858         if (scp->path != NULL) {
 859             setup_async_cb(scp, 0);
 860             xpt_free_path(scp->path);
 861         }
 862         if ((scp->flags & BUS_REGISTERED) != 0) {
 863             if (xpt_bus_deregister(cam_sim_path(scp->sim)) == CAM_REQ_CMP)
 864                 scp->flags &= ~BUS_REGISTERED;
 865         }
 866         if (scp->sim != NULL) {
 867             if ((scp->flags & BUS_REGISTERED) == 0)
 868                 cam_sim_free(scp->sim);
 869             else
 870                 kprintf("Can't free %s SIM (still registered)\n",
 871                        cam_sim_name(scp->sim));
 872         }
 873         rel_mplock();
 874         spin_uninit(&scp->state_lock);
 875     }
 876 }
 877
 878 static int
 879 atapi_cam_event_handler(module_t mod, int what, void *arg) {
 880     device_t *devlist;
 881     int devcount;
 882
 883     switch (what) {
 884         case MOD_UNLOAD:
 885             if (devclass_get_devices(atapi_cam_devclass, &devlist, &devcount)
 886                   != 0)
 887                 return ENXIO;
 888             if (devlist != NULL) {
 889                 while (devlist != NULL && devcount > 0) {
 890                     device_t child = devlist[--devcount];
 891                     struct atapi_xpt_softc *scp = device_get_softc(child);
 892
 893                     device_delete_child(device_get_parent(child),child);
 894                     if (scp != NULL)
 895                         kfree(scp, M_ATACAM);
 896                 }
 897                 kfree(devlist, M_TEMP);
 898             }
 899             break;
 900
 901         default:
 902             break;
 903     }
 904     return 0;
 905 }