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
28 * Copyright (c) 2002 Eric Moore
29 * Copyright (c) 2002 LSI Logic Corporation
30 * All rights reserved.
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
35 * 1. Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * 2. Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in the
39 * documentation and/or other materials provided with the distribution.
40 * 3. The party using or redistributing the source code and binary forms
41 * agrees to the disclaimer below and the terms and conditions set forth
44 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
45 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
46 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
47 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
48 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
49 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
50 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
51 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
52 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
53 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
57 #include <sys/cdefs.h>
58 __FBSDID("$FreeBSD$");
60 #include <sys/param.h>
61 #include <sys/systm.h>
62 #include <sys/malloc.h>
63 #include <sys/kernel.h>
71 #include <cam/cam_ccb.h>
72 #include <cam/cam_sim.h>
73 #include <cam/cam_xpt.h>
74 #include <cam/cam_xpt_sim.h>
75 #include <cam/cam_debug.h>
76 #include <cam/scsi/scsi_all.h>
77 #include <cam/scsi/scsi_message.h>
79 #include <machine/resource.h>
80 #include <machine/bus.h>
82 #include <dev/amr/amrreg.h>
83 #include <dev/amr/amrvar.h>
85 static void amr_cam_action(struct cam_sim *sim, union ccb *ccb);
86 static void amr_cam_poll(struct cam_sim *sim);
87 static void amr_cam_complete(struct amr_command *ac);
88 static void amr_cam_complete_extcdb(struct amr_command *ac);
91 /********************************************************************************
92 * Enqueue/dequeue functions
95 amr_enqueue_ccb(struct amr_softc *sc, union ccb *ccb)
98 TAILQ_INSERT_TAIL(&sc->amr_cam_ccbq, &ccb->ccb_h, sim_links.tqe);
102 amr_requeue_ccb(struct amr_softc *sc, union ccb *ccb)
105 TAILQ_INSERT_HEAD(&sc->amr_cam_ccbq, &ccb->ccb_h, sim_links.tqe);
108 static __inline union ccb *
109 amr_dequeue_ccb(struct amr_softc *sc)
113 if ((ccb = (union ccb *)TAILQ_FIRST(&sc->amr_cam_ccbq)) != NULL)
114 TAILQ_REMOVE(&sc->amr_cam_ccbq, &ccb->ccb_h, sim_links.tqe);
118 /********************************************************************************
119 * Attach our 'real' SCSI channels to CAM
122 amr_cam_attach(struct amr_softc *sc)
124 struct cam_devq *devq;
127 /* initialise the ccb queue */
128 TAILQ_INIT(&sc->amr_cam_ccbq);
131 * Allocate a devq for all our channels combined. This should
132 * allow for the maximum number of SCSI commands we will accept
133 * at one time. Save the pointer in the softc so we can find it later
136 if ((devq = cam_simq_alloc(AMR_MAX_SCSI_CMDS)) == NULL)
138 sc->amr_cam_devq = devq;
141 * Iterate over our channels, registering them with CAM
143 for (chn = 0; chn < sc->amr_maxchan; chn++) {
146 if ((sc->amr_cam_sim[chn] = cam_sim_alloc(amr_cam_action,
150 device_get_unit(sc->amr_dev),
155 device_printf(sc->amr_dev, "CAM SIM attach failed\n");
159 /* register the bus ID so we can get it later */
160 if (xpt_bus_register(sc->amr_cam_sim[chn], chn)) {
161 device_printf(sc->amr_dev, "CAM XPT bus registration failed\n");
166 * XXX we should scan the config and work out which devices are actually
172 /********************************************************************************
173 * Disconnect ourselves from CAM
176 amr_cam_detach(struct amr_softc *sc)
180 for (chn = 0; chn < sc->amr_maxchan; chn++) {
183 * If a sim was allocated for this channel, free it
185 if (sc->amr_cam_sim[chn] != NULL) {
186 xpt_bus_deregister(cam_sim_path(sc->amr_cam_sim[chn]));
187 cam_sim_free(sc->amr_cam_sim[chn], FALSE);
191 /* Now free the devq */
192 if (sc->amr_cam_devq != NULL)
193 cam_simq_free(sc->amr_cam_devq);
196 /********************************************************************************
197 ********************************************************************************
198 CAM passthrough interface
199 ********************************************************************************
200 ********************************************************************************/
202 /********************************************************************************
203 * Handle a request for action from CAM
206 amr_cam_action(struct cam_sim *sim, union ccb *ccb)
208 struct amr_softc *sc = cam_sim_softc(sim);
210 switch(ccb->ccb_h.func_code) {
213 * Perform SCSI I/O to a physical device.
217 struct ccb_hdr *ccbh = &ccb->ccb_h;
218 struct ccb_scsiio *csio = &ccb->csio;
220 /* Validate the CCB */
221 ccbh->status = CAM_REQ_INPROG;
223 /* check the CDB length */
224 if (csio->cdb_len > AMR_MAX_EXTCDB_LEN)
225 ccbh->status = CAM_REQ_CMP_ERR;
227 if ((csio->cdb_len > AMR_MAX_CDB_LEN) && (sc->support_ext_cdb == 0 ))
228 ccbh->status = CAM_REQ_CMP_ERR;
230 /* check that the CDB pointer is not to a physical address */
231 if ((ccbh->flags & CAM_CDB_POINTER) && (ccbh->flags & CAM_CDB_PHYS))
232 ccbh->status = CAM_REQ_CMP_ERR;
234 /* if there is data transfer, it must be to/from a virtual address */
235 if ((ccbh->flags & CAM_DIR_MASK) != CAM_DIR_NONE) {
236 if (ccbh->flags & CAM_DATA_PHYS) /* we can't map it */
237 ccbh->status = CAM_REQ_CMP_ERR;
238 if (ccbh->flags & CAM_SCATTER_VALID) /* we want to do the s/g setup */
239 ccbh->status = CAM_REQ_CMP_ERR;
243 * If the command is to a LUN other than 0, fail it.
244 * This is probably incorrect, but during testing the firmware did not
245 * seem to respect the LUN field, and thus devices appear echoed.
247 if (csio->ccb_h.target_lun != 0)
248 ccbh->status = CAM_REQ_CMP_ERR;
250 /* if we're happy with the request, queue it for attention */
251 if (ccbh->status == CAM_REQ_INPROG) {
253 /* save the channel number in the ccb */
254 csio->ccb_h.sim_priv.entries[0].field = cam_sim_bus(sim);
256 mtx_lock(&sc->amr_list_lock);
257 amr_enqueue_ccb(sc, ccb);
259 mtx_unlock(&sc->amr_list_lock);
265 case XPT_CALC_GEOMETRY:
267 cam_calc_geometry(&ccb->ccg, /*extended*/1);
272 * Return path stats. Some of these should probably be
277 struct ccb_pathinq *cpi = & ccb->cpi;
279 debug(3, "XPT_PATH_INQ");
280 cpi->version_num = 1; /* XXX??? */
281 cpi->hba_inquiry = PI_SDTR_ABLE|PI_TAG_ABLE|PI_WIDE_16;
282 cpi->target_sprt = 0;
283 cpi->hba_misc = PIM_NOBUSRESET;
284 cpi->hba_eng_cnt = 0;
285 cpi->max_target = AMR_MAX_TARGETS;
286 cpi->max_lun = 0 /* AMR_MAX_LUNS*/;
287 cpi->initiator_id = 7; /* XXX variable? */
288 strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
289 strncpy(cpi->hba_vid, "LSI", HBA_IDLEN);
290 strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
291 cpi->unit_number = cam_sim_unit(sim);
292 cpi->bus_id = cam_sim_bus(sim);
293 cpi->base_transfer_speed = 132 * 1024; /* XXX get from controller? */
294 cpi->transport = XPORT_SPI;
295 cpi->transport_version = 2;
296 cpi->protocol = PROTO_SCSI;
297 cpi->protocol_version = SCSI_REV_2;
298 cpi->ccb_h.status = CAM_REQ_CMP;
305 struct ccb_pathinq *cpi = & ccb->cpi;
307 debug(1, "XPT_RESET_BUS");
308 cpi->ccb_h.status = CAM_REQ_CMP;
314 debug(1, "XPT_RESET_DEV");
315 ccb->ccb_h.status = CAM_REQ_CMP;
319 case XPT_GET_TRAN_SETTINGS:
321 struct ccb_trans_settings *cts = &(ccb->cts);
323 debug(3, "XPT_GET_TRAN_SETTINGS");
325 struct ccb_trans_settings_scsi *scsi = &cts->proto_specific.scsi;
326 struct ccb_trans_settings_spi *spi = &cts->xport_specific.spi;
328 cts->protocol = PROTO_SCSI;
329 cts->protocol_version = SCSI_REV_2;
330 cts->transport = XPORT_SPI;
331 cts->transport_version = 2;
333 if (cts->type == CTS_TYPE_USER_SETTINGS) {
334 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
338 spi->flags = CTS_SPI_FLAGS_DISC_ENB;
339 spi->bus_width = MSG_EXT_WDTR_BUS_32_BIT;
340 spi->sync_period = 6; /* 40MHz how wide is this bus? */
341 spi->sync_offset = 31; /* How to extract this from board? */
343 spi->valid = CTS_SPI_VALID_SYNC_RATE
344 | CTS_SPI_VALID_SYNC_OFFSET
345 | CTS_SPI_VALID_BUS_WIDTH
346 | CTS_SPI_VALID_DISC;
347 scsi->valid = CTS_SCSI_VALID_TQ;
348 ccb->ccb_h.status = CAM_REQ_CMP;
352 case XPT_SET_TRAN_SETTINGS:
353 debug(3, "XPT_SET_TRAN_SETTINGS");
354 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
359 * Reject anything else as unsupported.
362 /* we can't do this */
363 ccb->ccb_h.status = CAM_REQ_INVALID;
369 /********************************************************************************
370 * Convert a CAM CCB off the top of the CCB queue to a passthrough SCSI command.
373 amr_cam_command(struct amr_softc *sc, struct amr_command **acp)
375 struct amr_command *ac;
376 struct amr_passthrough *ap;
377 struct amr_ext_passthrough *aep;
378 struct ccb_scsiio *csio;
379 int bus, target, error;
386 /* check to see if there is a ccb for us to work with */
387 if ((csio = (struct ccb_scsiio *)amr_dequeue_ccb(sc)) == NULL)
390 /* get bus/target, XXX validate against protected devices? */
391 bus = csio->ccb_h.sim_priv.entries[0].field;
392 target = csio->ccb_h.target_id;
395 * Build a passthrough command.
398 /* construct passthrough */
399 if (sc->support_ext_cdb ) {
400 if ((aep = malloc(sizeof(*aep), M_DEVBUF, M_NOWAIT | M_ZERO)) == NULL) {
406 aep->ap_request_sense_length = 14;
407 aep->ap_islogical = 0;
408 aep->ap_channel = bus;
409 aep->ap_scsi_id = target;
410 aep->ap_logical_drive_no = csio->ccb_h.target_lun;
411 aep->ap_cdb_length = csio->cdb_len;
412 aep->ap_data_transfer_length = csio->dxfer_len;
413 if (csio->ccb_h.flags & CAM_CDB_POINTER) {
414 bcopy(csio->cdb_io.cdb_ptr, aep->ap_cdb, csio->cdb_len);
416 bcopy(csio->cdb_io.cdb_bytes, aep->ap_cdb, csio->cdb_len);
418 /* we leave the data s/g list and s/g count to the map routine later */
420 debug(2, " COMMAND %x/%d+%d to %d:%d:%d", aep->ap_cdb[0], aep->ap_cdb_length, csio->dxfer_len,
421 aep->ap_channel, aep->ap_scsi_id, aep->ap_logical_drive_no);
424 if ((ap = malloc(sizeof(*ap), M_DEVBUF, M_NOWAIT | M_ZERO)) == NULL) {
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 | AMR_CMD_DATAIN;
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;
470 ac->ac_flags |= AMR_CMD_SG64;
473 ac->ac_length = sizeof(*ap);
474 ac->ac_complete = amr_cam_complete;
475 if (AMR_IS_SG64(sc)) {
476 ac->ac_mailbox.mb_command = AMR_CMD_PASS_64;
477 ac->ac_flags |= AMR_CMD_SG64;
479 ac->ac_mailbox.mb_command = AMR_CMD_PASS;
490 if (csio != NULL) /* put it back and try again later */
491 amr_requeue_ccb(sc, (union ccb *)csio);
497 /********************************************************************************
498 * Check for interrupt status
501 amr_cam_poll(struct cam_sim *sim)
504 amr_done(cam_sim_softc(sim));
507 /********************************************************************************
508 * Handle completion of a command submitted via CAM.
511 amr_cam_complete(struct amr_command *ac)
513 struct amr_passthrough *ap = (struct amr_passthrough *)ac->ac_data;
514 struct ccb_scsiio *csio = (struct ccb_scsiio *)ac->ac_private;
515 struct scsi_inquiry_data *inq = (struct scsi_inquiry_data *)csio->data_ptr;
517 /* XXX note that we're ignoring ac->ac_status - good idea? */
519 debug(1, "status 0x%x AP scsi_status 0x%x", ac->ac_status, ap->ap_scsi_status);
522 * Hide disks from CAM so that they're not picked up and treated as 'normal' disks.
524 * If the configuration provides a mechanism to mark a disk a "not managed", we
525 * could add handling for that to allow disks to be selectively visible.
528 if ((ap->ap_cdb[0] == INQUIRY) && (SID_TYPE(inq) == T_DIRECT)) {
529 bzero(csio->data_ptr, csio->dxfer_len);
530 if (ap->ap_scsi_status == 0xf0) {
531 csio->ccb_h.status = CAM_SCSI_STATUS_ERROR;
533 csio->ccb_h.status = CAM_DEV_NOT_THERE;
537 /* handle passthrough SCSI status */
538 switch(ap->ap_scsi_status) {
539 case 0: /* completed OK */
540 csio->ccb_h.status = CAM_REQ_CMP;
544 csio->ccb_h.status = CAM_SCSI_STATUS_ERROR;
545 csio->scsi_status = SCSI_STATUS_CHECK_COND;
546 bcopy(ap->ap_request_sense_area, &csio->sense_data, AMR_MAX_REQ_SENSE_LEN);
547 csio->sense_len = AMR_MAX_REQ_SENSE_LEN;
548 csio->ccb_h.status |= CAM_AUTOSNS_VALID;
552 csio->ccb_h.status = CAM_SCSI_BUSY;
558 csio->ccb_h.status = CAM_REQ_CMP_ERR;
563 if ((csio->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE)
564 debug(2, "%*D\n", imin(csio->dxfer_len, 16), csio->data_ptr, " ");
565 xpt_done((union ccb *)csio);
569 /********************************************************************************
570 * Handle completion of a command submitted via CAM.
571 * Completion for extended cdb
574 amr_cam_complete_extcdb(struct amr_command *ac)
576 struct amr_ext_passthrough *aep = (struct amr_ext_passthrough *)ac->ac_data;
577 struct ccb_scsiio *csio = (struct ccb_scsiio *)ac->ac_private;
578 struct scsi_inquiry_data *inq = (struct scsi_inquiry_data *)csio->data_ptr;
580 /* XXX note that we're ignoring ac->ac_status - good idea? */
582 debug(1, "status 0x%x AEP scsi_status 0x%x", ac->ac_status, aep->ap_scsi_status);
585 * Hide disks from CAM so that they're not picked up and treated as 'normal' disks.
587 * If the configuration provides a mechanism to mark a disk a "not managed", we
588 * could add handling for that to allow disks to be selectively visible.
591 if ((aep->ap_cdb[0] == INQUIRY) && (SID_TYPE(inq) == T_DIRECT)) {
592 bzero(csio->data_ptr, csio->dxfer_len);
593 if (aep->ap_scsi_status == 0xf0) {
594 csio->ccb_h.status = CAM_SCSI_STATUS_ERROR;
596 csio->ccb_h.status = CAM_DEV_NOT_THERE;
600 /* handle passthrough SCSI status */
601 switch(aep->ap_scsi_status) {
602 case 0: /* completed OK */
603 csio->ccb_h.status = CAM_REQ_CMP;
607 csio->ccb_h.status = CAM_SCSI_STATUS_ERROR;
608 csio->scsi_status = SCSI_STATUS_CHECK_COND;
609 bcopy(aep->ap_request_sense_area, &csio->sense_data, AMR_MAX_REQ_SENSE_LEN);
610 csio->sense_len = AMR_MAX_REQ_SENSE_LEN;
611 csio->ccb_h.status |= CAM_AUTOSNS_VALID;
615 csio->ccb_h.status = CAM_SCSI_BUSY;
621 csio->ccb_h.status = CAM_REQ_CMP_ERR;
626 if ((csio->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE)
627 debug(2, "%*D\n", imin(csio->dxfer_len, 16), csio->data_ptr, " ");
628 xpt_done((union ccb *)csio);