xref: /dragonfly/sys/dev/raid/mfi/mfi_cam.c (revision d4ef6694)
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  * $FreeBSD: src/sys/dev/mfi/mfi_cam.c,v 1.7 2011/10/13 20:06:19 marius Exp $
27  * FreeBSD projects/head_mfi/ r232949
28  */
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/bus.h>
38 #include <sys/conf.h>
39 #include <sys/eventhandler.h>
40 #include <sys/rman.h>
41 #include <sys/bus_dma.h>
42 #include <sys/buf2.h>
43 #include <sys/uio.h>
44 #include <sys/proc.h>
45 #include <sys/signalvar.h>
46 
47 #include <bus/cam/cam.h>
48 #include <bus/cam/cam_ccb.h>
49 #include <bus/cam/cam_debug.h>
50 #include <bus/cam/cam_sim.h>
51 #include <bus/cam/cam_xpt_sim.h>
52 #include <bus/cam/scsi/scsi_all.h>
53 #include <bus/cam/scsi/scsi_message.h>
54 
55 #include <machine/md_var.h>
56 
57 #include <dev/raid/mfi/mfireg.h>
58 #include <dev/raid/mfi/mfi_ioctl.h>
59 #include <dev/raid/mfi/mfivar.h>
60 
61 struct mfip_softc {
62 	device_t	dev;
63 	struct mfi_softc *mfi_sc;
64 	struct cam_devq *devq;
65 	struct cam_sim	*sim;
66 	struct cam_path	*path;
67 };
68 
69 static int	mfip_probe(device_t);
70 static int	mfip_attach(device_t);
71 static int	mfip_detach(device_t);
72 static void	mfip_cam_action(struct cam_sim *, union ccb *);
73 static void	mfip_cam_poll(struct cam_sim *);
74 static struct mfi_command * mfip_start(void *);
75 static void	mfip_done(struct mfi_command *cm);
76 
77 static devclass_t	mfip_devclass;
78 static device_method_t	mfip_methods[] = {
79 	DEVMETHOD(device_probe,		mfip_probe),
80 	DEVMETHOD(device_attach,	mfip_attach),
81 	DEVMETHOD(device_detach,	mfip_detach),
82 	DEVMETHOD_END
83 };
84 static driver_t mfip_driver = {
85 	"mfip",
86 	mfip_methods,
87 	sizeof(struct mfip_softc)
88 };
89 DRIVER_MODULE(mfip, mfi, mfip_driver, mfip_devclass, NULL, NULL);
90 MODULE_DEPEND(mfip, cam, 1, 1, 1);
91 MODULE_DEPEND(mfip, mfi, 1, 1, 1);
92 
93 #define ccb_mfip_ptr sim_priv.entries[0].ptr
94 
95 static int
96 mfip_probe(device_t dev)
97 {
98 
99 	device_set_desc(dev, "SCSI Passthrough Bus");
100 	return (0);
101 }
102 
103 static int
104 mfip_attach(device_t dev)
105 {
106 	struct mfip_softc *sc;
107 	struct mfi_softc *mfisc;
108 
109 	sc = device_get_softc(dev);
110 	if (sc == NULL)
111 		return (EINVAL);
112 
113 	mfisc = device_get_softc(device_get_parent(dev));
114 	sc->dev = dev;
115 	sc->mfi_sc = mfisc;
116 	mfisc->mfi_cam_start = mfip_start;
117 
118 	if ((sc->devq = cam_simq_alloc(MFI_SCSI_MAX_CMDS)) == NULL)
119 		return (ENOMEM);
120 
121 	sc->sim = cam_sim_alloc(mfip_cam_action, mfip_cam_poll, "mfi", sc,
122 				device_get_unit(dev), &mfisc->mfi_io_lock, 1,
123 				MFI_SCSI_MAX_CMDS, sc->devq);
124 	cam_simq_release(sc->devq);
125 	if (sc->sim == NULL) {
126 		device_printf(dev, "CAM SIM attach failed\n");
127 		return (EINVAL);
128 	}
129 
130 	lockmgr(&mfisc->mfi_io_lock, LK_EXCLUSIVE);
131 	if (xpt_bus_register(sc->sim, 0) != 0) {
132 		device_printf(dev, "XPT bus registration failed\n");
133 		cam_sim_free(sc->sim);
134 		lockmgr(&mfisc->mfi_io_lock, LK_RELEASE);
135 		return (EINVAL);
136 	}
137 	lockmgr(&mfisc->mfi_io_lock, LK_RELEASE);
138 
139 	return (0);
140 }
141 
142 static int
143 mfip_detach(device_t dev)
144 {
145 	struct mfip_softc *sc;
146 
147 	sc = device_get_softc(dev);
148 	if (sc == NULL)
149 		return (EINVAL);
150 
151 	if (sc->sim != NULL) {
152 		lockmgr(&sc->mfi_sc->mfi_io_lock, LK_EXCLUSIVE);
153 		xpt_bus_deregister(cam_sim_path(sc->sim));
154 		cam_sim_free(sc->sim);
155 		lockmgr(&sc->mfi_sc->mfi_io_lock, LK_RELEASE);
156 	}
157 
158 	return (0);
159 }
160 
161 static void
162 mfip_cam_action(struct cam_sim *sim, union ccb *ccb)
163 {
164 	struct mfip_softc *sc = cam_sim_softc(sim);
165 	struct mfi_softc *mfisc = sc->mfi_sc;
166 
167 	mfi_lockassert(&mfisc->mfi_io_lock);
168 
169 	switch (ccb->ccb_h.func_code) {
170 	case XPT_PATH_INQ:
171 	{
172 		struct ccb_pathinq *cpi = &ccb->cpi;
173 
174 		cpi->version_num = 1;
175 		cpi->hba_inquiry = PI_SDTR_ABLE|PI_TAG_ABLE|PI_WIDE_16;
176 		cpi->target_sprt = 0;
177 		cpi->hba_misc = PIM_NOBUSRESET|PIM_SEQSCAN;
178 		cpi->hba_eng_cnt = 0;
179 		cpi->max_target = MFI_SCSI_MAX_TARGETS;
180 		cpi->max_lun = MFI_SCSI_MAX_LUNS;
181 		cpi->initiator_id = MFI_SCSI_INITIATOR_ID;
182 		strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
183 		strncpy(cpi->hba_vid, "LSI", HBA_IDLEN);
184 		strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
185 		cpi->unit_number = cam_sim_unit(sim);
186 		cpi->bus_id = cam_sim_bus(sim);
187 		cpi->base_transfer_speed = 150000;
188 		cpi->transport = XPORT_SAS;
189 		cpi->transport_version = 0;
190 		cpi->protocol = PROTO_SCSI;
191 		cpi->protocol_version = SCSI_REV_2;
192 		cpi->ccb_h.status = CAM_REQ_CMP;
193 		break;
194 	}
195 	case XPT_RESET_BUS:
196 		ccb->ccb_h.status = CAM_REQ_CMP;
197 		break;
198 	case XPT_RESET_DEV:
199 		ccb->ccb_h.status = CAM_REQ_CMP;
200 		break;
201 	case XPT_GET_TRAN_SETTINGS:
202 	{
203 		struct ccb_trans_settings_sas *sas =
204 		    &ccb->cts.xport_specific.sas;
205 
206 		ccb->cts.protocol = PROTO_SCSI;
207 		ccb->cts.protocol_version = SCSI_REV_2;
208 		ccb->cts.transport = XPORT_SAS;
209 		ccb->cts.transport_version = 0;
210 
211 		sas->valid &= ~CTS_SAS_VALID_SPEED;
212 		sas->bitrate = 150000;
213 
214 		ccb->ccb_h.status = CAM_REQ_CMP;
215 		break;
216 	}
217 	case XPT_SET_TRAN_SETTINGS:
218 		ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
219 		break;
220 	case XPT_SCSI_IO:
221 	{
222 		struct ccb_hdr		*ccbh = &ccb->ccb_h;
223 		struct ccb_scsiio	*csio = &ccb->csio;
224 
225 		ccbh->status = CAM_REQ_INPROG;
226 		if (csio->cdb_len > MFI_SCSI_MAX_CDB_LEN) {
227 			ccbh->status = CAM_REQ_INVALID;
228 			break;
229 		}
230 		if ((ccbh->flags & CAM_DIR_MASK) != CAM_DIR_NONE) {
231 			if (ccbh->flags & CAM_DATA_PHYS) {
232 				ccbh->status = CAM_REQ_INVALID;
233 				break;
234 			}
235 			if (ccbh->flags & CAM_SCATTER_VALID) {
236 				ccbh->status = CAM_REQ_INVALID;
237 				break;
238 			}
239 		}
240 
241 		ccbh->ccb_mfip_ptr = sc;
242 		TAILQ_INSERT_TAIL(&mfisc->mfi_cam_ccbq, ccbh, sim_links.tqe);
243 		mfi_startio(mfisc);
244 		return;
245 	}
246 	default:
247 		ccb->ccb_h.status = CAM_REQ_INVALID;
248 		break;
249 	}
250 
251 	xpt_done(ccb);
252 	return;
253 }
254 
255 static struct mfi_command *
256 mfip_start(void *data)
257 {
258 	union ccb *ccb = data;
259 	struct ccb_hdr *ccbh = &ccb->ccb_h;
260 	struct ccb_scsiio *csio = &ccb->csio;
261 	struct mfip_softc *sc;
262 	struct mfi_pass_frame *pt;
263 	struct mfi_command *cm;
264 	uint32_t context = 0;
265 
266 	sc = ccbh->ccb_mfip_ptr;
267 
268 	if ((cm = mfi_dequeue_free(sc->mfi_sc)) == NULL)
269 		return (NULL);
270 
271 	/* Zero out the MFI frame */
272 	context = cm->cm_frame->header.context;
273 	bzero(cm->cm_frame, sizeof(union mfi_frame));
274 	cm->cm_frame->header.context = context;
275 
276 	pt = &cm->cm_frame->pass;
277 	pt->header.cmd = MFI_CMD_PD_SCSI_IO;
278 	pt->header.cmd_status = 0;
279 	pt->header.scsi_status = 0;
280 	pt->header.target_id = ccbh->target_id;
281 	pt->header.lun_id = ccbh->target_lun;
282 	pt->header.flags = 0;
283 	pt->header.timeout = 0;
284 	pt->header.data_len = csio->dxfer_len;
285 	pt->header.sense_len = MFI_SENSE_LEN;
286 	pt->header.cdb_len = csio->cdb_len;
287 	pt->sense_addr_lo = cm->cm_sense_busaddr;
288 	pt->sense_addr_hi = 0;
289 	if (ccbh->flags & CAM_CDB_POINTER)
290 		bcopy(csio->cdb_io.cdb_ptr, &pt->cdb[0], csio->cdb_len);
291 	else
292 		bcopy(csio->cdb_io.cdb_bytes, &pt->cdb[0], csio->cdb_len);
293 	cm->cm_complete = mfip_done;
294 	cm->cm_private = ccb;
295 	cm->cm_sg = &pt->sgl;
296 	cm->cm_total_frame_size = MFI_PASS_FRAME_SIZE;
297 	cm->cm_data = csio->data_ptr;
298 	cm->cm_len = csio->dxfer_len;
299 	switch (ccbh->flags & CAM_DIR_MASK) {
300 	case CAM_DIR_IN:
301 		cm->cm_flags = MFI_CMD_DATAIN;
302 		break;
303 	case CAM_DIR_OUT:
304 		cm->cm_flags = MFI_CMD_DATAOUT;
305 		break;
306 	case CAM_DIR_NONE:
307 	default:
308 		cm->cm_data = NULL;
309 		cm->cm_len = 0;
310 		cm->cm_flags = 0;
311 		break;
312 	}
313 
314 	TAILQ_REMOVE(&sc->mfi_sc->mfi_cam_ccbq, ccbh, sim_links.tqe);
315 	return (cm);
316 }
317 
318 static void
319 mfip_done(struct mfi_command *cm)
320 {
321 	union ccb *ccb = cm->cm_private;
322 	struct ccb_hdr *ccbh = &ccb->ccb_h;
323 	struct ccb_scsiio *csio = &ccb->csio;
324 	struct mfi_pass_frame *pt;
325 
326 	pt = &cm->cm_frame->pass;
327 
328 	switch (pt->header.cmd_status) {
329 	case MFI_STAT_OK:
330 	{
331 		uint8_t command, device;
332 
333 		ccbh->status = CAM_REQ_CMP;
334 		csio->scsi_status = pt->header.scsi_status;
335 		if (ccbh->flags & CAM_CDB_POINTER)
336 			command = csio->cdb_io.cdb_ptr[0];
337 		else
338 			command = csio->cdb_io.cdb_bytes[0];
339 		if (command == INQUIRY) {
340 			device = csio->data_ptr[0] & 0x1f;
341 			if ((device == T_DIRECT) || (device == T_PROCESSOR))
342 				csio->data_ptr[0] =
343 				     (csio->data_ptr[0] & 0xe0) | T_NODEVICE;
344 		}
345 		break;
346 	}
347 	case MFI_STAT_SCSI_DONE_WITH_ERROR:
348 	{
349 		int sense_len;
350 
351 		ccbh->status = CAM_SCSI_STATUS_ERROR | CAM_AUTOSNS_VALID;
352 		csio->scsi_status = pt->header.scsi_status;
353 		if (pt->header.sense_len < csio->sense_len)
354 			csio->sense_resid = csio->sense_len -
355 			    pt->header.sense_len;
356 		else
357 			csio->sense_resid = 0;
358 		sense_len = min(pt->header.sense_len,
359 		    sizeof(struct scsi_sense_data));
360 		bzero(&csio->sense_data, sizeof(struct scsi_sense_data));
361 		bcopy(&cm->cm_sense->data[0], &csio->sense_data, sense_len);
362 		break;
363 	}
364 	case MFI_STAT_DEVICE_NOT_FOUND:
365 		ccbh->status = CAM_SEL_TIMEOUT;
366 		break;
367 	case MFI_STAT_SCSI_IO_FAILED:
368 		ccbh->status = CAM_REQ_CMP_ERR;
369 		csio->scsi_status = pt->header.scsi_status;
370 		break;
371 	default:
372 		ccbh->status = CAM_REQ_CMP_ERR;
373 		csio->scsi_status = pt->header.scsi_status;
374 		break;
375 	}
376 
377 	mfi_release_command(cm);
378 	xpt_done(ccb);
379 }
380 
381 static void
382 mfip_cam_poll(struct cam_sim *sim)
383 {
384 	return;
385 }
386