uvisor.c revision 1.23
1 /* $NetBSD: uvisor.c,v 1.23 2003/11/07 21:27:56 carrel Exp $ */ 2 3 /* 4 * Copyright (c) 2000 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Lennart Augustsson (lennart (at) augustsson.net) at 9 * Carlstedt Research & Technology. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the NetBSD 22 * Foundation, Inc. and its contributors. 23 * 4. Neither the name of The NetBSD Foundation nor the names of its 24 * contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40 /* 41 * Handspring Visor (Palmpilot compatible PDA) driver 42 */ 43 44 #include <sys/cdefs.h> 45 __KERNEL_RCSID(0, "$NetBSD: uvisor.c,v 1.23 2003/11/07 21:27:56 carrel Exp $"); 46 47 #include <sys/param.h> 48 #include <sys/systm.h> 49 #include <sys/kernel.h> 50 #include <sys/device.h> 51 #include <sys/conf.h> 52 #include <sys/tty.h> 53 54 #include <dev/usb/usb.h> 55 #include <dev/usb/usbhid.h> 56 57 #include <dev/usb/usbdi.h> 58 #include <dev/usb/usbdi_util.h> 59 #include <dev/usb/usbdevs.h> 60 61 #include <dev/usb/ucomvar.h> 62 63 #ifdef UVISOR_DEBUG 64 #define DPRINTF(x) if (uvisordebug) printf x 65 #define DPRINTFN(n,x) if (uvisordebug>(n)) printf x 66 int uvisordebug = 0; 67 #else 68 #define DPRINTF(x) 69 #define DPRINTFN(n,x) 70 #endif 71 72 #define UVISOR_CONFIG_INDEX 0 73 #define UVISOR_IFACE_INDEX 0 74 75 /* From the Linux driver */ 76 /* 77 * UVISOR_REQUEST_BYTES_AVAILABLE asks the visor for the number of bytes that 78 * are available to be transfered to the host for the specified endpoint. 79 * Currently this is not used, and always returns 0x0001 80 */ 81 #define UVISOR_REQUEST_BYTES_AVAILABLE 0x01 82 83 /* 84 * UVISOR_CLOSE_NOTIFICATION is set to the device to notify it that the host 85 * is now closing the pipe. An empty packet is sent in response. 86 */ 87 #define UVISOR_CLOSE_NOTIFICATION 0x02 88 89 /* 90 * UVISOR_GET_CONNECTION_INFORMATION is sent by the host during enumeration to 91 * get the endpoints used by the connection. 92 */ 93 #define UVISOR_GET_CONNECTION_INFORMATION 0x03 94 95 96 /* 97 * UVISOR_GET_CONNECTION_INFORMATION returns data in the following format 98 */ 99 #define UVISOR_MAX_CONN 8 100 struct uvisor_connection_info { 101 uWord num_ports; 102 struct { 103 uByte port_function_id; 104 uByte port; 105 } connections[UVISOR_MAX_CONN]; 106 }; 107 #define UVISOR_CONNECTION_INFO_SIZE 18 108 109 /* struct uvisor_connection_info.connection[x].port_function_id defines: */ 110 #define UVISOR_FUNCTION_GENERIC 0x00 111 #define UVISOR_FUNCTION_DEBUGGER 0x01 112 #define UVISOR_FUNCTION_HOTSYNC 0x02 113 #define UVISOR_FUNCTION_CONSOLE 0x03 114 #define UVISOR_FUNCTION_REMOTE_FILE_SYS 0x04 115 116 /* 117 * Unknown PalmOS stuff. 118 */ 119 #define UVISOR_GET_PALM_INFORMATION 0x04 120 #define UVISOR_GET_PALM_INFORMATION_LEN 0x44 121 122 struct uvisor_palm_connection_info { 123 uByte num_ports; 124 uByte endpoint_numbers_different; 125 uWord reserved1; 126 struct { 127 uDWord port_function_id; 128 uByte port; 129 uByte end_point_info; 130 uWord reserved; 131 } connections[UVISOR_MAX_CONN]; 132 }; 133 134 135 136 #define UVISORIBUFSIZE 64 137 #define UVISOROBUFSIZE 1024 138 139 struct uvisor_softc { 140 USBBASEDEVICE sc_dev; /* base device */ 141 usbd_device_handle sc_udev; /* device */ 142 usbd_interface_handle sc_iface; /* interface */ 143 144 device_ptr_t sc_subdevs[UVISOR_MAX_CONN]; 145 int sc_numcon; 146 147 u_int16_t sc_flags; 148 149 u_char sc_dying; 150 }; 151 152 Static usbd_status uvisor_init(struct uvisor_softc *, 153 struct uvisor_connection_info *, 154 struct uvisor_palm_connection_info *); 155 156 Static void uvisor_close(void *, int); 157 158 159 struct ucom_methods uvisor_methods = { 160 NULL, 161 NULL, 162 NULL, 163 NULL, 164 NULL, 165 uvisor_close, 166 NULL, 167 NULL, 168 }; 169 170 struct uvisor_type { 171 struct usb_devno uv_dev; 172 u_int16_t uv_flags; 173 #define PALM4 0x0001 174 #define VISOR 0x0002 175 176 }; 177 static const struct uvisor_type uvisor_devs[] = { 178 {{ USB_VENDOR_HANDSPRING, USB_PRODUCT_HANDSPRING_VISOR }, VISOR }, 179 {{ USB_VENDOR_HANDSPRING, USB_PRODUCT_HANDSPRING_TREO }, PALM4 }, 180 {{ USB_VENDOR_HANDSPRING, USB_PRODUCT_HANDSPRING_TREO600 }, PALM4 }, 181 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_M500 }, PALM4 }, 182 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_M505 }, PALM4 }, 183 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_M515 }, PALM4 }, 184 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_I705 }, PALM4 }, 185 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_M125 }, PALM4 }, 186 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_M130 }, PALM4 }, 187 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_TUNGSTEN_Z }, PALM4 }, 188 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_TUNGSTEN_T }, PALM4 }, 189 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_ZIRE }, PALM4 }, 190 {{ USB_VENDOR_SONY, USB_PRODUCT_SONY_CLIE_40 }, PALM4 }, 191 {{ USB_VENDOR_SONY, USB_PRODUCT_SONY_CLIE_41 }, PALM4 }, 192 {{ USB_VENDOR_SONY, USB_PRODUCT_SONY_CLIE_S360 }, PALM4 }, 193 {{ USB_VENDOR_SONY, USB_PRODUCT_SONY_CLIE_NX60 }, PALM4 }, 194 /* {{ USB_VENDOR_SONY, USB_PRODUCT_SONY_CLIE_25 }, PALM4 },*/ 195 }; 196 #define uvisor_lookup(v, p) ((struct uvisor_type *)usb_lookup(uvisor_devs, v, p)) 197 198 USB_DECLARE_DRIVER(uvisor); 199 200 USB_MATCH(uvisor) 201 { 202 USB_MATCH_START(uvisor, uaa); 203 204 if (uaa->iface != NULL) 205 return (UMATCH_NONE); 206 207 DPRINTFN(20,("uvisor: vendor=0x%x, product=0x%x\n", 208 uaa->vendor, uaa->product)); 209 210 return (uvisor_lookup(uaa->vendor, uaa->product) != NULL ? 211 UMATCH_VENDOR_PRODUCT : UMATCH_NONE); 212 } 213 214 USB_ATTACH(uvisor) 215 { 216 USB_ATTACH_START(uvisor, sc, uaa); 217 usbd_device_handle dev = uaa->device; 218 usbd_interface_handle iface; 219 usb_interface_descriptor_t *id; 220 struct uvisor_connection_info coninfo; 221 struct uvisor_palm_connection_info palmconinfo; 222 usb_endpoint_descriptor_t *ed; 223 char devinfo[1024]; 224 char *devname = USBDEVNAME(sc->sc_dev); 225 int i, j, hasin, hasout, port; 226 usbd_status err; 227 struct ucom_attach_args uca; 228 229 DPRINTFN(10,("\nuvisor_attach: sc=%p\n", sc)); 230 231 /* Move the device into the configured state. */ 232 err = usbd_set_config_index(dev, UVISOR_CONFIG_INDEX, 1); 233 if (err) { 234 printf("\n%s: failed to set configuration, err=%s\n", 235 devname, usbd_errstr(err)); 236 goto bad; 237 } 238 239 err = usbd_device2interface_handle(dev, UVISOR_IFACE_INDEX, &iface); 240 if (err) { 241 printf("\n%s: failed to get interface, err=%s\n", 242 devname, usbd_errstr(err)); 243 goto bad; 244 } 245 246 usbd_devinfo(dev, 0, devinfo); 247 USB_ATTACH_SETUP; 248 printf("%s: %s\n", devname, devinfo); 249 250 sc->sc_flags = uvisor_lookup(uaa->vendor, uaa->product)->uv_flags; 251 252 if ((sc->sc_flags & (VISOR | PALM4)) == 0) { 253 printf("%s: init failed, device type is neither visor nor palm\n", 254 USBDEVNAME(sc->sc_dev)); 255 goto bad; 256 } 257 258 id = usbd_get_interface_descriptor(iface); 259 260 sc->sc_udev = dev; 261 sc->sc_iface = iface; 262 263 uca.ibufsize = UVISORIBUFSIZE; 264 uca.obufsize = UVISOROBUFSIZE; 265 uca.ibufsizepad = UVISORIBUFSIZE; 266 uca.opkthdrlen = 0; 267 uca.device = dev; 268 uca.iface = iface; 269 uca.methods = &uvisor_methods; 270 uca.arg = sc; 271 272 err = uvisor_init(sc, &coninfo, &palmconinfo); 273 if (err) { 274 printf("%s: init failed, %s\n", USBDEVNAME(sc->sc_dev), 275 usbd_errstr(err)); 276 goto bad; 277 } 278 279 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, 280 USBDEV(sc->sc_dev)); 281 282 if (sc->sc_flags & VISOR) { 283 sc->sc_numcon = UGETW(coninfo.num_ports); 284 if (sc->sc_numcon > UVISOR_MAX_CONN) 285 sc->sc_numcon = UVISOR_MAX_CONN; 286 287 /* Attach a ucom for each connection. */ 288 for (i = 0; i < sc->sc_numcon; ++i) { 289 switch (coninfo.connections[i].port_function_id) { 290 case UVISOR_FUNCTION_GENERIC: 291 uca.info = "Generic"; 292 break; 293 case UVISOR_FUNCTION_DEBUGGER: 294 uca.info = "Debugger"; 295 break; 296 case UVISOR_FUNCTION_HOTSYNC: 297 uca.info = "HotSync"; 298 break; 299 case UVISOR_FUNCTION_REMOTE_FILE_SYS: 300 uca.info = "Remote File System"; 301 break; 302 default: 303 uca.info = "unknown"; 304 break; 305 } 306 port = coninfo.connections[i].port; 307 uca.portno = port; 308 uca.bulkin = port | UE_DIR_IN; 309 uca.bulkout = port | UE_DIR_OUT; 310 /* Verify that endpoints exist. */ 311 hasin = 0; 312 hasout = 0; 313 for (j = 0; j < id->bNumEndpoints; j++) { 314 ed = usbd_interface2endpoint_descriptor(iface, j); 315 if (ed == NULL) 316 break; 317 if (UE_GET_ADDR(ed->bEndpointAddress) == port && 318 (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) { 319 if (UE_GET_DIR(ed->bEndpointAddress) 320 == UE_DIR_IN) 321 hasin++; 322 else 323 hasout++; 324 } 325 } 326 if (hasin == 1 && hasout == 1) 327 sc->sc_subdevs[i] = config_found_sm(self, &uca, 328 ucomprint, ucomsubmatch); 329 else 330 printf("%s: no proper endpoints for port %d (%d,%d)\n", 331 USBDEVNAME(sc->sc_dev), port, hasin, hasout); 332 } 333 334 } else { 335 sc->sc_numcon = palmconinfo.num_ports; 336 if (sc->sc_numcon > UVISOR_MAX_CONN) 337 sc->sc_numcon = UVISOR_MAX_CONN; 338 339 /* Attach a ucom for each connection. */ 340 for (i = 0; i < sc->sc_numcon; ++i) { 341 /* 342 * XXX this should copy out 4-char string from the 343 * XXX port_function_id, but where would the string go? 344 * XXX uca.info is a const char *, not an array. 345 */ 346 uca.info = "sync"; 347 uca.portno = i; 348 if (palmconinfo.endpoint_numbers_different) { 349 port = palmconinfo.connections[i].end_point_info; 350 uca.bulkin = (port >> 4) | UE_DIR_IN; 351 uca.bulkout = (port & 0xf) | UE_DIR_OUT; 352 } else { 353 port = palmconinfo.connections[i].port; 354 uca.bulkin = port | UE_DIR_IN; 355 uca.bulkout = port | UE_DIR_OUT; 356 } 357 sc->sc_subdevs[i] = config_found_sm(self, &uca, 358 ucomprint, ucomsubmatch); 359 360 361 } 362 } 363 364 USB_ATTACH_SUCCESS_RETURN; 365 366 bad: 367 DPRINTF(("uvisor_attach: ATTACH ERROR\n")); 368 sc->sc_dying = 1; 369 USB_ATTACH_ERROR_RETURN; 370 } 371 372 int 373 uvisor_activate(device_ptr_t self, enum devact act) 374 { 375 struct uvisor_softc *sc = (struct uvisor_softc *)self; 376 int rv = 0; 377 int i; 378 379 switch (act) { 380 case DVACT_ACTIVATE: 381 return (EOPNOTSUPP); 382 break; 383 384 case DVACT_DEACTIVATE: 385 for (i = 0; i < sc->sc_numcon; i++) 386 if (sc->sc_subdevs[i] != NULL) 387 rv |= config_deactivate(sc->sc_subdevs[i]); 388 sc->sc_dying = 1; 389 break; 390 } 391 return (rv); 392 } 393 394 int 395 uvisor_detach(device_ptr_t self, int flags) 396 { 397 struct uvisor_softc *sc = (struct uvisor_softc *)self; 398 int rv = 0; 399 int i; 400 401 DPRINTF(("uvisor_detach: sc=%p flags=%d\n", sc, flags)); 402 sc->sc_dying = 1; 403 for (i = 0; i < sc->sc_numcon; i++) { 404 if (sc->sc_subdevs[i] != NULL) { 405 rv |= config_detach(sc->sc_subdevs[i], flags); 406 sc->sc_subdevs[i] = NULL; 407 } 408 } 409 410 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, 411 USBDEV(sc->sc_dev)); 412 413 414 return (rv); 415 } 416 417 usbd_status 418 uvisor_init(struct uvisor_softc *sc, struct uvisor_connection_info *ci, 419 struct uvisor_palm_connection_info *cpi) 420 { 421 usbd_status err; 422 usb_device_request_t req; 423 int actlen; 424 uWord avail; 425 426 if (sc->sc_flags & VISOR) { 427 DPRINTF(("uvisor_init: getting Visor connection info\n")); 428 req.bmRequestType = UT_READ_VENDOR_ENDPOINT; 429 req.bRequest = UVISOR_GET_CONNECTION_INFORMATION; 430 USETW(req.wValue, 0); 431 USETW(req.wIndex, 0); 432 USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE); 433 err = usbd_do_request_flags(sc->sc_udev, &req, ci, 434 USBD_SHORT_XFER_OK, &actlen, USBD_DEFAULT_TIMEOUT); 435 if (err) 436 return (err); 437 } 438 439 if (sc->sc_flags & PALM4) { 440 DPRINTF(("uvisor_init: getting Palm connection info\n")); 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); 446 err = usbd_do_request_flags(sc->sc_udev, &req, cpi, 447 USBD_SHORT_XFER_OK, &actlen, USBD_DEFAULT_TIMEOUT); 448 if (err) 449 return (err); 450 } 451 452 DPRINTF(("uvisor_init: getting available bytes\n")); 453 req.bmRequestType = UT_READ_VENDOR_ENDPOINT; 454 req.bRequest = UVISOR_REQUEST_BYTES_AVAILABLE; 455 USETW(req.wValue, 0); 456 USETW(req.wIndex, 5); 457 USETW(req.wLength, sizeof avail); 458 err = usbd_do_request(sc->sc_udev, &req, &avail); 459 if (err) 460 return (err); 461 DPRINTF(("uvisor_init: avail=%d\n", UGETW(avail))); 462 463 DPRINTF(("uvisor_init: done\n")); 464 return (err); 465 } 466 467 void 468 uvisor_close(void *addr, int portno) 469 { 470 struct uvisor_softc *sc = addr; 471 usb_device_request_t req; 472 struct uvisor_connection_info coninfo; /* XXX ? */ 473 int actlen; 474 475 if (sc->sc_dying) 476 return; 477 478 req.bmRequestType = UT_READ_VENDOR_ENDPOINT; /* XXX read? */ 479 req.bRequest = UVISOR_CLOSE_NOTIFICATION; 480 USETW(req.wValue, 0); 481 USETW(req.wIndex, 0); 482 USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE); 483 (void)usbd_do_request_flags(sc->sc_udev, &req, &coninfo, 484 USBD_SHORT_XFER_OK, &actlen, USBD_DEFAULT_TIMEOUT); 485 } 486
Indexes created Tue Sep 30 20:09:53 GMT 2025