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.
32 * 3. All advertising materials mentioning features or use of this software
33 * must display the following acknowledgement:
34 * This product includes software developed by the NetBSD
35 * Foundation, Inc. and its contributors.
36 * 4. Neither the name of The NetBSD Foundation nor the names of its
37 * contributors may be used to endorse or promote products derived
38 * from this software without specific prior written permission.
40 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
41 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
42 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
44 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
45 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
46 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
47 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
48 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
50 * POSSIBILITY OF SUCH DAMAGE.
54 * Handspring Visor (Palmpilot compatible PDA) driver
57 #include <sys/stdint.h>
58 #include <sys/stddef.h>
59 #include <sys/param.h>
60 #include <sys/queue.h>
61 #include <sys/types.h>
62 #include <sys/systm.h>
63 #include <sys/kernel.h>
65 #include <sys/linker_set.h>
66 #include <sys/module.h>
68 #include <sys/mutex.h>
69 #include <sys/condvar.h>
70 #include <sys/sysctl.h>
72 #include <sys/unistd.h>
73 #include <sys/callout.h>
74 #include <sys/malloc.h>
77 #include <dev/usb/usb.h>
78 #include <dev/usb/usbdi.h>
79 #include <dev/usb/usbdi_util.h>
82 #define USB_DEBUG_VAR uvisor_debug
83 #include <dev/usb/usb_debug.h>
84 #include <dev/usb/usb_process.h>
86 #include <dev/usb/serial/usb_serial.h>
89 static int uvisor_debug = 0;
91 SYSCTL_NODE(_hw_usb, OID_AUTO, uvisor, CTLFLAG_RW, 0, "USB uvisor");
92 SYSCTL_INT(_hw_usb_uvisor, OID_AUTO, debug, CTLFLAG_RW,
93 &uvisor_debug, 0, "Debug level");
96 #define UVISOR_CONFIG_INDEX 0
97 #define UVISOR_IFACE_INDEX 0
100 * The following buffer sizes are hardcoded due to the way the Palm
101 * firmware works. It looks like the device is not short terminating
102 * the data transferred.
104 #define UVISORIBUFSIZE 0 /* Use wMaxPacketSize */
105 #define UVISOROBUFSIZE 32 /* bytes */
106 #define UVISOROFRAMES 32 /* units */
108 /* From the Linux driver */
110 * UVISOR_REQUEST_BYTES_AVAILABLE asks the visor for the number of bytes that
111 * are available to be transfered to the host for the specified endpoint.
112 * Currently this is not used, and always returns 0x0001
114 #define UVISOR_REQUEST_BYTES_AVAILABLE 0x01
117 * UVISOR_CLOSE_NOTIFICATION is set to the device to notify it that the host
118 * is now closing the pipe. An empty packet is sent in response.
120 #define UVISOR_CLOSE_NOTIFICATION 0x02
123 * UVISOR_GET_CONNECTION_INFORMATION is sent by the host during enumeration to
124 * get the endpoints used by the connection.
126 #define UVISOR_GET_CONNECTION_INFORMATION 0x03
129 * UVISOR_GET_CONNECTION_INFORMATION returns data in the following format
131 #define UVISOR_MAX_CONN 8
132 struct uvisor_connection_info {
135 uByte port_function_id;
137 } __packed connections[UVISOR_MAX_CONN];
140 #define UVISOR_CONNECTION_INFO_SIZE 18
142 /* struct uvisor_connection_info.connection[x].port defines: */
143 #define UVISOR_ENDPOINT_1 0x01
144 #define UVISOR_ENDPOINT_2 0x02
146 /* struct uvisor_connection_info.connection[x].port_function_id defines: */
147 #define UVISOR_FUNCTION_GENERIC 0x00
148 #define UVISOR_FUNCTION_DEBUGGER 0x01
149 #define UVISOR_FUNCTION_HOTSYNC 0x02
150 #define UVISOR_FUNCTION_CONSOLE 0x03
151 #define UVISOR_FUNCTION_REMOTE_FILE_SYS 0x04
154 * Unknown PalmOS stuff.
156 #define UVISOR_GET_PALM_INFORMATION 0x04
157 #define UVISOR_GET_PALM_INFORMATION_LEN 0x44
159 struct uvisor_palm_connection_info {
161 uByte endpoint_numbers_different;
164 uDWord port_function_id;
166 uByte end_point_info;
168 } __packed connections[UVISOR_MAX_CONN];
177 struct uvisor_softc {
178 struct ucom_super_softc sc_super_ucom;
179 struct ucom_softc sc_ucom;
181 struct usb_xfer *sc_xfer[UVISOR_N_TRANSFER];
182 struct usb_device *sc_udev;
186 #define UVISOR_FLAG_PALM4 0x0001
187 #define UVISOR_FLAG_VISOR 0x0002
188 #define UVISOR_FLAG_PALM35 0x0004
189 #define UVISOR_FLAG_SEND_NOTIFY 0x0008
192 uint8_t sc_iface_index;
197 static device_probe_t uvisor_probe;
198 static device_attach_t uvisor_attach;
199 static device_detach_t uvisor_detach;
201 static usb_callback_t uvisor_write_callback;
202 static usb_callback_t uvisor_read_callback;
204 static usb_error_t uvisor_init(struct uvisor_softc *, struct usb_device *,
205 struct usb_config *);
206 static void uvisor_cfg_open(struct ucom_softc *);
207 static void uvisor_cfg_close(struct ucom_softc *);
208 static void uvisor_start_read(struct ucom_softc *);
209 static void uvisor_stop_read(struct ucom_softc *);
210 static void uvisor_start_write(struct ucom_softc *);
211 static void uvisor_stop_write(struct ucom_softc *);
213 static const struct usb_config uvisor_config[UVISOR_N_TRANSFER] = {
215 [UVISOR_BULK_DT_WR] = {
217 .endpoint = UE_ADDR_ANY,
218 .direction = UE_DIR_OUT,
219 .bufsize = UVISOROBUFSIZE * UVISOROFRAMES,
220 .frames = UVISOROFRAMES,
221 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
222 .callback = &uvisor_write_callback,
225 [UVISOR_BULK_DT_RD] = {
227 .endpoint = UE_ADDR_ANY,
228 .direction = UE_DIR_IN,
229 .bufsize = UVISORIBUFSIZE,
230 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
231 .callback = &uvisor_read_callback,
235 static const struct ucom_callback uvisor_callback = {
236 .ucom_cfg_open = &uvisor_cfg_open,
237 .ucom_cfg_close = &uvisor_cfg_close,
238 .ucom_start_read = &uvisor_start_read,
239 .ucom_stop_read = &uvisor_stop_read,
240 .ucom_start_write = &uvisor_start_write,
241 .ucom_stop_write = &uvisor_stop_write,
244 static device_method_t uvisor_methods[] = {
245 DEVMETHOD(device_probe, uvisor_probe),
246 DEVMETHOD(device_attach, uvisor_attach),
247 DEVMETHOD(device_detach, uvisor_detach),
251 static devclass_t uvisor_devclass;
253 static driver_t uvisor_driver = {
255 .methods = uvisor_methods,
256 .size = sizeof(struct uvisor_softc),
259 DRIVER_MODULE(uvisor, uhub, uvisor_driver, uvisor_devclass, NULL, 0);
260 MODULE_DEPEND(uvisor, ucom, 1, 1, 1);
261 MODULE_DEPEND(uvisor, usb, 1, 1, 1);
263 static const struct usb_device_id uvisor_devs[] = {
264 #define UVISOR_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
265 UVISOR_DEV(ACEECA, MEZ1000, UVISOR_FLAG_PALM4),
266 UVISOR_DEV(ALPHASMART, DANA_SYNC, UVISOR_FLAG_PALM4),
267 UVISOR_DEV(GARMIN, IQUE_3600, UVISOR_FLAG_PALM4),
268 UVISOR_DEV(FOSSIL, WRISTPDA, UVISOR_FLAG_PALM4),
269 UVISOR_DEV(HANDSPRING, VISOR, UVISOR_FLAG_VISOR),
270 UVISOR_DEV(HANDSPRING, TREO, UVISOR_FLAG_PALM4),
271 UVISOR_DEV(HANDSPRING, TREO600, UVISOR_FLAG_PALM4),
272 UVISOR_DEV(PALM, M500, UVISOR_FLAG_PALM4),
273 UVISOR_DEV(PALM, M505, UVISOR_FLAG_PALM4),
274 UVISOR_DEV(PALM, M515, UVISOR_FLAG_PALM4),
275 UVISOR_DEV(PALM, I705, UVISOR_FLAG_PALM4),
276 UVISOR_DEV(PALM, M125, UVISOR_FLAG_PALM4),
277 UVISOR_DEV(PALM, M130, UVISOR_FLAG_PALM4),
278 UVISOR_DEV(PALM, TUNGSTEN_Z, UVISOR_FLAG_PALM4),
279 UVISOR_DEV(PALM, TUNGSTEN_T, UVISOR_FLAG_PALM4),
280 UVISOR_DEV(PALM, ZIRE, UVISOR_FLAG_PALM4),
281 UVISOR_DEV(PALM, ZIRE31, UVISOR_FLAG_PALM4),
282 UVISOR_DEV(SAMSUNG, I500, UVISOR_FLAG_PALM4),
283 UVISOR_DEV(SONY, CLIE_40, 0),
284 UVISOR_DEV(SONY, CLIE_41, 0),
285 UVISOR_DEV(SONY, CLIE_S360, UVISOR_FLAG_PALM4),
286 UVISOR_DEV(SONY, CLIE_NX60, UVISOR_FLAG_PALM4),
287 UVISOR_DEV(SONY, CLIE_35, UVISOR_FLAG_PALM35),
288 /* UVISOR_DEV(SONY, CLIE_25, UVISOR_FLAG_PALM4 ), */
289 UVISOR_DEV(SONY, CLIE_TJ37, UVISOR_FLAG_PALM4),
290 /* UVISOR_DEV(SONY, CLIE_TH55, UVISOR_FLAG_PALM4 ), See PR 80935 */
291 UVISOR_DEV(TAPWAVE, ZODIAC, UVISOR_FLAG_PALM4),
296 uvisor_probe(device_t dev)
298 struct usb_attach_arg *uaa = device_get_ivars(dev);
300 if (uaa->usb_mode != USB_MODE_HOST) {
303 if (uaa->info.bConfigIndex != UVISOR_CONFIG_INDEX) {
306 if (uaa->info.bIfaceIndex != UVISOR_IFACE_INDEX) {
309 return (usbd_lookup_id_by_uaa(uvisor_devs, sizeof(uvisor_devs), uaa));
313 uvisor_attach(device_t dev)
315 struct usb_attach_arg *uaa = device_get_ivars(dev);
316 struct uvisor_softc *sc = device_get_softc(dev);
317 struct usb_config uvisor_config_copy[UVISOR_N_TRANSFER];
320 DPRINTF("sc=%p\n", sc);
321 bcopy(uvisor_config, uvisor_config_copy,
322 sizeof(uvisor_config_copy));
323 device_set_usb_desc(dev);
325 mtx_init(&sc->sc_mtx, "uvisor", NULL, MTX_DEF);
327 sc->sc_udev = uaa->device;
329 /* configure the device */
331 sc->sc_flag = USB_GET_DRIVER_INFO(uaa);
332 sc->sc_iface_no = uaa->info.bIfaceNum;
333 sc->sc_iface_index = UVISOR_IFACE_INDEX;
335 error = uvisor_init(sc, uaa->device, uvisor_config_copy);
338 DPRINTF("init failed, error=%s\n",
342 error = usbd_transfer_setup(uaa->device, &sc->sc_iface_index,
343 sc->sc_xfer, uvisor_config_copy, UVISOR_N_TRANSFER,
346 DPRINTF("could not allocate all pipes\n");
350 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
351 &uvisor_callback, &sc->sc_mtx);
353 DPRINTF("ucom_attach failed\n");
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, 1);
371 usbd_transfer_unsetup(sc->sc_xfer, UVISOR_N_TRANSFER);
372 mtx_destroy(&sc->sc_mtx);
378 uvisor_init(struct uvisor_softc *sc, struct usb_device *udev, struct usb_config *config)
381 struct usb_device_request req;
382 struct uvisor_connection_info coninfo;
383 struct uvisor_palm_connection_info pconinfo;
387 if (sc->sc_flag & UVISOR_FLAG_VISOR) {
388 DPRINTF("getting connection info\n");
389 req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
390 req.bRequest = UVISOR_GET_CONNECTION_INFORMATION;
391 USETW(req.wValue, 0);
392 USETW(req.wIndex, 0);
393 USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE);
394 err = usbd_do_request_flags(udev, NULL,
395 &req, &coninfo, USB_SHORT_XFER_OK,
396 &actlen, USB_DEFAULT_TIMEOUT);
403 if (sc->sc_flag & UVISOR_FLAG_VISOR) {
407 np = UGETW(coninfo.num_ports);
408 if (np > UVISOR_MAX_CONN) {
409 np = UVISOR_MAX_CONN;
411 DPRINTF("Number of ports: %d\n", np);
413 for (i = 0; i < np; ++i) {
414 switch (coninfo.connections[i].port_function_id) {
415 case UVISOR_FUNCTION_GENERIC:
418 case UVISOR_FUNCTION_DEBUGGER:
421 case UVISOR_FUNCTION_HOTSYNC:
424 case UVISOR_FUNCTION_REMOTE_FILE_SYS:
425 desc = "Remote File System";
431 DPRINTF("Port %d is for %s\n",
432 coninfo.connections[i].port, desc);
437 if (sc->sc_flag & UVISOR_FLAG_PALM4) {
440 /* Palm OS 4.0 Hack */
441 req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
442 req.bRequest = UVISOR_GET_PALM_INFORMATION;
443 USETW(req.wValue, 0);
444 USETW(req.wIndex, 0);
445 USETW(req.wLength, UVISOR_GET_PALM_INFORMATION_LEN);
447 err = usbd_do_request_flags
448 (udev, NULL, &req, &pconinfo, USB_SHORT_XFER_OK,
449 &actlen, USB_DEFAULT_TIMEOUT);
455 DPRINTF("too little data\n");
459 if (pconinfo.endpoint_numbers_different) {
460 port = pconinfo.connections[0].end_point_info;
461 config[0].endpoint = (port & 0xF); /* output */
462 config[1].endpoint = (port >> 4); /* input */
464 port = pconinfo.connections[0].port;
465 config[0].endpoint = (port & 0xF); /* output */
466 config[1].endpoint = (port & 0xF); /* input */
469 req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
470 req.bRequest = UVISOR_GET_PALM_INFORMATION;
471 USETW(req.wValue, 0);
472 USETW(req.wIndex, 0);
473 USETW(req.wLength, UVISOR_GET_PALM_INFORMATION_LEN);
474 err = usbd_do_request(udev, &req, buffer);
480 if (sc->sc_flag & UVISOR_FLAG_PALM35) {
481 /* get the config number */
482 DPRINTF("getting config info\n");
483 req.bmRequestType = UT_READ;
484 req.bRequest = UR_GET_CONFIG;
485 USETW(req.wValue, 0);
486 USETW(req.wIndex, 0);
487 USETW(req.wLength, 1);
489 err = usbd_do_request(udev, NULL, &req, buffer);
493 /* get the interface number */
494 DPRINTF("get the interface number\n");
495 req.bmRequestType = UT_READ_DEVICE;
496 req.bRequest = UR_GET_INTERFACE;
497 USETW(req.wValue, 0);
498 USETW(req.wIndex, 0);
499 USETW(req.wLength, 1);
500 err = usbd_do_request(udev, NULL, &req, buffer);
508 DPRINTF("getting available bytes\n");
509 req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
510 req.bRequest = UVISOR_REQUEST_BYTES_AVAILABLE;
511 USETW(req.wValue, 0);
512 USETW(req.wIndex, 5);
513 USETW(req.wLength, sizeof(wAvail));
514 err = usbd_do_request(udev, NULL, &req, &wAvail);
518 DPRINTF("avail=%d\n", UGETW(wAvail));
527 uvisor_cfg_open(struct ucom_softc *ucom)
533 uvisor_cfg_close(struct ucom_softc *ucom)
535 struct uvisor_softc *sc = ucom->sc_parent;
536 uint8_t buffer[UVISOR_CONNECTION_INFO_SIZE];
537 struct usb_device_request req;
540 req.bmRequestType = UT_READ_VENDOR_ENDPOINT; /* XXX read? */
541 req.bRequest = UVISOR_CLOSE_NOTIFICATION;
542 USETW(req.wValue, 0);
543 USETW(req.wIndex, 0);
544 USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE);
546 err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
547 &req, buffer, 0, 1000);
549 DPRINTFN(0, "close notification failed, error=%s\n",
555 uvisor_start_read(struct ucom_softc *ucom)
557 struct uvisor_softc *sc = ucom->sc_parent;
559 usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_RD]);
563 uvisor_stop_read(struct ucom_softc *ucom)
565 struct uvisor_softc *sc = ucom->sc_parent;
567 usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_RD]);
571 uvisor_start_write(struct ucom_softc *ucom)
573 struct uvisor_softc *sc = ucom->sc_parent;
575 usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_WR]);
579 uvisor_stop_write(struct ucom_softc *ucom)
581 struct uvisor_softc *sc = ucom->sc_parent;
583 usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_WR]);
587 uvisor_write_callback(struct usb_xfer *xfer, usb_error_t error)
589 struct uvisor_softc *sc = usbd_xfer_softc(xfer);
590 struct usb_page_cache *pc;
594 switch (USB_GET_STATE(xfer)) {
596 case USB_ST_TRANSFERRED:
598 for (x = 0; x != UVISOROFRAMES; x++) {
600 usbd_xfer_set_frame_offset(xfer,
601 x * UVISOROBUFSIZE, x);
603 pc = usbd_xfer_get_frame(xfer, x);
604 if (ucom_get_data(&sc->sc_ucom, pc, 0,
605 UVISOROBUFSIZE, &actlen)) {
606 usbd_xfer_set_frame_len(xfer, x, actlen);
613 usbd_xfer_set_frames(xfer, x);
614 usbd_transfer_submit(xfer);
619 if (error != USB_ERR_CANCELLED) {
620 /* try to clear stall first */
621 usbd_xfer_set_stall(xfer);
629 uvisor_read_callback(struct usb_xfer *xfer, usb_error_t error)
631 struct uvisor_softc *sc = usbd_xfer_softc(xfer);
632 struct usb_page_cache *pc;
635 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
637 switch (USB_GET_STATE(xfer)) {
638 case USB_ST_TRANSFERRED:
639 pc = usbd_xfer_get_frame(xfer, 0);
640 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
644 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
645 usbd_transfer_submit(xfer);
649 if (error != USB_ERR_CANCELLED) {
650 /* try to clear stall first */
651 usbd_xfer_set_stall(xfer);