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