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>
40 #include <sys/malloc.h>
41 #include <sys/module.h>
44 #include <cam/cam_ccb.h>
45 #include <cam/cam_debug.h>
46 #include <cam/cam_sim.h>
47 #include <cam/cam_xpt_sim.h>
48 #include <cam/scsi/scsi_all.h>
49 #include <cam/scsi/scsi_message.h>
55 #include <machine/md_var.h>
56 #include <machine/bus.h>
62 #include <dev/aac/aacreg.h>
63 #include <sys/aac_ioctl.h>
64 #include <dev/aac/aacvar.h>
70 struct cam_path *path;
73 static int aac_cam_probe(device_t dev);
74 static int aac_cam_attach(device_t dev);
75 static int aac_cam_detach(device_t dev);
76 static void aac_cam_action(struct cam_sim *, union ccb *);
77 static void aac_cam_poll(struct cam_sim *);
78 static void aac_cam_complete(struct aac_command *);
79 static u_int32_t aac_cam_reset_bus(struct cam_sim *, union ccb *);
80 static u_int32_t aac_cam_abort_ccb(struct cam_sim *, union ccb *);
81 static u_int32_t aac_cam_term_io(struct cam_sim *, union ccb *);
83 static devclass_t aac_pass_devclass;
85 static device_method_t aac_pass_methods[] = {
86 DEVMETHOD(device_probe, aac_cam_probe),
87 DEVMETHOD(device_attach, aac_cam_attach),
88 DEVMETHOD(device_detach, aac_cam_detach),
92 static driver_t aac_pass_driver = {
95 sizeof(struct aac_cam)
98 DRIVER_MODULE(aacp, aac, aac_pass_driver, aac_pass_devclass, 0, 0);
99 MODULE_DEPEND(aacp, cam, 1, 1, 1);
101 MALLOC_DEFINE(M_AACCAM, "aaccam", "AAC CAM info");
104 aac_cam_event(struct aac_softc *sc, struct aac_event *event, void *arg)
107 struct aac_cam *camsc;
109 switch (event->ev_type) {
110 case AAC_EVENT_CMFREE:
112 camsc = ccb->ccb_h.sim_priv.entries[0].ptr;
113 free(event, M_AACCAM);
114 xpt_release_simq(camsc->sim, 1);
115 ccb->ccb_h.status = CAM_REQUEUE_REQ;
119 device_printf(sc->aac_dev, "unknown event %d in aac_cam\n",
128 aac_cam_probe(device_t dev)
130 fwprintf(NULL, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
136 aac_cam_detach(device_t dev)
138 struct aac_softc *sc;
139 struct aac_cam *camsc;
140 fwprintf(NULL, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
142 camsc = (struct aac_cam *)device_get_softc(dev);
143 sc = camsc->inf->aac_sc;
145 mtx_lock(&sc->aac_io_lock);
147 xpt_async(AC_LOST_DEVICE, camsc->path, NULL);
148 xpt_free_path(camsc->path);
149 xpt_bus_deregister(cam_sim_path(camsc->sim));
150 cam_sim_free(camsc->sim, /*free_devq*/TRUE);
152 mtx_unlock(&sc->aac_io_lock);
158 * Register the driver as a CAM SIM
161 aac_cam_attach(device_t dev)
163 struct cam_devq *devq;
165 struct cam_path *path;
166 struct aac_cam *camsc;
169 fwprintf(NULL, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
171 camsc = (struct aac_cam *)device_get_softc(dev);
172 inf = (struct aac_sim *)device_get_ivars(dev);
175 devq = cam_simq_alloc(inf->TargetsPerBus);
179 sim = cam_sim_alloc(aac_cam_action, aac_cam_poll, "aacp", camsc,
180 device_get_unit(dev), &inf->aac_sc->aac_io_lock, 1, 1, devq);
186 /* Since every bus has it's own sim, every bus 'appears' as bus 0 */
187 mtx_lock(&inf->aac_sc->aac_io_lock);
188 if (xpt_bus_register(sim, dev, 0) != CAM_SUCCESS) {
189 cam_sim_free(sim, TRUE);
190 mtx_unlock(&inf->aac_sc->aac_io_lock);
194 if (xpt_create_path(&path, NULL, cam_sim_path(sim),
195 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
196 xpt_bus_deregister(cam_sim_path(sim));
197 cam_sim_free(sim, TRUE);
198 mtx_unlock(&inf->aac_sc->aac_io_lock);
201 mtx_unlock(&inf->aac_sc->aac_io_lock);
210 aac_cam_action(struct cam_sim *sim, union ccb *ccb)
212 struct aac_cam *camsc;
213 struct aac_softc *sc;
216 struct aac_command *cm;
218 camsc = (struct aac_cam *)cam_sim_softc(sim);
219 sc = camsc->inf->aac_sc;
220 fwprintf(sc, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
222 /* Synchronous ops, and ops that don't require communication with the
224 switch(ccb->ccb_h.func_code) {
227 /* These are handled down below */
229 case XPT_CALC_GEOMETRY:
231 struct ccb_calc_geometry *ccg;
233 u_int32_t secs_per_cylinder;
236 size_mb = ccg->volume_size /
237 ((1024L * 1024L) / ccg->block_size);
238 if (size_mb >= (2 * 1024)) { /* 2GB */
240 ccg->secs_per_track = 63;
241 } else if (size_mb >= (1 * 1024)) { /* 1GB */
243 ccg->secs_per_track = 32;
246 ccg->secs_per_track = 32;
248 secs_per_cylinder = ccg->heads * ccg->secs_per_track;
249 ccg->cylinders = ccg->volume_size / secs_per_cylinder;
251 ccb->ccb_h.status = CAM_REQ_CMP;
257 struct ccb_pathinq *cpi = &ccb->cpi;
259 cpi->version_num = 1;
260 cpi->hba_inquiry = PI_WIDE_16;
261 cpi->target_sprt = 0;
264 * Resetting via the passthrough or parallel bus scan
267 cpi->hba_misc = PIM_NOBUSRESET | PIM_SEQSCAN;
268 cpi->hba_eng_cnt = 0;
269 cpi->max_target = camsc->inf->TargetsPerBus;
270 cpi->max_lun = 8; /* Per the controller spec */
271 cpi->initiator_id = camsc->inf->InitiatorBusId;
272 cpi->bus_id = camsc->inf->BusNumber;
273 cpi->base_transfer_speed = 3300;
274 strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
275 strncpy(cpi->hba_vid, "Adaptec", HBA_IDLEN);
276 strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
277 cpi->unit_number = cam_sim_unit(sim);
278 cpi->transport = XPORT_SPI;
279 cpi->transport_version = 2;
280 cpi->protocol = PROTO_SCSI;
281 cpi->protocol_version = SCSI_REV_2;
282 ccb->ccb_h.status = CAM_REQ_CMP;
286 case XPT_GET_TRAN_SETTINGS:
288 struct ccb_trans_settings_scsi *scsi =
289 &ccb->cts.proto_specific.scsi;
290 struct ccb_trans_settings_spi *spi =
291 &ccb->cts.xport_specific.spi;
292 ccb->cts.protocol = PROTO_SCSI;
293 ccb->cts.protocol_version = SCSI_REV_2;
294 ccb->cts.transport = XPORT_SPI;
295 ccb->cts.transport_version = 2;
296 if (ccb->ccb_h.target_lun != CAM_LUN_WILDCARD) {
297 scsi->valid = CTS_SCSI_VALID_TQ;
298 spi->valid |= CTS_SPI_VALID_DISC;
302 ccb->ccb_h.status = CAM_REQ_CMP;
306 case XPT_SET_TRAN_SETTINGS:
307 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
311 if (!(sc->flags & AAC_FLAGS_CAM_NORESET)) {
312 ccb->ccb_h.status = aac_cam_reset_bus(sim, ccb);
314 ccb->ccb_h.status = CAM_REQ_CMP;
319 ccb->ccb_h.status = aac_cam_abort_ccb(sim, ccb);
323 ccb->ccb_h.status = aac_cam_term_io(sim, ccb);
327 device_printf(sc->aac_dev, "Unsupported command 0x%x\n",
328 ccb->ccb_h.func_code);
329 ccb->ccb_h.status = CAM_PROVIDE_FAIL;
334 /* Async ops that require communcation with the controller */
336 if (aac_alloc_command(sc, &cm)) {
337 struct aac_event *event;
339 xpt_freeze_simq(sim, 1);
340 ccb->ccb_h.status = CAM_RESRC_UNAVAIL;
341 ccb->ccb_h.sim_priv.entries[0].ptr = camsc;
342 event = malloc(sizeof(struct aac_event), M_AACCAM,
345 device_printf(sc->aac_dev,
346 "Warning, out of memory for event\n");
349 event->ev_callback = aac_cam_event;
351 event->ev_type = AAC_EVENT_CMFREE;
352 aac_add_event(sc, event);
357 srb = (struct aac_srb *)&fib->data[0];
360 switch (ccb->ccb_h.flags & CAM_DIR_MASK) {
362 srb->flags = AAC_SRB_FLAGS_DATA_IN;
363 cm->cm_flags |= AAC_CMD_DATAIN;
366 srb->flags = AAC_SRB_FLAGS_DATA_OUT;
367 cm->cm_flags |= AAC_CMD_DATAOUT;
370 srb->flags = AAC_SRB_FLAGS_NO_DATA_XFER;
373 srb->flags = AAC_SRB_FLAGS_UNSPECIFIED_DIRECTION;
374 cm->cm_flags |= AAC_CMD_DATAIN | AAC_CMD_DATAOUT;
378 switch(ccb->ccb_h.func_code) {
381 struct ccb_scsiio *csio = &ccb->csio;
383 srb->function = AAC_SRB_FUNC_EXECUTE_SCSI;
386 * Copy the CDB into the SRB. It's only 6-16 bytes,
387 * so a copy is not too expensive.
389 srb->cdb_len = csio->cdb_len;
390 if (ccb->ccb_h.flags & CAM_CDB_POINTER)
391 bcopy(csio->cdb_io.cdb_ptr, (u_int8_t *)&srb->cdb[0],
394 bcopy(csio->cdb_io.cdb_bytes, (u_int8_t *)&srb->cdb[0],
398 fib->Header.Command = (sc->flags & AAC_FLAGS_SG_64BIT) ?
399 ScsiPortCommandU64 : ScsiPortCommand;
401 /* Map the s/g list. XXX 32bit addresses only! */
402 if ((ccb->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE) {
403 if ((ccb->ccb_h.flags & CAM_SCATTER_VALID) == 0) {
404 srb->data_len = csio->dxfer_len;
405 if (ccb->ccb_h.flags & CAM_DATA_PHYS) {
406 /* Send a 32bit command */
407 fib->Header.Command = ScsiPortCommand;
408 srb->sg_map.SgCount = 1;
409 srb->sg_map.SgEntry[0].SgAddress =
410 (uint32_t)(uintptr_t)csio->data_ptr;
411 srb->sg_map.SgEntry[0].SgByteCount =
415 * Arrange things so that the S/G
416 * map will get set up automagically
418 cm->cm_data = (void *)csio->data_ptr;
419 cm->cm_datalen = csio->dxfer_len;
420 cm->cm_sgtable = &srb->sg_map;
423 /* XXX Need to handle multiple s/g elements */
424 panic("aac_cam: multiple s/g elements");
427 srb->sg_map.SgCount = 0;
428 srb->sg_map.SgEntry[0].SgByteCount = 0;
435 if (!(sc->flags & AAC_FLAGS_CAM_NORESET)) {
436 srb->function = AAC_SRB_FUNC_RESET_DEVICE;
439 ccb->ccb_h.status = CAM_REQ_CMP;
447 srb->bus = camsc->inf->BusNumber; /* Bus number relative to the card */
448 srb->target = ccb->ccb_h.target_id;
449 srb->lun = ccb->ccb_h.target_lun;
450 srb->timeout = ccb->ccb_h.timeout; /* XXX */
451 srb->retry_limit = 0;
453 cm->cm_complete = aac_cam_complete;
454 cm->cm_private = ccb;
455 cm->cm_timestamp = time_uptime;
457 fib->Header.XferState =
458 AAC_FIBSTATE_HOSTOWNED |
459 AAC_FIBSTATE_INITIALISED |
460 AAC_FIBSTATE_FROMHOST |
461 AAC_FIBSTATE_REXPECTED |
463 fib->Header.Size = sizeof(struct aac_fib_header) +
464 sizeof(struct aac_srb);
466 aac_enqueue_ready(cm);
467 aac_startio(cm->cm_sc);
473 aac_cam_poll(struct cam_sim *sim)
476 * Pinging the interrupt routine isn't very safe, nor is it
477 * really necessary. Do nothing.
482 aac_cam_complete(struct aac_command *cm)
485 struct aac_srb_response *srbr;
486 struct aac_softc *sc;
489 fwprintf(sc, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
490 ccb = cm->cm_private;
491 srbr = (struct aac_srb_response *)&cm->cm_fib->data[0];
493 if (srbr->fib_status != 0) {
494 device_printf(sc->aac_dev, "Passthru FIB failed!\n");
495 ccb->ccb_h.status = CAM_REQ_ABORTED;
498 * The SRB error codes just happen to match the CAM error
499 * codes. How convienient!
501 ccb->ccb_h.status = srbr->srb_status;
503 /* Take care of SCSI_IO ops. */
504 if (ccb->ccb_h.func_code == XPT_SCSI_IO) {
505 u_int8_t command, device;
507 ccb->csio.scsi_status = srbr->scsi_status;
509 /* Take care of autosense */
510 if (srbr->sense_len) {
511 int sense_len, scsi_sense_len;
513 scsi_sense_len = sizeof(struct scsi_sense_data);
514 bzero(&ccb->csio.sense_data, scsi_sense_len);
515 sense_len = (srbr->sense_len >
516 scsi_sense_len) ? scsi_sense_len :
518 bcopy(&srbr->sense[0], &ccb->csio.sense_data,
520 ccb->csio.sense_len = sense_len;
521 ccb->ccb_h.status |= CAM_AUTOSNS_VALID;
522 // scsi_sense_print(&ccb->csio);
525 /* If this is an inquiry command, fake things out */
526 if (ccb->ccb_h.flags & CAM_CDB_POINTER)
527 command = ccb->csio.cdb_io.cdb_ptr[0];
529 command = ccb->csio.cdb_io.cdb_bytes[0];
531 if (command == INQUIRY) {
532 if (ccb->ccb_h.status == CAM_REQ_CMP) {
533 device = ccb->csio.data_ptr[0] & 0x1f;
535 * We want DASD and PROC devices to only be
536 * visible through the pass device.
538 if ((device == T_DIRECT) ||
539 (device == T_PROCESSOR) ||
540 (sc->flags & AAC_FLAGS_CAM_PASSONLY))
541 ccb->csio.data_ptr[0] =
542 ((device & 0xe0) | T_NODEVICE);
543 } else if (ccb->ccb_h.status == CAM_SEL_TIMEOUT &&
544 ccb->ccb_h.target_lun != 0) {
545 /* fix for INQUIRYs on Lun>0 */
546 ccb->ccb_h.status = CAM_DEV_NOT_THERE;
552 aac_release_command(cm);
559 aac_cam_reset_bus(struct cam_sim *sim, union ccb *ccb)
562 struct aac_softc *sc;
563 struct aac_cam *camsc;
564 struct aac_vmioctl *vmi;
565 struct aac_resetbus *rbc;
568 camsc = (struct aac_cam *)cam_sim_softc(sim);
569 sc = camsc->inf->aac_sc;
572 printf("Null sc?\n");
573 return (CAM_REQ_ABORTED);
576 aac_alloc_sync_fib(sc, &fib);
578 vmi = (struct aac_vmioctl *)&fib->data[0];
579 bzero(vmi, sizeof(struct aac_vmioctl));
581 vmi->Command = VM_Ioctl;
582 vmi->ObjType = FT_DRIVE;
583 vmi->MethId = sc->scsi_method_id;
585 vmi->IoctlCmd = ResetBus;
587 rbc = (struct aac_resetbus *)&vmi->IoctlBuf[0];
588 rbc->BusNumber = camsc->inf->BusNumber;
590 e = aac_sync_fib(sc, ContainerCommand, 0, fib,
591 sizeof(struct aac_vmioctl));
593 device_printf(sc->aac_dev,"Error %d sending ResetBus command\n",
595 aac_release_sync_fib(sc);
596 return (CAM_REQ_ABORTED);
599 aac_release_sync_fib(sc);
600 return (CAM_REQ_CMP);
604 aac_cam_abort_ccb(struct cam_sim *sim, union ccb *ccb)
606 return (CAM_UA_ABORT);
610 aac_cam_term_io(struct cam_sim *sim, union ccb *ccb)
612 return (CAM_UA_TERMIO);