uvisor.c revision 1.21
1 /* $NetBSD: uvisor.c,v 1.21 2003/08/03 21:59:26 nathanw 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.21 2003/08/03 21:59:26 nathanw 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_PALM, USB_PRODUCT_PALM_M500 }, PALM4 }, 181 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_M505 }, PALM4 }, 182 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_M515 }, PALM4 }, 183 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_I705 }, PALM4 }, 184 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_M125 }, PALM4 }, 185 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_M130 }, PALM4 }, 186 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_TUNGSTEN_Z }, PALM4 }, 187 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_TUNGSTEN_T }, PALM4 }, 188 {{ USB_VENDOR_PALM, USB_PRODUCT_PALM_ZIRE }, PALM4 }, 189 {{ USB_VENDOR_SONY, USB_PRODUCT_SONY_CLIE_40 }, PALM4 }, 190 {{ USB_VENDOR_SONY, USB_PRODUCT_SONY_CLIE_41 }, PALM4 }, 191 {{ USB_VENDOR_SONY, USB_PRODUCT_SONY_CLIE_S360 }, PALM4 }, 192 {{ USB_VENDOR_SONY, USB_PRODUCT_SONY_CLIE_NX60 }, PALM4 }, 193 /* {{ USB_VENDOR_SONY, USB_PRODUCT_SONY_CLIE_25 }, PALM4 },*/ 194 }; 195 #define uvisor_lookup(v, p) ((struct uvisor_type *)usb_lookup(uvisor_devs, v, p)) 196 197 USB_DECLARE_DRIVER(uvisor); 198 199 USB_MATCH(uvisor) 200 { 201 USB_MATCH_START(uvisor, uaa); 202 203 if (uaa->iface != NULL) 204 return (UMATCH_NONE); 205 206 DPRINTFN(20,("uvisor: vendor=0x%x, product=0x%x\n", 207 uaa->vendor, uaa->product)); 208 209 return (uvisor_lookup(uaa->vendor, uaa->product) != NULL ? 210 UMATCH_VENDOR_PRODUCT : UMATCH_NONE); 211 } 212 213 USB_ATTACH(uvisor) 214 { 215 USB_ATTACH_START(uvisor, sc, uaa); 216 usbd_device_handle dev = uaa->device; 217 usbd_interface_handle iface; 218 usb_interface_descriptor_t *id; 219 struct uvisor_connection_info coninfo; 220 struct uvisor_palm_connection_info palmconinfo; 221 usb_endpoint_descriptor_t *ed; 222 char devinfo[1024]; 223 char *devname = USBDEVNAME(sc->sc_dev); 224 int i, j, hasin, hasout, port; 225 usbd_status err; 226 struct ucom_attach_args uca; 227 228 DPRINTFN(10,("\nuvisor_attach: sc=%p\n", sc)); 229 230 /* Move the device into the configured state. */ 231 err = usbd_set_config_index(dev, UVISOR_CONFIG_INDEX, 1); 232 if (err) { 233 printf("\n%s: failed to set configuration, err=%s\n", 234 devname, usbd_errstr(err)); 235 goto bad; 236 } 237 238 err = usbd_device2interface_handle(dev, UVISOR_IFACE_INDEX, &iface); 239 if (err) { 240 printf("\n%s: failed to get interface, err=%s\n", 241 devname, usbd_errstr(err)); 242 goto bad; 243 } 244 245 usbd_devinfo(dev, 0, devinfo); 246 USB_ATTACH_SETUP; 247 printf("%s: %s\n", devname, devinfo); 248 249 sc->sc_flags = uvisor_lookup(uaa->vendor, uaa->product)->uv_flags; 250 251 if ((sc->sc_flags & (VISOR | PALM4)) == 0) { 252 printf("%s: init failed, device type is neither visor nor palm\n", 253 USBDEVNAME(sc->sc_dev)); 254 goto bad; 255 } 256 257 id = usbd_get_interface_descriptor(iface); 258 259 sc->sc_udev = dev; 260 sc->sc_iface = iface; 261 262 uca.ibufsize = UVISORIBUFSIZE; 263 uca.obufsize = UVISOROBUFSIZE; 264 uca.ibufsizepad = UVISORIBUFSIZE; 265 uca.opkthdrlen = 0; 266 uca.device = dev; 267 uca.iface = iface; 268 uca.methods = &uvisor_methods; 269 uca.arg = sc; 270 271 err = uvisor_init(sc, &coninfo, &palmconinfo); 272 if (err) { 273 printf("%s: init failed, %s\n", USBDEVNAME(sc->sc_dev), 274 usbd_errstr(err)); 275 goto bad; 276 } 277 278 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, 279 USBDEV(sc->sc_dev)); 280 281 if (sc->sc_flags & VISOR) { 282 sc->sc_numcon = UGETW(coninfo.num_ports); 283 if (sc->sc_numcon > UVISOR_MAX_CONN) 284 sc->sc_numcon = UVISOR_MAX_CONN; 285 286 /* Attach a ucom for each connection. */ 287 for (i = 0; i < sc->sc_numcon; ++i) { 288 switch (coninfo.connections[i].port_function_id) { 289 case UVISOR_FUNCTION_GENERIC: 290 uca.info = "Generic"; 291 break; 292 case UVISOR_FUNCTION_DEBUGGER: 293 uca.info = "Debugger"; 294 break; 295 case UVISOR_FUNCTION_HOTSYNC: 296 uca.info = "HotSync"; 297 break; 298 case UVISOR_FUNCTION_REMOTE_FILE_SYS: 299 uca.info = "Remote File System"; 300 break; 301 default: 302 uca.info = "unknown"; 303 break; 304 } 305 port = coninfo.connections[i].port; 306 uca.portno = port; 307 uca.bulkin = port | UE_DIR_IN; 308 uca.bulkout = port | UE_DIR_OUT; 309 /* Verify that endpoints exist. */ 310 hasin = 0; 311 hasout = 0; 312 for (j = 0; j < id->bNumEndpoints; j++) { 313 ed = usbd_interface2endpoint_descriptor(iface, j); 314 if (ed == NULL) 315 break; 316 if (UE_GET_ADDR(ed->bEndpointAddress) == port && 317 (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) { 318 if (UE_GET_DIR(ed->bEndpointAddress) 319 == UE_DIR_IN) 320 hasin++; 321 else 322 hasout++; 323 } 324 } 325 if (hasin == 1 && hasout == 1) 326 sc->sc_subdevs[i] = config_found_sm(self, &uca, 327 ucomprint, ucomsubmatch); 328 else 329 printf("%s: no proper endpoints for port %d (%d,%d)\n", 330 USBDEVNAME(sc->sc_dev), port, hasin, hasout); 331 } 332 333 } else { 334 sc->sc_numcon = palmconinfo.num_ports; 335 if (sc->sc_numcon > UVISOR_MAX_CONN) 336 sc->sc_numcon = UVISOR_MAX_CONN; 337 338 /* Attach a ucom for each connection. */ 339 for (i = 0; i < sc->sc_numcon; ++i) { 340 /* 341 * XXX this should copy out 4-char string from the 342 * XXX port_function_id, but where would the string go? 343 * XXX uca.info is a const char *, not an array. 344 */ 345 uca.info = "sync"; 346 uca.portno = i; 347 if (palmconinfo.endpoint_numbers_different) { 348 port = palmconinfo.connections[i].end_point_info; 349 uca.bulkin = (port >> 4) | UE_DIR_IN; 350 uca.bulkout = (port & 0xf) | UE_DIR_OUT; 351 } else { 352 port = palmconinfo.connections[i].port; 353 uca.bulkin = port | UE_DIR_IN; 354 uca.bulkout = port | UE_DIR_OUT; 355 } 356 sc->sc_subdevs[i] = config_found_sm(self, &uca, 357 ucomprint, ucomsubmatch); 358 359 360 } 361 } 362 363 USB_ATTACH_SUCCESS_RETURN; 364 365 bad: 366 DPRINTF(("uvisor_attach: ATTACH ERROR\n")); 367 sc->sc_dying = 1; 368 USB_ATTACH_ERROR_RETURN; 369 } 370 371 int 372 uvisor_activate(device_ptr_t self, enum devact act) 373 { 374 struct uvisor_softc *sc = (struct uvisor_softc *)self; 375 int rv = 0; 376 int i; 377 378 switch (act) { 379 case DVACT_ACTIVATE: 380 return (EOPNOTSUPP); 381 break; 382 383 case DVACT_DEACTIVATE: 384 for (i = 0; i < sc->sc_numcon; i++) 385 if (sc->sc_subdevs[i] != NULL) 386 rv = config_deactivate(sc->sc_subdevs[i]); 387 sc->sc_dying = 1; 388 break; 389 } 390 return (rv); 391 } 392 393 int 394 uvisor_detach(device_ptr_t self, int flags) 395 { 396 struct uvisor_softc *sc = (struct uvisor_softc *)self; 397 int rv = 0; 398 int i; 399 400 DPRINTF(("uvisor_detach: sc=%p flags=%d\n", sc, flags)); 401 sc->sc_dying = 1; 402 for (i = 0; i < sc->sc_numcon; i++) { 403 if (sc->sc_subdevs[i] != NULL) { 404 rv |= config_detach(sc->sc_subdevs[i], flags); 405 sc->sc_subdevs[i] = NULL; 406 } 407 } 408 409 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, 410 USBDEV(sc->sc_dev)); 411 412 413 return (rv); 414 } 415 416 usbd_status 417 uvisor_init(struct uvisor_softc *sc, struct uvisor_connection_info *ci, 418 struct uvisor_palm_connection_info *cpi) 419 { 420 usbd_status err; 421 usb_device_request_t req; 422 int actlen; 423 uWord avail; 424 425 if (sc->sc_flags & VISOR) { 426 DPRINTF(("uvisor_init: getting Visor connection info\n")); 427 req.bmRequestType = UT_READ_VENDOR_ENDPOINT; 428 req.bRequest = UVISOR_GET_CONNECTION_INFORMATION; 429 USETW(req.wValue, 0); 430 USETW(req.wIndex, 0); 431 USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE); 432 err = usbd_do_request_flags(sc->sc_udev, &req, ci, 433 USBD_SHORT_XFER_OK, &actlen, USBD_DEFAULT_TIMEOUT); 434 if (err) 435 return (err); 436 } 437 438 if (sc->sc_flags & PALM4) { 439 DPRINTF(("uvisor_init: getting Palm connection info\n")); 440 req.bmRequestType = UT_READ_VENDOR_ENDPOINT; 441 req.bRequest = UVISOR_GET_PALM_INFORMATION; 442 USETW(req.wValue, 0); 443 USETW(req.wIndex, 0); 444 USETW(req.wLength, UVISOR_GET_PALM_INFORMATION_LEN); 445 err = usbd_do_request_flags(sc->sc_udev, &req, cpi, 446 USBD_SHORT_XFER_OK, &actlen, USBD_DEFAULT_TIMEOUT); 447 if (err) 448 return (err); 449 } 450 451 DPRINTF(("uvisor_init: getting available bytes\n")); 452 req.bmRequestType = UT_READ_VENDOR_ENDPOINT; 453 req.bRequest = UVISOR_REQUEST_BYTES_AVAILABLE; 454 USETW(req.wValue, 0); 455 USETW(req.wIndex, 5); 456 USETW(req.wLength, sizeof avail); 457 err = usbd_do_request(sc->sc_udev, &req, &avail); 458 if (err) 459 return (err); 460 DPRINTF(("uvisor_init: avail=%d\n", UGETW(avail))); 461 462 DPRINTF(("uvisor_init: done\n")); 463 return (err); 464 } 465 466 void 467 uvisor_close(void *addr, int portno) 468 { 469 struct uvisor_softc *sc = addr; 470 usb_device_request_t req; 471 struct uvisor_connection_info coninfo; /* XXX ? */ 472 int actlen; 473 474 if (sc->sc_dying) 475 return; 476 477 req.bmRequestType = UT_READ_VENDOR_ENDPOINT; /* XXX read? */ 478 req.bRequest = UVISOR_CLOSE_NOTIFICATION; 479 USETW(req.wValue, 0); 480 USETW(req.wIndex, 0); 481 USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE); 482 (void)usbd_do_request_flags(sc->sc_udev, &req, &coninfo, 483 USBD_SHORT_XFER_OK, &actlen, USBD_DEFAULT_TIMEOUT); 484 } 485
Indexes created Tue Sep 30 20:09:53 GMT 2025