2 * Copyright (c) 2000 Michael Smith
3 * Copyright (c) 2000 BSDi
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * Copyright (c) 2002 Eric Moore
28 * Copyright (c) 2002 LSI Logic Corporation
29 * All rights reserved.
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
34 * 1. Redistributions of source code must retain the above copyright
35 * notice, this list of conditions and the following disclaimer.
36 * 2. Redistributions in binary form must reproduce the above copyright
37 * notice, this list of conditions and the following disclaimer in the
38 * documentation and/or other materials provided with the distribution.
39 * 3. The party using or redistributing the source code and binary forms
40 * agrees to the disclaimer below and the terms and conditions set forth
43 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
44 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
46 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
47 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
48 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
49 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
51 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
52 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55 * $FreeBSD: src/sys/dev/amr/amr_cam.c,v 1.1.2.3 2002/11/11 13:19:10 emoore Exp $
56 * $DragonFly: src/sys/dev/raid/amr/amr_cam.c,v 1.5 2004/06/21 15:39:30 dillon Exp $
59 #include <sys/param.h>
60 #include <sys/systm.h>
61 #include <sys/malloc.h>
62 #include <sys/kernel.h>
64 #include "amr_compat.h"
67 #include <sys/devicestat.h>
71 #include <bus/cam/cam.h>
72 #include <bus/cam/cam_ccb.h>
73 #include <bus/cam/cam_sim.h>
74 #include <bus/cam/cam_xpt.h>
75 #include <bus/cam/cam_xpt_sim.h>
76 #include <bus/cam/cam_debug.h>
77 #include <bus/cam/scsi/scsi_all.h>
78 #include <bus/cam/scsi/scsi_message.h>
80 #include <machine/resource.h>
81 #include <machine/bus.h>
86 static void amr_cam_action(struct cam_sim *sim, union ccb *ccb);
87 static void amr_cam_poll(struct cam_sim *sim);
88 static void amr_cam_complete(struct amr_command *ac);
89 static void amr_cam_complete_extcdb(struct amr_command *ac);
92 /********************************************************************************
93 * Enqueue/dequeue functions
96 amr_enqueue_ccb(struct amr_softc *sc, union ccb *ccb)
101 TAILQ_INSERT_TAIL(&sc->amr_cam_ccbq, &ccb->ccb_h, sim_links.tqe);
106 amr_requeue_ccb(struct amr_softc *sc, union ccb *ccb)
111 TAILQ_INSERT_HEAD(&sc->amr_cam_ccbq, &ccb->ccb_h, sim_links.tqe);
115 static __inline union ccb *
116 amr_dequeue_ccb(struct amr_softc *sc)
122 if ((ccb = (union ccb *)TAILQ_FIRST(&sc->amr_cam_ccbq)) != NULL)
123 TAILQ_REMOVE(&sc->amr_cam_ccbq, &ccb->ccb_h, sim_links.tqe);
128 /********************************************************************************
129 * Attach our 'real' SCSI channels to CAM
132 amr_cam_attach(struct amr_softc *sc)
134 struct cam_devq *devq;
137 /* initialise the ccb queue */
138 TAILQ_INIT(&sc->amr_cam_ccbq);
141 * Allocate a devq for all our channels combined. This should
142 * allow for the maximum number of SCSI commands we will accept
145 if ((devq = cam_simq_alloc(AMR_MAX_SCSI_CMDS)) == NULL)
149 * Iterate over our channels, registering them with CAM
151 for (chn = 0; chn < sc->amr_maxchan; chn++) {
154 if ((sc->amr_cam_sim[chn] = cam_sim_alloc(amr_cam_action,
158 device_get_unit(sc->amr_dev),
162 device_printf(sc->amr_dev, "CAM SIM attach failed\n");
166 /* register the bus ID so we can get it later */
167 if (xpt_bus_register(sc->amr_cam_sim[chn], chn)) {
168 device_printf(sc->amr_dev, "CAM XPT bus registration failed\n");
172 cam_simq_release(devq);
174 * XXX we should scan the config and work out which devices are actually
180 /********************************************************************************
181 * Disconnect ourselves from CAM
184 amr_cam_detach(struct amr_softc *sc)
189 * If a sim was allocated for a channel, free it
191 for (chn = 0; chn < sc->amr_maxchan; chn++) {
192 if (sc->amr_cam_sim[chn] != NULL) {
193 xpt_bus_deregister(cam_sim_path(sc->amr_cam_sim[chn]));
194 cam_sim_free(sc->amr_cam_sim[chn]);
199 /********************************************************************************
200 ********************************************************************************
201 CAM passthrough interface
202 ********************************************************************************
203 ********************************************************************************/
205 /********************************************************************************
206 * Handle a request for action from CAM
209 amr_cam_action(struct cam_sim *sim, union ccb *ccb)
211 struct amr_softc *sc = cam_sim_softc(sim);
213 switch(ccb->ccb_h.func_code) {
216 * Perform SCSI I/O to a physical device.
220 struct ccb_hdr *ccbh = &ccb->ccb_h;
221 struct ccb_scsiio *csio = &ccb->csio;
223 /* Validate the CCB */
224 ccbh->status = CAM_REQ_INPROG;
226 /* check the CDB length */
227 if (csio->cdb_len > AMR_MAX_EXTCDB_LEN)
228 ccbh->status = CAM_REQ_CMP_ERR;
230 if ((csio->cdb_len > AMR_MAX_CDB_LEN) && (sc->support_ext_cdb == 0 ))
231 ccbh->status = CAM_REQ_CMP_ERR;
233 /* check that the CDB pointer is not to a physical address */
234 if ((ccbh->flags & CAM_CDB_POINTER) && (ccbh->flags & CAM_CDB_PHYS))
235 ccbh->status = CAM_REQ_CMP_ERR;
237 /* if there is data transfer, it must be to/from a virtual address */
238 if ((ccbh->flags & CAM_DIR_MASK) != CAM_DIR_NONE) {
239 if (ccbh->flags & CAM_DATA_PHYS) /* we can't map it */
240 ccbh->status = CAM_REQ_CMP_ERR;
241 if (ccbh->flags & CAM_SCATTER_VALID) /* we want to do the s/g setup */
242 ccbh->status = CAM_REQ_CMP_ERR;
246 * If the command is to a LUN other than 0, fail it.
247 * This is probably incorrect, but during testing the firmware did not
248 * seem to respect the LUN field, and thus devices appear echoed.
250 if (csio->ccb_h.target_lun != 0)
251 ccbh->status = CAM_REQ_CMP_ERR;
253 /* if we're happy with the request, queue it for attention */
254 if (ccbh->status == CAM_REQ_INPROG) {
256 /* save the channel number in the ccb */
257 csio->ccb_h.sim_priv.entries[0].field = cam_sim_bus(sim);
259 amr_enqueue_ccb(sc, ccb);
266 case XPT_CALC_GEOMETRY:
268 struct ccb_calc_geometry *ccg = &ccb->ccg;
269 u_int32_t size_in_mb;
270 u_int32_t secs_per_cylinder;
272 size_in_mb = ccg->volume_size / ((1024L * 1024L) / ccg->block_size);
274 if (size_in_mb > 1024) {
276 ccg->secs_per_track = 63;
279 ccg->secs_per_track = 32;
281 secs_per_cylinder = ccg->heads * ccg->secs_per_track;
282 ccg->cylinders = ccg->volume_size / secs_per_cylinder;
283 ccb->ccb_h.status = CAM_REQ_CMP;
288 * Return path stats. Some of these should probably be
293 struct ccb_pathinq *cpi = & ccb->cpi;
295 debug(3, "XPT_PATH_INQ");
296 cpi->version_num = 1; /* XXX??? */
297 cpi->hba_inquiry = PI_SDTR_ABLE|PI_TAG_ABLE|PI_WIDE_16;
298 cpi->target_sprt = 0;
299 cpi->hba_misc = PIM_NOBUSRESET;
300 cpi->hba_eng_cnt = 0;
301 cpi->max_target = AMR_MAX_TARGETS;
302 cpi->max_lun = 0 /* AMR_MAX_LUNS*/;
303 cpi->initiator_id = 7; /* XXX variable? */
304 strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
305 strncpy(cpi->hba_vid, "LSI", HBA_IDLEN);
306 strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
307 cpi->unit_number = cam_sim_unit(sim);
308 cpi->bus_id = cam_sim_bus(sim);
309 cpi->base_transfer_speed = 132 * 1024; /* XXX get from controller? */
310 cpi->ccb_h.status = CAM_REQ_CMP;
317 struct ccb_pathinq *cpi = & ccb->cpi;
319 debug(1, "XPT_RESET_BUS");
320 cpi->ccb_h.status = CAM_REQ_CMP;
326 debug(1, "XPT_RESET_DEV");
327 ccb->ccb_h.status = CAM_REQ_CMP;
331 case XPT_GET_TRAN_SETTINGS:
333 struct ccb_trans_settings *cts;
335 debug(3, "XPT_GET_TRAN_SETTINGS");
339 if ((cts->flags & CCB_TRANS_USER_SETTINGS) == 0) {
340 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
344 cts->flags = CCB_TRANS_DISC_ENB|CCB_TRANS_TAG_ENB;
345 cts->bus_width = MSG_EXT_WDTR_BUS_32_BIT;
346 cts->sync_period = 6; /* 40MHz how wide is this bus? */
347 cts->sync_offset = 31; /* How to extract this from board? */
349 cts->valid = CCB_TRANS_SYNC_RATE_VALID
350 | CCB_TRANS_SYNC_OFFSET_VALID
351 | CCB_TRANS_BUS_WIDTH_VALID
352 | CCB_TRANS_DISC_VALID
353 | CCB_TRANS_TQ_VALID;
354 ccb->ccb_h.status = CAM_REQ_CMP;
358 case XPT_SET_TRAN_SETTINGS:
359 debug(3, "XPT_SET_TRAN_SETTINGS");
360 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
365 * Reject anything else as unsupported.
368 /* we can't do this */
369 ccb->ccb_h.status = CAM_REQ_INVALID;
375 /********************************************************************************
376 * Convert a CAM CCB off the top of the CCB queue to a passthrough SCSI command.
379 amr_cam_command(struct amr_softc *sc, struct amr_command **acp)
381 struct amr_command *ac;
382 struct amr_passthrough *ap;
383 struct amr_ext_passthrough *aep;
384 struct ccb_scsiio *csio;
385 int bus, target, error;
392 /* check to see if there is a ccb for us to work with */
393 if ((csio = (struct ccb_scsiio *)amr_dequeue_ccb(sc)) == NULL)
396 /* get bus/target, XXX validate against protected devices? */
397 bus = csio->ccb_h.sim_priv.entries[0].field;
398 target = csio->ccb_h.target_id;
401 * Build a passthrough command.
404 /* construct passthrough */
405 if (sc->support_ext_cdb ) {
406 aep = malloc(sizeof(*aep), M_DEVBUF, M_INTWAIT | M_ZERO);
409 aep->ap_request_sense_length = 14;
410 aep->ap_islogical = 0;
411 aep->ap_channel = bus;
412 aep->ap_scsi_id = target;
413 aep->ap_logical_drive_no = csio->ccb_h.target_lun;
414 aep->ap_cdb_length = csio->cdb_len;
415 aep->ap_data_transfer_length = csio->dxfer_len;
416 if (csio->ccb_h.flags & CAM_CDB_POINTER) {
417 bcopy(csio->cdb_io.cdb_ptr, aep->ap_cdb, csio->cdb_len);
419 bcopy(csio->cdb_io.cdb_bytes, aep->ap_cdb, csio->cdb_len);
421 /* we leave the data s/g list and s/g count to the map routine later */
423 debug(2, " COMMAND %x/%d+%d to %d:%d:%d", aep->ap_cdb[0], aep->ap_cdb_length, csio->dxfer_len,
424 aep->ap_channel, aep->ap_scsi_id, aep->ap_logical_drive_no);
427 ap = malloc(sizeof(*ap), M_DEVBUF, M_INTWAIT | M_ZERO);
430 ap->ap_request_sense_length = 14;
431 ap->ap_islogical = 0;
432 ap->ap_channel = bus;
433 ap->ap_scsi_id = target;
434 ap->ap_logical_drive_no = csio->ccb_h.target_lun;
435 ap->ap_cdb_length = csio->cdb_len;
436 ap->ap_data_transfer_length = csio->dxfer_len;
437 if (csio->ccb_h.flags & CAM_CDB_POINTER) {
438 bcopy(csio->cdb_io.cdb_ptr, ap->ap_cdb, csio->cdb_len);
440 bcopy(csio->cdb_io.cdb_bytes, ap->ap_cdb, csio->cdb_len);
442 /* we leave the data s/g list and s/g count to the map routine later */
444 debug(2, " COMMAND %x/%d+%d to %d:%d:%d", ap->ap_cdb[0], ap->ap_cdb_length, csio->dxfer_len,
445 ap->ap_channel, ap->ap_scsi_id, ap->ap_logical_drive_no);
448 /* construct command */
449 if ((ac = amr_alloccmd(sc)) == NULL) {
454 ac->ac_flags |= AMR_CMD_DATAOUT;
456 ac->ac_ccb_data = csio->data_ptr;
457 ac->ac_ccb_length = csio->dxfer_len;
458 if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_IN)
459 ac->ac_flags |= AMR_CMD_CCB_DATAIN;
460 if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_OUT)
461 ac->ac_flags |= AMR_CMD_CCB_DATAOUT;
463 ac->ac_private = csio;
464 if ( sc->support_ext_cdb ) {
466 ac->ac_length = sizeof(*aep);
467 ac->ac_complete = amr_cam_complete_extcdb;
468 ac->ac_mailbox.mb_command = AMR_CMD_EXTPASS;
471 ac->ac_length = sizeof(*ap);
472 ac->ac_complete = amr_cam_complete;
473 ac->ac_mailbox.mb_command = AMR_CMD_PASS;
484 if (csio != NULL) /* put it back and try again later */
485 amr_requeue_ccb(sc, (union ccb *)csio);
491 /********************************************************************************
492 * Check for interrupt status
495 amr_cam_poll(struct cam_sim *sim)
497 amr_done(cam_sim_softc(sim));
500 /********************************************************************************
501 * Handle completion of a command submitted via CAM.
504 amr_cam_complete(struct amr_command *ac)
506 struct amr_passthrough *ap = (struct amr_passthrough *)ac->ac_data;
507 struct ccb_scsiio *csio = (struct ccb_scsiio *)ac->ac_private;
508 struct scsi_inquiry_data *inq = (struct scsi_inquiry_data *)csio->data_ptr;
510 /* XXX note that we're ignoring ac->ac_status - good idea? */
512 debug(1, "status 0x%x scsi_status 0x%x", ac->ac_status, ap->ap_scsi_status);
515 * Hide disks from CAM so that they're not picked up and treated as 'normal' disks.
517 * If the configuration provides a mechanism to mark a disk a "not managed", we
518 * could add handling for that to allow disks to be selectively visible.
521 if ((ap->ap_cdb[0] == INQUIRY) && (SID_TYPE(inq) == T_DIRECT)) {
522 bzero(csio->data_ptr, csio->dxfer_len);
523 if (ap->ap_scsi_status == 0xf0) {
524 csio->ccb_h.status = CAM_SCSI_STATUS_ERROR;
526 csio->ccb_h.status = CAM_DEV_NOT_THERE;
530 /* handle passthrough SCSI status */
531 switch(ap->ap_scsi_status) {
532 case 0: /* completed OK */
533 csio->ccb_h.status = CAM_REQ_CMP;
537 csio->ccb_h.status = CAM_SCSI_STATUS_ERROR;
538 csio->scsi_status = SCSI_STATUS_CHECK_COND;
539 bcopy(ap->ap_request_sense_area, &csio->sense_data, AMR_MAX_REQ_SENSE_LEN);
540 csio->sense_len = AMR_MAX_REQ_SENSE_LEN;
541 csio->ccb_h.status |= CAM_AUTOSNS_VALID;
545 csio->ccb_h.status = CAM_SCSI_BUSY;
551 csio->ccb_h.status = CAM_REQ_CMP_ERR;
556 if ((csio->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE)
557 debug(2, "%*D\n", imin(csio->dxfer_len, 16), csio->data_ptr, " ");
558 xpt_done((union ccb *)csio);
562 /********************************************************************************
563 * Handle completion of a command submitted via CAM.
564 * Completion for extended cdb
567 amr_cam_complete_extcdb(struct amr_command *ac)
569 struct amr_ext_passthrough *aep = (struct amr_ext_passthrough *)ac->ac_data;
570 struct ccb_scsiio *csio = (struct ccb_scsiio *)ac->ac_private;
571 struct scsi_inquiry_data *inq = (struct scsi_inquiry_data *)csio->data_ptr;
573 /* XXX note that we're ignoring ac->ac_status - good idea? */
575 debug(1, "status 0x%x scsi_status 0x%x", ac->ac_status, aep->ap_scsi_status);
578 * Hide disks from CAM so that they're not picked up and treated as 'normal' disks.
580 * If the configuration provides a mechanism to mark a disk a "not managed", we
581 * could add handling for that to allow disks to be selectively visible.
584 if ((aep->ap_cdb[0] == INQUIRY) && (SID_TYPE(inq) == T_DIRECT)) {
585 bzero(csio->data_ptr, csio->dxfer_len);
586 if (aep->ap_scsi_status == 0xf0) {
587 csio->ccb_h.status = CAM_SCSI_STATUS_ERROR;
589 csio->ccb_h.status = CAM_DEV_NOT_THERE;
593 /* handle passthrough SCSI status */
594 switch(aep->ap_scsi_status) {
595 case 0: /* completed OK */
596 csio->ccb_h.status = CAM_REQ_CMP;
600 csio->ccb_h.status = CAM_SCSI_STATUS_ERROR;
601 csio->scsi_status = SCSI_STATUS_CHECK_COND;
602 bcopy(aep->ap_request_sense_area, &csio->sense_data, AMR_MAX_REQ_SENSE_LEN);
603 csio->sense_len = AMR_MAX_REQ_SENSE_LEN;
604 csio->ccb_h.status |= CAM_AUTOSNS_VALID;
608 csio->ccb_h.status = CAM_SCSI_BUSY;
614 csio->ccb_h.status = CAM_REQ_CMP_ERR;
619 if ((csio->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE)
620 debug(2, "%*D\n", imin(csio->dxfer_len, 16), csio->data_ptr, " ");
621 xpt_done((union ccb *)csio);