]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - backend/usb-unix.c
Import CUPS 1.4svn-r7356.
[thirdparty/cups.git] / backend / usb-unix.c
index 6c635b4764e1c41aa110333b56f534623bcfcb46..64215815ec43a58e00cd5890771d9fe406c78844 100644 (file)
@@ -1,27 +1,18 @@
 /*
- * "$Id$"
+ * "$Id: usb-unix.c 6910 2007-09-04 20:34:29Z mike $"
  *
  *   USB port backend for the Common UNIX Printing System (CUPS).
  *
  *   This file is included from "usb.c" when compiled on UNIX/Linux.
  *
- *   Copyright 1997-2006 by Easy Software Products, all rights reserved.
+ *   Copyright 2007 by Apple Inc.
+ *   Copyright 1997-2007 by Easy Software Products, all rights reserved.
  *
  *   These coded instructions, statements, and computer programs are the
- *   property of Easy Software Products and are protected by Federal
- *   copyright law.  Distribution and use rights are outlined in the file
+ *   property of Apple Inc. and are protected by Federal copyright
+ *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  *   "LICENSE" which should have been included with this file.  If this
- *   file is missing or damaged please contact Easy Software Products
- *   at:
- *
- *       Attn: CUPS Licensing Information
- *       Easy Software Products
- *       44141 Airport View Drive, Suite 204
- *       Hollywood, Maryland 20636 USA
- *
- *       Voice: (301) 373-9600
- *       EMail: cups-info@cups.org
- *         WWW: http://www.cups.org
+ *   file is missing or damaged, see the license at "http://www.cups.org/".
  *
  *   This file is subject to the Apple OS-Developed Software exception.
  *
@@ -30,6 +21,7 @@
  *   print_device() - Print a file to a USB device.
  *   list_devices() - List all USB devices.
  *   open_device()  - Open a USB device...
+ *   side_cb()      - Handle side-channel requests...
  */
 
 /*
@@ -44,7 +36,9 @@
  * Local functions...
  */
 
-int    open_device(const char *uri);
+static int     open_device(const char *uri, int *use_bc);
+static void    side_cb(int print_fd, int device_fd, int snmp_fd,
+                       http_addr_t *addr, int use_bc);
 
 
 /*
@@ -55,7 +49,7 @@ int                                   /* O - Exit status */
 print_device(const char *uri,          /* I - Device URI */
              const char *hostname,     /* I - Hostname/manufacturer */
              const char *resource,     /* I - Resource/modelname */
-            const char *options,       /* I - Device options/serial number */
+            char       *options,       /* I - Device options/serial number */
             int        print_fd,       /* I - File descriptor to print */
             int        copies,         /* I - Copies to print */
             int        argc,           /* I - Number of command-line arguments (6 or 7) */
@@ -65,23 +59,11 @@ print_device(const char *uri,               /* I - Device URI */
   int          device_fd;              /* USB device */
   size_t       tbytes;                 /* Total number of bytes written */
   struct termios opts;                 /* Parallel port options */
-#if defined(__linux) && defined(LP_POUTPA)
-  unsigned int status;                 /* Port status (off-line, out-of-paper, etc.) */
-  int          paperout;               /* Paper out? */
-#endif /* __linux && LP_POUTPA */
 
 
   (void)argc;
   (void)argv;
 
- /*
-  * Disable backchannel data when printing to Canon USB printers - apparently
-  * Canon printers will return the IEEE-1284 device ID over and over and over
-  * when they get a read request...
-  */
-
-  use_bc = strcasecmp(hostname, "Canon") != 0;
-
  /*
   * Open the USB port device...
   */
@@ -90,7 +72,30 @@ print_device(const char *uri,                /* I - Device URI */
 
   do
   {
-    if ((device_fd = open_device(uri)) == -1)
+#if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
+   /*
+    * *BSD's ulpt driver currently does not support the
+    * back-channel, incorrectly returns data ready on a select(),
+    * and locks up on read()...
+    */
+
+    use_bc = 0;
+
+#else
+   /*
+    * Disable backchannel data when printing to Brother, Canon, or
+    * Minolta USB printers - apparently these printers will return
+    * the IEEE-1284 device ID over and over and over when they get
+    * a read request...
+    */
+
+    use_bc = strcasecmp(hostname, "Brother") &&
+             strcasecmp(hostname, "Canon") &&
+             strncasecmp(hostname, "Konica", 6) &&
+             strncasecmp(hostname, "Minolta", 7);
+#endif /* __FreeBSD__ || __NetBSD__ || __OpenBSD__ || __DragonFly__ */
+
+    if ((device_fd = open_device(uri, &use_bc)) == -1)
     {
       if (getenv("CLASS") != NULL)
       {
@@ -101,8 +106,9 @@ print_device(const char *uri,               /* I - Device URI */
        * available printer in the class.
        */
 
-        fputs("INFO: Unable to open USB device, queuing on next printer in class...\n",
-             stderr);
+        _cupsLangPuts(stderr,
+                     _("INFO: Unable to contact printer, queuing on next "
+                       "printer in class...\n"));
 
        /*
         * Sleep 5 seconds to keep the job from requeuing too rapidly...
@@ -115,19 +121,23 @@ print_device(const char *uri,             /* I - Device URI */
 
       if (errno == EBUSY)
       {
-        fputs("INFO: USB port busy; will retry in 30 seconds...\n", stderr);
-       sleep(30);
+        _cupsLangPuts(stderr,
+                     _("INFO: Printer busy; will retry in 10 seconds...\n"));
+       sleep(10);
       }
       else if (errno == ENXIO || errno == EIO || errno == ENOENT ||
                errno == ENODEV)
       {
-        fputs("INFO: Printer not connected; will retry in 30 seconds...\n", stderr);
+        _cupsLangPuts(stderr,
+                     _("INFO: Printer not connected; will retry in 30 "
+                       "seconds...\n"));
        sleep(30);
       }
       else
       {
-       fprintf(stderr, "ERROR: Unable to open USB device \"%s\": %s\n",
-               uri, strerror(errno));
+       _cupsLangPrintf(stderr,
+                       _("ERROR: Unable to open device file \"%s\": %s\n"),
+                       resource, strerror(errno));
        return (CUPS_BACKEND_FAILED);
       }
     }
@@ -148,37 +158,6 @@ print_device(const char *uri,              /* I - Device URI */
 
   tcsetattr(device_fd, TCSANOW, &opts);
 
-#if defined(__linux) && defined(LP_POUTPA)
- /*
-  * Show the printer status before we send the file...
-  */
-
-  paperout = 0;
-
-  while (!ioctl(device_fd, LPGETSTATUS, &status))
-  {
-    fprintf(stderr, "DEBUG: LPGETSTATUS returned a port status of %02X...\n",
-            status);
-
-    if (status & LP_POUTPA)
-    {
-      fputs("WARNING: Media tray empty!\n", stderr);
-      fputs("STATUS: +media-tray-empty-error\n", stderr);
-
-      paperout = 1;
-    }
-
-    if (!(status & LP_PERRORP))
-      fputs("WARNING: Printer fault!\n", stderr);
-    else if (!(status & LP_PSELECD))
-      fputs("WARNING: Printer off-line.\n", stderr);
-    else
-      break;
-
-    sleep(5);
-  }
-#endif /* __linux && LP_POUTPA */
-
  /*
   * Finally, send the print file...
   */
@@ -195,11 +174,16 @@ print_device(const char *uri,             /* I - Device URI */
       lseek(print_fd, 0, SEEK_SET);
     }
 
-    tbytes = backendRunLoop(print_fd, device_fd, 1);
+    tbytes = backendRunLoop(print_fd, device_fd, -1, NULL, use_bc, side_cb);
 
     if (print_fd != 0 && tbytes >= 0)
-      fprintf(stderr, "INFO: Sent print file, " CUPS_LLFMT " bytes...\n",
-             CUPS_LLCAST tbytes);
+      _cupsLangPrintf(stderr,
+#ifdef HAVE_LONG_LONG
+                     _("INFO: Sent print file, %lld bytes...\n"),
+#else
+                     _("INFO: Sent print file, %ld bytes...\n"),
+#endif /* HAVE_LONG_LONG */
+                     CUPS_LLCAST tbytes);
   }
 
  /*
@@ -220,44 +204,52 @@ void
 list_devices(void)
 {
 #ifdef __linux
-  int  i;                      /* Looping var */
-  int  fd;                     /* File descriptor */
-  char format[255],            /* Format for device filename */
-       device[255],            /* Device filename */
-       device_id[1024],        /* Device ID string */
-       device_uri[1024],       /* Device URI string */
-       make_model[1024];       /* Make and model */
-
-
- /*
-  * First figure out which USB printer filename to use...
-  */
-
-  if (!access("/dev/usblp0", 0))
-    strcpy(format, "/dev/usblp%d");
-  else if (!access("/dev/usb/usblp0", 0))
-    strcpy(format, "/dev/usb/usblp%d");
-  else
-    strcpy(format, "/dev/usb/lp%d");
+  int  i;                              /* Looping var */
+  int  fd;                             /* File descriptor */
+  char device[255],                    /* Device filename */
+       device_id[1024],                /* Device ID string */
+       device_uri[1024],               /* Device URI string */
+       make_model[1024];               /* Make and model */
 
  /*
-  * Then open each USB device...
+  * Try to open each USB device...
   */
 
   for (i = 0; i < 16; i ++)
   {
-    sprintf(device, format, i);
+   /*
+    * Linux has a long history of changing the standard filenames used
+    * for USB printer devices.  We get the honor of trying them all...
+    */
 
-    if ((fd = open(device, O_RDWR | O_EXCL)) >= 0)
+    sprintf(device, "/dev/usblp%d", i);
+
+    if ((fd = open(device, O_RDWR | O_EXCL)) < 0)
     {
-      if (!backendGetDeviceID(fd, device_id, sizeof(device_id),
-                              make_model, sizeof(make_model),
-                             "usb", device_uri, sizeof(device_uri)))
-       printf("direct %s \"%s\" \"%s USB #%d\" \"%s\"\n", device_uri,
-              make_model, make_model, i + 1, device_id);
+      if (errno != ENOENT)
+       continue;
 
-      close(fd);
+      sprintf(device, "/dev/usb/lp%d", i);
+
+      if ((fd = open(device, O_RDWR | O_EXCL)) < 0)
+      {
+       if (errno != ENOENT)
+         continue;
+
+       sprintf(device, "/dev/usb/usblp%d", i);
+
+       if ((fd = open(device, O_RDWR | O_EXCL)) < 0)
+         continue;
+      }
     }
+
+    if (!backendGetDeviceID(fd, device_id, sizeof(device_id),
+                            make_model, sizeof(make_model),
+                           "usb", device_uri, sizeof(device_uri)))
+      printf("direct %s \"%s\" \"%s USB #%d\" \"%s\"\n", device_uri,
+            make_model, make_model, i + 1, device_id);
+
+    close(fd);
   }
 #elif defined(__sgi)
 #elif defined(__sun) && defined(ECPPIOC_GETDEVID)
@@ -277,7 +269,7 @@ list_devices(void)
   {
     sprintf(device, "/dev/usb/printer%d", i);
 
-    if ((fd = open(device, O_RDWR | O_EXCL)) >= 0)
+    if ((fd = open(device, O_WRONLY | O_EXCL)) >= 0)
     {
       if (!backendGetDeviceID(fd, device_id, sizeof(device_id),
                               make_model, sizeof(make_model),
@@ -290,7 +282,7 @@ list_devices(void)
   }
 #elif defined(__hpux)
 #elif defined(__osf)
-#elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
+#elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) || defined(__FreeBSD_kernel__)
   int   i;                      /* Looping var */
   char  device[255];            /* Device filename */
 
@@ -313,9 +305,13 @@ list_devices(void)
  * 'open_device()' - Open a USB device...
  */
 
-int                                    /* O - File descriptor or -1 on error */
-open_device(const char *uri)           /* I - Device URI */
+static int                             /* O - File descriptor or -1 on error */
+open_device(const char *uri,           /* I - Device URI */
+            int        *use_bc)                /* O - Set to 0 for unidirectional */
 {
+  int  fd;                             /* File descriptor */
+
+
  /*
   * The generic implementation just treats the URI as a device filename...
   * Specific operating systems may also support using the device serial
@@ -340,36 +336,41 @@ open_device(const char *uri)              /* I - Device URI */
 
     int                i;                      /* Looping var */
     int                busy;                   /* Are any ports busy? */
-    int                fd;                     /* File descriptor */
-    char       format[255],            /* Format for device filename */
-               device[255],            /* Device filename */
+    char       device[255],            /* Device filename */
                device_id[1024],        /* Device ID string */
                make_model[1024],       /* Make and model */
                device_uri[1024];       /* Device URI string */
 
 
    /*
-    * First figure out which USB printer filename to use...
-    */
-
-    if (!access("/dev/usblp0", 0))
-      strcpy(format, "/dev/usblp%d");
-    else if (!access("/dev/usb/usblp0", 0))
-      strcpy(format, "/dev/usb/usblp%d");
-    else
-      strcpy(format, "/dev/usb/lp%d");
-
-   /*
-    * Then find the correct USB device...
+    * Find the correct USB device...
     */
 
-    do
+    for (;;)
     {
       for (busy = 0, i = 0; i < 16; i ++)
       {
-       sprintf(device, format, i);
+       /*
+       * Linux has a long history of changing the standard filenames used
+       * for USB printer devices.  We get the honor of trying them all...
+       */
+
+       sprintf(device, "/dev/usblp%d", i);
+
+       if ((fd = open(device, O_RDWR | O_EXCL)) < 0 && errno == ENOENT)
+       {
+         sprintf(device, "/dev/usb/lp%d", i);
+
+         if ((fd = open(device, O_RDWR | O_EXCL)) < 0 && errno == ENOENT)
+         {
+           sprintf(device, "/dev/usb/usblp%d", i);
+
+           if ((fd = open(device, O_RDWR | O_EXCL)) < 0 && errno == ENOENT)
+             continue;
+         }
+       }
 
-       if ((fd = open(device, O_RDWR | O_EXCL)) >= 0)
+       if (fd >= 0)
        {
          backendGetDeviceID(fd, device_id, sizeof(device_id),
                              make_model, sizeof(make_model),
@@ -394,7 +395,8 @@ open_device(const char *uri)                /* I - Device URI */
          * Yes, return this file descriptor...
          */
 
-         fprintf(stderr, "DEBUG: Printer using device file \"%s\"...\n", device);
+         fprintf(stderr, "DEBUG: Printer using device file \"%s\"...\n",
+                 device);
 
          return (fd);
        }
@@ -414,20 +416,11 @@ open_device(const char *uri)              /* I - Device URI */
 
       if (busy)
       {
-       fputs("INFO: USB printer is busy; will retry in 5 seconds...\n",
-             stderr);
+       _cupsLangPuts(stderr,
+                     _("INFO: Printer busy; will retry in 5 seconds...\n"));
        sleep(5);
       }
     }
-    while (busy);
-
-   /*
-    * Couldn't find the printer, return "no such device or address"...
-    */
-
-    errno = ENODEV;
-
-    return (-1);
   }
 #elif defined(__sun) && defined(ECPPIOC_GETDEVID)
   {
@@ -446,7 +439,6 @@ open_device(const char *uri)                /* I - Device URI */
 
     int                i;                      /* Looping var */
     int                busy;                   /* Are any ports busy? */
-    int                fd;                     /* File descriptor */
     char       device[255],            /* Device filename */
                device_id[1024],        /* Device ID string */
                make_model[1024],       /* Make and model */
@@ -463,7 +455,7 @@ open_device(const char *uri)                /* I - Device URI */
       {
        sprintf(device, "/dev/usb/printer%d", i);
 
-       if ((fd = open(device, O_RDWR | O_EXCL)) >= 0)
+       if ((fd = open(device, O_WRONLY | O_EXCL)) >= 0)
          backendGetDeviceID(fd, device_id, sizeof(device_id),
                              make_model, sizeof(make_model),
                             "usb", device_uri, sizeof(device_uri));
@@ -481,7 +473,17 @@ open_device(const char *uri)               /* I - Device URI */
         }
 
         if (!strcmp(uri, device_uri))
-         return (fd);  /* Yes, return this file descriptor... */
+       {
+        /*
+         * Yes, return this file descriptor...
+         */
+
+          fputs("DEBUG: Setting use_bc to 0!\n", stderr);
+
+          *use_bc = 0;
+
+         return (fd);
+       }
 
        /*
        * This wasn't the one...
@@ -498,8 +500,8 @@ open_device(const char *uri)                /* I - Device URI */
 
       if (busy)
       {
-       fputs("INFO: USB printer is busy; will retry in 5 seconds...\n",
-             stderr);
+       _cupsLangPuts(stderr,
+                     _("INFO: Printer is busy; will retry in 5 seconds...\n"));
        sleep(5);
       }
     }
@@ -514,7 +516,20 @@ open_device(const char *uri)               /* I - Device URI */
     return (-1);
   }
 #else
-    return (open(uri + 4, O_RDWR | O_EXCL));
+  {
+    if (*use_bc)
+      fd = open(uri + 4, O_RDWR | O_EXCL);
+    else
+      fd = -1;
+
+    if (fd < 0)
+    {
+      fd      = open(uri + 4, O_WRONLY | O_EXCL);
+      *use_bc = 0;
+    }
+
+    return (fd);
+  }
 #endif /* __linux */
   else
   {
@@ -525,5 +540,77 @@ open_device(const char *uri)               /* I - Device URI */
 
 
 /*
- * End of "$Id$".
+ * 'side_cb()' - Handle side-channel requests...
+ */
+
+static void
+side_cb(int         print_fd,          /* I - Print file */
+        int         device_fd,         /* I - Device file */
+        int         snmp_fd,           /* I - SNMP socket (unused) */
+       http_addr_t *addr,              /* I - Device address (unused) */
+       int         use_bc)             /* I - Using back-channel? */
+{
+  cups_sc_command_t    command;        /* Request command */
+  cups_sc_status_t     status;         /* Request/response status */
+  char                 data[2048];     /* Request/response data */
+  int                  datalen;        /* Request/response data size */
+
+
+  (void)snmp_fd;
+  (void)addr;
+
+  datalen = sizeof(data);
+
+  if (cupsSideChannelRead(&command, &status, data, &datalen, 1.0))
+  {
+    _cupsLangPuts(stderr, _("WARNING: Failed to read side-channel request!\n"));
+    return;
+  }
+
+  switch (command)
+  {
+    case CUPS_SC_CMD_DRAIN_OUTPUT :
+        if (backendDrainOutput(print_fd, device_fd))
+         status = CUPS_SC_STATUS_IO_ERROR;
+       else if (tcdrain(device_fd))
+         status = CUPS_SC_STATUS_IO_ERROR;
+       else
+         status = CUPS_SC_STATUS_OK;
+
+       datalen = 0;
+        break;
+
+    case CUPS_SC_CMD_GET_BIDI :
+        data[0] = use_bc;
+        datalen = 1;
+        break;
+
+    case CUPS_SC_CMD_GET_DEVICE_ID :
+        memset(data, 0, sizeof(data));
+
+        if (backendGetDeviceID(device_fd, data, sizeof(data) - 1,
+                              NULL, 0, NULL, NULL, 0))
+        {
+         status  = CUPS_SC_STATUS_NOT_IMPLEMENTED;
+         datalen = 0;
+       }
+       else
+        {
+         status  = CUPS_SC_STATUS_OK;
+         datalen = strlen(data);
+       }
+        break;
+
+    default :
+        status  = CUPS_SC_STATUS_NOT_IMPLEMENTED;
+       datalen = 0;
+       break;
+  }
+
+  cupsSideChannelWrite(command, status, data, datalen, 1.0);
+}
+
+
+/*
+ * End of "$Id: usb-unix.c 6910 2007-09-04 20:34:29Z mike $".
  */