2 * libusb example program to manipulate U.are.U 4000B fingerprint scanner.
3 * Copyright © 2007 Daniel Drake <dsd@gentoo.org>
5 * Basic image capture program only, does not consider the powerup quirks or
6 * the fact that image encryption may be enabled. Not expected to work
7 * flawlessly all of the time.
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
32 #define EP_INTR (1 | LIBUSB_ENDPOINT_IN)
33 #define EP_DATA (2 | LIBUSB_ENDPOINT_IN)
34 #define CTRL_IN (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_IN)
35 #define CTRL_OUT (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_OUT)
37 #define INTR_LENGTH 64
41 MODE_AWAIT_FINGER_ON = 0x10,
42 MODE_AWAIT_FINGER_OFF = 0x12,
48 static int next_state(void);
51 STATE_AWAIT_MODE_CHANGE_AWAIT_FINGER_ON = 1,
52 STATE_AWAIT_IRQ_FINGER_DETECTED,
53 STATE_AWAIT_MODE_CHANGE_CAPTURE,
55 STATE_AWAIT_MODE_CHANGE_AWAIT_FINGER_OFF,
56 STATE_AWAIT_IRQ_FINGER_REMOVED,
60 static struct libusb_device_handle *devh = NULL;
61 static unsigned char imgbuf[0x1b340];
62 static unsigned char irqbuf[INTR_LENGTH];
63 static struct libusb_transfer *img_transfer = NULL;
64 static struct libusb_transfer *irq_transfer = NULL;
65 static int img_idx = 0;
66 static int do_exit = 0;
68 static int find_dpfp_device(void)
70 devh = libusb_open_device_with_vid_pid(NULL, 0x05ba, 0x000a);
71 return devh ? 0 : -EIO;
74 static int print_f0_data(void)
76 unsigned char data[0x10];
80 r = libusb_control_transfer(devh, CTRL_IN, USB_RQ, 0xf0, 0, data,
83 fprintf(stderr, "F0 error %d\n", r);
86 if ((unsigned int) r < sizeof(data)) {
87 fprintf(stderr, "short read (%d)\n", r);
92 for (i = 0; i < sizeof(data); i++)
93 printf("%02x ", data[i]);
98 static int get_hwstat(unsigned char *status)
102 r = libusb_control_transfer(devh, CTRL_IN, USB_RQ, 0x07, 0, status, 1, 0);
104 fprintf(stderr, "read hwstat error %d\n", r);
107 if ((unsigned int) r < 1) {
108 fprintf(stderr, "short read (%d)\n", r);
112 printf("hwstat reads %02x\n", *status);
116 static int set_hwstat(unsigned char data)
120 printf("set hwstat to %02x\n", data);
121 r = libusb_control_transfer(devh, CTRL_OUT, USB_RQ, 0x07, 0, &data, 1, 0);
123 fprintf(stderr, "set hwstat error %d\n", r);
126 if ((unsigned int) r < 1) {
127 fprintf(stderr, "short write (%d)", r);
134 static int set_mode(unsigned char data)
137 printf("set mode %02x\n", data);
139 r = libusb_control_transfer(devh, CTRL_OUT, USB_RQ, 0x4e, 0, &data, 1, 0);
141 fprintf(stderr, "set mode error %d\n", r);
144 if ((unsigned int) r < 1) {
145 fprintf(stderr, "short write (%d)", r);
152 static void LIBUSB_CALL cb_mode_changed(struct libusb_transfer *transfer)
154 if (transfer->status != LIBUSB_TRANSFER_COMPLETED) {
155 fprintf(stderr, "mode change transfer not completed!\n");
159 printf("async cb_mode_changed length=%d actual_length=%d\n",
160 transfer->length, transfer->actual_length);
161 if (next_state() < 0)
165 static int set_mode_async(unsigned char data)
167 unsigned char *buf = (unsigned char*) malloc(LIBUSB_CONTROL_SETUP_SIZE + 1);
168 struct libusb_transfer *transfer;
173 transfer = libusb_alloc_transfer(0);
179 printf("async set mode %02x\n", data);
180 libusb_fill_control_setup(buf, CTRL_OUT, USB_RQ, 0x4e, 0, 1);
181 buf[LIBUSB_CONTROL_SETUP_SIZE] = data;
182 libusb_fill_control_transfer(transfer, devh, buf, cb_mode_changed, NULL,
185 transfer->flags = LIBUSB_TRANSFER_SHORT_NOT_OK
186 | LIBUSB_TRANSFER_FREE_BUFFER | LIBUSB_TRANSFER_FREE_TRANSFER;
187 return libusb_submit_transfer(transfer);
190 static int do_sync_intr(unsigned char *data)
195 r = libusb_interrupt_transfer(devh, EP_INTR, data, INTR_LENGTH,
198 fprintf(stderr, "intr error %d\n", r);
201 if (transferred < INTR_LENGTH) {
202 fprintf(stderr, "short read (%d)\n", r);
206 printf("recv interrupt %04x\n", *((uint16_t *) data));
210 static int sync_intr(unsigned char type)
213 unsigned char data[INTR_LENGTH];
216 r = do_sync_intr(data);
224 static int save_to_file(unsigned char *data)
229 snprintf(filename, sizeof(filename), "finger%d.pgm", img_idx++);
230 fd = fopen(filename, "w");
234 fputs("P5 384 289 255 ", fd);
235 (void) fwrite(data + 64, 1, 384*289, fd);
237 printf("saved image to %s\n", filename);
241 static int next_state(void)
244 printf("old state: %d\n", state);
246 case STATE_AWAIT_IRQ_FINGER_REMOVED:
247 state = STATE_AWAIT_MODE_CHANGE_AWAIT_FINGER_ON;
248 r = set_mode_async(MODE_AWAIT_FINGER_ON);
250 case STATE_AWAIT_MODE_CHANGE_AWAIT_FINGER_ON:
251 state = STATE_AWAIT_IRQ_FINGER_DETECTED;
253 case STATE_AWAIT_IRQ_FINGER_DETECTED:
254 state = STATE_AWAIT_MODE_CHANGE_CAPTURE;
255 r = set_mode_async(MODE_CAPTURE);
257 case STATE_AWAIT_MODE_CHANGE_CAPTURE:
258 state = STATE_AWAIT_IMAGE;
260 case STATE_AWAIT_IMAGE:
261 state = STATE_AWAIT_MODE_CHANGE_AWAIT_FINGER_OFF;
262 r = set_mode_async(MODE_AWAIT_FINGER_OFF);
264 case STATE_AWAIT_MODE_CHANGE_AWAIT_FINGER_OFF:
265 state = STATE_AWAIT_IRQ_FINGER_REMOVED;
268 printf("unrecognised state %d\n", state);
271 fprintf(stderr, "error detected changing state\n");
275 printf("new state: %d\n", state);
279 static void LIBUSB_CALL cb_irq(struct libusb_transfer *transfer)
281 unsigned char irqtype = transfer->buffer[0];
283 if (transfer->status != LIBUSB_TRANSFER_COMPLETED) {
284 fprintf(stderr, "irq transfer status %d?\n", transfer->status);
286 libusb_free_transfer(transfer);
291 printf("IRQ callback %02x\n", irqtype);
293 case STATE_AWAIT_IRQ_FINGER_DETECTED:
294 if (irqtype == 0x01) {
295 if (next_state() < 0) {
300 printf("finger-on-sensor detected in wrong state!\n");
303 case STATE_AWAIT_IRQ_FINGER_REMOVED:
304 if (irqtype == 0x02) {
305 if (next_state() < 0) {
310 printf("finger-on-sensor detected in wrong state!\n");
314 if (libusb_submit_transfer(irq_transfer) < 0)
318 static void LIBUSB_CALL cb_img(struct libusb_transfer *transfer)
320 if (transfer->status != LIBUSB_TRANSFER_COMPLETED) {
321 fprintf(stderr, "img transfer status %d?\n", transfer->status);
323 libusb_free_transfer(transfer);
328 printf("Image callback\n");
329 save_to_file(imgbuf);
330 if (next_state() < 0) {
334 if (libusb_submit_transfer(img_transfer) < 0)
338 static int init_capture(void)
342 r = libusb_submit_transfer(irq_transfer);
346 r = libusb_submit_transfer(img_transfer);
348 libusb_cancel_transfer(irq_transfer);
350 if (libusb_handle_events(NULL) < 0)
355 /* start state machine */
356 state = STATE_AWAIT_IRQ_FINGER_REMOVED;
360 static int do_init(void)
362 unsigned char status;
365 r = get_hwstat(&status);
369 if (!(status & 0x80)) {
370 r = set_hwstat(status | 0x80);
373 r = get_hwstat(&status);
379 r = set_hwstat(status);
383 r = get_hwstat(&status);
394 static int alloc_transfers(void)
396 img_transfer = libusb_alloc_transfer(0);
400 irq_transfer = libusb_alloc_transfer(0);
404 libusb_fill_bulk_transfer(img_transfer, devh, EP_DATA, imgbuf,
405 sizeof(imgbuf), cb_img, NULL, 0);
406 libusb_fill_interrupt_transfer(irq_transfer, devh, EP_INTR, irqbuf,
407 sizeof(irqbuf), cb_irq, NULL, 0);
412 static void sighandler(int signum)
419 struct sigaction sigact;
422 r = libusb_init(NULL);
424 fprintf(stderr, "failed to initialise libusb\n");
428 r = find_dpfp_device();
430 fprintf(stderr, "Could not find/open device\n");
434 r = libusb_claim_interface(devh, 0);
436 fprintf(stderr, "usb_claim_interface error %d\n", r);
439 printf("claimed interface\n");
449 /* async from here onwards */
451 r = alloc_transfers();
459 sigact.sa_handler = sighandler;
460 sigemptyset(&sigact.sa_mask);
462 sigaction(SIGINT, &sigact, NULL);
463 sigaction(SIGTERM, &sigact, NULL);
464 sigaction(SIGQUIT, &sigact, NULL);
467 r = libusb_handle_events(NULL);
472 printf("shutting down...\n");
475 r = libusb_cancel_transfer(irq_transfer);
481 r = libusb_cancel_transfer(img_transfer);
486 while (irq_transfer || img_transfer)
487 if (libusb_handle_events(NULL) < 0)
496 libusb_free_transfer(img_transfer);
497 libusb_free_transfer(irq_transfer);
501 libusb_release_interface(devh, 0);
505 return r >= 0 ? r : -r;