backend/usb-unix.c

   1 /*
   2  * "$Id: usb-unix.c 7687 2008-06-24 01:28:36Z mike $"
   3  *
   4  *   USB port backend for the Common UNIX Printing System (CUPS).
   5  *
   6  *   This file is included from "usb.c" when compiled on UNIX/Linux.
   7  *
   8  *   Copyright 2007-2008 by Apple Inc.
   9  *   Copyright 1997-2007 by Easy Software Products, all rights reserved.
  10  *
  11  *   These coded instructions, statements, and computer programs are the
  12  *   property of Apple Inc. and are protected by Federal copyright
  13  *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  14  *   "LICENSE" which should have been included with this file.  If this
  15  *   file is missing or damaged, see the license at "http://www.cups.org/".
  16  *
  17  *   This file is subject to the Apple OS-Developed Software exception.
  18  *
  19  * Contents:
  20  *
  21  *   print_device() - Print a file to a USB device.
  22  *   list_devices() - List all USB devices.
  23  *   open_device()  - Open a USB device...
  24  *   side_cb()      - Handle side-channel requests...
  25  */
  26
  27 /*
  28  * Include necessary headers.
  29  */
  30
  31 #include <sys/select.h>
  32
  33
  34 /*
  35  * Local functions...
  36  */
  37
  38 static int      open_device(const char *uri, int *use_bc);
  39 static void     side_cb(int print_fd, int device_fd, int snmp_fd,
  40                         http_addr_t *addr, int use_bc);
  41
  42
  43 /*
  44  * 'print_device()' - Print a file to a USB device.
  45  */
  46
  47 int                                     /* O - Exit status */
  48 print_device(const char *uri,           /* I - Device URI */
  49              const char *hostname,      /* I - Hostname/manufacturer */
  50              const char *resource,      /* I - Resource/modelname */
  51              char       *options,       /* I - Device options/serial number */
  52              int        print_fd,       /* I - File descriptor to print */
  53              int        copies,         /* I - Copies to print */
  54              int        argc,           /* I - Number of command-line arguments (6 or 7) */
  55              char       *argv[])        /* I - Command-line arguments */
  56 {
  57   int           use_bc;                 /* Use backchannel path? */
  58   int           device_fd;              /* USB device */
  59   size_t        tbytes;                 /* Total number of bytes written */
  60   struct termios opts;                  /* Parallel port options */
  61
  62
  63   (void)argc;
  64   (void)argv;
  65
  66  /*
  67   * Open the USB port device...
  68   */
  69
  70   fputs("STATE: +connecting-to-device\n", stderr);
  71
  72   do
  73   {
  74 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
  75    /*
  76     * *BSD's ulpt driver currently does not support the
  77     * back-channel, incorrectly returns data ready on a select(),
  78     * and locks up on read()...
  79     */
  80
  81     use_bc = 0;
  82
  83 #else
  84    /*
  85     * Disable backchannel data when printing to Brother, Canon, or
  86     * Minolta USB printers - apparently these printers will return
  87     * the IEEE-1284 device ID over and over and over when they get
  88     * a read request...
  89     */
  90
  91     use_bc = strcasecmp(hostname, "Brother") &&
  92              strcasecmp(hostname, "Canon") &&
  93              strncasecmp(hostname, "Konica", 6) &&
  94              strncasecmp(hostname, "Minolta", 7);
  95 #endif /* __FreeBSD__ || __NetBSD__ || __OpenBSD__ || __DragonFly__ */
  96
  97     if ((device_fd = open_device(uri, &use_bc)) == -1)
  98     {
  99       if (getenv("CLASS") != NULL)
 100       {
 101        /*
 102         * If the CLASS environment variable is set, the job was submitted
 103         * to a class and not to a specific queue.  In this case, we want
 104         * to abort immediately so that the job can be requeued on the next
 105         * available printer in the class.
 106         */
 107
 108         _cupsLangPuts(stderr,
 109                       _("INFO: Unable to contact printer, queuing on next "
 110                         "printer in class...\n"));
 111
 112        /*
 113         * Sleep 5 seconds to keep the job from requeuing too rapidly...
 114         */
 115
 116         sleep(5);
 117
 118         return (CUPS_BACKEND_FAILED);
 119       }
 120
 121       if (errno == EBUSY)
 122       {
 123         _cupsLangPuts(stderr,
 124                       _("INFO: Printer busy; will retry in 10 seconds...\n"));
 125         sleep(10);
 126       }
 127       else if (errno == ENXIO || errno == EIO || errno == ENOENT ||
 128                errno == ENODEV)
 129       {
 130         _cupsLangPuts(stderr,
 131                       _("INFO: Printer not connected; will retry in 30 "
 132                         "seconds...\n"));
 133         sleep(30);
 134       }
 135       else
 136       {
 137         _cupsLangPrintf(stderr,
 138                         _("ERROR: Unable to open device file \"%s\": %s\n"),
 139                         resource, strerror(errno));
 140         return (CUPS_BACKEND_FAILED);
 141       }
 142     }
 143   }
 144   while (device_fd < 0);
 145
 146   fputs("STATE: -connecting-to-device\n", stderr);
 147
 148  /*
 149   * Set any options provided...
 150   */
 151
 152   tcgetattr(device_fd, &opts);
 153
 154   opts.c_lflag &= ~(ICANON | ECHO | ISIG);      /* Raw mode */
 155
 156   /**** No options supported yet ****/
 157
 158   tcsetattr(device_fd, TCSANOW, &opts);
 159
 160  /*
 161   * Finally, send the print file...
 162   */
 163
 164   tbytes = 0;
 165
 166   while (copies > 0 && tbytes >= 0)
 167   {
 168     copies --;
 169
 170     if (print_fd != 0)
 171     {
 172       fputs("PAGE: 1 1\n", stderr);
 173       lseek(print_fd, 0, SEEK_SET);
 174     }
 175
 176     tbytes = backendRunLoop(print_fd, device_fd, -1, NULL, use_bc, side_cb);
 177
 178     if (print_fd != 0 && tbytes >= 0)
 179       _cupsLangPrintf(stderr,
 180 #ifdef HAVE_LONG_LONG
 181                       _("INFO: Sent print file, %lld bytes...\n"),
 182 #else
 183                       _("INFO: Sent print file, %ld bytes...\n"),
 184 #endif /* HAVE_LONG_LONG */
 185                       CUPS_LLCAST tbytes);
 186   }
 187
 188  /*
 189   * Close the USB port and return...
 190   */
 191
 192   close(device_fd);
 193
 194   return (tbytes < 0 ? CUPS_BACKEND_FAILED : CUPS_BACKEND_OK);
 195 }
 196
 197
 198 /*
 199  * 'list_devices()' - List all USB devices.
 200  */
 201
 202 void
 203 list_devices(void)
 204 {
 205 #ifdef __linux
 206   int   i;                              /* Looping var */
 207   int   fd;                             /* File descriptor */
 208   char  device[255],                    /* Device filename */
 209         device_id[1024],                /* Device ID string */
 210         device_uri[1024],               /* Device URI string */
 211         make_model[1024];               /* Make and model */
 212
 213
 214  /*
 215   * Try to open each USB device...
 216   */
 217
 218   for (i = 0; i < 16; i ++)
 219   {
 220    /*
 221     * Linux has a long history of changing the standard filenames used
 222     * for USB printer devices.  We get the honor of trying them all...
 223     */
 224
 225     sprintf(device, "/dev/usblp%d", i);
 226
 227     if ((fd = open(device, O_RDWR | O_EXCL)) < 0)
 228     {
 229       if (errno != ENOENT)
 230         continue;
 231
 232       sprintf(device, "/dev/usb/lp%d", i);
 233
 234       if ((fd = open(device, O_RDWR | O_EXCL)) < 0)
 235       {
 236         if (errno != ENOENT)
 237           continue;
 238
 239         sprintf(device, "/dev/usb/usblp%d", i);
 240
 241         if ((fd = open(device, O_RDWR | O_EXCL)) < 0)
 242           continue;
 243       }
 244     }
 245
 246     if (!backendGetDeviceID(fd, device_id, sizeof(device_id),
 247                             make_model, sizeof(make_model),
 248                             "usb", device_uri, sizeof(device_uri)))
 249       cupsBackendReport("direct", device_uri, make_model, make_model,
 250                         device_id, NULL);
 251
 252     close(fd);
 253   }
 254 #elif defined(__sgi)
 255 #elif defined(__sun) && defined(ECPPIOC_GETDEVID)
 256   int   i;                      /* Looping var */
 257   int   fd;                     /* File descriptor */
 258   char  device[255],            /* Device filename */
 259         device_id[1024],        /* Device ID string */
 260         device_uri[1024],       /* Device URI string */
 261         make_model[1024];       /* Make and model */
 262
 263
 264  /*
 265   * Open each USB device...
 266   */
 267
 268   for (i = 0; i < 8; i ++)
 269   {
 270     sprintf(device, "/dev/usb/printer%d", i);
 271
 272     if ((fd = open(device, O_WRONLY | O_EXCL)) >= 0)
 273     {
 274       if (!backendGetDeviceID(fd, device_id, sizeof(device_id),
 275                               make_model, sizeof(make_model),
 276                               "usb", device_uri, sizeof(device_uri)))
 277         cupsBackendReport("direct", device_uri, make_model, make_model,
 278                           device_id, NULL);
 279
 280       close(fd);
 281     }
 282   }
 283 #elif defined(__hpux)
 284 #elif defined(__osf)
 285 #elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) || defined(__FreeBSD_kernel__)
 286   int   i;                      /* Looping var */
 287   char  device[255];            /* Device filename */
 288
 289
 290   for (i = 0; i < 8; i ++)
 291   {
 292     sprintf(device, "/dev/ulpt%d", i);
 293     if (!access(device, 0))
 294       printf("direct usb:%s \"Unknown\" \"USB Printer #%d\"\n", device, i + 1);
 295
 296     sprintf(device, "/dev/unlpt%d", i);
 297     if (!access(device, 0))
 298       printf("direct usb:%s \"Unknown\" \"USB Printer #%d (no reset)\"\n", device, i + 1);
 299   }
 300 #endif
 301 }
 302
 303
 304 /*
 305  * 'open_device()' - Open a USB device...
 306  */
 307
 308 static int                              /* O - File descriptor or -1 on error */
 309 open_device(const char *uri,            /* I - Device URI */
 310             int        *use_bc)         /* O - Set to 0 for unidirectional */
 311 {
 312   int   fd;                             /* File descriptor */
 313
 314
 315  /*
 316   * The generic implementation just treats the URI as a device filename...
 317   * Specific operating systems may also support using the device serial
 318   * number and/or make/model.
 319   */
 320
 321   if (!strncmp(uri, "usb:/dev/", 9))
 322 #ifdef __linux
 323   {
 324    /*
 325     * Do not allow direct devices anymore...
 326     */
 327
 328     errno = ENODEV;
 329     return (-1);
 330   }
 331   else if (!strncmp(uri, "usb://", 6))
 332   {
 333    /*
 334     * For Linux, try looking up the device serial number or model...
 335     */
 336
 337     int         i;                      /* Looping var */
 338     int         busy;                   /* Are any ports busy? */
 339     char        device[255],            /* Device filename */
 340                 device_id[1024],        /* Device ID string */
 341                 make_model[1024],       /* Make and model */
 342                 device_uri[1024];       /* Device URI string */
 343
 344
 345    /*
 346     * Find the correct USB device...
 347     */
 348
 349     for (;;)
 350     {
 351       for (busy = 0, i = 0; i < 16; i ++)
 352       {
 353        /*
 354         * Linux has a long history of changing the standard filenames used
 355         * for USB printer devices.  We get the honor of trying them all...
 356         */
 357
 358         sprintf(device, "/dev/usblp%d", i);
 359
 360         if ((fd = open(device, O_RDWR | O_EXCL)) < 0 && errno == ENOENT)
 361         {
 362           sprintf(device, "/dev/usb/lp%d", i);
 363
 364           if ((fd = open(device, O_RDWR | O_EXCL)) < 0 && errno == ENOENT)
 365           {
 366             sprintf(device, "/dev/usb/usblp%d", i);
 367
 368             if ((fd = open(device, O_RDWR | O_EXCL)) < 0 && errno == ENOENT)
 369               continue;
 370           }
 371         }
 372
 373         if (fd >= 0)
 374         {
 375           backendGetDeviceID(fd, device_id, sizeof(device_id),
 376                              make_model, sizeof(make_model),
 377                              "usb", device_uri, sizeof(device_uri));
 378         }
 379         else
 380         {
 381          /*
 382           * If the open failed because it was busy, flag it so we retry
 383           * as needed...
 384           */
 385
 386           if (errno == EBUSY)
 387             busy = 1;
 388
 389           device_uri[0] = '\0';
 390         }
 391
 392         if (!strcmp(uri, device_uri))
 393         {
 394          /*
 395           * Yes, return this file descriptor...
 396           */
 397
 398           fprintf(stderr, "DEBUG: Printer using device file \"%s\"...\n",
 399                   device);
 400
 401           return (fd);
 402         }
 403
 404        /*
 405         * This wasn't the one...
 406         */
 407
 408         if (fd >= 0)
 409           close(fd);
 410       }
 411
 412      /*
 413       * If we get here and at least one of the printer ports showed up
 414       * as "busy", then sleep for a bit and retry...
 415       */
 416
 417       if (busy)
 418         _cupsLangPuts(stderr,
 419                       _("INFO: Printer busy; will retry in 5 seconds...\n"));
 420
 421       sleep(5);
 422     }
 423   }
 424 #elif defined(__sun) && defined(ECPPIOC_GETDEVID)
 425   {
 426    /*
 427     * Do not allow direct devices anymore...
 428     */
 429
 430     errno = ENODEV;
 431     return (-1);
 432   }
 433   else if (!strncmp(uri, "usb://", 6))
 434   {
 435    /*
 436     * For Solaris, try looking up the device serial number or model...
 437     */
 438
 439     int         i;                      /* Looping var */
 440     int         busy;                   /* Are any ports busy? */
 441     char        device[255],            /* Device filename */
 442                 device_id[1024],        /* Device ID string */
 443                 make_model[1024],       /* Make and model */
 444                 device_uri[1024];       /* Device URI string */
 445
 446
 447    /*
 448     * Find the correct USB device...
 449     */
 450
 451     do
 452     {
 453       for (i = 0, busy = 0; i < 8; i ++)
 454       {
 455         sprintf(device, "/dev/usb/printer%d", i);
 456
 457         if ((fd = open(device, O_WRONLY | O_EXCL)) >= 0)
 458           backendGetDeviceID(fd, device_id, sizeof(device_id),
 459                              make_model, sizeof(make_model),
 460                              "usb", device_uri, sizeof(device_uri));
 461         else
 462         {
 463          /*
 464           * If the open failed because it was busy, flag it so we retry
 465           * as needed...
 466           */
 467
 468           if (errno == EBUSY)
 469             busy = 1;
 470
 471           device_uri[0] = '\0';
 472         }
 473
 474         if (!strcmp(uri, device_uri))
 475         {
 476          /*
 477           * Yes, return this file descriptor...
 478           */
 479
 480           fputs("DEBUG: Setting use_bc to 0!\n", stderr);
 481
 482           *use_bc = 0;
 483
 484           return (fd);
 485         }
 486
 487        /*
 488         * This wasn't the one...
 489         */
 490
 491         if (fd >= 0)
 492           close(fd);
 493       }
 494
 495      /*
 496       * If we get here and at least one of the printer ports showed up
 497       * as "busy", then sleep for a bit and retry...
 498       */
 499
 500       if (busy)
 501       {
 502         _cupsLangPuts(stderr,
 503                       _("INFO: Printer is busy; will retry in 5 seconds...\n"));
 504         sleep(5);
 505       }
 506     }
 507     while (busy);
 508
 509    /*
 510     * Couldn't find the printer, return "no such device or address"...
 511     */
 512
 513     errno = ENODEV;
 514
 515     return (-1);
 516   }
 517 #else
 518   {
 519     if (*use_bc)
 520       fd = open(uri + 4, O_RDWR | O_EXCL);
 521     else
 522       fd = -1;
 523
 524     if (fd < 0)
 525     {
 526       fd      = open(uri + 4, O_WRONLY | O_EXCL);
 527       *use_bc = 0;
 528     }
 529
 530     return (fd);
 531   }
 532 #endif /* __linux */
 533   else
 534   {
 535     errno = ENODEV;
 536     return (-1);
 537   }
 538 }
 539
 540
 541 /*
 542  * 'side_cb()' - Handle side-channel requests...
 543  */
 544
 545 static void
 546 side_cb(int         print_fd,           /* I - Print file */
 547         int         device_fd,          /* I - Device file */
 548         int         snmp_fd,            /* I - SNMP socket (unused) */
 549         http_addr_t *addr,              /* I - Device address (unused) */
 550         int         use_bc)             /* I - Using back-channel? */
 551 {
 552   cups_sc_command_t     command;        /* Request command */
 553   cups_sc_status_t      status;         /* Request/response status */
 554   char                  data[2048];     /* Request/response data */
 555   int                   datalen;        /* Request/response data size */
 556
 557
 558   (void)snmp_fd;
 559   (void)addr;
 560
 561   datalen = sizeof(data);
 562
 563   if (cupsSideChannelRead(&command, &status, data, &datalen, 1.0))
 564   {
 565     _cupsLangPuts(stderr, _("WARNING: Failed to read side-channel request!\n"));
 566     return;
 567   }
 568
 569   switch (command)
 570   {
 571     case CUPS_SC_CMD_DRAIN_OUTPUT :
 572         if (backendDrainOutput(print_fd, device_fd))
 573           status = CUPS_SC_STATUS_IO_ERROR;
 574         else if (tcdrain(device_fd))
 575           status = CUPS_SC_STATUS_IO_ERROR;
 576         else
 577           status = CUPS_SC_STATUS_OK;
 578
 579         datalen = 0;
 580         break;
 581
 582     case CUPS_SC_CMD_GET_BIDI :
 583         data[0] = use_bc;
 584         datalen = 1;
 585         break;
 586
 587     case CUPS_SC_CMD_GET_DEVICE_ID :
 588         memset(data, 0, sizeof(data));
 589
 590         if (backendGetDeviceID(device_fd, data, sizeof(data) - 1,
 591                                NULL, 0, NULL, NULL, 0))
 592         {
 593           status  = CUPS_SC_STATUS_NOT_IMPLEMENTED;
 594           datalen = 0;
 595         }
 596         else
 597         {
 598           status  = CUPS_SC_STATUS_OK;
 599           datalen = strlen(data);
 600         }
 601         break;
 602
 603     default :
 604         status  = CUPS_SC_STATUS_NOT_IMPLEMENTED;
 605         datalen = 0;
 606         break;
 607   }
 608
 609   cupsSideChannelWrite(command, status, data, datalen, 1.0);
 610 }
 611
 612
 613 /*
 614  * End of "$Id: usb-unix.c 7687 2008-06-24 01:28:36Z mike $".
 615  */