82static int uvisor_debug = 0;
83
84SYSCTL_NODE(_hw_usb, OID_AUTO, uvisor, CTLFLAG_RW, 0, "USB uvisor");
85SYSCTL_INT(_hw_usb_uvisor, OID_AUTO, debug, CTLFLAG_RW,
86 &uvisor_debug, 0, "Debug level");
87#endif
88
89#define UVISOR_CONFIG_INDEX 0
90#define UVISOR_IFACE_INDEX 0
91
92/*
93 * The following buffer sizes are hardcoded due to the way the Palm
94 * firmware works. It looks like the device is not short terminating
95 * the data transferred.
96 */
97#define UVISORIBUFSIZE 0 /* Use wMaxPacketSize */
98#define UVISOROBUFSIZE 32 /* bytes */
99#define UVISOROFRAMES 32 /* units */
100
101/* From the Linux driver */
102/*
103 * UVISOR_REQUEST_BYTES_AVAILABLE asks the visor for the number of bytes that
104 * are available to be transfered to the host for the specified endpoint.
105 * Currently this is not used, and always returns 0x0001
106 */
107#define UVISOR_REQUEST_BYTES_AVAILABLE 0x01
108
109/*
110 * UVISOR_CLOSE_NOTIFICATION is set to the device to notify it that the host
111 * is now closing the pipe. An empty packet is sent in response.
112 */
113#define UVISOR_CLOSE_NOTIFICATION 0x02
114
115/*
116 * UVISOR_GET_CONNECTION_INFORMATION is sent by the host during enumeration to
117 * get the endpoints used by the connection.
118 */
119#define UVISOR_GET_CONNECTION_INFORMATION 0x03
120
121/*
122 * UVISOR_GET_CONNECTION_INFORMATION returns data in the following format
123 */
124#define UVISOR_MAX_CONN 8
125struct uvisor_connection_info {
126 uWord num_ports;
127 struct {
128 uByte port_function_id;
129 uByte port;
130 } __packed connections[UVISOR_MAX_CONN];
131} __packed;
132
133#define UVISOR_CONNECTION_INFO_SIZE 18
134
135/* struct uvisor_connection_info.connection[x].port defines: */
136#define UVISOR_ENDPOINT_1 0x01
137#define UVISOR_ENDPOINT_2 0x02
138
139/* struct uvisor_connection_info.connection[x].port_function_id defines: */
140#define UVISOR_FUNCTION_GENERIC 0x00
141#define UVISOR_FUNCTION_DEBUGGER 0x01
142#define UVISOR_FUNCTION_HOTSYNC 0x02
143#define UVISOR_FUNCTION_CONSOLE 0x03
144#define UVISOR_FUNCTION_REMOTE_FILE_SYS 0x04
145
146/*
147 * Unknown PalmOS stuff.
148 */
149#define UVISOR_GET_PALM_INFORMATION 0x04
150#define UVISOR_GET_PALM_INFORMATION_LEN 0x44
151
152struct uvisor_palm_connection_info {
153 uByte num_ports;
154 uByte endpoint_numbers_different;
155 uWord reserved1;
156 struct {
157 uDWord port_function_id;
158 uByte port;
159 uByte end_point_info;
160 uWord reserved;
161 } __packed connections[UVISOR_MAX_CONN];
162} __packed;
163
164enum {
165 UVISOR_BULK_DT_WR,
166 UVISOR_BULK_DT_RD,
167 UVISOR_N_TRANSFER,
168};
169
170struct uvisor_softc {
171 struct ucom_super_softc sc_super_ucom;
172 struct ucom_softc sc_ucom;
173
174 struct usb_xfer *sc_xfer[UVISOR_N_TRANSFER];
175 struct usb_device *sc_udev;
176 struct mtx sc_mtx;
177
178 uint16_t sc_flag;
179#define UVISOR_FLAG_PALM4 0x0001
180#define UVISOR_FLAG_VISOR 0x0002
181#define UVISOR_FLAG_PALM35 0x0004
182#define UVISOR_FLAG_SEND_NOTIFY 0x0008
183
184 uint8_t sc_iface_no;
185 uint8_t sc_iface_index;
186};
187
188/* prototypes */
189
190static device_probe_t uvisor_probe;
191static device_attach_t uvisor_attach;
192static device_detach_t uvisor_detach;
193
194static usb_callback_t uvisor_write_callback;
195static usb_callback_t uvisor_read_callback;
196
197static usb_error_t uvisor_init(struct uvisor_softc *, struct usb_device *,
198 struct usb_config *);
199static void uvisor_cfg_open(struct ucom_softc *);
200static void uvisor_cfg_close(struct ucom_softc *);
201static void uvisor_start_read(struct ucom_softc *);
202static void uvisor_stop_read(struct ucom_softc *);
203static void uvisor_start_write(struct ucom_softc *);
204static void uvisor_stop_write(struct ucom_softc *);
205
206static const struct usb_config uvisor_config[UVISOR_N_TRANSFER] = {
207
208 [UVISOR_BULK_DT_WR] = {
209 .type = UE_BULK,
210 .endpoint = UE_ADDR_ANY,
211 .direction = UE_DIR_OUT,
212 .bufsize = UVISOROBUFSIZE * UVISOROFRAMES,
213 .frames = UVISOROFRAMES,
214 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
215 .callback = &uvisor_write_callback,
216 },
217
218 [UVISOR_BULK_DT_RD] = {
219 .type = UE_BULK,
220 .endpoint = UE_ADDR_ANY,
221 .direction = UE_DIR_IN,
222 .bufsize = UVISORIBUFSIZE,
223 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
224 .callback = &uvisor_read_callback,
225 },
226};
227
228static const struct ucom_callback uvisor_callback = {
229 .ucom_cfg_open = &uvisor_cfg_open,
230 .ucom_cfg_close = &uvisor_cfg_close,
231 .ucom_start_read = &uvisor_start_read,
232 .ucom_stop_read = &uvisor_stop_read,
233 .ucom_start_write = &uvisor_start_write,
234 .ucom_stop_write = &uvisor_stop_write,
235};
236
237static device_method_t uvisor_methods[] = {
238 DEVMETHOD(device_probe, uvisor_probe),
239 DEVMETHOD(device_attach, uvisor_attach),
240 DEVMETHOD(device_detach, uvisor_detach),
241 {0, 0}
242};
243
244static devclass_t uvisor_devclass;
245
246static driver_t uvisor_driver = {
247 .name = "uvisor",
248 .methods = uvisor_methods,
249 .size = sizeof(struct uvisor_softc),
250};
251
252DRIVER_MODULE(uvisor, uhub, uvisor_driver, uvisor_devclass, NULL, 0);
253MODULE_DEPEND(uvisor, ucom, 1, 1, 1);
254MODULE_DEPEND(uvisor, usb, 1, 1, 1);
255
256static const struct usb_device_id uvisor_devs[] = {
257#define UVISOR_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
258 UVISOR_DEV(ACEECA, MEZ1000, UVISOR_FLAG_PALM4),
259 UVISOR_DEV(ALPHASMART, DANA_SYNC, UVISOR_FLAG_PALM4),
260 UVISOR_DEV(GARMIN, IQUE_3600, UVISOR_FLAG_PALM4),
261 UVISOR_DEV(FOSSIL, WRISTPDA, UVISOR_FLAG_PALM4),
262 UVISOR_DEV(HANDSPRING, VISOR, UVISOR_FLAG_VISOR),
263 UVISOR_DEV(HANDSPRING, TREO, UVISOR_FLAG_PALM4),
264 UVISOR_DEV(HANDSPRING, TREO600, UVISOR_FLAG_PALM4),
265 UVISOR_DEV(PALM, M500, UVISOR_FLAG_PALM4),
266 UVISOR_DEV(PALM, M505, UVISOR_FLAG_PALM4),
267 UVISOR_DEV(PALM, M515, UVISOR_FLAG_PALM4),
268 UVISOR_DEV(PALM, I705, UVISOR_FLAG_PALM4),
269 UVISOR_DEV(PALM, M125, UVISOR_FLAG_PALM4),
270 UVISOR_DEV(PALM, M130, UVISOR_FLAG_PALM4),
271 UVISOR_DEV(PALM, TUNGSTEN_Z, UVISOR_FLAG_PALM4),
272 UVISOR_DEV(PALM, TUNGSTEN_T, UVISOR_FLAG_PALM4),
273 UVISOR_DEV(PALM, ZIRE, UVISOR_FLAG_PALM4),
274 UVISOR_DEV(PALM, ZIRE31, UVISOR_FLAG_PALM4),
275 UVISOR_DEV(SAMSUNG, I500, UVISOR_FLAG_PALM4),
276 UVISOR_DEV(SONY, CLIE_40, 0),
277 UVISOR_DEV(SONY, CLIE_41, 0),
278 UVISOR_DEV(SONY, CLIE_S360, UVISOR_FLAG_PALM4),
279 UVISOR_DEV(SONY, CLIE_NX60, UVISOR_FLAG_PALM4),
280 UVISOR_DEV(SONY, CLIE_35, UVISOR_FLAG_PALM35),
281/* UVISOR_DEV(SONY, CLIE_25, UVISOR_FLAG_PALM4 ), */
282 UVISOR_DEV(SONY, CLIE_TJ37, UVISOR_FLAG_PALM4),
283/* UVISOR_DEV(SONY, CLIE_TH55, UVISOR_FLAG_PALM4 ), See PR 80935 */
284 UVISOR_DEV(TAPWAVE, ZODIAC, UVISOR_FLAG_PALM4),
285#undef UVISOR_DEV
286};
287
288static int
289uvisor_probe(device_t dev)
290{
291 struct usb_attach_arg *uaa = device_get_ivars(dev);
292
293 if (uaa->usb_mode != USB_MODE_HOST) {
294 return (ENXIO);
295 }
296 if (uaa->info.bConfigIndex != UVISOR_CONFIG_INDEX) {
297 return (ENXIO);
298 }
299 if (uaa->info.bIfaceIndex != UVISOR_IFACE_INDEX) {
300 return (ENXIO);
301 }
302 return (usbd_lookup_id_by_uaa(uvisor_devs, sizeof(uvisor_devs), uaa));
303}
304
305static int
306uvisor_attach(device_t dev)
307{
308 struct usb_attach_arg *uaa = device_get_ivars(dev);
309 struct uvisor_softc *sc = device_get_softc(dev);
310 struct usb_config uvisor_config_copy[UVISOR_N_TRANSFER];
311 int error;
312
313 DPRINTF("sc=%p\n", sc);
314 bcopy(uvisor_config, uvisor_config_copy,
315 sizeof(uvisor_config_copy));
316 device_set_usb_desc(dev);
317
318 mtx_init(&sc->sc_mtx, "uvisor", NULL, MTX_DEF);
319
320 sc->sc_udev = uaa->device;
321
322 /* configure the device */
323
324 sc->sc_flag = USB_GET_DRIVER_INFO(uaa);
325 sc->sc_iface_no = uaa->info.bIfaceNum;
326 sc->sc_iface_index = UVISOR_IFACE_INDEX;
327
328 error = uvisor_init(sc, uaa->device, uvisor_config_copy);
329
330 if (error) {
331 DPRINTF("init failed, error=%s\n",
332 usbd_errstr(error));
333 goto detach;
334 }
335 error = usbd_transfer_setup(uaa->device, &sc->sc_iface_index,
336 sc->sc_xfer, uvisor_config_copy, UVISOR_N_TRANSFER,
337 sc, &sc->sc_mtx);
338 if (error) {
339 DPRINTF("could not allocate all pipes\n");
340 goto detach;
341 }
342
343 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
344 &uvisor_callback, &sc->sc_mtx);
345 if (error) {
346 DPRINTF("ucom_attach failed\n");
347 goto detach;
348 }
349 return (0);
350
351detach:
352 uvisor_detach(dev);
353 return (ENXIO);
354}
355
356static int
357uvisor_detach(device_t dev)
358{
359 struct uvisor_softc *sc = device_get_softc(dev);
360
361 DPRINTF("sc=%p\n", sc);
362
363 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom, 1);
364 usbd_transfer_unsetup(sc->sc_xfer, UVISOR_N_TRANSFER);
365 mtx_destroy(&sc->sc_mtx);
366
367 return (0);
368}
369
370static usb_error_t
371uvisor_init(struct uvisor_softc *sc, struct usb_device *udev, struct usb_config *config)
372{
373 usb_error_t err = 0;
374 struct usb_device_request req;
375 struct uvisor_connection_info coninfo;
376 struct uvisor_palm_connection_info pconinfo;
377 uint16_t actlen;
378 uint8_t buffer[256];
379
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);
390
391 if (err) {
392 goto done;
393 }
394 }
|
396 if (sc->sc_flag & UVISOR_FLAG_VISOR) {
397 uint16_t i, np;
398 const char *desc;
399
400 np = UGETW(coninfo.num_ports);
401 if (np > UVISOR_MAX_CONN) {
402 np = UVISOR_MAX_CONN;
403 }
404 DPRINTF("Number of ports: %d\n", np);
405
406 for (i = 0; i < np; ++i) {
407 switch (coninfo.connections[i].port_function_id) {
408 case UVISOR_FUNCTION_GENERIC:
409 desc = "Generic";
410 break;
411 case UVISOR_FUNCTION_DEBUGGER:
412 desc = "Debugger";
413 break;
414 case UVISOR_FUNCTION_HOTSYNC:
415 desc = "HotSync";
416 break;
417 case UVISOR_FUNCTION_REMOTE_FILE_SYS:
418 desc = "Remote File System";
419 break;
420 default:
421 desc = "unknown";
422 break;
423 }
424 DPRINTF("Port %d is for %s\n",
425 coninfo.connections[i].port, desc);
426 }
427 }
428#endif
429
430 if (sc->sc_flag & UVISOR_FLAG_PALM4) {
431 uint8_t port;
432
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);
439
440 err = usbd_do_request_flags
441 (udev, NULL, &req, &pconinfo, USB_SHORT_XFER_OK,
442 &actlen, USB_DEFAULT_TIMEOUT);
443
444 if (err) {
445 goto done;
446 }
447 if (actlen < 12) {
448 DPRINTF("too little data\n");
449 err = USB_ERR_INVAL;
450 goto done;
451 }
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 */
456 } else {
457 port = pconinfo.connections[0].port;
458 config[0].endpoint = (port & 0xF); /* output */
459 config[1].endpoint = (port & 0xF); /* input */
460 }
461#if 0
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);
468 if (err) {
469 goto done;
470 }
471#endif
472 }
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);
481
482 err = usbd_do_request(udev, NULL, &req, buffer);
483 if (err) {
484 goto done;
485 }
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);
494 if (err) {
495 goto done;
496 }
497 }
498#if 0
499 uWord wAvail;
500
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);
508 if (err) {
509 goto done;
510 }
511 DPRINTF("avail=%d\n", UGETW(wAvail));
512#endif
513
514 DPRINTF("done\n");
515done:
516 return (err);
517}
518
519static void
520uvisor_cfg_open(struct ucom_softc *ucom)
521{
522 return;
523}
524
525static void
526uvisor_cfg_close(struct ucom_softc *ucom)
527{
528 struct uvisor_softc *sc = ucom->sc_parent;
529 uint8_t buffer[UVISOR_CONNECTION_INFO_SIZE];
530 struct usb_device_request req;
531 usb_error_t err;
532
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);
538
539 err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
540 &req, buffer, 0, 1000);
541 if (err) {
542 DPRINTFN(0, "close notification failed, error=%s\n",
543 usbd_errstr(err));
544 }
545}
546
547static void
548uvisor_start_read(struct ucom_softc *ucom)
549{
550 struct uvisor_softc *sc = ucom->sc_parent;
551
552 usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_RD]);
553}
554
555static void
556uvisor_stop_read(struct ucom_softc *ucom)
557{
558 struct uvisor_softc *sc = ucom->sc_parent;
559
560 usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_RD]);
561}
562
563static void
564uvisor_start_write(struct ucom_softc *ucom)
565{
566 struct uvisor_softc *sc = ucom->sc_parent;
567
568 usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_WR]);
569}
570
571static void
572uvisor_stop_write(struct ucom_softc *ucom)
573{
574 struct uvisor_softc *sc = ucom->sc_parent;
575
576 usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_WR]);
577}
578
579static void
580uvisor_write_callback(struct usb_xfer *xfer, usb_error_t error)
581{
582 struct uvisor_softc *sc = usbd_xfer_softc(xfer);
583 struct usb_page_cache *pc;
584 uint32_t actlen;
585 uint8_t x;
586
587 switch (USB_GET_STATE(xfer)) {
588 case USB_ST_SETUP:
589 case USB_ST_TRANSFERRED:
590tr_setup:
591 for (x = 0; x != UVISOROFRAMES; x++) {
592
593 usbd_xfer_set_frame_offset(xfer,
594 x * UVISOROBUFSIZE, x);
595
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);
600 } else {
601 break;
602 }
603 }
604 /* check for data */
605 if (x != 0) {
606 usbd_xfer_set_frames(xfer, x);
607 usbd_transfer_submit(xfer);
608 }
609 break;
610
611 default: /* Error */
612 if (error != USB_ERR_CANCELLED) {
613 /* try to clear stall first */
614 usbd_xfer_set_stall(xfer);
615 goto tr_setup;
616 }
617 break;
618 }
619}
620
621static void
622uvisor_read_callback(struct usb_xfer *xfer, usb_error_t error)
623{
624 struct uvisor_softc *sc = usbd_xfer_softc(xfer);
625 struct usb_page_cache *pc;
626 int actlen;
627
628 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
629
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);
634
635 case USB_ST_SETUP:
636tr_setup:
637 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
638 usbd_transfer_submit(xfer);
639 return;
640
641 default: /* Error */
642 if (error != USB_ERR_CANCELLED) {
643 /* try to clear stall first */
644 usbd_xfer_set_stall(xfer);
645 goto tr_setup;
646 }
647 return;
648 }
649}
|