From d12b29478305da18918b2cb0df98c93516cd77d9 Mon Sep 17 00:00:00 2001 From: Vasily Khoruzhick Date: Fri, 8 Feb 2013 19:04:30 +0300 Subject: [PATCH] Add upektc_img driver Imaging driver, handles UPEK 147e:2020 device --- configure.ac | 13 +- libfprint/Makefile.am | 6 + libfprint/core.c | 3 + libfprint/drivers/driver_ids.h | 1 + libfprint/drivers/upeke2.c | 5 - libfprint/drivers/upektc_img.c | 628 +++++++++++++++++++++++++++++++++ libfprint/drivers/upektc_img.h | 144 ++++++++ libfprint/fp_internal.h | 3 + 8 files changed, 797 insertions(+), 6 deletions(-) create mode 100644 libfprint/drivers/upektc_img.c create mode 100644 libfprint/drivers/upektc_img.h diff --git a/configure.ac b/configure.ac index b65a0bc..5897e34 100644 --- a/configure.ac +++ b/configure.ac @@ -23,7 +23,7 @@ AC_SUBST(lt_major) AC_SUBST(lt_revision) AC_SUBST(lt_age) -all_drivers="upeke2 upekts upektc upeksonly vcom5s uru4000 fdu2000 aes1610 aes1660 aes2501 aes2550 aes2660 aes3500 aes4000 vfs101 vfs301" +all_drivers="upeke2 upekts upektc upeksonly vcom5s uru4000 fdu2000 aes1610 aes1660 aes2501 aes2550 aes2660 aes3500 aes4000 vfs101 vfs301 upektc_img" require_imaging='no' require_aeslib='no' @@ -45,6 +45,7 @@ enable_aes3500='no' enable_aes4000='no' enable_vfs101='no' enable_vfs301='no' +enable_upektc_img='no' AC_ARG_WITH([drivers],[AS_HELP_STRING([--with-drivers], [List of drivers to enable])], @@ -135,6 +136,10 @@ for driver in `echo ${drivers} | sed -e 's/,/ /g' -e 's/,$//g'`; do AC_DEFINE([ENABLE_VFS301], [], [Build Validity VFS301/VFS300 driver]) enable_vfs301="yes" ;; + upektc_img) + AC_DEFINE([ENABLE_UPEKTC_IMG], [], [Build Upek TouchChip Fingerprint Coprocessor driver]) + enable_upektc_img="yes" + ;; esac done @@ -157,6 +162,7 @@ AM_CONDITIONAL([REQUIRE_AESX660], [test "$require_aesX660" = "yes"]) AM_CONDITIONAL([REQUIRE_AES3K], [test "$require_aes3k" = "yes"]) AM_CONDITIONAL([ENABLE_VFS101], [test "$enable_vfs101" = "yes"]) AM_CONDITIONAL([ENABLE_VFS301], [test "$enable_vfs301" = "yes"]) +AM_CONDITIONAL([ENABLE_UPEKTC_IMG], [test "$enable_upektc_img" = "yes"]) PKG_CHECK_MODULES(LIBUSB, [libusb-1.0 >= 0.9.1]) @@ -373,6 +379,11 @@ if test x$enable_vfs301 != xno ; then else AC_MSG_NOTICE([ vfs301 driver disabled]) fi +if test x$enable_upektc_img != xno ; then + AC_MSG_NOTICE([** upektc_img driver enabled]) +else + AC_MSG_NOTICE([ upektc_img driver disabled]) +fi if test x$require_aeslib != xno ; then AC_MSG_NOTICE([** aeslib helper functions enabled]) else diff --git a/libfprint/Makefile.am b/libfprint/Makefile.am index 5f46bc2..2d2c890 100644 --- a/libfprint/Makefile.am +++ b/libfprint/Makefile.am @@ -18,6 +18,7 @@ FDU2000_SRC = drivers/fdu2000.c VCOM5S_SRC = drivers/vcom5s.c VFS101_SRC = drivers/vfs101.c VFS301_SRC = drivers/vfs301.c drivers/vfs301_proto.c drivers/vfs301_proto.h drivers/vfs301_proto_fragments.h +UPEKTC_IMG_SRC = drivers/upektc_img.c drivers/upektc_img.h EXTRA_DIST = \ $(UPEKE2_SRC) \ @@ -36,6 +37,7 @@ EXTRA_DIST = \ $(VCOM5S_SRC) \ $(VFS101_SRC) \ $(VFS301_SRC) \ + $(UPEKTC_IMG_SRC) \ drivers/aesx660.c \ drivers/aesx660.h \ drivers/aes3k.c \ @@ -165,6 +167,10 @@ if ENABLE_VFS301 DRIVER_SRC += $(VFS301_SRC) endif +if ENABLE_UPEKTC_IMG +DRIVER_SRC += $(UPEKTC_IMG_SRC) +endif + if REQUIRE_IMAGEMAGICK OTHER_SRC += imagemagick.c libfprint_la_CFLAGS += $(IMAGING_CFLAGS) diff --git a/libfprint/core.c b/libfprint/core.c index f6faab2..bf46826 100644 --- a/libfprint/core.c +++ b/libfprint/core.c @@ -389,6 +389,9 @@ static struct fp_img_driver * const img_drivers[] = { #ifdef ENABLE_UPEKTC &upektc_driver, #endif +#ifdef ENABLE_UPEKTC_IMG + &upektc_img_driver, +#endif /*#ifdef ENABLE_FDU2000 &fdu2000_driver, #endif diff --git a/libfprint/drivers/driver_ids.h b/libfprint/drivers/driver_ids.h index 25ef229..fde2512 100644 --- a/libfprint/drivers/driver_ids.h +++ b/libfprint/drivers/driver_ids.h @@ -37,6 +37,7 @@ enum { AES1660_ID = 14, AES2660_ID = 15, AES3500_ID = 16, + UPEKTC_IMG_ID = 17, }; #endif diff --git a/libfprint/drivers/upeke2.c b/libfprint/drivers/upeke2.c index a7db54d..83fe93f 100644 --- a/libfprint/drivers/upeke2.c +++ b/libfprint/drivers/upeke2.c @@ -48,7 +48,6 @@ enum { UPEKE2_2016, - UPEKE2_2020, }; struct upeke2_dev { @@ -856,9 +855,6 @@ static int discover(struct libusb_device_descriptor *dsc, uint32_t *devtype) if (dsc->idProduct == 0x2016 && dsc->bcdDevice == 2) return 1; - if (dsc->idProduct == 0x2020 && dsc->bcdDevice == 1) - return 1; - return 0; } @@ -1461,7 +1457,6 @@ static int verify_stop(struct fp_dev *dev, gboolean iterating) static const struct usb_id id_table[] = { { .vendor = 0x147e, .product = 0x2016, .driver_data = UPEKE2_2016 }, - { .vendor = 0x147e, .product = 0x2020, .driver_data = UPEKE2_2020 }, { 0, 0, 0, }, /* terminating entry */ }; diff --git a/libfprint/drivers/upektc_img.c b/libfprint/drivers/upektc_img.c new file mode 100644 index 0000000..3bf6dcf --- /dev/null +++ b/libfprint/drivers/upektc_img.c @@ -0,0 +1,628 @@ +/* + * UPEK TouchChip driver for libfprint + * Copyright (C) 2013 Vasily Khoruzhick + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#define FP_COMPONENT "upekts_img" + +#include +#include + +#include + +#include +#include + +#include "upektc_img.h" +#include "driver_ids.h" + +static void start_capture(struct fp_img_dev *dev); +static void start_deactivation(struct fp_img_dev *dev); + +#define EP_IN (1 | LIBUSB_ENDPOINT_IN) +#define EP_OUT (2 | LIBUSB_ENDPOINT_OUT) +#define CTRL_TIMEOUT 4000 +#define BULK_TIMEOUT 4000 + +#define IMAGE_WIDTH 144 +#define IMAGE_HEIGHT 384 +#define IMAGE_SIZE (IMAGE_WIDTH * IMAGE_HEIGHT) + +#define MAX_CMD_SIZE 64 +#define MAX_RESPONSE_SIZE 2052 +#define SHORT_RESPONSE_SIZE 64 + +struct upekts_img_dev { + unsigned char cmd[MAX_CMD_SIZE]; + unsigned char image_bits[IMAGE_SIZE * 2]; + unsigned char seq; + size_t image_size; + gboolean deactivating; +}; + +/****** HELPERS ******/ + +static const uint16_t crc_table[256] = { + 0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7, + 0x8108, 0x9129, 0xa14a, 0xb16b, 0xc18c, 0xd1ad, 0xe1ce, 0xf1ef, + 0x1231, 0x0210, 0x3273, 0x2252, 0x52b5, 0x4294, 0x72f7, 0x62d6, + 0x9339, 0x8318, 0xb37b, 0xa35a, 0xd3bd, 0xc39c, 0xf3ff, 0xe3de, + 0x2462, 0x3443, 0x0420, 0x1401, 0x64e6, 0x74c7, 0x44a4, 0x5485, + 0xa56a, 0xb54b, 0x8528, 0x9509, 0xe5ee, 0xf5cf, 0xc5ac, 0xd58d, + 0x3653, 0x2672, 0x1611, 0x0630, 0x76d7, 0x66f6, 0x5695, 0x46b4, + 0xb75b, 0xa77a, 0x9719, 0x8738, 0xf7df, 0xe7fe, 0xd79d, 0xc7bc, + 0x48c4, 0x58e5, 0x6886, 0x78a7, 0x0840, 0x1861, 0x2802, 0x3823, + 0xc9cc, 0xd9ed, 0xe98e, 0xf9af, 0x8948, 0x9969, 0xa90a, 0xb92b, + 0x5af5, 0x4ad4, 0x7ab7, 0x6a96, 0x1a71, 0x0a50, 0x3a33, 0x2a12, + 0xdbfd, 0xcbdc, 0xfbbf, 0xeb9e, 0x9b79, 0x8b58, 0xbb3b, 0xab1a, + 0x6ca6, 0x7c87, 0x4ce4, 0x5cc5, 0x2c22, 0x3c03, 0x0c60, 0x1c41, + 0xedae, 0xfd8f, 0xcdec, 0xddcd, 0xad2a, 0xbd0b, 0x8d68, 0x9d49, + 0x7e97, 0x6eb6, 0x5ed5, 0x4ef4, 0x3e13, 0x2e32, 0x1e51, 0x0e70, + 0xff9f, 0xefbe, 0xdfdd, 0xcffc, 0xbf1b, 0xaf3a, 0x9f59, 0x8f78, + 0x9188, 0x81a9, 0xb1ca, 0xa1eb, 0xd10c, 0xc12d, 0xf14e, 0xe16f, + 0x1080, 0x00a1, 0x30c2, 0x20e3, 0x5004, 0x4025, 0x7046, 0x6067, + 0x83b9, 0x9398, 0xa3fb, 0xb3da, 0xc33d, 0xd31c, 0xe37f, 0xf35e, + 0x02b1, 0x1290, 0x22f3, 0x32d2, 0x4235, 0x5214, 0x6277, 0x7256, + 0xb5ea, 0xa5cb, 0x95a8, 0x8589, 0xf56e, 0xe54f, 0xd52c, 0xc50d, + 0x34e2, 0x24c3, 0x14a0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405, + 0xa7db, 0xb7fa, 0x8799, 0x97b8, 0xe75f, 0xf77e, 0xc71d, 0xd73c, + 0x26d3, 0x36f2, 0x0691, 0x16b0, 0x6657, 0x7676, 0x4615, 0x5634, + 0xd94c, 0xc96d, 0xf90e, 0xe92f, 0x99c8, 0x89e9, 0xb98a, 0xa9ab, + 0x5844, 0x4865, 0x7806, 0x6827, 0x18c0, 0x08e1, 0x3882, 0x28a3, + 0xcb7d, 0xdb5c, 0xeb3f, 0xfb1e, 0x8bf9, 0x9bd8, 0xabbb, 0xbb9a, + 0x4a75, 0x5a54, 0x6a37, 0x7a16, 0x0af1, 0x1ad0, 0x2ab3, 0x3a92, + 0xfd2e, 0xed0f, 0xdd6c, 0xcd4d, 0xbdaa, 0xad8b, 0x9de8, 0x8dc9, + 0x7c26, 0x6c07, 0x5c64, 0x4c45, 0x3ca2, 0x2c83, 0x1ce0, 0x0cc1, + 0xef1f, 0xff3e, 0xcf5d, 0xdf7c, 0xaf9b, 0xbfba, 0x8fd9, 0x9ff8, + 0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0x0ed1, 0x1ef0 +}; + +static uint16_t udf_crc(unsigned char *buffer, size_t size) +{ + uint16_t crc = 0; + while (size--) + crc = (uint16_t) ((crc << 8) ^ + crc_table[((crc >> 8) & 0x00ff) ^ *buffer++]); + return crc; +} + +static void upektc_img_cmd_fix_seq(unsigned char *cmd_buf, unsigned char seq) +{ + uint8_t byte; + + byte = cmd_buf[5]; + byte &= 0x0f; + byte |= (seq << 4); + cmd_buf[5] = byte; +} + +static void upektc_img_cmd_update_crc(unsigned char *cmd_buf, size_t size) +{ + /* CRC does not cover Ciao prefix (4 bytes) and CRC location (2 bytes) */ + uint16_t crc = udf_crc(cmd_buf + 4, size - 6); + + cmd_buf[size - 2] = (crc & 0x00ff); + cmd_buf[size - 1] = (crc & 0xff00) >> 8; +} + +static void upektc_img_submit_req(struct fpi_ssm *ssm, + const unsigned char *buf, size_t buf_size, unsigned char seq, + libusb_transfer_cb_fn cb) +{ + struct fp_img_dev *dev = ssm->priv; + struct upekts_img_dev *upekdev = dev->priv; + struct libusb_transfer *transfer = libusb_alloc_transfer(0); + int r; + + BUG_ON(buf_size > MAX_CMD_SIZE); + + if (!transfer) { + fpi_ssm_mark_aborted(ssm, -ENOMEM); + return; + } + + transfer->flags |= LIBUSB_TRANSFER_FREE_TRANSFER; + + memcpy(upekdev->cmd, buf, buf_size); + upektc_img_cmd_fix_seq(upekdev->cmd, seq); + upektc_img_cmd_update_crc(upekdev->cmd, buf_size); + + libusb_fill_bulk_transfer(transfer, dev->udev, EP_OUT, upekdev->cmd, buf_size, + cb, ssm, BULK_TIMEOUT); + + r = libusb_submit_transfer(transfer); + if (r < 0) { + libusb_free_transfer(transfer); + fpi_ssm_mark_aborted(ssm, r); + } +} + +static void upektc_img_read_data(struct fpi_ssm *ssm, size_t buf_size, libusb_transfer_cb_fn cb) +{ + struct libusb_transfer *transfer = libusb_alloc_transfer(0); + struct fp_img_dev *dev = ssm->priv; + int r; + unsigned char *data; + + if (!transfer) { + fpi_ssm_mark_aborted(ssm, -ENOMEM); + return; + } + + transfer->flags |= LIBUSB_TRANSFER_FREE_BUFFER | + LIBUSB_TRANSFER_FREE_TRANSFER; + + data = g_malloc(buf_size); + libusb_fill_bulk_transfer(transfer, dev->udev, EP_IN, data, buf_size, + cb, ssm, BULK_TIMEOUT); + + r = libusb_submit_transfer(transfer); + if (r < 0) { + g_free(data); + libusb_free_transfer(transfer); + fpi_ssm_mark_aborted(ssm, r); + } +} + +/****** CAPTURE ******/ + +enum capture_states { + CAPTURE_INIT_CAPTURE, + CAPTURE_READ_DATA, + CAPTURE_ACK_00_28, + CAPTURE_ACK_08, + CAPTURE_ACK_FRAME, + CAPTURE_NUM_STATES, +}; + +static void capture_reqs_cb(struct libusb_transfer *transfer) +{ + struct fpi_ssm *ssm = transfer->user_data; + + if ((transfer->status == LIBUSB_TRANSFER_COMPLETED) && + (transfer->length == transfer->actual_length)) { + fpi_ssm_jump_to_state(ssm, CAPTURE_READ_DATA); + } else { + fpi_ssm_mark_aborted(ssm, -EIO); + } +} + +static int upektc_img_process_image_frame(unsigned char *image_buf, unsigned char *cmd_res) +{ + int offset = 8; + int len = ((cmd_res[5] & 0x0f) << 8) | (cmd_res[6]); + + len -= 1; + if (cmd_res[7] == 0x2c) { + len -= 10; + offset += 10; + } + if (cmd_res[7] == 0x20) { + len -= 4; + } + memcpy(image_buf, cmd_res + offset, len); + + return len; +} + +static void capture_read_data_cb(struct libusb_transfer *transfer) +{ + struct fpi_ssm *ssm = transfer->user_data; + struct fp_img_dev *dev = ssm->priv; + struct upekts_img_dev *upekdev = dev->priv; + unsigned char *data = transfer->buffer; + struct fp_img *img; + + if (transfer->status != LIBUSB_TRANSFER_COMPLETED) { + fp_dbg("request is not completed, %d", transfer->status); + fpi_ssm_mark_aborted(ssm, -EIO); + return; + } + + fp_dbg("request completed, len: %.4x", transfer->actual_length); + if (transfer->actual_length == 0) { + fpi_ssm_jump_to_state(ssm, CAPTURE_READ_DATA); + return; + } + + if (upekdev->deactivating) { + fp_dbg("Deactivate requested\n"); + fpi_ssm_mark_completed(ssm); + return; + } + + switch (data[4]) { + case 0x00: + switch (data[7]) { + /* No finger */ + case 0x28: + fpi_ssm_jump_to_state(ssm, CAPTURE_ACK_00_28); + break; + /* Image frame with additional info */ + case 0x2c: + fpi_imgdev_report_finger_status(dev, TRUE); + /* Plain image frame */ + case 0x24: + upekdev->image_size += + upektc_img_process_image_frame(upekdev->image_bits + upekdev->image_size, + data); + fpi_ssm_jump_to_state(ssm, CAPTURE_ACK_FRAME); + break; + /* Last image frame */ + case 0x20: + upekdev->image_size += + upektc_img_process_image_frame(upekdev->image_bits + upekdev->image_size, + data); + BUG_ON(upekdev->image_size != IMAGE_SIZE); + fp_dbg("Image size is %d\n", upekdev->image_size); + img = fpi_img_new(IMAGE_SIZE); + memcpy(img->data, upekdev->image_bits, IMAGE_SIZE); + fpi_imgdev_image_captured(dev, img); + fpi_imgdev_report_finger_status(dev, FALSE); + fpi_ssm_mark_completed(ssm); + break; + default: + fp_err("Uknown response!\n"); + fpi_ssm_mark_aborted(ssm, -EINVAL); + break; + } + break; + case 0x08: + fpi_ssm_jump_to_state(ssm, CAPTURE_ACK_08); + break; + } +} + +static void capture_run_state(struct fpi_ssm *ssm) +{ + struct fp_img_dev *dev = ssm->priv; + struct upekts_img_dev *upekdev = dev->priv; + + switch (ssm->cur_state) { + case CAPTURE_INIT_CAPTURE: + upektc_img_submit_req(ssm, upek2020_init_capture, sizeof(upek2020_init_capture), + upekdev->seq, capture_reqs_cb); + upekdev->seq++; + break; + case CAPTURE_READ_DATA: + upektc_img_read_data(ssm, MAX_RESPONSE_SIZE, capture_read_data_cb); + break; + case CAPTURE_ACK_00_28: + upektc_img_submit_req(ssm, upek2020_ack_00_28, sizeof(upek2020_ack_00_28), + upekdev->seq, capture_reqs_cb); + upekdev->seq++; + break; + case CAPTURE_ACK_08: + upektc_img_submit_req(ssm, upek2020_ack_08, sizeof(upek2020_ack_08), + 0, capture_reqs_cb); + break; + case CAPTURE_ACK_FRAME: + upektc_img_submit_req(ssm, upek2020_ack_frame, sizeof(upek2020_ack_frame), + upekdev->seq, capture_reqs_cb); + upekdev->seq++; + break; + }; +} + +static void capture_sm_complete(struct fpi_ssm *ssm) +{ + struct fp_img_dev *dev = ssm->priv; + struct upekts_img_dev *upekdev = dev->priv; + int err = ssm->error; + + fp_dbg("Capture completed, %d", err); + fpi_ssm_free(ssm); + + if (upekdev->deactivating) + start_deactivation(dev); + else if (err) + fpi_imgdev_session_error(dev, err); + else + start_capture(dev); +} + +static void start_capture(struct fp_img_dev *dev) +{ + struct upekts_img_dev *upekdev = dev->priv; + struct fpi_ssm *ssm; + + upekdev->image_size = 0; + + ssm = fpi_ssm_new(dev->dev, capture_run_state, CAPTURE_NUM_STATES); + ssm->priv = dev; + fpi_ssm_start(ssm, capture_sm_complete); +} + +/****** INITIALIZATION/DEINITIALIZATION ******/ + +enum deactivate_states { + DEACTIVATE_DEINIT, + DEACTIVATE_READ_DEINIT_DATA, + DEACTIVATE_NUM_STATES, +}; + +static void deactivate_reqs_cb(struct libusb_transfer *transfer) +{ + struct fpi_ssm *ssm = transfer->user_data; + + if ((transfer->status == LIBUSB_TRANSFER_COMPLETED) && + (transfer->length == transfer->actual_length)) { + fpi_ssm_jump_to_state(ssm, CAPTURE_READ_DATA); + } else { + fpi_ssm_mark_aborted(ssm, -EIO); + } +} + +/* TODO: process response properly */ +static void deactivate_read_data_cb(struct libusb_transfer *transfer) +{ + struct fpi_ssm *ssm = transfer->user_data; + + if (transfer->status == LIBUSB_TRANSFER_COMPLETED) { + fpi_ssm_mark_completed(ssm); + } else { + fpi_ssm_mark_aborted(ssm, -EIO); + } +} + +static void deactivate_run_state(struct fpi_ssm *ssm) +{ + struct fp_img_dev *dev = ssm->priv; + struct upekts_img_dev *upekdev = dev->priv; + + switch (ssm->cur_state) { + case DEACTIVATE_DEINIT: + upektc_img_submit_req(ssm, upek2020_deinit, sizeof(upek2020_deinit), + upekdev->seq, deactivate_reqs_cb); + upekdev->seq++; + break; + case DEACTIVATE_READ_DEINIT_DATA: + upektc_img_read_data(ssm, MAX_RESPONSE_SIZE, deactivate_read_data_cb); + break; + }; +} + +static void deactivate_sm_complete(struct fpi_ssm *ssm) +{ + struct fp_img_dev *dev = ssm->priv; + struct upekts_img_dev *upekdev = dev->priv; + int err = ssm->error; + + fp_dbg("Deactivate completed"); + fpi_ssm_free(ssm); + + if (err) { + fpi_imgdev_session_error(dev, err); + return; + } + + upekdev->deactivating = FALSE; + fpi_imgdev_deactivate_complete(dev); +} + +static void start_deactivation(struct fp_img_dev *dev) +{ + struct upekts_img_dev *upekdev = dev->priv; + struct fpi_ssm *ssm; + + upekdev->image_size = 0; + + ssm = fpi_ssm_new(dev->dev, deactivate_run_state, DEACTIVATE_NUM_STATES); + ssm->priv = dev; + fpi_ssm_start(ssm, deactivate_sm_complete); +} + +enum activate_states { + ACTIVATE_CONTROL_REQ_1, + ACTIVATE_READ_CTRL_RESP_1, + ACTIVATE_INIT_1, + ACTIVATE_READ_INIT_1_RESP, + ACTIVATE_INIT_2, + ACTIVATE_READ_INIT_2_RESP, + ACTIVATE_CONTROL_REQ_2, + ACTIVATE_READ_CTRL_RESP_2, + ACTIVATE_INIT_3, + ACTIVATE_READ_INIT_3_RESP, + ACTIVATE_INIT_4, + ACTIVATE_READ_INIT_4_RESP, + ACTIVATE_NUM_STATES, +}; + +static void init_reqs_ctrl_cb(struct libusb_transfer *transfer) +{ + struct fpi_ssm *ssm = transfer->user_data; + + if (transfer->status == LIBUSB_TRANSFER_COMPLETED) { + fpi_ssm_next_state(ssm); + } else { + fpi_ssm_mark_aborted(ssm, -EIO); + } +} + +static void init_reqs_cb(struct libusb_transfer *transfer) +{ + struct fpi_ssm *ssm = transfer->user_data; + + if ((transfer->status == LIBUSB_TRANSFER_COMPLETED) && + (transfer->length == transfer->actual_length)) { + fpi_ssm_next_state(ssm); + } else { + fpi_ssm_mark_aborted(ssm, -EIO); + } +} + +/* TODO: process response properly */ +static void init_read_data_cb(struct libusb_transfer *transfer) +{ + struct fpi_ssm *ssm = transfer->user_data; + + if (transfer->status == LIBUSB_TRANSFER_COMPLETED) { + fpi_ssm_next_state(ssm); + } else { + fpi_ssm_mark_aborted(ssm, -EIO); + } +} + +static void activate_run_state(struct fpi_ssm *ssm) +{ + struct libusb_transfer *transfer; + struct fp_img_dev *dev = ssm->priv; + struct upekts_img_dev *upekdev = dev->priv; + int r; + + switch (ssm->cur_state) { + case ACTIVATE_CONTROL_REQ_1: + case ACTIVATE_CONTROL_REQ_2: + { + unsigned char *data; + + transfer = libusb_alloc_transfer(0); + if (!transfer) { + fpi_ssm_mark_aborted(ssm, -ENOMEM); + break; + } + transfer->flags |= LIBUSB_TRANSFER_FREE_BUFFER | + LIBUSB_TRANSFER_FREE_TRANSFER; + + data = g_malloc0(LIBUSB_CONTROL_SETUP_SIZE + 1); + libusb_fill_control_setup(data, + LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE, 0x0c, 0x100, 0x0400, 1); + libusb_fill_control_transfer(transfer, ssm->dev->udev, data, + init_reqs_ctrl_cb, ssm, CTRL_TIMEOUT); + r = libusb_submit_transfer(transfer); + if (r < 0) { + g_free(data); + libusb_free_transfer(transfer); + fpi_ssm_mark_aborted(ssm, r); + } + } + break; + case ACTIVATE_INIT_1: + upektc_img_submit_req(ssm, upek2020_init_1, sizeof(upek2020_init_1), + 0, init_reqs_cb); + break; + case ACTIVATE_INIT_2: + upektc_img_submit_req(ssm, upek2020_init_2, sizeof(upek2020_init_2), + 0, init_reqs_cb); + break; + case ACTIVATE_INIT_3: + upektc_img_submit_req(ssm, upek2020_init_3, sizeof(upek2020_init_3), + 0, init_reqs_cb); + break; + case ACTIVATE_INIT_4: + upektc_img_submit_req(ssm, upek2020_init_4, sizeof(upek2020_init_4), + upekdev->seq, init_reqs_cb); + /* Seq should be updated after 4th init */ + upekdev->seq++; + break; + case ACTIVATE_READ_CTRL_RESP_1: + case ACTIVATE_READ_CTRL_RESP_2: + case ACTIVATE_READ_INIT_1_RESP: + case ACTIVATE_READ_INIT_2_RESP: + case ACTIVATE_READ_INIT_3_RESP: + case ACTIVATE_READ_INIT_4_RESP: + upektc_img_read_data(ssm, SHORT_RESPONSE_SIZE, init_read_data_cb); + break; + } +} + +static void activate_sm_complete(struct fpi_ssm *ssm) +{ + struct fp_img_dev *dev = ssm->priv; + int err = ssm->error; + + fpi_ssm_free(ssm); + fp_dbg("%s status %d", __func__, err); + fpi_imgdev_activate_complete(dev, err); + + if (!err) + start_capture(dev); +} + +static int dev_activate(struct fp_img_dev *dev, enum fp_imgdev_state state) +{ + struct upekts_img_dev *upekdev = dev->priv; + struct fpi_ssm *ssm = fpi_ssm_new(dev->dev, activate_run_state, + ACTIVATE_NUM_STATES); + ssm->priv = dev; + upekdev->seq = 0; + fpi_ssm_start(ssm, activate_sm_complete); + return 0; +} + +static void dev_deactivate(struct fp_img_dev *dev) +{ + struct upekts_img_dev *upekdev = dev->priv; + + upekdev->deactivating = TRUE; +} + +static int dev_init(struct fp_img_dev *dev, unsigned long driver_data) +{ + /* TODO check that device has endpoints we're using */ + int r; + + r = libusb_claim_interface(dev->udev, 0); + if (r < 0) { + fp_err("could not claim interface 0"); + return r; + } + + dev->priv = g_malloc0(sizeof(struct upekts_img_dev)); + fpi_imgdev_open_complete(dev, 0); + return 0; +} + +static void dev_deinit(struct fp_img_dev *dev) +{ + g_free(dev->priv); + libusb_release_interface(dev->udev, 0); + fpi_imgdev_close_complete(dev); +} + +static int discover(struct libusb_device_descriptor *dsc, uint32_t *devtype) +{ + if (dsc->idProduct == 0x2020 && dsc->bcdDevice == 1) + return 1; + + return 0; +} + +static const struct usb_id id_table[] = { + { .vendor = 0x147e, .product = 0x2020 }, + { 0, 0, 0, }, +}; + +struct fp_img_driver upektc_img_driver = { + .driver = { + .id = UPEKTC_IMG_ID, + .name = FP_COMPONENT, + .full_name = "Upek TouchChip Fingerprint Coprocessor", + .id_table = id_table, + .scan_type = FP_SCAN_TYPE_SWIPE, + .discover = discover, + }, + .flags = 0, + .img_height = IMAGE_HEIGHT, + .img_width = IMAGE_WIDTH, + .bz3_threshold = 70, + + .open = dev_init, + .close = dev_deinit, + .activate = dev_activate, + .deactivate = dev_deactivate, +}; diff --git a/libfprint/drivers/upektc_img.h b/libfprint/drivers/upektc_img.h new file mode 100644 index 0000000..6146557 --- /dev/null +++ b/libfprint/drivers/upektc_img.h @@ -0,0 +1,144 @@ +/* + * Upek TouchChip Fingerprint Coprocessor definitions + * Copyright (c) 2013 Vasily Khoruzhick + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef __UPEKTC_IMG_H +#define __UPEKTC_IMG_H + +static const unsigned char upek2020_init_1[] = { +'C', 'i', 'a', 'o', +0x04, +0x00, 0x0d, +0x01, 0x00, 0x46, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, +0x01, 0x00, 0x00, 0x00, +0xda, 0xc1 +}; + +static const unsigned char upek2020_init_2[] = { +0x43, 0x69, 0x61, 0x6f, +0x07, +0x00, 0x01, +0x01, +0x3d, 0x72 +}; + +static const unsigned char upek2020_init_3[] = { +'C', 'i', 'a', 'o', +0x04, +0x00, 0x0d, +0x01, 0x00, 0xbc, 0x02, 0x00, 0x00, 0x00, 0x00, 0x01, +0x01, 0x00, 0x00, 0x00, +0x55, 0x2f +}; + +static const unsigned char upek2020_init_4[] = { +'C', 'i', 'a', 'o', +0x00, +0x00, 0x07, +0x28, 0x04, 0x00, 0x00, 0x00, 0x06, 0x04, +0xc0, 0xd6 +}; + +static const unsigned char upek2020_deinit[] = { +'C', 'i', 'a', 'o', +0x07, +0x00, 0x01, +0x01, +0x3d, +0x72 +}; + +static const unsigned char upek2020_init_capture[] = { +'C', 'i', 'a', 'o', +0x00, +0x00, 0x0e, /* Seq = 7, len = 0x00e */ +0x28, /* CMD = 0x28 */ +0x0b, 0x00, /* Inner len = 0x000b */ +0x00, 0x00, +0x0e, /* SUBCMD = 0x0e */ +0x02, +0xfe, 0xff, 0xff, 0xff, /* timeout = -2 = 0xfffffffe = infinite time */ +0x02, +0x00, /* Wait for acceptable finger */ +0x02, +0x14, 0x9a /* CRC */ +}; + +#if 0 +static const unsigned char finger_status[] = { +'C', 'i', 'a', 'o', +0x00, +0x70, 0x14, /* Seq = 7, len = 0x014 */ +0x28, /* CMD = 0x28 */ +0x11, 0x00, /* Inner len = 0x0011 */ +0x00, 0x00, 0x00, 0x20, 0x01, 0x00, 0x00, 0x00, +0x0c, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, +0x00, +0x26, 0x03, /* CRC */ +0x00, 0x00, 0x00, /* Rest is garbage */ +0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, +0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, +0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, +0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 +}; +#endif + +static const unsigned char upek2020_ack_00_28[] = { +'C', 'i', 'a', 'o', +0x00, +0x80, 0x08, /* Seq = 8, len = 0x008 */ +0x28, /* CMD = 0x28 */ +0x05, 0x00, /* Inner len = 0x0005 */ +0x00, 0x00, 0x00, 0x30, 0x01, +0x6a, 0xc4 /* CRC */ +}; + +#if 0 +/* No seq should be tracked here */ +static const unsigned char got_finger[] = { +'C', 'i', 'a', 'o', +0x08, +0x00, 0x00, /* Seq = 0, len = 0x000 */ +0xa1, 0xa9, /* CRC */ +0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* Rest is garbage */ +0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, +0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, +0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, +0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, +0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, +0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 +}; +#endif + +/* No seq should be put in there */ +static const unsigned char upek2020_ack_08[] = { +'C', 'i', 'a', 'o', +0x09, +0x00, 0x00, /* Seq = 0, len = 0x0 */ +0x91, 0x9e /* CRC */ +}; + +static const unsigned char upek2020_ack_frame[] = { +'C', 'i', 'a', 'o', +0x00, +0x50, 0x01, /* Seq = 5, len = 0x001 */ +0x30, +0xac, 0x5b /* CRC */ +}; + +#endif diff --git a/libfprint/fp_internal.h b/libfprint/fp_internal.h index c383c66..42d38f1 100644 --- a/libfprint/fp_internal.h +++ b/libfprint/fp_internal.h @@ -294,6 +294,9 @@ extern struct fp_img_driver vfs101_driver; #ifdef ENABLE_VFS301 extern struct fp_img_driver vfs301_driver; #endif +#ifdef ENABLE_UPEKTC_IMG +extern struct fp_img_driver upektc_img_driver; +#endif extern libusb_context *fpi_usb_ctx; extern GSList *opened_devices;