2 * Copyright (c) 2004-07 Applied Micro Circuits Corporation.
3 * Copyright (c) 2004-05 Vinod Kashyap.
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
31 * AMCC'S 3ware driver for 9000 series storage controllers.
33 * Author: Vinod Kashyap
34 * Modifications by: Adam Radford
35 * Modifications by: Manjunath Ranganathaiah
40 * FreeBSD CAM related functions.
44 #include <dev/twa/tw_osl_includes.h>
47 #include <cam/cam_ccb.h>
48 #include <cam/cam_sim.h>
49 #include <cam/cam_xpt_sim.h>
50 #include <cam/cam_debug.h>
51 #include <cam/cam_periph.h>
53 #include <cam/scsi/scsi_all.h>
54 #include <cam/scsi/scsi_message.h>
56 static TW_VOID twa_action(struct cam_sim *sim, union ccb *ccb);
57 static TW_VOID twa_poll(struct cam_sim *sim);
59 static TW_INT32 tw_osli_execute_scsi(struct tw_osli_req_context *req,
65 * Function name: tw_osli_cam_attach
66 * Description: Attaches the driver to CAM.
68 * Input: sc -- ptr to OSL internal ctlr context
70 * Return value: 0 -- success
74 tw_osli_cam_attach(struct twa_softc *sc)
76 struct cam_devq *devq;
78 tw_osli_dbg_dprintf(3, sc, "entered");
81 * Create the device queue for our SIM.
83 if ((devq = cam_simq_alloc(TW_OSLI_MAX_NUM_IOS)) == NULL) {
84 tw_osli_printf(sc, "error = %d",
85 TW_CL_SEVERITY_ERROR_STRING,
86 TW_CL_MESSAGE_SOURCE_FREEBSD_DRIVER,
88 "Failed to create SIM device queue",
94 * Create a SIM entry. Though we can support TW_OSLI_MAX_NUM_REQUESTS
95 * simultaneous requests, we claim to be able to handle only
96 * TW_OSLI_MAX_NUM_IOS (two less), so that we always have a request
97 * packet available to service ioctls and AENs.
99 tw_osli_dbg_dprintf(3, sc, "Calling cam_sim_alloc");
100 sc->sim = cam_sim_alloc(twa_action, twa_poll, "twa", sc,
101 device_get_unit(sc->bus_dev), sc->sim_lock,
102 TW_OSLI_MAX_NUM_IOS, 1, devq);
103 if (sc->sim == NULL) {
105 tw_osli_printf(sc, "error = %d",
106 TW_CL_SEVERITY_ERROR_STRING,
107 TW_CL_MESSAGE_SOURCE_FREEBSD_DRIVER,
109 "Failed to create a SIM entry",
117 tw_osli_dbg_dprintf(3, sc, "Calling xpt_bus_register");
118 mtx_lock(sc->sim_lock);
119 if (xpt_bus_register(sc->sim, sc->bus_dev, 0) != CAM_SUCCESS) {
120 cam_sim_free(sc->sim, TRUE);
121 sc->sim = NULL; /* so cam_detach will not try to free it */
122 tw_osli_printf(sc, "error = %d",
123 TW_CL_SEVERITY_ERROR_STRING,
124 TW_CL_MESSAGE_SOURCE_FREEBSD_DRIVER,
126 "Failed to register the bus",
128 mtx_unlock(sc->sim_lock);
132 tw_osli_dbg_dprintf(3, sc, "Calling xpt_create_path");
133 if (xpt_create_path(&sc->path, NULL,
134 cam_sim_path(sc->sim),
136 CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
137 xpt_bus_deregister(cam_sim_path (sc->sim));
138 /* Passing TRUE to cam_sim_free will free the devq as well. */
139 cam_sim_free(sc->sim, TRUE);
140 tw_osli_printf(sc, "error = %d",
141 TW_CL_SEVERITY_ERROR_STRING,
142 TW_CL_MESSAGE_SOURCE_FREEBSD_DRIVER,
144 "Failed to create path",
146 mtx_unlock(sc->sim_lock);
149 mtx_unlock(sc->sim_lock);
151 tw_osli_dbg_dprintf(3, sc, "exiting");
158 * Function name: tw_osli_cam_detach
159 * Description: Detaches the driver from CAM.
161 * Input: sc -- ptr to OSL internal ctlr context
166 tw_osli_cam_detach(struct twa_softc *sc)
168 tw_osli_dbg_dprintf(3, sc, "entered");
170 mtx_lock(sc->sim_lock);
173 xpt_free_path(sc->path);
175 xpt_bus_deregister(cam_sim_path(sc->sim));
176 /* Passing TRUE to cam_sim_free will free the devq as well. */
177 cam_sim_free(sc->sim, TRUE);
179 /* It's ok have 1 hold count while destroying the mutex */
180 mtx_destroy(sc->sim_lock);
186 * Function name: tw_osli_execute_scsi
187 * Description: Build a fw cmd, based on a CAM style ccb, and
190 * Input: req -- ptr to OSL internal request context
191 * ccb -- ptr to CAM style ccb
193 * Return value: 0 -- success
197 tw_osli_execute_scsi(struct tw_osli_req_context *req, union ccb *ccb)
199 struct twa_softc *sc = req->ctlr;
200 struct tw_cl_req_packet *req_pkt;
201 struct tw_cl_scsi_req_packet *scsi_req;
202 struct ccb_hdr *ccb_h = &(ccb->ccb_h);
203 struct ccb_scsiio *csio = &(ccb->csio);
206 tw_osli_dbg_dprintf(10, sc, "SCSI I/O request 0x%x",
207 csio->cdb_io.cdb_bytes[0]);
209 if (ccb_h->target_id >= TW_CL_MAX_NUM_UNITS) {
210 tw_osli_dbg_dprintf(3, sc, "Invalid target. PTL = %x %x %x",
211 ccb_h->path_id, ccb_h->target_id, ccb_h->target_lun);
212 ccb_h->status |= CAM_TID_INVALID;
216 if (ccb_h->target_lun >= TW_CL_MAX_NUM_LUNS) {
217 tw_osli_dbg_dprintf(3, sc, "Invalid lun. PTL = %x %x %x",
218 ccb_h->path_id, ccb_h->target_id, ccb_h->target_lun);
219 ccb_h->status |= CAM_LUN_INVALID;
224 if(ccb_h->flags & CAM_CDB_PHYS) {
225 tw_osli_printf(sc, "",
226 TW_CL_SEVERITY_ERROR_STRING,
227 TW_CL_MESSAGE_SOURCE_FREEBSD_DRIVER,
229 "Physical CDB address!");
230 ccb_h->status = CAM_REQ_INVALID;
236 * We are going to work on this request. Mark it as enqueued (though
237 * we don't actually queue it...)
239 ccb_h->status |= CAM_SIM_QUEUED;
241 if((ccb_h->flags & CAM_DIR_MASK) != CAM_DIR_NONE) {
242 if(ccb_h->flags & CAM_DIR_IN)
243 req->flags |= TW_OSLI_REQ_FLAGS_DATA_IN;
245 req->flags |= TW_OSLI_REQ_FLAGS_DATA_OUT;
248 /* Build the CL understood request packet for SCSI cmds. */
249 req_pkt = &req->req_pkt;
251 req_pkt->tw_osl_callback = tw_osl_complete_io;
252 scsi_req = &(req_pkt->gen_req_pkt.scsi_req);
253 scsi_req->unit = ccb_h->target_id;
254 scsi_req->lun = ccb_h->target_lun;
255 scsi_req->sense_len = 0;
256 scsi_req->sense_data = (TW_UINT8 *)(&csio->sense_data);
257 scsi_req->scsi_status = 0;
258 if(ccb_h->flags & CAM_CDB_POINTER)
259 scsi_req->cdb = csio->cdb_io.cdb_ptr;
261 scsi_req->cdb = csio->cdb_io.cdb_bytes;
262 scsi_req->cdb_len = csio->cdb_len;
264 if (csio->dxfer_len > TW_CL_MAX_IO_SIZE) {
265 tw_osli_printf(sc, "size = %d",
266 TW_CL_SEVERITY_ERROR_STRING,
267 TW_CL_MESSAGE_SOURCE_FREEBSD_DRIVER,
271 ccb_h->status = CAM_REQ_TOO_BIG;
272 ccb_h->status &= ~CAM_SIM_QUEUED;
277 req->length = csio->dxfer_len;
278 req->flags |= TW_OSLI_REQ_FLAGS_CCB;
279 req->deadline = tw_osl_get_local_time() + (ccb_h->timeout / 1000);
282 * twa_map_load_data_callback will fill in the SGL,
283 * and submit the I/O.
285 error = tw_osli_map_request(req);
286 if ((error) && (req->flags & TW_OSLI_REQ_FLAGS_FAILED)) {
288 ccb_h->status = CAM_REQ_CMP_ERR;
289 ccb_h->status &= ~CAM_SIM_QUEUED;
298 * Function name: twa_action
299 * Description: Driver entry point for CAM's use.
301 * Input: sim -- sim corresponding to the ctlr
302 * ccb -- ptr to CAM request
307 twa_action(struct cam_sim *sim, union ccb *ccb)
309 struct twa_softc *sc = (struct twa_softc *)cam_sim_softc(sim);
310 struct ccb_hdr *ccb_h = &(ccb->ccb_h);
312 switch (ccb_h->func_code) {
313 case XPT_SCSI_IO: /* SCSI I/O */
315 struct tw_osli_req_context *req;
317 req = tw_osli_get_request(sc);
319 tw_osli_dbg_dprintf(2, sc, "Cannot get request pkt.");
321 * Freeze the simq to maintain ccb ordering. The next
322 * ccb that gets completed will unfreeze the simq.
324 ccb_h->status &= ~CAM_SIM_QUEUED;
325 ccb_h->status |= CAM_REQUEUE_REQ;
330 if ((tw_cl_is_reset_needed(&(req->ctlr->ctlr_handle)))) {
331 ccb_h->status &= ~CAM_SIM_QUEUED;
332 ccb_h->status |= CAM_REQUEUE_REQ;
334 tw_osli_req_q_insert_tail(req, TW_OSLI_FREE_Q);
338 req->req_handle.osl_req_ctxt = req;
339 req->req_handle.is_io = TW_CL_TRUE;
341 if (tw_osli_execute_scsi(req, ccb))
342 tw_osli_req_q_insert_tail(req, TW_OSLI_FREE_Q);
347 tw_osli_dbg_dprintf(2, sc, "Abort request.");
348 ccb_h->status = CAM_UA_ABORT;
353 tw_cl_create_event(&(sc->ctlr_handle), TW_CL_FALSE,
354 TW_CL_MESSAGE_SOURCE_FREEBSD_DRIVER,
355 0x2108, 0x3, TW_CL_SEVERITY_INFO_STRING,
356 "Received Reset Bus request from CAM",
359 tw_cl_set_reset_needed(&(sc->ctlr_handle));
360 ccb_h->status = CAM_REQ_CMP;
364 case XPT_SET_TRAN_SETTINGS:
365 tw_osli_dbg_dprintf(3, sc, "XPT_SET_TRAN_SETTINGS");
368 * This command is not supported, since it's very specific
369 * to SCSI, and we are doing ATA.
371 ccb_h->status = CAM_FUNC_NOTAVAIL;
375 case XPT_GET_TRAN_SETTINGS:
377 struct ccb_trans_settings *cts = &ccb->cts;
378 struct ccb_trans_settings_scsi *scsi =
379 &cts->proto_specific.scsi;
380 struct ccb_trans_settings_spi *spi =
381 &cts->xport_specific.spi;
383 cts->protocol = PROTO_SCSI;
384 cts->protocol_version = SCSI_REV_2;
385 cts->transport = XPORT_SPI;
386 cts->transport_version = 2;
388 spi->valid = CTS_SPI_VALID_DISC;
389 spi->flags = CTS_SPI_FLAGS_DISC_ENB;
390 scsi->valid = CTS_SCSI_VALID_TQ;
391 scsi->flags = CTS_SCSI_FLAGS_TAG_ENB;
392 tw_osli_dbg_dprintf(3, sc, "XPT_GET_TRAN_SETTINGS");
393 ccb_h->status = CAM_REQ_CMP;
398 case XPT_CALC_GEOMETRY:
399 tw_osli_dbg_dprintf(3, sc, "XPT_CALC_GEOMETRY");
400 cam_calc_geometry(&ccb->ccg, 1/* extended */);
404 case XPT_PATH_INQ: /* Path inquiry -- get twa properties */
406 struct ccb_pathinq *path_inq = &ccb->cpi;
408 tw_osli_dbg_dprintf(3, sc, "XPT_PATH_INQ request");
410 path_inq->version_num = 1;
411 path_inq->hba_inquiry = 0;
412 path_inq->target_sprt = 0;
413 path_inq->hba_misc = 0;
414 path_inq->hba_eng_cnt = 0;
415 path_inq->max_target = TW_CL_MAX_NUM_UNITS;
416 path_inq->max_lun = TW_CL_MAX_NUM_LUNS - 1;
417 path_inq->unit_number = cam_sim_unit(sim);
418 path_inq->bus_id = cam_sim_bus(sim);
419 path_inq->initiator_id = TW_CL_MAX_NUM_UNITS;
420 path_inq->base_transfer_speed = 100000;
421 strncpy(path_inq->sim_vid, "FreeBSD", SIM_IDLEN);
422 strncpy(path_inq->hba_vid, "3ware", HBA_IDLEN);
423 strncpy(path_inq->dev_name, cam_sim_name(sim), DEV_IDLEN);
424 path_inq->transport = XPORT_SPI;
425 path_inq->transport_version = 2;
426 path_inq->protocol = PROTO_SCSI;
427 path_inq->protocol_version = SCSI_REV_2;
428 path_inq->maxio = TW_CL_MAX_IO_SIZE;
429 ccb_h->status = CAM_REQ_CMP;
435 tw_osli_dbg_dprintf(3, sc, "func_code = %x", ccb_h->func_code);
436 ccb_h->status = CAM_REQ_INVALID;
445 * Function name: twa_poll
446 * Description: Driver entry point called when interrupts are not
449 * Input: sim -- sim corresponding to the controller
454 twa_poll(struct cam_sim *sim)
456 struct twa_softc *sc = (struct twa_softc *)(cam_sim_softc(sim));
458 tw_osli_dbg_dprintf(3, sc, "entering; sc = %p", sc);
459 tw_cl_interrupt(&(sc->ctlr_handle));
460 tw_osli_dbg_dprintf(3, sc, "exiting; sc = %p", sc);
466 * Function name: tw_osli_request_bus_scan
467 * Description: Requests CAM for a scan of the bus.
469 * Input: sc -- ptr to per ctlr structure
471 * Return value: 0 -- success
475 tw_osli_request_bus_scan(struct twa_softc *sc)
479 tw_osli_dbg_dprintf(3, sc, "entering");
481 /* If we get here before sc->sim is initialized, return an error. */
484 if ((ccb = xpt_alloc_ccb()) == NULL)
486 mtx_lock(sc->sim_lock);
487 if (xpt_create_path(&ccb->ccb_h.path, xpt_periph, cam_sim_path(sc->sim),
488 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
490 mtx_unlock(sc->sim_lock);
495 mtx_unlock(sc->sim_lock);
502 * Function name: tw_osli_disallow_new_requests
503 * Description: Calls the appropriate CAM function, so as to freeze
504 * the flow of new requests from CAM to this controller.
506 * Input: sc -- ptr to OSL internal ctlr context
507 * req_handle -- ptr to request handle sent by OSL.
512 tw_osli_disallow_new_requests(struct twa_softc *sc,
513 struct tw_cl_req_handle *req_handle)
515 /* Only freeze/release the simq for IOs */
516 if (req_handle->is_io) {
517 struct tw_osli_req_context *req = req_handle->osl_req_ctxt;
518 union ccb *ccb = (union ccb *)(req->orig_req);
520 xpt_freeze_simq(sc->sim, 1);
521 ccb->ccb_h.status |= CAM_RELEASE_SIMQ;
528 * Function name: tw_osl_timeout
529 * Description: Call to timeout().
531 * Input: req_handle -- ptr to request handle sent by OSL.
536 tw_osl_timeout(struct tw_cl_req_handle *req_handle)
538 struct tw_osli_req_context *req = req_handle->osl_req_ctxt;
539 union ccb *ccb = (union ccb *)(req->orig_req);
540 struct ccb_hdr *ccb_h = &(ccb->ccb_h);
542 req->deadline = tw_osl_get_local_time() + (ccb_h->timeout / 1000);
548 * Function name: tw_osl_untimeout
549 * Description: Inverse of call to timeout().
551 * Input: req_handle -- ptr to request handle sent by OSL.
556 tw_osl_untimeout(struct tw_cl_req_handle *req_handle)
558 struct tw_osli_req_context *req = req_handle->osl_req_ctxt;
566 * Function name: tw_osl_scan_bus
567 * Description: CL calls this function to request for a bus scan.
569 * Input: ctlr_handle -- ptr to controller handle
574 tw_osl_scan_bus(struct tw_cl_ctlr_handle *ctlr_handle)
576 struct twa_softc *sc = ctlr_handle->osl_ctlr_ctxt;
579 if ((error = tw_osli_request_bus_scan(sc)))
580 tw_osli_printf(sc, "error = %d",
581 TW_CL_SEVERITY_ERROR_STRING,
582 TW_CL_MESSAGE_SOURCE_FREEBSD_DRIVER,
584 "Bus scan request to CAM failed",
591 * Function name: tw_osl_complete_io
592 * Description: Called to complete CAM scsi requests.
594 * Input: req_handle -- ptr to request handle
599 tw_osl_complete_io(struct tw_cl_req_handle *req_handle)
601 struct tw_osli_req_context *req = req_handle->osl_req_ctxt;
602 struct tw_cl_req_packet *req_pkt =
603 (struct tw_cl_req_packet *)(&req->req_pkt);
604 struct tw_cl_scsi_req_packet *scsi_req;
605 struct twa_softc *sc = req->ctlr;
606 union ccb *ccb = (union ccb *)(req->orig_req);
608 tw_osli_dbg_dprintf(10, sc, "entering");
610 if (req->state != TW_OSLI_REQ_STATE_BUSY)
611 tw_osli_printf(sc, "request = %p, status = %d",
612 TW_CL_SEVERITY_ERROR_STRING,
613 TW_CL_MESSAGE_SOURCE_FREEBSD_DRIVER,
615 "Unposted command completed!!",
619 * Remove request from the busy queue. Just mark it complete.
620 * There's no need to move it into the complete queue as we are
621 * going to be done with it right now.
623 req->state = TW_OSLI_REQ_STATE_COMPLETE;
624 tw_osli_req_q_remove_item(req, TW_OSLI_BUSY_Q);
626 tw_osli_unmap_request(req);
629 if (req->error_code) {
630 /* This request never got submitted to the firmware. */
631 if (req->error_code == EBUSY) {
633 * Cmd queue is full, or the Common Layer is out of
634 * resources. The simq will already have been frozen.
635 * When this ccb gets completed will unfreeze the simq.
637 ccb->ccb_h.status |= CAM_REQUEUE_REQ;
639 else if (req->error_code == EFBIG)
640 ccb->ccb_h.status = CAM_REQ_TOO_BIG;
642 ccb->ccb_h.status = CAM_REQ_CMP_ERR;
644 scsi_req = &(req_pkt->gen_req_pkt.scsi_req);
645 if (req_pkt->status == TW_CL_ERR_REQ_SUCCESS)
646 ccb->ccb_h.status = CAM_REQ_CMP;
648 if (req_pkt->status & TW_CL_ERR_REQ_INVALID_TARGET)
649 ccb->ccb_h.status |= CAM_SEL_TIMEOUT;
650 else if (req_pkt->status & TW_CL_ERR_REQ_INVALID_LUN)
651 ccb->ccb_h.status |= CAM_DEV_NOT_THERE;
652 else if (req_pkt->status & TW_CL_ERR_REQ_SCSI_ERROR)
653 ccb->ccb_h.status |= CAM_SCSI_STATUS_ERROR;
654 else if (req_pkt->status & TW_CL_ERR_REQ_BUS_RESET)
655 ccb->ccb_h.status |= (CAM_REQUEUE_REQ | CAM_SCSI_BUS_RESET);
657 * If none of the above errors occurred, simply
658 * mark completion error.
660 if (ccb->ccb_h.status == 0)
661 ccb->ccb_h.status = CAM_REQ_CMP_ERR;
663 if (req_pkt->status & TW_CL_ERR_REQ_AUTO_SENSE_VALID) {
664 ccb->csio.sense_len = scsi_req->sense_len;
665 ccb->ccb_h.status |= CAM_AUTOSNS_VALID;
669 ccb->csio.scsi_status = scsi_req->scsi_status;
672 ccb->ccb_h.status &= ~CAM_SIM_QUEUED;
673 mtx_lock(sc->sim_lock);
675 mtx_unlock(sc->sim_lock);
676 if (! req->error_code)
677 /* twa_action will free the request otherwise */
678 tw_osli_req_q_insert_tail(req, TW_OSLI_FREE_Q);