2 * "$Id: usb-unix.c 6510 2007-05-04 13:08:05Z 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 1997-2007 by Easy Software Products, all rights reserved.
10 * These coded instructions, statements, and computer programs are the
11 * property of Easy Software Products and are protected by Federal
12 * copyright law. Distribution and use rights are outlined in the file
13 * "LICENSE" which should have been included with this file. If this
14 * file is missing or damaged please contact Easy Software Products
17 * Attn: CUPS Licensing Information
18 * Easy Software Products
19 * 44141 Airport View Drive, Suite 204
20 * Hollywood, Maryland 20636 USA
22 * Voice: (301) 373-9600
23 * EMail: cups-info@cups.org
24 * WWW: http://www.cups.org
26 * This file is subject to the Apple OS-Developed Software exception.
30 * print_device() - Print a file to a USB device.
31 * list_devices() - List all USB devices.
32 * open_device() - Open a USB device...
33 * side_cb() - Handle side-channel requests...
37 * Include necessary headers.
41 #include <sys/select.h>
48 static int open_device(const char *uri
, int *use_bc
);
49 static void side_cb(int print_fd
, int device_fd
, int use_bc
);
53 * 'print_device()' - Print a file to a USB device.
56 int /* O - Exit status */
57 print_device(const char *uri
, /* I - Device URI */
58 const char *hostname
, /* I - Hostname/manufacturer */
59 const char *resource
, /* I - Resource/modelname */
60 const char *options
, /* I - Device options/serial number */
61 int print_fd
, /* I - File descriptor to print */
62 int copies
, /* I - Copies to print */
63 int argc
, /* I - Number of command-line arguments (6 or 7) */
64 char *argv
[]) /* I - Command-line arguments */
66 int use_bc
; /* Use backchannel path? */
67 int device_fd
; /* USB device */
68 size_t tbytes
; /* Total number of bytes written */
69 struct termios opts
; /* Parallel port options */
76 * Open the USB port device...
79 fputs("STATE: +connecting-to-device\n", stderr
);
83 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
85 * *BSD's ulpt driver currently does not support the
86 * back-channel, incorrectly returns data ready on a select(),
87 * and locks up on read()...
94 * Disable backchannel data when printing to Brother, Canon, or
95 * Minolta USB printers - apparently these printers will return
96 * the IEEE-1284 device ID over and over and over when they get
100 use_bc
= strcasecmp(hostname
, "Brother") &&
101 strcasecmp(hostname
, "Canon") &&
102 strcasecmp(hostname
, "Konica Minolta") &&
103 strcasecmp(hostname
, "Minolta");
104 #endif /* __FreeBSD__ || __NetBSD__ || __OpenBSD__ || __DragonFly__ */
106 if ((device_fd
= open_device(uri
, &use_bc
)) == -1)
108 if (getenv("CLASS") != NULL
)
111 * If the CLASS environment variable is set, the job was submitted
112 * to a class and not to a specific queue. In this case, we want
113 * to abort immediately so that the job can be requeued on the next
114 * available printer in the class.
117 fputs(_("INFO: Unable to contact printer, queuing on next "
118 "printer in class...\n"), stderr
);
121 * Sleep 5 seconds to keep the job from requeuing too rapidly...
126 return (CUPS_BACKEND_FAILED
);
131 fputs(_("INFO: Printer busy; will retry in 10 seconds...\n"), stderr
);
134 else if (errno
== ENXIO
|| errno
== EIO
|| errno
== ENOENT
||
137 fputs(_("INFO: Printer not connected; will retry in 30 seconds...\n"),
143 fprintf(stderr
, _("ERROR: Unable to open device file \"%s\": %s\n"),
144 resource
, strerror(errno
));
145 return (CUPS_BACKEND_FAILED
);
149 while (device_fd
< 0);
151 fputs("STATE: -connecting-to-device\n", stderr
);
154 * Set any options provided...
157 tcgetattr(device_fd
, &opts
);
159 opts
.c_lflag
&= ~(ICANON
| ECHO
| ISIG
); /* Raw mode */
161 /**** No options supported yet ****/
163 tcsetattr(device_fd
, TCSANOW
, &opts
);
166 * Finally, send the print file...
171 while (copies
> 0 && tbytes
>= 0)
177 fputs("PAGE: 1 1\n", stderr
);
178 lseek(print_fd
, 0, SEEK_SET
);
181 tbytes
= backendRunLoop(print_fd
, device_fd
, use_bc
, side_cb
);
183 if (print_fd
!= 0 && tbytes
>= 0)
185 #ifdef HAVE_LONG_LONG
186 _("INFO: Sent print file, %lld bytes...\n"),
188 _("INFO: Sent print file, %ld bytes...\n"),
189 #endif /* HAVE_LONG_LONG */
194 * Close the USB port and return...
199 return (tbytes
< 0 ? CUPS_BACKEND_FAILED
: CUPS_BACKEND_OK
);
204 * 'list_devices()' - List all USB devices.
211 int i
; /* Looping var */
212 int fd
; /* File descriptor */
213 char device
[255], /* Device filename */
214 device_id
[1024], /* Device ID string */
215 device_uri
[1024], /* Device URI string */
216 make_model
[1024]; /* Make and model */
219 * Try to open each USB device...
222 for (i
= 0; i
< 16; i
++)
225 * Linux has a long history of changing the standard filenames used
226 * for USB printer devices. We get the honor of trying them all...
229 sprintf(device
, "/dev/usblp%d", i
);
231 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0)
236 sprintf(device
, "/dev/usb/lp%d", i
);
238 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0)
243 sprintf(device
, "/dev/usb/usblp%d", i
);
245 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0)
250 if (!backendGetDeviceID(fd
, device_id
, sizeof(device_id
),
251 make_model
, sizeof(make_model
),
252 "usb", device_uri
, sizeof(device_uri
)))
253 printf("direct %s \"%s\" \"%s USB #%d\" \"%s\"\n", device_uri
,
254 make_model
, make_model
, i
+ 1, device_id
);
259 #elif defined(__sun) && defined(ECPPIOC_GETDEVID)
260 int i
; /* Looping var */
261 int fd
; /* File descriptor */
262 char device
[255], /* Device filename */
263 device_id
[1024], /* Device ID string */
264 device_uri
[1024], /* Device URI string */
265 make_model
[1024]; /* Make and model */
269 * Open each USB device...
272 for (i
= 0; i
< 8; i
++)
274 sprintf(device
, "/dev/usb/printer%d", i
);
276 if ((fd
= open(device
, O_WRONLY
| O_EXCL
)) >= 0)
278 if (!backendGetDeviceID(fd
, device_id
, sizeof(device_id
),
279 make_model
, sizeof(make_model
),
280 "usb", device_uri
, sizeof(device_uri
)))
281 printf("direct %s \"%s\" \"%s USB #%d\" \"%s\"\n", device_uri
,
282 make_model
, make_model
, i
+ 1, device_id
);
287 #elif defined(__hpux)
289 #elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
290 int i
; /* Looping var */
291 char device
[255]; /* Device filename */
294 for (i
= 0; i
< 8; i
++)
296 sprintf(device
, "/dev/ulpt%d", i
);
297 if (!access(device
, 0))
298 printf("direct usb:%s \"Unknown\" \"USB Printer #%d\"\n", device
, i
+ 1);
300 sprintf(device
, "/dev/unlpt%d", i
);
301 if (!access(device
, 0))
302 printf("direct usb:%s \"Unknown\" \"USB Printer #%d (no reset)\"\n", device
, i
+ 1);
309 * 'open_device()' - Open a USB device...
312 static int /* O - File descriptor or -1 on error */
313 open_device(const char *uri
, /* I - Device URI */
314 int *use_bc
) /* O - Set to 0 for unidirectional */
316 int fd
; /* File descriptor */
320 * The generic implementation just treats the URI as a device filename...
321 * Specific operating systems may also support using the device serial
322 * number and/or make/model.
325 if (!strncmp(uri
, "usb:/dev/", 9))
329 * Do not allow direct devices anymore...
335 else if (!strncmp(uri
, "usb://", 6))
338 * For Linux, try looking up the device serial number or model...
341 int i
; /* Looping var */
342 int busy
; /* Are any ports busy? */
343 char device
[255], /* Device filename */
344 device_id
[1024], /* Device ID string */
345 make_model
[1024], /* Make and model */
346 device_uri
[1024]; /* Device URI string */
350 * Find the correct USB device...
355 for (busy
= 0, i
= 0; i
< 16; i
++)
358 * Linux has a long history of changing the standard filenames used
359 * for USB printer devices. We get the honor of trying them all...
362 sprintf(device
, "/dev/usblp%d", i
);
364 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0 && errno
== ENOENT
)
366 sprintf(device
, "/dev/usb/lp%d", i
);
368 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0 && errno
== ENOENT
)
370 sprintf(device
, "/dev/usb/usblp%d", i
);
372 if ((fd
= open(device
, O_RDWR
| O_EXCL
)) < 0 && errno
== ENOENT
)
379 backendGetDeviceID(fd
, device_id
, sizeof(device_id
),
380 make_model
, sizeof(make_model
),
381 "usb", device_uri
, sizeof(device_uri
));
386 * If the open failed because it was busy, flag it so we retry
393 device_uri
[0] = '\0';
396 if (!strcmp(uri
, device_uri
))
399 * Yes, return this file descriptor...
402 fprintf(stderr
, "DEBUG: Printer using device file \"%s\"...\n",
409 * This wasn't the one...
417 * If we get here and at least one of the printer ports showed up
418 * as "busy", then sleep for a bit and retry...
423 fputs(_("INFO: Printer busy; will retry in 5 seconds...\n"),
431 * Couldn't find the printer, return "no such device or address"...
438 #elif defined(__sun) && defined(ECPPIOC_GETDEVID)
441 * Do not allow direct devices anymore...
447 else if (!strncmp(uri
, "usb://", 6))
450 * For Solaris, try looking up the device serial number or model...
453 int i
; /* Looping var */
454 int busy
; /* Are any ports busy? */
455 char device
[255], /* Device filename */
456 device_id
[1024], /* Device ID string */
457 make_model
[1024], /* Make and model */
458 device_uri
[1024]; /* Device URI string */
462 * Find the correct USB device...
467 for (i
= 0, busy
= 0; i
< 8; i
++)
469 sprintf(device
, "/dev/usb/printer%d", i
);
471 if ((fd
= open(device
, O_WRONLY
| O_EXCL
)) >= 0)
472 backendGetDeviceID(fd
, device_id
, sizeof(device_id
),
473 make_model
, sizeof(make_model
),
474 "usb", device_uri
, sizeof(device_uri
));
478 * If the open failed because it was busy, flag it so we retry
485 device_uri
[0] = '\0';
488 if (!strcmp(uri
, device_uri
))
491 * Yes, return this file descriptor...
494 fputs("DEBUG: Setting use_bc to 0!\n", stderr
);
502 * This wasn't the one...
510 * If we get here and at least one of the printer ports showed up
511 * as "busy", then sleep for a bit and retry...
516 fputs(_("INFO: Printer is busy; will retry in 5 seconds...\n"),
524 * Couldn't find the printer, return "no such device or address"...
534 fd
= open(uri
+ 4, O_RDWR
| O_EXCL
);
540 fd
= open(uri
+ 4, O_WRONLY
| O_EXCL
);
556 * 'side_cb()' - Handle side-channel requests...
560 side_cb(int print_fd
, /* I - Print file */
561 int device_fd
, /* I - Device file */
562 int use_bc
) /* I - Using back-channel? */
564 cups_sc_command_t command
; /* Request command */
565 cups_sc_status_t status
; /* Request/response status */
566 char data
[2048]; /* Request/response data */
567 int datalen
; /* Request/response data size */
570 datalen
= sizeof(data
);
572 if (cupsSideChannelRead(&command
, &status
, data
, &datalen
, 1.0))
574 fputs(_("WARNING: Failed to read side-channel request!\n"), stderr
);
580 case CUPS_SC_CMD_DRAIN_OUTPUT
:
581 if (tcdrain(device_fd
))
582 status
= CUPS_SC_STATUS_IO_ERROR
;
584 status
= CUPS_SC_STATUS_OK
;
589 case CUPS_SC_CMD_GET_BIDI
:
594 case CUPS_SC_CMD_GET_DEVICE_ID
:
595 memset(data
, 0, sizeof(data
));
597 if (backendGetDeviceID(device_fd
, data
, sizeof(data
) - 1,
598 NULL
, 0, NULL
, NULL
, 0))
600 status
= CUPS_SC_STATUS_NOT_IMPLEMENTED
;
605 status
= CUPS_SC_STATUS_OK
;
606 datalen
= strlen(data
);
611 status
= CUPS_SC_STATUS_NOT_IMPLEMENTED
;
616 cupsSideChannelWrite(command
, status
, data
, datalen
, 1.0);
621 * End of "$Id: usb-unix.c 6510 2007-05-04 13:08:05Z mike $".