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_RWTUN,
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 transferred 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 static const STRUCT_USB_HOST_ID uvisor_devs[] = {
255 #define UVISOR_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
256 UVISOR_DEV(ACEECA, MEZ1000, UVISOR_FLAG_PALM4),
257 UVISOR_DEV(ALPHASMART, DANA_SYNC, UVISOR_FLAG_PALM4),
258 UVISOR_DEV(GARMIN, IQUE_3600, UVISOR_FLAG_PALM4),
259 UVISOR_DEV(FOSSIL, WRISTPDA, UVISOR_FLAG_PALM4),
260 UVISOR_DEV(HANDSPRING, VISOR, UVISOR_FLAG_VISOR),
261 UVISOR_DEV(HANDSPRING, TREO, UVISOR_FLAG_PALM4),
262 UVISOR_DEV(HANDSPRING, TREO600, UVISOR_FLAG_PALM4),
263 UVISOR_DEV(PALM, M500, UVISOR_FLAG_PALM4),
264 UVISOR_DEV(PALM, M505, UVISOR_FLAG_PALM4),
265 UVISOR_DEV(PALM, M515, UVISOR_FLAG_PALM4),
266 UVISOR_DEV(PALM, I705, UVISOR_FLAG_PALM4),
267 UVISOR_DEV(PALM, M125, UVISOR_FLAG_PALM4),
268 UVISOR_DEV(PALM, M130, UVISOR_FLAG_PALM4),
269 UVISOR_DEV(PALM, TUNGSTEN_Z, UVISOR_FLAG_PALM4),
270 UVISOR_DEV(PALM, TUNGSTEN_T, UVISOR_FLAG_PALM4),
271 UVISOR_DEV(PALM, ZIRE, UVISOR_FLAG_PALM4),
272 UVISOR_DEV(PALM, ZIRE31, UVISOR_FLAG_PALM4),
273 UVISOR_DEV(SAMSUNG, I500, UVISOR_FLAG_PALM4),
274 UVISOR_DEV(SONY, CLIE_40, 0),
275 UVISOR_DEV(SONY, CLIE_41, 0),
276 UVISOR_DEV(SONY, CLIE_S360, UVISOR_FLAG_PALM4),
277 UVISOR_DEV(SONY, CLIE_NX60, UVISOR_FLAG_PALM4),
278 UVISOR_DEV(SONY, CLIE_35, UVISOR_FLAG_PALM35),
279 /* UVISOR_DEV(SONY, CLIE_25, UVISOR_FLAG_PALM4 ), */
280 UVISOR_DEV(SONY, CLIE_TJ37, UVISOR_FLAG_PALM4),
281 /* UVISOR_DEV(SONY, CLIE_TH55, UVISOR_FLAG_PALM4 ), See PR 80935 */
282 UVISOR_DEV(TAPWAVE, ZODIAC, UVISOR_FLAG_PALM4),
286 DRIVER_MODULE(uvisor, uhub, uvisor_driver, uvisor_devclass, NULL, 0);
287 MODULE_DEPEND(uvisor, ucom, 1, 1, 1);
288 MODULE_DEPEND(uvisor, usb, 1, 1, 1);
289 MODULE_VERSION(uvisor, 1);
290 USB_PNP_HOST_INFO(uvisor_devs);
293 uvisor_probe(device_t dev)
295 struct usb_attach_arg *uaa = device_get_ivars(dev);
297 if (uaa->usb_mode != USB_MODE_HOST) {
300 if (uaa->info.bConfigIndex != UVISOR_CONFIG_INDEX) {
303 if (uaa->info.bIfaceIndex != UVISOR_IFACE_INDEX) {
306 return (usbd_lookup_id_by_uaa(uvisor_devs, sizeof(uvisor_devs), uaa));
310 uvisor_attach(device_t dev)
312 struct usb_attach_arg *uaa = device_get_ivars(dev);
313 struct uvisor_softc *sc = device_get_softc(dev);
314 struct usb_config uvisor_config_copy[UVISOR_N_TRANSFER];
317 DPRINTF("sc=%p\n", sc);
318 memcpy(uvisor_config_copy, uvisor_config,
319 sizeof(uvisor_config_copy));
321 device_set_usb_desc(dev);
323 mtx_init(&sc->sc_mtx, "uvisor", NULL, MTX_DEF);
324 ucom_ref(&sc->sc_super_ucom);
326 sc->sc_udev = uaa->device;
328 /* configure the device */
330 sc->sc_flag = USB_GET_DRIVER_INFO(uaa);
331 sc->sc_iface_no = uaa->info.bIfaceNum;
332 sc->sc_iface_index = UVISOR_IFACE_INDEX;
334 error = uvisor_init(sc, uaa->device, uvisor_config_copy);
337 DPRINTF("init failed, error=%s\n",
341 error = usbd_transfer_setup(uaa->device, &sc->sc_iface_index,
342 sc->sc_xfer, uvisor_config_copy, UVISOR_N_TRANSFER,
345 DPRINTF("could not allocate all pipes\n");
349 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
350 &uvisor_callback, &sc->sc_mtx);
352 DPRINTF("ucom_attach failed\n");
355 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
365 uvisor_detach(device_t dev)
367 struct uvisor_softc *sc = device_get_softc(dev);
369 DPRINTF("sc=%p\n", sc);
371 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
372 usbd_transfer_unsetup(sc->sc_xfer, UVISOR_N_TRANSFER);
374 device_claim_softc(dev);
376 uvisor_free_softc(sc);
381 UCOM_UNLOAD_DRAIN(uvisor);
384 uvisor_free_softc(struct uvisor_softc *sc)
386 if (ucom_unref(&sc->sc_super_ucom)) {
387 mtx_destroy(&sc->sc_mtx);
388 device_free_softc(sc);
393 uvisor_free(struct ucom_softc *ucom)
395 uvisor_free_softc(ucom->sc_parent);
399 uvisor_init(struct uvisor_softc *sc, struct usb_device *udev, struct usb_config *config)
402 struct usb_device_request req;
403 struct uvisor_connection_info coninfo;
404 struct uvisor_palm_connection_info pconinfo;
408 if (sc->sc_flag & UVISOR_FLAG_VISOR) {
409 DPRINTF("getting connection info\n");
410 req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
411 req.bRequest = UVISOR_GET_CONNECTION_INFORMATION;
412 USETW(req.wValue, 0);
413 USETW(req.wIndex, 0);
414 USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE);
415 err = usbd_do_request_flags(udev, NULL,
416 &req, &coninfo, USB_SHORT_XFER_OK,
417 &actlen, USB_DEFAULT_TIMEOUT);
424 if (sc->sc_flag & UVISOR_FLAG_VISOR) {
428 np = UGETW(coninfo.num_ports);
429 if (np > UVISOR_MAX_CONN) {
430 np = UVISOR_MAX_CONN;
432 DPRINTF("Number of ports: %d\n", np);
434 for (i = 0; i < np; ++i) {
435 switch (coninfo.connections[i].port_function_id) {
436 case UVISOR_FUNCTION_GENERIC:
439 case UVISOR_FUNCTION_DEBUGGER:
442 case UVISOR_FUNCTION_HOTSYNC:
445 case UVISOR_FUNCTION_REMOTE_FILE_SYS:
446 desc = "Remote File System";
452 DPRINTF("Port %d is for %s\n",
453 coninfo.connections[i].port, desc);
458 if (sc->sc_flag & UVISOR_FLAG_PALM4) {
461 /* Palm OS 4.0 Hack */
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);
468 err = usbd_do_request_flags
469 (udev, NULL, &req, &pconinfo, USB_SHORT_XFER_OK,
470 &actlen, USB_DEFAULT_TIMEOUT);
476 DPRINTF("too little data\n");
480 if (pconinfo.endpoint_numbers_different) {
481 port = pconinfo.connections[0].end_point_info;
482 config[0].endpoint = (port & 0xF); /* output */
483 config[1].endpoint = (port >> 4); /* input */
485 port = pconinfo.connections[0].port;
486 config[0].endpoint = (port & 0xF); /* output */
487 config[1].endpoint = (port & 0xF); /* input */
490 req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
491 req.bRequest = UVISOR_GET_PALM_INFORMATION;
492 USETW(req.wValue, 0);
493 USETW(req.wIndex, 0);
494 USETW(req.wLength, UVISOR_GET_PALM_INFORMATION_LEN);
495 err = usbd_do_request(udev, &req, buffer);
501 if (sc->sc_flag & UVISOR_FLAG_PALM35) {
502 /* get the config number */
503 DPRINTF("getting config info\n");
504 req.bmRequestType = UT_READ;
505 req.bRequest = UR_GET_CONFIG;
506 USETW(req.wValue, 0);
507 USETW(req.wIndex, 0);
508 USETW(req.wLength, 1);
510 err = usbd_do_request(udev, NULL, &req, buffer);
514 /* get the interface number */
515 DPRINTF("get the interface number\n");
516 req.bmRequestType = UT_READ_DEVICE;
517 req.bRequest = UR_GET_INTERFACE;
518 USETW(req.wValue, 0);
519 USETW(req.wIndex, 0);
520 USETW(req.wLength, 1);
521 err = usbd_do_request(udev, NULL, &req, buffer);
529 DPRINTF("getting available bytes\n");
530 req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
531 req.bRequest = UVISOR_REQUEST_BYTES_AVAILABLE;
532 USETW(req.wValue, 0);
533 USETW(req.wIndex, 5);
534 USETW(req.wLength, sizeof(wAvail));
535 err = usbd_do_request(udev, NULL, &req, &wAvail);
539 DPRINTF("avail=%d\n", UGETW(wAvail));
548 uvisor_cfg_open(struct ucom_softc *ucom)
554 uvisor_cfg_close(struct ucom_softc *ucom)
556 struct uvisor_softc *sc = ucom->sc_parent;
557 uint8_t buffer[UVISOR_CONNECTION_INFO_SIZE];
558 struct usb_device_request req;
561 req.bmRequestType = UT_READ_VENDOR_ENDPOINT; /* XXX read? */
562 req.bRequest = UVISOR_CLOSE_NOTIFICATION;
563 USETW(req.wValue, 0);
564 USETW(req.wIndex, 0);
565 USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE);
567 err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
568 &req, buffer, 0, 1000);
570 DPRINTFN(0, "close notification failed, error=%s\n",
576 uvisor_start_read(struct ucom_softc *ucom)
578 struct uvisor_softc *sc = ucom->sc_parent;
580 usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_RD]);
584 uvisor_stop_read(struct ucom_softc *ucom)
586 struct uvisor_softc *sc = ucom->sc_parent;
588 usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_RD]);
592 uvisor_start_write(struct ucom_softc *ucom)
594 struct uvisor_softc *sc = ucom->sc_parent;
596 usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_WR]);
600 uvisor_stop_write(struct ucom_softc *ucom)
602 struct uvisor_softc *sc = ucom->sc_parent;
604 usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_WR]);
608 uvisor_write_callback(struct usb_xfer *xfer, usb_error_t error)
610 struct uvisor_softc *sc = usbd_xfer_softc(xfer);
611 struct usb_page_cache *pc;
615 switch (USB_GET_STATE(xfer)) {
617 case USB_ST_TRANSFERRED:
619 for (x = 0; x != UVISOROFRAMES; x++) {
621 usbd_xfer_set_frame_offset(xfer,
622 x * UVISOROBUFSIZE, x);
624 pc = usbd_xfer_get_frame(xfer, x);
625 if (ucom_get_data(&sc->sc_ucom, pc, 0,
626 UVISOROBUFSIZE, &actlen)) {
627 usbd_xfer_set_frame_len(xfer, x, actlen);
634 usbd_xfer_set_frames(xfer, x);
635 usbd_transfer_submit(xfer);
640 if (error != USB_ERR_CANCELLED) {
641 /* try to clear stall first */
642 usbd_xfer_set_stall(xfer);
650 uvisor_read_callback(struct usb_xfer *xfer, usb_error_t error)
652 struct uvisor_softc *sc = usbd_xfer_softc(xfer);
653 struct usb_page_cache *pc;
656 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
658 switch (USB_GET_STATE(xfer)) {
659 case USB_ST_TRANSFERRED:
660 pc = usbd_xfer_get_frame(xfer, 0);
661 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
665 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
666 usbd_transfer_submit(xfer);
670 if (error != USB_ERR_CANCELLED) {
671 /* try to clear stall first */
672 usbd_xfer_set_stall(xfer);