2 * Copyright (c) 2002 Adaptec, Inc.
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 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
31 * CAM front-end for communicating with non-DASD devices
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/sysctl.h>
41 #include <sys/malloc.h>
42 #include <sys/module.h>
43 #include <sys/mutex.h>
46 #include <cam/cam_ccb.h>
47 #include <cam/cam_debug.h>
48 #include <cam/cam_periph.h>
49 #include <cam/cam_sim.h>
50 #include <cam/cam_xpt_sim.h>
51 #include <cam/scsi/scsi_all.h>
52 #include <cam/scsi/scsi_message.h>
58 #include <machine/md_var.h>
59 #include <machine/bus.h>
65 #include <dev/aac/aacreg.h>
66 #include <sys/aac_ioctl.h>
67 #include <dev/aac/aacvar.h>
73 struct cam_path *path;
76 static int aac_cam_probe(device_t dev);
77 static int aac_cam_attach(device_t dev);
78 static int aac_cam_detach(device_t dev);
79 static void aac_cam_action(struct cam_sim *, union ccb *);
80 static void aac_cam_poll(struct cam_sim *);
81 static void aac_cam_complete(struct aac_command *);
82 static void aac_cam_rescan(struct aac_softc *sc, uint32_t channel,
85 static u_int32_t aac_cam_reset_bus(struct cam_sim *, union ccb *);
86 static u_int32_t aac_cam_abort_ccb(struct cam_sim *, union ccb *);
87 static u_int32_t aac_cam_term_io(struct cam_sim *, union ccb *);
89 static devclass_t aac_pass_devclass;
91 static device_method_t aac_pass_methods[] = {
92 DEVMETHOD(device_probe, aac_cam_probe),
93 DEVMETHOD(device_attach, aac_cam_attach),
94 DEVMETHOD(device_detach, aac_cam_detach),
98 static driver_t aac_pass_driver = {
101 sizeof(struct aac_cam)
104 DRIVER_MODULE(aacp, aac, aac_pass_driver, aac_pass_devclass, NULL, NULL);
105 MODULE_DEPEND(aacp, cam, 1, 1, 1);
107 static MALLOC_DEFINE(M_AACCAM, "aaccam", "AAC CAM info");
110 aac_cam_rescan(struct aac_softc *sc, uint32_t channel, uint32_t target_id)
114 struct aac_cam *camsc;
116 if (target_id == AAC_CAM_TARGET_WILDCARD)
117 target_id = CAM_TARGET_WILDCARD;
119 TAILQ_FOREACH(sim, &sc->aac_sim_tqh, sim_link) {
120 camsc = sim->aac_cam;
121 if (camsc == NULL || camsc->inf == NULL ||
122 camsc->inf->BusNumber != channel)
125 ccb = xpt_alloc_ccb_nowait();
127 device_printf(sc->aac_dev,
128 "Cannot allocate ccb for bus rescan.\n");
132 if (xpt_create_path(&ccb->ccb_h.path, NULL,
133 cam_sim_path(camsc->sim),
134 target_id, CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
136 device_printf(sc->aac_dev,
137 "Cannot create path for bus rescan.\n");
147 aac_cam_event(struct aac_softc *sc, struct aac_event *event, void *arg)
150 struct aac_cam *camsc;
152 switch (event->ev_type) {
153 case AAC_EVENT_CMFREE:
155 camsc = ccb->ccb_h.sim_priv.entries[0].ptr;
156 free(event, M_AACCAM);
157 xpt_release_simq(camsc->sim, 1);
158 ccb->ccb_h.status = CAM_REQUEUE_REQ;
162 device_printf(sc->aac_dev, "unknown event %d in aac_cam\n",
169 aac_cam_probe(device_t dev)
171 fwprintf(NULL, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
177 aac_cam_detach(device_t dev)
179 struct aac_softc *sc;
180 struct aac_cam *camsc;
181 fwprintf(NULL, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
183 camsc = (struct aac_cam *)device_get_softc(dev);
184 sc = camsc->inf->aac_sc;
185 camsc->inf->aac_cam = NULL;
187 mtx_lock(&sc->aac_io_lock);
189 xpt_async(AC_LOST_DEVICE, camsc->path, NULL);
190 xpt_free_path(camsc->path);
191 xpt_bus_deregister(cam_sim_path(camsc->sim));
192 cam_sim_free(camsc->sim, /*free_devq*/TRUE);
194 sc->cam_rescan_cb = NULL;
196 mtx_unlock(&sc->aac_io_lock);
202 * Register the driver as a CAM SIM
205 aac_cam_attach(device_t dev)
207 struct cam_devq *devq;
209 struct cam_path *path;
210 struct aac_cam *camsc;
213 fwprintf(NULL, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
215 camsc = (struct aac_cam *)device_get_softc(dev);
216 inf = (struct aac_sim *)device_get_ivars(dev);
218 camsc->inf->aac_cam = camsc;
220 devq = cam_simq_alloc(inf->TargetsPerBus);
224 sim = cam_sim_alloc(aac_cam_action, aac_cam_poll, "aacp", camsc,
225 device_get_unit(dev), &inf->aac_sc->aac_io_lock, 1, 1, devq);
231 /* Since every bus has it's own sim, every bus 'appears' as bus 0 */
232 mtx_lock(&inf->aac_sc->aac_io_lock);
233 if (xpt_bus_register(sim, dev, 0) != CAM_SUCCESS) {
234 cam_sim_free(sim, TRUE);
235 mtx_unlock(&inf->aac_sc->aac_io_lock);
239 if (xpt_create_path(&path, NULL, cam_sim_path(sim),
240 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
241 xpt_bus_deregister(cam_sim_path(sim));
242 cam_sim_free(sim, TRUE);
243 mtx_unlock(&inf->aac_sc->aac_io_lock);
246 inf->aac_sc->cam_rescan_cb = aac_cam_rescan;
247 mtx_unlock(&inf->aac_sc->aac_io_lock);
256 aac_cam_action(struct cam_sim *sim, union ccb *ccb)
258 struct aac_cam *camsc;
259 struct aac_softc *sc;
262 struct aac_command *cm;
264 camsc = (struct aac_cam *)cam_sim_softc(sim);
265 sc = camsc->inf->aac_sc;
266 fwprintf(sc, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
268 /* Synchronous ops, and ops that don't require communication with the
270 switch(ccb->ccb_h.func_code) {
273 /* These are handled down below */
275 case XPT_CALC_GEOMETRY:
277 struct ccb_calc_geometry *ccg;
279 u_int32_t secs_per_cylinder;
282 size_mb = ccg->volume_size /
283 ((1024L * 1024L) / ccg->block_size);
284 if (size_mb >= (2 * 1024)) { /* 2GB */
286 ccg->secs_per_track = 63;
287 } else if (size_mb >= (1 * 1024)) { /* 1GB */
289 ccg->secs_per_track = 32;
292 ccg->secs_per_track = 32;
294 secs_per_cylinder = ccg->heads * ccg->secs_per_track;
295 ccg->cylinders = ccg->volume_size / secs_per_cylinder;
297 ccb->ccb_h.status = CAM_REQ_CMP;
303 struct ccb_pathinq *cpi = &ccb->cpi;
305 cpi->version_num = 1;
306 cpi->hba_inquiry = PI_WIDE_16;
307 cpi->target_sprt = 0;
310 * Resetting via the passthrough or parallel bus scan
313 cpi->hba_misc = PIM_NOBUSRESET | PIM_SEQSCAN;
314 cpi->hba_eng_cnt = 0;
315 cpi->max_target = camsc->inf->TargetsPerBus;
316 cpi->max_lun = 8; /* Per the controller spec */
317 cpi->initiator_id = camsc->inf->InitiatorBusId;
318 cpi->bus_id = camsc->inf->BusNumber;
319 cpi->base_transfer_speed = 3300;
320 strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
321 strncpy(cpi->hba_vid, "Adaptec", HBA_IDLEN);
322 strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
323 cpi->unit_number = cam_sim_unit(sim);
324 cpi->transport = XPORT_SPI;
325 cpi->transport_version = 2;
326 cpi->protocol = PROTO_SCSI;
327 cpi->protocol_version = SCSI_REV_2;
328 ccb->ccb_h.status = CAM_REQ_CMP;
332 case XPT_GET_TRAN_SETTINGS:
334 struct ccb_trans_settings_scsi *scsi =
335 &ccb->cts.proto_specific.scsi;
336 struct ccb_trans_settings_spi *spi =
337 &ccb->cts.xport_specific.spi;
338 ccb->cts.protocol = PROTO_SCSI;
339 ccb->cts.protocol_version = SCSI_REV_2;
340 ccb->cts.transport = XPORT_SPI;
341 ccb->cts.transport_version = 2;
342 if (ccb->ccb_h.target_lun != CAM_LUN_WILDCARD) {
343 scsi->valid = CTS_SCSI_VALID_TQ;
344 spi->valid |= CTS_SPI_VALID_DISC;
348 ccb->ccb_h.status = CAM_REQ_CMP;
352 case XPT_SET_TRAN_SETTINGS:
353 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
357 if (!(sc->flags & AAC_FLAGS_CAM_NORESET)) {
358 ccb->ccb_h.status = aac_cam_reset_bus(sim, ccb);
360 ccb->ccb_h.status = CAM_REQ_CMP;
365 ccb->ccb_h.status = aac_cam_abort_ccb(sim, ccb);
369 ccb->ccb_h.status = aac_cam_term_io(sim, ccb);
373 device_printf(sc->aac_dev, "Unsupported command 0x%x\n",
374 ccb->ccb_h.func_code);
375 ccb->ccb_h.status = CAM_PROVIDE_FAIL;
380 /* Async ops that require communcation with the controller */
382 if (aac_alloc_command(sc, &cm)) {
383 struct aac_event *event;
385 xpt_freeze_simq(sim, 1);
386 ccb->ccb_h.status = CAM_RESRC_UNAVAIL;
387 ccb->ccb_h.sim_priv.entries[0].ptr = camsc;
388 event = malloc(sizeof(struct aac_event), M_AACCAM,
391 device_printf(sc->aac_dev,
392 "Warning, out of memory for event\n");
395 event->ev_callback = aac_cam_event;
397 event->ev_type = AAC_EVENT_CMFREE;
398 aac_add_event(sc, event);
403 srb = (struct aac_srb *)&fib->data[0];
406 switch (ccb->ccb_h.flags & CAM_DIR_MASK) {
408 srb->flags = AAC_SRB_FLAGS_DATA_IN;
409 cm->cm_flags |= AAC_CMD_DATAIN;
412 srb->flags = AAC_SRB_FLAGS_DATA_OUT;
413 cm->cm_flags |= AAC_CMD_DATAOUT;
416 srb->flags = AAC_SRB_FLAGS_NO_DATA_XFER;
419 srb->flags = AAC_SRB_FLAGS_UNSPECIFIED_DIRECTION;
420 cm->cm_flags |= AAC_CMD_DATAIN | AAC_CMD_DATAOUT;
424 switch(ccb->ccb_h.func_code) {
427 struct ccb_scsiio *csio = &ccb->csio;
429 srb->function = AAC_SRB_FUNC_EXECUTE_SCSI;
432 * Copy the CDB into the SRB. It's only 6-16 bytes,
433 * so a copy is not too expensive.
435 srb->cdb_len = csio->cdb_len;
436 if (ccb->ccb_h.flags & CAM_CDB_POINTER)
437 bcopy(csio->cdb_io.cdb_ptr, (u_int8_t *)&srb->cdb[0],
440 bcopy(csio->cdb_io.cdb_bytes, (u_int8_t *)&srb->cdb[0],
444 fib->Header.Command = (sc->flags & AAC_FLAGS_SG_64BIT) ?
445 ScsiPortCommandU64 : ScsiPortCommand;
447 /* Map the s/g list. XXX 32bit addresses only! */
448 if ((ccb->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE) {
449 switch ((ccb->ccb_h.flags & CAM_DATA_MASK)) {
451 srb->data_len = csio->dxfer_len;
453 * Arrange things so that the S/G
454 * map will get set up automagically
456 cm->cm_data = (void *)csio->data_ptr;
457 cm->cm_datalen = csio->dxfer_len;
458 cm->cm_sgtable = &srb->sg_map;
461 /* Send a 32bit command */
462 fib->Header.Command = ScsiPortCommand;
463 srb->sg_map.SgCount = 1;
464 srb->sg_map.SgEntry[0].SgAddress =
465 (uint32_t)(uintptr_t)csio->data_ptr;
466 srb->sg_map.SgEntry[0].SgByteCount =
468 srb->data_len = csio->dxfer_len;
471 /* XXX Need to handle multiple s/g elements */
472 panic("aac_cam: multiple s/g elements");
475 srb->sg_map.SgCount = 0;
476 srb->sg_map.SgEntry[0].SgByteCount = 0;
483 if (!(sc->flags & AAC_FLAGS_CAM_NORESET)) {
484 srb->function = AAC_SRB_FUNC_RESET_DEVICE;
487 ccb->ccb_h.status = CAM_REQ_CMP;
495 srb->bus = camsc->inf->BusNumber; /* Bus number relative to the card */
496 srb->target = ccb->ccb_h.target_id;
497 srb->lun = ccb->ccb_h.target_lun;
498 srb->timeout = ccb->ccb_h.timeout; /* XXX */
499 srb->retry_limit = 0;
501 cm->cm_complete = aac_cam_complete;
502 cm->cm_private = ccb;
503 cm->cm_timestamp = time_uptime;
505 fib->Header.XferState =
506 AAC_FIBSTATE_HOSTOWNED |
507 AAC_FIBSTATE_INITIALISED |
508 AAC_FIBSTATE_FROMHOST |
509 AAC_FIBSTATE_REXPECTED |
511 fib->Header.Size = sizeof(struct aac_fib_header) +
512 sizeof(struct aac_srb);
514 aac_enqueue_ready(cm);
515 aac_startio(cm->cm_sc);
519 aac_cam_poll(struct cam_sim *sim)
522 * Pinging the interrupt routine isn't very safe, nor is it
523 * really necessary. Do nothing.
528 aac_cam_fix_inquiry(struct aac_softc *sc, union ccb *ccb)
530 struct scsi_inquiry_data *inq;
532 uint8_t device, qual;
534 /* If this is an inquiry command, fake things out */
535 if (ccb->ccb_h.flags & CAM_CDB_POINTER)
536 data = ccb->csio.cdb_io.cdb_ptr;
538 data = ccb->csio.cdb_io.cdb_bytes;
540 if (data[0] != INQUIRY)
543 if (ccb->ccb_h.status == CAM_REQ_CMP) {
544 inq = (struct scsi_inquiry_data *)ccb->csio.data_ptr;
545 device = SID_TYPE(inq);
546 qual = SID_QUAL(inq);
549 * We want DASD and PROC devices to only be
550 * visible through the pass device.
552 if (((device == T_DIRECT) ||
553 (device == T_PROCESSOR) ||
554 (sc->flags & AAC_FLAGS_CAM_PASSONLY))) {
556 * Some aac(4) adapters will always report that a direct
557 * access device is offline in response to a INQUIRY
558 * command that does not retreive vital product data.
559 * Force the qualifier to connected so that upper layers
560 * correctly recognize that a disk is present.
562 if ((data[1] & SI_EVPD) == 0 && device == T_DIRECT &&
563 qual == SID_QUAL_LU_OFFLINE)
564 qual = SID_QUAL_LU_CONNECTED;
565 ccb->csio.data_ptr[0] = (qual << 5) | T_NODEVICE;
567 } else if (ccb->ccb_h.status == CAM_SEL_TIMEOUT &&
568 ccb->ccb_h.target_lun != 0) {
569 /* fix for INQUIRYs on Lun>0 */
570 ccb->ccb_h.status = CAM_DEV_NOT_THERE;
575 aac_cam_complete(struct aac_command *cm)
578 struct aac_srb_response *srbr;
579 struct aac_softc *sc;
583 fwprintf(sc, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
584 ccb = cm->cm_private;
585 srbr = (struct aac_srb_response *)&cm->cm_fib->data[0];
587 if (srbr->fib_status != 0) {
588 device_printf(sc->aac_dev, "Passthru FIB failed!\n");
589 ccb->ccb_h.status = CAM_REQ_ABORTED;
592 * The SRB error codes just happen to match the CAM error
593 * codes. How convienient!
595 ccb->ccb_h.status = srbr->srb_status;
597 /* Take care of SCSI_IO ops. */
598 if (ccb->ccb_h.func_code == XPT_SCSI_IO) {
599 ccb->csio.scsi_status = srbr->scsi_status;
601 /* Take care of autosense */
602 if (srbr->sense_len) {
603 sense_returned = srbr->sense_len;
604 if (sense_returned < ccb->csio.sense_len)
605 ccb->csio.sense_resid =
606 ccb->csio.sense_len -
609 ccb->csio.sense_resid = 0;
610 bzero(&ccb->csio.sense_data,
611 sizeof(struct scsi_sense_data));
612 bcopy(&srbr->sense[0], &ccb->csio.sense_data,
613 min(ccb->csio.sense_len, sense_returned));
614 ccb->ccb_h.status |= CAM_AUTOSNS_VALID;
615 // scsi_sense_print(&ccb->csio);
618 aac_cam_fix_inquiry(sc, ccb);
622 aac_release_command(cm);
627 aac_cam_reset_bus(struct cam_sim *sim, union ccb *ccb)
630 struct aac_softc *sc;
631 struct aac_cam *camsc;
632 struct aac_vmioctl *vmi;
633 struct aac_resetbus *rbc;
636 camsc = (struct aac_cam *)cam_sim_softc(sim);
637 sc = camsc->inf->aac_sc;
640 printf("aac: Null sc?\n");
641 return (CAM_REQ_ABORTED);
644 aac_alloc_sync_fib(sc, &fib);
646 vmi = (struct aac_vmioctl *)&fib->data[0];
647 bzero(vmi, sizeof(struct aac_vmioctl));
649 vmi->Command = VM_Ioctl;
650 vmi->ObjType = FT_DRIVE;
651 vmi->MethId = sc->scsi_method_id;
653 vmi->IoctlCmd = ResetBus;
655 rbc = (struct aac_resetbus *)&vmi->IoctlBuf[0];
656 rbc->BusNumber = camsc->inf->BusNumber;
658 e = aac_sync_fib(sc, ContainerCommand, 0, fib,
659 sizeof(struct aac_vmioctl));
661 device_printf(sc->aac_dev,"Error %d sending ResetBus command\n",
663 aac_release_sync_fib(sc);
664 return (CAM_REQ_ABORTED);
667 aac_release_sync_fib(sc);
668 return (CAM_REQ_CMP);
672 aac_cam_abort_ccb(struct cam_sim *sim, union ccb *ccb)
674 return (CAM_UA_ABORT);
678 aac_cam_term_io(struct cam_sim *sim, union ccb *ccb)
680 return (CAM_UA_TERMIO);