4 * LIBUSB interface code for CUPS.
6 * Copyright 2007-2015 by Apple Inc.
8 * These coded instructions, statements, and computer programs are the
9 * property of Apple Inc. and are protected by Federal copyright
10 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
11 * which should have been included with this file. If this file is
12 * file is missing or damaged, see the license at "http://www.cups.org/".
16 * Include necessary headers...
20 #include <cups/cups-private.h>
23 #include <sys/select.h>
24 #include <sys/types.h>
31 * WAIT_EOF_DELAY is number of seconds we'll wait for responses from
32 * the printer after we've finished sending all the data
36 #define WAIT_EOF_DELAY 7
37 #define WAIT_SIDE_DELAY 3
38 #define DEFAULT_TIMEOUT 5000L
45 typedef struct usb_printer_s
/**** USB Printer Data ****/
47 struct libusb_device
*device
; /* Device info */
48 int conf
, /* Configuration */
49 origconf
, /* Original configuration */
50 iface
, /* Interface */
51 altset
, /* Alternate setting */
52 write_endp
, /* Write endpoint */
53 read_endp
, /* Read endpoint */
54 protocol
, /* Protocol: 1 = Uni-di, 2 = Bi-di. */
55 usblp_attached
, /* "usblp" kernel module attached? */
56 reset_after_job
;/* Set to 1 by print_device() */
57 unsigned quirks
; /* Quirks flags */
58 struct libusb_device_handle
*handle
; /* Open handle to device */
61 typedef int (*usb_cb_t
)(usb_printer_t
*, const char *, const char *,
64 typedef struct usb_globals_s
/* Global USB printer information */
66 usb_printer_t
*printer
; /* Printer */
68 pthread_mutex_t read_thread_mutex
;
69 pthread_cond_t read_thread_cond
;
73 pthread_mutex_t readwrite_lock_mutex
;
74 pthread_cond_t readwrite_lock_cond
;
77 int print_fd
; /* File descriptor to print */
78 ssize_t print_bytes
; /* Print bytes read */
81 int drain_output
; /* Drain all pending output */
82 int bidi_flag
; /* 0=unidirectional, 1=bidirectional */
84 pthread_mutex_t sidechannel_thread_mutex
;
85 pthread_cond_t sidechannel_thread_cond
;
86 int sidechannel_thread_stop
;
87 int sidechannel_thread_done
;
91 * Quirks: various printer quirks are handled by this structure and its flags.
93 * The quirks table used to be compiled into the backend but is now loaded from
94 * one or more files in the /usr/share/cups/usb directory.
97 #define USB_QUIRK_BLACKLIST 0x0001 /* Does not conform to the spec */
98 #define USB_QUIRK_NO_REATTACH 0x0002 /* After printing we cannot re-attach
99 the usblp kernel module */
100 #define USB_QUIRK_SOFT_RESET 0x0004 /* After printing do a soft reset
102 #define USB_QUIRK_UNIDIR 0x0008 /* Requires unidirectional mode */
103 #define USB_QUIRK_USB_INIT 0x0010 /* Needs vendor USB init string */
104 #define USB_QUIRK_VENDOR_CLASS 0x0020 /* Descriptor uses vendor-specific
106 #define USB_QUIRK_DELAY_CLOSE 0x0040 /* Delay close */
107 #define USB_QUIRK_WHITELIST 0x0000 /* no quirks */
110 typedef struct usb_quirk_s
/* USB "quirk" information */
112 int vendor_id
, /* Affected vendor ID */
113 product_id
; /* Affected product ID or 0 for all */
114 unsigned quirks
; /* Quirks bitfield */
124 cups_array_t
*all_quirks
; /* Array of printer quirks */
125 usb_globals_t g
= { 0 }; /* Globals */
126 libusb_device
**all_list
; /* List of connected USB devices */
133 static int close_device(usb_printer_t
*printer
);
134 static int compare_quirks(usb_quirk_t
*a
, usb_quirk_t
*b
);
135 static usb_printer_t
*find_device(usb_cb_t cb
, const void *data
);
136 static unsigned find_quirks(int vendor_id
, int product_id
);
137 static int get_device_id(usb_printer_t
*printer
, char *buffer
,
139 static int list_cb(usb_printer_t
*printer
, const char *device_uri
,
140 const char *device_id
, const void *data
);
141 static void load_quirks(void);
142 static char *make_device_uri(usb_printer_t
*printer
,
143 const char *device_id
,
144 char *uri
, size_t uri_size
);
145 static int open_device(usb_printer_t
*printer
, int verbose
);
146 static int print_cb(usb_printer_t
*printer
, const char *device_uri
,
147 const char *device_id
, const void *data
);
148 static void *read_thread(void *reference
);
149 static void *sidechannel_thread(void *reference
);
150 static void soft_reset(void);
151 static int soft_reset_printer(usb_printer_t
*printer
);
155 * 'list_devices()' - List the available printers.
163 fputs("DEBUG: list_devices\n", stderr
);
164 find_device(list_cb
, NULL
);
169 * 'print_device()' - Print a file to a USB device.
172 int /* O - Exit status */
173 print_device(const char *uri
, /* I - Device URI */
174 const char *hostname
, /* I - Hostname/manufacturer */
175 const char *resource
, /* I - Resource/modelname */
176 char *options
, /* I - Device options/serial number */
177 int print_fd
, /* I - File descriptor to print */
178 int copies
, /* I - Copies to print */
179 int argc
, /* I - Number of command-line arguments (6 or 7) */
180 char *argv
[]) /* I - Command-line arguments */
182 int bytes
; /* Bytes written */
183 ssize_t total_bytes
; /* Total bytes written */
184 struct sigaction action
; /* Actions for POSIX signals */
185 int status
= CUPS_BACKEND_OK
,
186 /* Function results */
187 iostatus
; /* Current IO status */
188 pthread_t read_thread_id
, /* Read thread */
189 sidechannel_thread_id
; /* Side-channel thread */
190 int have_sidechannel
= 0, /* Was the side-channel thread started? */
191 have_backchannel
= 0; /* Do we have a back channel? */
192 struct stat sidechannel_info
; /* Side-channel file descriptor info */
193 unsigned char print_buffer
[8192], /* Print data buffer */
194 *print_ptr
; /* Pointer into print data buffer */
195 fd_set input_set
; /* Input set for select() */
196 int nfds
; /* Number of file descriptors */
197 struct timeval
*timeout
, /* Timeout pointer */
199 struct timespec cond_timeout
; /* pthread condition timeout */
200 int num_opts
; /* Number of options */
201 cups_option_t
*opts
; /* Options */
202 const char *val
; /* Option value */
208 * See if the side-channel descriptor is valid...
211 have_sidechannel
= !fstat(CUPS_SC_FD
, &sidechannel_info
) &&
212 S_ISSOCK(sidechannel_info
.st_mode
);
214 g
.wait_eof
= WAIT_EOF
;
217 * Connect to the printer...
220 fprintf(stderr
, "DEBUG: Printing on printer with URI: %s\n", uri
);
221 while ((g
.printer
= find_device(print_cb
, uri
)) == NULL
)
223 _cupsLangPrintFilter(stderr
, "INFO",
224 _("Waiting for printer to become available."));
228 g
.print_fd
= print_fd
;
231 * Some devices need a reset after finishing a job, these devices are
232 * marked with the USB_QUIRK_SOFT_RESET quirk.
234 g
.printer
->reset_after_job
= (g
.printer
->quirks
& USB_QUIRK_SOFT_RESET
? 1 : 0);
237 * If we are printing data from a print driver on stdin, ignore SIGTERM
238 * so that the driver can finish out any page data, e.g. to eject the
239 * current page. We only do this for stdin printing as otherwise there
240 * is no way to cancel a raw print job...
245 memset(&action
, 0, sizeof(action
));
247 sigemptyset(&action
.sa_mask
);
248 action
.sa_handler
= SIG_IGN
;
249 sigaction(SIGTERM
, &action
, NULL
);
253 * Start the side channel thread if the descriptor is valid...
256 pthread_mutex_init(&g
.readwrite_lock_mutex
, NULL
);
257 pthread_cond_init(&g
.readwrite_lock_cond
, NULL
);
258 g
.readwrite_lock
= 1;
260 if (have_sidechannel
)
262 g
.sidechannel_thread_stop
= 0;
263 g
.sidechannel_thread_done
= 0;
265 pthread_cond_init(&g
.sidechannel_thread_cond
, NULL
);
266 pthread_mutex_init(&g
.sidechannel_thread_mutex
, NULL
);
268 if (pthread_create(&sidechannel_thread_id
, NULL
, sidechannel_thread
, NULL
))
270 fprintf(stderr
, "DEBUG: Fatal USB error.\n");
271 _cupsLangPrintFilter(stderr
, "ERROR",
272 _("There was an unrecoverable USB error."));
273 fputs("DEBUG: Couldn't create side-channel thread.\n", stderr
);
274 close_device(g
.printer
);
275 return (CUPS_BACKEND_STOP
);
280 * Debug mode: If option "usb-unidir" is given, always deactivate
284 num_opts
= cupsParseOptions(argv
[5], 0, &opts
);
285 val
= cupsGetOption("usb-unidir", num_opts
, opts
);
286 if (val
&& strcasecmp(val
, "no") && strcasecmp(val
, "off") &&
287 strcasecmp(val
, "false"))
289 g
.printer
->read_endp
= -1;
290 fprintf(stderr
, "DEBUG: Forced uni-directional communication "
291 "via \"usb-unidir\" option.\n");
295 * Debug mode: If option "usb-no-reattach" is given, do not re-attach
296 * the usblp kernel module after the job has completed.
299 val
= cupsGetOption("usb-no-reattach", num_opts
, opts
);
300 if (val
&& strcasecmp(val
, "no") && strcasecmp(val
, "off") &&
301 strcasecmp(val
, "false"))
303 g
.printer
->usblp_attached
= 0;
304 fprintf(stderr
, "DEBUG: Forced not re-attaching the usblp kernel module "
305 "after the job via \"usb-no-reattach\" option.\n");
309 * Get the read thread going...
312 if (g
.printer
->read_endp
!= -1)
314 have_backchannel
= 1;
316 g
.read_thread_stop
= 0;
317 g
.read_thread_done
= 0;
319 pthread_cond_init(&g
.read_thread_cond
, NULL
);
320 pthread_mutex_init(&g
.read_thread_mutex
, NULL
);
322 if (pthread_create(&read_thread_id
, NULL
, read_thread
, NULL
))
324 fprintf(stderr
, "DEBUG: Fatal USB error.\n");
325 _cupsLangPrintFilter(stderr
, "ERROR",
326 _("There was an unrecoverable USB error."));
327 fputs("DEBUG: Couldn't create read thread.\n", stderr
);
328 close_device(g
.printer
);
329 return (CUPS_BACKEND_STOP
);
333 fprintf(stderr
, "DEBUG: Uni-directional device/mode, back channel "
337 * The main thread sends the print file...
343 print_ptr
= print_buffer
;
345 while (status
== CUPS_BACKEND_OK
&& copies
-- > 0)
347 _cupsLangPrintFilter(stderr
, "INFO", _("Sending data to printer."));
349 if (print_fd
!= STDIN_FILENO
)
351 fputs("PAGE: 1 1\n", stderr
);
352 lseek(print_fd
, 0, SEEK_SET
);
355 while (status
== CUPS_BACKEND_OK
)
360 FD_SET(print_fd
, &input_set
);
363 * Calculate select timeout...
364 * If we have data waiting to send timeout is 100ms.
365 * else if we're draining print_fd timeout is 0.
366 * else we're waiting forever...
372 tv
.tv_usec
= 100000; /* 100ms */
375 else if (g
.drain_output
)
385 * I/O is unlocked around select...
388 pthread_mutex_lock(&g
.readwrite_lock_mutex
);
389 g
.readwrite_lock
= 0;
390 pthread_cond_signal(&g
.readwrite_lock_cond
);
391 pthread_mutex_unlock(&g
.readwrite_lock_mutex
);
393 nfds
= select(print_fd
+ 1, &input_set
, NULL
, NULL
, timeout
);
396 * Reacquire the lock...
399 pthread_mutex_lock(&g
.readwrite_lock_mutex
);
400 while (g
.readwrite_lock
)
401 pthread_cond_wait(&g
.readwrite_lock_cond
, &g
.readwrite_lock_mutex
);
402 g
.readwrite_lock
= 1;
403 pthread_mutex_unlock(&g
.readwrite_lock_mutex
);
407 if (errno
== EINTR
&& total_bytes
== 0)
409 fputs("DEBUG: Received an interrupt before any bytes were "
410 "written, aborting.\n", stderr
);
411 close_device(g
.printer
);
412 return (CUPS_BACKEND_OK
);
414 else if (errno
!= EAGAIN
&& errno
!= EINTR
)
416 _cupsLangPrintFilter(stderr
, "ERROR",
417 _("Unable to read print data."));
418 perror("DEBUG: select");
419 close_device(g
.printer
);
420 return (CUPS_BACKEND_FAILED
);
425 * If drain output has finished send a response...
428 if (g
.drain_output
&& !nfds
&& !g
.print_bytes
)
430 /* Send a response... */
431 cupsSideChannelWrite(CUPS_SC_CMD_DRAIN_OUTPUT
, CUPS_SC_STATUS_OK
, NULL
, 0, 1.0);
436 * Check if we have print data ready...
439 if (FD_ISSET(print_fd
, &input_set
))
441 g
.print_bytes
= read(print_fd
, print_buffer
, sizeof(print_buffer
));
443 if (g
.print_bytes
< 0)
446 * Read error - bail if we don't see EAGAIN or EINTR...
449 if (errno
!= EAGAIN
&& errno
!= EINTR
)
451 _cupsLangPrintFilter(stderr
, "ERROR",
452 _("Unable to read print data."));
453 perror("DEBUG: read");
454 close_device(g
.printer
);
455 return (CUPS_BACKEND_FAILED
);
460 else if (g
.print_bytes
== 0)
463 * End of file, break out of the loop...
469 print_ptr
= print_buffer
;
471 fprintf(stderr
, "DEBUG: Read %d bytes of print data...\n",
477 iostatus
= libusb_bulk_transfer(g
.printer
->handle
,
478 g
.printer
->write_endp
,
479 print_buffer
, g
.print_bytes
,
482 * Ignore timeout errors, but retain the number of bytes written to
483 * avoid sending duplicate data...
486 if (iostatus
== LIBUSB_ERROR_TIMEOUT
)
488 fputs("DEBUG: Got USB transaction timeout during write.\n", stderr
);
493 * If we've stalled, retry the write...
496 else if (iostatus
== LIBUSB_ERROR_PIPE
)
498 fputs("DEBUG: Got USB pipe stalled during write.\n", stderr
);
500 iostatus
= libusb_bulk_transfer(g
.printer
->handle
,
501 g
.printer
->write_endp
,
502 print_buffer
, g
.print_bytes
,
507 * Retry a write after an aborted write since we probably just got
511 else if (iostatus
== LIBUSB_ERROR_INTERRUPTED
)
513 fputs("DEBUG: Got USB return aborted during write.\n", stderr
);
515 iostatus
= libusb_bulk_transfer(g
.printer
->handle
,
516 g
.printer
->write_endp
,
517 print_buffer
, g
.print_bytes
,
524 * Write error - bail if we don't see an error we can retry...
527 _cupsLangPrintFilter(stderr
, "ERROR",
528 _("Unable to send data to printer."));
529 fprintf(stderr
, "DEBUG: libusb write operation returned %x.\n",
532 status
= CUPS_BACKEND_FAILED
;
537 fprintf(stderr
, "DEBUG: Wrote %d bytes of print data...\n",
540 g
.print_bytes
-= bytes
;
542 total_bytes
+= bytes
;
546 if (print_fd
!= 0 && status
== CUPS_BACKEND_OK
)
547 fprintf(stderr
, "DEBUG: Sending print file, " CUPS_LLFMT
" bytes...\n",
548 CUPS_LLCAST total_bytes
);
552 fprintf(stderr
, "DEBUG: Sent " CUPS_LLFMT
" bytes...\n",
553 CUPS_LLCAST total_bytes
);
556 * Signal the side channel thread to exit...
559 if (have_sidechannel
)
562 pthread_mutex_lock(&g
.readwrite_lock_mutex
);
563 g
.readwrite_lock
= 0;
564 pthread_cond_signal(&g
.readwrite_lock_cond
);
565 pthread_mutex_unlock(&g
.readwrite_lock_mutex
);
567 g
.sidechannel_thread_stop
= 1;
568 pthread_mutex_lock(&g
.sidechannel_thread_mutex
);
570 if (!g
.sidechannel_thread_done
)
572 gettimeofday(&tv
, NULL
);
573 cond_timeout
.tv_sec
= tv
.tv_sec
+ WAIT_SIDE_DELAY
;
574 cond_timeout
.tv_nsec
= tv
.tv_usec
* 1000;
576 while (!g
.sidechannel_thread_done
)
578 if (pthread_cond_timedwait(&g
.sidechannel_thread_cond
,
579 &g
.sidechannel_thread_mutex
,
585 pthread_mutex_unlock(&g
.sidechannel_thread_mutex
);
589 * Signal the read thread to exit then wait 7 seconds for it to complete...
592 if (have_backchannel
)
594 g
.read_thread_stop
= 1;
596 pthread_mutex_lock(&g
.read_thread_mutex
);
598 if (!g
.read_thread_done
)
600 fputs("DEBUG: Waiting for read thread to exit...\n", stderr
);
602 gettimeofday(&tv
, NULL
);
603 cond_timeout
.tv_sec
= tv
.tv_sec
+ WAIT_EOF_DELAY
;
604 cond_timeout
.tv_nsec
= tv
.tv_usec
* 1000;
606 while (!g
.read_thread_done
)
608 if (pthread_cond_timedwait(&g
.read_thread_cond
, &g
.read_thread_mutex
,
614 * If it didn't exit abort the pending read and wait an additional
618 if (!g
.read_thread_done
)
620 fputs("DEBUG: Read thread still active, aborting the pending read...\n",
625 gettimeofday(&tv
, NULL
);
626 cond_timeout
.tv_sec
= tv
.tv_sec
+ 1;
627 cond_timeout
.tv_nsec
= tv
.tv_usec
* 1000;
629 while (!g
.read_thread_done
)
631 if (pthread_cond_timedwait(&g
.read_thread_cond
, &g
.read_thread_mutex
,
638 pthread_mutex_unlock(&g
.read_thread_mutex
);
642 * Close the connection and input file and general clean up...
645 if (g
.printer
.quirks
& USB_QUIRK_DELAY_CLOSE
)
648 close_device(g
.printer
);
654 libusb_free_device_list(all_list
, 1);
662 * 'close_device()' - Close the connection to the USB printer.
665 static int /* I - 0 on success, -1 on failure */
666 close_device(usb_printer_t
*printer
) /* I - Printer */
668 struct libusb_device_descriptor devdesc
;
669 /* Current device descriptor */
670 struct libusb_config_descriptor
*confptr
;
671 /* Pointer to current configuration */
677 * Release interfaces before closing so that we know all data is written
681 int errcode
; /* Return value of libusb function */
682 int number1
, /* Interface number */
683 number2
; /* Configuration number */
686 libusb_get_config_descriptor(printer
->device
, printer
->conf
, &confptr
);
689 number1
= confptr
->interface
[printer
->iface
].
690 altsetting
[printer
->altset
].bInterfaceNumber
;
691 libusb_release_interface(printer
->handle
, number1
);
693 number2
= confptr
->bConfigurationValue
;
695 libusb_free_config_descriptor(confptr
);
698 * If we have changed the configuration from one valid configuration
699 * to another, restore the old one
701 if (printer
->origconf
> 0 && printer
->origconf
!= number2
)
703 fprintf(stderr
, "DEBUG: Restoring USB device configuration: %d -> %d\n",
704 number2
, printer
->origconf
);
705 if ((errcode
= libusb_set_configuration(printer
->handle
,
706 printer
->origconf
)) < 0)
708 if (errcode
!= LIBUSB_ERROR_BUSY
)
711 libusb_get_device_descriptor (printer
->device
, &devdesc
);
714 "DEBUG: Failed to set configuration %d\n",
718 "DEBUG: Failed to set configuration %d for %04x:%04x\n",
719 printer
->origconf
, devdesc
.idVendor
, devdesc
.idProduct
);
725 * Re-attach "usblp" kernel module if it was attached before using this
728 if (printer
->usblp_attached
== 1)
729 if (libusb_attach_kernel_driver(printer
->handle
, number1
) < 0)
731 errcode
= libusb_get_device_descriptor (printer
->device
, &devdesc
);
734 "DEBUG: Failed to re-attach \"usblp\" kernel module\n");
737 "DEBUG: Failed to re-attach \"usblp\" kernel module to "
738 "%04x:%04x\n", devdesc
.idVendor
, devdesc
.idProduct
);
743 "DEBUG: Failed to get configuration descriptor %d\n",
747 * Reset the device to clean up after the job
750 if (printer
->reset_after_job
== 1)
752 if ((errcode
= libusb_reset_device(printer
->handle
)) < 0)
754 "DEBUG: Device reset failed, error code: %d\n",
758 "DEBUG: Resetting printer.\n");
762 * Close the interface and return...
765 libusb_close(printer
->handle
);
766 printer
->handle
= NULL
;
774 * 'compare_quirks()' - Compare two quirks entries.
777 static int /* O - Result of comparison */
778 compare_quirks(usb_quirk_t
*a
, /* I - First quirk entry */
779 usb_quirk_t
*b
) /* I - Second quirk entry */
781 int result
; /* Result of comparison */
783 if ((result
= b
->vendor_id
- a
->vendor_id
) == 0)
784 result
= b
->product_id
- a
->product_id
;
791 * 'find_device()' - Find or enumerate USB printers.
794 static usb_printer_t
* /* O - Found printer */
795 find_device(usb_cb_t cb
, /* I - Callback function */
796 const void *data
) /* I - User data for callback */
798 libusb_device
**list
; /* List of connected USB devices */
799 libusb_device
*device
= NULL
; /* Current device */
800 struct libusb_device_descriptor devdesc
;
801 /* Current device descriptor */
802 struct libusb_config_descriptor
*confptr
= NULL
;
803 /* Pointer to current configuration */
804 const struct libusb_interface
*ifaceptr
= NULL
;
805 /* Pointer to current interface */
806 const struct libusb_interface_descriptor
*altptr
= NULL
;
807 /* Pointer to current alternate setting */
808 const struct libusb_endpoint_descriptor
*endpptr
= NULL
;
809 /* Pointer to current endpoint */
810 ssize_t err
= 0, /* Error code */
811 numdevs
, /* number of connected devices */
813 uint8_t conf
, /* Current configuration */
814 iface
, /* Current interface */
815 altset
, /* Current alternate setting */
816 protocol
, /* Current protocol */
817 endp
, /* Current endpoint */
818 read_endp
, /* Current read endpoint */
819 write_endp
; /* Current write endpoint */
820 char device_id
[1024],/* IEEE-1284 device ID */
823 static usb_printer_t printer
; /* Current printer */
827 * Initialize libusb...
830 err
= libusb_init(NULL
);
833 fprintf(stderr
, "DEBUG: Unable to initialize USB access via libusb, "
834 "libusb error %i\n", (int)err
);
838 numdevs
= libusb_get_device_list(NULL
, &list
);
839 fprintf(stderr
, "DEBUG: libusb_get_device_list=%d\n", (int)numdevs
);
842 * Then loop through the devices it found...
846 for (i
= 0; i
< numdevs
; i
++)
851 * Ignore devices with no configuration data and anything that is not
855 if (libusb_get_device_descriptor(device
, &devdesc
) < 0)
858 if (!devdesc
.bNumConfigurations
|| !devdesc
.idVendor
||
862 printer
.quirks
= find_quirks(devdesc
.idVendor
, devdesc
.idProduct
);
865 * Ignore blacklisted printers...
868 if (printer
.quirks
& USB_QUIRK_BLACKLIST
)
871 for (conf
= 0; conf
< devdesc
.bNumConfigurations
; conf
++)
873 if (libusb_get_config_descriptor(device
, conf
, &confptr
) < 0)
875 for (iface
= 0, ifaceptr
= confptr
->interface
;
876 iface
< confptr
->bNumInterfaces
;
877 iface
++, ifaceptr
++)
880 * Some printers offer multiple interfaces...
885 for (altset
= 0, altptr
= ifaceptr
->altsetting
;
886 altset
< ifaceptr
->num_altsetting
;
887 altset
++, altptr
++)
890 * Currently we only support unidirectional and bidirectional
891 * printers. Future versions of this code will support the
892 * 1284.4 (packet mode) protocol as well.
895 if (((altptr
->bInterfaceClass
!= LIBUSB_CLASS_PRINTER
||
896 altptr
->bInterfaceSubClass
!= 1) &&
897 ((printer
.quirks
& USB_QUIRK_VENDOR_CLASS
) == 0)) ||
898 (altptr
->bInterfaceProtocol
!= 1 && /* Unidirectional */
899 altptr
->bInterfaceProtocol
!= 2) || /* Bidirectional */
900 altptr
->bInterfaceProtocol
< protocol
)
903 if (printer
.quirks
& USB_QUIRK_VENDOR_CLASS
)
904 fprintf(stderr
, "DEBUG: Printer does not report class 7 and/or "
905 "subclass 1 but works as a printer anyway\n");
910 for (endp
= 0, endpptr
= altptr
->endpoint
;
911 endp
< altptr
->bNumEndpoints
;
913 if ((endpptr
->bmAttributes
& LIBUSB_TRANSFER_TYPE_MASK
) ==
914 LIBUSB_TRANSFER_TYPE_BULK
)
916 if (endpptr
->bEndpointAddress
& LIBUSB_ENDPOINT_DIR_MASK
)
922 if (write_endp
!= 0xff)
925 * Save the best match so far...
928 protocol
= altptr
->bInterfaceProtocol
;
929 printer
.altset
= altset
;
930 printer
.write_endp
= write_endp
;
932 printer
.read_endp
= read_endp
;
934 printer
.read_endp
= -1;
940 printer
.device
= device
;
942 printer
.iface
= iface
;
943 printer
.protocol
= protocol
;
944 printer
.handle
= NULL
;
946 if (!open_device(&printer
, data
!= NULL
))
948 get_device_id(&printer
, device_id
, sizeof(device_id
));
949 make_device_uri(&printer
, device_id
, device_uri
,
952 fprintf(stderr
, "DEBUG2: Printer found with device ID: %s "
954 device_id
, device_uri
);
956 if ((*cb
)(&printer
, device_uri
, device_id
, data
))
958 fprintf(stderr
, "DEBUG: Device protocol: %d\n",
960 if (printer
.quirks
& USB_QUIRK_UNIDIR
)
962 printer
.read_endp
= -1;
963 fprintf(stderr
, "DEBUG: Printer reports bi-di support "
964 "but in reality works only uni-directionally\n");
966 if (printer
.read_endp
!= -1)
968 printer
.read_endp
= confptr
->interface
[printer
.iface
].
969 altsetting
[printer
.altset
].
970 endpoint
[printer
.read_endp
].
974 fprintf(stderr
, "DEBUG: Uni-directional USB communication "
976 printer
.write_endp
= confptr
->interface
[printer
.iface
].
977 altsetting
[printer
.altset
].
978 endpoint
[printer
.write_endp
].
980 if (printer
.quirks
& USB_QUIRK_NO_REATTACH
)
982 printer
.usblp_attached
= 0;
983 fprintf(stderr
, "DEBUG: Printer does not like usblp "
984 "kernel module to be re-attached after job\n");
986 libusb_free_config_descriptor(confptr
);
990 close_device(&printer
);
994 libusb_free_config_descriptor(confptr
);
999 * If we get this far without returning, then we haven't found a printer
1008 libusb_free_device_list(list
, 1);
1016 * 'find_quirks()' - Find the quirks for the given printer, if any.
1018 * First looks for an exact match, then looks for the vendor ID wildcard match.
1021 static unsigned /* O - Quirks flags */
1022 find_quirks(int vendor_id
, /* I - Vendor ID */
1023 int product_id
) /* I - Product ID */
1025 usb_quirk_t key
, /* Search key */
1026 *match
; /* Matching quirk entry */
1029 key
.vendor_id
= vendor_id
;
1030 key
.product_id
= product_id
;
1032 if ((match
= cupsArrayFind(all_quirks
, &key
)) != NULL
)
1033 return (match
->quirks
);
1037 if ((match
= cupsArrayFind(all_quirks
, &key
)) != NULL
)
1038 return (match
->quirks
);
1040 return (USB_QUIRK_WHITELIST
);
1045 * 'get_device_id()' - Get the IEEE-1284 device ID for the printer.
1048 static int /* O - 0 on success, -1 on error */
1049 get_device_id(usb_printer_t
*printer
, /* I - Printer */
1050 char *buffer
, /* I - String buffer */
1051 size_t bufsize
) /* I - Number of bytes in buffer */
1053 int length
; /* Length of device ID */
1056 if (libusb_control_transfer(printer
->handle
,
1057 LIBUSB_REQUEST_TYPE_CLASS
| LIBUSB_ENDPOINT_IN
|
1058 LIBUSB_RECIPIENT_INTERFACE
,
1060 (printer
->iface
<< 8) | printer
->altset
,
1061 (unsigned char *)buffer
, bufsize
, 5000) < 0)
1068 * Extract the length of the device ID string from the first two
1069 * bytes. The 1284 spec says the length is stored MSB first...
1072 length
= (int)((((unsigned)buffer
[0] & 255) << 8) | ((unsigned)buffer
[1] & 255));
1075 * Check to see if the length is larger than our buffer or less than 14 bytes
1076 * (the minimum valid device ID is "MFG:x;MDL:y;" with 2 bytes for the length).
1078 * If the length is out-of-range, assume that the vendor incorrectly
1079 * implemented the 1284 spec and re-read the length as LSB first,..
1082 if (length
> bufsize
|| length
< 14)
1083 length
= (int)((((unsigned)buffer
[1] & 255) << 8) | ((unsigned)buffer
[0] & 255));
1085 if (length
> bufsize
)
1091 * Invalid device ID, clear it!
1101 * Copy the device ID text to the beginning of the buffer and
1105 memmove(buffer
, buffer
+ 2, (size_t)length
);
1106 buffer
[length
] = '\0';
1113 * 'list_cb()' - List USB printers for discovery.
1116 static int /* O - 0 to continue, 1 to stop */
1117 list_cb(usb_printer_t
*printer
, /* I - Printer */
1118 const char *device_uri
, /* I - Device URI */
1119 const char *device_id
, /* I - IEEE-1284 device ID */
1120 const void *data
) /* I - User data (not used) */
1122 char make_model
[1024]; /* Make and model */
1126 * Get the device URI and make/model strings...
1129 if (backendGetMakeModel(device_id
, make_model
, sizeof(make_model
)))
1130 strlcpy(make_model
, "Unknown", sizeof(make_model
));
1133 * Report the printer...
1136 cupsBackendReport("direct", device_uri
, make_model
, make_model
, device_id
,
1148 * 'load_quirks()' - Load all quirks files in the /usr/share/cups/usb directory.
1154 const char *datadir
; /* CUPS_DATADIR environment variable */
1155 char filename
[1024], /* Filename */
1156 line
[1024]; /* Line from file */
1157 cups_dir_t
*dir
; /* Directory */
1158 cups_dentry_t
*dent
; /* Directory entry */
1159 cups_file_t
*fp
; /* Quirks file */
1160 usb_quirk_t
*quirk
; /* New quirk */
1163 all_quirks
= cupsArrayNew((cups_array_func_t
)compare_quirks
, NULL
);
1165 if ((datadir
= getenv("CUPS_DATADIR")) == NULL
)
1166 datadir
= CUPS_DATADIR
;
1168 snprintf(filename
, sizeof(filename
), "%s/usb", datadir
);
1169 if ((dir
= cupsDirOpen(filename
)) == NULL
)
1175 fprintf(stderr
, "DEBUG: Loading USB quirks from \"%s\".\n", filename
);
1177 while ((dent
= cupsDirRead(dir
)) != NULL
)
1179 if (!S_ISREG(dent
->fileinfo
.st_mode
))
1182 snprintf(filename
, sizeof(filename
), "%s/usb/%s", datadir
, dent
->filename
);
1183 if ((fp
= cupsFileOpen(filename
, "r")) == NULL
)
1189 while (cupsFileGets(fp
, line
, sizeof(line
)))
1192 * Skip blank and comment lines...
1195 if (line
[0] == '#' || !line
[0])
1202 if ((quirk
= calloc(1, sizeof(usb_quirk_t
))) == NULL
)
1204 perror("DEBUG: Unable to allocate memory for quirk");
1208 if (sscanf(line
, "%x%x", &quirk
->vendor_id
, &quirk
->product_id
) < 1)
1210 fprintf(stderr
, "DEBUG: Bad line: %s\n", line
);
1215 if (strstr(line
, " blacklist"))
1216 quirk
->quirks
|= USB_QUIRK_BLACKLIST
;
1218 if (strstr(line
, " delay-close"))
1219 quirk
->quirks
|= USB_QUIRK_DELAY_CLOSE
;
1221 if (strstr(line
, " no-reattach"))
1222 quirk
->quirks
|= USB_QUIRK_NO_REATTACH
;
1224 if (strstr(line
, " soft-reset"))
1225 quirk
->quirks
|= USB_QUIRK_SOFT_RESET
;
1227 if (strstr(line
, " unidir"))
1228 quirk
->quirks
|= USB_QUIRK_UNIDIR
;
1230 if (strstr(line
, " usb-init"))
1231 quirk
->quirks
|= USB_QUIRK_USB_INIT
;
1233 if (strstr(line
, " vendor-class"))
1234 quirk
->quirks
|= USB_QUIRK_VENDOR_CLASS
;
1236 cupsArrayAdd(all_quirks
, quirk
);
1242 fprintf(stderr
, "DEBUG: Loaded %d quirks.\n", cupsArrayCount(all_quirks
));
1249 * 'make_device_uri()' - Create a device URI for a USB printer.
1252 static char * /* O - Device URI */
1254 usb_printer_t
*printer
, /* I - Printer */
1255 const char *device_id
, /* I - IEEE-1284 device ID */
1256 char *uri
, /* I - Device URI buffer */
1257 size_t uri_size
) /* I - Size of device URI buffer */
1259 struct libusb_device_descriptor devdesc
;
1260 /* Current device descriptor */
1261 char options
[1024]; /* Device URI options */
1262 int num_values
; /* Number of 1284 parameters */
1263 cups_option_t
*values
; /* 1284 parameters */
1264 const char *mfg
, /* Manufacturer */
1266 *des
= NULL
, /* Description */
1267 *sern
; /* Serial number */
1268 size_t mfglen
; /* Length of manufacturer string */
1269 char tempmfg
[256], /* Temporary manufacturer string */
1270 tempsern
[256], /* Temporary serial number string */
1271 *tempptr
; /* Pointer into temp string */
1275 * Get the make, model, and serial numbers...
1278 num_values
= _cupsGet1284Values(device_id
, &values
);
1280 if ((sern
= cupsGetOption("SERIALNUMBER", num_values
, values
)) == NULL
)
1281 if ((sern
= cupsGetOption("SERN", num_values
, values
)) == NULL
)
1282 if ((sern
= cupsGetOption("SN", num_values
, values
)) == NULL
&&
1283 ((libusb_get_device_descriptor(printer
->device
, &devdesc
) >= 0) &&
1284 devdesc
.iSerialNumber
))
1287 * Try getting the serial number from the device itself...
1291 libusb_get_string_descriptor_ascii(printer
->handle
,
1292 devdesc
.iSerialNumber
,
1293 (unsigned char *)tempsern
,
1294 sizeof(tempsern
) - 1);
1297 tempsern
[length
] = '\0';
1302 if ((mfg
= cupsGetOption("MANUFACTURER", num_values
, values
)) == NULL
)
1303 mfg
= cupsGetOption("MFG", num_values
, values
);
1305 if ((mdl
= cupsGetOption("MODEL", num_values
, values
)) == NULL
)
1306 mdl
= cupsGetOption("MDL", num_values
, values
);
1309 * To maintain compatibility with the original character device backend on
1310 * Linux and *BSD, map manufacturer names...
1315 if (!_cups_strcasecmp(mfg
, "Hewlett-Packard"))
1317 else if (!_cups_strcasecmp(mfg
, "Lexmark International"))
1323 * No manufacturer? Use the model string or description...
1327 _ppdNormalizeMakeAndModel(mdl
, tempmfg
, sizeof(tempmfg
));
1328 else if ((des
= cupsGetOption("DESCRIPTION", num_values
, values
)) != NULL
||
1329 (des
= cupsGetOption("DES", num_values
, values
)) != NULL
)
1330 _ppdNormalizeMakeAndModel(des
, tempmfg
, sizeof(tempmfg
));
1332 strlcpy(tempmfg
, "Unknown", sizeof(tempmfg
));
1334 if ((tempptr
= strchr(tempmfg
, ' ')) != NULL
)
1343 * No model? Use description...
1346 mdl
= des
; /* We remove the manufacturer name below */
1347 else if (!strncasecmp(mfg
, "Unknown", 7))
1350 mdl
= "Unknown Model";
1353 mfglen
= strlen(mfg
);
1355 if (!strncasecmp(mdl
, mfg
, mfglen
) && _cups_isspace(mdl
[mfglen
]))
1359 while (_cups_isspace(*mdl
))
1364 * Generate the device URI from the manufacturer, model, serial number,
1365 * and interface number...
1370 if (printer
->iface
> 0)
1371 snprintf(options
, sizeof(options
), "?serial=%s&interface=%d", sern
,
1374 snprintf(options
, sizeof(options
), "?serial=%s", sern
);
1376 else if (printer
->iface
> 0)
1377 snprintf(options
, sizeof(options
), "?interface=%d", printer
->iface
);
1381 httpAssembleURIf(HTTP_URI_CODING_ALL
, uri
, uri_size
, "usb", NULL
, mfg
, 0,
1382 "/%s%s", mdl
, options
);
1384 cupsFreeOptions(num_values
, values
);
1391 * 'open_device()' - Open a connection to the USB printer.
1394 static int /* O - 0 on success, -1 on error */
1395 open_device(usb_printer_t
*printer
, /* I - Printer */
1396 int verbose
) /* I - Update connecting-to-device state? */
1398 struct libusb_device_descriptor devdesc
;
1399 /* Current device descriptor */
1400 struct libusb_config_descriptor
*confptr
= NULL
;
1401 /* Pointer to current configuration */
1402 int number1
= -1, /* Configuration/interface/altset */
1403 number2
= -1, /* numbers */
1405 char current
; /* Current configuration */
1409 * Return immediately if we are already connected...
1412 if (printer
->handle
)
1416 * Try opening the printer...
1419 if ((errcode
= libusb_open(printer
->device
, &printer
->handle
)) < 0)
1421 fprintf(stderr
, "DEBUG: Failed to open device, code: %d\n",
1426 printer
->usblp_attached
= 0;
1427 printer
->reset_after_job
= 0;
1430 fputs("STATE: +connecting-to-device\n", stderr
);
1432 if ((errcode
= libusb_get_device_descriptor(printer
->device
, &devdesc
)) < 0)
1434 fprintf(stderr
, "DEBUG: Failed to get device descriptor, code: %d\n",
1440 * Get the "usblp" kernel module out of the way. This backend only
1441 * works without the module attached.
1444 errcode
= libusb_kernel_driver_active(printer
->handle
, printer
->iface
);
1446 printer
->usblp_attached
= 0;
1447 else if (errcode
== 1)
1449 printer
->usblp_attached
= 1;
1451 libusb_detach_kernel_driver(printer
->handle
, printer
->iface
)) < 0)
1453 fprintf(stderr
, "DEBUG: Failed to detach \"usblp\" module from %04x:%04x\n",
1454 devdesc
.idVendor
, devdesc
.idProduct
);
1460 printer
->usblp_attached
= 0;
1462 if (errcode
!= LIBUSB_ERROR_NOT_SUPPORTED
)
1465 "DEBUG: Failed to check whether %04x:%04x has the \"usblp\" "
1466 "kernel module attached\n", devdesc
.idVendor
, devdesc
.idProduct
);
1472 * Set the desired configuration, but only if it needs changing. Some
1473 * printers (e.g., Samsung) don't like libusb_set_configuration. It will
1474 * succeed, but the following print job is sometimes silently lost by the
1478 if (libusb_control_transfer(printer
->handle
,
1479 LIBUSB_REQUEST_TYPE_STANDARD
| LIBUSB_ENDPOINT_IN
|
1480 LIBUSB_RECIPIENT_DEVICE
,
1481 8, /* GET_CONFIGURATION */
1482 0, 0, (unsigned char *)¤t
, 1, 5000) < 0)
1483 current
= 0; /* Assume not configured */
1485 printer
->origconf
= current
;
1488 libusb_get_config_descriptor (printer
->device
, printer
->conf
, &confptr
))
1491 fprintf(stderr
, "DEBUG: Failed to get config descriptor for %04x:%04x\n",
1492 devdesc
.idVendor
, devdesc
.idProduct
);
1495 number1
= confptr
->bConfigurationValue
;
1497 if (number1
!= current
)
1499 fprintf(stderr
, "DEBUG: Switching USB device configuration: %d -> %d\n",
1501 if ((errcode
= libusb_set_configuration(printer
->handle
, number1
)) < 0)
1504 * If the set fails, chances are that the printer only supports a
1505 * single configuration. Technically these printers don't conform to
1506 * the USB printer specification, but otherwise they'll work...
1509 if (errcode
!= LIBUSB_ERROR_BUSY
)
1510 fprintf(stderr
, "DEBUG: Failed to set configuration %d for %04x:%04x\n",
1511 number1
, devdesc
.idVendor
, devdesc
.idProduct
);
1516 * Claim interfaces as needed...
1519 number1
= confptr
->interface
[printer
->iface
].
1520 altsetting
[printer
->altset
].bInterfaceNumber
;
1522 while ((errcode
= libusb_claim_interface(printer
->handle
, number1
)) < 0)
1524 if (errcode
!= LIBUSB_ERROR_BUSY
)
1527 "DEBUG: Failed to claim interface %d for %04x:%04x: %s\n",
1528 number1
, devdesc
.idVendor
, devdesc
.idProduct
, strerror(errno
));
1532 else if ((errcode
= libusb_detach_kernel_driver(printer
->handle
, printer
->iface
)) < 0)
1535 "DEBUG: Failed to detach \"usblp\" module from %04x:%04x\n",
1536 devdesc
.idVendor
, devdesc
.idProduct
);
1545 * Set alternate setting, but only if there is more than one option. Some
1546 * printers (e.g., Samsung) don't like usb_set_altinterface.
1549 if (confptr
->interface
[printer
->iface
].num_altsetting
> 1)
1551 number1
= confptr
->interface
[printer
->iface
].
1552 altsetting
[printer
->altset
].bInterfaceNumber
;
1553 number2
= confptr
->interface
[printer
->iface
].
1554 altsetting
[printer
->altset
].bAlternateSetting
;
1557 libusb_set_interface_alt_setting(printer
->handle
, number1
, number2
))
1560 if (errcode
!= LIBUSB_ERROR_BUSY
)
1563 "DEBUG: Failed to set alternate interface %d for %04x:%04x: "
1565 number2
, devdesc
.idVendor
, devdesc
.idProduct
, strerror(errno
));
1572 libusb_free_config_descriptor(confptr
);
1575 fputs("STATE: -connecting-to-device\n", stderr
);
1580 * If we get here, there was a hard error...
1586 fputs("STATE: -connecting-to-device\n", stderr
);
1588 libusb_close(printer
->handle
);
1589 printer
->handle
= NULL
;
1596 * 'print_cb()' - Find a USB printer for printing.
1599 static int /* O - 0 to continue, 1 to stop (found) */
1600 print_cb(usb_printer_t
*printer
, /* I - Printer */
1601 const char *device_uri
, /* I - Device URI */
1602 const char *device_id
, /* I - IEEE-1284 device ID */
1603 const void *data
) /* I - User data (make, model, S/N) */
1605 char requested_uri
[1024], /* Requested URI */
1606 *requested_ptr
, /* Pointer into requested URI */
1607 detected_uri
[1024], /* Detected URI */
1608 *detected_ptr
; /* Pointer into detected URI */
1612 * If we have an exact match, stop now...
1615 if (!strcmp((char *)data
, device_uri
))
1619 * Work on copies of the URIs...
1622 strlcpy(requested_uri
, (char *)data
, sizeof(requested_uri
));
1623 strlcpy(detected_uri
, device_uri
, sizeof(detected_uri
));
1626 * libusb-discovered URIs can have an "interface" specification and this
1627 * never happens for usblp-discovered URIs, so remove the "interface"
1628 * specification from the URI which we are checking currently. This way a
1629 * queue for a usblp-discovered printer can now be accessed via libusb.
1631 * Similarly, strip "?serial=NNN...NNN" as needed.
1634 if ((requested_ptr
= strstr(requested_uri
, "?interface=")) == NULL
)
1635 requested_ptr
= strstr(requested_uri
, "&interface=");
1636 if ((detected_ptr
= strstr(detected_uri
, "?interface=")) == NULL
)
1637 detected_ptr
= strstr(detected_uri
, "&interface=");
1639 if (!requested_ptr
&& detected_ptr
)
1642 * Strip "[?&]interface=nnn" from the detected printer.
1645 *detected_ptr
= '\0';
1647 else if (requested_ptr
&& !detected_ptr
)
1650 * Strip "[?&]interface=nnn" from the requested printer.
1653 *requested_ptr
= '\0';
1656 if ((requested_ptr
= strstr(requested_uri
, "?serial=?")) != NULL
)
1659 * Strip "?serial=?" from the requested printer. This is a special
1660 * case, as "?serial=?" means no serial number and not the serial
1661 * number '?'. This is not covered by the checks below...
1664 *requested_ptr
= '\0';
1667 if ((requested_ptr
= strstr(requested_uri
, "?serial=")) == NULL
&&
1668 (detected_ptr
= strstr(detected_uri
, "?serial=")) != NULL
)
1671 * Strip "?serial=nnn" from the detected printer.
1674 *detected_ptr
= '\0';
1676 else if (requested_ptr
&& !detected_ptr
)
1679 * Strip "?serial=nnn" from the requested printer.
1682 *requested_ptr
= '\0';
1685 return (!strcmp(requested_uri
, detected_uri
));
1690 * 'read_thread()' - Thread to read the backchannel data on.
1693 static void *read_thread(void *reference
)
1695 unsigned char readbuffer
[512];
1707 * Read frequency: once every 250 milliseconds.
1711 delay
.tv_usec
= 250000;
1716 * Remember when we started so we can throttle the loop after the read
1720 gettimeofday(&now
, NULL
);
1723 * Calculate what 250 milliSeconds are in absolute time...
1726 timeradd(&now
, &delay
, &end
);
1728 rbytes
= sizeof(readbuffer
);
1729 readstatus
= libusb_bulk_transfer(g
.printer
->handle
,
1730 g
.printer
->read_endp
,
1733 if (readstatus
== LIBUSB_SUCCESS
&& rbytes
> 0)
1735 fprintf(stderr
, "DEBUG: Read %d bytes of back-channel data...\n",
1737 cupsBackChannelWrite((const char *)readbuffer
, (size_t)rbytes
, 1.0);
1739 else if (readstatus
== LIBUSB_ERROR_TIMEOUT
)
1740 fputs("DEBUG: Got USB transaction timeout during read.\n", stderr
);
1741 else if (readstatus
== LIBUSB_ERROR_PIPE
)
1742 fputs("DEBUG: Got USB pipe stalled during read.\n", stderr
);
1743 else if (readstatus
== LIBUSB_ERROR_INTERRUPTED
)
1744 fputs("DEBUG: Got USB return aborted during read.\n", stderr
);
1747 * Make sure this loop executes no more than once every 250 miliseconds...
1750 if ((readstatus
!= LIBUSB_SUCCESS
|| rbytes
== 0) &&
1751 (g
.wait_eof
|| !g
.read_thread_stop
))
1753 gettimeofday(&now
, NULL
);
1754 if (timercmp(&now
, &end
, <))
1756 timersub(&end
, &now
, &timeleft
);
1757 usleep(1000000 * timeleft
.tv_sec
+ timeleft
.tv_usec
);
1760 } while (g
.wait_eof
|| !g
.read_thread_stop
);
1763 * Let the main thread know that we have completed the read thread...
1766 pthread_mutex_lock(&g
.read_thread_mutex
);
1767 g
.read_thread_done
= 1;
1768 pthread_cond_signal(&g
.read_thread_cond
);
1769 pthread_mutex_unlock(&g
.read_thread_mutex
);
1776 * 'sidechannel_thread()' - Handle side-channel requests.
1780 sidechannel_thread(void *reference
)
1782 cups_sc_command_t command
; /* Request command */
1783 cups_sc_status_t status
; /* Request/response status */
1784 char data
[2048]; /* Request/response data */
1785 int datalen
; /* Request/response data size */
1792 datalen
= sizeof(data
);
1794 if (cupsSideChannelRead(&command
, &status
, data
, &datalen
, 1.0))
1796 if (status
== CUPS_SC_STATUS_TIMEOUT
)
1804 case CUPS_SC_CMD_SOFT_RESET
: /* Do a soft reset */
1805 fputs("DEBUG: CUPS_SC_CMD_SOFT_RESET received from driver...\n",
1809 cupsSideChannelWrite(command
, CUPS_SC_STATUS_OK
, NULL
, 0, 1.0);
1810 fputs("DEBUG: Returning status CUPS_STATUS_OK with no bytes...\n",
1814 case CUPS_SC_CMD_DRAIN_OUTPUT
: /* Drain all pending output */
1815 fputs("DEBUG: CUPS_SC_CMD_DRAIN_OUTPUT received from driver...\n",
1821 case CUPS_SC_CMD_GET_BIDI
: /* Is the connection bidirectional? */
1822 fputs("DEBUG: CUPS_SC_CMD_GET_BIDI received from driver...\n",
1825 data
[0] = (g
.printer
->protocol
>= 2 ? 1 : 0);
1826 cupsSideChannelWrite(command
, CUPS_SC_STATUS_OK
, data
, 1, 1.0);
1829 "DEBUG: Returned CUPS_SC_STATUS_OK with 1 byte (%02X)...\n",
1833 case CUPS_SC_CMD_GET_DEVICE_ID
: /* Return IEEE-1284 device ID */
1834 fputs("DEBUG: CUPS_SC_CMD_GET_DEVICE_ID received from driver...\n",
1837 datalen
= sizeof(data
);
1838 if (get_device_id(g
.printer
, data
, sizeof(data
)))
1840 status
= CUPS_SC_STATUS_IO_ERROR
;
1845 status
= CUPS_SC_STATUS_OK
;
1846 datalen
= strlen(data
);
1848 cupsSideChannelWrite(command
, CUPS_SC_STATUS_OK
, data
, datalen
, 1.0);
1850 if (datalen
< sizeof(data
))
1851 data
[datalen
] = '\0';
1853 data
[sizeof(data
) - 1] = '\0';
1856 "DEBUG: Returning CUPS_SC_STATUS_OK with %d bytes (%s)...\n",
1860 case CUPS_SC_CMD_GET_STATE
: /* Return device state */
1861 fputs("DEBUG: CUPS_SC_CMD_GET_STATE received from driver...\n",
1864 data
[0] = CUPS_SC_STATE_ONLINE
;
1865 cupsSideChannelWrite(command
, CUPS_SC_STATUS_OK
, data
, 1, 1.0);
1868 "DEBUG: Returned CUPS_SC_STATUS_OK with 1 byte (%02X)...\n",
1872 case CUPS_SC_CMD_GET_CONNECTED
: /* Return whether device is
1874 fputs("DEBUG: CUPS_SC_CMD_GET_CONNECTED received from driver...\n",
1877 data
[0] = (g
.printer
->handle
? 1 : 0);
1878 cupsSideChannelWrite(command
, CUPS_SC_STATUS_OK
, data
, 1, 1.0);
1881 "DEBUG: Returned CUPS_SC_STATUS_OK with 1 byte (%02X)...\n",
1886 fprintf(stderr
, "DEBUG: Unknown side-channel command (%d) received "
1887 "from driver...\n", command
);
1889 cupsSideChannelWrite(command
, CUPS_SC_STATUS_NOT_IMPLEMENTED
,
1892 fputs("DEBUG: Returned CUPS_SC_STATUS_NOT_IMPLEMENTED with no bytes...\n",
1897 while (!g
.sidechannel_thread_stop
);
1899 pthread_mutex_lock(&g
.sidechannel_thread_mutex
);
1900 g
.sidechannel_thread_done
= 1;
1901 pthread_cond_signal(&g
.sidechannel_thread_cond
);
1902 pthread_mutex_unlock(&g
.sidechannel_thread_mutex
);
1909 * 'soft_reset()' - Send a soft reset to the device.
1915 fd_set input_set
; /* Input set for select() */
1916 struct timeval tv
; /* Time value */
1917 char buffer
[2048]; /* Buffer */
1918 struct timespec cond_timeout
; /* pthread condition timeout */
1922 * Send an abort once a second until the I/O lock is released by the main
1926 pthread_mutex_lock(&g
.readwrite_lock_mutex
);
1927 while (g
.readwrite_lock
)
1929 gettimeofday(&tv
, NULL
);
1930 cond_timeout
.tv_sec
= tv
.tv_sec
+ 1;
1931 cond_timeout
.tv_nsec
= tv
.tv_usec
* 1000;
1933 while (g
.readwrite_lock
)
1935 if (pthread_cond_timedwait(&g
.readwrite_lock_cond
,
1936 &g
.readwrite_lock_mutex
,
1937 &cond_timeout
) != 0)
1942 g
.readwrite_lock
= 1;
1943 pthread_mutex_unlock(&g
.readwrite_lock_mutex
);
1946 * Flush bytes waiting on print_fd...
1951 FD_ZERO(&input_set
);
1952 FD_SET(g
.print_fd
, &input_set
);
1957 while (select(g
.print_fd
+1, &input_set
, NULL
, NULL
, &tv
) > 0)
1958 if (read(g
.print_fd
, buffer
, sizeof(buffer
)) <= 0)
1965 soft_reset_printer(g
.printer
);
1968 * Release the I/O lock...
1971 pthread_mutex_lock(&g
.readwrite_lock_mutex
);
1972 g
.readwrite_lock
= 0;
1973 pthread_cond_signal(&g
.readwrite_lock_cond
);
1974 pthread_mutex_unlock(&g
.readwrite_lock_mutex
);
1979 * 'soft_reset_printer()' - Do the soft reset request specific to printers
1981 * This soft reset is specific to the printer device class and is much less
1982 * invasive than the general USB reset libusb_reset_device(). Especially it
1983 * does never happen that the USB addressing and configuration changes. What
1984 * is actually done is that all buffers get flushed and the bulk IN and OUT
1985 * pipes get reset to their default states. This clears all stall conditions.
1986 * See http://cholla.mmto.org/computers/linux/usb/usbprint11.pdf
1989 static int /* O - 0 on success, < 0 on error */
1991 usb_printer_t
*printer
) /* I - Printer */
1993 struct libusb_config_descriptor
*confptr
= NULL
;
1994 /* Pointer to current configuration */
1995 int interface
, /* Interface to reset */
1996 errcode
; /* Error code */
1999 if (libusb_get_config_descriptor(printer
->device
, printer
->conf
,
2001 interface
= printer
->iface
;
2003 interface
= confptr
->interface
[printer
->iface
].
2004 altsetting
[printer
->altset
].bInterfaceNumber
;
2006 libusb_free_config_descriptor(confptr
);
2008 if ((errcode
= libusb_control_transfer(printer
->handle
,
2009 LIBUSB_REQUEST_TYPE_CLASS
|
2010 LIBUSB_ENDPOINT_OUT
|
2011 LIBUSB_RECIPIENT_OTHER
,
2012 2, 0, interface
, NULL
, 0, 5000)) < 0)
2013 errcode
= libusb_control_transfer(printer
->handle
,
2014 LIBUSB_REQUEST_TYPE_CLASS
|
2015 LIBUSB_ENDPOINT_OUT
|
2016 LIBUSB_RECIPIENT_INTERFACE
,
2017 2, 0, interface
, NULL
, 0, 5000);