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