2 * "$Id: usb-unix.c 7810 2008-07-29 01:11:15Z mike $"
4 * USB port backend for the Common UNIX Printing System (CUPS).
6 * This file is included from "usb.c" when compiled on UNIX/Linux.
8 * Copyright 2007-2009 by Apple Inc.
9 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
11 * These coded instructions, statements, and computer programs are the
12 * property of Apple Inc. and are protected by Federal copyright
13 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
14 * "LICENSE" which should have been included with this file. If this
15 * file is missing or damaged, see the license at "http://www.cups.org/".
17 * This file is subject to the Apple OS-Developed Software exception.
21 * print_device() - Print a file to a USB device.
22 * list_devices() - List all USB devices.
23 * open_device() - Open a USB device...
24 * side_cb() - Handle side-channel requests...
28 * Include necessary headers.
31 #include <sys/select.h>
38 static int open_device(const char *uri
, int *use_bc
);
39 static int side_cb(int print_fd
, int device_fd
, int snmp_fd
,
40 http_addr_t
*addr
, int use_bc
);
44 * 'print_device()' - Print a file to a USB device.
47 int /* O - Exit status */
48 print_device(const char *uri
, /* I - Device URI */
49 const char *hostname
, /* I - Hostname/manufacturer */
50 const char *resource
, /* I - Resource/modelname */
51 char *options
, /* I - Device options/serial number */
52 int print_fd
, /* I - File descriptor to print */
53 int copies
, /* I - Copies to print */
54 int argc
, /* I - Number of command-line arguments (6 or 7) */
55 char *argv
[]) /* I - Command-line arguments */
57 int use_bc
; /* Use backchannel path? */
58 int device_fd
; /* USB device */
59 size_t tbytes
; /* Total number of bytes written */
60 struct termios opts
; /* Parallel port options */
67 * Open the USB port device...
70 fputs("STATE: +connecting-to-device\n", stderr
);
74 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
76 * *BSD's ulpt driver currently does not support the
77 * back-channel, incorrectly returns data ready on a select(),
78 * and locks up on read()...
85 * CUPS STR #3028: Solaris' usbprn driver apparently does not support
86 * select() or poll(), so we can't support backchannel...
93 * Disable backchannel data when printing to Brother, Canon, or
94 * Minolta USB printers - apparently these printers will return
95 * the IEEE-1284 device ID over and over and over when they get
99 use_bc
= strcasecmp(hostname
, "Brother") &&
100 strcasecmp(hostname
, "Canon") &&
101 strncasecmp(hostname
, "Konica", 6) &&
102 strncasecmp(hostname
, "Minolta", 7);
103 #endif /* __FreeBSD__ || __NetBSD__ || __OpenBSD__ || __DragonFly__ */
105 if ((device_fd
= open_device(uri
, &use_bc
)) == -1)
107 if (getenv("CLASS") != NULL
)
110 * If the CLASS environment variable is set, the job was submitted
111 * to a class and not to a specific queue. In this case, we want
112 * to abort immediately so that the job can be requeued on the next
113 * available printer in the class.
116 _cupsLangPrintFilter(stderr
, "INFO",
117 _("Unable to contact printer, queuing on next "
118 "printer in class."));
121 * Sleep 5 seconds to keep the job from requeuing too rapidly...
126 return (CUPS_BACKEND_FAILED
);
131 _cupsLangPrintFilter(stderr
, "INFO",
132 _("Printer busy, will retry in 10 seconds."));
135 else if (errno
== ENXIO
|| errno
== EIO
|| errno
== ENOENT
||
138 _cupsLangPrintFilter(stderr
, "INFO",
139 _("Printer not connected, will retry in 30 "
145 _cupsLangPrintError(stderr
, "ERROR", _("Unable to open device file"));
146 return (CUPS_BACKEND_FAILED
);
150 while (device_fd
< 0);
152 fputs("STATE: -connecting-to-device\n", stderr
);
155 * Set any options provided...
158 tcgetattr(device_fd
, &opts
);
160 opts
.c_lflag
&= ~(ICANON
| ECHO
| ISIG
); /* Raw mode */
162 /**** No options supported yet ****/
164 tcsetattr(device_fd
, TCSANOW
, &opts
);
167 * Finally, send the print file...
172 while (copies
> 0 && tbytes
>= 0)
178 fputs("PAGE: 1 1\n", stderr
);
179 lseek(print_fd
, 0, SEEK_SET
);
184 * CUPS STR #3028: Solaris' usbprn driver apparently does not support
185 * select() or poll(), so we can't support the sidechannel either...
188 tbytes
= backendRunLoop(print_fd
, device_fd
, -1, NULL
, use_bc
, 1, NULL
);
191 tbytes
= backendRunLoop(print_fd
, device_fd
, -1, NULL
, use_bc
, 1, side_cb
);
194 if (print_fd
!= 0 && tbytes
>= 0)
195 _cupsLangPrintFilter(stderr
, "INFO", _("Print file sent."));
199 * Close the USB port and return...
204 return (tbytes
< 0 ? CUPS_BACKEND_FAILED
: CUPS_BACKEND_OK
);
209 * 'list_devices()' - List all USB devices.
216 int i
; /* Looping var */
217 int fd
; /* File descriptor */
218 char device
[255], /* Device filename */
219 device_id
[1024], /* Device ID string */
220 device_uri
[1024], /* Device URI string */
221 make_model
[1024]; /* Make and model */
225 * Try to open each USB device...
228 for (i
= 0; i
< 16; i
++)
231 * Linux has a long history of changing the standard filenames used
232 * for USB printer devices. We get the honor of trying them all...
235 sprintf(device
, "/dev/usblp%d", i
);
237 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0)
242 sprintf(device
, "/dev/usb/lp%d", i
);
244 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0)
249 sprintf(device
, "/dev/usb/usblp%d", i
);
251 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0)
256 if (!backendGetDeviceID(fd
, device_id
, sizeof(device_id
),
257 make_model
, sizeof(make_model
),
258 "usb", device_uri
, sizeof(device_uri
)))
259 cupsBackendReport("direct", device_uri
, make_model
, make_model
,
265 #elif defined(__sun) && defined(ECPPIOC_GETDEVID)
266 int i
; /* Looping var */
267 int fd
; /* File descriptor */
268 char device
[255], /* Device filename */
269 device_id
[1024], /* Device ID string */
270 device_uri
[1024], /* Device URI string */
271 make_model
[1024]; /* Make and model */
275 * Open each USB device...
278 for (i
= 0; i
< 8; i
++)
280 sprintf(device
, "/dev/usb/printer%d", i
);
282 if ((fd
= open(device
, O_WRONLY
| O_EXCL
)) >= 0)
284 if (!backendGetDeviceID(fd
, device_id
, sizeof(device_id
),
285 make_model
, sizeof(make_model
),
286 "usb", device_uri
, sizeof(device_uri
)))
287 cupsBackendReport("direct", device_uri
, make_model
, make_model
,
293 #elif defined(__hpux)
295 #elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) || defined(__FreeBSD_kernel__)
296 int i
; /* Looping var */
297 char device
[255]; /* Device filename */
300 for (i
= 0; i
< 8; i
++)
302 sprintf(device
, "/dev/ulpt%d", i
);
303 if (!access(device
, 0))
304 printf("direct usb:%s \"Unknown\" \"USB Printer #%d\"\n", device
, i
+ 1);
306 sprintf(device
, "/dev/unlpt%d", i
);
307 if (!access(device
, 0))
308 printf("direct usb:%s \"Unknown\" \"USB Printer #%d (no reset)\"\n", device
, i
+ 1);
315 * 'open_device()' - Open a USB device...
318 static int /* O - File descriptor or -1 on error */
319 open_device(const char *uri
, /* I - Device URI */
320 int *use_bc
) /* O - Set to 0 for unidirectional */
322 int fd
; /* File descriptor */
326 * The generic implementation just treats the URI as a device filename...
327 * Specific operating systems may also support using the device serial
328 * number and/or make/model.
331 if (!strncmp(uri
, "usb:/dev/", 9))
335 * Do not allow direct devices anymore...
341 else if (!strncmp(uri
, "usb://", 6))
344 * For Linux, try looking up the device serial number or model...
347 int i
; /* Looping var */
348 int busy
; /* Are any ports busy? */
349 char device
[255], /* Device filename */
350 device_id
[1024], /* Device ID string */
351 make_model
[1024], /* Make and model */
352 device_uri
[1024]; /* Device URI string */
356 * Find the correct USB device...
361 for (busy
= 0, i
= 0; i
< 16; i
++)
364 * Linux has a long history of changing the standard filenames used
365 * for USB printer devices. We get the honor of trying them all...
368 sprintf(device
, "/dev/usblp%d", i
);
370 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0 && errno
== ENOENT
)
372 sprintf(device
, "/dev/usb/lp%d", i
);
374 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0 && errno
== ENOENT
)
376 sprintf(device
, "/dev/usb/usblp%d", i
);
378 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0 && errno
== ENOENT
)
385 backendGetDeviceID(fd
, device_id
, sizeof(device_id
),
386 make_model
, sizeof(make_model
),
387 "usb", device_uri
, sizeof(device_uri
));
392 * If the open failed because it was busy, flag it so we retry
399 device_uri
[0] = '\0';
402 if (!strcmp(uri
, device_uri
))
405 * Yes, return this file descriptor...
408 fprintf(stderr
, "DEBUG: Printer using device file \"%s\"...\n",
415 * This wasn't the one...
423 * If we get here and at least one of the printer ports showed up
424 * as "busy", then sleep for a bit and retry...
428 _cupsLangPrintFilter(stderr
, "INFO",
429 _("Printer is busy, will retry in 5 seconds."));
434 #elif defined(__sun) && defined(ECPPIOC_GETDEVID)
437 * Do not allow direct devices anymore...
443 else if (!strncmp(uri
, "usb://", 6))
446 * For Solaris, try looking up the device serial number or model...
449 int i
; /* Looping var */
450 int busy
; /* Are any ports busy? */
451 char device
[255], /* Device filename */
452 device_id
[1024], /* Device ID string */
453 make_model
[1024], /* Make and model */
454 device_uri
[1024]; /* Device URI string */
458 * Find the correct USB device...
463 for (i
= 0, busy
= 0; i
< 8; i
++)
465 sprintf(device
, "/dev/usb/printer%d", i
);
467 if ((fd
= open(device
, O_WRONLY
| O_EXCL
)) >= 0)
468 backendGetDeviceID(fd
, device_id
, sizeof(device_id
),
469 make_model
, sizeof(make_model
),
470 "usb", device_uri
, sizeof(device_uri
));
474 * If the open failed because it was busy, flag it so we retry
481 device_uri
[0] = '\0';
484 if (!strcmp(uri
, device_uri
))
487 * Yes, return this file descriptor...
490 fputs("DEBUG: Setting use_bc to 0!\n", stderr
);
498 * This wasn't the one...
506 * If we get here and at least one of the printer ports showed up
507 * as "busy", then sleep for a bit and retry...
512 _cupsLangPrintFilter(stderr
, "INFO",
513 _("Printer is busy, will retry in 5 seconds."));
520 * Couldn't find the printer, return "no such device or address"...
530 fd
= open(uri
+ 4, O_RDWR
| O_EXCL
);
536 fd
= open(uri
+ 4, O_WRONLY
| O_EXCL
);
552 * 'side_cb()' - Handle side-channel requests...
555 static int /* O - 0 on success, -1 on error */
556 side_cb(int print_fd
, /* I - Print file */
557 int device_fd
, /* I - Device file */
558 int snmp_fd
, /* I - SNMP socket (unused) */
559 http_addr_t
*addr
, /* I - Device address (unused) */
560 int use_bc
) /* I - Using back-channel? */
562 cups_sc_command_t command
; /* Request command */
563 cups_sc_status_t status
; /* Request/response status */
564 char data
[2048]; /* Request/response data */
565 int datalen
; /* Request/response data size */
571 datalen
= sizeof(data
);
573 if (cupsSideChannelRead(&command
, &status
, data
, &datalen
, 1.0))
578 case CUPS_SC_CMD_DRAIN_OUTPUT
:
579 if (backendDrainOutput(print_fd
, device_fd
))
580 status
= CUPS_SC_STATUS_IO_ERROR
;
581 else if (tcdrain(device_fd
))
582 status
= CUPS_SC_STATUS_IO_ERROR
;
584 status
= CUPS_SC_STATUS_OK
;
589 case CUPS_SC_CMD_GET_BIDI
:
590 status
= CUPS_SC_STATUS_OK
;
595 case CUPS_SC_CMD_GET_DEVICE_ID
:
596 memset(data
, 0, sizeof(data
));
598 if (backendGetDeviceID(device_fd
, data
, sizeof(data
) - 1,
599 NULL
, 0, NULL
, NULL
, 0))
601 status
= CUPS_SC_STATUS_NOT_IMPLEMENTED
;
606 status
= CUPS_SC_STATUS_OK
;
607 datalen
= strlen(data
);
612 status
= CUPS_SC_STATUS_NOT_IMPLEMENTED
;
617 return (cupsSideChannelWrite(command
, status
, data
, datalen
, 1.0));
622 * End of "$Id: usb-unix.c 7810 2008-07-29 01:11:15Z mike $".