xref: /dragonfly/sys/dev/disk/vpo/vpo.c (revision 6e285212)
1 /*-
2  * Copyright (c) 1997, 1998, 1999 Nicolas Souchu
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/ppbus/vpo.c,v 1.20.2.1 2000/05/07 21:08:18 n_hibma Exp $
27  * $DragonFly: src/sys/dev/disk/vpo/vpo.c,v 1.2 2003/06/17 04:28:29 dillon Exp $
28  */
29 
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/module.h>
33 #include <sys/bus.h>
34 #include <sys/malloc.h>
35 #include <sys/devicestat.h>	/* for struct devstat */
36 
37 #include <machine/clock.h>
38 
39 #include <cam/cam.h>
40 #include <cam/cam_ccb.h>
41 #include <cam/cam_sim.h>
42 #include <cam/cam_xpt_sim.h>
43 #include <cam/cam_debug.h>
44 #include <cam/cam_periph.h>
45 
46 #include <cam/scsi/scsi_all.h>
47 #include <cam/scsi/scsi_message.h>
48 #include <cam/scsi/scsi_da.h>
49 
50 #include <sys/kernel.h>
51 
52 #include "opt_vpo.h"
53 
54 #include <dev/ppbus/ppbconf.h>
55 #include <dev/ppbus/vpoio.h>
56 
57 #include "ppbus_if.h"
58 
59 struct vpo_sense {
60 	struct scsi_sense cmd;
61 	unsigned int stat;
62 	unsigned int count;
63 };
64 
65 struct vpo_data {
66 	unsigned short vpo_unit;
67 
68 	int vpo_stat;
69 	int vpo_count;
70 	int vpo_error;
71 
72 	int vpo_isplus;
73 
74 	struct cam_sim  *sim;
75 
76 	struct vpo_sense vpo_sense;
77 
78 	struct vpoio_data vpo_io;	/* interface to low level functions */
79 };
80 
81 #define DEVTOSOFTC(dev) \
82 	((struct vpo_data *)device_get_softc(dev))
83 
84 /* cam related functions */
85 static void	vpo_action(struct cam_sim *sim, union ccb *ccb);
86 static void	vpo_poll(struct cam_sim *sim);
87 static void	vpo_cam_rescan_callback(struct cam_periph *periph,
88 					union ccb *ccb);
89 static void	vpo_cam_rescan(struct vpo_data *vpo);
90 
91 static void
92 vpo_identify(driver_t *driver, device_t parent)
93 {
94 
95 	BUS_ADD_CHILD(parent, 0, "vpo", 0);
96 }
97 
98 /*
99  * vpo_probe()
100  */
101 static int
102 vpo_probe(device_t dev)
103 {
104 	struct vpo_data *vpo;
105 	int error;
106 
107 	vpo = DEVTOSOFTC(dev);
108 	bzero(vpo, sizeof(struct vpo_data));
109 
110 	/* vpo dependent initialisation */
111 	vpo->vpo_unit = device_get_unit(dev);
112 
113 	/* low level probe */
114 	vpoio_set_unit(&vpo->vpo_io, vpo->vpo_unit);
115 
116 	/* check ZIP before ZIP+ or imm_probe() will send controls to
117 	 * the printer or whatelse connected to the port */
118 	if ((error = vpoio_probe(dev, &vpo->vpo_io)) == 0) {
119 		vpo->vpo_isplus = 0;
120 		device_set_desc(dev,
121 				"Iomega VPI0 Parallel to SCSI interface");
122 	} else if ((error = imm_probe(dev, &vpo->vpo_io)) == 0) {
123 		vpo->vpo_isplus = 1;
124 		device_set_desc(dev,
125 				"Iomega Matchmaker Parallel to SCSI interface");
126 	} else {
127 		return (error);
128 	}
129 
130 	return (0);
131 }
132 
133 /*
134  * vpo_attach()
135  */
136 static int
137 vpo_attach(device_t dev)
138 {
139 	struct vpo_data *vpo = DEVTOSOFTC(dev);
140 	struct cam_devq *devq;
141 	int error;
142 
143 	/* low level attachment */
144 	if (vpo->vpo_isplus) {
145 		if ((error = imm_attach(&vpo->vpo_io)))
146 			return (error);
147 	} else {
148 		if ((error = vpoio_attach(&vpo->vpo_io)))
149 			return (error);
150 	}
151 
152 	/*
153 	**	Now tell the generic SCSI layer
154 	**	about our bus.
155 	*/
156 	devq = cam_simq_alloc(/*maxopenings*/1);
157 	/* XXX What about low-level detach on error? */
158 	if (devq == NULL)
159 		return (ENXIO);
160 
161 	vpo->sim = cam_sim_alloc(vpo_action, vpo_poll, "vpo", vpo,
162 				 device_get_unit(dev),
163 				 /*untagged*/1, /*tagged*/0, devq);
164 	if (vpo->sim == NULL) {
165 		cam_simq_free(devq);
166 		return (ENXIO);
167 	}
168 
169 	if (xpt_bus_register(vpo->sim, /*bus*/0) != CAM_SUCCESS) {
170 		cam_sim_free(vpo->sim, /*free_devq*/TRUE);
171 		return (ENXIO);
172 	}
173 
174 	/* all went ok */
175 
176 	vpo_cam_rescan(vpo);	/* have CAM rescan the bus */
177 
178 	return (0);
179 }
180 
181 static void
182 vpo_cam_rescan_callback(struct cam_periph *periph, union ccb *ccb)
183 {
184         free(ccb, M_TEMP);
185 }
186 
187 static void
188 vpo_cam_rescan(struct vpo_data *vpo)
189 {
190         struct cam_path *path;
191         union ccb *ccb = malloc(sizeof(union ccb), M_TEMP, M_WAITOK);
192 
193         bzero(ccb, sizeof(union ccb));
194 
195         if (xpt_create_path(&path, xpt_periph, cam_sim_path(vpo->sim), 0, 0)
196             != CAM_REQ_CMP) {
197 		/* A failure is benign as the user can do a manual rescan */
198                 return;
199 	}
200 
201         xpt_setup_ccb(&ccb->ccb_h, path, 5/*priority (low)*/);
202         ccb->ccb_h.func_code = XPT_SCAN_BUS;
203         ccb->ccb_h.cbfcnp = vpo_cam_rescan_callback;
204         ccb->crcn.flags = CAM_FLAG_NONE;
205         xpt_action(ccb);
206 
207         /* The scan is in progress now. */
208 }
209 
210 /*
211  * vpo_intr()
212  */
213 static void
214 vpo_intr(struct vpo_data *vpo, struct ccb_scsiio *csio)
215 {
216 	int errno;	/* error in errno.h */
217 	int s;
218 #ifdef VP0_DEBUG
219 	int i;
220 #endif
221 
222 	s = splcam();
223 
224 	if (vpo->vpo_isplus) {
225 		errno = imm_do_scsi(&vpo->vpo_io, VP0_INITIATOR,
226 			csio->ccb_h.target_id,
227 			(char *)&csio->cdb_io.cdb_bytes, csio->cdb_len,
228 			(char *)csio->data_ptr, csio->dxfer_len,
229 			&vpo->vpo_stat, &vpo->vpo_count, &vpo->vpo_error);
230 	} else {
231 		errno = vpoio_do_scsi(&vpo->vpo_io, VP0_INITIATOR,
232 			csio->ccb_h.target_id,
233 			(char *)&csio->cdb_io.cdb_bytes, csio->cdb_len,
234 			(char *)csio->data_ptr, csio->dxfer_len,
235 			&vpo->vpo_stat, &vpo->vpo_count, &vpo->vpo_error);
236 	}
237 
238 #ifdef VP0_DEBUG
239 	printf("vpo_do_scsi = %d, status = 0x%x, count = %d, vpo_error = %d\n",
240 		 errno, vpo->vpo_stat, vpo->vpo_count, vpo->vpo_error);
241 
242 	/* dump of command */
243 	for (i=0; i<csio->cdb_len; i++)
244 		printf("%x ", ((char *)&csio->cdb_io.cdb_bytes)[i]);
245 
246 	printf("\n");
247 #endif
248 
249 	if (errno) {
250 		/* connection to ppbus interrupted */
251 		csio->ccb_h.status = CAM_CMD_TIMEOUT;
252 		goto error;
253 	}
254 
255 	/* if a timeout occured, no sense */
256 	if (vpo->vpo_error) {
257 		if (vpo->vpo_error != VP0_ESELECT_TIMEOUT)
258 			printf("vpo%d: VP0 error/timeout (%d)\n",
259 				vpo->vpo_unit, vpo->vpo_error);
260 
261 		csio->ccb_h.status = CAM_CMD_TIMEOUT;
262 		goto error;
263 	}
264 
265 	/* check scsi status */
266 	if (vpo->vpo_stat != SCSI_STATUS_OK) {
267 	   csio->scsi_status = vpo->vpo_stat;
268 
269 	   /* check if we have to sense the drive */
270 	   if ((vpo->vpo_stat & SCSI_STATUS_CHECK_COND) != 0) {
271 
272 		vpo->vpo_sense.cmd.opcode = REQUEST_SENSE;
273 		vpo->vpo_sense.cmd.length = csio->sense_len;
274 		vpo->vpo_sense.cmd.control = 0;
275 
276 		if (vpo->vpo_isplus) {
277 			errno = imm_do_scsi(&vpo->vpo_io, VP0_INITIATOR,
278 				csio->ccb_h.target_id,
279 				(char *)&vpo->vpo_sense.cmd,
280 				sizeof(vpo->vpo_sense.cmd),
281 				(char *)&csio->sense_data, csio->sense_len,
282 				&vpo->vpo_sense.stat, &vpo->vpo_sense.count,
283 				&vpo->vpo_error);
284 		} else {
285 			errno = vpoio_do_scsi(&vpo->vpo_io, VP0_INITIATOR,
286 				csio->ccb_h.target_id,
287 				(char *)&vpo->vpo_sense.cmd,
288 				sizeof(vpo->vpo_sense.cmd),
289 				(char *)&csio->sense_data, csio->sense_len,
290 				&vpo->vpo_sense.stat, &vpo->vpo_sense.count,
291 				&vpo->vpo_error);
292 		}
293 
294 
295 #ifdef VP0_DEBUG
296 		printf("(sense) vpo_do_scsi = %d, status = 0x%x, count = %d, vpo_error = %d\n",
297 			errno, vpo->vpo_sense.stat, vpo->vpo_sense.count, vpo->vpo_error);
298 #endif
299 
300 		/* check sense return status */
301 		if (errno == 0 && vpo->vpo_sense.stat == SCSI_STATUS_OK) {
302 		   /* sense ok */
303 		   csio->ccb_h.status = CAM_AUTOSNS_VALID | CAM_SCSI_STATUS_ERROR;
304 		   csio->sense_resid = csio->sense_len - vpo->vpo_sense.count;
305 
306 #ifdef VP0_DEBUG
307 		   /* dump of sense info */
308 		   printf("(sense) ");
309 		   for (i=0; i<vpo->vpo_sense.count; i++)
310 			printf("%x ", ((char *)&csio->sense_data)[i]);
311 		   printf("\n");
312 #endif
313 
314 		} else {
315 		   /* sense failed */
316 		   csio->ccb_h.status = CAM_AUTOSENSE_FAIL;
317 		}
318 	   } else {
319 		/* no sense */
320 		csio->ccb_h.status = CAM_SCSI_STATUS_ERROR;
321 	   }
322 
323 	   goto error;
324 	}
325 
326 	csio->resid = csio->dxfer_len - vpo->vpo_count;
327 	csio->ccb_h.status = CAM_REQ_CMP;
328 
329 error:
330 	splx(s);
331 
332 	return;
333 }
334 
335 static void
336 vpo_action(struct cam_sim *sim, union ccb *ccb)
337 {
338 
339 	struct vpo_data *vpo = (struct vpo_data *)sim->softc;
340 
341 	switch (ccb->ccb_h.func_code) {
342 	case XPT_SCSI_IO:
343 	{
344 		struct ccb_scsiio *csio;
345 
346 		csio = &ccb->csio;
347 
348 #ifdef VP0_DEBUG
349 		printf("vpo%d: XPT_SCSI_IO (0x%x) request\n",
350 			vpo->vpo_unit, csio->cdb_io.cdb_bytes[0]);
351 #endif
352 
353 		vpo_intr(vpo, csio);
354 
355 		xpt_done(ccb);
356 
357 		break;
358 	}
359 	case XPT_CALC_GEOMETRY:
360 	{
361 		struct	  ccb_calc_geometry *ccg;
362 
363 		ccg = &ccb->ccg;
364 
365 #ifdef VP0_DEBUG
366 		printf("vpo%d: XPT_CALC_GEOMETRY (bs=%d,vs=%d,c=%d,h=%d,spt=%d) request\n",
367 			vpo->vpo_unit,
368 			ccg->block_size,
369 			ccg->volume_size,
370 			ccg->cylinders,
371 			ccg->heads,
372 			ccg->secs_per_track);
373 #endif
374 
375 		ccg->heads = 64;
376 		ccg->secs_per_track = 32;
377 		ccg->cylinders = ccg->volume_size /
378 				 (ccg->heads * ccg->secs_per_track);
379 
380 		ccb->ccb_h.status = CAM_REQ_CMP;
381 		xpt_done(ccb);
382 		break;
383 	}
384 	case XPT_RESET_BUS:		/* Reset the specified SCSI bus */
385 	{
386 
387 #ifdef VP0_DEBUG
388 		printf("vpo%d: XPT_RESET_BUS request\n", vpo->vpo_unit);
389 #endif
390 
391 		if (vpo->vpo_isplus) {
392 			if (imm_reset_bus(&vpo->vpo_io)) {
393 				ccb->ccb_h.status = CAM_REQ_CMP_ERR;
394 				xpt_done(ccb);
395 				return;
396 			}
397 		} else {
398 			if (vpoio_reset_bus(&vpo->vpo_io)) {
399 				ccb->ccb_h.status = CAM_REQ_CMP_ERR;
400 				xpt_done(ccb);
401 				return;
402 			}
403 		}
404 
405 		ccb->ccb_h.status = CAM_REQ_CMP;
406 		xpt_done(ccb);
407 		break;
408 	}
409 	case XPT_PATH_INQ:		/* Path routing inquiry */
410 	{
411 		struct ccb_pathinq *cpi = &ccb->cpi;
412 
413 #ifdef VP0_DEBUG
414 		printf("vpo%d: XPT_PATH_INQ request\n", vpo->vpo_unit);
415 #endif
416 		cpi->version_num = 1; /* XXX??? */
417 		cpi->hba_inquiry = 0;
418 		cpi->target_sprt = 0;
419 		cpi->hba_misc = 0;
420 		cpi->hba_eng_cnt = 0;
421 		cpi->max_target = 7;
422 		cpi->max_lun = 0;
423 		cpi->initiator_id = VP0_INITIATOR;
424 		cpi->bus_id = sim->bus_id;
425 		cpi->base_transfer_speed = 93;
426 		strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
427 		strncpy(cpi->hba_vid, "Iomega", HBA_IDLEN);
428 		strncpy(cpi->dev_name, sim->sim_name, DEV_IDLEN);
429 		cpi->unit_number = sim->unit_number;
430 
431 		cpi->ccb_h.status = CAM_REQ_CMP;
432 		xpt_done(ccb);
433 		break;
434 	}
435 	default:
436 		ccb->ccb_h.status = CAM_REQ_INVALID;
437 		xpt_done(ccb);
438 		break;
439 	}
440 
441 	return;
442 }
443 
444 static void
445 vpo_poll(struct cam_sim *sim)
446 {
447 	/* The ZIP is actually always polled throw vpo_action() */
448 	return;
449 }
450 
451 static devclass_t vpo_devclass;
452 
453 static device_method_t vpo_methods[] = {
454 	/* device interface */
455 	DEVMETHOD(device_identify,	vpo_identify),
456 	DEVMETHOD(device_probe,		vpo_probe),
457 	DEVMETHOD(device_attach,	vpo_attach),
458 
459 	{ 0, 0 }
460 };
461 
462 static driver_t vpo_driver = {
463 	"vpo",
464 	vpo_methods,
465 	sizeof(struct vpo_data),
466 };
467 DRIVER_MODULE(vpo, ppbus, vpo_driver, vpo_devclass, 0, 0);
468