xref: /freebsd/sys/dev/aac/aac_cam.c (revision bfe691b2f75de2224c7ceb304ebcdef2b42d4179) 
1 /*-
2  * Copyright (c) 2002 Adaptec, Inc.
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  * 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.
13  *
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
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 /*
31  * CAM front-end for communicating with non-DASD devices
32  */
33 
34 #include "opt_aac.h"
35 
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>
42 
43 #include <cam/cam.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>
50 
51 #include <sys/bus.h>
52 #include <sys/conf.h>
53 #include <sys/disk.h>
54 
55 #include <machine/md_var.h>
56 #include <machine/bus.h>
57 #include <sys/rman.h>
58 
59 #include <vm/vm.h>
60 #include <vm/pmap.h>
61 
62 #include <dev/aac/aacreg.h>
63 #include <sys/aac_ioctl.h>
64 #include <dev/aac/aacvar.h>
65 
66 struct aac_cam {
67 	device_t		dev;
68 	struct aac_sim		*inf;
69 	struct cam_sim		*sim;
70 	struct cam_path		*path;
71 };
72 
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 *);
82 
83 static devclass_t	aac_pass_devclass;
84 
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),
89 	{ 0, 0 }
90 };
91 
92 static driver_t	aac_pass_driver = {
93 	"aacp",
94 	aac_pass_methods,
95 	sizeof(struct aac_cam)
96 };
97 
98 DRIVER_MODULE(aacp, aac, aac_pass_driver, aac_pass_devclass, 0, 0);
99 MODULE_DEPEND(aacp, cam, 1, 1, 1);
100 
101 MALLOC_DEFINE(M_AACCAM, "aaccam", "AAC CAM info");
102 
103 static void
104 aac_cam_event(struct aac_softc *sc, struct aac_event *event, void *arg)
105 {
106 	struct aac_cam *camsc;
107 
108 	switch (event->ev_type) {
109 	case AAC_EVENT_CMFREE:
110 		camsc = arg;
111 		free(event, M_AACCAM);
112 		xpt_release_simq(camsc->sim, 1);
113 		break;
114 	default:
115 		device_printf(sc->aac_dev, "unknown event %d in aac_cam\n",
116 		    event->ev_type);
117 		break;
118 	}
119 
120 	return;
121 }
122 
123 static int
124 aac_cam_probe(device_t dev)
125 {
126 	debug_called(2);
127 
128 	return (0);
129 }
130 
131 static int
132 aac_cam_detach(device_t dev)
133 {
134 	struct aac_cam *camsc;
135 	debug_called(2);
136 
137 	camsc = (struct aac_cam *)device_get_softc(dev);
138 
139 	mtx_lock(&Giant);
140 
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);
145 
146 	mtx_unlock(&Giant);
147 
148 	return (0);
149 }
150 
151 /*
152  * Register the driver as a CAM SIM
153  */
154 static int
155 aac_cam_attach(device_t dev)
156 {
157 	struct cam_devq *devq;
158 	struct cam_sim *sim;
159 	struct cam_path *path;
160 	struct aac_cam *camsc;
161 	struct aac_sim *inf;
162 
163 	debug_called(1);
164 
165 	camsc = (struct aac_cam *)device_get_softc(dev);
166 	inf = (struct aac_sim *)device_get_ivars(dev);
167 	camsc->inf = inf;
168 
169 	devq = cam_simq_alloc(inf->TargetsPerBus);
170 	if (devq == NULL)
171 		return (EIO);
172 
173 	sim = cam_sim_alloc(aac_cam_action, aac_cam_poll, "aacp", camsc,
174 	    device_get_unit(dev), 1, 1, devq);
175 	if (sim == NULL) {
176 		cam_simq_free(devq);
177 		return (EIO);
178 	}
179 
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);
183 		return (EIO);
184 	}
185 
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);
190 		return (EIO);
191 	}
192 
193 	camsc->sim = sim;
194 	camsc->path = path;
195 
196 	return (0);
197 }
198 
199 static void
200 aac_cam_action(struct cam_sim *sim, union ccb *ccb)
201 {
202 	struct	aac_cam *camsc;
203 	struct	aac_softc *sc;
204 	struct	aac_srb32 *srb;
205 	struct	aac_fib *fib;
206 	struct	aac_command *cm;
207 
208 	debug_called(2);
209 
210 	camsc = (struct aac_cam *)cam_sim_softc(sim);
211 	sc = camsc->inf->aac_sc;
212 
213 	/* Synchronous ops, and ops that don't require communication with the
214 	 * controller */
215 	switch(ccb->ccb_h.func_code) {
216 	case XPT_SCSI_IO:
217 	case XPT_RESET_DEV:
218 		/* These are handled down below */
219 		break;
220 	case XPT_CALC_GEOMETRY:
221 	{
222 		struct ccb_calc_geometry *ccg;
223 		u_int32_t size_mb;
224 		u_int32_t secs_per_cylinder;
225 
226 		ccg = &ccb->ccg;
227 		size_mb = ccg->volume_size /
228 		    ((1024L * 1024L) / ccg->block_size);
229 		if (size_mb >= (2 * 1024)) {		/* 2GB */
230 			ccg->heads = 255;
231 			ccg->secs_per_track = 63;
232 		} else if (size_mb >= (1 * 1024)) {	/* 1GB */
233 			ccg->heads = 128;
234 			ccg->secs_per_track = 32;
235 		} else {
236 			ccg->heads = 64;
237 			ccg->secs_per_track = 32;
238 		}
239 		secs_per_cylinder = ccg->heads * ccg->secs_per_track;
240 		ccg->cylinders = ccg->volume_size / secs_per_cylinder;
241 
242 		ccb->ccb_h.status = CAM_REQ_CMP;
243 		xpt_done(ccb);
244 		return;
245 	}
246 	case XPT_PATH_INQ:
247 	{
248 		struct ccb_pathinq *cpi = &ccb->cpi;
249 
250 		cpi->version_num = 1;
251 		cpi->hba_inquiry = PI_WIDE_16;
252 		cpi->target_sprt = 0;
253 
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);
266                 cpi->transport = XPORT_SPI;
267                 cpi->transport_version = 2;
268                 cpi->protocol = PROTO_SCSI;
269                 cpi->protocol_version = SCSI_REV_2;
270 		ccb->ccb_h.status = CAM_REQ_CMP;
271 		xpt_done(ccb);
272 		return;
273 	}
274 	case XPT_GET_TRAN_SETTINGS:
275 	{
276 		struct ccb_trans_settings_scsi *scsi =
277 			&ccb->cts.proto_specific.scsi;
278 		struct ccb_trans_settings_spi *spi =
279 			&ccb->cts.xport_specific.spi;
280 		ccb->cts.protocol = PROTO_SCSI;
281 		ccb->cts.protocol_version = SCSI_REV_2;
282 		ccb->cts.transport = XPORT_SPI;
283 		ccb->cts.transport_version = 2;
284 		if (ccb->ccb_h.target_lun != CAM_LUN_WILDCARD) {
285 			scsi->valid = CTS_SCSI_VALID_TQ;
286 			spi->valid |= CTS_SPI_VALID_DISC;
287 		} else {
288 			scsi->valid = 0;
289 		}
290 		ccb->ccb_h.status = CAM_REQ_CMP;
291 		xpt_done(ccb);
292 		return;
293 	}
294 	case XPT_SET_TRAN_SETTINGS:
295 		ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
296 		xpt_done(ccb);
297 		return;
298 	case XPT_RESET_BUS:
299 		if (!(sc->flags & AAC_FLAGS_CAM_NORESET)) {
300 			ccb->ccb_h.status = aac_cam_reset_bus(sim, ccb);
301 		} else {
302 			ccb->ccb_h.status = CAM_REQ_CMP;
303 		}
304 		xpt_done(ccb);
305 		return;
306 	case XPT_ABORT:
307 		ccb->ccb_h.status = aac_cam_abort_ccb(sim, ccb);
308 		xpt_done(ccb);
309 		return;
310 	case XPT_TERM_IO:
311 		ccb->ccb_h.status = aac_cam_term_io(sim, ccb);
312 		xpt_done(ccb);
313 		return;
314 	default:
315 		device_printf(sc->aac_dev, "Unsupported command 0x%x\n",
316 		    ccb->ccb_h.func_code);
317 		ccb->ccb_h.status = CAM_PROVIDE_FAIL;
318 		xpt_done(ccb);
319 		return;
320 	}
321 
322 	/* Async ops that require communcation with the controller */
323 
324 	mtx_lock(&sc->aac_io_lock);
325 	if (aac_alloc_command(sc, &cm)) {
326 		struct aac_event *event;
327 
328 		xpt_freeze_simq(sim, 1);
329 		ccb->ccb_h.status = CAM_REQUEUE_REQ;
330 		xpt_done(ccb);
331 		event = malloc(sizeof(struct aac_event), M_AACCAM,
332 		    M_NOWAIT | M_ZERO);
333 		if (event == NULL) {
334 			device_printf(sc->aac_dev,
335 			    "Warning, out of memory for event\n");
336 			/* XXX Yuck, what to do here? */
337 			mtx_unlock(&sc->aac_io_lock);
338 			return;
339 		}
340 		event->ev_callback = aac_cam_event;
341 		event->ev_arg = camsc;
342 		event->ev_type = AAC_EVENT_CMFREE;
343 		aac_add_event(sc, event);
344 		mtx_unlock(&sc->aac_io_lock);
345 		return;
346 	}
347 
348 	fib = cm->cm_fib;
349 	srb = (struct aac_srb32 *)&fib->data[0];
350 	cm->cm_datalen = 0;
351 
352 	switch (ccb->ccb_h.flags & CAM_DIR_MASK) {
353 	case CAM_DIR_IN:
354 		srb->flags = AAC_SRB_FLAGS_DATA_IN;
355 		cm->cm_flags |= AAC_CMD_DATAIN;
356 		break;
357 	case CAM_DIR_OUT:
358 		srb->flags = AAC_SRB_FLAGS_DATA_OUT;
359 		cm->cm_flags |= AAC_CMD_DATAOUT;
360 		break;
361 	case CAM_DIR_NONE:
362 		srb->flags = AAC_SRB_FLAGS_NO_DATA_XFER;
363 		break;
364 	default:
365 		srb->flags = AAC_SRB_FLAGS_UNSPECIFIED_DIRECTION;
366 		cm->cm_flags |= AAC_CMD_DATAIN | AAC_CMD_DATAOUT;
367 		break;
368 	}
369 
370 	switch(ccb->ccb_h.func_code) {
371 	case XPT_SCSI_IO:
372 	{
373 		struct ccb_scsiio *csio = &ccb->csio;
374 
375 		srb->function = AAC_SRB_FUNC_EXECUTE_SCSI;
376 
377 		/*
378 		 * Copy the CDB into the SRB.  It's only 6-16 bytes,
379 		 * so a copy is not too expensive.
380 		 */
381 		srb->cdb_len = csio->cdb_len;
382 		if (ccb->ccb_h.flags & CAM_CDB_POINTER)
383 			bcopy(csio->cdb_io.cdb_ptr, (u_int8_t *)&srb->cdb[0],
384 			    srb->cdb_len);
385 		else
386 			bcopy(csio->cdb_io.cdb_bytes, (u_int8_t *)&srb->cdb[0],
387 			    srb->cdb_len);
388 
389 		/* Map the s/g list. XXX 32bit addresses only! */
390 		if ((ccb->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE) {
391 			if ((ccb->ccb_h.flags & CAM_SCATTER_VALID) == 0) {
392 				srb->data_len = csio->dxfer_len;
393 				if (ccb->ccb_h.flags & CAM_DATA_PHYS) {
394 					/*
395 					 * XXX This isn't 64-bit clean.
396 					 * However, this condition is not
397 					 * normally used in CAM.
398 					 */
399 					srb->sg_map32.SgCount = 1;
400 					srb->sg_map32.SgEntry[0].SgAddress =
401 					    (uint32_t)(uintptr_t)csio->data_ptr;
402 					srb->sg_map32.SgEntry[0].SgByteCount =
403 					    csio->dxfer_len;
404 				} else {
405 					/*
406 					 * Arrange things so that the S/G
407 					 * map will get set up automagically
408 					 */
409 					cm->cm_data = (void *)csio->data_ptr;
410 					cm->cm_datalen = csio->dxfer_len;
411 					cm->cm_sgtable = &srb->sg_map32;
412 				}
413 			} else {
414 				/* XXX Need to handle multiple s/g elements */
415 				panic("aac_cam: multiple s/g elements");
416 			}
417 		} else {
418 			srb->sg_map32.SgCount = 0;
419 			srb->sg_map32.SgEntry[0].SgByteCount = 0;
420 			srb->data_len = 0;
421 		}
422 
423 		break;
424 	}
425 	case XPT_RESET_DEV:
426 		if (!(sc->flags & AAC_FLAGS_CAM_NORESET)) {
427 			srb->function = AAC_SRB_FUNC_RESET_DEVICE;
428 			break;
429 		} else {
430 			ccb->ccb_h.status = CAM_REQ_CMP;
431 			xpt_done(ccb);
432 			mtx_unlock(&sc->aac_io_lock);
433 			return;
434 		}
435 	default:
436 		break;
437 	}
438 
439 	srb->bus = camsc->inf->BusNumber; /* Bus number relative to the card */
440 	srb->target = ccb->ccb_h.target_id;
441 	srb->lun = ccb->ccb_h.target_lun;
442 	srb->timeout = ccb->ccb_h.timeout;	/* XXX */
443 	srb->retry_limit = 0;
444 
445 	cm->cm_complete = aac_cam_complete;
446 	cm->cm_private = ccb;
447 	cm->cm_timestamp = time_uptime;
448 	cm->cm_queue = AAC_ADAP_NORM_CMD_QUEUE;
449 
450 	fib->Header.XferState =
451 	    AAC_FIBSTATE_HOSTOWNED	|
452 	    AAC_FIBSTATE_INITIALISED	|
453 	    AAC_FIBSTATE_FROMHOST	|
454 	    AAC_FIBSTATE_REXPECTED	|
455 	    AAC_FIBSTATE_NORM;
456 	fib->Header.Command = ScsiPortCommand;
457 	fib->Header.Size = sizeof(struct aac_fib_header) +
458 	    sizeof(struct aac_srb32);
459 
460 	aac_enqueue_ready(cm);
461 	aac_startio(cm->cm_sc);
462 
463 	mtx_unlock(&sc->aac_io_lock);
464 
465 	return;
466 }
467 
468 static void
469 aac_cam_poll(struct cam_sim *sim)
470 {
471 	/*
472 	 * Pinging the interrupt routine isn't very safe, nor is it
473 	 * really necessary.  Do nothing.
474 	 */
475 }
476 
477 static void
478 aac_cam_complete(struct aac_command *cm)
479 {
480 	union	ccb *ccb;
481 	struct 	aac_srb_response *srbr;
482 	struct	aac_softc *sc;
483 
484 	debug_called(2);
485 
486 	sc = cm->cm_sc;
487 	ccb = cm->cm_private;
488 	srbr = (struct aac_srb_response *)&cm->cm_fib->data[0];
489 
490 	if (srbr->fib_status != 0) {
491 		device_printf(sc->aac_dev, "Passthru FIB failed!\n");
492 		ccb->ccb_h.status = CAM_REQ_ABORTED;
493 	} else {
494 		/*
495 		 * The SRB error codes just happen to match the CAM error
496 		 * codes.  How convienient!
497 		 */
498 		ccb->ccb_h.status = srbr->srb_status;
499 
500 		/* Take care of SCSI_IO ops. */
501 		if (ccb->ccb_h.func_code == XPT_SCSI_IO) {
502 			u_int8_t command, device;
503 
504 			ccb->csio.scsi_status = srbr->scsi_status;
505 
506 			/* Take care of autosense */
507 			if (srbr->sense_len) {
508 				int sense_len, scsi_sense_len;
509 
510 				scsi_sense_len = sizeof(struct scsi_sense_data);
511 				bzero(&ccb->csio.sense_data, scsi_sense_len);
512 				sense_len = (srbr->sense_len >
513 				    scsi_sense_len) ? scsi_sense_len :
514 				    srbr->sense_len;
515 				bcopy(&srbr->sense[0], &ccb->csio.sense_data,
516 				    srbr->sense_len);
517 				ccb->csio.sense_len = sense_len;
518 				ccb->ccb_h.status |= CAM_AUTOSNS_VALID;
519 				// scsi_sense_print(&ccb->csio);
520 			}
521 
522 			/* If this is an inquiry command, fake things out */
523 			if (ccb->ccb_h.flags & CAM_CDB_POINTER)
524 				command = ccb->csio.cdb_io.cdb_ptr[0];
525 			else
526 				command = ccb->csio.cdb_io.cdb_bytes[0];
527 
528 			if ((command == INQUIRY) &&
529 			    (ccb->ccb_h.status == CAM_REQ_CMP)) {
530 				device = ccb->csio.data_ptr[0] & 0x1f;
531 				/*
532 				 * We want DASD and PROC devices to only be
533 				 * visible through the pass device.
534 				 */
535 				if ((device == T_DIRECT) ||
536 				    (device == T_PROCESSOR) ||
537 				    (sc->flags & AAC_FLAGS_CAM_PASSONLY))
538 					ccb->csio.data_ptr[0] =
539 					    ((device & 0xe0) | T_NODEVICE);
540 			}
541 		}
542 	}
543 
544 	aac_release_command(cm);
545 	xpt_done(ccb);
546 
547 	return;
548 }
549 
550 static u_int32_t
551 aac_cam_reset_bus(struct cam_sim *sim, union ccb *ccb)
552 {
553 	struct aac_fib *fib;
554 	struct aac_softc *sc;
555 	struct aac_cam *camsc;
556 	struct aac_vmioctl *vmi;
557 	struct aac_resetbus *rbc;
558 	int e;
559 
560 	camsc = (struct aac_cam *)cam_sim_softc(sim);
561 	sc = camsc->inf->aac_sc;
562 
563 	if (sc == NULL) {
564 		printf("Null sc?\n");
565 		return (CAM_REQ_ABORTED);
566 	}
567 
568 	mtx_lock(&sc->aac_io_lock);
569 	aac_alloc_sync_fib(sc, &fib);
570 
571 	vmi = (struct aac_vmioctl *)&fib->data[0];
572 	bzero(vmi, sizeof(struct aac_vmioctl));
573 
574 	vmi->Command = VM_Ioctl;
575 	vmi->ObjType = FT_DRIVE;
576 	vmi->MethId = sc->scsi_method_id;
577 	vmi->ObjId = 0;
578 	vmi->IoctlCmd = ResetBus;
579 
580 	rbc = (struct aac_resetbus *)&vmi->IoctlBuf[0];
581 	rbc->BusNumber = camsc->inf->BusNumber;
582 
583 	e = aac_sync_fib(sc, ContainerCommand, 0, fib,
584 	    sizeof(struct aac_vmioctl));
585 	if (e) {
586 		device_printf(sc->aac_dev,"Error %d sending ResetBus command\n",
587 		    e);
588 		aac_release_sync_fib(sc);
589 		mtx_unlock(&sc->aac_io_lock);
590 		return (CAM_REQ_ABORTED);
591 	}
592 
593 	aac_release_sync_fib(sc);
594 	mtx_unlock(&sc->aac_io_lock);
595 	return (CAM_REQ_CMP);
596 }
597 
598 static u_int32_t
599 aac_cam_abort_ccb(struct cam_sim *sim, union ccb *ccb)
600 {
601 	return (CAM_UA_ABORT);
602 }
603 
604 static u_int32_t
605 aac_cam_term_io(struct cam_sim *sim, union ccb *ccb)
606 {
607 	return (CAM_UA_TERMIO);
608 }
609 
610