1 /* $NetBSD: ulpt.c,v 1.94 2014/03/16 05:20:29 dholland Exp $ */ 2 3 /* 4 * Copyright (c) 1998, 2003 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@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 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 /* 34 * Printer Class spec: http://www.usb.org/developers/data/devclass/usbprint109.PDF 35 */ 36 37 #include <sys/cdefs.h> 38 __KERNEL_RCSID(0, "$NetBSD: ulpt.c,v 1.94 2014/03/16 05:20:29 dholland Exp $"); 39 40 #include <sys/param.h> 41 #include <sys/systm.h> 42 #include <sys/proc.h> 43 #include <sys/kernel.h> 44 #include <sys/fcntl.h> 45 #include <sys/device.h> 46 #include <sys/ioctl.h> 47 #include <sys/uio.h> 48 #include <sys/conf.h> 49 #include <sys/vnode.h> 50 #include <sys/syslog.h> 51 52 #include <machine/vmparam.h> /* PAGE_SIZE */ 53 54 #include <dev/usb/usb.h> 55 #include <dev/usb/usbdi.h> 56 #include <dev/usb/usbdi_util.h> 57 #include <dev/usb/usbdevs.h> 58 #include <dev/usb/usb_quirks.h> 59 60 #define TIMEOUT hz*16 /* wait up to 16 seconds for a ready */ 61 #define STEP hz/4 62 63 #define LPTPRI (PZERO+8) 64 #define ULPT_BSIZE PAGE_SIZE 65 66 #define ULPT_READS_PER_SEC 5 67 /* XXX Why is 10 us a reasonable value? */ 68 #define ULPT_READ_TIMO 10 69 70 #ifdef ULPT_DEBUG 71 #define DPRINTFN(n,x) if (ulptdebug>=(n)) printf x 72 int ulptdebug = 0; 73 /* 74 * The strategy for debug levels is: 75 * 1: attach-time operations 76 * 2: open/close/status/reset 77 * 3: read/write basic 78 * 4: read/write details 79 * 10: left over from previous debug code 80 */ 81 #else 82 #define DPRINTFN(n,x) 83 #endif 84 85 #define UR_GET_DEVICE_ID 0 86 #define UR_GET_PORT_STATUS 1 87 #define UR_SOFT_RESET 2 88 89 #define LPS_NERR 0x08 /* printer no error */ 90 #define LPS_SELECT 0x10 /* printer selected */ 91 #define LPS_NOPAPER 0x20 /* printer out of paper */ 92 #define LPS_INVERT (LPS_SELECT|LPS_NERR) 93 #define LPS_MASK (LPS_SELECT|LPS_NERR|LPS_NOPAPER) 94 95 struct ulpt_softc { 96 device_t sc_dev; 97 usbd_device_handle sc_udev; /* device */ 98 usbd_interface_handle sc_iface; /* interface */ 99 int sc_ifaceno; 100 101 int sc_out; 102 usbd_pipe_handle sc_out_pipe; /* bulk out pipe */ 103 usbd_xfer_handle sc_out_xfer; 104 void *sc_out_buf; 105 106 int sc_in; 107 usbd_pipe_handle sc_in_pipe; /* bulk in pipe */ 108 usbd_xfer_handle sc_in_xfer; 109 void *sc_in_buf; 110 111 struct callout sc_read_callout; /* to drain input on write-only opens */ 112 int sc_has_callout; 113 114 u_char sc_state; 115 #define ULPT_OPEN 0x01 /* device is open */ 116 #define ULPT_OBUSY 0x02 /* printer is busy doing output */ 117 #define ULPT_INIT 0x04 /* waiting to initialize for open */ 118 u_char sc_flags; 119 #define ULPT_NOPRIME 0x40 /* don't prime on open */ 120 u_char sc_laststatus; 121 122 int sc_refcnt; 123 u_char sc_dying; 124 }; 125 126 dev_type_open(ulptopen); 127 dev_type_close(ulptclose); 128 dev_type_write(ulptwrite); 129 dev_type_read(ulptread); 130 dev_type_ioctl(ulptioctl); 131 132 const struct cdevsw ulpt_cdevsw = { 133 .d_open = ulptopen, 134 .d_close = ulptclose, 135 .d_read = ulptread, 136 .d_write = ulptwrite, 137 .d_ioctl = ulptioctl, 138 .d_stop = nostop, 139 .d_tty = notty, 140 .d_poll = nopoll, 141 .d_mmap = nommap, 142 .d_kqfilter = nokqfilter, 143 .d_flag = D_OTHER 144 }; 145 146 void ulpt_disco(void *); 147 148 int ulpt_do_write(struct ulpt_softc *, struct uio *uio, int); 149 int ulpt_do_read(struct ulpt_softc *, struct uio *uio, int); 150 int ulpt_status(struct ulpt_softc *); 151 void ulpt_reset(struct ulpt_softc *); 152 int ulpt_statusmsg(u_char, struct ulpt_softc *); 153 void ulpt_read_cb(usbd_xfer_handle xfer, usbd_private_handle priv, 154 usbd_status status); 155 void ulpt_tick(void *xsc); 156 157 #if 0 158 void ieee1284_print_id(char *); 159 #endif 160 161 #define ULPTUNIT(s) (minor(s) & 0x1f) 162 #define ULPTFLAGS(s) (minor(s) & 0xe0) 163 164 165 int ulpt_match(device_t, cfdata_t, void *); 166 void ulpt_attach(device_t, device_t, void *); 167 int ulpt_detach(device_t, int); 168 int ulpt_activate(device_t, enum devact); 169 170 extern struct cfdriver ulpt_cd; 171 172 CFATTACH_DECL_NEW(ulpt, sizeof(struct ulpt_softc), ulpt_match, ulpt_attach, 173 ulpt_detach, ulpt_activate); 174 175 int 176 ulpt_match(device_t parent, cfdata_t match, void *aux) 177 { 178 struct usbif_attach_arg *uaa = aux; 179 /* XXX Print something useful, or don't. */ 180 DPRINTFN(10,("ulpt_match\n")); 181 182 if (uaa->class == UICLASS_PRINTER && 183 uaa->subclass == UISUBCLASS_PRINTER && 184 (uaa->proto == UIPROTO_PRINTER_UNI || 185 uaa->proto == UIPROTO_PRINTER_BI || 186 uaa->proto == UIPROTO_PRINTER_1284)) 187 return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO); 188 return (UMATCH_NONE); 189 } 190 191 void 192 ulpt_attach(device_t parent, device_t self, void *aux) 193 { 194 struct ulpt_softc *sc = device_private(self); 195 struct usbif_attach_arg *uaa = aux; 196 usbd_device_handle dev = uaa->device; 197 usbd_interface_handle iface = uaa->iface; 198 usb_interface_descriptor_t *ifcd = usbd_get_interface_descriptor(iface); 199 const usb_interface_descriptor_t *id; 200 usbd_status err; 201 char *devinfop; 202 usb_endpoint_descriptor_t *ed; 203 u_int8_t epcount; 204 int i, altno; 205 usbd_desc_iter_t iter; 206 207 sc->sc_dev = self; 208 209 aprint_naive("\n"); 210 aprint_normal("\n"); 211 212 devinfop = usbd_devinfo_alloc(dev, 0); 213 aprint_normal_dev(self, "%s, iclass %d/%d\n", 214 devinfop, ifcd->bInterfaceClass, ifcd->bInterfaceSubClass); 215 usbd_devinfo_free(devinfop); 216 217 /* Loop through descriptors looking for a bidir mode. */ 218 usb_desc_iter_init(dev, &iter); 219 for (altno = 0;;) { 220 id = (const usb_interface_descriptor_t *)usb_desc_iter_next(&iter); 221 if (!id) 222 break; 223 if (id->bDescriptorType == UDESC_INTERFACE && 224 id->bInterfaceNumber == ifcd->bInterfaceNumber) { 225 if (id->bInterfaceClass == UICLASS_PRINTER && 226 id->bInterfaceSubClass == UISUBCLASS_PRINTER && 227 (id->bInterfaceProtocol == UIPROTO_PRINTER_BI /*|| 228 id->bInterfaceProtocol == UIPROTO_PRINTER_1284*/)) 229 goto found; 230 altno++; 231 } 232 } 233 id = ifcd; /* not found, use original */ 234 found: 235 if (id != ifcd) { 236 /* Found a new bidir setting */ 237 DPRINTFN(1, ("ulpt_attach: set altno = %d\n", altno)); 238 err = usbd_set_interface(iface, altno); 239 if (err) { 240 aprint_error_dev(self, 241 "setting alternate interface failed\n"); 242 sc->sc_dying = 1; 243 return; 244 } 245 } 246 247 epcount = 0; 248 (void)usbd_endpoint_count(iface, &epcount); 249 250 sc->sc_in = -1; 251 sc->sc_out = -1; 252 for (i = 0; i < epcount; i++) { 253 ed = usbd_interface2endpoint_descriptor(iface, i); 254 if (ed == NULL) { 255 aprint_error_dev(self, "couldn't get ep %d\n", i); 256 return; 257 } 258 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 259 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) { 260 sc->sc_in = ed->bEndpointAddress; 261 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT && 262 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) { 263 sc->sc_out = ed->bEndpointAddress; 264 } 265 } 266 if (sc->sc_out == -1) { 267 aprint_error_dev(self, "could not find bulk out endpoint\n"); 268 sc->sc_dying = 1; 269 return; 270 } 271 272 if (usbd_get_quirks(dev)->uq_flags & UQ_BROKEN_BIDIR) { 273 /* This device doesn't handle reading properly. */ 274 sc->sc_in = -1; 275 } 276 277 aprint_normal_dev(self, "using %s-directional mode\n", 278 sc->sc_in >= 0 ? "bi" : "uni"); 279 280 sc->sc_iface = iface; 281 sc->sc_ifaceno = id->bInterfaceNumber; 282 sc->sc_udev = dev; 283 284 #if 0 285 /* 286 * This code is disabled because for some mysterious reason it causes 287 * printing not to work. But only sometimes, and mostly with 288 * UHCI and less often with OHCI. *sigh* 289 */ 290 { 291 usb_config_descriptor_t *cd = usbd_get_config_descriptor(dev); 292 usb_device_request_t req; 293 int len, alen; 294 295 req.bmRequestType = UT_READ_CLASS_INTERFACE; 296 req.bRequest = UR_GET_DEVICE_ID; 297 USETW(req.wValue, cd->bConfigurationValue); 298 USETW2(req.wIndex, id->bInterfaceNumber, id->bAlternateSetting); 299 USETW(req.wLength, DEVINFOSIZE - 1); 300 err = usbd_do_request_flags(dev, &req, devinfop, USBD_SHORT_XFER_OK, 301 &alen, USBD_DEFAULT_TIMEOUT); 302 if (err) { 303 printf("%s: cannot get device id\n", device_xname(sc->sc_dev)); 304 } else if (alen <= 2) { 305 printf("%s: empty device id, no printer connected?\n", 306 device_xname(sc->sc_dev)); 307 } else { 308 /* devinfop now contains an IEEE-1284 device ID */ 309 len = ((devinfop[0] & 0xff) << 8) | (devinfop[1] & 0xff); 310 if (len > DEVINFOSIZE - 3) 311 len = DEVINFOSIZE - 3; 312 devinfop[len] = 0; 313 printf("%s: device id <", device_xname(sc->sc_dev)); 314 ieee1284_print_id(devinfop+2); 315 printf(">\n"); 316 } 317 } 318 #endif 319 320 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, 321 sc->sc_dev); 322 323 DPRINTFN(1, ("ulpt_attach: sc=%p in=%d out=%d\n", 324 sc, sc->sc_out, sc->sc_in)); 325 326 return; 327 } 328 329 int 330 ulpt_activate(device_t self, enum devact act) 331 { 332 struct ulpt_softc *sc = device_private(self); 333 334 switch (act) { 335 case DVACT_DEACTIVATE: 336 sc->sc_dying = 1; 337 return 0; 338 default: 339 return EOPNOTSUPP; 340 } 341 } 342 343 int 344 ulpt_detach(device_t self, int flags) 345 { 346 struct ulpt_softc *sc = device_private(self); 347 int s; 348 int maj, mn; 349 350 DPRINTFN(1, ("ulpt_detach: sc=%p\n", sc)); 351 352 sc->sc_dying = 1; 353 if (sc->sc_out_pipe != NULL) 354 usbd_abort_pipe(sc->sc_out_pipe); 355 if (sc->sc_in_pipe != NULL) 356 usbd_abort_pipe(sc->sc_in_pipe); 357 358 s = splusb(); 359 if (--sc->sc_refcnt >= 0) { 360 /* There is noone to wake, aborting the pipe is enough */ 361 /* Wait for processes to go away. */ 362 usb_detach_waitold(sc->sc_dev); 363 } 364 splx(s); 365 366 /* locate the major number */ 367 maj = cdevsw_lookup_major(&ulpt_cdevsw); 368 369 /* Nuke the vnodes for any open instances (calls close). */ 370 mn = device_unit(self); 371 vdevgone(maj, mn, mn, VCHR); 372 vdevgone(maj, mn | ULPT_NOPRIME , mn | ULPT_NOPRIME, VCHR); 373 374 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, 375 sc->sc_dev); 376 377 return (0); 378 } 379 380 int 381 ulpt_status(struct ulpt_softc *sc) 382 { 383 usb_device_request_t req; 384 usbd_status err; 385 u_char status; 386 387 req.bmRequestType = UT_READ_CLASS_INTERFACE; 388 req.bRequest = UR_GET_PORT_STATUS; 389 USETW(req.wValue, 0); 390 USETW(req.wIndex, sc->sc_ifaceno); 391 USETW(req.wLength, 1); 392 err = usbd_do_request(sc->sc_udev, &req, &status); 393 DPRINTFN(2, ("ulpt_status: status=0x%02x err=%d\n", status, err)); 394 if (!err) 395 return (status); 396 else 397 return (0); 398 } 399 400 void 401 ulpt_reset(struct ulpt_softc *sc) 402 { 403 usb_device_request_t req; 404 405 DPRINTFN(2, ("ulpt_reset\n")); 406 req.bRequest = UR_SOFT_RESET; 407 USETW(req.wValue, 0); 408 USETW(req.wIndex, sc->sc_ifaceno); 409 USETW(req.wLength, 0); 410 411 /* 412 * There was a mistake in the USB printer 1.0 spec that gave the 413 * request type as UT_WRITE_CLASS_OTHER; it should have been 414 * UT_WRITE_CLASS_INTERFACE. Many printers use the old one, 415 * so we try both. 416 */ 417 req.bmRequestType = UT_WRITE_CLASS_OTHER; 418 if (usbd_do_request(sc->sc_udev, &req, 0)) { /* 1.0 */ 419 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 420 (void)usbd_do_request(sc->sc_udev, &req, 0); /* 1.1 */ 421 } 422 } 423 424 int ulptusein = 1; 425 426 /* 427 * Reset the printer, then wait until it's selected and not busy. 428 */ 429 int 430 ulptopen(dev_t dev, int flag, int mode, struct lwp *l) 431 { 432 u_char flags = ULPTFLAGS(dev); 433 struct ulpt_softc *sc; 434 usbd_status err; 435 int spin, error; 436 437 sc = device_lookup_private(&ulpt_cd, ULPTUNIT(dev)); 438 if (sc == NULL) 439 return ENXIO; 440 441 if (sc == NULL || sc->sc_iface == NULL || sc->sc_dying) 442 return (ENXIO); 443 444 if (sc->sc_state) 445 return (EBUSY); 446 447 sc->sc_state = ULPT_INIT; 448 sc->sc_flags = flags; 449 DPRINTFN(2, ("ulptopen: flags=0x%x\n", (unsigned)flags)); 450 451 error = 0; 452 sc->sc_refcnt++; 453 454 if ((flags & ULPT_NOPRIME) == 0) 455 ulpt_reset(sc); 456 457 for (spin = 0; (ulpt_status(sc) & LPS_SELECT) == 0; spin += STEP) { 458 DPRINTFN(2, ("ulpt_open: waiting a while\n")); 459 if (spin >= TIMEOUT) { 460 error = EBUSY; 461 sc->sc_state = 0; 462 goto done; 463 } 464 465 /* wait 1/4 second, give up if we get a signal */ 466 error = tsleep((void *)sc, LPTPRI | PCATCH, "ulptop", STEP); 467 if (error != EWOULDBLOCK) { 468 sc->sc_state = 0; 469 goto done; 470 } 471 472 if (sc->sc_dying) { 473 error = ENXIO; 474 sc->sc_state = 0; 475 goto done; 476 } 477 } 478 479 err = usbd_open_pipe(sc->sc_iface, sc->sc_out, 0, &sc->sc_out_pipe); 480 if (err) { 481 error = EIO; 482 goto err0; 483 } 484 sc->sc_out_xfer = usbd_alloc_xfer(sc->sc_udev); 485 if (sc->sc_out_xfer == NULL) { 486 error = ENOMEM; 487 goto err1; 488 } 489 sc->sc_out_buf = usbd_alloc_buffer(sc->sc_out_xfer, ULPT_BSIZE); 490 if (sc->sc_out_buf == NULL) { 491 error = ENOMEM; 492 goto err2; 493 } 494 495 if (ulptusein && sc->sc_in != -1) { 496 DPRINTFN(2, ("ulpt_open: opening input pipe %d\n", sc->sc_in)); 497 err = usbd_open_pipe(sc->sc_iface, sc->sc_in,0,&sc->sc_in_pipe); 498 if (err) { 499 error = EIO; 500 goto err2; 501 } 502 sc->sc_in_xfer = usbd_alloc_xfer(sc->sc_udev); 503 if (sc->sc_in_xfer == NULL) { 504 error = ENOMEM; 505 goto err3; 506 } 507 sc->sc_in_buf = usbd_alloc_buffer(sc->sc_in_xfer, ULPT_BSIZE); 508 if (sc->sc_in_buf == NULL) { 509 error = ENOMEM; 510 goto err4; 511 } 512 513 /* If it's not opened for read then set up a reader. */ 514 if (!(flag & FREAD)) { 515 DPRINTFN(2, ("ulpt_open: start read callout\n")); 516 callout_init(&sc->sc_read_callout, 0); 517 callout_reset(&sc->sc_read_callout, hz/5, ulpt_tick, sc); 518 sc->sc_has_callout = 1; 519 } 520 } 521 522 sc->sc_state = ULPT_OPEN; 523 goto done; 524 525 err4: 526 usbd_free_xfer(sc->sc_in_xfer); 527 sc->sc_in_xfer = NULL; 528 err3: 529 usbd_close_pipe(sc->sc_in_pipe); 530 sc->sc_in_pipe = NULL; 531 err2: 532 usbd_free_xfer(sc->sc_out_xfer); 533 sc->sc_out_xfer = NULL; 534 err1: 535 usbd_close_pipe(sc->sc_out_pipe); 536 sc->sc_out_pipe = NULL; 537 err0: 538 sc->sc_state = 0; 539 540 done: 541 if (--sc->sc_refcnt < 0) 542 usb_detach_wakeupold(sc->sc_dev); 543 544 DPRINTFN(2, ("ulptopen: done, error=%d\n", error)); 545 return (error); 546 } 547 548 /* 549 * XXX Document return value semantics. 550 */ 551 int 552 ulpt_statusmsg(u_char status, struct ulpt_softc *sc) 553 { 554 u_char new; 555 556 status = (status ^ LPS_INVERT) & LPS_MASK; 557 new = status & ~sc->sc_laststatus; 558 sc->sc_laststatus = status; 559 560 if (new & LPS_SELECT) 561 log(LOG_NOTICE, "%s: offline\n", device_xname(sc->sc_dev)); 562 if (new & LPS_NOPAPER) 563 log(LOG_NOTICE, "%s: out of paper\n", device_xname(sc->sc_dev)); 564 if (new & LPS_NERR) 565 log(LOG_NOTICE, "%s: output error\n", device_xname(sc->sc_dev)); 566 567 return (status); 568 } 569 570 int 571 ulptclose(dev_t dev, int flag, int mode, 572 struct lwp *l) 573 { 574 struct ulpt_softc *sc; 575 576 sc = device_lookup_private(&ulpt_cd, ULPTUNIT(dev)); 577 578 if (sc->sc_state != ULPT_OPEN) 579 /* We are being forced to close before the open completed. */ 580 return (0); 581 582 if (sc->sc_has_callout) { 583 DPRINTFN(2, ("ulptclose: stopping read callout\n")); 584 callout_halt(&sc->sc_read_callout, NULL); 585 callout_destroy(&sc->sc_read_callout); 586 sc->sc_has_callout = 0; 587 } 588 589 if (sc->sc_out_pipe != NULL) { 590 usbd_abort_pipe(sc->sc_out_pipe); 591 usbd_close_pipe(sc->sc_out_pipe); 592 sc->sc_out_pipe = NULL; 593 } 594 if (sc->sc_out_xfer != NULL) { 595 usbd_free_xfer(sc->sc_out_xfer); 596 sc->sc_out_xfer = NULL; 597 } 598 599 if (sc->sc_in_pipe != NULL) { 600 usbd_abort_pipe(sc->sc_in_pipe); 601 usbd_close_pipe(sc->sc_in_pipe); 602 sc->sc_in_pipe = NULL; 603 } 604 if (sc->sc_in_xfer != NULL) { 605 usbd_free_xfer(sc->sc_in_xfer); 606 sc->sc_in_xfer = NULL; 607 } 608 609 sc->sc_state = 0; 610 611 DPRINTFN(2, ("ulptclose: closed\n")); 612 return (0); 613 } 614 615 int 616 ulpt_do_write(struct ulpt_softc *sc, struct uio *uio, int flags) 617 { 618 u_int32_t n; 619 int error = 0; 620 void *bufp; 621 usbd_xfer_handle xfer; 622 usbd_status err; 623 624 DPRINTFN(3, ("ulptwrite\n")); 625 xfer = sc->sc_out_xfer; 626 bufp = sc->sc_out_buf; 627 while ((n = min(ULPT_BSIZE, uio->uio_resid)) != 0) { 628 ulpt_statusmsg(ulpt_status(sc), sc); 629 error = uiomove(bufp, n, uio); 630 if (error) 631 break; 632 DPRINTFN(4, ("ulptwrite: transfer %d bytes\n", n)); 633 err = usbd_bulk_transfer(xfer, sc->sc_out_pipe, USBD_NO_COPY, 634 USBD_NO_TIMEOUT, bufp, &n, "ulptwr"); 635 if (err) { 636 DPRINTFN(3, ("ulptwrite: error=%d\n", err)); 637 error = EIO; 638 break; 639 } 640 } 641 642 return (error); 643 } 644 645 int 646 ulptwrite(dev_t dev, struct uio *uio, int flags) 647 { 648 struct ulpt_softc *sc; 649 int error; 650 651 sc = device_lookup_private(&ulpt_cd, ULPTUNIT(dev)); 652 653 if (sc->sc_dying) 654 return (EIO); 655 656 sc->sc_refcnt++; 657 error = ulpt_do_write(sc, uio, flags); 658 if (--sc->sc_refcnt < 0) 659 usb_detach_wakeupold(sc->sc_dev); 660 return (error); 661 } 662 663 /* 664 * Perform a read operation according to the given uio. 665 * This should respect nonblocking I/O status. 666 * 667 * XXX Doing a short read when more data is available seems to be 668 * problematic. See 669 * http://www.freebsd.org/cgi/query-pr.cgi?pr=91538&cat= for a fix. 670 * However, this will be unnecessary given a proper fix for the next 671 * problem, and most actual callers read a lot. 672 * 673 * XXX This code should interact properly with select/poll, and that 674 * requires the USB transactions to be queued and function before the 675 * user does a read. Read will then consume data from a buffer, and 676 * not interact with the device. See ucom.c for an example of how to 677 * do this. 678 */ 679 int 680 ulpt_do_read(struct ulpt_softc *sc, struct uio *uio, int flags) 681 { 682 u_int32_t n, nread, nreq; 683 int error = 0, nonblocking, timeout; 684 void *bufp; 685 usbd_xfer_handle xfer; 686 usbd_status err = USBD_NORMAL_COMPLETION; 687 688 /* XXX Resolve with background reader process. KASSERT? */ 689 if (sc->sc_in_pipe == NULL) 690 return EIO; 691 692 if (flags & IO_NDELAY) 693 nonblocking = 1; 694 else 695 nonblocking = 0; 696 697 if (nonblocking) 698 timeout = USBD_DEFAULT_TIMEOUT; /* 5 ms */ 699 else 700 timeout = USBD_NO_TIMEOUT; 701 702 DPRINTFN(3, ("ulptread nonblocking=%d uio_reside=%ld timeout=%d\n", 703 nonblocking, (u_long)uio->uio_resid, timeout)); 704 705 xfer = sc->sc_in_xfer; 706 bufp = sc->sc_in_buf; 707 nread = 0; 708 while ((nreq = min(ULPT_BSIZE, uio->uio_resid)) != 0) { 709 KASSERT(error == 0); 710 if (error != 0) { 711 printf("ulptread: pre-switch error %d != 0", error); 712 goto done; 713 } 714 715 /* 716 * XXX Even with the short timeout, this will tsleep, 717 * but it should be adequately prompt in practice. 718 */ 719 n = nreq; 720 DPRINTFN(4, ("ulptread: transfer %d bytes, nonblocking=%d timeout=%d\n", 721 n, nonblocking, timeout)); 722 err = usbd_bulk_transfer(xfer, sc->sc_in_pipe, 723 USBD_NO_COPY | USBD_SHORT_XFER_OK, 724 timeout, bufp, &n, "ulptrd"); 725 726 DPRINTFN(4, ("ulptread: transfer complete nreq %d n %d nread %d err %d\n", 727 nreq, n, nread, err)); 728 /* 729 * Process "err" return, jumping to done if we set "error". 730 */ 731 switch (err) { 732 case USBD_NORMAL_COMPLETION: 733 if (n == 0) { 734 DPRINTFN(3, ("ulptread: NORMAL n==0\n")); 735 } 736 break; 737 738 case USBD_SHORT_XFER: 739 /* We said SHORT_XFER_OK, so shouldn't happen. */ 740 DPRINTFN(3, ("ulptread: SHORT n=%d\n", n)); 741 break; 742 743 case USBD_TIMEOUT: 744 if (nonblocking == 0) { 745 /* XXX Cannot happen; perhaps KASSERT. */ 746 printf("ulptread: timeout in blocking mode\n"); 747 error = EIO; 748 goto done; 749 } 750 751 DPRINTFN(3, ("ulptread: TIMEOUT n %d nread %d error %d\n", 752 n, nread, error)); 753 /* 754 * Don't set error until we understand why 755 * this happens. 756 */ 757 break; 758 759 case USBD_INTERRUPTED: 760 /* 761 * The tsleep in usbd_bulk_transfer was 762 * interrupted. Reflect it to the caller so 763 * that reading can be interrupted. 764 */ 765 error = EINTR; 766 DPRINTFN(3, ("ulptread: EINTR error %d\n", error)); 767 goto done; 768 break; 769 770 default: 771 /* Assume all other return codes are really errors. */ 772 error = EIO; 773 DPRINTFN(3, ("ulptread: n %d err %d error %d\n", 774 n, err, error)); 775 goto done; 776 break; 777 } 778 /* XXX KASSERT */ 779 if (error != 0) { 780 printf("ulptread: post-switch error %d != 0", error); 781 goto done; 782 } 783 784 if (n > 0) { 785 /* 786 * Record progress to enable later choosing 787 * between short reads and EWOULDBLOCK. 788 */ 789 nread += n; 790 791 /* Copy to userspace, giving up on any error. */ 792 error = uiomove(bufp, n, uio); 793 if (error != 0) 794 break; 795 } else { 796 /* 797 * We read 0 bytes, and therefore are done, 798 * even if we aren't in nonblocking mode. 799 */ 800 if (error == 0 && nread == 0) 801 error = EWOULDBLOCK; 802 DPRINTFN(3, ("ulptread: read 0=>done error %d\n", 803 error)); 804 goto done; 805 } 806 807 /* 808 * A short transfer indicates no more data will be 809 * forthcoming. Terminate this read regardless of 810 * whether we are in nonblocking mode. XXX Reconsider 811 * for blocking mode; maybe we should continue to 812 * block, but maybe it just doesn't make senes to do 813 * blocking reads from devices like this. 814 */ 815 if (err == USBD_SHORT_XFER) { 816 DPRINTFN(3, ("ulptread: SHORT=>done n %d nread %d err %d error %d\n", 817 n, nread, err, error)); 818 break; 819 } 820 } 821 822 done: 823 DPRINTFN(3, ("ulptread: finished n %d nread %d err %d error %d\n", 824 n, nread, err, error)); 825 return (error); 826 } 827 828 int 829 ulptread(dev_t dev, struct uio *uio, int flags) 830 { 831 struct ulpt_softc *sc; 832 int error; 833 834 sc = device_lookup_private(&ulpt_cd, ULPTUNIT(dev)); 835 836 if (sc->sc_dying) 837 return (EIO); 838 839 sc->sc_refcnt++; 840 error = ulpt_do_read(sc, uio, flags); 841 if (--sc->sc_refcnt < 0) 842 usb_detach_wakeupold(sc->sc_dev); 843 return (error); 844 } 845 846 void 847 ulpt_read_cb(usbd_xfer_handle xfer, usbd_private_handle priv, 848 usbd_status status) 849 { 850 usbd_status err; 851 u_int32_t n; 852 usbd_private_handle xsc; 853 struct ulpt_softc *sc; 854 855 usbd_get_xfer_status(xfer, &xsc, NULL, &n, &err); 856 sc = xsc; 857 858 DPRINTFN(4, ("ulpt_read_cb: start sc=%p, err=%d n=%d\n", sc, err, n)); 859 860 #ifdef ULPT_DEBUG 861 if (!err && n > 0) 862 DPRINTFN(3, ("ulpt_tick: discarding %d bytes\n", n)); 863 #endif 864 if (!err || err == USBD_TIMEOUT) 865 callout_reset(&sc->sc_read_callout, hz / ULPT_READS_PER_SEC, 866 ulpt_tick, sc); 867 } 868 869 /* 870 * For devices which are not opened for reading, this function is 871 * called continuously to start read bulk transfers to avoid the 872 * printer overflowing its output buffer. 873 * 874 * XXX This should be adapted for continuous reads to allow select to 875 * work; see do_ulpt_read(). 876 */ 877 void 878 ulpt_tick(void *xsc) 879 { 880 struct ulpt_softc *sc = xsc; 881 usbd_status err __unused; 882 883 if (sc == NULL || sc->sc_dying) 884 return; 885 886 usbd_setup_xfer(sc->sc_in_xfer, sc->sc_in_pipe, sc, sc->sc_in_buf, 887 ULPT_BSIZE, USBD_NO_COPY | USBD_SHORT_XFER_OK, 888 ULPT_READ_TIMO, ulpt_read_cb); 889 err = usbd_transfer(sc->sc_in_xfer); 890 DPRINTFN(3, ("ulpt_tick: sc=%p err=%d\n", sc, err)); 891 } 892 893 int 894 ulptioctl(dev_t dev, u_long cmd, void *data, 895 int flag, struct lwp *l) 896 { 897 #if 0 898 struct ulpt_softc *sc; 899 900 sc = device_lookup_private(&ulpt_cd, ULPTUNIT(dev)); 901 #endif 902 903 switch (cmd) { 904 case FIONBIO: 905 return 0; 906 } 907 908 return ENODEV; 909 } 910 911 #if 0 912 /* XXX This does not belong here. */ 913 /* 914 * Print select parts of a IEEE 1284 device ID. 915 */ 916 void 917 ieee1284_print_id(char *str) 918 { 919 char *p, *q; 920 921 for (p = str-1; p; p = strchr(p, ';')) { 922 p++; /* skip ';' */ 923 if (strncmp(p, "MFG:", 4) == 0 || 924 strncmp(p, "MANUFACTURER:", 14) == 0 || 925 strncmp(p, "MDL:", 4) == 0 || 926 strncmp(p, "MODEL:", 6) == 0) { 927 q = strchr(p, ';'); 928 if (q) 929 printf("%.*s", (int)(q - p + 1), p); 930 } 931 } 932 } 933 #endif 934