uvisor.c revision 214761
1184610Salfred/*	$NetBSD: uvisor.c,v 1.9 2001/01/23 14:04:14 augustss Exp $	*/
2184610Salfred/*      $FreeBSD: head/sys/dev/usb/serial/uvisor.c 214761 2010-11-03 21:50:49Z n_hibma $ */
3184610Salfred
4184610Salfred/* Also already merged from NetBSD:
5184610Salfred *	$NetBSD: uvisor.c,v 1.12 2001/11/13 06:24:57 lukem Exp $
6184610Salfred *	$NetBSD: uvisor.c,v 1.13 2002/02/11 15:11:49 augustss Exp $
7184610Salfred *	$NetBSD: uvisor.c,v 1.14 2002/02/27 23:00:03 augustss Exp $
8184610Salfred *	$NetBSD: uvisor.c,v 1.15 2002/06/16 15:01:31 augustss Exp $
9184610Salfred *	$NetBSD: uvisor.c,v 1.16 2002/07/11 21:14:36 augustss Exp $
10184610Salfred *	$NetBSD: uvisor.c,v 1.17 2002/08/13 11:38:15 augustss Exp $
11184610Salfred *	$NetBSD: uvisor.c,v 1.18 2003/02/05 00:50:14 augustss Exp $
12184610Salfred *	$NetBSD: uvisor.c,v 1.19 2003/02/07 18:12:37 augustss Exp $
13184610Salfred *	$NetBSD: uvisor.c,v 1.20 2003/04/11 01:30:10 simonb Exp $
14184610Salfred */
15184610Salfred
16184610Salfred/*-
17184610Salfred * Copyright (c) 2000 The NetBSD Foundation, Inc.
18184610Salfred * All rights reserved.
19184610Salfred *
20184610Salfred * This code is derived from software contributed to The NetBSD Foundation
21184610Salfred * by Lennart Augustsson (lennart@augustsson.net) at
22184610Salfred * Carlstedt Research & Technology.
23184610Salfred *
24184610Salfred * Redistribution and use in source and binary forms, with or without
25184610Salfred * modification, are permitted provided that the following conditions
26184610Salfred * are met:
27184610Salfred * 1. Redistributions of source code must retain the above copyright
28184610Salfred *    notice, this list of conditions and the following disclaimer.
29184610Salfred * 2. Redistributions in binary form must reproduce the above copyright
30184610Salfred *    notice, this list of conditions and the following disclaimer in the
31184610Salfred *    documentation and/or other materials provided with the distribution.
32184610Salfred *
33184610Salfred * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
34184610Salfred * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
35184610Salfred * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
36184610Salfred * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
37184610Salfred * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
38184610Salfred * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
39184610Salfred * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
40184610Salfred * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
41184610Salfred * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42184610Salfred * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
43184610Salfred * POSSIBILITY OF SUCH DAMAGE.
44184610Salfred */
45184610Salfred
46184610Salfred/*
47184610Salfred * Handspring Visor (Palmpilot compatible PDA) driver
48184610Salfred */
49184610Salfred
50194677Sthompsa#include <sys/stdint.h>
51194677Sthompsa#include <sys/stddef.h>
52194677Sthompsa#include <sys/param.h>
53194677Sthompsa#include <sys/queue.h>
54194677Sthompsa#include <sys/types.h>
55194677Sthompsa#include <sys/systm.h>
56194677Sthompsa#include <sys/kernel.h>
57194677Sthompsa#include <sys/bus.h>
58194677Sthompsa#include <sys/linker_set.h>
59194677Sthompsa#include <sys/module.h>
60194677Sthompsa#include <sys/lock.h>
61194677Sthompsa#include <sys/mutex.h>
62194677Sthompsa#include <sys/condvar.h>
63194677Sthompsa#include <sys/sysctl.h>
64194677Sthompsa#include <sys/sx.h>
65194677Sthompsa#include <sys/unistd.h>
66194677Sthompsa#include <sys/callout.h>
67194677Sthompsa#include <sys/malloc.h>
68194677Sthompsa#include <sys/priv.h>
69194677Sthompsa
70194677Sthompsa#include <dev/usb/usb.h>
71194677Sthompsa#include <dev/usb/usbdi.h>
72194677Sthompsa#include <dev/usb/usbdi_util.h>
73188746Sthompsa#include "usbdevs.h"
74184610Salfred
75184610Salfred#define	USB_DEBUG_VAR uvisor_debug
76188942Sthompsa#include <dev/usb/usb_debug.h>
77188942Sthompsa#include <dev/usb/usb_process.h>
78184610Salfred
79188942Sthompsa#include <dev/usb/serial/usb_serial.h>
80184610Salfred
81207077Sthompsa#ifdef USB_DEBUG
82184610Salfredstatic int uvisor_debug = 0;
83184610Salfred
84192502SthompsaSYSCTL_NODE(_hw_usb, OID_AUTO, uvisor, CTLFLAG_RW, 0, "USB uvisor");
85192502SthompsaSYSCTL_INT(_hw_usb_uvisor, OID_AUTO, debug, CTLFLAG_RW,
86184610Salfred    &uvisor_debug, 0, "Debug level");
87184610Salfred#endif
88184610Salfred
89184610Salfred#define	UVISOR_CONFIG_INDEX	0
90184610Salfred#define	UVISOR_IFACE_INDEX	0
91184610Salfred
92196494Salfred/*
93196494Salfred * The following buffer sizes are hardcoded due to the way the Palm
94196494Salfred * firmware works. It looks like the device is not short terminating
95196494Salfred * the data transferred.
96196494Salfred */
97196494Salfred#define	UVISORIBUFSIZE	       0	/* Use wMaxPacketSize */
98196494Salfred#define	UVISOROBUFSIZE	       32	/* bytes */
99196494Salfred#define	UVISOROFRAMES	       32	/* units */
100196494Salfred
101184610Salfred/* From the Linux driver */
102184610Salfred/*
103184610Salfred * UVISOR_REQUEST_BYTES_AVAILABLE asks the visor for the number of bytes that
104184610Salfred * are available to be transfered to the host for the specified endpoint.
105184610Salfred * Currently this is not used, and always returns 0x0001
106184610Salfred */
107184610Salfred#define	UVISOR_REQUEST_BYTES_AVAILABLE		0x01
108184610Salfred
109184610Salfred/*
110184610Salfred * UVISOR_CLOSE_NOTIFICATION is set to the device to notify it that the host
111184610Salfred * is now closing the pipe. An empty packet is sent in response.
112184610Salfred */
113184610Salfred#define	UVISOR_CLOSE_NOTIFICATION		0x02
114184610Salfred
115184610Salfred/*
116184610Salfred * UVISOR_GET_CONNECTION_INFORMATION is sent by the host during enumeration to
117184610Salfred * get the endpoints used by the connection.
118184610Salfred */
119184610Salfred#define	UVISOR_GET_CONNECTION_INFORMATION	0x03
120184610Salfred
121184610Salfred/*
122184610Salfred * UVISOR_GET_CONNECTION_INFORMATION returns data in the following format
123184610Salfred */
124184610Salfred#define	UVISOR_MAX_CONN 8
125184610Salfredstruct uvisor_connection_info {
126184610Salfred	uWord	num_ports;
127184610Salfred	struct {
128184610Salfred		uByte	port_function_id;
129184610Salfred		uByte	port;
130184610Salfred	} __packed connections[UVISOR_MAX_CONN];
131184610Salfred} __packed;
132184610Salfred
133184610Salfred#define	UVISOR_CONNECTION_INFO_SIZE 18
134184610Salfred
135184610Salfred/* struct uvisor_connection_info.connection[x].port defines: */
136184610Salfred#define	UVISOR_ENDPOINT_1		0x01
137184610Salfred#define	UVISOR_ENDPOINT_2		0x02
138184610Salfred
139184610Salfred/* struct uvisor_connection_info.connection[x].port_function_id defines: */
140184610Salfred#define	UVISOR_FUNCTION_GENERIC		0x00
141184610Salfred#define	UVISOR_FUNCTION_DEBUGGER	0x01
142184610Salfred#define	UVISOR_FUNCTION_HOTSYNC		0x02
143184610Salfred#define	UVISOR_FUNCTION_CONSOLE		0x03
144184610Salfred#define	UVISOR_FUNCTION_REMOTE_FILE_SYS	0x04
145184610Salfred
146184610Salfred/*
147184610Salfred * Unknown PalmOS stuff.
148184610Salfred */
149184610Salfred#define	UVISOR_GET_PALM_INFORMATION		0x04
150184610Salfred#define	UVISOR_GET_PALM_INFORMATION_LEN		0x44
151184610Salfred
152184610Salfredstruct uvisor_palm_connection_info {
153184610Salfred	uByte	num_ports;
154184610Salfred	uByte	endpoint_numbers_different;
155184610Salfred	uWord	reserved1;
156184610Salfred	struct {
157184610Salfred		uDWord	port_function_id;
158184610Salfred		uByte	port;
159184610Salfred		uByte	end_point_info;
160184610Salfred		uWord	reserved;
161184610Salfred	} __packed connections[UVISOR_MAX_CONN];
162184610Salfred} __packed;
163184610Salfred
164187259Sthompsaenum {
165187259Sthompsa	UVISOR_BULK_DT_WR,
166187259Sthompsa	UVISOR_BULK_DT_RD,
167188413Sthompsa	UVISOR_N_TRANSFER,
168187259Sthompsa};
169187259Sthompsa
170184610Salfredstruct uvisor_softc {
171192984Sthompsa	struct ucom_super_softc sc_super_ucom;
172192984Sthompsa	struct ucom_softc sc_ucom;
173184610Salfred
174192984Sthompsa	struct usb_xfer *sc_xfer[UVISOR_N_TRANSFER];
175192984Sthompsa	struct usb_device *sc_udev;
176189265Sthompsa	struct mtx sc_mtx;
177184610Salfred
178184610Salfred	uint16_t sc_flag;
179184610Salfred#define	UVISOR_FLAG_PALM4       0x0001
180184610Salfred#define	UVISOR_FLAG_VISOR       0x0002
181184610Salfred#define	UVISOR_FLAG_PALM35      0x0004
182184610Salfred#define	UVISOR_FLAG_SEND_NOTIFY 0x0008
183184610Salfred
184184610Salfred	uint8_t	sc_iface_no;
185184610Salfred	uint8_t	sc_iface_index;
186184610Salfred};
187184610Salfred
188184610Salfred/* prototypes */
189184610Salfred
190184610Salfredstatic device_probe_t uvisor_probe;
191184610Salfredstatic device_attach_t uvisor_attach;
192184610Salfredstatic device_detach_t uvisor_detach;
193184610Salfred
194193045Sthompsastatic usb_callback_t uvisor_write_callback;
195193045Sthompsastatic usb_callback_t uvisor_read_callback;
196184610Salfred
197193045Sthompsastatic usb_error_t uvisor_init(struct uvisor_softc *, struct usb_device *,
198192984Sthompsa		    struct usb_config *);
199192984Sthompsastatic void	uvisor_cfg_open(struct ucom_softc *);
200192984Sthompsastatic void	uvisor_cfg_close(struct ucom_softc *);
201192984Sthompsastatic void	uvisor_start_read(struct ucom_softc *);
202192984Sthompsastatic void	uvisor_stop_read(struct ucom_softc *);
203192984Sthompsastatic void	uvisor_start_write(struct ucom_softc *);
204192984Sthompsastatic void	uvisor_stop_write(struct ucom_softc *);
205184610Salfred
206192984Sthompsastatic const struct usb_config uvisor_config[UVISOR_N_TRANSFER] = {
207184610Salfred
208187259Sthompsa	[UVISOR_BULK_DT_WR] = {
209184610Salfred		.type = UE_BULK,
210184610Salfred		.endpoint = UE_ADDR_ANY,
211184610Salfred		.direction = UE_DIR_OUT,
212196494Salfred		.bufsize = UVISOROBUFSIZE * UVISOROFRAMES,
213196494Salfred		.frames = UVISOROFRAMES,
214190734Sthompsa		.flags = {.pipe_bof = 1,.force_short_xfer = 1,},
215190734Sthompsa		.callback = &uvisor_write_callback,
216184610Salfred	},
217184610Salfred
218187259Sthompsa	[UVISOR_BULK_DT_RD] = {
219184610Salfred		.type = UE_BULK,
220184610Salfred		.endpoint = UE_ADDR_ANY,
221184610Salfred		.direction = UE_DIR_IN,
222196494Salfred		.bufsize = UVISORIBUFSIZE,
223190734Sthompsa		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
224190734Sthompsa		.callback = &uvisor_read_callback,
225184610Salfred	},
226184610Salfred};
227184610Salfred
228192984Sthompsastatic const struct ucom_callback uvisor_callback = {
229194228Sthompsa	.ucom_cfg_open = &uvisor_cfg_open,
230194228Sthompsa	.ucom_cfg_close = &uvisor_cfg_close,
231194228Sthompsa	.ucom_start_read = &uvisor_start_read,
232194228Sthompsa	.ucom_stop_read = &uvisor_stop_read,
233194228Sthompsa	.ucom_start_write = &uvisor_start_write,
234194228Sthompsa	.ucom_stop_write = &uvisor_stop_write,
235184610Salfred};
236184610Salfred
237184610Salfredstatic device_method_t uvisor_methods[] = {
238184610Salfred	DEVMETHOD(device_probe, uvisor_probe),
239184610Salfred	DEVMETHOD(device_attach, uvisor_attach),
240184610Salfred	DEVMETHOD(device_detach, uvisor_detach),
241184610Salfred	{0, 0}
242184610Salfred};
243184610Salfred
244184610Salfredstatic devclass_t uvisor_devclass;
245184610Salfred
246184610Salfredstatic driver_t uvisor_driver = {
247184610Salfred	.name = "uvisor",
248184610Salfred	.methods = uvisor_methods,
249184610Salfred	.size = sizeof(struct uvisor_softc),
250184610Salfred};
251184610Salfred
252189275SthompsaDRIVER_MODULE(uvisor, uhub, uvisor_driver, uvisor_devclass, NULL, 0);
253188942SthompsaMODULE_DEPEND(uvisor, ucom, 1, 1, 1);
254188942SthompsaMODULE_DEPEND(uvisor, usb, 1, 1, 1);
255212122SthompsaMODULE_VERSION(uvisor, 1);
256184610Salfred
257192984Sthompsastatic const struct usb_device_id uvisor_devs[] = {
258201028Sthompsa#define	UVISOR_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
259201028Sthompsa	UVISOR_DEV(ACEECA, MEZ1000, UVISOR_FLAG_PALM4),
260205032Sthompsa	UVISOR_DEV(ALPHASMART, DANA_SYNC, UVISOR_FLAG_PALM4),
261201028Sthompsa	UVISOR_DEV(GARMIN, IQUE_3600, UVISOR_FLAG_PALM4),
262201028Sthompsa	UVISOR_DEV(FOSSIL, WRISTPDA, UVISOR_FLAG_PALM4),
263201028Sthompsa	UVISOR_DEV(HANDSPRING, VISOR, UVISOR_FLAG_VISOR),
264201028Sthompsa	UVISOR_DEV(HANDSPRING, TREO, UVISOR_FLAG_PALM4),
265201028Sthompsa	UVISOR_DEV(HANDSPRING, TREO600, UVISOR_FLAG_PALM4),
266201028Sthompsa	UVISOR_DEV(PALM, M500, UVISOR_FLAG_PALM4),
267201028Sthompsa	UVISOR_DEV(PALM, M505, UVISOR_FLAG_PALM4),
268201028Sthompsa	UVISOR_DEV(PALM, M515, UVISOR_FLAG_PALM4),
269201028Sthompsa	UVISOR_DEV(PALM, I705, UVISOR_FLAG_PALM4),
270201028Sthompsa	UVISOR_DEV(PALM, M125, UVISOR_FLAG_PALM4),
271201028Sthompsa	UVISOR_DEV(PALM, M130, UVISOR_FLAG_PALM4),
272201028Sthompsa	UVISOR_DEV(PALM, TUNGSTEN_Z, UVISOR_FLAG_PALM4),
273201028Sthompsa	UVISOR_DEV(PALM, TUNGSTEN_T, UVISOR_FLAG_PALM4),
274201028Sthompsa	UVISOR_DEV(PALM, ZIRE, UVISOR_FLAG_PALM4),
275201028Sthompsa	UVISOR_DEV(PALM, ZIRE31, UVISOR_FLAG_PALM4),
276201028Sthompsa	UVISOR_DEV(SAMSUNG, I500, UVISOR_FLAG_PALM4),
277201028Sthompsa	UVISOR_DEV(SONY, CLIE_40, 0),
278201028Sthompsa	UVISOR_DEV(SONY, CLIE_41, 0),
279201028Sthompsa	UVISOR_DEV(SONY, CLIE_S360, UVISOR_FLAG_PALM4),
280201028Sthompsa	UVISOR_DEV(SONY, CLIE_NX60, UVISOR_FLAG_PALM4),
281201028Sthompsa	UVISOR_DEV(SONY, CLIE_35, UVISOR_FLAG_PALM35),
282201028Sthompsa/*  UVISOR_DEV(SONY, CLIE_25, UVISOR_FLAG_PALM4 ), */
283201028Sthompsa	UVISOR_DEV(SONY, CLIE_TJ37, UVISOR_FLAG_PALM4),
284201028Sthompsa/*  UVISOR_DEV(SONY, CLIE_TH55, UVISOR_FLAG_PALM4 ), See PR 80935 */
285201028Sthompsa	UVISOR_DEV(TAPWAVE, ZODIAC, UVISOR_FLAG_PALM4),
286201028Sthompsa#undef UVISOR_DEV
287184610Salfred};
288184610Salfred
289184610Salfredstatic int
290184610Salfreduvisor_probe(device_t dev)
291184610Salfred{
292192984Sthompsa	struct usb_attach_arg *uaa = device_get_ivars(dev);
293184610Salfred
294192499Sthompsa	if (uaa->usb_mode != USB_MODE_HOST) {
295184610Salfred		return (ENXIO);
296184610Salfred	}
297184610Salfred	if (uaa->info.bConfigIndex != UVISOR_CONFIG_INDEX) {
298184610Salfred		return (ENXIO);
299184610Salfred	}
300184610Salfred	if (uaa->info.bIfaceIndex != UVISOR_IFACE_INDEX) {
301184610Salfred		return (ENXIO);
302184610Salfred	}
303194228Sthompsa	return (usbd_lookup_id_by_uaa(uvisor_devs, sizeof(uvisor_devs), uaa));
304184610Salfred}
305184610Salfred
306184610Salfredstatic int
307184610Salfreduvisor_attach(device_t dev)
308184610Salfred{
309192984Sthompsa	struct usb_attach_arg *uaa = device_get_ivars(dev);
310184610Salfred	struct uvisor_softc *sc = device_get_softc(dev);
311192984Sthompsa	struct usb_config uvisor_config_copy[UVISOR_N_TRANSFER];
312184610Salfred	int error;
313184610Salfred
314184610Salfred	DPRINTF("sc=%p\n", sc);
315184610Salfred	bcopy(uvisor_config, uvisor_config_copy,
316184610Salfred	    sizeof(uvisor_config_copy));
317194228Sthompsa	device_set_usb_desc(dev);
318184610Salfred
319189265Sthompsa	mtx_init(&sc->sc_mtx, "uvisor", NULL, MTX_DEF);
320189265Sthompsa
321184610Salfred	sc->sc_udev = uaa->device;
322184610Salfred
323184610Salfred	/* configure the device */
324184610Salfred
325184610Salfred	sc->sc_flag = USB_GET_DRIVER_INFO(uaa);
326184610Salfred	sc->sc_iface_no = uaa->info.bIfaceNum;
327184610Salfred	sc->sc_iface_index = UVISOR_IFACE_INDEX;
328184610Salfred
329184610Salfred	error = uvisor_init(sc, uaa->device, uvisor_config_copy);
330184610Salfred
331184610Salfred	if (error) {
332184610Salfred		DPRINTF("init failed, error=%s\n",
333194228Sthompsa		    usbd_errstr(error));
334184610Salfred		goto detach;
335184610Salfred	}
336194228Sthompsa	error = usbd_transfer_setup(uaa->device, &sc->sc_iface_index,
337184610Salfred	    sc->sc_xfer, uvisor_config_copy, UVISOR_N_TRANSFER,
338189265Sthompsa	    sc, &sc->sc_mtx);
339184610Salfred	if (error) {
340184610Salfred		DPRINTF("could not allocate all pipes\n");
341184610Salfred		goto detach;
342184610Salfred	}
343184610Salfred
344194228Sthompsa	error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
345189265Sthompsa	    &uvisor_callback, &sc->sc_mtx);
346184610Salfred	if (error) {
347194228Sthompsa		DPRINTF("ucom_attach failed\n");
348184610Salfred		goto detach;
349184610Salfred	}
350184610Salfred	return (0);
351184610Salfred
352184610Salfreddetach:
353184610Salfred	uvisor_detach(dev);
354184610Salfred	return (ENXIO);
355184610Salfred}
356184610Salfred
357184610Salfredstatic int
358184610Salfreduvisor_detach(device_t dev)
359184610Salfred{
360184610Salfred	struct uvisor_softc *sc = device_get_softc(dev);
361184610Salfred
362184610Salfred	DPRINTF("sc=%p\n", sc);
363184610Salfred
364214761Sn_hibma	ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
365194228Sthompsa	usbd_transfer_unsetup(sc->sc_xfer, UVISOR_N_TRANSFER);
366189265Sthompsa	mtx_destroy(&sc->sc_mtx);
367184610Salfred
368184610Salfred	return (0);
369184610Salfred}
370184610Salfred
371193045Sthompsastatic usb_error_t
372192984Sthompsauvisor_init(struct uvisor_softc *sc, struct usb_device *udev, struct usb_config *config)
373184610Salfred{
374193045Sthompsa	usb_error_t err = 0;
375192984Sthompsa	struct usb_device_request req;
376184610Salfred	struct uvisor_connection_info coninfo;
377184610Salfred	struct uvisor_palm_connection_info pconinfo;
378184610Salfred	uint16_t actlen;
379184610Salfred	uint8_t buffer[256];
380184610Salfred
381184610Salfred	if (sc->sc_flag & UVISOR_FLAG_VISOR) {
382184610Salfred		DPRINTF("getting connection info\n");
383184610Salfred		req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
384184610Salfred		req.bRequest = UVISOR_GET_CONNECTION_INFORMATION;
385184610Salfred		USETW(req.wValue, 0);
386184610Salfred		USETW(req.wIndex, 0);
387184610Salfred		USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE);
388194228Sthompsa		err = usbd_do_request_flags(udev, NULL,
389190172Sthompsa		    &req, &coninfo, USB_SHORT_XFER_OK,
390184610Salfred		    &actlen, USB_DEFAULT_TIMEOUT);
391184610Salfred
392184610Salfred		if (err) {
393184610Salfred			goto done;
394184610Salfred		}
395184610Salfred	}
396207077Sthompsa#ifdef USB_DEBUG
397184610Salfred	if (sc->sc_flag & UVISOR_FLAG_VISOR) {
398184610Salfred		uint16_t i, np;
399184610Salfred		const char *desc;
400184610Salfred
401184610Salfred		np = UGETW(coninfo.num_ports);
402184610Salfred		if (np > UVISOR_MAX_CONN) {
403184610Salfred			np = UVISOR_MAX_CONN;
404184610Salfred		}
405184610Salfred		DPRINTF("Number of ports: %d\n", np);
406184610Salfred
407184610Salfred		for (i = 0; i < np; ++i) {
408184610Salfred			switch (coninfo.connections[i].port_function_id) {
409184610Salfred			case UVISOR_FUNCTION_GENERIC:
410184610Salfred				desc = "Generic";
411184610Salfred				break;
412184610Salfred			case UVISOR_FUNCTION_DEBUGGER:
413184610Salfred				desc = "Debugger";
414184610Salfred				break;
415184610Salfred			case UVISOR_FUNCTION_HOTSYNC:
416184610Salfred				desc = "HotSync";
417184610Salfred				break;
418184610Salfred			case UVISOR_FUNCTION_REMOTE_FILE_SYS:
419184610Salfred				desc = "Remote File System";
420184610Salfred				break;
421184610Salfred			default:
422184610Salfred				desc = "unknown";
423184610Salfred				break;
424184610Salfred			}
425184610Salfred			DPRINTF("Port %d is for %s\n",
426184610Salfred			    coninfo.connections[i].port, desc);
427184610Salfred		}
428184610Salfred	}
429184610Salfred#endif
430184610Salfred
431184610Salfred	if (sc->sc_flag & UVISOR_FLAG_PALM4) {
432184610Salfred		uint8_t port;
433184610Salfred
434184610Salfred		/* Palm OS 4.0 Hack */
435184610Salfred		req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
436184610Salfred		req.bRequest = UVISOR_GET_PALM_INFORMATION;
437184610Salfred		USETW(req.wValue, 0);
438184610Salfred		USETW(req.wIndex, 0);
439184610Salfred		USETW(req.wLength, UVISOR_GET_PALM_INFORMATION_LEN);
440184610Salfred
441194228Sthompsa		err = usbd_do_request_flags
442190172Sthompsa		    (udev, NULL, &req, &pconinfo, USB_SHORT_XFER_OK,
443184610Salfred		    &actlen, USB_DEFAULT_TIMEOUT);
444184610Salfred
445184610Salfred		if (err) {
446184610Salfred			goto done;
447184610Salfred		}
448184610Salfred		if (actlen < 12) {
449184610Salfred			DPRINTF("too little data\n");
450184610Salfred			err = USB_ERR_INVAL;
451184610Salfred			goto done;
452184610Salfred		}
453184610Salfred		if (pconinfo.endpoint_numbers_different) {
454184610Salfred			port = pconinfo.connections[0].end_point_info;
455184610Salfred			config[0].endpoint = (port & 0xF);	/* output */
456184610Salfred			config[1].endpoint = (port >> 4);	/* input */
457184610Salfred		} else {
458184610Salfred			port = pconinfo.connections[0].port;
459184610Salfred			config[0].endpoint = (port & 0xF);	/* output */
460184610Salfred			config[1].endpoint = (port & 0xF);	/* input */
461184610Salfred		}
462184610Salfred#if 0
463184610Salfred		req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
464184610Salfred		req.bRequest = UVISOR_GET_PALM_INFORMATION;
465184610Salfred		USETW(req.wValue, 0);
466184610Salfred		USETW(req.wIndex, 0);
467184610Salfred		USETW(req.wLength, UVISOR_GET_PALM_INFORMATION_LEN);
468194228Sthompsa		err = usbd_do_request(udev, &req, buffer);
469184610Salfred		if (err) {
470184610Salfred			goto done;
471184610Salfred		}
472184610Salfred#endif
473184610Salfred	}
474184610Salfred	if (sc->sc_flag & UVISOR_FLAG_PALM35) {
475184610Salfred		/* get the config number */
476184610Salfred		DPRINTF("getting config info\n");
477184610Salfred		req.bmRequestType = UT_READ;
478184610Salfred		req.bRequest = UR_GET_CONFIG;
479184610Salfred		USETW(req.wValue, 0);
480184610Salfred		USETW(req.wIndex, 0);
481184610Salfred		USETW(req.wLength, 1);
482184610Salfred
483194228Sthompsa		err = usbd_do_request(udev, NULL, &req, buffer);
484184610Salfred		if (err) {
485184610Salfred			goto done;
486184610Salfred		}
487184610Salfred		/* get the interface number */
488184610Salfred		DPRINTF("get the interface number\n");
489184610Salfred		req.bmRequestType = UT_READ_DEVICE;
490184610Salfred		req.bRequest = UR_GET_INTERFACE;
491184610Salfred		USETW(req.wValue, 0);
492184610Salfred		USETW(req.wIndex, 0);
493184610Salfred		USETW(req.wLength, 1);
494194228Sthompsa		err = usbd_do_request(udev, NULL, &req, buffer);
495184610Salfred		if (err) {
496184610Salfred			goto done;
497184610Salfred		}
498184610Salfred	}
499196494Salfred#if 0
500196494Salfred	uWord wAvail;
501196494Salfred
502184610Salfred	DPRINTF("getting available bytes\n");
503184610Salfred	req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
504184610Salfred	req.bRequest = UVISOR_REQUEST_BYTES_AVAILABLE;
505184610Salfred	USETW(req.wValue, 0);
506184610Salfred	USETW(req.wIndex, 5);
507184610Salfred	USETW(req.wLength, sizeof(wAvail));
508194228Sthompsa	err = usbd_do_request(udev, NULL, &req, &wAvail);
509184610Salfred	if (err) {
510184610Salfred		goto done;
511184610Salfred	}
512184610Salfred	DPRINTF("avail=%d\n", UGETW(wAvail));
513196494Salfred#endif
514184610Salfred
515184610Salfred	DPRINTF("done\n");
516184610Salfreddone:
517184610Salfred	return (err);
518184610Salfred}
519184610Salfred
520184610Salfredstatic void
521192984Sthompsauvisor_cfg_open(struct ucom_softc *ucom)
522184610Salfred{
523184610Salfred	return;
524184610Salfred}
525184610Salfred
526184610Salfredstatic void
527192984Sthompsauvisor_cfg_close(struct ucom_softc *ucom)
528184610Salfred{
529184610Salfred	struct uvisor_softc *sc = ucom->sc_parent;
530184610Salfred	uint8_t buffer[UVISOR_CONNECTION_INFO_SIZE];
531192984Sthompsa	struct usb_device_request req;
532193045Sthompsa	usb_error_t err;
533184610Salfred
534184610Salfred	req.bmRequestType = UT_READ_VENDOR_ENDPOINT;	/* XXX read? */
535184610Salfred	req.bRequest = UVISOR_CLOSE_NOTIFICATION;
536184610Salfred	USETW(req.wValue, 0);
537184610Salfred	USETW(req.wIndex, 0);
538184610Salfred	USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE);
539184610Salfred
540194228Sthompsa	err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
541188413Sthompsa	    &req, buffer, 0, 1000);
542184610Salfred	if (err) {
543184610Salfred		DPRINTFN(0, "close notification failed, error=%s\n",
544194228Sthompsa		    usbd_errstr(err));
545184610Salfred	}
546184610Salfred}
547184610Salfred
548184610Salfredstatic void
549192984Sthompsauvisor_start_read(struct ucom_softc *ucom)
550184610Salfred{
551184610Salfred	struct uvisor_softc *sc = ucom->sc_parent;
552184610Salfred
553194228Sthompsa	usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_RD]);
554184610Salfred}
555184610Salfred
556184610Salfredstatic void
557192984Sthompsauvisor_stop_read(struct ucom_softc *ucom)
558184610Salfred{
559184610Salfred	struct uvisor_softc *sc = ucom->sc_parent;
560184610Salfred
561194228Sthompsa	usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_RD]);
562184610Salfred}
563184610Salfred
564184610Salfredstatic void
565192984Sthompsauvisor_start_write(struct ucom_softc *ucom)
566184610Salfred{
567184610Salfred	struct uvisor_softc *sc = ucom->sc_parent;
568184610Salfred
569194228Sthompsa	usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_WR]);
570184610Salfred}
571184610Salfred
572184610Salfredstatic void
573192984Sthompsauvisor_stop_write(struct ucom_softc *ucom)
574184610Salfred{
575184610Salfred	struct uvisor_softc *sc = ucom->sc_parent;
576184610Salfred
577194228Sthompsa	usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_WR]);
578184610Salfred}
579184610Salfred
580184610Salfredstatic void
581194677Sthompsauvisor_write_callback(struct usb_xfer *xfer, usb_error_t error)
582184610Salfred{
583194677Sthompsa	struct uvisor_softc *sc = usbd_xfer_softc(xfer);
584194677Sthompsa	struct usb_page_cache *pc;
585184610Salfred	uint32_t actlen;
586196494Salfred	uint8_t x;
587184610Salfred
588184610Salfred	switch (USB_GET_STATE(xfer)) {
589184610Salfred	case USB_ST_SETUP:
590184610Salfred	case USB_ST_TRANSFERRED:
591188413Sthompsatr_setup:
592196494Salfred		for (x = 0; x != UVISOROFRAMES; x++) {
593184610Salfred
594196494Salfred			usbd_xfer_set_frame_offset(xfer,
595196494Salfred			    x * UVISOROBUFSIZE, x);
596196494Salfred
597196494Salfred			pc = usbd_xfer_get_frame(xfer, x);
598196494Salfred			if (ucom_get_data(&sc->sc_ucom, pc, 0,
599196494Salfred			    UVISOROBUFSIZE, &actlen)) {
600196494Salfred				usbd_xfer_set_frame_len(xfer, x, actlen);
601196494Salfred			} else {
602196494Salfred				break;
603196494Salfred			}
604196494Salfred		}
605196494Salfred		/* check for data */
606196494Salfred		if (x != 0) {
607196494Salfred			usbd_xfer_set_frames(xfer, x);
608194228Sthompsa			usbd_transfer_submit(xfer);
609184610Salfred		}
610196494Salfred		break;
611184610Salfred
612184610Salfred	default:			/* Error */
613194677Sthompsa		if (error != USB_ERR_CANCELLED) {
614188413Sthompsa			/* try to clear stall first */
615194677Sthompsa			usbd_xfer_set_stall(xfer);
616188413Sthompsa			goto tr_setup;
617184610Salfred		}
618196494Salfred		break;
619184610Salfred	}
620184610Salfred}
621184610Salfred
622184610Salfredstatic void
623194677Sthompsauvisor_read_callback(struct usb_xfer *xfer, usb_error_t error)
624184610Salfred{
625194677Sthompsa	struct uvisor_softc *sc = usbd_xfer_softc(xfer);
626194677Sthompsa	struct usb_page_cache *pc;
627194677Sthompsa	int actlen;
628184610Salfred
629194677Sthompsa	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
630194677Sthompsa
631184610Salfred	switch (USB_GET_STATE(xfer)) {
632184610Salfred	case USB_ST_TRANSFERRED:
633194677Sthompsa		pc = usbd_xfer_get_frame(xfer, 0);
634194677Sthompsa		ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
635184610Salfred
636184610Salfred	case USB_ST_SETUP:
637188413Sthompsatr_setup:
638194677Sthompsa		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
639194228Sthompsa		usbd_transfer_submit(xfer);
640184610Salfred		return;
641184610Salfred
642184610Salfred	default:			/* Error */
643194677Sthompsa		if (error != USB_ERR_CANCELLED) {
644188413Sthompsa			/* try to clear stall first */
645194677Sthompsa			usbd_xfer_set_stall(xfer);
646188413Sthompsa			goto tr_setup;
647184610Salfred		}
648184610Salfred		return;
649184610Salfred	}
650184610Salfred}
651