xref: /freebsd/sys/dev/mfi/mfi_cam.c (revision e3466a89fd9c3d0be2f831d42a5b5cf65cb0fd53)
1 /*-
2  * Copyright 2007 Scott Long
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 #include "opt_mfi.h"
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/malloc.h>
36 #include <sys/module.h>
37 #include <sys/selinfo.h>
38 #include <sys/bus.h>
39 #include <sys/conf.h>
40 #include <sys/eventhandler.h>
41 #include <sys/rman.h>
42 #include <sys/bus_dma.h>
43 #include <sys/bio.h>
44 #include <sys/ioccom.h>
45 #include <sys/uio.h>
46 #include <sys/proc.h>
47 #include <sys/signalvar.h>
48 #include <sys/sysctl.h>
49 
50 #include <cam/cam.h>
51 #include <cam/cam_ccb.h>
52 #include <cam/cam_debug.h>
53 #include <cam/cam_periph.h>
54 #include <cam/cam_sim.h>
55 #include <cam/cam_xpt_periph.h>
56 #include <cam/cam_xpt_sim.h>
57 #include <cam/scsi/scsi_all.h>
58 #include <cam/scsi/scsi_message.h>
59 
60 #include <machine/md_var.h>
61 #include <machine/bus.h>
62 #include <machine/resource.h>
63 
64 #include <dev/mfi/mfireg.h>
65 #include <dev/mfi/mfi_ioctl.h>
66 #include <dev/mfi/mfivar.h>
67 
68 enum mfip_state {
69 	MFIP_STATE_NONE,
70 	MFIP_STATE_DETACH,
71 	MFIP_STATE_RESCAN
72 };
73 
74 struct mfip_softc {
75 	device_t	dev;
76 	struct mfi_softc *mfi_sc;
77 	struct cam_devq *devq;
78 	struct cam_sim	*sim;
79 	struct cam_path	*path;
80 	enum mfip_state	state;
81 };
82 
83 static int	mfip_probe(device_t);
84 static int	mfip_attach(device_t);
85 static int	mfip_detach(device_t);
86 static void	mfip_cam_action(struct cam_sim *, union ccb *);
87 static void	mfip_cam_poll(struct cam_sim *);
88 static void	mfip_cam_rescan(struct mfi_softc *, uint32_t tid);
89 static struct mfi_command * mfip_start(void *);
90 static void	mfip_done(struct mfi_command *cm);
91 
92 static int mfi_allow_disks = 0;
93 TUNABLE_INT("hw.mfi.allow_cam_disk_passthrough", &mfi_allow_disks);
94 SYSCTL_INT(_hw_mfi, OID_AUTO, allow_cam_disk_passthrough, CTLFLAG_RD,
95     &mfi_allow_disks, 0, "event message locale");
96 
97 static devclass_t	mfip_devclass;
98 static device_method_t	mfip_methods[] = {
99 	DEVMETHOD(device_probe,		mfip_probe),
100 	DEVMETHOD(device_attach,	mfip_attach),
101 	DEVMETHOD(device_detach,	mfip_detach),
102 
103 	DEVMETHOD_END
104 };
105 static driver_t mfip_driver = {
106 	"mfip",
107 	mfip_methods,
108 	sizeof(struct mfip_softc)
109 };
110 DRIVER_MODULE(mfip, mfi, mfip_driver, mfip_devclass, 0, 0);
111 MODULE_DEPEND(mfip, cam, 1, 1, 1);
112 MODULE_DEPEND(mfip, mfi, 1, 1, 1);
113 
114 #define ccb_mfip_ptr sim_priv.entries[0].ptr
115 
116 static int
117 mfip_probe(device_t dev)
118 {
119 
120 	device_set_desc(dev, "SCSI Passthrough Bus");
121 	return (0);
122 }
123 
124 static int
125 mfip_attach(device_t dev)
126 {
127 	struct mfip_softc *sc;
128 	struct mfi_softc *mfisc;
129 
130 	sc = device_get_softc(dev);
131 	if (sc == NULL)
132 		return (EINVAL);
133 
134 	mfisc = device_get_softc(device_get_parent(dev));
135 	sc->dev = dev;
136 	sc->state = MFIP_STATE_NONE;
137 	sc->mfi_sc = mfisc;
138 	mfisc->mfi_cam_start = mfip_start;
139 
140 	if ((sc->devq = cam_simq_alloc(MFI_SCSI_MAX_CMDS)) == NULL)
141 		return (ENOMEM);
142 
143 	sc->sim = cam_sim_alloc(mfip_cam_action, mfip_cam_poll, "mfi", sc,
144 				device_get_unit(dev), &mfisc->mfi_io_lock, 1,
145 				MFI_SCSI_MAX_CMDS, sc->devq);
146 	if (sc->sim == NULL) {
147 		cam_simq_free(sc->devq);
148 		device_printf(dev, "CAM SIM attach failed\n");
149 		return (EINVAL);
150 	}
151 
152 	mfisc->mfi_cam_rescan_cb = mfip_cam_rescan;
153 
154 	mtx_lock(&mfisc->mfi_io_lock);
155 	if (xpt_bus_register(sc->sim, dev, 0) != 0) {
156 		device_printf(dev, "XPT bus registration failed\n");
157 		cam_sim_free(sc->sim, FALSE);
158 		cam_simq_free(sc->devq);
159 		mtx_unlock(&mfisc->mfi_io_lock);
160 		return (EINVAL);
161 	}
162 	mtx_unlock(&mfisc->mfi_io_lock);
163 
164 	return (0);
165 }
166 
167 static int
168 mfip_detach(device_t dev)
169 {
170 	struct mfip_softc *sc;
171 
172 	sc = device_get_softc(dev);
173 	if (sc == NULL)
174 		return (EINVAL);
175 
176 	mtx_lock(&sc->mfi_sc->mfi_io_lock);
177 	if (sc->state == MFIP_STATE_RESCAN) {
178 		mtx_unlock(&sc->mfi_sc->mfi_io_lock);
179 		return (EBUSY);
180 	}
181 	sc->state = MFIP_STATE_DETACH;
182 	mtx_unlock(&sc->mfi_sc->mfi_io_lock);
183 
184 	sc->mfi_sc->mfi_cam_rescan_cb = NULL;
185 
186 	if (sc->sim != NULL) {
187 		mtx_lock(&sc->mfi_sc->mfi_io_lock);
188 		xpt_bus_deregister(cam_sim_path(sc->sim));
189 		cam_sim_free(sc->sim, FALSE);
190 		mtx_unlock(&sc->mfi_sc->mfi_io_lock);
191 	}
192 
193 	if (sc->devq != NULL)
194 		cam_simq_free(sc->devq);
195 
196 	return (0);
197 }
198 
199 static void
200 mfip_cam_action(struct cam_sim *sim, union ccb *ccb)
201 {
202 	struct mfip_softc *sc = cam_sim_softc(sim);
203 	struct mfi_softc *mfisc = sc->mfi_sc;
204 
205 	mtx_assert(&mfisc->mfi_io_lock, MA_OWNED);
206 
207 	switch (ccb->ccb_h.func_code) {
208 	case XPT_PATH_INQ:
209 	{
210 		struct ccb_pathinq *cpi = &ccb->cpi;
211 
212 		cpi->version_num = 1;
213 		cpi->hba_inquiry = PI_SDTR_ABLE|PI_TAG_ABLE|PI_WIDE_16;
214 		cpi->target_sprt = 0;
215 		cpi->hba_misc = PIM_NOBUSRESET|PIM_SEQSCAN;
216 		cpi->hba_eng_cnt = 0;
217 		cpi->max_target = MFI_SCSI_MAX_TARGETS;
218 		cpi->max_lun = MFI_SCSI_MAX_LUNS;
219 		cpi->initiator_id = MFI_SCSI_INITIATOR_ID;
220 		strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
221 		strncpy(cpi->hba_vid, "LSI", HBA_IDLEN);
222 		strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
223 		cpi->unit_number = cam_sim_unit(sim);
224 		cpi->bus_id = cam_sim_bus(sim);
225 		cpi->base_transfer_speed = 150000;
226 		cpi->transport = XPORT_SAS;
227 		cpi->transport_version = 0;
228 		cpi->protocol = PROTO_SCSI;
229 		cpi->protocol_version = SCSI_REV_2;
230 		cpi->ccb_h.status = CAM_REQ_CMP;
231 		break;
232 	}
233 	case XPT_RESET_BUS:
234 		ccb->ccb_h.status = CAM_REQ_CMP;
235 		break;
236 	case XPT_RESET_DEV:
237 		ccb->ccb_h.status = CAM_REQ_CMP;
238 		break;
239 	case XPT_GET_TRAN_SETTINGS:
240 	{
241 		struct ccb_trans_settings_sas *sas =
242 		    &ccb->cts.xport_specific.sas;
243 
244 		ccb->cts.protocol = PROTO_SCSI;
245 		ccb->cts.protocol_version = SCSI_REV_2;
246 		ccb->cts.transport = XPORT_SAS;
247 		ccb->cts.transport_version = 0;
248 
249 		sas->valid &= ~CTS_SAS_VALID_SPEED;
250 		sas->bitrate = 150000;
251 
252 		ccb->ccb_h.status = CAM_REQ_CMP;
253 		break;
254 	}
255 	case XPT_SET_TRAN_SETTINGS:
256 		ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
257 		break;
258 	case XPT_SCSI_IO:
259 	{
260 		struct ccb_hdr		*ccbh = &ccb->ccb_h;
261 		struct ccb_scsiio	*csio = &ccb->csio;
262 
263 		ccbh->status = CAM_REQ_INPROG;
264 		if (csio->cdb_len > MFI_SCSI_MAX_CDB_LEN) {
265 			ccbh->status = CAM_REQ_INVALID;
266 			break;
267 		}
268 		ccbh->ccb_mfip_ptr = sc;
269 		TAILQ_INSERT_TAIL(&mfisc->mfi_cam_ccbq, ccbh, sim_links.tqe);
270 		mfi_startio(mfisc);
271 		return;
272 	}
273 	default:
274 		ccb->ccb_h.status = CAM_REQ_INVALID;
275 		break;
276 	}
277 
278 	xpt_done(ccb);
279 	return;
280 }
281 
282 static void
283 mfip_cam_rescan(struct mfi_softc *sc, uint32_t tid)
284 {
285 	union ccb *ccb;
286 	struct mfip_softc *camsc;
287 	struct cam_sim *sim;
288 	device_t mfip_dev;
289 
290 	mtx_lock(&Giant);
291 	mfip_dev = device_find_child(sc->mfi_dev, "mfip", -1);
292 	mtx_unlock(&Giant);
293 	if (mfip_dev == NULL) {
294 		device_printf(sc->mfi_dev, "Couldn't find mfip child device!\n");
295 		return;
296 	}
297 
298 	mtx_lock(&sc->mfi_io_lock);
299 	camsc = device_get_softc(mfip_dev);
300 	if (camsc->state == MFIP_STATE_DETACH) {
301 		mtx_unlock(&sc->mfi_io_lock);
302 		return;
303 	}
304 	camsc->state = MFIP_STATE_RESCAN;
305 	mtx_unlock(&sc->mfi_io_lock);
306 
307 	ccb = xpt_alloc_ccb_nowait();
308 	if (ccb == NULL) {
309 		device_printf(sc->mfi_dev,
310 		    "Cannot allocate ccb for bus rescan.\n");
311 		return;
312 	}
313 
314 	sim = camsc->sim;
315 	if (xpt_create_path(&ccb->ccb_h.path, xpt_periph, cam_sim_path(sim),
316 	    tid, CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
317 		xpt_free_ccb(ccb);
318 		device_printf(sc->mfi_dev,
319 		    "Cannot create path for bus rescan.\n");
320 		return;
321 	}
322 
323 	xpt_rescan(ccb);
324 
325 	mtx_lock(&sc->mfi_io_lock);
326 	camsc->state = MFIP_STATE_NONE;
327 	mtx_unlock(&sc->mfi_io_lock);
328 }
329 
330 static struct mfi_command *
331 mfip_start(void *data)
332 {
333 	union ccb *ccb = data;
334 	struct ccb_hdr *ccbh = &ccb->ccb_h;
335 	struct ccb_scsiio *csio = &ccb->csio;
336 	struct mfip_softc *sc;
337 	struct mfi_pass_frame *pt;
338 	struct mfi_command *cm;
339 	uint32_t context = 0;
340 
341 	sc = ccbh->ccb_mfip_ptr;
342 
343 	if ((cm = mfi_dequeue_free(sc->mfi_sc)) == NULL)
344 		return (NULL);
345 
346 	/* Zero out the MFI frame */
347 	context = cm->cm_frame->header.context;
348 	bzero(cm->cm_frame, sizeof(union mfi_frame));
349 	cm->cm_frame->header.context = context;
350 
351 	pt = &cm->cm_frame->pass;
352 	pt->header.cmd = MFI_CMD_PD_SCSI_IO;
353 	pt->header.cmd_status = 0;
354 	pt->header.scsi_status = 0;
355 	pt->header.target_id = ccbh->target_id;
356 	pt->header.lun_id = ccbh->target_lun;
357 	pt->header.flags = 0;
358 	pt->header.timeout = 0;
359 	pt->header.data_len = csio->dxfer_len;
360 	pt->header.sense_len = MFI_SENSE_LEN;
361 	pt->header.cdb_len = csio->cdb_len;
362 	pt->sense_addr_lo = (uint32_t)cm->cm_sense_busaddr;
363 	pt->sense_addr_hi = (uint32_t)((uint64_t)cm->cm_sense_busaddr >> 32);
364 	if (ccbh->flags & CAM_CDB_POINTER)
365 		bcopy(csio->cdb_io.cdb_ptr, &pt->cdb[0], csio->cdb_len);
366 	else
367 		bcopy(csio->cdb_io.cdb_bytes, &pt->cdb[0], csio->cdb_len);
368 	cm->cm_complete = mfip_done;
369 	cm->cm_private = ccb;
370 	cm->cm_sg = &pt->sgl;
371 	cm->cm_total_frame_size = MFI_PASS_FRAME_SIZE;
372 	cm->cm_data = ccb;
373 	cm->cm_len = csio->dxfer_len;
374 	switch (ccbh->flags & CAM_DIR_MASK) {
375 	case CAM_DIR_IN:
376 		cm->cm_flags = MFI_CMD_DATAIN | MFI_CMD_CCB;
377 		break;
378 	case CAM_DIR_OUT:
379 		cm->cm_flags = MFI_CMD_DATAOUT | MFI_CMD_CCB;
380 		break;
381 	case CAM_DIR_NONE:
382 	default:
383 		cm->cm_data = NULL;
384 		cm->cm_len = 0;
385 		cm->cm_flags = 0;
386 		break;
387 	}
388 
389 	TAILQ_REMOVE(&sc->mfi_sc->mfi_cam_ccbq, ccbh, sim_links.tqe);
390 	return (cm);
391 }
392 
393 static void
394 mfip_done(struct mfi_command *cm)
395 {
396 	union ccb *ccb = cm->cm_private;
397 	struct ccb_hdr *ccbh = &ccb->ccb_h;
398 	struct ccb_scsiio *csio = &ccb->csio;
399 	struct mfip_softc *sc;
400 	struct mfi_pass_frame *pt;
401 
402 	sc = ccbh->ccb_mfip_ptr;
403 	pt = &cm->cm_frame->pass;
404 
405 	switch (pt->header.cmd_status) {
406 	case MFI_STAT_OK:
407 	{
408 		uint8_t command, device;
409 
410 		ccbh->status = CAM_REQ_CMP;
411 		csio->scsi_status = pt->header.scsi_status;
412 		if (ccbh->flags & CAM_CDB_POINTER)
413 			command = csio->cdb_io.cdb_ptr[0];
414 		else
415 			command = csio->cdb_io.cdb_bytes[0];
416 		if (command == INQUIRY) {
417 			device = csio->data_ptr[0] & 0x1f;
418 			if ((!mfi_allow_disks && device == T_DIRECT) ||
419 			    (device == T_PROCESSOR))
420 				csio->data_ptr[0] =
421 				     (csio->data_ptr[0] & 0xe0) | T_NODEVICE;
422 		}
423 		break;
424 	}
425 	case MFI_STAT_SCSI_DONE_WITH_ERROR:
426 	{
427 		int sense_len;
428 
429 		ccbh->status = CAM_SCSI_STATUS_ERROR | CAM_AUTOSNS_VALID;
430 		csio->scsi_status = pt->header.scsi_status;
431 		if (pt->header.sense_len < csio->sense_len)
432 			csio->sense_resid = csio->sense_len -
433 			    pt->header.sense_len;
434 		else
435 			csio->sense_resid = 0;
436 		sense_len = min(pt->header.sense_len,
437 		    sizeof(struct scsi_sense_data));
438 		bzero(&csio->sense_data, sizeof(struct scsi_sense_data));
439 		bcopy(&cm->cm_sense->data[0], &csio->sense_data, sense_len);
440 		break;
441 	}
442 	case MFI_STAT_DEVICE_NOT_FOUND:
443 		ccbh->status = CAM_SEL_TIMEOUT;
444 		break;
445 	case MFI_STAT_SCSI_IO_FAILED:
446 		ccbh->status = CAM_REQ_CMP_ERR;
447 		csio->scsi_status = pt->header.scsi_status;
448 		break;
449 	default:
450 		ccbh->status = CAM_REQ_CMP_ERR;
451 		csio->scsi_status = pt->header.scsi_status;
452 		break;
453 	}
454 
455 	mfi_release_command(cm);
456 	xpt_done(ccb);
457 }
458 
459 static void
460 mfip_cam_poll(struct cam_sim *sim)
461 {
462 	struct mfip_softc *sc = cam_sim_softc(sim);
463 	struct mfi_softc *mfisc = sc->mfi_sc;
464 
465 	mfisc->mfi_intr_ptr(mfisc);
466 }
467 
468