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
33 #define EP_INTR (1 | LIBUSB_ENDPOINT_IN)
34 #define EP_DATA (2 | LIBUSB_ENDPOINT_IN)
35 #define CTRL_IN (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_IN)
36 #define CTRL_OUT (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_OUT)
38 #define INTR_LENGTH 64
42 MODE_AWAIT_FINGER_ON = 0x10,
43 MODE_AWAIT_FINGER_OFF = 0x12,
49 static int next_state(void);
52 STATE_AWAIT_MODE_CHANGE_AWAIT_FINGER_ON = 1,
53 STATE_AWAIT_IRQ_FINGER_DETECTED,
54 STATE_AWAIT_MODE_CHANGE_CAPTURE,
56 STATE_AWAIT_MODE_CHANGE_AWAIT_FINGER_OFF,
57 STATE_AWAIT_IRQ_FINGER_REMOVED,
61 static struct libusb_device_handle *devh = NULL;
62 static unsigned char imgbuf[0x1b340];
63 static unsigned char irqbuf[INTR_LENGTH];
64 static struct libusb_transfer *img_transfer = NULL;
65 static struct libusb_transfer *irq_transfer = NULL;
66 static int img_idx = 0;
67 static int do_exit = 0;
69 static pthread_t poll_thread;
70 static pthread_cond_t exit_cond = PTHREAD_COND_INITIALIZER;
71 static pthread_mutex_t exit_cond_lock = PTHREAD_MUTEX_INITIALIZER;
73 static void request_exit(int code)
76 pthread_cond_signal(&exit_cond);
79 static void *poll_thread_main(void *arg)
82 printf("poll thread running\n");
85 struct timeval tv = { 1, 0 };
86 r = libusb_handle_events_timeout(NULL, &tv);
93 printf("poll thread shutting down\n");
97 static int find_dpfp_device(void)
99 devh = libusb_open_device_with_vid_pid(NULL, 0x05ba, 0x000a);
100 return devh ? 0 : -EIO;
103 static int print_f0_data(void)
105 unsigned char data[0x10];
109 r = libusb_control_transfer(devh, CTRL_IN, USB_RQ, 0xf0, 0, data,
112 fprintf(stderr, "F0 error %d\n", r);
115 if ((unsigned int) r < sizeof(data)) {
116 fprintf(stderr, "short read (%d)\n", r);
121 for (i = 0; i < sizeof(data); i++)
122 printf("%02x ", data[i]);
127 static int get_hwstat(unsigned char *status)
131 r = libusb_control_transfer(devh, CTRL_IN, USB_RQ, 0x07, 0, status, 1, 0);
133 fprintf(stderr, "read hwstat error %d\n", r);
136 if ((unsigned int) r < 1) {
137 fprintf(stderr, "short read (%d)\n", r);
141 printf("hwstat reads %02x\n", *status);
145 static int set_hwstat(unsigned char data)
149 printf("set hwstat to %02x\n", data);
150 r = libusb_control_transfer(devh, CTRL_OUT, USB_RQ, 0x07, 0, &data, 1, 0);
152 fprintf(stderr, "set hwstat error %d\n", r);
155 if ((unsigned int) r < 1) {
156 fprintf(stderr, "short write (%d)", r);
163 static int set_mode(unsigned char data)
166 printf("set mode %02x\n", data);
168 r = libusb_control_transfer(devh, CTRL_OUT, USB_RQ, 0x4e, 0, &data, 1, 0);
170 fprintf(stderr, "set mode error %d\n", r);
173 if ((unsigned int) r < 1) {
174 fprintf(stderr, "short write (%d)", r);
181 static void LIBUSB_CALL cb_mode_changed(struct libusb_transfer *transfer)
183 if (transfer->status != LIBUSB_TRANSFER_COMPLETED) {
184 fprintf(stderr, "mode change transfer not completed!\n");
188 printf("async cb_mode_changed length=%d actual_length=%d\n",
189 transfer->length, transfer->actual_length);
190 if (next_state() < 0)
194 static int set_mode_async(unsigned char data)
196 unsigned char *buf = (unsigned char*) malloc(LIBUSB_CONTROL_SETUP_SIZE + 1);
197 struct libusb_transfer *transfer;
202 transfer = libusb_alloc_transfer(0);
208 printf("async set mode %02x\n", data);
209 libusb_fill_control_setup(buf, CTRL_OUT, USB_RQ, 0x4e, 0, 1);
210 buf[LIBUSB_CONTROL_SETUP_SIZE] = data;
211 libusb_fill_control_transfer(transfer, devh, buf, cb_mode_changed, NULL,
214 transfer->flags = LIBUSB_TRANSFER_SHORT_NOT_OK
215 | LIBUSB_TRANSFER_FREE_BUFFER | LIBUSB_TRANSFER_FREE_TRANSFER;
216 return libusb_submit_transfer(transfer);
219 static int do_sync_intr(unsigned char *data)
224 r = libusb_interrupt_transfer(devh, EP_INTR, data, INTR_LENGTH,
227 fprintf(stderr, "intr error %d\n", r);
230 if (transferred < INTR_LENGTH) {
231 fprintf(stderr, "short read (%d)\n", r);
235 printf("recv interrupt %04x\n", *((uint16_t *) data));
239 static int sync_intr(unsigned char type)
242 unsigned char data[INTR_LENGTH];
245 r = do_sync_intr(data);
253 static int save_to_file(unsigned char *data)
258 snprintf(filename, sizeof(filename), "finger%d.pgm", img_idx++);
259 fd = fopen(filename, "w");
263 fputs("P5 384 289 255 ", fd);
264 (void) fwrite(data + 64, 1, 384*289, fd);
266 printf("saved image to %s\n", filename);
270 static int next_state(void)
273 printf("old state: %d\n", state);
275 case STATE_AWAIT_IRQ_FINGER_REMOVED:
276 state = STATE_AWAIT_MODE_CHANGE_AWAIT_FINGER_ON;
277 r = set_mode_async(MODE_AWAIT_FINGER_ON);
279 case STATE_AWAIT_MODE_CHANGE_AWAIT_FINGER_ON:
280 state = STATE_AWAIT_IRQ_FINGER_DETECTED;
282 case STATE_AWAIT_IRQ_FINGER_DETECTED:
283 state = STATE_AWAIT_MODE_CHANGE_CAPTURE;
284 r = set_mode_async(MODE_CAPTURE);
286 case STATE_AWAIT_MODE_CHANGE_CAPTURE:
287 state = STATE_AWAIT_IMAGE;
289 case STATE_AWAIT_IMAGE:
290 state = STATE_AWAIT_MODE_CHANGE_AWAIT_FINGER_OFF;
291 r = set_mode_async(MODE_AWAIT_FINGER_OFF);
293 case STATE_AWAIT_MODE_CHANGE_AWAIT_FINGER_OFF:
294 state = STATE_AWAIT_IRQ_FINGER_REMOVED;
297 printf("unrecognised state %d\n", state);
300 fprintf(stderr, "error detected changing state\n");
304 printf("new state: %d\n", state);
308 static void LIBUSB_CALL cb_irq(struct libusb_transfer *transfer)
310 unsigned char irqtype = transfer->buffer[0];
312 if (transfer->status != LIBUSB_TRANSFER_COMPLETED) {
313 fprintf(stderr, "irq transfer status %d?\n", transfer->status);
319 printf("IRQ callback %02x\n", irqtype);
321 case STATE_AWAIT_IRQ_FINGER_DETECTED:
322 if (irqtype == 0x01) {
323 if (next_state() < 0) {
328 printf("finger-on-sensor detected in wrong state!\n");
331 case STATE_AWAIT_IRQ_FINGER_REMOVED:
332 if (irqtype == 0x02) {
333 if (next_state() < 0) {
338 printf("finger-on-sensor detected in wrong state!\n");
342 if (libusb_submit_transfer(irq_transfer) < 0)
346 static void LIBUSB_CALL cb_img(struct libusb_transfer *transfer)
348 if (transfer->status != LIBUSB_TRANSFER_COMPLETED) {
349 fprintf(stderr, "img transfer status %d?\n", transfer->status);
355 printf("Image callback\n");
356 save_to_file(imgbuf);
357 if (next_state() < 0) {
361 if (libusb_submit_transfer(img_transfer) < 0)
365 static int init_capture(void)
369 r = libusb_submit_transfer(irq_transfer);
373 r = libusb_submit_transfer(img_transfer);
375 libusb_cancel_transfer(irq_transfer);
377 if (libusb_handle_events(NULL) < 0)
382 /* start state machine */
383 state = STATE_AWAIT_IRQ_FINGER_REMOVED;
387 static int do_init(void)
389 unsigned char status;
392 r = get_hwstat(&status);
396 if (!(status & 0x80)) {
397 r = set_hwstat(status | 0x80);
400 r = get_hwstat(&status);
406 r = set_hwstat(status);
410 r = get_hwstat(&status);
421 static int alloc_transfers(void)
423 img_transfer = libusb_alloc_transfer(0);
427 irq_transfer = libusb_alloc_transfer(0);
431 libusb_fill_bulk_transfer(img_transfer, devh, EP_DATA, imgbuf,
432 sizeof(imgbuf), cb_img, NULL, 0);
433 libusb_fill_interrupt_transfer(irq_transfer, devh, EP_INTR, irqbuf,
434 sizeof(irqbuf), cb_irq, NULL, 0);
439 static void sighandler(int signum)
446 struct sigaction sigact;
449 r = libusb_init(NULL);
451 fprintf(stderr, "failed to initialise libusb\n");
455 r = find_dpfp_device();
457 fprintf(stderr, "Could not find/open device\n");
461 r = libusb_claim_interface(devh, 0);
463 fprintf(stderr, "usb_claim_interface error %d %s\n", r, strerror(-r));
466 printf("claimed interface\n");
476 /* async from here onwards */
478 sigact.sa_handler = sighandler;
479 sigemptyset(&sigact.sa_mask);
481 sigaction(SIGINT, &sigact, NULL);
482 sigaction(SIGTERM, &sigact, NULL);
483 sigaction(SIGQUIT, &sigact, NULL);
485 r = pthread_create(&poll_thread, NULL, poll_thread_main, NULL);
489 r = alloc_transfers();
492 pthread_join(poll_thread, NULL);
499 pthread_join(poll_thread, NULL);
504 pthread_mutex_lock(&exit_cond_lock);
505 pthread_cond_wait(&exit_cond, &exit_cond_lock);
506 pthread_mutex_unlock(&exit_cond_lock);
509 printf("shutting down...\n");
510 pthread_join(poll_thread, NULL);
512 r = libusb_cancel_transfer(irq_transfer);
518 r = libusb_cancel_transfer(img_transfer);
524 while (img_transfer || irq_transfer)
525 if (libusb_handle_events(NULL) < 0)
534 libusb_free_transfer(img_transfer);
535 libusb_free_transfer(irq_transfer);
539 libusb_release_interface(devh, 0);
543 return r >= 0 ? r : -r;