uvisor.c revision 214761
1/*	$NetBSD: uvisor.c,v 1.9 2001/01/23 14:04:14 augustss Exp $	*/
2/*      $FreeBSD: head/sys/dev/usb/serial/uvisor.c 214761 2010-11-03 21:50:49Z n_hibma $ */
3
4/* Also already merged from NetBSD:
5 *	$NetBSD: uvisor.c,v 1.12 2001/11/13 06:24:57 lukem Exp $
6 *	$NetBSD: uvisor.c,v 1.13 2002/02/11 15:11:49 augustss Exp $
7 *	$NetBSD: uvisor.c,v 1.14 2002/02/27 23:00:03 augustss Exp $
8 *	$NetBSD: uvisor.c,v 1.15 2002/06/16 15:01:31 augustss Exp $
9 *	$NetBSD: uvisor.c,v 1.16 2002/07/11 21:14:36 augustss Exp $
10 *	$NetBSD: uvisor.c,v 1.17 2002/08/13 11:38:15 augustss Exp $
11 *	$NetBSD: uvisor.c,v 1.18 2003/02/05 00:50:14 augustss Exp $
12 *	$NetBSD: uvisor.c,v 1.19 2003/02/07 18:12:37 augustss Exp $
13 *	$NetBSD: uvisor.c,v 1.20 2003/04/11 01:30:10 simonb Exp $
14 */
15
16/*-
17 * Copyright (c) 2000 The NetBSD Foundation, Inc.
18 * All rights reserved.
19 *
20 * This code is derived from software contributed to The NetBSD Foundation
21 * by Lennart Augustsson (lennart@augustsson.net) at
22 * Carlstedt Research & Technology.
23 *
24 * Redistribution and use in source and binary forms, with or without
25 * modification, are permitted provided that the following conditions
26 * are met:
27 * 1. Redistributions of source code must retain the above copyright
28 *    notice, this list of conditions and the following disclaimer.
29 * 2. Redistributions in binary form must reproduce the above copyright
30 *    notice, this list of conditions and the following disclaimer in the
31 *    documentation and/or other materials provided with the distribution.
32 *
33 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
34 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
35 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
36 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
37 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
38 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
39 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
40 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
41 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
43 * POSSIBILITY OF SUCH DAMAGE.
44 */
45
46/*
47 * Handspring Visor (Palmpilot compatible PDA) driver
48 */
49
50#include <sys/stdint.h>
51#include <sys/stddef.h>
52#include <sys/param.h>
53#include <sys/queue.h>
54#include <sys/types.h>
55#include <sys/systm.h>
56#include <sys/kernel.h>
57#include <sys/bus.h>
58#include <sys/linker_set.h>
59#include <sys/module.h>
60#include <sys/lock.h>
61#include <sys/mutex.h>
62#include <sys/condvar.h>
63#include <sys/sysctl.h>
64#include <sys/sx.h>
65#include <sys/unistd.h>
66#include <sys/callout.h>
67#include <sys/malloc.h>
68#include <sys/priv.h>
69
70#include <dev/usb/usb.h>
71#include <dev/usb/usbdi.h>
72#include <dev/usb/usbdi_util.h>
73#include "usbdevs.h"
74
75#define	USB_DEBUG_VAR uvisor_debug
76#include <dev/usb/usb_debug.h>
77#include <dev/usb/usb_process.h>
78
79#include <dev/usb/serial/usb_serial.h>
80
81#ifdef USB_DEBUG
82static int uvisor_debug = 0;
83
84SYSCTL_NODE(_hw_usb, OID_AUTO, uvisor, CTLFLAG_RW, 0, "USB uvisor");
85SYSCTL_INT(_hw_usb_uvisor, OID_AUTO, debug, CTLFLAG_RW,
86    &uvisor_debug, 0, "Debug level");
87#endif
88
89#define	UVISOR_CONFIG_INDEX	0
90#define	UVISOR_IFACE_INDEX	0
91
92/*
93 * The following buffer sizes are hardcoded due to the way the Palm
94 * firmware works. It looks like the device is not short terminating
95 * the data transferred.
96 */
97#define	UVISORIBUFSIZE	       0	/* Use wMaxPacketSize */
98#define	UVISOROBUFSIZE	       32	/* bytes */
99#define	UVISOROFRAMES	       32	/* units */
100
101/* From the Linux driver */
102/*
103 * UVISOR_REQUEST_BYTES_AVAILABLE asks the visor for the number of bytes that
104 * are available to be transfered to the host for the specified endpoint.
105 * Currently this is not used, and always returns 0x0001
106 */
107#define	UVISOR_REQUEST_BYTES_AVAILABLE		0x01
108
109/*
110 * UVISOR_CLOSE_NOTIFICATION is set to the device to notify it that the host
111 * is now closing the pipe. An empty packet is sent in response.
112 */
113#define	UVISOR_CLOSE_NOTIFICATION		0x02
114
115/*
116 * UVISOR_GET_CONNECTION_INFORMATION is sent by the host during enumeration to
117 * get the endpoints used by the connection.
118 */
119#define	UVISOR_GET_CONNECTION_INFORMATION	0x03
120
121/*
122 * UVISOR_GET_CONNECTION_INFORMATION returns data in the following format
123 */
124#define	UVISOR_MAX_CONN 8
125struct uvisor_connection_info {
126	uWord	num_ports;
127	struct {
128		uByte	port_function_id;
129		uByte	port;
130	} __packed connections[UVISOR_MAX_CONN];
131} __packed;
132
133#define	UVISOR_CONNECTION_INFO_SIZE 18
134
135/* struct uvisor_connection_info.connection[x].port defines: */
136#define	UVISOR_ENDPOINT_1		0x01
137#define	UVISOR_ENDPOINT_2		0x02
138
139/* struct uvisor_connection_info.connection[x].port_function_id defines: */
140#define	UVISOR_FUNCTION_GENERIC		0x00
141#define	UVISOR_FUNCTION_DEBUGGER	0x01
142#define	UVISOR_FUNCTION_HOTSYNC		0x02
143#define	UVISOR_FUNCTION_CONSOLE		0x03
144#define	UVISOR_FUNCTION_REMOTE_FILE_SYS	0x04
145
146/*
147 * Unknown PalmOS stuff.
148 */
149#define	UVISOR_GET_PALM_INFORMATION		0x04
150#define	UVISOR_GET_PALM_INFORMATION_LEN		0x44
151
152struct uvisor_palm_connection_info {
153	uByte	num_ports;
154	uByte	endpoint_numbers_different;
155	uWord	reserved1;
156	struct {
157		uDWord	port_function_id;
158		uByte	port;
159		uByte	end_point_info;
160		uWord	reserved;
161	} __packed connections[UVISOR_MAX_CONN];
162} __packed;
163
164enum {
165	UVISOR_BULK_DT_WR,
166	UVISOR_BULK_DT_RD,
167	UVISOR_N_TRANSFER,
168};
169
170struct uvisor_softc {
171	struct ucom_super_softc sc_super_ucom;
172	struct ucom_softc sc_ucom;
173
174	struct usb_xfer *sc_xfer[UVISOR_N_TRANSFER];
175	struct usb_device *sc_udev;
176	struct mtx sc_mtx;
177
178	uint16_t sc_flag;
179#define	UVISOR_FLAG_PALM4       0x0001
180#define	UVISOR_FLAG_VISOR       0x0002
181#define	UVISOR_FLAG_PALM35      0x0004
182#define	UVISOR_FLAG_SEND_NOTIFY 0x0008
183
184	uint8_t	sc_iface_no;
185	uint8_t	sc_iface_index;
186};
187
188/* prototypes */
189
190static device_probe_t uvisor_probe;
191static device_attach_t uvisor_attach;
192static device_detach_t uvisor_detach;
193
194static usb_callback_t uvisor_write_callback;
195static usb_callback_t uvisor_read_callback;
196
197static usb_error_t uvisor_init(struct uvisor_softc *, struct usb_device *,
198		    struct usb_config *);
199static void	uvisor_cfg_open(struct ucom_softc *);
200static void	uvisor_cfg_close(struct ucom_softc *);
201static void	uvisor_start_read(struct ucom_softc *);
202static void	uvisor_stop_read(struct ucom_softc *);
203static void	uvisor_start_write(struct ucom_softc *);
204static void	uvisor_stop_write(struct ucom_softc *);
205
206static const struct usb_config uvisor_config[UVISOR_N_TRANSFER] = {
207
208	[UVISOR_BULK_DT_WR] = {
209		.type = UE_BULK,
210		.endpoint = UE_ADDR_ANY,
211		.direction = UE_DIR_OUT,
212		.bufsize = UVISOROBUFSIZE * UVISOROFRAMES,
213		.frames = UVISOROFRAMES,
214		.flags = {.pipe_bof = 1,.force_short_xfer = 1,},
215		.callback = &uvisor_write_callback,
216	},
217
218	[UVISOR_BULK_DT_RD] = {
219		.type = UE_BULK,
220		.endpoint = UE_ADDR_ANY,
221		.direction = UE_DIR_IN,
222		.bufsize = UVISORIBUFSIZE,
223		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
224		.callback = &uvisor_read_callback,
225	},
226};
227
228static const struct ucom_callback uvisor_callback = {
229	.ucom_cfg_open = &uvisor_cfg_open,
230	.ucom_cfg_close = &uvisor_cfg_close,
231	.ucom_start_read = &uvisor_start_read,
232	.ucom_stop_read = &uvisor_stop_read,
233	.ucom_start_write = &uvisor_start_write,
234	.ucom_stop_write = &uvisor_stop_write,
235};
236
237static device_method_t uvisor_methods[] = {
238	DEVMETHOD(device_probe, uvisor_probe),
239	DEVMETHOD(device_attach, uvisor_attach),
240	DEVMETHOD(device_detach, uvisor_detach),
241	{0, 0}
242};
243
244static devclass_t uvisor_devclass;
245
246static driver_t uvisor_driver = {
247	.name = "uvisor",
248	.methods = uvisor_methods,
249	.size = sizeof(struct uvisor_softc),
250};
251
252DRIVER_MODULE(uvisor, uhub, uvisor_driver, uvisor_devclass, NULL, 0);
253MODULE_DEPEND(uvisor, ucom, 1, 1, 1);
254MODULE_DEPEND(uvisor, usb, 1, 1, 1);
255MODULE_VERSION(uvisor, 1);
256
257static const struct usb_device_id uvisor_devs[] = {
258#define	UVISOR_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
259	UVISOR_DEV(ACEECA, MEZ1000, UVISOR_FLAG_PALM4),
260	UVISOR_DEV(ALPHASMART, DANA_SYNC, UVISOR_FLAG_PALM4),
261	UVISOR_DEV(GARMIN, IQUE_3600, UVISOR_FLAG_PALM4),
262	UVISOR_DEV(FOSSIL, WRISTPDA, UVISOR_FLAG_PALM4),
263	UVISOR_DEV(HANDSPRING, VISOR, UVISOR_FLAG_VISOR),
264	UVISOR_DEV(HANDSPRING, TREO, UVISOR_FLAG_PALM4),
265	UVISOR_DEV(HANDSPRING, TREO600, UVISOR_FLAG_PALM4),
266	UVISOR_DEV(PALM, M500, UVISOR_FLAG_PALM4),
267	UVISOR_DEV(PALM, M505, UVISOR_FLAG_PALM4),
268	UVISOR_DEV(PALM, M515, UVISOR_FLAG_PALM4),
269	UVISOR_DEV(PALM, I705, UVISOR_FLAG_PALM4),
270	UVISOR_DEV(PALM, M125, UVISOR_FLAG_PALM4),
271	UVISOR_DEV(PALM, M130, UVISOR_FLAG_PALM4),
272	UVISOR_DEV(PALM, TUNGSTEN_Z, UVISOR_FLAG_PALM4),
273	UVISOR_DEV(PALM, TUNGSTEN_T, UVISOR_FLAG_PALM4),
274	UVISOR_DEV(PALM, ZIRE, UVISOR_FLAG_PALM4),
275	UVISOR_DEV(PALM, ZIRE31, UVISOR_FLAG_PALM4),
276	UVISOR_DEV(SAMSUNG, I500, UVISOR_FLAG_PALM4),
277	UVISOR_DEV(SONY, CLIE_40, 0),
278	UVISOR_DEV(SONY, CLIE_41, 0),
279	UVISOR_DEV(SONY, CLIE_S360, UVISOR_FLAG_PALM4),
280	UVISOR_DEV(SONY, CLIE_NX60, UVISOR_FLAG_PALM4),
281	UVISOR_DEV(SONY, CLIE_35, UVISOR_FLAG_PALM35),
282/*  UVISOR_DEV(SONY, CLIE_25, UVISOR_FLAG_PALM4 ), */
283	UVISOR_DEV(SONY, CLIE_TJ37, UVISOR_FLAG_PALM4),
284/*  UVISOR_DEV(SONY, CLIE_TH55, UVISOR_FLAG_PALM4 ), See PR 80935 */
285	UVISOR_DEV(TAPWAVE, ZODIAC, UVISOR_FLAG_PALM4),
286#undef UVISOR_DEV
287};
288
289static int
290uvisor_probe(device_t dev)
291{
292	struct usb_attach_arg *uaa = device_get_ivars(dev);
293
294	if (uaa->usb_mode != USB_MODE_HOST) {
295		return (ENXIO);
296	}
297	if (uaa->info.bConfigIndex != UVISOR_CONFIG_INDEX) {
298		return (ENXIO);
299	}
300	if (uaa->info.bIfaceIndex != UVISOR_IFACE_INDEX) {
301		return (ENXIO);
302	}
303	return (usbd_lookup_id_by_uaa(uvisor_devs, sizeof(uvisor_devs), uaa));
304}
305
306static int
307uvisor_attach(device_t dev)
308{
309	struct usb_attach_arg *uaa = device_get_ivars(dev);
310	struct uvisor_softc *sc = device_get_softc(dev);
311	struct usb_config uvisor_config_copy[UVISOR_N_TRANSFER];
312	int error;
313
314	DPRINTF("sc=%p\n", sc);
315	bcopy(uvisor_config, uvisor_config_copy,
316	    sizeof(uvisor_config_copy));
317	device_set_usb_desc(dev);
318
319	mtx_init(&sc->sc_mtx, "uvisor", NULL, MTX_DEF);
320
321	sc->sc_udev = uaa->device;
322
323	/* configure the device */
324
325	sc->sc_flag = USB_GET_DRIVER_INFO(uaa);
326	sc->sc_iface_no = uaa->info.bIfaceNum;
327	sc->sc_iface_index = UVISOR_IFACE_INDEX;
328
329	error = uvisor_init(sc, uaa->device, uvisor_config_copy);
330
331	if (error) {
332		DPRINTF("init failed, error=%s\n",
333		    usbd_errstr(error));
334		goto detach;
335	}
336	error = usbd_transfer_setup(uaa->device, &sc->sc_iface_index,
337	    sc->sc_xfer, uvisor_config_copy, UVISOR_N_TRANSFER,
338	    sc, &sc->sc_mtx);
339	if (error) {
340		DPRINTF("could not allocate all pipes\n");
341		goto detach;
342	}
343
344	error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
345	    &uvisor_callback, &sc->sc_mtx);
346	if (error) {
347		DPRINTF("ucom_attach failed\n");
348		goto detach;
349	}
350	return (0);
351
352detach:
353	uvisor_detach(dev);
354	return (ENXIO);
355}
356
357static int
358uvisor_detach(device_t dev)
359{
360	struct uvisor_softc *sc = device_get_softc(dev);
361
362	DPRINTF("sc=%p\n", sc);
363
364	ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
365	usbd_transfer_unsetup(sc->sc_xfer, UVISOR_N_TRANSFER);
366	mtx_destroy(&sc->sc_mtx);
367
368	return (0);
369}
370
371static usb_error_t
372uvisor_init(struct uvisor_softc *sc, struct usb_device *udev, struct usb_config *config)
373{
374	usb_error_t err = 0;
375	struct usb_device_request req;
376	struct uvisor_connection_info coninfo;
377	struct uvisor_palm_connection_info pconinfo;
378	uint16_t actlen;
379	uint8_t buffer[256];
380
381	if (sc->sc_flag & UVISOR_FLAG_VISOR) {
382		DPRINTF("getting connection info\n");
383		req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
384		req.bRequest = UVISOR_GET_CONNECTION_INFORMATION;
385		USETW(req.wValue, 0);
386		USETW(req.wIndex, 0);
387		USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE);
388		err = usbd_do_request_flags(udev, NULL,
389		    &req, &coninfo, USB_SHORT_XFER_OK,
390		    &actlen, USB_DEFAULT_TIMEOUT);
391
392		if (err) {
393			goto done;
394		}
395	}
396#ifdef USB_DEBUG
397	if (sc->sc_flag & UVISOR_FLAG_VISOR) {
398		uint16_t i, np;
399		const char *desc;
400
401		np = UGETW(coninfo.num_ports);
402		if (np > UVISOR_MAX_CONN) {
403			np = UVISOR_MAX_CONN;
404		}
405		DPRINTF("Number of ports: %d\n", np);
406
407		for (i = 0; i < np; ++i) {
408			switch (coninfo.connections[i].port_function_id) {
409			case UVISOR_FUNCTION_GENERIC:
410				desc = "Generic";
411				break;
412			case UVISOR_FUNCTION_DEBUGGER:
413				desc = "Debugger";
414				break;
415			case UVISOR_FUNCTION_HOTSYNC:
416				desc = "HotSync";
417				break;
418			case UVISOR_FUNCTION_REMOTE_FILE_SYS:
419				desc = "Remote File System";
420				break;
421			default:
422				desc = "unknown";
423				break;
424			}
425			DPRINTF("Port %d is for %s\n",
426			    coninfo.connections[i].port, desc);
427		}
428	}
429#endif
430
431	if (sc->sc_flag & UVISOR_FLAG_PALM4) {
432		uint8_t port;
433
434		/* Palm OS 4.0 Hack */
435		req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
436		req.bRequest = UVISOR_GET_PALM_INFORMATION;
437		USETW(req.wValue, 0);
438		USETW(req.wIndex, 0);
439		USETW(req.wLength, UVISOR_GET_PALM_INFORMATION_LEN);
440
441		err = usbd_do_request_flags
442		    (udev, NULL, &req, &pconinfo, USB_SHORT_XFER_OK,
443		    &actlen, USB_DEFAULT_TIMEOUT);
444
445		if (err) {
446			goto done;
447		}
448		if (actlen < 12) {
449			DPRINTF("too little data\n");
450			err = USB_ERR_INVAL;
451			goto done;
452		}
453		if (pconinfo.endpoint_numbers_different) {
454			port = pconinfo.connections[0].end_point_info;
455			config[0].endpoint = (port & 0xF);	/* output */
456			config[1].endpoint = (port >> 4);	/* input */
457		} else {
458			port = pconinfo.connections[0].port;
459			config[0].endpoint = (port & 0xF);	/* output */
460			config[1].endpoint = (port & 0xF);	/* input */
461		}
462#if 0
463		req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
464		req.bRequest = UVISOR_GET_PALM_INFORMATION;
465		USETW(req.wValue, 0);
466		USETW(req.wIndex, 0);
467		USETW(req.wLength, UVISOR_GET_PALM_INFORMATION_LEN);
468		err = usbd_do_request(udev, &req, buffer);
469		if (err) {
470			goto done;
471		}
472#endif
473	}
474	if (sc->sc_flag & UVISOR_FLAG_PALM35) {
475		/* get the config number */
476		DPRINTF("getting config info\n");
477		req.bmRequestType = UT_READ;
478		req.bRequest = UR_GET_CONFIG;
479		USETW(req.wValue, 0);
480		USETW(req.wIndex, 0);
481		USETW(req.wLength, 1);
482
483		err = usbd_do_request(udev, NULL, &req, buffer);
484		if (err) {
485			goto done;
486		}
487		/* get the interface number */
488		DPRINTF("get the interface number\n");
489		req.bmRequestType = UT_READ_DEVICE;
490		req.bRequest = UR_GET_INTERFACE;
491		USETW(req.wValue, 0);
492		USETW(req.wIndex, 0);
493		USETW(req.wLength, 1);
494		err = usbd_do_request(udev, NULL, &req, buffer);
495		if (err) {
496			goto done;
497		}
498	}
499#if 0
500	uWord wAvail;
501
502	DPRINTF("getting available bytes\n");
503	req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
504	req.bRequest = UVISOR_REQUEST_BYTES_AVAILABLE;
505	USETW(req.wValue, 0);
506	USETW(req.wIndex, 5);
507	USETW(req.wLength, sizeof(wAvail));
508	err = usbd_do_request(udev, NULL, &req, &wAvail);
509	if (err) {
510		goto done;
511	}
512	DPRINTF("avail=%d\n", UGETW(wAvail));
513#endif
514
515	DPRINTF("done\n");
516done:
517	return (err);
518}
519
520static void
521uvisor_cfg_open(struct ucom_softc *ucom)
522{
523	return;
524}
525
526static void
527uvisor_cfg_close(struct ucom_softc *ucom)
528{
529	struct uvisor_softc *sc = ucom->sc_parent;
530	uint8_t buffer[UVISOR_CONNECTION_INFO_SIZE];
531	struct usb_device_request req;
532	usb_error_t err;
533
534	req.bmRequestType = UT_READ_VENDOR_ENDPOINT;	/* XXX read? */
535	req.bRequest = UVISOR_CLOSE_NOTIFICATION;
536	USETW(req.wValue, 0);
537	USETW(req.wIndex, 0);
538	USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE);
539
540	err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
541	    &req, buffer, 0, 1000);
542	if (err) {
543		DPRINTFN(0, "close notification failed, error=%s\n",
544		    usbd_errstr(err));
545	}
546}
547
548static void
549uvisor_start_read(struct ucom_softc *ucom)
550{
551	struct uvisor_softc *sc = ucom->sc_parent;
552
553	usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_RD]);
554}
555
556static void
557uvisor_stop_read(struct ucom_softc *ucom)
558{
559	struct uvisor_softc *sc = ucom->sc_parent;
560
561	usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_RD]);
562}
563
564static void
565uvisor_start_write(struct ucom_softc *ucom)
566{
567	struct uvisor_softc *sc = ucom->sc_parent;
568
569	usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_WR]);
570}
571
572static void
573uvisor_stop_write(struct ucom_softc *ucom)
574{
575	struct uvisor_softc *sc = ucom->sc_parent;
576
577	usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_WR]);
578}
579
580static void
581uvisor_write_callback(struct usb_xfer *xfer, usb_error_t error)
582{
583	struct uvisor_softc *sc = usbd_xfer_softc(xfer);
584	struct usb_page_cache *pc;
585	uint32_t actlen;
586	uint8_t x;
587
588	switch (USB_GET_STATE(xfer)) {
589	case USB_ST_SETUP:
590	case USB_ST_TRANSFERRED:
591tr_setup:
592		for (x = 0; x != UVISOROFRAMES; x++) {
593
594			usbd_xfer_set_frame_offset(xfer,
595			    x * UVISOROBUFSIZE, x);
596
597			pc = usbd_xfer_get_frame(xfer, x);
598			if (ucom_get_data(&sc->sc_ucom, pc, 0,
599			    UVISOROBUFSIZE, &actlen)) {
600				usbd_xfer_set_frame_len(xfer, x, actlen);
601			} else {
602				break;
603			}
604		}
605		/* check for data */
606		if (x != 0) {
607			usbd_xfer_set_frames(xfer, x);
608			usbd_transfer_submit(xfer);
609		}
610		break;
611
612	default:			/* Error */
613		if (error != USB_ERR_CANCELLED) {
614			/* try to clear stall first */
615			usbd_xfer_set_stall(xfer);
616			goto tr_setup;
617		}
618		break;
619	}
620}
621
622static void
623uvisor_read_callback(struct usb_xfer *xfer, usb_error_t error)
624{
625	struct uvisor_softc *sc = usbd_xfer_softc(xfer);
626	struct usb_page_cache *pc;
627	int actlen;
628
629	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
630
631	switch (USB_GET_STATE(xfer)) {
632	case USB_ST_TRANSFERRED:
633		pc = usbd_xfer_get_frame(xfer, 0);
634		ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
635
636	case USB_ST_SETUP:
637tr_setup:
638		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
639		usbd_transfer_submit(xfer);
640		return;
641
642	default:			/* Error */
643		if (error != USB_ERR_CANCELLED) {
644			/* try to clear stall first */
645			usbd_xfer_set_stall(xfer);
646			goto tr_setup;
647		}
648		return;
649	}
650}
651