]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - backend/ieee1284.c
Import CUPS 1.4svn r7023 into easysw/current.
[thirdparty/cups.git] / backend / ieee1284.c
index 6152c4c7a27a1a15cf24d298bbcdf2a81ca9fe0d..5fab7ec84ba53faddb5b1d923a53ba9e27b57f8f 100644 (file)
@@ -1,44 +1,41 @@
 /*
- * "$Id: ieee1284.c 4903 2006-01-10 20:02:46Z mike $"
+ * "$Id: ieee1284.c 7019 2007-10-10 22:48:52Z mike $"
  *
  *   IEEE-1284 support functions for the Common UNIX Printing System (CUPS).
  *
- *   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.
  *
  * Contents:
  *
- *   get_device_id() - Get the IEEE-1284 device ID string and corresponding
- *                     URI.
+ *   backendGetDeviceID()  - Get the IEEE-1284 device ID string and
+ *                           corresponding URI.
+ *   backendGetMakeModel() - Get the make and model string from the device ID.
  */
 
 /*
  * Include necessary headers.
  */
 
-#include <cups/debug.h>
+#include "backend-private.h"
+
 #ifdef __linux
 #  include <sys/ioctl.h>
 #  include <linux/lp.h>
 #  define IOCNR_GET_DEVICE_ID          1
 #  define LPIOC_GET_DEVICE_ID(len)     _IOC(_IOC_READ, 'P', IOCNR_GET_DEVICE_ID, len)
+#  include <linux/parport.h>
+#  include <linux/ppdev.h>
+#  include <unistd.h>
+#  include <fcntl.h>
 #endif /* __linux */
 
 #ifdef __sun
 
 
 /*
- * 'get_device_id()' - Get the IEEE-1284 device ID string and
- *                     corresponding URI.
+ * 'backendGetDeviceID()' - Get the IEEE-1284 device ID string and
+ *                          corresponding URI.
  */
 
 int                                    /* O - 0 on success, -1 on failure */
-get_device_id(
+backendGetDeviceID(
     int        fd,                     /* I - File descriptor */
     char       *device_id,             /* O - 1284 device ID */
     int        device_id_size,         /* I - Size of buffer */
@@ -70,17 +67,19 @@ get_device_id(
   char *attr,                          /* 1284 attribute */
        *delim,                         /* 1284 delimiter */
        *uriptr,                        /* Pointer into URI */
-       *mfg,                           /* Manufacturer string */
-       *mdl,                           /* Model string */
+       manufacturer[256],              /* Manufacturer string */
        serial_number[1024];            /* Serial number string */
+  int  manulen;                        /* Length of manufacturer string */
 #ifdef __linux
   int  length;                         /* Length of device ID info */
+  int   got_id = 0;
 #endif /* __linux */
-#ifdef __sun
+#if defined(__sun) && defined(ECPPIOC_GETDEVID)
   struct ecpp_device_id did;           /* Device ID buffer */
-#endif /* __sun */
+#endif /* __sun && ECPPIOC_GETDEVID */
+
 
-  DEBUG_printf(("get_device_id(fd=%d, device_id=%p, device_id_size=%d, "
+  DEBUG_printf(("backendGetDeviceID(fd=%d, device_id=%p, device_id_size=%d, "
                 "make_model=%p, make_model_size=%d, scheme=\"%s\", "
                "uri=%p, uri_size=%d)\n", fd, device_id, device_id_size,
                make_model, make_model_size, scheme ? scheme : "(null)",
@@ -90,89 +89,321 @@ get_device_id(
   * Range check input...
   */
 
-  if (fd < 0 ||
-      !device_id || device_id_size < 32 ||
-      !make_model || make_model_size < 32)
+  if (!device_id || device_id_size < 32)
   {
-    DEBUG_puts("get_device_id: Bad args!");
+    DEBUG_puts("backendGetDeviceID: Bad args!");
     return (-1);
   }
 
-  *device_id  = '\0';
-  *make_model = '\0';
-
-  if (uri)
-    *uri = '\0';
+  if (make_model)
+    *make_model = '\0';
 
- /*
-  * Get the device ID string...
-  */
-
-#ifdef __linux
-  if (!ioctl(fd, LPIOC_GET_DEVICE_ID(device_id_size), device_id))
+  if (fd >= 0)
   {
    /*
-    * Extract the length of the device ID string from the first two
-    * bytes.  The 1284 spec says the length is stored MSB first...
+    * Get the device ID string...
     */
 
-    length = (((unsigned)device_id[0] & 255) << 8) +
-            ((unsigned)device_id[1] & 255);
+    *device_id = '\0';
 
+#ifdef __linux
+  if (ioctl(fd, LPIOC_GET_DEVICE_ID(device_id_size), device_id))
+  {
    /*
-    * Check to see if the length is larger than our buffer; first
-    * assume that the vendor incorrectly implemented the 1284 spec,
-    * and then limit the length to the size of our buffer...
+    * Linux has to implement things differently for every device it seems.
+    * Since the standard parallel port driver does not provide a simple
+    * ioctl() to get the 1284 device ID, we have to open the "raw" parallel
+    * device corresponding to this port and do some negotiation trickery
+    * to get the current device ID.
     */
 
-    if (length > (device_id_size - 2))
-      length = (((unsigned)device_id[1] & 255) << 8) +
-              ((unsigned)device_id[0] & 255);
+    if (uri && !strncmp(uri, "parallel:/dev/", 14))
+    {
+      char     devparport[16];         /* /dev/parportN */
+      int      devparportfd,           /* File descriptor for raw device */
+               status,                 /* ioctl status */
+               mode;                   /* Port mode */
 
-    if (length > (device_id_size - 2))
-      length = device_id_size - 2;
 
-   /*
-    * Copy the device ID text to the beginning of the buffer and
-    * nul-terminate.
-    */
+     /*
+      * Since the Linux parallel backend only supports 4 parallel port
+      * devices, just grab the trailing digit and use it to construct a
+      * /dev/parportN filename...
+      */
 
-    memmove(device_id, device_id + 2, length);
-    device_id[length] = '\0';
+      snprintf(devparport, sizeof(devparport), "/dev/parport%s",
+               uri + strlen(uri) - 1);
+
+      if ((devparportfd = open(devparport, O_RDWR | O_NOCTTY)) != -1)
+      {
+       /*
+        * Claim the device...
+        */
+
+       if (!ioctl(devparportfd, PPCLAIM))
+       {
+          fcntl(devparport, F_SETFL, fcntl(devparportfd, F_GETFL) | O_NONBLOCK);
+
+         mode = IEEE1284_MODE_COMPAT;
+
+         if (!ioctl(devparportfd, PPNEGOT, &mode))
+         {
+          /*
+           * Put the device into Device ID mode...
+           */
+
+           mode = IEEE1284_MODE_NIBBLE | IEEE1284_DEVICEID;
+
+           if (!ioctl(devparportfd, PPNEGOT, &mode))
+           {
+            /*
+             * Read the 1284 device ID...
+             */
+
+             if ((length = read(devparportfd, device_id,
+                                device_id_size - 1)) >= 2)
+              {
+               device_id[length] = '\0';
+               got_id = 1;
+             }
+           }
+         }
+
+         /*
+         * Release the device...
+         */
+
+         ioctl(devparportfd, PPRELEASE);
+       }
+
+        close(devparportfd);
+      }
+    }
   }
-#  ifdef DEBUG
   else
-    printf("get_device_id: ioctl failed - %s\n", strerror(errno));
+    got_id = 1;
+
+  if (got_id)
+    {
+     /*
+      * Extract the length of the device ID string from the first two
+      * bytes.  The 1284 spec says the length is stored MSB first...
+      */
+
+      length = (((unsigned)device_id[0] & 255) << 8) +
+              ((unsigned)device_id[1] & 255);
+
+     /*
+      * Check to see if the length is larger than our buffer; first
+      * assume that the vendor incorrectly implemented the 1284 spec,
+      * and then limit the length to the size of our buffer...
+      */
+
+      if (length > (device_id_size - 2))
+       length = (((unsigned)device_id[1] & 255) << 8) +
+                ((unsigned)device_id[0] & 255);
+
+      if (length > (device_id_size - 2))
+       length = device_id_size - 2;
+
+     /*
+      * Copy the device ID text to the beginning of the buffer and
+      * nul-terminate.
+      */
+
+      memmove(device_id, device_id + 2, length);
+      device_id[length] = '\0';
+    }
+#  ifdef DEBUG
+    else
+      printf("backendGetDeviceID: ioctl failed - %s\n", strerror(errno));
 #  endif /* DEBUG */
 #endif /* __linux */
 
 #if defined(__sun) && defined(ECPPIOC_GETDEVID)
-  did.mode = ECPP_CENTRONICS;
-  did.len  = device_id_size - 1;
-  did.rlen = 0;
-  did.addr = device_id;
+    did.mode = ECPP_CENTRONICS;
+    did.len  = device_id_size - 1;
+    did.rlen = 0;
+    did.addr = device_id;
 
-  if (!ioctl(fd, ECPPIOC_GETDEVID, &did))
+    if (!ioctl(fd, ECPPIOC_GETDEVID, &did))
+    {
+     /*
+      * Nul-terminate the device ID text.
+      */
+
+      if (did.rlen < (device_id_size - 1))
+       device_id[did.rlen] = '\0';
+      else
+       device_id[device_id_size - 1] = '\0';
+    }
+#  ifdef DEBUG
+    else
+      printf("backendGetDeviceID: ioctl failed - %s\n", strerror(errno));
+#  endif /* DEBUG */
+#endif /* __sun && ECPPIOC_GETDEVID */
+  }
+
+  DEBUG_printf(("backendGetDeviceID: device_id=\"%s\"\n", device_id));
+
+  if (scheme && uri)
+    *uri = '\0';
+
+  if (!*device_id)
+    return (-1);
+
+ /*
+  * Get the make and model...
+  */
+
+  if (make_model)
+    backendGetMakeModel(device_id, make_model, make_model_size);
+
+ /*
+  * Then generate a device URI...
+  */
+
+  if (scheme && uri && uri_size > 32)
   {
    /*
-    * Nul-terminate the device ID text.
+    * Look for the serial number field...
+    */
+
+    if ((attr = strstr(device_id, "SERN:")) != NULL)
+      attr += 5;
+    else if ((attr = strstr(device_id, "SERIALNUMBER:")) != NULL)
+      attr += 13;
+    else if ((attr = strstr(device_id, ";SN:")) != NULL)
+      attr += 4;
+
+    if (attr)
+    {
+      strlcpy(serial_number, attr, sizeof(serial_number));
+
+      if ((delim = strchr(serial_number, ';')) != NULL)
+       *delim = '\0';
+    }
+    else
+      serial_number[0] = '\0';
+
+   /*
+    * Generate the device URI from the manufacturer, make_model, and
+    * serial number strings.
     */
 
-    if (did.rlen < (device_id_size - 1))
-      device_id[did.rlen] = '\0';
+    snprintf(uri, uri_size, "%s://", scheme);
+
+    if ((attr = strstr(device_id, "MANUFACTURER:")) != NULL)
+      attr += 13;
+    else if ((attr = strstr(device_id, "Manufacturer:")) != NULL)
+      attr += 13;
+    else if ((attr = strstr(device_id, "MFG:")) != NULL)
+      attr += 4;
+
+    if (attr)
+    {
+      strlcpy(manufacturer, attr, sizeof(manufacturer));
+
+      if ((delim = strchr(manufacturer, ';')) != NULL)
+        *delim = '\0';
+
+      if (!strcasecmp(manufacturer, "Hewlett-Packard"))
+        strcpy(manufacturer, "HP");
+      else if (!strcasecmp(manufacturer, "Lexmark International"))
+        strcpy(manufacturer, "Lexmark");
+    }
+    else
+    {
+      strlcpy(manufacturer, make_model, sizeof(manufacturer));
+
+      if ((delim = strchr(manufacturer, ' ')) != NULL)
+        *delim = '\0';
+    }
+
+    manulen = strlen(manufacturer);
+
+    for (uriptr = uri + strlen(uri), delim = manufacturer;
+        *delim && uriptr < (uri + uri_size - 3);
+        delim ++)
+      if (*delim == ' ')
+      {
+       *uriptr++ = '%';
+       *uriptr++ = '2';
+       *uriptr++ = '0';
+      }
+      else
+       *uriptr++ = *delim;
+
+    *uriptr++ = '/';
+
+    if (!strncasecmp(make_model, manufacturer, manulen))
+    {
+      delim = make_model + manulen;
+
+      while (isspace(*delim & 255))
+        delim ++;
+    }
+    else
+      delim = make_model;
+
+    for (; *delim && uriptr < (uri + uri_size - 3); delim ++)
+      if (*delim == ' ')
+      {
+       *uriptr++ = '%';
+       *uriptr++ = '2';
+       *uriptr++ = '0';
+      }
+      else
+       *uriptr++ = *delim;
+
+    if (serial_number[0])
+    {
+     /*
+      * Add the serial number to the URI...
+      */
+
+      strlcpy(uriptr, "?serial=", uri_size - (uriptr - uri));
+      strlcat(uriptr, serial_number, uri_size - (uriptr - uri));
+    }
     else
-      device_id[device_id_size - 1] = '\0';
+      *uriptr = '\0';
   }
-#  ifdef DEBUG
-  else
-    printf("get_device_id: ioctl failed - %s\n", strerror(errno));
-#  endif /* DEBUG */
-#endif /* __sun && ECPPIOC_GETDEVID */
 
-  DEBUG_printf(("get_device_id: device_id=\"%s\"\n", device_id));
+  return (0);
+}
 
-  if (!*device_id)
+
+/*
+ * 'backendGetMakeModel()' - Get the make and model string from the device ID.
+ */
+
+int                                    /* O - 0 on success, -1 on failure */
+backendGetMakeModel(
+    const char *device_id,             /* O - 1284 device ID */
+    char       *make_model,            /* O - Make/model */
+    int        make_model_size)                /* I - Size of buffer */
+{
+  char *attr,                          /* 1284 attribute */
+       *delim,                         /* 1284 delimiter */
+       *mfg,                           /* Manufacturer string */
+       *mdl;                           /* Model string */
+
+
+  DEBUG_printf(("backendGetMakeModel(device_id=\"%s\", "
+                "make_model=%p, make_model_size=%d)\n", device_id,
+               make_model, make_model_size));
+
+ /*
+  * Range check input...
+  */
+
+  if (!device_id || !*device_id || !make_model || make_model_size < 32)
+  {
+    DEBUG_puts("backendGetMakeModel: Bad args!");
     return (-1);
+  }
+
+  *make_model = '\0';
 
  /*
   * Look for the description field...
@@ -224,69 +455,86 @@ get_device_id(
 
   if ((mfg = strstr(device_id, "MANUFACTURER:")) != NULL)
     mfg += 13;
+  else if ((mfg = strstr(device_id, "Manufacturer:")) != NULL)
+    mfg += 13;
   else if ((mfg = strstr(device_id, "MFG:")) != NULL)
     mfg += 4;
 
   if ((mdl = strstr(device_id, "MODEL:")) != NULL)
     mdl += 6;
+  else if ((mdl = strstr(device_id, "Model:")) != NULL)
+    mdl += 6;
   else if ((mdl = strstr(device_id, "MDL:")) != NULL)
     mdl += 4;
 
-  if (attr)
+  if (mdl)
   {
    /*
-    * Use description...
+    * Build a make-model string from the manufacturer and model attributes...
     */
 
-    if (!strncasecmp(attr, "Hewlett-Packard hp ", 19))
+    if (mfg)
     {
-     /*
-      * Check for a common HP bug...
-      */
+      if (!strncasecmp(mfg, "Hewlett-Packard", 15))
+       strlcpy(make_model, "HP", make_model_size);
+      else if (!strncasecmp(mfg, "Lexmark International", 21))
+       strlcpy(make_model, "Lexmark", make_model_size);
+      else
+       strlcpy(make_model, mfg, make_model_size);
 
-      strlcpy(make_model, "HP ", make_model_size);
-      strlcpy(make_model + 3, attr + 19, make_model_size - 3);
-    }
-    else if (!strncasecmp(attr, "Hewlett-Packard ", 16))
-    {
-      strlcpy(make_model, "HP ", make_model_size);
-      strlcpy(make_model + 3, attr + 16, make_model_size - 3);
+      if ((delim = strchr(make_model, ';')) != NULL)
+       *delim = '\0';
+
+      if (!strncasecmp(make_model, mdl, strlen(make_model)))
+      {
+       /*
+       * Just copy model string, since it has the manufacturer...
+       */
+
+       strlcpy(make_model, mdl, make_model_size);
+      }
+      else
+      {
+       /*
+       * Concatenate the make and model...
+       */
+
+       strlcat(make_model, " ", make_model_size);
+       strlcat(make_model, mdl, make_model_size);
+      }
     }
     else
     {
-      strlcpy(make_model, attr, make_model_size);
+     /*
+      * Just copy model string, since it has the manufacturer...
+      */
+
+      strlcpy(make_model, mdl, make_model_size);
     }
   }
-  else if (mfg && mdl)
+  else if (attr)
   {
    /*
-    * Build a make-model string from the manufacturer and model attributes...
+    * Use description...
     */
 
-    if (!strncasecmp(mfg, "Hewlett-Packard", 15))
-      strlcpy(make_model, "HP", make_model_size);
-    else
-      strlcpy(make_model, mfg, make_model_size);
-
-    if ((delim = strchr(make_model, ';')) != NULL)
-      *delim = '\0';
-
-    if (!strncasecmp(make_model, mdl, strlen(make_model)))
+    if (!strncasecmp(attr, "Hewlett-Packard hp ", 19))
     {
      /*
-      * Just copy model string, since it has the manufacturer...
+      * Check for a common HP bug...
       */
 
-      strlcpy(make_model, mdl, make_model_size);
+      strlcpy(make_model, "HP ", make_model_size);
+      strlcpy(make_model + 3, attr + 19, make_model_size - 3);
+    }
+    else if (!strncasecmp(attr, "Hewlett-Packard ", 16))
+    {
+      strlcpy(make_model, "HP ", make_model_size);
+      strlcpy(make_model + 3, attr + 16, make_model_size - 3);
     }
     else
     {
-     /*
-      * Concatenate the make and model...
-      */
-
-      strlcat(make_model, " ", make_model_size);
-      strlcat(make_model, mdl, make_model_size);
+      strlcpy(make_model, attr, make_model_size);
     }
   }
   else
@@ -298,76 +546,34 @@ get_device_id(
     strlcpy(make_model, "Unknown", make_model_size);
   }
 
+ /*
+  * Strip trailing data...
+  */
+
   if ((delim = strchr(make_model, ';')) != NULL)
     *delim = '\0';
 
-  if (scheme && uri && uri_size > 32)
-  {
-   /*
-    * Look for the serial number field...
-    */
-
-    if ((attr = strstr(device_id, "SERN:")) != NULL)
-      attr += 5;
-    else if ((attr = strstr(device_id, "SERIALNUMBER:")) != NULL)
-      attr += 13;
-    else if ((attr = strstr(device_id, ";SN:")) != NULL)
-      attr += 4;
-
-    if (attr)
-    {
-      strlcpy(serial_number, attr, sizeof(serial_number));
+ /*
+  * Strip trailing whitespace...
+  */
 
-      if ((delim = strchr(serial_number, ';')) != NULL)
-       *delim = '\0';
-    }
+  for (delim = make_model + strlen(make_model) - 1; delim >= make_model; delim --)
+    if (isspace(*delim & 255))
+      *delim = '\0';
     else
-      serial_number[0] = '\0';
+      break;
 
-   /*
-    * Generate the device URI from the make_model and serial number strings.
-    */
-
-    snprintf(uri, uri_size, "%s://", scheme);
-    for (uriptr = uri + strlen(uri), delim = make_model;
-        *delim && uriptr < (uri + uri_size - 1);
-        delim ++)
-      if (*delim == ' ')
-      {
-       delim ++;
-       *uriptr++ = '/';
-       break;
-      }
-      else
-       *uriptr++ = *delim;
-
-    for (; *delim && uriptr < (uri + uri_size - 3); delim ++)
-      if (*delim == ' ')
-      {
-       *uriptr++ = '%';
-       *uriptr++ = '2';
-       *uriptr++ = '0';
-      }
-      else
-       *uriptr++ = *delim;
-
-    *uriptr = '\0';
-
-    if (serial_number[0])
-    {
-     /*
-      * Add the serial number to the URI...
-      */
-
-      strlcat(uri, "?serial=", uri_size);
-      strlcat(uri, serial_number, uri_size);
-    }
-  }
+ /*
+  * Return...
+  */
 
-  return (0);
+  if (make_model[0])
+    return (0);
+  else
+    return (-1);
 }
 
 
 /*
- * End of "$Id: ieee1284.c 4903 2006-01-10 20:02:46Z mike $".
+ * End of "$Id: ieee1284.c 7019 2007-10-10 22:48:52Z mike $".
  */