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 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.
32 #include <sys/select.h>
39 static int open_device(const char *uri
, int *use_bc
);
40 static void side_cb(int print_fd
, int device_fd
, 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 const 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 * Disable backchannel data when printing to Brother, Canon, or
86 * Minolta USB printers - apparently these printers will return
87 * the IEEE-1284 device ID over and over and over when they get
91 use_bc
= strcasecmp(hostname
, "Brother") &&
92 strcasecmp(hostname
, "Canon") &&
93 strcasecmp(hostname
, "Konica Minolta") &&
94 strcasecmp(hostname
, "Minolta");
95 #endif /* __FreeBSD__ || __NetBSD__ || __OpenBSD__ || __DragonFly__ */
97 if ((device_fd
= open_device(uri
, &use_bc
)) == -1)
99 if (getenv("CLASS") != NULL
)
102 * If the CLASS environment variable is set, the job was submitted
103 * to a class and not to a specific queue. In this case, we want
104 * to abort immediately so that the job can be requeued on the next
105 * available printer in the class.
108 _cupsLangPuts(stderr
,
109 _("INFO: Unable to contact printer, queuing on next "
110 "printer in class...\n"));
113 * Sleep 5 seconds to keep the job from requeuing too rapidly...
118 return (CUPS_BACKEND_FAILED
);
123 _cupsLangPuts(stderr
,
124 _("INFO: Printer busy; will retry in 10 seconds...\n"));
127 else if (errno
== ENXIO
|| errno
== EIO
|| errno
== ENOENT
||
130 _cupsLangPuts(stderr
,
131 _("INFO: Printer not connected; will retry in 30 "
137 _cupsLangPrintf(stderr
,
138 _("ERROR: Unable to open device file \"%s\": %s\n"),
139 resource
, strerror(errno
));
140 return (CUPS_BACKEND_FAILED
);
144 while (device_fd
< 0);
146 fputs("STATE: -connecting-to-device\n", stderr
);
149 * Set any options provided...
152 tcgetattr(device_fd
, &opts
);
154 opts
.c_lflag
&= ~(ICANON
| ECHO
| ISIG
); /* Raw mode */
156 /**** No options supported yet ****/
158 tcsetattr(device_fd
, TCSANOW
, &opts
);
161 * Finally, send the print file...
166 while (copies
> 0 && tbytes
>= 0)
172 fputs("PAGE: 1 1\n", stderr
);
173 lseek(print_fd
, 0, SEEK_SET
);
176 tbytes
= backendRunLoop(print_fd
, device_fd
, use_bc
, side_cb
);
178 if (print_fd
!= 0 && tbytes
>= 0)
179 _cupsLangPrintf(stderr
,
180 #ifdef HAVE_LONG_LONG
181 _("INFO: Sent print file, %lld bytes...\n"),
183 _("INFO: Sent print file, %ld bytes...\n"),
184 #endif /* HAVE_LONG_LONG */
189 * Close the USB port and return...
194 return (tbytes
< 0 ? CUPS_BACKEND_FAILED
: CUPS_BACKEND_OK
);
199 * 'list_devices()' - List all USB devices.
206 int i
; /* Looping var */
207 int fd
; /* File descriptor */
208 char device
[255], /* Device filename */
209 device_id
[1024], /* Device ID string */
210 device_uri
[1024], /* Device URI string */
211 make_model
[1024]; /* Make and model */
214 * Try to open each USB device...
217 for (i
= 0; i
< 16; i
++)
220 * Linux has a long history of changing the standard filenames used
221 * for USB printer devices. We get the honor of trying them all...
224 sprintf(device
, "/dev/usblp%d", i
);
226 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0)
231 sprintf(device
, "/dev/usb/lp%d", i
);
233 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0)
238 sprintf(device
, "/dev/usb/usblp%d", i
);
240 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0)
245 if (!backendGetDeviceID(fd
, device_id
, sizeof(device_id
),
246 make_model
, sizeof(make_model
),
247 "usb", device_uri
, sizeof(device_uri
)))
248 printf("direct %s \"%s\" \"%s USB #%d\" \"%s\"\n", device_uri
,
249 make_model
, make_model
, i
+ 1, device_id
);
254 #elif defined(__sun) && defined(ECPPIOC_GETDEVID)
255 int i
; /* Looping var */
256 int fd
; /* File descriptor */
257 char device
[255], /* Device filename */
258 device_id
[1024], /* Device ID string */
259 device_uri
[1024], /* Device URI string */
260 make_model
[1024]; /* Make and model */
264 * Open each USB device...
267 for (i
= 0; i
< 8; i
++)
269 sprintf(device
, "/dev/usb/printer%d", i
);
271 if ((fd
= open(device
, O_WRONLY
| O_EXCL
)) >= 0)
273 if (!backendGetDeviceID(fd
, device_id
, sizeof(device_id
),
274 make_model
, sizeof(make_model
),
275 "usb", device_uri
, sizeof(device_uri
)))
276 printf("direct %s \"%s\" \"%s USB #%d\" \"%s\"\n", device_uri
,
277 make_model
, make_model
, i
+ 1, device_id
);
282 #elif defined(__hpux)
284 #elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) || defined(__FreeBSD_kernel__)
285 int i
; /* Looping var */
286 char device
[255]; /* Device filename */
289 for (i
= 0; i
< 8; i
++)
291 sprintf(device
, "/dev/ulpt%d", i
);
292 if (!access(device
, 0))
293 printf("direct usb:%s \"Unknown\" \"USB Printer #%d\"\n", device
, i
+ 1);
295 sprintf(device
, "/dev/unlpt%d", i
);
296 if (!access(device
, 0))
297 printf("direct usb:%s \"Unknown\" \"USB Printer #%d (no reset)\"\n", device
, i
+ 1);
304 * 'open_device()' - Open a USB device...
307 static int /* O - File descriptor or -1 on error */
308 open_device(const char *uri
, /* I - Device URI */
309 int *use_bc
) /* O - Set to 0 for unidirectional */
311 int fd
; /* File descriptor */
315 * The generic implementation just treats the URI as a device filename...
316 * Specific operating systems may also support using the device serial
317 * number and/or make/model.
320 if (!strncmp(uri
, "usb:/dev/", 9))
324 * Do not allow direct devices anymore...
330 else if (!strncmp(uri
, "usb://", 6))
333 * For Linux, try looking up the device serial number or model...
336 int i
; /* Looping var */
337 int busy
; /* Are any ports busy? */
338 char device
[255], /* Device filename */
339 device_id
[1024], /* Device ID string */
340 make_model
[1024], /* Make and model */
341 device_uri
[1024]; /* Device URI string */
345 * Find the correct USB device...
350 for (busy
= 0, i
= 0; i
< 16; i
++)
353 * Linux has a long history of changing the standard filenames used
354 * for USB printer devices. We get the honor of trying them all...
357 sprintf(device
, "/dev/usblp%d", i
);
359 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0 && errno
== ENOENT
)
361 sprintf(device
, "/dev/usb/lp%d", i
);
363 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0 && errno
== ENOENT
)
365 sprintf(device
, "/dev/usb/usblp%d", i
);
367 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0 && errno
== ENOENT
)
374 backendGetDeviceID(fd
, device_id
, sizeof(device_id
),
375 make_model
, sizeof(make_model
),
376 "usb", device_uri
, sizeof(device_uri
));
381 * If the open failed because it was busy, flag it so we retry
388 device_uri
[0] = '\0';
391 if (!strcmp(uri
, device_uri
))
394 * Yes, return this file descriptor...
397 fprintf(stderr
, "DEBUG: Printer using device file \"%s\"...\n",
404 * This wasn't the one...
412 * If we get here and at least one of the printer ports showed up
413 * as "busy", then sleep for a bit and retry...
418 _cupsLangPuts(stderr
,
419 _("INFO: Printer busy; will retry in 5 seconds...\n"));
426 * Couldn't find the printer, return "no such device or address"...
433 #elif defined(__sun) && defined(ECPPIOC_GETDEVID)
436 * Do not allow direct devices anymore...
442 else if (!strncmp(uri
, "usb://", 6))
445 * For Solaris, try looking up the device serial number or model...
448 int i
; /* Looping var */
449 int busy
; /* Are any ports busy? */
450 char device
[255], /* Device filename */
451 device_id
[1024], /* Device ID string */
452 make_model
[1024], /* Make and model */
453 device_uri
[1024]; /* Device URI string */
457 * Find the correct USB device...
462 for (i
= 0, busy
= 0; i
< 8; i
++)
464 sprintf(device
, "/dev/usb/printer%d", i
);
466 if ((fd
= open(device
, O_WRONLY
| O_EXCL
)) >= 0)
467 backendGetDeviceID(fd
, device_id
, sizeof(device_id
),
468 make_model
, sizeof(make_model
),
469 "usb", device_uri
, sizeof(device_uri
));
473 * If the open failed because it was busy, flag it so we retry
480 device_uri
[0] = '\0';
483 if (!strcmp(uri
, device_uri
))
486 * Yes, return this file descriptor...
489 fputs("DEBUG: Setting use_bc to 0!\n", stderr
);
497 * This wasn't the one...
505 * If we get here and at least one of the printer ports showed up
506 * as "busy", then sleep for a bit and retry...
511 _cupsLangPuts(stderr
,
512 _("INFO: Printer is busy; will retry in 5 seconds...\n"));
519 * Couldn't find the printer, return "no such device or address"...
529 fd
= open(uri
+ 4, O_RDWR
| O_EXCL
);
535 fd
= open(uri
+ 4, O_WRONLY
| O_EXCL
);
551 * 'side_cb()' - Handle side-channel requests...
555 side_cb(int print_fd
, /* I - Print file */
556 int device_fd
, /* I - Device file */
557 int use_bc
) /* I - Using back-channel? */
559 cups_sc_command_t command
; /* Request command */
560 cups_sc_status_t status
; /* Request/response status */
561 char data
[2048]; /* Request/response data */
562 int datalen
; /* Request/response data size */
565 datalen
= sizeof(data
);
567 if (cupsSideChannelRead(&command
, &status
, data
, &datalen
, 1.0))
569 _cupsLangPuts(stderr
, _("WARNING: Failed to read side-channel request!\n"));
575 case CUPS_SC_CMD_DRAIN_OUTPUT
:
576 if (backendDrainOutput(print_fd
, device_fd
))
577 status
= CUPS_SC_STATUS_IO_ERROR
;
578 else if (tcdrain(device_fd
))
579 status
= CUPS_SC_STATUS_IO_ERROR
;
581 status
= CUPS_SC_STATUS_OK
;
586 case CUPS_SC_CMD_GET_BIDI
:
591 case CUPS_SC_CMD_GET_DEVICE_ID
:
592 memset(data
, 0, sizeof(data
));
594 if (backendGetDeviceID(device_fd
, data
, sizeof(data
) - 1,
595 NULL
, 0, NULL
, NULL
, 0))
597 status
= CUPS_SC_STATUS_NOT_IMPLEMENTED
;
602 status
= CUPS_SC_STATUS_OK
;
603 datalen
= strlen(data
);
608 status
= CUPS_SC_STATUS_NOT_IMPLEMENTED
;
613 cupsSideChannelWrite(command
, status
, data
, datalen
, 1.0);