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