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/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>
58 #include <sys/module.h>
60 #include <sys/mutex.h>
61 #include <sys/condvar.h>
62 #include <sys/sysctl.h>
64 #include <sys/unistd.h>
65 #include <sys/callout.h>
66 #include <sys/malloc.h>
69 #include <dev/usb/usb.h>
70 #include <dev/usb/usbdi.h>
71 #include <dev/usb/usbdi_util.h>
74 #define USB_DEBUG_VAR uvisor_debug
75 #include <dev/usb/usb_debug.h>
76 #include <dev/usb/usb_process.h>
78 #include <dev/usb/serial/usb_serial.h>
81 static int uvisor_debug = 0;
83 static SYSCTL_NODE(_hw_usb, OID_AUTO, uvisor, CTLFLAG_RW, 0, "USB uvisor");
84 SYSCTL_INT(_hw_usb_uvisor, OID_AUTO, debug, CTLFLAG_RW,
85 &uvisor_debug, 0, "Debug level");
88 #define UVISOR_CONFIG_INDEX 0
89 #define UVISOR_IFACE_INDEX 0
92 * The following buffer sizes are hardcoded due to the way the Palm
93 * firmware works. It looks like the device is not short terminating
94 * the data transferred.
96 #define UVISORIBUFSIZE 0 /* Use wMaxPacketSize */
97 #define UVISOROBUFSIZE 32 /* bytes */
98 #define UVISOROFRAMES 32 /* units */
100 /* From the Linux driver */
102 * UVISOR_REQUEST_BYTES_AVAILABLE asks the visor for the number of bytes that
103 * are available to be transfered to the host for the specified endpoint.
104 * Currently this is not used, and always returns 0x0001
106 #define UVISOR_REQUEST_BYTES_AVAILABLE 0x01
109 * UVISOR_CLOSE_NOTIFICATION is set to the device to notify it that the host
110 * is now closing the pipe. An empty packet is sent in response.
112 #define UVISOR_CLOSE_NOTIFICATION 0x02
115 * UVISOR_GET_CONNECTION_INFORMATION is sent by the host during enumeration to
116 * get the endpoints used by the connection.
118 #define UVISOR_GET_CONNECTION_INFORMATION 0x03
121 * UVISOR_GET_CONNECTION_INFORMATION returns data in the following format
123 #define UVISOR_MAX_CONN 8
124 struct uvisor_connection_info {
127 uByte port_function_id;
129 } __packed connections[UVISOR_MAX_CONN];
132 #define UVISOR_CONNECTION_INFO_SIZE 18
134 /* struct uvisor_connection_info.connection[x].port defines: */
135 #define UVISOR_ENDPOINT_1 0x01
136 #define UVISOR_ENDPOINT_2 0x02
138 /* struct uvisor_connection_info.connection[x].port_function_id defines: */
139 #define UVISOR_FUNCTION_GENERIC 0x00
140 #define UVISOR_FUNCTION_DEBUGGER 0x01
141 #define UVISOR_FUNCTION_HOTSYNC 0x02
142 #define UVISOR_FUNCTION_CONSOLE 0x03
143 #define UVISOR_FUNCTION_REMOTE_FILE_SYS 0x04
146 * Unknown PalmOS stuff.
148 #define UVISOR_GET_PALM_INFORMATION 0x04
149 #define UVISOR_GET_PALM_INFORMATION_LEN 0x44
151 struct uvisor_palm_connection_info {
153 uByte endpoint_numbers_different;
156 uDWord port_function_id;
158 uByte end_point_info;
160 } __packed connections[UVISOR_MAX_CONN];
169 struct uvisor_softc {
170 struct ucom_super_softc sc_super_ucom;
171 struct ucom_softc sc_ucom;
173 struct usb_xfer *sc_xfer[UVISOR_N_TRANSFER];
174 struct usb_device *sc_udev;
178 #define UVISOR_FLAG_PALM4 0x0001
179 #define UVISOR_FLAG_VISOR 0x0002
180 #define UVISOR_FLAG_PALM35 0x0004
181 #define UVISOR_FLAG_SEND_NOTIFY 0x0008
184 uint8_t sc_iface_index;
189 static device_probe_t uvisor_probe;
190 static device_attach_t uvisor_attach;
191 static device_detach_t uvisor_detach;
192 static void uvisor_free_softc(struct uvisor_softc *);
194 static usb_callback_t uvisor_write_callback;
195 static usb_callback_t uvisor_read_callback;
197 static usb_error_t uvisor_init(struct uvisor_softc *, struct usb_device *,
198 struct usb_config *);
199 static void uvisor_free(struct ucom_softc *);
200 static void uvisor_cfg_open(struct ucom_softc *);
201 static void uvisor_cfg_close(struct ucom_softc *);
202 static void uvisor_start_read(struct ucom_softc *);
203 static void uvisor_stop_read(struct ucom_softc *);
204 static void uvisor_start_write(struct ucom_softc *);
205 static void uvisor_stop_write(struct ucom_softc *);
207 static const struct usb_config uvisor_config[UVISOR_N_TRANSFER] = {
209 [UVISOR_BULK_DT_WR] = {
211 .endpoint = UE_ADDR_ANY,
212 .direction = UE_DIR_OUT,
213 .bufsize = UVISOROBUFSIZE * UVISOROFRAMES,
214 .frames = UVISOROFRAMES,
215 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
216 .callback = &uvisor_write_callback,
219 [UVISOR_BULK_DT_RD] = {
221 .endpoint = UE_ADDR_ANY,
222 .direction = UE_DIR_IN,
223 .bufsize = UVISORIBUFSIZE,
224 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
225 .callback = &uvisor_read_callback,
229 static const struct ucom_callback uvisor_callback = {
230 .ucom_cfg_open = &uvisor_cfg_open,
231 .ucom_cfg_close = &uvisor_cfg_close,
232 .ucom_start_read = &uvisor_start_read,
233 .ucom_stop_read = &uvisor_stop_read,
234 .ucom_start_write = &uvisor_start_write,
235 .ucom_stop_write = &uvisor_stop_write,
236 .ucom_free = &uvisor_free,
239 static device_method_t uvisor_methods[] = {
240 DEVMETHOD(device_probe, uvisor_probe),
241 DEVMETHOD(device_attach, uvisor_attach),
242 DEVMETHOD(device_detach, uvisor_detach),
246 static devclass_t uvisor_devclass;
248 static driver_t uvisor_driver = {
250 .methods = uvisor_methods,
251 .size = sizeof(struct uvisor_softc),
254 DRIVER_MODULE(uvisor, uhub, uvisor_driver, uvisor_devclass, NULL, 0);
255 MODULE_DEPEND(uvisor, ucom, 1, 1, 1);
256 MODULE_DEPEND(uvisor, usb, 1, 1, 1);
257 MODULE_VERSION(uvisor, 1);
259 static const STRUCT_USB_HOST_ID uvisor_devs[] = {
260 #define UVISOR_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
261 UVISOR_DEV(ACEECA, MEZ1000, UVISOR_FLAG_PALM4),
262 UVISOR_DEV(ALPHASMART, DANA_SYNC, UVISOR_FLAG_PALM4),
263 UVISOR_DEV(GARMIN, IQUE_3600, UVISOR_FLAG_PALM4),
264 UVISOR_DEV(FOSSIL, WRISTPDA, UVISOR_FLAG_PALM4),
265 UVISOR_DEV(HANDSPRING, VISOR, UVISOR_FLAG_VISOR),
266 UVISOR_DEV(HANDSPRING, TREO, UVISOR_FLAG_PALM4),
267 UVISOR_DEV(HANDSPRING, TREO600, UVISOR_FLAG_PALM4),
268 UVISOR_DEV(PALM, M500, UVISOR_FLAG_PALM4),
269 UVISOR_DEV(PALM, M505, UVISOR_FLAG_PALM4),
270 UVISOR_DEV(PALM, M515, UVISOR_FLAG_PALM4),
271 UVISOR_DEV(PALM, I705, UVISOR_FLAG_PALM4),
272 UVISOR_DEV(PALM, M125, UVISOR_FLAG_PALM4),
273 UVISOR_DEV(PALM, M130, UVISOR_FLAG_PALM4),
274 UVISOR_DEV(PALM, TUNGSTEN_Z, UVISOR_FLAG_PALM4),
275 UVISOR_DEV(PALM, TUNGSTEN_T, UVISOR_FLAG_PALM4),
276 UVISOR_DEV(PALM, ZIRE, UVISOR_FLAG_PALM4),
277 UVISOR_DEV(PALM, ZIRE31, UVISOR_FLAG_PALM4),
278 UVISOR_DEV(SAMSUNG, I500, UVISOR_FLAG_PALM4),
279 UVISOR_DEV(SONY, CLIE_40, 0),
280 UVISOR_DEV(SONY, CLIE_41, 0),
281 UVISOR_DEV(SONY, CLIE_S360, UVISOR_FLAG_PALM4),
282 UVISOR_DEV(SONY, CLIE_NX60, UVISOR_FLAG_PALM4),
283 UVISOR_DEV(SONY, CLIE_35, UVISOR_FLAG_PALM35),
284 /* UVISOR_DEV(SONY, CLIE_25, UVISOR_FLAG_PALM4 ), */
285 UVISOR_DEV(SONY, CLIE_TJ37, UVISOR_FLAG_PALM4),
286 /* UVISOR_DEV(SONY, CLIE_TH55, UVISOR_FLAG_PALM4 ), See PR 80935 */
287 UVISOR_DEV(TAPWAVE, ZODIAC, UVISOR_FLAG_PALM4),
292 uvisor_probe(device_t dev)
294 struct usb_attach_arg *uaa = device_get_ivars(dev);
296 if (uaa->usb_mode != USB_MODE_HOST) {
299 if (uaa->info.bConfigIndex != UVISOR_CONFIG_INDEX) {
302 if (uaa->info.bIfaceIndex != UVISOR_IFACE_INDEX) {
305 return (usbd_lookup_id_by_uaa(uvisor_devs, sizeof(uvisor_devs), uaa));
309 uvisor_attach(device_t dev)
311 struct usb_attach_arg *uaa = device_get_ivars(dev);
312 struct uvisor_softc *sc = device_get_softc(dev);
313 struct usb_config uvisor_config_copy[UVISOR_N_TRANSFER];
316 DPRINTF("sc=%p\n", sc);
317 memcpy(uvisor_config_copy, uvisor_config,
318 sizeof(uvisor_config_copy));
320 device_set_usb_desc(dev);
322 mtx_init(&sc->sc_mtx, "uvisor", NULL, MTX_DEF);
323 ucom_ref(&sc->sc_super_ucom);
325 sc->sc_udev = uaa->device;
327 /* configure the device */
329 sc->sc_flag = USB_GET_DRIVER_INFO(uaa);
330 sc->sc_iface_no = uaa->info.bIfaceNum;
331 sc->sc_iface_index = UVISOR_IFACE_INDEX;
333 error = uvisor_init(sc, uaa->device, uvisor_config_copy);
336 DPRINTF("init failed, error=%s\n",
340 error = usbd_transfer_setup(uaa->device, &sc->sc_iface_index,
341 sc->sc_xfer, uvisor_config_copy, UVISOR_N_TRANSFER,
344 DPRINTF("could not allocate all pipes\n");
348 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
349 &uvisor_callback, &sc->sc_mtx);
351 DPRINTF("ucom_attach failed\n");
354 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
364 uvisor_detach(device_t dev)
366 struct uvisor_softc *sc = device_get_softc(dev);
368 DPRINTF("sc=%p\n", sc);
370 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
371 usbd_transfer_unsetup(sc->sc_xfer, UVISOR_N_TRANSFER);
373 device_claim_softc(dev);
375 uvisor_free_softc(sc);
380 UCOM_UNLOAD_DRAIN(uvisor);
383 uvisor_free_softc(struct uvisor_softc *sc)
385 if (ucom_unref(&sc->sc_super_ucom)) {
386 mtx_destroy(&sc->sc_mtx);
387 device_free_softc(sc);
392 uvisor_free(struct ucom_softc *ucom)
394 uvisor_free_softc(ucom->sc_parent);
398 uvisor_init(struct uvisor_softc *sc, struct usb_device *udev, struct usb_config *config)
401 struct usb_device_request req;
402 struct uvisor_connection_info coninfo;
403 struct uvisor_palm_connection_info pconinfo;
407 if (sc->sc_flag & UVISOR_FLAG_VISOR) {
408 DPRINTF("getting connection info\n");
409 req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
410 req.bRequest = UVISOR_GET_CONNECTION_INFORMATION;
411 USETW(req.wValue, 0);
412 USETW(req.wIndex, 0);
413 USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE);
414 err = usbd_do_request_flags(udev, NULL,
415 &req, &coninfo, USB_SHORT_XFER_OK,
416 &actlen, USB_DEFAULT_TIMEOUT);
423 if (sc->sc_flag & UVISOR_FLAG_VISOR) {
427 np = UGETW(coninfo.num_ports);
428 if (np > UVISOR_MAX_CONN) {
429 np = UVISOR_MAX_CONN;
431 DPRINTF("Number of ports: %d\n", np);
433 for (i = 0; i < np; ++i) {
434 switch (coninfo.connections[i].port_function_id) {
435 case UVISOR_FUNCTION_GENERIC:
438 case UVISOR_FUNCTION_DEBUGGER:
441 case UVISOR_FUNCTION_HOTSYNC:
444 case UVISOR_FUNCTION_REMOTE_FILE_SYS:
445 desc = "Remote File System";
451 DPRINTF("Port %d is for %s\n",
452 coninfo.connections[i].port, desc);
457 if (sc->sc_flag & UVISOR_FLAG_PALM4) {
460 /* Palm OS 4.0 Hack */
461 req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
462 req.bRequest = UVISOR_GET_PALM_INFORMATION;
463 USETW(req.wValue, 0);
464 USETW(req.wIndex, 0);
465 USETW(req.wLength, UVISOR_GET_PALM_INFORMATION_LEN);
467 err = usbd_do_request_flags
468 (udev, NULL, &req, &pconinfo, USB_SHORT_XFER_OK,
469 &actlen, USB_DEFAULT_TIMEOUT);
475 DPRINTF("too little data\n");
479 if (pconinfo.endpoint_numbers_different) {
480 port = pconinfo.connections[0].end_point_info;
481 config[0].endpoint = (port & 0xF); /* output */
482 config[1].endpoint = (port >> 4); /* input */
484 port = pconinfo.connections[0].port;
485 config[0].endpoint = (port & 0xF); /* output */
486 config[1].endpoint = (port & 0xF); /* input */
489 req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
490 req.bRequest = UVISOR_GET_PALM_INFORMATION;
491 USETW(req.wValue, 0);
492 USETW(req.wIndex, 0);
493 USETW(req.wLength, UVISOR_GET_PALM_INFORMATION_LEN);
494 err = usbd_do_request(udev, &req, buffer);
500 if (sc->sc_flag & UVISOR_FLAG_PALM35) {
501 /* get the config number */
502 DPRINTF("getting config info\n");
503 req.bmRequestType = UT_READ;
504 req.bRequest = UR_GET_CONFIG;
505 USETW(req.wValue, 0);
506 USETW(req.wIndex, 0);
507 USETW(req.wLength, 1);
509 err = usbd_do_request(udev, NULL, &req, buffer);
513 /* get the interface number */
514 DPRINTF("get the interface number\n");
515 req.bmRequestType = UT_READ_DEVICE;
516 req.bRequest = UR_GET_INTERFACE;
517 USETW(req.wValue, 0);
518 USETW(req.wIndex, 0);
519 USETW(req.wLength, 1);
520 err = usbd_do_request(udev, NULL, &req, buffer);
528 DPRINTF("getting available bytes\n");
529 req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
530 req.bRequest = UVISOR_REQUEST_BYTES_AVAILABLE;
531 USETW(req.wValue, 0);
532 USETW(req.wIndex, 5);
533 USETW(req.wLength, sizeof(wAvail));
534 err = usbd_do_request(udev, NULL, &req, &wAvail);
538 DPRINTF("avail=%d\n", UGETW(wAvail));
547 uvisor_cfg_open(struct ucom_softc *ucom)
553 uvisor_cfg_close(struct ucom_softc *ucom)
555 struct uvisor_softc *sc = ucom->sc_parent;
556 uint8_t buffer[UVISOR_CONNECTION_INFO_SIZE];
557 struct usb_device_request req;
560 req.bmRequestType = UT_READ_VENDOR_ENDPOINT; /* XXX read? */
561 req.bRequest = UVISOR_CLOSE_NOTIFICATION;
562 USETW(req.wValue, 0);
563 USETW(req.wIndex, 0);
564 USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE);
566 err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
567 &req, buffer, 0, 1000);
569 DPRINTFN(0, "close notification failed, error=%s\n",
575 uvisor_start_read(struct ucom_softc *ucom)
577 struct uvisor_softc *sc = ucom->sc_parent;
579 usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_RD]);
583 uvisor_stop_read(struct ucom_softc *ucom)
585 struct uvisor_softc *sc = ucom->sc_parent;
587 usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_RD]);
591 uvisor_start_write(struct ucom_softc *ucom)
593 struct uvisor_softc *sc = ucom->sc_parent;
595 usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_WR]);
599 uvisor_stop_write(struct ucom_softc *ucom)
601 struct uvisor_softc *sc = ucom->sc_parent;
603 usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_WR]);
607 uvisor_write_callback(struct usb_xfer *xfer, usb_error_t error)
609 struct uvisor_softc *sc = usbd_xfer_softc(xfer);
610 struct usb_page_cache *pc;
614 switch (USB_GET_STATE(xfer)) {
616 case USB_ST_TRANSFERRED:
618 for (x = 0; x != UVISOROFRAMES; x++) {
620 usbd_xfer_set_frame_offset(xfer,
621 x * UVISOROBUFSIZE, x);
623 pc = usbd_xfer_get_frame(xfer, x);
624 if (ucom_get_data(&sc->sc_ucom, pc, 0,
625 UVISOROBUFSIZE, &actlen)) {
626 usbd_xfer_set_frame_len(xfer, x, actlen);
633 usbd_xfer_set_frames(xfer, x);
634 usbd_transfer_submit(xfer);
639 if (error != USB_ERR_CANCELLED) {
640 /* try to clear stall first */
641 usbd_xfer_set_stall(xfer);
649 uvisor_read_callback(struct usb_xfer *xfer, usb_error_t error)
651 struct uvisor_softc *sc = usbd_xfer_softc(xfer);
652 struct usb_page_cache *pc;
655 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
657 switch (USB_GET_STATE(xfer)) {
658 case USB_ST_TRANSFERRED:
659 pc = usbd_xfer_get_frame(xfer, 0);
660 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
664 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
665 usbd_transfer_submit(xfer);
669 if (error != USB_ERR_CANCELLED) {
670 /* try to clear stall first */
671 usbd_xfer_set_stall(xfer);