1 /* $NetBSD: uvisor.c,v 1.9 2001/01/23 14:04:14 augustss Exp $ */
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 $
17 * Copyright (c) 2000 The NetBSD Foundation, Inc.
18 * All rights reserved.
20 * This code is derived from software contributed to The NetBSD Foundation
21 * by Lennart Augustsson (lennart@augustsson.net) at
22 * Carlstedt Research & Technology.
24 * Redistribution and use in source and binary forms, with or without
25 * modification, are permitted provided that the following conditions
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.
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.
47 * Handspring Visor (Palmpilot compatible PDA) driver
50 #include <sys/stdint.h>
51 #include <sys/param.h>
52 #include <sys/queue.h>
53 #include <sys/types.h>
54 #include <sys/systm.h>
55 #include <sys/kernel.h>
57 #include <sys/module.h>
59 #include <sys/condvar.h>
60 #include <sys/sysctl.h>
61 #include <sys/unistd.h>
62 #include <sys/callout.h>
63 #include <sys/malloc.h>
66 #include <bus/u4b/usb.h>
67 #include <bus/u4b/usbdi.h>
68 #include <bus/u4b/usbdi_util.h>
69 #include <bus/u4b/usbdevs.h>
71 #define USB_DEBUG_VAR uvisor_debug
72 #include <bus/u4b/usb_debug.h>
73 #include <bus/u4b/usb_process.h>
75 #include <bus/u4b/serial/usb_serial.h>
78 static int uvisor_debug = 0;
80 static SYSCTL_NODE(_hw_usb, OID_AUTO, uvisor, CTLFLAG_RW, 0, "USB uvisor");
81 SYSCTL_INT(_hw_usb_uvisor, OID_AUTO, debug, CTLFLAG_RW,
82 &uvisor_debug, 0, "Debug level");
85 #define UVISOR_CONFIG_INDEX 0
86 #define UVISOR_IFACE_INDEX 0
89 * The following buffer sizes are hardcoded due to the way the Palm
90 * firmware works. It looks like the device is not short terminating
91 * the data transferred.
93 #define UVISORIBUFSIZE 0 /* Use wMaxPacketSize */
94 #define UVISOROBUFSIZE 32 /* bytes */
95 #define UVISOROFRAMES 32 /* units */
97 /* From the Linux driver */
99 * UVISOR_REQUEST_BYTES_AVAILABLE asks the visor for the number of bytes that
100 * are available to be transfered to the host for the specified endpoint.
101 * Currently this is not used, and always returns 0x0001
103 #define UVISOR_REQUEST_BYTES_AVAILABLE 0x01
106 * UVISOR_CLOSE_NOTIFICATION is set to the device to notify it that the host
107 * is now closing the pipe. An empty packet is sent in response.
109 #define UVISOR_CLOSE_NOTIFICATION 0x02
112 * UVISOR_GET_CONNECTION_INFORMATION is sent by the host during enumeration to
113 * get the endpoints used by the connection.
115 #define UVISOR_GET_CONNECTION_INFORMATION 0x03
118 * UVISOR_GET_CONNECTION_INFORMATION returns data in the following format
120 #define UVISOR_MAX_CONN 8
121 struct uvisor_connection_info {
124 uByte port_function_id;
126 } __packed connections[UVISOR_MAX_CONN];
129 #define UVISOR_CONNECTION_INFO_SIZE 18
131 /* struct uvisor_connection_info.connection[x].port defines: */
132 #define UVISOR_ENDPOINT_1 0x01
133 #define UVISOR_ENDPOINT_2 0x02
135 /* struct uvisor_connection_info.connection[x].port_function_id defines: */
136 #define UVISOR_FUNCTION_GENERIC 0x00
137 #define UVISOR_FUNCTION_DEBUGGER 0x01
138 #define UVISOR_FUNCTION_HOTSYNC 0x02
139 #define UVISOR_FUNCTION_CONSOLE 0x03
140 #define UVISOR_FUNCTION_REMOTE_FILE_SYS 0x04
143 * Unknown PalmOS stuff.
145 #define UVISOR_GET_PALM_INFORMATION 0x04
146 #define UVISOR_GET_PALM_INFORMATION_LEN 0x44
148 struct uvisor_palm_connection_info {
150 uByte endpoint_numbers_different;
153 uDWord port_function_id;
155 uByte end_point_info;
157 } __packed connections[UVISOR_MAX_CONN];
166 struct uvisor_softc {
167 struct ucom_super_softc sc_super_ucom;
168 struct ucom_softc sc_ucom;
170 struct usb_xfer *sc_xfer[UVISOR_N_TRANSFER];
171 struct usb_device *sc_udev;
175 #define UVISOR_FLAG_PALM4 0x0001
176 #define UVISOR_FLAG_VISOR 0x0002
177 #define UVISOR_FLAG_PALM35 0x0004
178 #define UVISOR_FLAG_SEND_NOTIFY 0x0008
181 uint8_t sc_iface_index;
186 static device_probe_t uvisor_probe;
187 static device_attach_t uvisor_attach;
188 static device_detach_t uvisor_detach;
190 static usb_callback_t uvisor_write_callback;
191 static usb_callback_t uvisor_read_callback;
193 static usb_error_t uvisor_init(struct uvisor_softc *, struct usb_device *,
194 struct usb_config *);
195 static void uvisor_cfg_open(struct ucom_softc *);
196 static void uvisor_cfg_close(struct ucom_softc *);
197 static void uvisor_start_read(struct ucom_softc *);
198 static void uvisor_stop_read(struct ucom_softc *);
199 static void uvisor_start_write(struct ucom_softc *);
200 static void uvisor_stop_write(struct ucom_softc *);
202 static const struct usb_config uvisor_config[UVISOR_N_TRANSFER] = {
204 [UVISOR_BULK_DT_WR] = {
206 .endpoint = UE_ADDR_ANY,
207 .direction = UE_DIR_OUT,
208 .bufsize = UVISOROBUFSIZE * UVISOROFRAMES,
209 .frames = UVISOROFRAMES,
210 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
211 .callback = &uvisor_write_callback,
214 [UVISOR_BULK_DT_RD] = {
216 .endpoint = UE_ADDR_ANY,
217 .direction = UE_DIR_IN,
218 .bufsize = UVISORIBUFSIZE,
219 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
220 .callback = &uvisor_read_callback,
224 static const struct ucom_callback uvisor_callback = {
225 .ucom_cfg_open = &uvisor_cfg_open,
226 .ucom_cfg_close = &uvisor_cfg_close,
227 .ucom_start_read = &uvisor_start_read,
228 .ucom_stop_read = &uvisor_stop_read,
229 .ucom_start_write = &uvisor_start_write,
230 .ucom_stop_write = &uvisor_stop_write,
233 static device_method_t uvisor_methods[] = {
234 DEVMETHOD(device_probe, uvisor_probe),
235 DEVMETHOD(device_attach, uvisor_attach),
236 DEVMETHOD(device_detach, uvisor_detach),
240 static devclass_t uvisor_devclass;
242 static driver_t uvisor_driver = {
244 .methods = uvisor_methods,
245 .size = sizeof(struct uvisor_softc),
248 DRIVER_MODULE(uvisor, uhub, uvisor_driver, uvisor_devclass, NULL, 0);
249 MODULE_DEPEND(uvisor, ucom, 1, 1, 1);
250 MODULE_DEPEND(uvisor, usb, 1, 1, 1);
251 MODULE_VERSION(uvisor, 1);
253 static const STRUCT_USB_HOST_ID uvisor_devs[] = {
254 #define UVISOR_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
255 UVISOR_DEV(ACEECA, MEZ1000, UVISOR_FLAG_PALM4),
256 UVISOR_DEV(ALPHASMART, DANA_SYNC, UVISOR_FLAG_PALM4),
257 UVISOR_DEV(GARMIN, IQUE_3600, UVISOR_FLAG_PALM4),
258 UVISOR_DEV(FOSSIL, WRISTPDA, UVISOR_FLAG_PALM4),
259 UVISOR_DEV(HANDSPRING, VISOR, UVISOR_FLAG_VISOR),
260 UVISOR_DEV(HANDSPRING, TREO, UVISOR_FLAG_PALM4),
261 UVISOR_DEV(HANDSPRING, TREO600, UVISOR_FLAG_PALM4),
262 UVISOR_DEV(PALM, M500, UVISOR_FLAG_PALM4),
263 UVISOR_DEV(PALM, M505, UVISOR_FLAG_PALM4),
264 UVISOR_DEV(PALM, M515, UVISOR_FLAG_PALM4),
265 UVISOR_DEV(PALM, I705, UVISOR_FLAG_PALM4),
266 UVISOR_DEV(PALM, M125, UVISOR_FLAG_PALM4),
267 UVISOR_DEV(PALM, M130, UVISOR_FLAG_PALM4),
268 UVISOR_DEV(PALM, TUNGSTEN_Z, UVISOR_FLAG_PALM4),
269 UVISOR_DEV(PALM, TUNGSTEN_T, UVISOR_FLAG_PALM4),
270 UVISOR_DEV(PALM, ZIRE, UVISOR_FLAG_PALM4),
271 UVISOR_DEV(PALM, ZIRE31, UVISOR_FLAG_PALM4),
272 UVISOR_DEV(SAMSUNG, I500, UVISOR_FLAG_PALM4),
273 UVISOR_DEV(SONY, CLIE_40, 0),
274 UVISOR_DEV(SONY, CLIE_41, 0),
275 UVISOR_DEV(SONY, CLIE_S360, UVISOR_FLAG_PALM4),
276 UVISOR_DEV(SONY, CLIE_NX60, UVISOR_FLAG_PALM4),
277 UVISOR_DEV(SONY, CLIE_35, UVISOR_FLAG_PALM35),
278 /* UVISOR_DEV(SONY, CLIE_25, UVISOR_FLAG_PALM4 ), */
279 UVISOR_DEV(SONY, CLIE_TJ37, UVISOR_FLAG_PALM4),
280 /* UVISOR_DEV(SONY, CLIE_TH55, UVISOR_FLAG_PALM4 ), See PR 80935 */
281 UVISOR_DEV(TAPWAVE, ZODIAC, UVISOR_FLAG_PALM4),
286 uvisor_probe(device_t dev)
288 struct usb_attach_arg *uaa = device_get_ivars(dev);
290 if (uaa->usb_mode != USB_MODE_HOST) {
293 if (uaa->info.bConfigIndex != UVISOR_CONFIG_INDEX) {
296 if (uaa->info.bIfaceIndex != UVISOR_IFACE_INDEX) {
299 return (usbd_lookup_id_by_uaa(uvisor_devs, sizeof(uvisor_devs), uaa));
303 uvisor_attach(device_t dev)
305 struct usb_attach_arg *uaa = device_get_ivars(dev);
306 struct uvisor_softc *sc = device_get_softc(dev);
307 struct usb_config uvisor_config_copy[UVISOR_N_TRANSFER];
310 DPRINTF("sc=%p\n", sc);
311 memcpy(uvisor_config_copy, uvisor_config,
312 sizeof(uvisor_config_copy));
314 device_set_usb_desc(dev);
316 lockinit(&sc->sc_lock, "uvisor", 0, LK_CANRECURSE);
318 sc->sc_udev = uaa->device;
320 /* configure the device */
322 sc->sc_flag = USB_GET_DRIVER_INFO(uaa);
323 sc->sc_iface_no = uaa->info.bIfaceNum;
324 sc->sc_iface_index = UVISOR_IFACE_INDEX;
326 error = uvisor_init(sc, uaa->device, uvisor_config_copy);
329 DPRINTF("init failed, error=%s\n",
333 error = usbd_transfer_setup(uaa->device, &sc->sc_iface_index,
334 sc->sc_xfer, uvisor_config_copy, UVISOR_N_TRANSFER,
337 DPRINTF("could not allocate all pipes\n");
341 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
342 &uvisor_callback, &sc->sc_lock);
344 DPRINTF("ucom_attach failed\n");
347 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
357 uvisor_detach(device_t dev)
359 struct uvisor_softc *sc = device_get_softc(dev);
361 DPRINTF("sc=%p\n", sc);
363 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
364 usbd_transfer_unsetup(sc->sc_xfer, UVISOR_N_TRANSFER);
365 lockuninit(&sc->sc_lock);
371 uvisor_init(struct uvisor_softc *sc, struct usb_device *udev, struct usb_config *config)
374 struct usb_device_request req;
375 struct uvisor_connection_info coninfo;
376 struct uvisor_palm_connection_info pconinfo;
380 if (sc->sc_flag & UVISOR_FLAG_VISOR) {
381 DPRINTF("getting connection info\n");
382 req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
383 req.bRequest = UVISOR_GET_CONNECTION_INFORMATION;
384 USETW(req.wValue, 0);
385 USETW(req.wIndex, 0);
386 USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE);
387 err = usbd_do_request_flags(udev, NULL,
388 &req, &coninfo, USB_SHORT_XFER_OK,
389 &actlen, USB_DEFAULT_TIMEOUT);
396 if (sc->sc_flag & UVISOR_FLAG_VISOR) {
400 np = UGETW(coninfo.num_ports);
401 if (np > UVISOR_MAX_CONN) {
402 np = UVISOR_MAX_CONN;
404 DPRINTF("Number of ports: %d\n", np);
406 for (i = 0; i < np; ++i) {
407 switch (coninfo.connections[i].port_function_id) {
408 case UVISOR_FUNCTION_GENERIC:
411 case UVISOR_FUNCTION_DEBUGGER:
414 case UVISOR_FUNCTION_HOTSYNC:
417 case UVISOR_FUNCTION_REMOTE_FILE_SYS:
418 desc = "Remote File System";
424 DPRINTF("Port %d is for %s\n",
425 coninfo.connections[i].port, desc);
430 if (sc->sc_flag & UVISOR_FLAG_PALM4) {
433 /* Palm OS 4.0 Hack */
434 req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
435 req.bRequest = UVISOR_GET_PALM_INFORMATION;
436 USETW(req.wValue, 0);
437 USETW(req.wIndex, 0);
438 USETW(req.wLength, UVISOR_GET_PALM_INFORMATION_LEN);
440 err = usbd_do_request_flags
441 (udev, NULL, &req, &pconinfo, USB_SHORT_XFER_OK,
442 &actlen, USB_DEFAULT_TIMEOUT);
448 DPRINTF("too little data\n");
452 if (pconinfo.endpoint_numbers_different) {
453 port = pconinfo.connections[0].end_point_info;
454 config[0].endpoint = (port & 0xF); /* output */
455 config[1].endpoint = (port >> 4); /* input */
457 port = pconinfo.connections[0].port;
458 config[0].endpoint = (port & 0xF); /* output */
459 config[1].endpoint = (port & 0xF); /* input */
462 req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
463 req.bRequest = UVISOR_GET_PALM_INFORMATION;
464 USETW(req.wValue, 0);
465 USETW(req.wIndex, 0);
466 USETW(req.wLength, UVISOR_GET_PALM_INFORMATION_LEN);
467 err = usbd_do_request(udev, &req, buffer);
473 if (sc->sc_flag & UVISOR_FLAG_PALM35) {
474 /* get the config number */
475 DPRINTF("getting config info\n");
476 req.bmRequestType = UT_READ;
477 req.bRequest = UR_GET_CONFIG;
478 USETW(req.wValue, 0);
479 USETW(req.wIndex, 0);
480 USETW(req.wLength, 1);
482 err = usbd_do_request(udev, NULL, &req, buffer);
486 /* get the interface number */
487 DPRINTF("get the interface number\n");
488 req.bmRequestType = UT_READ_DEVICE;
489 req.bRequest = UR_GET_INTERFACE;
490 USETW(req.wValue, 0);
491 USETW(req.wIndex, 0);
492 USETW(req.wLength, 1);
493 err = usbd_do_request(udev, NULL, &req, buffer);
501 DPRINTF("getting available bytes\n");
502 req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
503 req.bRequest = UVISOR_REQUEST_BYTES_AVAILABLE;
504 USETW(req.wValue, 0);
505 USETW(req.wIndex, 5);
506 USETW(req.wLength, sizeof(wAvail));
507 err = usbd_do_request(udev, NULL, &req, &wAvail);
511 DPRINTF("avail=%d\n", UGETW(wAvail));
520 uvisor_cfg_open(struct ucom_softc *ucom)
526 uvisor_cfg_close(struct ucom_softc *ucom)
528 struct uvisor_softc *sc = ucom->sc_parent;
529 uint8_t buffer[UVISOR_CONNECTION_INFO_SIZE];
530 struct usb_device_request req;
533 req.bmRequestType = UT_READ_VENDOR_ENDPOINT; /* XXX read? */
534 req.bRequest = UVISOR_CLOSE_NOTIFICATION;
535 USETW(req.wValue, 0);
536 USETW(req.wIndex, 0);
537 USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE);
539 err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
540 &req, buffer, 0, 1000);
542 DPRINTFN(0, "close notification failed, error=%s\n",
548 uvisor_start_read(struct ucom_softc *ucom)
550 struct uvisor_softc *sc = ucom->sc_parent;
552 usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_RD]);
556 uvisor_stop_read(struct ucom_softc *ucom)
558 struct uvisor_softc *sc = ucom->sc_parent;
560 usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_RD]);
564 uvisor_start_write(struct ucom_softc *ucom)
566 struct uvisor_softc *sc = ucom->sc_parent;
568 usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_WR]);
572 uvisor_stop_write(struct ucom_softc *ucom)
574 struct uvisor_softc *sc = ucom->sc_parent;
576 usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_WR]);
580 uvisor_write_callback(struct usb_xfer *xfer, usb_error_t error)
582 struct uvisor_softc *sc = usbd_xfer_softc(xfer);
583 struct usb_page_cache *pc;
587 switch (USB_GET_STATE(xfer)) {
589 case USB_ST_TRANSFERRED:
591 for (x = 0; x != UVISOROFRAMES; x++) {
593 usbd_xfer_set_frame_offset(xfer,
594 x * UVISOROBUFSIZE, x);
596 pc = usbd_xfer_get_frame(xfer, x);
597 if (ucom_get_data(&sc->sc_ucom, pc, 0,
598 UVISOROBUFSIZE, &actlen)) {
599 usbd_xfer_set_frame_len(xfer, x, actlen);
606 usbd_xfer_set_frames(xfer, x);
607 usbd_transfer_submit(xfer);
612 if (error != USB_ERR_CANCELLED) {
613 /* try to clear stall first */
614 usbd_xfer_set_stall(xfer);
622 uvisor_read_callback(struct usb_xfer *xfer, usb_error_t error)
624 struct uvisor_softc *sc = usbd_xfer_softc(xfer);
625 struct usb_page_cache *pc;
628 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
630 switch (USB_GET_STATE(xfer)) {
631 case USB_ST_TRANSFERRED:
632 pc = usbd_xfer_get_frame(xfer, 0);
633 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
637 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
638 usbd_transfer_submit(xfer);
642 if (error != USB_ERR_CANCELLED) {
643 /* try to clear stall first */
644 usbd_xfer_set_stall(xfer);