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)
106 struct aac_cam *camsc;
108 switch (event->ev_type) {
109 case AAC_EVENT_CMFREE:
111 free(event, M_AACCAM);
112 xpt_release_simq(camsc->sim, 1);
115 device_printf(sc->aac_dev, "unknown event %d in aac_cam\n",
124 aac_cam_probe(device_t dev)
132 aac_cam_detach(device_t dev)
134 struct aac_cam *camsc;
137 camsc = (struct aac_cam *)device_get_softc(dev);
141 xpt_async(AC_LOST_DEVICE, camsc->path, NULL);
142 xpt_free_path(camsc->path);
143 xpt_bus_deregister(cam_sim_path(camsc->sim));
144 cam_sim_free(camsc->sim, /*free_devq*/TRUE);
152 * Register the driver as a CAM SIM
155 aac_cam_attach(device_t dev)
157 struct cam_devq *devq;
159 struct cam_path *path;
160 struct aac_cam *camsc;
165 camsc = (struct aac_cam *)device_get_softc(dev);
166 inf = (struct aac_sim *)device_get_ivars(dev);
169 devq = cam_simq_alloc(inf->TargetsPerBus);
173 sim = cam_sim_alloc(aac_cam_action, aac_cam_poll, "aacp", camsc,
174 device_get_unit(dev), 1, 1, devq);
180 /* Since every bus has it's own sim, every bus 'appears' as bus 0 */
181 if (xpt_bus_register(sim, 0) != CAM_SUCCESS) {
182 cam_sim_free(sim, TRUE);
186 if (xpt_create_path(&path, NULL, cam_sim_path(sim),
187 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
188 xpt_bus_deregister(cam_sim_path(sim));
189 cam_sim_free(sim, TRUE);
200 aac_cam_action(struct cam_sim *sim, union ccb *ccb)
202 struct aac_cam *camsc;
203 struct aac_softc *sc;
204 struct aac_srb32 *srb;
206 struct aac_command *cm;
210 camsc = (struct aac_cam *)cam_sim_softc(sim);
211 sc = camsc->inf->aac_sc;
213 /* Synchronous ops, and ops that don't require communication with the
215 switch(ccb->ccb_h.func_code) {
218 /* These are handled down below */
220 case XPT_CALC_GEOMETRY:
222 struct ccb_calc_geometry *ccg;
224 u_int32_t secs_per_cylinder;
227 size_mb = ccg->volume_size /
228 ((1024L * 1024L) / ccg->block_size);
229 if (size_mb >= (2 * 1024)) { /* 2GB */
231 ccg->secs_per_track = 63;
232 } else if (size_mb >= (1 * 1024)) { /* 1GB */
234 ccg->secs_per_track = 32;
237 ccg->secs_per_track = 32;
239 secs_per_cylinder = ccg->heads * ccg->secs_per_track;
240 ccg->cylinders = ccg->volume_size / secs_per_cylinder;
242 ccb->ccb_h.status = CAM_REQ_CMP;
248 struct ccb_pathinq *cpi = &ccb->cpi;
250 cpi->version_num = 1;
251 cpi->hba_inquiry = PI_WIDE_16;
252 cpi->target_sprt = 0;
254 /* Resetting via the passthrough causes problems. */
255 cpi->hba_misc = PIM_NOBUSRESET;
256 cpi->hba_eng_cnt = 0;
257 cpi->max_target = camsc->inf->TargetsPerBus;
258 cpi->max_lun = 8; /* Per the controller spec */
259 cpi->initiator_id = camsc->inf->InitiatorBusId;
260 cpi->bus_id = camsc->inf->BusNumber;
261 cpi->base_transfer_speed = 3300;
262 strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
263 strncpy(cpi->hba_vid, "Adaptec", HBA_IDLEN);
264 strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
265 cpi->unit_number = cam_sim_unit(sim);
267 ccb->ccb_h.status = CAM_REQ_CMP;
271 case XPT_GET_TRAN_SETTINGS:
273 ccb->cts.flags &= ~(CCB_TRANS_DISC_ENB | CCB_TRANS_TAG_ENB);
274 ccb->cts.valid = CCB_TRANS_DISC_VALID | CCB_TRANS_TQ_VALID;
275 ccb->ccb_h.status = CAM_REQ_CMP;
279 case XPT_SET_TRAN_SETTINGS:
280 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
284 if (!(sc->flags & AAC_FLAGS_CAM_NORESET)) {
285 ccb->ccb_h.status = aac_cam_reset_bus(sim, ccb);
287 ccb->ccb_h.status = CAM_REQ_CMP;
292 ccb->ccb_h.status = aac_cam_abort_ccb(sim, ccb);
296 ccb->ccb_h.status = aac_cam_term_io(sim, ccb);
300 device_printf(sc->aac_dev, "Unsupported command 0x%x\n",
301 ccb->ccb_h.func_code);
302 ccb->ccb_h.status = CAM_PROVIDE_FAIL;
307 /* Async ops that require communcation with the controller */
309 mtx_lock(&sc->aac_io_lock);
310 if (aac_alloc_command(sc, &cm)) {
311 struct aac_event *event;
313 xpt_freeze_simq(sim, 1);
314 ccb->ccb_h.status = CAM_REQUEUE_REQ;
316 event = malloc(sizeof(struct aac_event), M_AACCAM,
319 device_printf(sc->aac_dev,
320 "Warning, out of memory for event\n");
321 /* XXX Yuck, what to do here? */
322 mtx_unlock(&sc->aac_io_lock);
325 event->ev_callback = aac_cam_event;
326 event->ev_arg = camsc;
327 event->ev_type = AAC_EVENT_CMFREE;
328 aac_add_event(sc, event);
329 mtx_unlock(&sc->aac_io_lock);
334 srb = (struct aac_srb32 *)&fib->data[0];
337 switch (ccb->ccb_h.flags & CAM_DIR_MASK) {
339 srb->flags = AAC_SRB_FLAGS_DATA_IN;
340 cm->cm_flags |= AAC_CMD_DATAIN;
343 srb->flags = AAC_SRB_FLAGS_DATA_OUT;
344 cm->cm_flags |= AAC_CMD_DATAOUT;
347 srb->flags = AAC_SRB_FLAGS_NO_DATA_XFER;
350 srb->flags = AAC_SRB_FLAGS_UNSPECIFIED_DIRECTION;
351 cm->cm_flags |= AAC_CMD_DATAIN | AAC_CMD_DATAOUT;
355 switch(ccb->ccb_h.func_code) {
358 struct ccb_scsiio *csio = &ccb->csio;
360 srb->function = AAC_SRB_FUNC_EXECUTE_SCSI;
363 * Copy the CDB into the SRB. It's only 6-16 bytes,
364 * so a copy is not too expensive.
366 srb->cdb_len = csio->cdb_len;
367 if (ccb->ccb_h.flags & CAM_CDB_POINTER)
368 bcopy(csio->cdb_io.cdb_ptr, (u_int8_t *)&srb->cdb[0],
371 bcopy(csio->cdb_io.cdb_bytes, (u_int8_t *)&srb->cdb[0],
374 /* Map the s/g list. XXX 32bit addresses only! */
375 if ((ccb->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE) {
376 if ((ccb->ccb_h.flags & CAM_SCATTER_VALID) == 0) {
377 srb->data_len = csio->dxfer_len;
378 if (ccb->ccb_h.flags & CAM_DATA_PHYS) {
380 * XXX This isn't 64-bit clean.
381 * However, this condition is not
382 * normally used in CAM.
384 srb->sg_map32.SgCount = 1;
385 srb->sg_map32.SgEntry[0].SgAddress =
386 (uint32_t)(uintptr_t)csio->data_ptr;
387 srb->sg_map32.SgEntry[0].SgByteCount =
391 * Arrange things so that the S/G
392 * map will get set up automagically
394 cm->cm_data = (void *)csio->data_ptr;
395 cm->cm_datalen = csio->dxfer_len;
396 cm->cm_sgtable = &srb->sg_map32;
399 /* XXX Need to handle multiple s/g elements */
400 panic("aac_cam: multiple s/g elements");
403 srb->sg_map32.SgCount = 0;
404 srb->sg_map32.SgEntry[0].SgByteCount = 0;
411 if (!(sc->flags & AAC_FLAGS_CAM_NORESET)) {
412 srb->function = AAC_SRB_FUNC_RESET_DEVICE;
415 ccb->ccb_h.status = CAM_REQ_CMP;
423 srb->bus = camsc->inf->BusNumber; /* Bus number relative to the card */
424 srb->target = ccb->ccb_h.target_id;
425 srb->lun = ccb->ccb_h.target_lun;
426 srb->timeout = ccb->ccb_h.timeout; /* XXX */
427 srb->retry_limit = 0;
429 cm->cm_complete = aac_cam_complete;
430 cm->cm_private = ccb;
431 cm->cm_timestamp = time_uptime;
432 cm->cm_queue = AAC_ADAP_NORM_CMD_QUEUE;
434 fib->Header.XferState =
435 AAC_FIBSTATE_HOSTOWNED |
436 AAC_FIBSTATE_INITIALISED |
437 AAC_FIBSTATE_FROMHOST |
438 AAC_FIBSTATE_REXPECTED |
440 fib->Header.Command = ScsiPortCommand;
441 fib->Header.Size = sizeof(struct aac_fib_header) +
442 sizeof(struct aac_srb32);
444 aac_enqueue_ready(cm);
445 aac_startio(cm->cm_sc);
447 mtx_unlock(&sc->aac_io_lock);
453 aac_cam_poll(struct cam_sim *sim)
456 * Pinging the interrupt routine isn't very safe, nor is it
457 * really necessary. Do nothing.
462 aac_cam_complete(struct aac_command *cm)
465 struct aac_srb_response *srbr;
466 struct aac_softc *sc;
471 ccb = cm->cm_private;
472 srbr = (struct aac_srb_response *)&cm->cm_fib->data[0];
474 if (srbr->fib_status != 0) {
475 device_printf(sc->aac_dev, "Passthru FIB failed!\n");
476 ccb->ccb_h.status = CAM_REQ_ABORTED;
479 * The SRB error codes just happen to match the CAM error
480 * codes. How convienient!
482 ccb->ccb_h.status = srbr->srb_status;
484 /* Take care of SCSI_IO ops. */
485 if (ccb->ccb_h.func_code == XPT_SCSI_IO) {
486 u_int8_t command, device;
488 ccb->csio.scsi_status = srbr->scsi_status;
490 /* Take care of autosense */
491 if (srbr->sense_len) {
492 int sense_len, scsi_sense_len;
494 scsi_sense_len = sizeof(struct scsi_sense_data);
495 bzero(&ccb->csio.sense_data, scsi_sense_len);
496 sense_len = (srbr->sense_len >
497 scsi_sense_len) ? scsi_sense_len :
499 bcopy(&srbr->sense[0], &ccb->csio.sense_data,
501 ccb->csio.sense_len = sense_len;
502 ccb->ccb_h.status |= CAM_AUTOSNS_VALID;
503 // scsi_sense_print(&ccb->csio);
506 /* If this is an inquiry command, fake things out */
507 if (ccb->ccb_h.flags & CAM_CDB_POINTER)
508 command = ccb->csio.cdb_io.cdb_ptr[0];
510 command = ccb->csio.cdb_io.cdb_bytes[0];
512 if ((command == INQUIRY) &&
513 (ccb->ccb_h.status == CAM_REQ_CMP)) {
514 device = ccb->csio.data_ptr[0] & 0x1f;
516 * We want DASD and PROC devices to only be
517 * visible through the pass device.
519 if ((device == T_DIRECT) ||
520 (device == T_PROCESSOR) ||
521 (sc->flags & AAC_FLAGS_CAM_PASSONLY))
522 ccb->csio.data_ptr[0] =
523 ((device & 0xe0) | T_NODEVICE);
528 aac_release_command(cm);
535 aac_cam_reset_bus(struct cam_sim *sim, union ccb *ccb)
538 struct aac_softc *sc;
539 struct aac_cam *camsc;
540 struct aac_vmioctl *vmi;
541 struct aac_resetbus *rbc;
544 camsc = (struct aac_cam *)cam_sim_softc(sim);
545 sc = camsc->inf->aac_sc;
548 printf("Null sc?\n");
549 return (CAM_REQ_ABORTED);
552 mtx_lock(&sc->aac_io_lock);
553 aac_alloc_sync_fib(sc, &fib);
555 vmi = (struct aac_vmioctl *)&fib->data[0];
556 bzero(vmi, sizeof(struct aac_vmioctl));
558 vmi->Command = VM_Ioctl;
559 vmi->ObjType = FT_DRIVE;
560 vmi->MethId = sc->scsi_method_id;
562 vmi->IoctlCmd = ResetBus;
564 rbc = (struct aac_resetbus *)&vmi->IoctlBuf[0];
565 rbc->BusNumber = camsc->inf->BusNumber;
567 e = aac_sync_fib(sc, ContainerCommand, 0, fib,
568 sizeof(struct aac_vmioctl));
570 device_printf(sc->aac_dev,"Error %d sending ResetBus command\n",
572 aac_release_sync_fib(sc);
573 return (CAM_REQ_ABORTED);
576 aac_release_sync_fib(sc);
577 mtx_unlock(&sc->aac_io_lock);
578 return (CAM_REQ_CMP);
582 aac_cam_abort_ccb(struct cam_sim *sim, union ccb *ccb)
584 return (CAM_UA_ABORT);
588 aac_cam_term_io(struct cam_sim *sim, union ccb *ccb)
590 return (CAM_UA_TERMIO);