1 /* $OpenBSD: uow.c,v 1.30 2011/07/03 15:47:17 matthew Exp $ */ 2 3 /* 4 * Copyright (c) 2006 Alexander Yurchenko <grange@openbsd.org> 5 * 6 * Permission to use, copy, modify, and distribute this software for any 7 * purpose with or without fee is hereby granted, provided that the above 8 * copyright notice and this permission notice appear in all copies. 9 * 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19 /* 20 * Maxim/Dallas DS2490 USB 1-Wire adapter driver. 21 */ 22 23 #include <sys/param.h> 24 #include <sys/systm.h> 25 #include <sys/device.h> 26 #include <sys/kernel.h> 27 #include <sys/proc.h> 28 29 #include <dev/onewire/onewirereg.h> 30 #include <dev/onewire/onewirevar.h> 31 32 #include <dev/usb/usb.h> 33 #include <dev/usb/usbdevs.h> 34 #include <dev/usb/usbdi.h> 35 #include <dev/usb/usbdi_util.h> 36 37 #include <dev/usb/uowreg.h> 38 39 #define UOW_TIMEOUT 1000 /* ms */ 40 41 struct uow_softc { 42 struct device sc_dev; 43 44 struct onewire_bus sc_ow_bus; 45 struct device *sc_ow_dev; 46 47 usbd_device_handle sc_udev; 48 usbd_interface_handle sc_iface; 49 usbd_pipe_handle sc_ph_ibulk; 50 usbd_pipe_handle sc_ph_obulk; 51 usbd_pipe_handle sc_ph_intr; 52 u_int8_t sc_regs[DS2490_NREGS]; 53 usbd_xfer_handle sc_xfer; 54 u_int8_t sc_fifo[DS2490_DATAFIFOSIZE]; 55 }; 56 57 int uow_match(struct device *, void *, void *); 58 void uow_attach(struct device *, struct device *, void *); 59 int uow_detach(struct device *, int); 60 int uow_activate(struct device *, int); 61 62 struct cfdriver uow_cd = { 63 NULL, "uow", DV_DULL 64 }; 65 66 const struct cfattach uow_ca = { 67 sizeof(struct uow_softc), 68 uow_match, 69 uow_attach, 70 uow_detach, 71 uow_activate, 72 }; 73 74 /* List of supported devices */ 75 static const struct usb_devno uow_devs[] = { 76 { USB_VENDOR_DALLAS, USB_PRODUCT_DALLAS_USB_FOB_IBUTTON } 77 }; 78 79 int uow_ow_reset(void *); 80 int uow_ow_bit(void *, int); 81 int uow_ow_read_byte(void *); 82 void uow_ow_write_byte(void *, int); 83 void uow_ow_read_block(void *, void *, int); 84 void uow_ow_write_block(void *, const void *, int); 85 void uow_ow_matchrom(void *, u_int64_t); 86 int uow_ow_search(void *, u_int64_t *, int, u_int64_t); 87 88 int uow_cmd(struct uow_softc *, int, int, int); 89 #define uow_ctlcmd(s, c, p) uow_cmd((s), DS2490_CONTROL_CMD, (c), (p)) 90 #define uow_commcmd(s, c, p) uow_cmd((s), DS2490_COMM_CMD, (c), (p)) 91 #define uow_modecmd(s, c, p) uow_cmd((s), DS2490_MODE_CMD, (c), (p)) 92 93 void uow_intr(usbd_xfer_handle, usbd_private_handle, usbd_status); 94 int uow_read(struct uow_softc *, void *, int); 95 int uow_write(struct uow_softc *, const void *, int); 96 int uow_reset(struct uow_softc *); 97 98 int 99 uow_match(struct device *parent, void *match, void *aux) 100 { 101 struct usb_attach_arg *uaa = aux; 102 103 if (uaa->iface != NULL) 104 return (UMATCH_NONE); 105 106 return ((usb_lookup(uow_devs, uaa->vendor, uaa->product) != NULL) ? 107 UMATCH_VENDOR_PRODUCT : UMATCH_NONE); 108 } 109 110 void 111 uow_attach(struct device *parent, struct device *self, void *aux) 112 { 113 struct uow_softc *sc = (struct uow_softc *)self; 114 struct usb_attach_arg *uaa = aux; 115 usb_interface_descriptor_t *id; 116 usb_endpoint_descriptor_t *ed; 117 int ep_ibulk = -1, ep_obulk = -1, ep_intr = -1; 118 struct onewirebus_attach_args oba; 119 usbd_status error; 120 int i; 121 122 sc->sc_udev = uaa->device; 123 124 /* Set USB configuration */ 125 if ((error = usbd_set_config_no(sc->sc_udev, 126 DS2490_USB_CONFIG, 0)) != 0) { 127 printf("%s: failed to set config %d: %s\n", 128 sc->sc_dev.dv_xname, DS2490_USB_CONFIG, 129 usbd_errstr(error)); 130 return; 131 } 132 133 /* Get interface handle */ 134 if ((error = usbd_device2interface_handle(sc->sc_udev, 135 DS2490_USB_IFACE, &sc->sc_iface)) != 0) { 136 printf("%s: failed to get iface %d: %s\n", 137 sc->sc_dev.dv_xname, DS2490_USB_IFACE, 138 usbd_errstr(error)); 139 return; 140 } 141 142 /* Find endpoints */ 143 id = usbd_get_interface_descriptor(sc->sc_iface); 144 for (i = 0; i < id->bNumEndpoints; i++) { 145 ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i); 146 if (ed == NULL) { 147 printf("%s: failed to get endpoint %d descriptor\n", 148 sc->sc_dev.dv_xname, i); 149 return; 150 } 151 152 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 153 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) 154 ep_ibulk = ed->bEndpointAddress; 155 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT && 156 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) 157 ep_obulk = ed->bEndpointAddress; 158 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 159 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) 160 ep_intr = ed->bEndpointAddress; 161 } 162 if (ep_ibulk == -1 || ep_obulk == -1 || ep_intr == -1) { 163 printf("%s: missing endpoint: ibulk %d, obulk %d, intr %d\n", 164 sc->sc_dev.dv_xname, ep_ibulk, ep_obulk, ep_intr); 165 return; 166 } 167 168 /* Open pipes */ 169 if ((error = usbd_open_pipe(sc->sc_iface, ep_ibulk, USBD_EXCLUSIVE_USE, 170 &sc->sc_ph_ibulk)) != 0) { 171 printf("%s: failed to open bulk-in pipe: %s\n", 172 sc->sc_dev.dv_xname, usbd_errstr(error)); 173 return; 174 } 175 if ((error = usbd_open_pipe(sc->sc_iface, ep_obulk, USBD_EXCLUSIVE_USE, 176 &sc->sc_ph_obulk)) != 0) { 177 printf("%s: failed to open bulk-out pipe: %s\n", 178 sc->sc_dev.dv_xname, usbd_errstr(error)); 179 goto fail; 180 } 181 if ((error = usbd_open_pipe_intr(sc->sc_iface, ep_intr, 182 USBD_SHORT_XFER_OK, &sc->sc_ph_intr, sc, 183 sc->sc_regs, sizeof(sc->sc_regs), uow_intr, 184 USBD_DEFAULT_INTERVAL)) != 0) { 185 printf("%s: failed to open intr pipe: %s\n", 186 sc->sc_dev.dv_xname, usbd_errstr(error)); 187 goto fail; 188 } 189 190 #if 0 191 /* Allocate xfer for bulk transfers */ 192 if ((sc->sc_xfer = usbd_alloc_xfer(sc->sc_udev)) == NULL) { 193 printf("%s: failed to alloc bulk xfer\n", 194 sc->sc_dev.dv_xname); 195 goto fail; 196 } 197 #endif 198 199 memset(sc->sc_fifo, 0xff, sizeof(sc->sc_fifo)); 200 201 /* Reset device */ 202 uow_reset(sc); 203 204 /* Attach 1-Wire bus */ 205 sc->sc_ow_bus.bus_cookie = sc; 206 sc->sc_ow_bus.bus_reset = uow_ow_reset; 207 sc->sc_ow_bus.bus_bit = uow_ow_bit; 208 sc->sc_ow_bus.bus_read_byte = uow_ow_read_byte; 209 sc->sc_ow_bus.bus_write_byte = uow_ow_write_byte; 210 sc->sc_ow_bus.bus_read_block = uow_ow_read_block; 211 sc->sc_ow_bus.bus_write_block = uow_ow_write_block; 212 sc->sc_ow_bus.bus_matchrom = uow_ow_matchrom; 213 #if 0 214 sc->sc_ow_bus.bus_search = uow_ow_search; 215 #endif 216 217 bzero(&oba, sizeof(oba)); 218 oba.oba_bus = &sc->sc_ow_bus; 219 sc->sc_ow_dev = config_found(self, &oba, onewirebus_print); 220 221 return; 222 223 fail: 224 if (sc->sc_ph_ibulk != NULL) 225 usbd_close_pipe(sc->sc_ph_ibulk); 226 if (sc->sc_ph_obulk != NULL) 227 usbd_close_pipe(sc->sc_ph_obulk); 228 if (sc->sc_ph_intr != NULL) 229 usbd_close_pipe(sc->sc_ph_intr); 230 if (sc->sc_xfer != NULL) 231 usbd_free_xfer(sc->sc_xfer); 232 } 233 234 int 235 uow_detach(struct device *self, int flags) 236 { 237 struct uow_softc *sc = (struct uow_softc *)self; 238 int rv = 0, s; 239 240 s = splusb(); 241 242 if (sc->sc_ph_ibulk != NULL) { 243 usbd_abort_pipe(sc->sc_ph_ibulk); 244 usbd_close_pipe(sc->sc_ph_ibulk); 245 } 246 if (sc->sc_ph_obulk != NULL) { 247 usbd_abort_pipe(sc->sc_ph_obulk); 248 usbd_close_pipe(sc->sc_ph_obulk); 249 } 250 if (sc->sc_ph_intr != NULL) { 251 usbd_abort_pipe(sc->sc_ph_intr); 252 usbd_close_pipe(sc->sc_ph_intr); 253 } 254 255 if (sc->sc_xfer != NULL) 256 usbd_free_xfer(sc->sc_xfer); 257 258 if (sc->sc_ow_dev != NULL) 259 rv = config_detach(sc->sc_ow_dev, flags); 260 261 splx(s); 262 263 return (rv); 264 } 265 266 int 267 uow_activate(struct device *self, int act) 268 { 269 struct uow_softc *sc = (struct uow_softc *)self; 270 int rv = 0; 271 272 switch (act) { 273 case DVACT_DEACTIVATE: 274 if (sc->sc_ow_dev != NULL) 275 rv = config_deactivate(sc->sc_ow_dev); 276 usbd_deactivate(sc->sc_udev); 277 break; 278 } 279 280 return (rv); 281 } 282 283 int 284 uow_ow_reset(void *arg) 285 { 286 struct uow_softc *sc = arg; 287 288 if (uow_commcmd(sc, DS2490_COMM_1WIRE_RESET | DS2490_BIT_IM, 0) != 0) 289 return (1); 290 291 /* XXX: check presence pulse */ 292 return (0); 293 } 294 295 int 296 uow_ow_bit(void *arg, int value) 297 { 298 struct uow_softc *sc = arg; 299 u_int8_t data; 300 301 if (uow_commcmd(sc, DS2490_COMM_BIT_IO | DS2490_BIT_IM | 302 (value ? DS2490_BIT_D : 0), 0) != 0) 303 return (1); 304 if (uow_read(sc, &data, 1) != 1) 305 return (1); 306 307 return (data); 308 } 309 310 int 311 uow_ow_read_byte(void *arg) 312 { 313 struct uow_softc *sc = arg; 314 u_int8_t data; 315 316 if (uow_commcmd(sc, DS2490_COMM_BYTE_IO | DS2490_BIT_IM, 0xff) != 0) 317 return (-1); 318 if (uow_read(sc, &data, 1) != 1) 319 return (-1); 320 321 return (data); 322 } 323 324 void 325 uow_ow_write_byte(void *arg, int value) 326 { 327 struct uow_softc *sc = arg; 328 u_int8_t data; 329 330 if (uow_commcmd(sc, DS2490_COMM_BYTE_IO | DS2490_BIT_IM, value) != 0) 331 return; 332 uow_read(sc, &data, sizeof(data)); 333 } 334 335 void 336 uow_ow_read_block(void *arg, void *buf, int len) 337 { 338 struct uow_softc *sc = arg; 339 340 if (uow_write(sc, sc->sc_fifo, len) != 0) 341 return; 342 if (uow_commcmd(sc, DS2490_COMM_BLOCK_IO | DS2490_BIT_IM, len) != 0) 343 return; 344 uow_read(sc, buf, len); 345 } 346 347 void 348 uow_ow_write_block(void *arg, const void *buf, int len) 349 { 350 struct uow_softc *sc = arg; 351 352 if (uow_write(sc, buf, len) != 0) 353 return; 354 if (uow_commcmd(sc, DS2490_COMM_BLOCK_IO | DS2490_BIT_IM, len) != 0) 355 return; 356 } 357 358 void 359 uow_ow_matchrom(void *arg, u_int64_t rom) 360 { 361 struct uow_softc *sc = arg; 362 u_int8_t data[8]; 363 int i; 364 365 for (i = 0; i < 8; i++) 366 data[i] = (rom >> (i * 8)) & 0xff; 367 368 if (uow_write(sc, data, 8) != 0) 369 return; 370 if (uow_commcmd(sc, DS2490_COMM_MATCH_ACCESS | DS2490_BIT_IM, 371 ONEWIRE_CMD_MATCH_ROM) != 0) 372 return; 373 } 374 375 int 376 uow_ow_search(void *arg, u_int64_t *buf, int size, u_int64_t startrom) 377 { 378 struct uow_softc *sc = arg; 379 u_int8_t data[8]; 380 int i, rv; 381 382 for (i = 0; i < 8; i++) 383 data[i] = (startrom >> (i * 8)) & 0xff; 384 385 if (uow_write(sc, data, 8) != 0) 386 return (-1); 387 if (uow_commcmd(sc, DS2490_COMM_SEARCH_ACCESS | DS2490_BIT_IM | 388 DS2490_BIT_SM | DS2490_BIT_RST | DS2490_BIT_F, size << 8 | 389 ONEWIRE_CMD_SEARCH_ROM) != 0) 390 return (-1); 391 392 if ((rv = uow_read(sc, buf, size * 8)) == -1) 393 return (-1); 394 395 return (rv / 8); 396 } 397 398 int 399 uow_cmd(struct uow_softc *sc, int type, int cmd, int param) 400 { 401 usb_device_request_t req; 402 usbd_status error; 403 404 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 405 req.bRequest = type; 406 USETW(req.wValue, cmd); 407 USETW(req.wIndex, param); 408 USETW(req.wLength, 0); 409 if ((error = usbd_do_request(sc->sc_udev, &req, NULL)) != 0) { 410 printf("%s: cmd failed, type 0x%02x, cmd 0x%04x, " 411 "param 0x%04x: %s\n", sc->sc_dev.dv_xname, type, cmd, 412 param, usbd_errstr(error)); 413 if (cmd != DS2490_CTL_RESET_DEVICE) 414 uow_reset(sc); 415 return (1); 416 } 417 418 again: 419 if (tsleep(sc->sc_regs, PRIBIO, "uowcmd", 420 (UOW_TIMEOUT * hz) / 1000) != 0) { 421 printf("%s: cmd timeout, type 0x%02x, cmd 0x%04x, " 422 "param 0x%04x\n", sc->sc_dev.dv_xname, type, cmd, 423 param); 424 return (1); 425 } 426 if ((sc->sc_regs[DS2490_ST_STFL] & DS2490_ST_STFL_IDLE) == 0) 427 goto again; 428 429 return (0); 430 } 431 432 void 433 uow_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status) 434 { 435 struct uow_softc *sc = priv; 436 437 if (status != USBD_NORMAL_COMPLETION) { 438 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) 439 return; 440 if (status == USBD_STALLED) 441 usbd_clear_endpoint_stall_async(sc->sc_ph_intr); 442 return; 443 } 444 445 wakeup(sc->sc_regs); 446 } 447 448 int 449 uow_read(struct uow_softc *sc, void *buf, int len) 450 { 451 usbd_status error; 452 int count; 453 454 /* XXX: implement FIFO status monitoring */ 455 if (len > DS2490_DATAFIFOSIZE) { 456 printf("%s: read %d bytes, xfer too big\n", 457 sc->sc_dev.dv_xname, len); 458 return (-1); 459 } 460 461 if ((sc->sc_xfer = usbd_alloc_xfer(sc->sc_udev)) == NULL) { 462 printf("%s: failed to alloc xfer\n", sc->sc_dev.dv_xname); 463 return (-1); 464 } 465 usbd_setup_xfer(sc->sc_xfer, sc->sc_ph_ibulk, sc, buf, len, 466 USBD_SHORT_XFER_OK, UOW_TIMEOUT, NULL); 467 error = usbd_sync_transfer(sc->sc_xfer); 468 usbd_free_xfer(sc->sc_xfer); 469 if (error != 0) { 470 printf("%s: read failed, len %d: %s\n", 471 sc->sc_dev.dv_xname, len, usbd_errstr(error)); 472 uow_reset(sc); 473 return (-1); 474 } 475 476 usbd_get_xfer_status(sc->sc_xfer, NULL, NULL, &count, &error); 477 return (count); 478 } 479 480 int 481 uow_write(struct uow_softc *sc, const void *buf, int len) 482 { 483 usbd_status error; 484 485 /* XXX: implement FIFO status monitoring */ 486 if (len > DS2490_DATAFIFOSIZE) { 487 printf("%s: write %d bytes, xfer too big\n", 488 sc->sc_dev.dv_xname, len); 489 return (1); 490 } 491 492 if ((sc->sc_xfer = usbd_alloc_xfer(sc->sc_udev)) == NULL) { 493 printf("%s: failed to alloc xfer\n", sc->sc_dev.dv_xname); 494 return (-1); 495 } 496 usbd_setup_xfer(sc->sc_xfer, sc->sc_ph_obulk, sc, (void *)buf, len, 0, 497 UOW_TIMEOUT, NULL); 498 error = usbd_sync_transfer(sc->sc_xfer); 499 usbd_free_xfer(sc->sc_xfer); 500 if (error != 0) { 501 printf("%s: write failed, len %d: %s\n", 502 sc->sc_dev.dv_xname, len, usbd_errstr(error)); 503 uow_reset(sc); 504 return (1); 505 } 506 507 return (0); 508 } 509 510 int 511 uow_reset(struct uow_softc *sc) 512 { 513 return (uow_ctlcmd(sc, DS2490_CTL_RESET_DEVICE, 0)); 514 } 515