2 * Copyright (c) 2001,2002 Thomas Quinot <thomas@cuivre.fr.eu.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
28 * $FreeBSD: src/sys/dev/ata/atapi-cam.c,v 1.10.2.3 2003/05/21 09:24:55 thomas Exp $
29 * $DragonFly: src/sys/dev/disk/ata/atapi-cam.c,v 1.7 2004/04/07 06:22:15 dillon Exp $
32 #include <sys/param.h>
33 #include <sys/systm.h>
35 #include <sys/devicestat.h>
36 #include <sys/kernel.h>
37 #include <sys/malloc.h>
39 #include <machine/bus.h>
41 #include <bus/cam/cam.h>
42 #include <bus/cam/cam_ccb.h>
43 #include <bus/cam/cam_periph.h>
44 #include <bus/cam/cam_sim.h>
45 #include <bus/cam/cam_xpt_sim.h>
46 #include <bus/cam/cam_debug.h>
47 #include <bus/cam/scsi/scsi_all.h>
50 #include "atapi-all.h"
52 /* hardware command descriptor block */
54 struct atapi_xpt_softc *softc;
60 u_int8_t cmd[CAM_MAX_CDBLEN];
62 #define DOING_AUTOSENSE 1
65 TAILQ_ENTRY(atapi_hcb) chain;
68 /* private data associated with an ATA bus */
69 struct atapi_xpt_softc {
70 struct ata_channel *ata_ch;
71 struct cam_path *path;
74 #define BUS_REGISTERED 0x01
75 #define RESOURCE_SHORTAGE 0x02
77 TAILQ_HEAD(,atapi_hcb) pending_hcbs;
78 LIST_ENTRY(atapi_xpt_softc) chain;
81 enum reinit_reason { BOOT_ATTACH, ATTACH, RESET };
83 static LIST_HEAD(,atapi_xpt_softc) all_buses = LIST_HEAD_INITIALIZER(all_buses);
86 static void atapi_action(struct cam_sim *, union ccb *);
87 static void atapi_poll(struct cam_sim *);
88 static void atapi_async(void *, u_int32_t, struct cam_path *, void *);
89 static void atapi_async1(void *, u_int32_t, struct cam_path *, void *);
90 static int atapi_cb(struct atapi_request *);
92 /* internal functions */
93 static void reinit_bus(struct atapi_xpt_softc *scp, enum reinit_reason reason);
94 static void setup_dev(struct atapi_xpt_softc *, struct ata_device *);
95 static void setup_async_cb(struct atapi_xpt_softc *, uint32_t);
96 static void cam_rescan_callback(struct cam_periph *, union ccb *);
97 static void cam_rescan(struct cam_sim *);
98 static void free_hcb_and_ccb_done(struct atapi_hcb *, u_int32_t);
99 static struct atapi_hcb *allocate_hcb(struct atapi_xpt_softc *, int, int, union ccb *);
100 static void free_hcb(struct atapi_hcb *hcb);
101 static void free_softc(struct atapi_xpt_softc *scp);
102 static struct atapi_xpt_softc *get_softc(struct ata_channel *ata_ch);
103 static struct ata_device *get_ata_device(struct atapi_xpt_softc *scp, int id);
105 static MALLOC_DEFINE(M_ATACAM, "ATA CAM transport", "ATA driver CAM-XPT layer");
108 atapi_cam_attach_bus(struct ata_channel *ata_ch)
110 struct atapi_xpt_softc *scp = NULL;
111 struct cam_devq *devq = NULL;
112 struct cam_sim *sim = NULL;
113 struct cam_path *path = NULL;
116 LIST_FOREACH(scp, &all_buses, chain) {
117 if (scp->ata_ch == ata_ch)
121 scp = malloc(sizeof(struct atapi_xpt_softc), M_ATACAM, M_INTWAIT | M_ZERO);
122 scp->ata_ch = ata_ch;
123 TAILQ_INIT(&scp->pending_hcbs);
124 LIST_INSERT_HEAD(&all_buses, scp, chain);
125 unit = device_get_unit(ata_ch->dev);
127 devq = cam_simq_alloc(16);
128 sim = cam_sim_alloc(atapi_action, atapi_poll, "ata", (void *)scp,
130 cam_simq_release(devq);
135 if (xpt_bus_register(sim, 0) != CAM_SUCCESS) {
138 scp->flags |= BUS_REGISTERED;
140 if (xpt_create_path(&path, /*periph*/ NULL,
141 cam_sim_path(sim), CAM_TARGET_WILDCARD,
142 CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
147 CAM_DEBUG(path, CAM_DEBUG_TRACE, ("Registered SIM for ata%d\n", unit));
149 setup_async_cb(scp, AC_LOST_DEVICE);
150 reinit_bus(scp, cold ? BOOT_ATTACH : ATTACH);
158 atapi_cam_detach_bus(struct ata_channel *ata_ch)
160 struct atapi_xpt_softc *scp = get_softc(ata_ch);
165 atapi_cam_reinit_bus(struct ata_channel *ata_ch) {
166 struct atapi_xpt_softc *scp = get_softc(ata_ch);
169 * scp might be null if the bus is being reinitialised during
170 * the boot-up sequence, before the ATAPI bus is registered.
174 reinit_bus(scp, RESET);
178 reinit_bus(struct atapi_xpt_softc *scp, enum reinit_reason reason) {
179 if (scp->ata_ch->devices & ATA_ATAPI_MASTER)
180 setup_dev(scp, &scp->ata_ch->device[MASTER]);
181 if (scp->ata_ch->devices & ATA_ATAPI_SLAVE)
182 setup_dev(scp, &scp->ata_ch->device[SLAVE]);
188 xpt_async(AC_BUS_RESET, scp->path, NULL);
191 cam_rescan(scp->sim);
197 setup_dev(struct atapi_xpt_softc *scp, struct ata_device *atp)
199 if (atp->driver == NULL) {
200 ata_set_name(atp, "atapicam",
201 2 * device_get_unit(atp->channel->dev) +
202 (atp->unit == ATA_MASTER) ? 0 : 1);
203 atp->driver = (void *)scp;
208 setup_async_cb(struct atapi_xpt_softc *scp, uint32_t events)
210 struct ccb_setasync csa;
212 xpt_setup_ccb(&csa.ccb_h, scp->path, /*priority*/ 5);
213 csa.ccb_h.func_code = XPT_SASYNC_CB;
214 csa.event_enable = events;
215 csa.callback = &atapi_async;
216 csa.callback_arg = scp->sim;
217 xpt_action((union ccb *) &csa);
221 atapi_action(struct cam_sim *sim, union ccb *ccb)
223 struct atapi_xpt_softc *softc = (struct atapi_xpt_softc*)cam_sim_softc(sim);
224 struct ccb_hdr *ccb_h = &ccb->ccb_h;
225 struct atapi_hcb *hcb = NULL;
226 int unit = cam_sim_unit(sim);
227 int bus = cam_sim_bus(sim);
231 switch (ccb_h->func_code) {
233 struct ccb_pathinq *cpi = &ccb->cpi;
235 cpi->version_num = 1;
236 cpi->hba_inquiry = 0;
237 cpi->target_sprt = 0;
238 #if !defined(NO_ATANG)
239 cpi->hba_misc = PIM_NO_6_BYTE;
243 cpi->hba_eng_cnt = 0;
244 bzero(cpi->vuhba_flags, sizeof(cpi->vuhba_flags));
247 cpi->async_flags = 0;
249 cpi->initiator_id = 7;
250 strncpy(cpi->sim_vid, "FreeBSD", sizeof(cpi->sim_vid));
251 strncpy(cpi->hba_vid, "ATAPI", sizeof(cpi->hba_vid));
252 strncpy(cpi->dev_name, cam_sim_name(sim), sizeof cpi->dev_name);
253 cpi->unit_number = cam_sim_unit(sim);
254 cpi->bus_id = cam_sim_bus(sim);
255 cpi->base_transfer_speed = 3300;
256 if (softc->ata_ch && ccb_h->target_id != CAM_TARGET_WILDCARD) {
257 switch (softc->ata_ch->device[ccb_h->target_id].mode) {
259 cpi->base_transfer_speed = 5200;
262 cpi->base_transfer_speed = 7000;
265 cpi->base_transfer_speed = 11000;
270 cpi->base_transfer_speed = 16000;
273 cpi->base_transfer_speed = 33000;
276 cpi->base_transfer_speed = 66000;
279 cpi->base_transfer_speed = 100000;
282 cpi->base_transfer_speed = 133000;
288 ccb->ccb_h.status = CAM_REQ_CMP;
293 case XPT_RESET_DEV: {
294 int tid = ccb_h->target_id;
295 struct ata_device *dev = get_ata_device(softc, tid);
297 CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_SUBTRACE, ("dev reset\n"));
299 ccb->ccb_h.status = CAM_REQ_CMP;
305 CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_SUBTRACE, ("bus reset\n"));
306 ata_reinit(softc->ata_ch);
307 ccb->ccb_h.status = CAM_REQ_CMP;
311 case XPT_SET_TRAN_SETTINGS:
312 /* ignore these, we're not doing SCSI here */
313 CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_SUBTRACE,
314 ("SET_TRAN_SETTINGS not supported\n"));
315 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
319 case XPT_GET_TRAN_SETTINGS: {
320 struct ccb_trans_settings *cts = &ccb->cts;
323 * XXX The default CAM transport code is very scsi specific and
324 * doesn't understand IDE speeds very well. Be silent about it
325 * here and let it default to what is set in XPT_PATH_INQ
327 CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_SUBTRACE, ("GET_TRAN_SETTINGS\n"));
328 cts->valid = (CCB_TRANS_DISC_VALID | CCB_TRANS_TQ_VALID);
329 cts->flags &= ~(CCB_TRANS_DISC_ENB | CCB_TRANS_TAG_ENB);
330 ccb->ccb_h.status = CAM_REQ_CMP;
335 case XPT_CALC_GEOMETRY: {
336 struct ccb_calc_geometry *ccg;
337 unsigned int size_mb;
338 unsigned int secs_per_cylinder;
341 CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_SUBTRACE, ("CALC_GEOMETRY\n"));
343 size_mb = ccg->volume_size / ((1024L * 1024L) / ccg->block_size);
346 if (size_mb > 1024 && extended) {
348 ccg->secs_per_track = 63;
351 ccg->secs_per_track = 32;
353 secs_per_cylinder = ccg->heads * ccg->secs_per_track;
354 ccg->cylinders = ccg->volume_size / secs_per_cylinder;
355 ccb->ccb_h.status = CAM_REQ_CMP;
361 struct ccb_scsiio *csio = &ccb->csio;
362 int tid = ccb_h->target_id, lid = ccb_h->target_lun;
363 struct ata_device *dev = get_ata_device(softc, tid);
365 CAM_DEBUG(ccb_h->path, CAM_DEBUG_SUBTRACE, ("XPT_SCSI_IO\n"));
367 /* check that this request was not aborted already */
368 if ((ccb_h->status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
369 printf("XPT_SCSI_IO received but already in progress?\n");
374 CAM_DEBUG(ccb_h->path, CAM_DEBUG_SUBTRACE,
375 ("SCSI IO received for invalid device\n"));
376 ccb_h->status = CAM_TID_INVALID;
381 CAM_DEBUG(ccb_h->path, CAM_DEBUG_SUBTRACE,
382 ("SCSI IO received for invalid lun %d\n", lid));
383 ccb_h->status = CAM_LUN_INVALID;
387 if ((ccb_h->flags & CAM_SCATTER_VALID)) {
388 /* scatter-gather not supported */
389 xpt_print_path(ccb_h->path);
390 printf("ATAPI-CAM does not support scatter-gather yet!\n");
393 if ((hcb = allocate_hcb(softc, unit, bus, ccb)) == NULL)
396 ccb_h->status |= CAM_SIM_QUEUED;
398 bcopy((ccb_h->flags & CAM_CDB_POINTER) ?
399 csio->cdb_io.cdb_ptr : csio->cdb_io.cdb_bytes,
400 hcb->cmd, csio->cdb_len);
402 if (CAM_DEBUGGED(ccb_h->path, CAM_DEBUG_CDB)) {
403 char cdb_str[(SCSI_MAX_CDBLEN * 3) + 1];
405 printf("atapi_action: hcb@%p: %s\n", hcb,
406 scsi_cdb_string(hcb->cmd, cdb_str, sizeof(cdb_str)));
410 len = csio->dxfer_len;
411 buf = csio->data_ptr;
413 /* some SCSI commands require special processing */
414 switch (hcb->cmd[0]) {
417 * many ATAPI devices seem to report more than
418 * SHORT_INQUIRY_LENGTH bytes of available INQUIRY
419 * information, but respond with some incorrect condition
420 * when actually asked for it, so we are going to pretend
421 * that only SHORT_INQUIRY_LENGTH are expected, anyway.
423 struct scsi_inquiry *inq = (struct scsi_inquiry *) &hcb->cmd[0];
425 if (inq->byte2 == 0 && inq->page_code == 0 &&
426 inq->length > SHORT_INQUIRY_LENGTH) {
428 len = inq->length = SHORT_INQUIRY_LENGTH;
432 #if defined(NO_ATANG) /* EXITED IN ORIGINAL, DELETED IN ATANG */
438 * not supported by ATAPI/MMC devices (per SCSI MMC spec)
439 * translate to _10 equivalent.
440 * (actually we should do this only if we have tried
441 * MODE_foo_6 and received ILLEGAL_REQUEST or
442 * INVALID COMMAND OPERATION CODE)
443 * alternative fix: behave like a honest CAM transport,
444 * do not muck with CDB contents, and change scsi_cd to
445 * always use MODE_SENSE_10 in cdgetmode(), or let scsi_cd
446 * know that this specific unit is an ATAPI/MMC one,
447 * and in /that case/ use MODE_SENSE_10
450 CAM_DEBUG(ccb_h->path, CAM_DEBUG_SUBTRACE,
451 ("Translating %s into _10 equivalent\n",
452 (hcb->cmd[0] == MODE_SELECT_6) ?
453 "MODE_SELECT_6" : "MODE_SENSE_6"));
457 hcb->cmd[8] = hcb->cmd[4];
458 hcb->cmd[9] = hcb->cmd[5];
468 CAM_DEBUG(ccb_h->path, CAM_DEBUG_SUBTRACE,
469 ("Translating %s into _10 equivalent\n",
470 (hcb->cmd[0] == READ_6) ? "READ_6" : "WRITE_6"));
472 hcb->cmd[9] = hcb->cmd[5];
473 hcb->cmd[8] = hcb->cmd[4];
476 hcb->cmd[5] = hcb->cmd[3];
477 hcb->cmd[4] = hcb->cmd[2];
478 hcb->cmd[3] = hcb->cmd[1] & 0x1f;
484 if ((ccb_h->flags & CAM_DIR_MASK) == CAM_DIR_IN && (len & 1)) {
485 /* ATA always transfers an even number of bytes */
487 buf = hcb->dxfer_alloc = malloc(len, M_ATACAM, M_INTWAIT | M_ZERO);
490 TAILQ_INSERT_TAIL(&softc->pending_hcbs, hcb, chain);
492 if (atapi_queue_cmd(dev, hcb->cmd, buf, len,
493 (((ccb_h->flags & CAM_DIR_MASK) == CAM_DIR_IN) ?
494 ATPR_F_READ : 0) | ATPR_F_QUIET,
495 ccb_h->timeout, atapi_cb, (void *)hcb) == 0)
501 CAM_DEBUG(ccb_h->path, CAM_DEBUG_SUBTRACE,
502 ("unsupported function code 0x%02x\n", ccb_h->func_code));
503 ccb_h->status = CAM_REQ_INVALID;
511 xpt_print_path(ccb_h->path);
512 printf("out of memory, freezing queue.\n");
513 softc->flags |= RESOURCE_SHORTAGE;
514 xpt_freeze_simq(sim, /*count*/ 1);
515 ccb_h->status = CAM_REQUEUE_REQ;
520 atapi_poll(struct cam_sim *sim)
522 /* do nothing - we do not actually service any interrupts */
523 printf("atapi_poll called!\n");
527 atapi_cb(struct atapi_request *req)
529 struct atapi_hcb *hcb = (struct atapi_hcb *) req->driver;
530 struct ccb_scsiio *csio = &hcb->ccb->csio;
531 int hcb_status = req->result;
535 if (CAM_DEBUGGED(csio->ccb_h.path, CAM_DEBUG_CDB)) {
536 printf("atapi_cb: hcb@%p status = %02x: (sk = %02x%s%s%s)\n",
537 hcb, hcb_status, hcb_status >> 4,
538 (hcb_status & 4) ? " ABRT" : "",
539 (hcb_status & 2) ? " EOM" : "",
540 (hcb_status & 1) ? " ILI" : "");
541 printf(" %s: cmd %02x - sk=%02x asc=%02x ascq=%02x\n",
542 req->device->name, req->ccb[0], req->sense.sense_key,
543 req->sense.asc, req->sense.ascq);
546 if (hcb_status != 0) {
547 csio->scsi_status = SCSI_STATUS_CHECK_COND;
548 if ((csio->ccb_h.flags & CAM_DIS_AUTOSENSE) == 0) {
549 csio->ccb_h.status |= CAM_AUTOSNS_VALID;
550 bcopy((void *)&req->sense, (void *)&csio->sense_data,
551 sizeof(struct atapi_reqsense));
553 free_hcb_and_ccb_done(hcb, CAM_SCSI_STATUS_ERROR);
556 if (((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_IN) &&
557 hcb->dxfer_alloc != NULL)
558 bcopy(hcb->dxfer_alloc, csio->data_ptr, csio->dxfer_len);
559 csio->scsi_status = SCSI_STATUS_OK;
560 free_hcb_and_ccb_done(hcb, CAM_REQ_CMP);
567 free_hcb_and_ccb_done(struct atapi_hcb *hcb, u_int32_t status)
569 struct atapi_xpt_softc *softc = hcb->softc;
570 union ccb *ccb = hcb->ccb;
573 /* we're about to free a hcb, so the shortage has ended */
574 if (softc->flags & RESOURCE_SHORTAGE) {
575 softc->flags &= ~RESOURCE_SHORTAGE;
576 status |= CAM_RELEASE_SIMQ;
581 status | (ccb->ccb_h.status & ~(CAM_STATUS_MASK | CAM_SIM_QUEUED));
586 atapi_async(void *callback_arg, u_int32_t code,
587 struct cam_path *path, void *arg)
591 atapi_async1(callback_arg, code, path, arg);
596 atapi_async1(void *callback_arg, u_int32_t code,
597 struct cam_path* path, void *arg)
599 struct atapi_xpt_softc *softc;
603 sim = (struct cam_sim *) callback_arg;
604 softc = (struct atapi_xpt_softc *) cam_sim_softc(sim);
607 targ = xpt_path_target_id(path);
608 xpt_print_path(path);
610 printf("Lost host adapter\n");
612 printf("Lost target %d???\n", targ);
621 cam_rescan_callback(struct cam_periph *periph, union ccb *ccb)
623 if (ccb->ccb_h.status != CAM_REQ_CMP) {
624 CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_TRACE,
625 ("Rescan failed, 0x%04x\n", ccb->ccb_h.status));
627 CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_TRACE,
628 ("Rescan succeeded\n"));
630 xpt_free_path(ccb->ccb_h.path);
635 cam_rescan(struct cam_sim *sim)
637 struct cam_path *path;
638 union ccb *ccb = malloc(sizeof(union ccb), M_ATACAM, M_INTWAIT | M_ZERO);
640 if (xpt_create_path(&path, xpt_periph, cam_sim_path(sim),
641 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD) != CAM_REQ_CMP)
644 CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_TRACE, ("Rescanning ATAPI bus.\n"));
645 xpt_setup_ccb(&ccb->ccb_h, path, 5/*priority (low)*/);
646 ccb->ccb_h.func_code = XPT_SCAN_BUS;
647 ccb->ccb_h.cbfcnp = cam_rescan_callback;
648 ccb->crcn.flags = CAM_FLAG_NONE;
650 /* scan is in progress now */
653 static struct atapi_hcb *
654 allocate_hcb(struct atapi_xpt_softc *softc, int unit, int bus, union ccb *ccb)
656 struct atapi_hcb *hcb;
658 hcb = malloc(sizeof(struct atapi_hcb), M_ATACAM, M_INTWAIT | M_ZERO);
670 free_hcb(struct atapi_hcb *hcb)
672 TAILQ_REMOVE(&hcb->softc->pending_hcbs, hcb, chain);
673 if (hcb->dxfer_alloc != NULL)
674 free(hcb->dxfer_alloc, M_ATACAM);
679 free_softc(struct atapi_xpt_softc *scp)
681 struct atapi_hcb *hcb;
684 TAILQ_FOREACH(hcb, &scp->pending_hcbs, chain) {
685 free_hcb_and_ccb_done(hcb, CAM_UNREC_HBA_ERROR);
687 if (scp->path != NULL) {
688 setup_async_cb(scp, 0);
689 xpt_free_path(scp->path);
691 if ((scp->flags & BUS_REGISTERED) != 0) {
692 if (xpt_bus_deregister(cam_sim_path(scp->sim)) == CAM_REQ_CMP)
693 scp->flags &= ~BUS_REGISTERED;
695 if (scp->sim != NULL) {
696 if ((scp->flags & BUS_REGISTERED) == 0)
697 cam_sim_free(scp->sim);
699 printf("Can't free %s SIM (still registered)\n",
700 cam_sim_name(scp->sim));
702 LIST_REMOVE(scp, chain);
707 static struct atapi_xpt_softc *
708 get_softc(struct ata_channel *ata_ch) {
709 struct atapi_xpt_softc *scp;
710 LIST_FOREACH(scp, &all_buses, chain) {
711 if (scp->ata_ch == ata_ch)
717 static struct ata_device *
718 get_ata_device(struct atapi_xpt_softc *scp, int id)
720 int role = ATA_ATAPI_MASTER;
724 role = ATA_ATAPI_SLAVE;
728 if (scp->ata_ch->devices & role)
729 return &scp->ata_ch->device[id];