4 * LIBUSB interface code for CUPS.
6 * Copyright 2007-2013 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 * list_devices() - List the available printers.
17 * print_device() - Print a file to a USB device.
18 * close_device() - Close the connection to the USB printer.
19 * find_device() - Find or enumerate USB printers.
20 * get_device_id() - Get the IEEE-1284 device ID for the printer.
21 * list_cb() - List USB printers for discovery.
22 * make_device_uri() - Create a device URI for a USB printer.
23 * open_device() - Open a connection to the USB printer.
24 * print_cb() - Find a USB printer for printing.
25 * printer_class_soft_reset()' - Do the soft reset request specific to
27 * quirks() - Get the known quirks of a given printer model
28 * read_thread() - Thread to read the backchannel data on.
29 * sidechannel_thread() - Handle side-channel requests.
30 * soft_reset() - Send a soft reset to the device.
34 * Include necessary headers...
38 #include <cups/cups-private.h>
40 #include <sys/select.h>
41 #include <sys/types.h>
48 * WAIT_EOF_DELAY is number of seconds we'll wait for responses from
49 * the printer after we've finished sending all the data
53 #define WAIT_EOF_DELAY 7
54 #define WAIT_SIDE_DELAY 3
55 #define DEFAULT_TIMEOUT 5000L
62 typedef struct usb_printer_s
/**** USB Printer Data ****/
64 struct libusb_device
*device
; /* Device info */
65 int conf
, /* Configuration */
66 origconf
, /* Original configuration */
67 iface
, /* Interface */
68 altset
, /* Alternate setting */
69 write_endp
, /* Write endpoint */
70 read_endp
, /* Read endpoint */
71 protocol
, /* Protocol: 1 = Uni-di, 2 = Bi-di. */
72 usblp_attached
, /* "usblp" kernel module attached? */
73 reset_after_job
; /* Set to 1 by print_device() */
74 unsigned int quirks
; /* Quirks flags */
75 struct libusb_device_handle
*handle
; /* Open handle to device */
78 typedef int (*usb_cb_t
)(usb_printer_t
*, const char *, const char *,
81 typedef struct usb_globals_s
83 usb_printer_t
*printer
; /* Printer */
85 pthread_mutex_t read_thread_mutex
;
86 pthread_cond_t read_thread_cond
;
90 pthread_mutex_t readwrite_lock_mutex
;
91 pthread_cond_t readwrite_lock_cond
;
94 int print_fd
; /* File descriptor to print */
95 ssize_t print_bytes
; /* Print bytes read */
98 int drain_output
; /* Drain all pending output */
99 int bidi_flag
; /* 0=unidirectional, 1=bidirectional */
101 pthread_mutex_t sidechannel_thread_mutex
;
102 pthread_cond_t sidechannel_thread_cond
;
103 int sidechannel_thread_stop
;
104 int sidechannel_thread_done
;
108 * Quirks: various printer quirks are handled by this table & its flags.
110 * This is copied from the usblp kernel module. So we can easily copy and paste
111 * new quirks from the module.
114 struct quirk_printer_struct
{
120 #define USBLP_QUIRK_BIDIR 0x1 /* reports bidir but requires
121 unidirectional mode (no INs/reads) */
122 #define USBLP_QUIRK_USB_INIT 0x2 /* needs vendor USB init string */
123 #define USBLP_QUIRK_BAD_CLASS 0x4 /* descriptor uses vendor-specific
125 #define USBLP_QUICK_BLACKLIST 0x8 /* these printers do not conform to the USB print spec */
126 #define USBLP_QUIRK_RESET 0x4000 /* After printing do a reset
128 #define USBLP_QUIRK_NO_REATTACH 0x8000 /* After printing we cannot re-attach
129 the usblp kernel module */
131 static const struct quirk_printer_struct quirk_printers
[] = {
132 { 0x03f0, 0x0004, USBLP_QUIRK_BIDIR
}, /* HP DeskJet 895C */
133 { 0x03f0, 0x0104, USBLP_QUIRK_BIDIR
}, /* HP DeskJet 880C */
134 { 0x03f0, 0x0204, USBLP_QUIRK_BIDIR
}, /* HP DeskJet 815C */
135 { 0x03f0, 0x0304, USBLP_QUIRK_BIDIR
}, /* HP DeskJet 810C/812C */
136 { 0x03f0, 0x0404, USBLP_QUIRK_BIDIR
}, /* HP DeskJet 830C */
137 { 0x03f0, 0x0504, USBLP_QUIRK_BIDIR
}, /* HP DeskJet 885C */
138 { 0x03f0, 0x0604, USBLP_QUIRK_BIDIR
}, /* HP DeskJet 840C */
139 { 0x03f0, 0x0804, USBLP_QUIRK_BIDIR
}, /* HP DeskJet 816C */
140 { 0x03f0, 0x1104, USBLP_QUIRK_BIDIR
}, /* HP Deskjet 959C */
141 { 0x0409, 0xefbe, USBLP_QUIRK_BIDIR
}, /* NEC Picty900 (HP OEM) */
142 { 0x0409, 0xbef4, USBLP_QUIRK_BIDIR
}, /* NEC Picty760 (HP OEM) */
143 { 0x0409, 0xf0be, USBLP_QUIRK_BIDIR
}, /* NEC Picty920 (HP OEM) */
144 { 0x0409, 0xf1be, USBLP_QUIRK_BIDIR
}, /* NEC Picty800 (HP OEM) */
145 { 0x0482, 0x0010, USBLP_QUIRK_BIDIR
}, /* Kyocera Mita FS 820,
146 by zut <kernel@zut.de> */
147 { 0x04a9, 0x10a2, USBLP_QUIRK_BIDIR
}, /* Canon, Inc. PIXMA iP4200
148 Printer, http://www.cups.org/str.php?L4155 */
149 { 0x04a9, 0x10b6, USBLP_QUIRK_BIDIR
}, /* Canon, Inc. PIXMA iP4300
150 Printer, https://bugs.launchpad.net/bugs/1032385 */
151 { 0x04a9, 0x170c, USBLP_QUIRK_BIDIR
}, /* Canon, Inc. MP500
152 Printer, https://bugs.launchpad.net/bugs/1032456 */
153 { 0x04a9, 0x1717, USBLP_QUIRK_BIDIR
}, /* Canon, Inc. MP510
154 Printer, https://bugs.launchpad.net/bugs/1050009 */
155 { 0x04a9, 0x173d, USBLP_QUIRK_BIDIR
}, /* Canon, Inc. MP550
156 Printer, http://www.cups.org/str.php?L4155 */
157 { 0x04a9, 0x173e, USBLP_QUIRK_BIDIR
}, /* Canon, Inc. MP560
158 Printer, http://www.cups.org/str.php?L4155 */
159 { 0x04f9, 0x001a, USBLP_QUIRK_NO_REATTACH
}, /* Brother Industries, Ltd
160 HL-1430 Laser Printer,
161 https://bugs.launchpad.net/bugs/1038695 */
162 { 0x04f9, 0x000d, USBLP_QUIRK_BIDIR
|
163 USBLP_QUIRK_NO_REATTACH
}, /* Brother Industries, Ltd
164 HL-1440 Laser Printer,
165 https://bugs.launchpad.net/bugs/1000253 */
166 { 0x06bc, 0x000b, USBLP_QUIRK_NO_REATTACH
}, /* Oki Data Corp.
167 Okipage 14ex Printer,
168 https://bugs.launchpad.net/bugs/872483 */
169 { 0x06bc, 0x01c7, USBLP_QUIRK_NO_REATTACH
}, /* Oki Data Corp. B410d,
170 https://bugs.launchpad.net/bugs/872483 */
171 { 0x04b8, 0x0202, USBLP_QUIRK_BAD_CLASS
}, /* Seiko Epson Receipt
173 { 0x067b, 0x2305, USBLP_QUIRK_BIDIR
|
174 USBLP_QUIRK_NO_REATTACH
|
176 { 0x0924, 0x3ce9, USBLP_QUIRK_NO_REATTACH
}, /* Xerox Phaser 3124
177 https://bugzilla.redhat.com/show_bug.cgi?id=867392 */
178 /* Prolific Technology, Inc. PL2305 Parallel Port
179 (USB -> Parallel adapter), https://bugs.launchpad.net/bugs/987485 */
180 { 0x04e8, 0x0000, USBLP_QUIRK_RESET
}, /* All Samsung devices,
181 https://bugs.launchpad.net/bugs/1032456 */
182 { 0x0a5f, 0x0000, USBLP_QUIRK_BIDIR
}, /* All Zebra devices,
183 https://bugs.launchpad.net/bugs/1001028 */
185 { 0x04a9, 0x304a, USBLP_QUIRK_BLACKLIST
}, /* Canon CP-10 */
186 { 0x04a9, 0x3063, USBLP_QUIRK_BLACKLIST
}, /* Canon CP-100 */
187 { 0x04a9, 0x307c, USBLP_QUIRK_BLACKLIST
}, /* Canon CP-200 */
188 { 0x04a9, 0x307d, USBLP_QUIRK_BLACKLIST
}, /* Canon CP-300 */
189 { 0x04a9, 0x30bd, USBLP_QUIRK_BLACKLIST
}, /* Canon CP-220 */
190 { 0x04a9, 0x30be, USBLP_QUIRK_BLACKLIST
}, /* Canon CP-330 */
191 { 0x04a9, 0x30f6, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY CP400 */
192 { 0x04a9, 0x310b, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY CP600 */
193 { 0x04a9, 0x3127, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY CP710 */
194 { 0x04a9, 0x3128, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY CP510 */
195 { 0x04a9, 0x3141, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY ES1 */
196 { 0x04a9, 0x3142, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY CP730 */
197 { 0x04a9, 0x3143, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY CP720 */
198 { 0x04a9, 0x3170, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY CP750 */
199 { 0x04a9, 0x3171, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY CP740 */
200 { 0x04a9, 0x3185, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY ES2 */
201 { 0x04a9, 0x3186, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY ES20 */
202 { 0x04a9, 0x31aa, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY CP770 */
203 { 0x04a9, 0x31ab, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY CP760 */
204 { 0x04a9, 0x31b0, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY ES30 */
205 { 0x04a9, 0x31dd, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY CP780 */
206 { 0x04a9, 0x31ee, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY ES40 */
207 { 0x04a9, 0x3214, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY CP800 */
208 { 0x04a9, 0x3255, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY CP900 */
209 { 0x04a9, 0x3256, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY CP810 */
210 { 0x04a9, 0x30F5, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY CP500 */
211 { 0x04a9, 0x31AF, USBLP_QUIRK_BLACKLIST
}, /* Canon SELPHY ES3 */
212 /* MISSING PIDs: CP520, CP530, CP790 */
221 usb_globals_t g
= { 0 }; /* Globals */
222 libusb_device
**list
; /* List of connected USB devices */
229 static int close_device(usb_printer_t
*printer
);
230 static usb_printer_t
*find_device(usb_cb_t cb
, const void *data
);
231 static int get_device_id(usb_printer_t
*printer
, char *buffer
,
233 static int list_cb(usb_printer_t
*printer
, const char *device_uri
,
234 const char *device_id
, const void *data
);
235 static char *make_device_uri(usb_printer_t
*printer
,
236 const char *device_id
,
237 char *uri
, size_t uri_size
);
238 static int open_device(usb_printer_t
*printer
, int verbose
);
239 static int print_cb(usb_printer_t
*printer
, const char *device_uri
,
240 const char *device_id
, const void *data
);
241 static int printer_class_soft_reset(usb_printer_t
*printer
);
242 static unsigned int quirks(int vendor
, int product
);
243 static void *read_thread(void *reference
);
244 static void *sidechannel_thread(void *reference
);
245 static void soft_reset(void);
249 * 'list_devices()' - List the available printers.
255 fputs("DEBUG: list_devices\n", stderr
);
256 find_device(list_cb
, NULL
);
261 * 'print_device()' - Print a file to a USB device.
264 int /* O - Exit status */
265 print_device(const char *uri
, /* I - Device URI */
266 const char *hostname
, /* I - Hostname/manufacturer */
267 const char *resource
, /* I - Resource/modelname */
268 char *options
, /* I - Device options/serial number */
269 int print_fd
, /* I - File descriptor to print */
270 int copies
, /* I - Copies to print */
271 int argc
, /* I - Number of command-line arguments (6 or 7) */
272 char *argv
[]) /* I - Command-line arguments */
274 int bytes
; /* Bytes written */
275 ssize_t total_bytes
; /* Total bytes written */
276 struct sigaction action
; /* Actions for POSIX signals */
277 int status
= CUPS_BACKEND_OK
,
278 /* Function results */
279 iostatus
; /* Current IO status */
280 pthread_t read_thread_id
, /* Read thread */
281 sidechannel_thread_id
; /* Side-channel thread */
282 int have_sidechannel
= 0, /* Was the side-channel thread started? */
283 have_backchannel
= 0; /* Do we have a back channel? */
284 struct stat sidechannel_info
; /* Side-channel file descriptor info */
285 unsigned char print_buffer
[8192], /* Print data buffer */
286 *print_ptr
; /* Pointer into print data buffer */
287 fd_set input_set
; /* Input set for select() */
288 int nfds
; /* Number of file descriptors */
289 struct timeval
*timeout
, /* Timeout pointer */
291 struct timespec cond_timeout
; /* pthread condition timeout */
292 int num_opts
; /* Number of options */
293 cups_option_t
*opts
; /* Options */
294 const char *val
; /* Option value */
298 * See if the side-channel descriptor is valid...
301 have_sidechannel
= !fstat(CUPS_SC_FD
, &sidechannel_info
) &&
302 S_ISSOCK(sidechannel_info
.st_mode
);
304 g
.wait_eof
= WAIT_EOF
;
307 * Connect to the printer...
310 fprintf(stderr
, "DEBUG: Printing on printer with URI: %s\n", uri
);
311 while ((g
.printer
= find_device(print_cb
, uri
)) == NULL
)
313 _cupsLangPrintFilter(stderr
, "INFO",
314 _("Waiting for printer to become available."));
318 g
.print_fd
= print_fd
;
321 * Some devices need a reset after finishing a job, these devices are
322 * marked with the USBLP_QUIRK_RESET quirk.
324 g
.printer
->reset_after_job
= (g
.printer
->quirks
& USBLP_QUIRK_RESET
? 1 : 0);
327 * If we are printing data from a print driver on stdin, ignore SIGTERM
328 * so that the driver can finish out any page data, e.g. to eject the
329 * current page. We only do this for stdin printing as otherwise there
330 * is no way to cancel a raw print job...
335 memset(&action
, 0, sizeof(action
));
337 sigemptyset(&action
.sa_mask
);
338 action
.sa_handler
= SIG_IGN
;
339 sigaction(SIGTERM
, &action
, NULL
);
343 * Start the side channel thread if the descriptor is valid...
346 pthread_mutex_init(&g
.readwrite_lock_mutex
, NULL
);
347 pthread_cond_init(&g
.readwrite_lock_cond
, NULL
);
348 g
.readwrite_lock
= 1;
350 if (have_sidechannel
)
352 g
.sidechannel_thread_stop
= 0;
353 g
.sidechannel_thread_done
= 0;
355 pthread_cond_init(&g
.sidechannel_thread_cond
, NULL
);
356 pthread_mutex_init(&g
.sidechannel_thread_mutex
, NULL
);
358 if (pthread_create(&sidechannel_thread_id
, NULL
, sidechannel_thread
, NULL
))
360 fprintf(stderr
, "DEBUG: Fatal USB error.\n");
361 _cupsLangPrintFilter(stderr
, "ERROR",
362 _("There was an unrecoverable USB error."));
363 fputs("DEBUG: Couldn't create side-channel thread.\n", stderr
);
364 close_device(g
.printer
);
365 return (CUPS_BACKEND_STOP
);
370 * Debug mode: If option "usb-unidir" is given, always deactivate
374 num_opts
= cupsParseOptions(argv
[5], 0, &opts
);
375 val
= cupsGetOption("usb-unidir", num_opts
, opts
);
376 if (val
&& strcasecmp(val
, "no") && strcasecmp(val
, "off") &&
377 strcasecmp(val
, "false"))
379 g
.printer
->read_endp
= -1;
380 fprintf(stderr
, "DEBUG: Forced uni-directional communication "
381 "via \"usb-unidir\" option.\n");
385 * Debug mode: If option "usb-no-reattach" is given, do not re-attach
386 * the usblp kernel module after the job has completed.
389 val
= cupsGetOption("usb-no-reattach", num_opts
, opts
);
390 if (val
&& strcasecmp(val
, "no") && strcasecmp(val
, "off") &&
391 strcasecmp(val
, "false"))
393 g
.printer
->usblp_attached
= 0;
394 fprintf(stderr
, "DEBUG: Forced not re-attaching the usblp kernel module "
395 "after the job via \"usb-no-reattach\" option.\n");
399 * Get the read thread going...
402 if (g
.printer
->read_endp
!= -1)
404 have_backchannel
= 1;
406 g
.read_thread_stop
= 0;
407 g
.read_thread_done
= 0;
409 pthread_cond_init(&g
.read_thread_cond
, NULL
);
410 pthread_mutex_init(&g
.read_thread_mutex
, NULL
);
412 if (pthread_create(&read_thread_id
, NULL
, read_thread
, NULL
))
414 fprintf(stderr
, "DEBUG: Fatal USB error.\n");
415 _cupsLangPrintFilter(stderr
, "ERROR",
416 _("There was an unrecoverable USB error."));
417 fputs("DEBUG: Couldn't create read thread.\n", stderr
);
418 close_device(g
.printer
);
419 return (CUPS_BACKEND_STOP
);
423 fprintf(stderr
, "DEBUG: Uni-directional device/mode, back channel "
427 * The main thread sends the print file...
433 print_ptr
= print_buffer
;
435 while (status
== CUPS_BACKEND_OK
&& copies
-- > 0)
437 _cupsLangPrintFilter(stderr
, "INFO", _("Sending data to printer."));
439 if (print_fd
!= STDIN_FILENO
)
441 fputs("PAGE: 1 1\n", stderr
);
442 lseek(print_fd
, 0, SEEK_SET
);
445 while (status
== CUPS_BACKEND_OK
)
450 FD_SET(print_fd
, &input_set
);
453 * Calculate select timeout...
454 * If we have data waiting to send timeout is 100ms.
455 * else if we're draining print_fd timeout is 0.
456 * else we're waiting forever...
462 tv
.tv_usec
= 100000; /* 100ms */
465 else if (g
.drain_output
)
475 * I/O is unlocked around select...
478 pthread_mutex_lock(&g
.readwrite_lock_mutex
);
479 g
.readwrite_lock
= 0;
480 pthread_cond_signal(&g
.readwrite_lock_cond
);
481 pthread_mutex_unlock(&g
.readwrite_lock_mutex
);
483 nfds
= select(print_fd
+ 1, &input_set
, NULL
, NULL
, timeout
);
486 * Reacquire the lock...
489 pthread_mutex_lock(&g
.readwrite_lock_mutex
);
490 while (g
.readwrite_lock
)
491 pthread_cond_wait(&g
.readwrite_lock_cond
, &g
.readwrite_lock_mutex
);
492 g
.readwrite_lock
= 1;
493 pthread_mutex_unlock(&g
.readwrite_lock_mutex
);
497 if (errno
== EINTR
&& total_bytes
== 0)
499 fputs("DEBUG: Received an interrupt before any bytes were "
500 "written, aborting.\n", stderr
);
501 close_device(g
.printer
);
502 return (CUPS_BACKEND_OK
);
504 else if (errno
!= EAGAIN
&& errno
!= EINTR
)
506 _cupsLangPrintFilter(stderr
, "ERROR",
507 _("Unable to read print data."));
508 perror("DEBUG: select");
509 close_device(g
.printer
);
510 return (CUPS_BACKEND_FAILED
);
515 * If drain output has finished send a response...
518 if (g
.drain_output
&& !nfds
&& !g
.print_bytes
)
520 /* Send a response... */
521 cupsSideChannelWrite(CUPS_SC_CMD_DRAIN_OUTPUT
, CUPS_SC_STATUS_OK
, NULL
, 0, 1.0);
526 * Check if we have print data ready...
529 if (FD_ISSET(print_fd
, &input_set
))
531 g
.print_bytes
= read(print_fd
, print_buffer
, sizeof(print_buffer
));
533 if (g
.print_bytes
< 0)
536 * Read error - bail if we don't see EAGAIN or EINTR...
539 if (errno
!= EAGAIN
&& errno
!= EINTR
)
541 _cupsLangPrintFilter(stderr
, "ERROR",
542 _("Unable to read print data."));
543 perror("DEBUG: read");
544 close_device(g
.printer
);
545 return (CUPS_BACKEND_FAILED
);
550 else if (g
.print_bytes
== 0)
553 * End of file, break out of the loop...
559 print_ptr
= print_buffer
;
561 fprintf(stderr
, "DEBUG: Read %d bytes of print data...\n",
567 iostatus
= libusb_bulk_transfer(g
.printer
->handle
,
568 g
.printer
->write_endp
,
569 print_buffer
, g
.print_bytes
,
572 * Ignore timeout errors, but retain the number of bytes written to
573 * avoid sending duplicate data...
576 if (iostatus
== LIBUSB_ERROR_TIMEOUT
)
578 fputs("DEBUG: Got USB transaction timeout during write.\n", stderr
);
583 * If we've stalled, retry the write...
586 else if (iostatus
== LIBUSB_ERROR_PIPE
)
588 fputs("DEBUG: Got USB pipe stalled during write.\n", stderr
);
590 iostatus
= libusb_bulk_transfer(g
.printer
->handle
,
591 g
.printer
->write_endp
,
592 print_buffer
, g
.print_bytes
,
597 * Retry a write after an aborted write since we probably just got
601 else if (iostatus
== LIBUSB_ERROR_INTERRUPTED
)
603 fputs("DEBUG: Got USB return aborted during write.\n", stderr
);
605 iostatus
= libusb_bulk_transfer(g
.printer
->handle
,
606 g
.printer
->write_endp
,
607 print_buffer
, g
.print_bytes
,
614 * Write error - bail if we don't see an error we can retry...
617 _cupsLangPrintFilter(stderr
, "ERROR",
618 _("Unable to send data to printer."));
619 fprintf(stderr
, "DEBUG: libusb write operation returned %x.\n",
622 status
= CUPS_BACKEND_FAILED
;
627 fprintf(stderr
, "DEBUG: Wrote %d bytes of print data...\n",
630 g
.print_bytes
-= bytes
;
632 total_bytes
+= bytes
;
636 if (print_fd
!= 0 && status
== CUPS_BACKEND_OK
)
637 fprintf(stderr
, "DEBUG: Sending print file, " CUPS_LLFMT
" bytes...\n",
638 CUPS_LLCAST total_bytes
);
642 fprintf(stderr
, "DEBUG: Sent " CUPS_LLFMT
" bytes...\n",
643 CUPS_LLCAST total_bytes
);
646 * Signal the side channel thread to exit...
649 if (have_sidechannel
)
652 pthread_mutex_lock(&g
.readwrite_lock_mutex
);
653 g
.readwrite_lock
= 0;
654 pthread_cond_signal(&g
.readwrite_lock_cond
);
655 pthread_mutex_unlock(&g
.readwrite_lock_mutex
);
657 g
.sidechannel_thread_stop
= 1;
658 pthread_mutex_lock(&g
.sidechannel_thread_mutex
);
660 if (!g
.sidechannel_thread_done
)
662 gettimeofday(&tv
, NULL
);
663 cond_timeout
.tv_sec
= tv
.tv_sec
+ WAIT_SIDE_DELAY
;
664 cond_timeout
.tv_nsec
= tv
.tv_usec
* 1000;
666 while (!g
.sidechannel_thread_done
)
668 if (pthread_cond_timedwait(&g
.sidechannel_thread_cond
,
669 &g
.sidechannel_thread_mutex
,
675 pthread_mutex_unlock(&g
.sidechannel_thread_mutex
);
679 * Signal the read thread to exit then wait 7 seconds for it to complete...
682 if (have_backchannel
)
684 g
.read_thread_stop
= 1;
686 pthread_mutex_lock(&g
.read_thread_mutex
);
688 if (!g
.read_thread_done
)
690 fputs("DEBUG: Waiting for read thread to exit...\n", stderr
);
692 gettimeofday(&tv
, NULL
);
693 cond_timeout
.tv_sec
= tv
.tv_sec
+ WAIT_EOF_DELAY
;
694 cond_timeout
.tv_nsec
= tv
.tv_usec
* 1000;
696 while (!g
.read_thread_done
)
698 if (pthread_cond_timedwait(&g
.read_thread_cond
, &g
.read_thread_mutex
,
704 * If it didn't exit abort the pending read and wait an additional
708 if (!g
.read_thread_done
)
710 fputs("DEBUG: Read thread still active, aborting the pending read...\n",
715 gettimeofday(&tv
, NULL
);
716 cond_timeout
.tv_sec
= tv
.tv_sec
+ 1;
717 cond_timeout
.tv_nsec
= tv
.tv_usec
* 1000;
719 while (!g
.read_thread_done
)
721 if (pthread_cond_timedwait(&g
.read_thread_cond
, &g
.read_thread_mutex
,
728 pthread_mutex_unlock(&g
.read_thread_mutex
);
732 * Close the connection and input file and general clean up...
735 close_device(g
.printer
);
741 libusb_free_device_list(list
, 1);
749 * 'close_device()' - Close the connection to the USB printer.
752 static int /* I - 0 on success, -1 on failure */
753 close_device(usb_printer_t
*printer
) /* I - Printer */
755 struct libusb_device_descriptor devdesc
;
756 /* Current device descriptor */
757 struct libusb_config_descriptor
*confptr
;
758 /* Pointer to current configuration */
764 * Release interfaces before closing so that we know all data is written
768 int errcode
; /* Return value of libusb function */
769 int number1
, /* Interface number */
770 number2
; /* Configuration number */
773 libusb_get_config_descriptor(printer
->device
, printer
->conf
, &confptr
);
776 number1
= confptr
->interface
[printer
->iface
].
777 altsetting
[printer
->altset
].bInterfaceNumber
;
778 libusb_release_interface(printer
->handle
, number1
);
780 number2
= confptr
->bConfigurationValue
;
782 libusb_free_config_descriptor(confptr
);
785 * If we have changed the configuration from one valid configuration
786 * to another, restore the old one
788 if (printer
->origconf
> 0 && printer
->origconf
!= number2
)
790 fprintf(stderr
, "DEBUG: Restoring USB device configuration: %d -> %d\n",
791 number2
, printer
->origconf
);
792 if ((errcode
= libusb_set_configuration(printer
->handle
,
793 printer
->origconf
)) < 0)
795 if (errcode
!= LIBUSB_ERROR_BUSY
)
798 libusb_get_device_descriptor (printer
->device
, &devdesc
);
801 "DEBUG: Failed to set configuration %d\n",
805 "DEBUG: Failed to set configuration %d for %04x:%04x\n",
806 printer
->origconf
, devdesc
.idVendor
, devdesc
.idProduct
);
812 * Re-attach "usblp" kernel module if it was attached before using this
815 if (printer
->usblp_attached
== 1)
816 if (libusb_attach_kernel_driver(printer
->handle
, number1
) < 0)
818 errcode
= libusb_get_device_descriptor (printer
->device
, &devdesc
);
821 "DEBUG: Failed to re-attach \"usblp\" kernel module\n");
824 "DEBUG: Failed to re-attach \"usblp\" kernel module to "
825 "%04x:%04x\n", devdesc
.idVendor
, devdesc
.idProduct
);
830 "DEBUG: Failed to get configuration descriptor %d\n",
834 * Reset the device to clean up after the job
837 if (printer
->reset_after_job
== 1)
839 if ((errcode
= libusb_reset_device(printer
->handle
)) < 0)
841 "DEBUG: Device reset failed, error code: %d\n",
845 "DEBUG: Resetting printer.\n");
849 * Close the interface and return...
852 libusb_close(printer
->handle
);
853 printer
->handle
= NULL
;
861 * 'find_device()' - Find or enumerate USB printers.
864 static usb_printer_t
* /* O - Found printer */
865 find_device(usb_cb_t cb
, /* I - Callback function */
866 const void *data
) /* I - User data for callback */
868 libusb_device
**list
; /* List of connected USB devices */
869 libusb_device
*device
= NULL
; /* Current device */
870 struct libusb_device_descriptor devdesc
;
871 /* Current device descriptor */
872 struct libusb_config_descriptor
*confptr
= NULL
;
873 /* Pointer to current configuration */
874 const struct libusb_interface
*ifaceptr
= NULL
;
875 /* Pointer to current interface */
876 const struct libusb_interface_descriptor
*altptr
= NULL
;
877 /* Pointer to current alternate setting */
878 const struct libusb_endpoint_descriptor
*endpptr
= NULL
;
879 /* Pointer to current endpoint */
880 ssize_t numdevs
, /* number of connected devices */
882 uint8_t conf
, /* Current configuration */
883 iface
, /* Current interface */
884 altset
, /* Current alternate setting */
885 protocol
, /* Current protocol */
886 endp
, /* Current endpoint */
887 read_endp
, /* Current read endpoint */
888 write_endp
; /* Current write endpoint */
889 char device_id
[1024],/* IEEE-1284 device ID */
892 static usb_printer_t printer
; /* Current printer */
896 * Initialize libusb...
900 numdevs
= libusb_get_device_list(NULL
, &list
);
901 fprintf(stderr
, "DEBUG: libusb_get_device_list=%d\n", (int)numdevs
);
904 * Then loop through the devices it found...
908 for (i
= 0; i
< numdevs
; i
++)
913 * Ignore devices with no configuration data and anything that is not
917 if (libusb_get_device_descriptor(device
, &devdesc
) < 0)
920 if (!devdesc
.bNumConfigurations
|| !devdesc
.idVendor
||
924 printer
.quirks
= quirks(devdesc
.idVendor
, devdesc
.idProduct
);
927 * Ignore blacklisted printers...
930 if (printer
.quirks
& USBLP_QUIRK_BLACKLIST
)
933 for (conf
= 0; conf
< devdesc
.bNumConfigurations
; conf
++)
935 if (libusb_get_config_descriptor(device
, conf
, &confptr
) < 0)
937 for (iface
= 0, ifaceptr
= confptr
->interface
;
938 iface
< confptr
->bNumInterfaces
;
939 iface
++, ifaceptr
++)
942 * Some printers offer multiple interfaces...
947 for (altset
= 0, altptr
= ifaceptr
->altsetting
;
948 altset
< ifaceptr
->num_altsetting
;
949 altset
++, altptr
++)
952 * Currently we only support unidirectional and bidirectional
953 * printers. Future versions of this code will support the
954 * 1284.4 (packet mode) protocol as well.
957 if (((altptr
->bInterfaceClass
!= LIBUSB_CLASS_PRINTER
||
958 altptr
->bInterfaceSubClass
!= 1) &&
959 ((printer
.quirks
& USBLP_QUIRK_BAD_CLASS
) == 0)) ||
960 (altptr
->bInterfaceProtocol
!= 1 && /* Unidirectional */
961 altptr
->bInterfaceProtocol
!= 2) || /* Bidirectional */
962 altptr
->bInterfaceProtocol
< protocol
)
965 if (printer
.quirks
& USBLP_QUIRK_BAD_CLASS
)
966 fprintf(stderr
, "DEBUG: Printer does not report class 7 and/or "
967 "subclass 1 but works as a printer anyway\n");
972 for (endp
= 0, endpptr
= altptr
->endpoint
;
973 endp
< altptr
->bNumEndpoints
;
975 if ((endpptr
->bmAttributes
& LIBUSB_TRANSFER_TYPE_MASK
) ==
976 LIBUSB_TRANSFER_TYPE_BULK
)
978 if (endpptr
->bEndpointAddress
& LIBUSB_ENDPOINT_DIR_MASK
)
987 * Save the best match so far...
990 protocol
= altptr
->bInterfaceProtocol
;
991 printer
.altset
= altset
;
992 printer
.write_endp
= write_endp
;
994 printer
.read_endp
= read_endp
;
996 printer
.read_endp
= -1;
1002 printer
.device
= device
;
1003 printer
.conf
= conf
;
1004 printer
.iface
= iface
;
1005 printer
.protocol
= protocol
;
1006 printer
.handle
= NULL
;
1008 if (!open_device(&printer
, data
!= NULL
))
1010 get_device_id(&printer
, device_id
, sizeof(device_id
));
1011 make_device_uri(&printer
, device_id
, device_uri
,
1012 sizeof(device_uri
));
1014 fprintf(stderr
, "DEBUG2: Printer found with device ID: %s "
1016 device_id
, device_uri
);
1018 if ((*cb
)(&printer
, device_uri
, device_id
, data
))
1020 fprintf(stderr
, "DEBUG: Device protocol: %d\n",
1022 if (printer
.quirks
& USBLP_QUIRK_BIDIR
)
1024 printer
.read_endp
= -1;
1025 fprintf(stderr
, "DEBUG: Printer reports bi-di support "
1026 "but in reality works only uni-directionally\n");
1028 if (printer
.read_endp
!= -1)
1030 printer
.read_endp
= confptr
->interface
[printer
.iface
].
1031 altsetting
[printer
.altset
].
1032 endpoint
[printer
.read_endp
].
1036 fprintf(stderr
, "DEBUG: Uni-directional USB communication "
1038 printer
.write_endp
= confptr
->interface
[printer
.iface
].
1039 altsetting
[printer
.altset
].
1040 endpoint
[printer
.write_endp
].
1042 if (printer
.quirks
& USBLP_QUIRK_NO_REATTACH
)
1044 printer
.usblp_attached
= 0;
1045 fprintf(stderr
, "DEBUG: Printer does not like usblp "
1046 "kernel module to be re-attached after job\n");
1048 libusb_free_config_descriptor(confptr
);
1052 close_device(&printer
);
1056 libusb_free_config_descriptor(confptr
);
1061 * If we get this far without returning, then we haven't found a printer
1069 libusb_free_device_list(list
, 1);
1077 * 'get_device_id()' - Get the IEEE-1284 device ID for the printer.
1080 static int /* O - 0 on success, -1 on error */
1081 get_device_id(usb_printer_t
*printer
, /* I - Printer */
1082 char *buffer
, /* I - String buffer */
1083 size_t bufsize
) /* I - Number of bytes in buffer */
1085 int length
; /* Length of device ID */
1088 if (libusb_control_transfer(printer
->handle
,
1089 LIBUSB_REQUEST_TYPE_CLASS
| LIBUSB_ENDPOINT_IN
|
1090 LIBUSB_RECIPIENT_INTERFACE
,
1092 (printer
->iface
<< 8) | printer
->altset
,
1093 (unsigned char *)buffer
, bufsize
, 5000) < 0)
1100 * Extract the length of the device ID string from the first two
1101 * bytes. The 1284 spec says the length is stored MSB first...
1104 length
= (((unsigned)buffer
[0] & 255) << 8) |
1105 ((unsigned)buffer
[1] & 255);
1108 * Check to see if the length is larger than our buffer or less than 14 bytes
1109 * (the minimum valid device ID is "MFG:x;MDL:y;" with 2 bytes for the length).
1111 * If the length is out-of-range, assume that the vendor incorrectly
1112 * implemented the 1284 spec and re-read the length as LSB first,..
1115 if (length
> bufsize
|| length
< 14)
1116 length
= (((unsigned)buffer
[1] & 255) << 8) |
1117 ((unsigned)buffer
[0] & 255);
1119 if (length
> bufsize
)
1125 * Invalid device ID, clear it!
1135 * Copy the device ID text to the beginning of the buffer and
1139 memmove(buffer
, buffer
+ 2, length
);
1140 buffer
[length
] = '\0';
1147 * 'list_cb()' - List USB printers for discovery.
1150 static int /* O - 0 to continue, 1 to stop */
1151 list_cb(usb_printer_t
*printer
, /* I - Printer */
1152 const char *device_uri
, /* I - Device URI */
1153 const char *device_id
, /* I - IEEE-1284 device ID */
1154 const void *data
) /* I - User data (not used) */
1156 char make_model
[1024]; /* Make and model */
1160 * Get the device URI and make/model strings...
1163 if (backendGetMakeModel(device_id
, make_model
, sizeof(make_model
)))
1164 strlcpy(make_model
, "Unknown", sizeof(make_model
));
1167 * Report the printer...
1170 cupsBackendReport("direct", device_uri
, make_model
, make_model
, device_id
,
1182 * 'make_device_uri()' - Create a device URI for a USB printer.
1185 static char * /* O - Device URI */
1187 usb_printer_t
*printer
, /* I - Printer */
1188 const char *device_id
, /* I - IEEE-1284 device ID */
1189 char *uri
, /* I - Device URI buffer */
1190 size_t uri_size
) /* I - Size of device URI buffer */
1192 struct libusb_device_descriptor devdesc
;
1193 /* Current device descriptor */
1194 char options
[1024]; /* Device URI options */
1195 int num_values
; /* Number of 1284 parameters */
1196 cups_option_t
*values
; /* 1284 parameters */
1197 const char *mfg
, /* Manufacturer */
1199 *des
= NULL
, /* Description */
1200 *sern
; /* Serial number */
1201 size_t mfglen
; /* Length of manufacturer string */
1202 char tempmfg
[256], /* Temporary manufacturer string */
1203 tempsern
[256], /* Temporary serial number string */
1204 *tempptr
; /* Pointer into temp string */
1208 * Get the make, model, and serial numbers...
1211 num_values
= _cupsGet1284Values(device_id
, &values
);
1213 if ((sern
= cupsGetOption("SERIALNUMBER", num_values
, values
)) == NULL
)
1214 if ((sern
= cupsGetOption("SERN", num_values
, values
)) == NULL
)
1215 if ((sern
= cupsGetOption("SN", num_values
, values
)) == NULL
&&
1216 ((libusb_get_device_descriptor(printer
->device
, &devdesc
) >= 0) &&
1217 devdesc
.iSerialNumber
))
1220 * Try getting the serial number from the device itself...
1224 libusb_get_string_descriptor_ascii(printer
->handle
,
1225 devdesc
.iSerialNumber
,
1226 (unsigned char *)tempsern
,
1227 sizeof(tempsern
) - 1);
1230 tempsern
[length
] = '\0';
1235 if ((mfg
= cupsGetOption("MANUFACTURER", num_values
, values
)) == NULL
)
1236 mfg
= cupsGetOption("MFG", num_values
, values
);
1238 if ((mdl
= cupsGetOption("MODEL", num_values
, values
)) == NULL
)
1239 mdl
= cupsGetOption("MDL", num_values
, values
);
1242 * To maintain compatibility with the original character device backend on
1243 * Linux and *BSD, map manufacturer names...
1248 if (!_cups_strcasecmp(mfg
, "Hewlett-Packard"))
1250 else if (!_cups_strcasecmp(mfg
, "Lexmark International"))
1256 * No manufacturer? Use the model string or description...
1260 _ppdNormalizeMakeAndModel(mdl
, tempmfg
, sizeof(tempmfg
));
1261 else if ((des
= cupsGetOption("DESCRIPTION", num_values
, values
)) != NULL
||
1262 (des
= cupsGetOption("DES", num_values
, values
)) != NULL
)
1263 _ppdNormalizeMakeAndModel(des
, tempmfg
, sizeof(tempmfg
));
1265 strlcpy(tempmfg
, "Unknown", sizeof(tempmfg
));
1267 if ((tempptr
= strchr(tempmfg
, ' ')) != NULL
)
1276 * No model? Use description...
1279 mdl
= des
; /* We remove the manufacturer name below */
1280 else if (!strncasecmp(mfg
, "Unknown", 7))
1283 mdl
= "Unknown Model";
1286 mfglen
= strlen(mfg
);
1288 if (!strncasecmp(mdl
, mfg
, mfglen
) && _cups_isspace(mdl
[mfglen
]))
1292 while (_cups_isspace(*mdl
))
1297 * Generate the device URI from the manufacturer, model, serial number,
1298 * and interface number...
1303 if (printer
->iface
> 0)
1304 snprintf(options
, sizeof(options
), "?serial=%s&interface=%d", sern
,
1307 snprintf(options
, sizeof(options
), "?serial=%s", sern
);
1309 else if (printer
->iface
> 0)
1310 snprintf(options
, sizeof(options
), "?interface=%d", printer
->iface
);
1314 httpAssembleURIf(HTTP_URI_CODING_ALL
, uri
, uri_size
, "usb", NULL
, mfg
, 0,
1315 "/%s%s", mdl
, options
);
1317 cupsFreeOptions(num_values
, values
);
1324 * 'open_device()' - Open a connection to the USB printer.
1327 static int /* O - 0 on success, -1 on error */
1328 open_device(usb_printer_t
*printer
, /* I - Printer */
1329 int verbose
) /* I - Update connecting-to-device state? */
1331 struct libusb_device_descriptor devdesc
;
1332 /* Current device descriptor */
1333 struct libusb_config_descriptor
*confptr
= NULL
;
1334 /* Pointer to current configuration */
1335 int number1
= -1, /* Configuration/interface/altset */
1336 number2
= -1, /* numbers */
1338 char current
; /* Current configuration */
1342 * Return immediately if we are already connected...
1345 if (printer
->handle
)
1349 * Try opening the printer...
1352 if ((errcode
= libusb_open(printer
->device
, &printer
->handle
)) < 0)
1354 fprintf(stderr
, "DEBUG: Failed to open device, code: %d\n",
1359 printer
->usblp_attached
= 0;
1360 printer
->reset_after_job
= 0;
1363 fputs("STATE: +connecting-to-device\n", stderr
);
1365 if ((errcode
= libusb_get_device_descriptor(printer
->device
, &devdesc
)) < 0)
1367 fprintf(stderr
, "DEBUG: Failed to get device descriptor, code: %d\n",
1373 * Get the "usblp" kernel module out of the way. This backend only
1374 * works without the module attached.
1377 errcode
= libusb_kernel_driver_active(printer
->handle
, printer
->iface
);
1379 printer
->usblp_attached
= 0;
1380 else if (errcode
== 1)
1382 printer
->usblp_attached
= 1;
1384 libusb_detach_kernel_driver(printer
->handle
, printer
->iface
)) < 0)
1386 fprintf(stderr
, "DEBUG: Failed to detach \"usblp\" module from %04x:%04x\n",
1387 devdesc
.idVendor
, devdesc
.idProduct
);
1393 printer
->usblp_attached
= 0;
1394 fprintf(stderr
, "DEBUG: Failed to check whether %04x:%04x has the \"usblp\" kernel module attached\n",
1395 devdesc
.idVendor
, devdesc
.idProduct
);
1400 * Set the desired configuration, but only if it needs changing. Some
1401 * printers (e.g., Samsung) don't like libusb_set_configuration. It will
1402 * succeed, but the following print job is sometimes silently lost by the
1406 if (libusb_control_transfer(printer
->handle
,
1407 LIBUSB_REQUEST_TYPE_STANDARD
| LIBUSB_ENDPOINT_IN
|
1408 LIBUSB_RECIPIENT_DEVICE
,
1409 8, /* GET_CONFIGURATION */
1410 0, 0, (unsigned char *)¤t
, 1, 5000) < 0)
1411 current
= 0; /* Assume not configured */
1413 printer
->origconf
= current
;
1416 libusb_get_config_descriptor (printer
->device
, printer
->conf
, &confptr
))
1419 fprintf(stderr
, "DEBUG: Failed to get config descriptor for %04x:%04x\n",
1420 devdesc
.idVendor
, devdesc
.idProduct
);
1423 number1
= confptr
->bConfigurationValue
;
1425 if (number1
!= current
)
1427 fprintf(stderr
, "DEBUG: Switching USB device configuration: %d -> %d\n",
1429 if ((errcode
= libusb_set_configuration(printer
->handle
, number1
)) < 0)
1432 * If the set fails, chances are that the printer only supports a
1433 * single configuration. Technically these printers don't conform to
1434 * the USB printer specification, but otherwise they'll work...
1437 if (errcode
!= LIBUSB_ERROR_BUSY
)
1438 fprintf(stderr
, "DEBUG: Failed to set configuration %d for %04x:%04x\n",
1439 number1
, devdesc
.idVendor
, devdesc
.idProduct
);
1444 * Claim interfaces as needed...
1447 number1
= confptr
->interface
[printer
->iface
].
1448 altsetting
[printer
->altset
].bInterfaceNumber
;
1450 while ((errcode
= libusb_claim_interface(printer
->handle
, number1
)) < 0)
1452 if (errcode
!= LIBUSB_ERROR_BUSY
)
1455 "DEBUG: Failed to claim interface %d for %04x:%04x: %s\n",
1456 number1
, devdesc
.idVendor
, devdesc
.idProduct
, strerror(errno
));
1463 * Set alternate setting, but only if there is more than one option. Some
1464 * printers (e.g., Samsung) don't like usb_set_altinterface.
1467 if (confptr
->interface
[printer
->iface
].num_altsetting
> 1)
1469 number1
= confptr
->interface
[printer
->iface
].
1470 altsetting
[printer
->altset
].bInterfaceNumber
;
1471 number2
= confptr
->interface
[printer
->iface
].
1472 altsetting
[printer
->altset
].bAlternateSetting
;
1475 libusb_set_interface_alt_setting(printer
->handle
, number1
, number2
))
1478 if (errcode
!= LIBUSB_ERROR_BUSY
)
1481 "DEBUG: Failed to set alternate interface %d for %04x:%04x: "
1483 number2
, devdesc
.idVendor
, devdesc
.idProduct
, strerror(errno
));
1490 libusb_free_config_descriptor(confptr
);
1493 fputs("STATE: -connecting-to-device\n", stderr
);
1498 * If we get here, there was a hard error...
1504 fputs("STATE: -connecting-to-device\n", stderr
);
1506 libusb_close(printer
->handle
);
1507 printer
->handle
= NULL
;
1514 * 'print_cb()' - Find a USB printer for printing.
1517 static int /* O - 0 to continue, 1 to stop (found) */
1518 print_cb(usb_printer_t
*printer
, /* I - Printer */
1519 const char *device_uri
, /* I - Device URI */
1520 const char *device_id
, /* I - IEEE-1284 device ID */
1521 const void *data
) /* I - User data (make, model, S/N) */
1523 char requested_uri
[1024], /* Requested URI */
1524 *requested_ptr
, /* Pointer into requested URI */
1525 detected_uri
[1024], /* Detected URI */
1526 *detected_ptr
; /* Pointer into detected URI */
1530 * If we have an exact match, stop now...
1533 if (!strcmp((char *)data
, device_uri
))
1537 * Work on copies of the URIs...
1540 strlcpy(requested_uri
, (char *)data
, sizeof(requested_uri
));
1541 strlcpy(detected_uri
, device_uri
, sizeof(detected_uri
));
1544 * libusb-discovered URIs can have an "interface" specification and this
1545 * never happens for usblp-discovered URIs, so remove the "interface"
1546 * specification from the URI which we are checking currently. This way a
1547 * queue for a usblp-discovered printer can now be accessed via libusb.
1549 * Similarly, strip "?serial=NNN...NNN" as needed.
1552 if ((requested_ptr
= strstr(requested_uri
, "?interface=")) == NULL
)
1553 requested_ptr
= strstr(requested_uri
, "&interface=");
1554 if ((detected_ptr
= strstr(detected_uri
, "?interface=")) == NULL
)
1555 detected_ptr
= strstr(detected_uri
, "&interface=");
1557 if (!requested_ptr
&& detected_ptr
)
1560 * Strip "[?&]interface=nnn" from the detected printer.
1563 *detected_ptr
= '\0';
1565 else if (requested_ptr
&& !detected_ptr
)
1568 * Strip "[?&]interface=nnn" from the requested printer.
1571 *requested_ptr
= '\0';
1574 if ((requested_ptr
= strstr(requested_uri
, "?serial=?")) != NULL
)
1577 * Strip "?serial=?" from the requested printer. This is a special
1578 * case, as "?serial=?" means no serial number and not the serial
1579 * number '?'. This is not covered by the checks below...
1582 *requested_ptr
= '\0';
1585 if ((requested_ptr
= strstr(requested_uri
, "?serial=")) == NULL
&&
1586 (detected_ptr
= strstr(detected_uri
, "?serial=")) != NULL
)
1589 * Strip "?serial=nnn" from the detected printer.
1592 *detected_ptr
= '\0';
1594 else if (requested_ptr
&& !detected_ptr
)
1597 * Strip "?serial=nnn" from the requested printer.
1600 *requested_ptr
= '\0';
1603 return (!strcmp(requested_uri
, detected_uri
));
1608 * 'printer_class_soft_reset()' - Do the soft reset request specific to printers
1610 * This soft reset is specific to the printer device class and is much less
1611 * invasive than the general USB reset libusb_reset_device(). Especially it
1612 * does never happen that the USB addressing and configuration changes. What
1613 * is actually done is that all buffers get flushed and the bulk IN and OUT
1614 * pipes get reset to their default states. This clears all stall conditions.
1615 * See http://cholla.mmto.org/computers/linux/usb/usbprint11.pdf
1618 static int /* O - 0 on success, < 0 on error */
1619 printer_class_soft_reset(usb_printer_t
*printer
) /* I - Printer */
1621 struct libusb_config_descriptor
*confptr
= NULL
;
1622 /* Pointer to current configuration */
1626 if (libusb_get_config_descriptor(printer
->device
, printer
->conf
, &confptr
)
1628 interface
= printer
->iface
;
1630 interface
= confptr
->interface
[printer
->iface
].
1631 altsetting
[printer
->altset
].bInterfaceNumber
;
1632 libusb_free_config_descriptor(confptr
);
1633 if ((errcode
= libusb_control_transfer(printer
->handle
,
1634 LIBUSB_REQUEST_TYPE_CLASS
|
1635 LIBUSB_ENDPOINT_OUT
|
1636 LIBUSB_RECIPIENT_OTHER
,
1637 2, 0, interface
, NULL
, 0, 5000)) < 0)
1638 errcode
= libusb_control_transfer(printer
->handle
,
1639 LIBUSB_REQUEST_TYPE_CLASS
|
1640 LIBUSB_ENDPOINT_OUT
|
1641 LIBUSB_RECIPIENT_INTERFACE
,
1642 2, 0, interface
, NULL
, 0, 5000);
1648 * 'quirks()' - Get the known quirks of a given printer model
1651 static unsigned int quirks(int vendor
, int product
)
1655 for (i
= 0; quirk_printers
[i
].vendorId
; i
++)
1657 if (vendor
== quirk_printers
[i
].vendorId
&&
1658 (quirk_printers
[i
].productId
== 0x0000 ||
1659 product
== quirk_printers
[i
].productId
))
1660 return quirk_printers
[i
].quirks
;
1667 * 'read_thread()' - Thread to read the backchannel data on.
1670 static void *read_thread(void *reference
)
1672 unsigned char readbuffer
[512];
1684 * Read frequency: once every 250 milliseconds.
1688 delay
.tv_usec
= 250000;
1693 * Remember when we started so we can throttle the loop after the read
1697 gettimeofday(&now
, NULL
);
1700 * Calculate what 250 milliSeconds are in absolute time...
1703 timeradd(&now
, &delay
, &end
);
1705 rbytes
= sizeof(readbuffer
);
1706 readstatus
= libusb_bulk_transfer(g
.printer
->handle
,
1707 g
.printer
->read_endp
,
1710 if (readstatus
== LIBUSB_SUCCESS
&& rbytes
> 0)
1712 fprintf(stderr
, "DEBUG: Read %d bytes of back-channel data...\n",
1714 cupsBackChannelWrite((const char *)readbuffer
, rbytes
, 1.0);
1716 else if (readstatus
== LIBUSB_ERROR_TIMEOUT
)
1717 fputs("DEBUG: Got USB transaction timeout during read.\n", stderr
);
1718 else if (readstatus
== LIBUSB_ERROR_PIPE
)
1719 fputs("DEBUG: Got USB pipe stalled during read.\n", stderr
);
1720 else if (readstatus
== LIBUSB_ERROR_INTERRUPTED
)
1721 fputs("DEBUG: Got USB return aborted during read.\n", stderr
);
1724 * Make sure this loop executes no more than once every 250 miliseconds...
1727 if ((readstatus
!= LIBUSB_SUCCESS
|| rbytes
== 0) &&
1728 (g
.wait_eof
|| !g
.read_thread_stop
))
1730 gettimeofday(&now
, NULL
);
1731 if (timercmp(&now
, &end
, <))
1733 timersub(&end
, &now
, &timeleft
);
1734 usleep(1000000 * timeleft
.tv_sec
+ timeleft
.tv_usec
);
1737 } while (g
.wait_eof
|| !g
.read_thread_stop
);
1740 * Let the main thread know that we have completed the read thread...
1743 pthread_mutex_lock(&g
.read_thread_mutex
);
1744 g
.read_thread_done
= 1;
1745 pthread_cond_signal(&g
.read_thread_cond
);
1746 pthread_mutex_unlock(&g
.read_thread_mutex
);
1753 * 'sidechannel_thread()' - Handle side-channel requests.
1757 sidechannel_thread(void *reference
)
1759 cups_sc_command_t command
; /* Request command */
1760 cups_sc_status_t status
; /* Request/response status */
1761 char data
[2048]; /* Request/response data */
1762 int datalen
; /* Request/response data size */
1769 datalen
= sizeof(data
);
1771 if (cupsSideChannelRead(&command
, &status
, data
, &datalen
, 1.0))
1773 if (status
== CUPS_SC_STATUS_TIMEOUT
)
1781 case CUPS_SC_CMD_SOFT_RESET
: /* Do a soft reset */
1782 fputs("DEBUG: CUPS_SC_CMD_SOFT_RESET received from driver...\n",
1786 cupsSideChannelWrite(command
, CUPS_SC_STATUS_OK
, NULL
, 0, 1.0);
1787 fputs("DEBUG: Returning status CUPS_STATUS_OK with no bytes...\n",
1791 case CUPS_SC_CMD_DRAIN_OUTPUT
: /* Drain all pending output */
1792 fputs("DEBUG: CUPS_SC_CMD_DRAIN_OUTPUT received from driver...\n",
1798 case CUPS_SC_CMD_GET_BIDI
: /* Is the connection bidirectional? */
1799 fputs("DEBUG: CUPS_SC_CMD_GET_BIDI received from driver...\n",
1802 data
[0] = (g
.printer
->protocol
>= 2 ? 1 : 0);
1803 cupsSideChannelWrite(command
, CUPS_SC_STATUS_OK
, data
, 1, 1.0);
1806 "DEBUG: Returned CUPS_SC_STATUS_OK with 1 byte (%02X)...\n",
1810 case CUPS_SC_CMD_GET_DEVICE_ID
: /* Return IEEE-1284 device ID */
1811 fputs("DEBUG: CUPS_SC_CMD_GET_DEVICE_ID received from driver...\n",
1814 datalen
= sizeof(data
);
1815 if (get_device_id(g
.printer
, data
, sizeof(data
)))
1817 status
= CUPS_SC_STATUS_IO_ERROR
;
1822 status
= CUPS_SC_STATUS_OK
;
1823 datalen
= strlen(data
);
1825 cupsSideChannelWrite(command
, CUPS_SC_STATUS_OK
, data
, datalen
, 1.0);
1827 if (datalen
< sizeof(data
))
1828 data
[datalen
] = '\0';
1830 data
[sizeof(data
) - 1] = '\0';
1833 "DEBUG: Returning CUPS_SC_STATUS_OK with %d bytes (%s)...\n",
1837 case CUPS_SC_CMD_GET_STATE
: /* Return device state */
1838 fputs("DEBUG: CUPS_SC_CMD_GET_STATE received from driver...\n",
1841 data
[0] = CUPS_SC_STATE_ONLINE
;
1842 cupsSideChannelWrite(command
, CUPS_SC_STATUS_OK
, data
, 1, 1.0);
1845 "DEBUG: Returned CUPS_SC_STATUS_OK with 1 byte (%02X)...\n",
1849 case CUPS_SC_CMD_GET_CONNECTED
: /* Return whether device is
1851 fputs("DEBUG: CUPS_SC_CMD_GET_CONNECTED received from driver...\n",
1854 data
[0] = (g
.printer
->handle
? 1 : 0);
1855 cupsSideChannelWrite(command
, CUPS_SC_STATUS_OK
, data
, 1, 1.0);
1858 "DEBUG: Returned CUPS_SC_STATUS_OK with 1 byte (%02X)...\n",
1863 fprintf(stderr
, "DEBUG: Unknown side-channel command (%d) received "
1864 "from driver...\n", command
);
1866 cupsSideChannelWrite(command
, CUPS_SC_STATUS_NOT_IMPLEMENTED
,
1869 fputs("DEBUG: Returned CUPS_SC_STATUS_NOT_IMPLEMENTED with no bytes...\n",
1874 while (!g
.sidechannel_thread_stop
);
1876 pthread_mutex_lock(&g
.sidechannel_thread_mutex
);
1877 g
.sidechannel_thread_done
= 1;
1878 pthread_cond_signal(&g
.sidechannel_thread_cond
);
1879 pthread_mutex_unlock(&g
.sidechannel_thread_mutex
);
1886 * 'soft_reset()' - Send a soft reset to the device.
1889 static void soft_reset(void)
1891 fd_set input_set
; /* Input set for select() */
1892 struct timeval tv
; /* Time value */
1893 char buffer
[2048]; /* Buffer */
1894 struct timespec cond_timeout
; /* pthread condition timeout */
1897 * Send an abort once a second until the I/O lock is released by the main
1901 pthread_mutex_lock(&g
.readwrite_lock_mutex
);
1902 while (g
.readwrite_lock
)
1904 gettimeofday(&tv
, NULL
);
1905 cond_timeout
.tv_sec
= tv
.tv_sec
+ 1;
1906 cond_timeout
.tv_nsec
= tv
.tv_usec
* 1000;
1908 while (g
.readwrite_lock
)
1910 if (pthread_cond_timedwait(&g
.readwrite_lock_cond
,
1911 &g
.readwrite_lock_mutex
,
1912 &cond_timeout
) != 0)
1917 g
.readwrite_lock
= 1;
1918 pthread_mutex_unlock(&g
.readwrite_lock_mutex
);
1921 * Flush bytes waiting on print_fd...
1926 FD_ZERO(&input_set
);
1927 FD_SET(g
.print_fd
, &input_set
);
1932 while (select(g
.print_fd
+1, &input_set
, NULL
, NULL
, &tv
) > 0)
1933 if (read(g
.print_fd
, buffer
, sizeof(buffer
)) <= 0)
1940 printer_class_soft_reset(g
.printer
);
1943 * Release the I/O lock...
1946 pthread_mutex_lock(&g
.readwrite_lock_mutex
);
1947 g
.readwrite_lock
= 0;
1948 pthread_cond_signal(&g
.readwrite_lock_cond
);
1949 pthread_mutex_unlock(&g
.readwrite_lock_mutex
);