2709c6dc8c
The basic model is that image drivers declare a fp_img_driver structure rather than a fp_driver struct. fp_img_driver will contain primitive imaging operations such as 'scan finger and return image'. The imgdev layer will generically implement the primitive fp_driver operations, and the imgdev layer will fix up the enroll/verify/etc pointers at driver registration time. Removed const from all fp_driver declarations, as these are now modified dynamically in the case of imaging drivers.
372 lines
8.2 KiB
C
372 lines
8.2 KiB
C
/*
|
|
* Core functions for libfprint
|
|
* Copyright (C) 2007 Daniel Drake <dsd@gentoo.org>
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
#include <config.h>
|
|
#include <errno.h>
|
|
#include <stdio.h>
|
|
|
|
#include <glib.h>
|
|
#include <usb.h>
|
|
|
|
#include "fp_internal.h"
|
|
|
|
static GList *registered_drivers = NULL;
|
|
|
|
void fpi_log(enum fpi_log_level level, const char *component,
|
|
const char *function, const char *format, ...)
|
|
{
|
|
va_list args;
|
|
FILE *stream = stdout;
|
|
const char *prefix;
|
|
|
|
switch (level) {
|
|
case LOG_LEVEL_INFO:
|
|
prefix = "info";
|
|
break;
|
|
case LOG_LEVEL_WARNING:
|
|
stream = stderr;
|
|
prefix = "warning";
|
|
break;
|
|
case LOG_LEVEL_ERROR:
|
|
stream = stderr;
|
|
prefix = "error";
|
|
break;
|
|
case LOG_LEVEL_DEBUG:
|
|
stream = stderr;
|
|
prefix = "debug";
|
|
break;
|
|
default:
|
|
stream = stderr;
|
|
prefix = "unknown";
|
|
break;
|
|
}
|
|
|
|
fprintf(stream, "%s:%s [%s] ", component ? component : "fp", prefix,
|
|
function);
|
|
|
|
va_start (args, format);
|
|
vfprintf(stream, format, args);
|
|
va_end (args);
|
|
|
|
fprintf(stream, "\n");
|
|
}
|
|
|
|
static void register_driver(struct fp_driver *drv)
|
|
{
|
|
registered_drivers = g_list_prepend(registered_drivers, (gpointer) drv);
|
|
fp_dbg("registered driver %s", drv->name);
|
|
}
|
|
|
|
static struct fp_driver * const primitive_drivers[] = {
|
|
&upekts_driver,
|
|
};
|
|
|
|
static struct fp_img_driver * const img_drivers[] = {
|
|
&uru4000_driver,
|
|
};
|
|
|
|
static void register_drivers(void)
|
|
{
|
|
unsigned int i;
|
|
|
|
for (i = 0; i < ARRAY_SIZE(primitive_drivers); i++)
|
|
register_driver(primitive_drivers[i]);
|
|
|
|
for (i = 0; i < ARRAY_SIZE(img_drivers); i++) {
|
|
struct fp_img_driver *imgdriver = img_drivers[i];
|
|
fpi_img_driver_setup(imgdriver);
|
|
register_driver(&imgdriver->driver);
|
|
}
|
|
}
|
|
|
|
static struct fp_driver *find_supporting_driver(struct usb_device *udev)
|
|
{
|
|
GList *elem = registered_drivers;
|
|
|
|
do {
|
|
struct fp_driver *drv = elem->data;
|
|
const struct usb_id *id;
|
|
|
|
for (id = drv->id_table; id->vendor; id++)
|
|
if (udev->descriptor.idVendor == id->vendor &&
|
|
udev->descriptor.idProduct == id->product) {
|
|
fp_dbg("driver %s supports USB device %04x:%04x",
|
|
drv->name, id->vendor, id->product);
|
|
return drv;
|
|
}
|
|
} while (elem = g_list_next(elem));
|
|
return NULL;
|
|
}
|
|
|
|
API_EXPORTED struct fp_dscv_dev **fp_discover_devs(void)
|
|
{
|
|
GList *tmplist = NULL;
|
|
struct fp_dscv_dev **list;
|
|
struct usb_device *udev;
|
|
struct usb_bus *bus;
|
|
int dscv_count = 0;
|
|
|
|
if (registered_drivers == NULL)
|
|
return NULL;
|
|
|
|
usb_find_busses();
|
|
usb_find_devices();
|
|
|
|
/* Check each device against each driver, temporarily storing successfully
|
|
* discovered devices in a GList.
|
|
*
|
|
* Quite inefficient but excusable as we'll only be dealing with small
|
|
* sets of drivers against small sets of USB devices */
|
|
for (bus = usb_get_busses(); bus; bus = bus->next)
|
|
for (udev = bus->devices; udev; udev = udev->next) {
|
|
struct fp_driver *drv = find_supporting_driver(udev);
|
|
struct fp_dscv_dev *ddev;
|
|
if (!drv)
|
|
continue;
|
|
ddev = g_malloc0(sizeof(*ddev));
|
|
ddev->drv = drv;
|
|
ddev->udev = udev;
|
|
tmplist = g_list_prepend(tmplist, (gpointer) ddev);
|
|
dscv_count++;
|
|
}
|
|
|
|
/* Convert our temporary GList into a standard NULL-terminated pointer
|
|
* array. */
|
|
list = g_malloc(sizeof(*list) * (dscv_count + 1));
|
|
if (dscv_count > 0) {
|
|
GList *elem = tmplist;
|
|
int i = 0;
|
|
do {
|
|
list[i++] = elem->data;
|
|
} while (elem = g_list_next(elem));
|
|
}
|
|
list[dscv_count] = NULL; /* NULL-terminate */
|
|
|
|
g_list_free(tmplist);
|
|
return list;
|
|
}
|
|
|
|
API_EXPORTED void fp_dscv_devs_free(struct fp_dscv_dev **devs)
|
|
{
|
|
int i;
|
|
if (!devs)
|
|
return;
|
|
|
|
for (i = 0; devs[i]; i++)
|
|
g_free(devs[i]);
|
|
g_free(devs);
|
|
}
|
|
|
|
API_EXPORTED struct fp_driver *fp_dscv_dev_get_driver(struct fp_dscv_dev *dev)
|
|
{
|
|
return dev->drv;
|
|
}
|
|
|
|
API_EXPORTED struct fp_dev *fp_dev_open(struct fp_dscv_dev *ddev)
|
|
{
|
|
struct fp_dev *dev;
|
|
struct fp_driver *drv = ddev->drv;
|
|
int r;
|
|
|
|
usb_dev_handle *udevh = usb_open(ddev->udev);
|
|
if (!udevh) {
|
|
fp_err("usb_open failed");
|
|
return NULL;
|
|
}
|
|
|
|
dev = g_malloc0(sizeof(*dev));
|
|
dev->drv = drv;
|
|
dev->udev = udevh;
|
|
dev->__enroll_stage = -1;
|
|
|
|
if (drv->init) {
|
|
r = drv->init(dev);
|
|
if (r) {
|
|
fp_err("device initialisation failed, driver=%s", drv->name);
|
|
usb_close(udevh);
|
|
g_free(dev);
|
|
return NULL;
|
|
}
|
|
}
|
|
|
|
fp_dbg("");
|
|
return dev;
|
|
}
|
|
|
|
API_EXPORTED void fp_dev_close(struct fp_dev *dev)
|
|
{
|
|
fp_dbg("");
|
|
if (dev->drv->exit)
|
|
dev->drv->exit(dev);
|
|
usb_close(dev->udev);
|
|
g_free(dev);
|
|
}
|
|
|
|
API_EXPORTED struct fp_driver *fp_dev_get_driver(struct fp_dev *dev)
|
|
{
|
|
return dev->drv;
|
|
}
|
|
|
|
API_EXPORTED int fp_dev_get_nr_enroll_stages(struct fp_dev *dev)
|
|
{
|
|
return dev->nr_enroll_stages;
|
|
}
|
|
|
|
API_EXPORTED const char *fp_driver_get_name(struct fp_driver *drv)
|
|
{
|
|
return drv->name;
|
|
}
|
|
|
|
API_EXPORTED const char *fp_driver_get_full_name(struct fp_driver *drv)
|
|
{
|
|
return drv->full_name;
|
|
}
|
|
|
|
API_EXPORTED int fp_enroll_finger(struct fp_dev *dev,
|
|
struct fp_print_data **print_data)
|
|
{
|
|
struct fp_driver *drv = dev->drv;
|
|
int ret;
|
|
int stage = dev->__enroll_stage;
|
|
gboolean initial = FALSE;
|
|
|
|
if (!dev->nr_enroll_stages || !drv->enroll) {
|
|
fp_err("driver %s has 0 enroll stages or no enroll func",
|
|
drv->name);
|
|
return -ENOTSUP;
|
|
}
|
|
|
|
if (stage == -1) {
|
|
initial = TRUE;
|
|
dev->__enroll_stage = ++stage;
|
|
}
|
|
|
|
if (stage >= dev->nr_enroll_stages) {
|
|
fp_err("exceeding number of enroll stages for device claimed by "
|
|
"driver %s (%d stages)", drv->name, dev->nr_enroll_stages);
|
|
dev->__enroll_stage = -1;
|
|
return -EINVAL;
|
|
}
|
|
fp_dbg("%s will handle enroll stage %d/%d%s", drv->name, stage,
|
|
dev->nr_enroll_stages - 1, initial ? " (initial)" : "");
|
|
|
|
ret = drv->enroll(dev, initial, stage, print_data);
|
|
if (ret < 0) {
|
|
fp_err("enroll failed with code %d", ret);
|
|
dev->__enroll_stage = -1;
|
|
return ret;
|
|
}
|
|
switch (ret) {
|
|
case FP_ENROLL_PASS:
|
|
fp_dbg("enroll stage passed");
|
|
dev->__enroll_stage = stage + 1;
|
|
break;
|
|
case FP_ENROLL_COMPLETE:
|
|
fp_dbg("enroll complete");
|
|
dev->__enroll_stage = -1;
|
|
break;
|
|
case FP_ENROLL_RETRY:
|
|
fp_dbg("enroll should retry");
|
|
break;
|
|
case FP_ENROLL_RETRY_TOO_SHORT:
|
|
fp_dbg("swipe was too short, enroll should retry");
|
|
break;
|
|
case FP_ENROLL_RETRY_CENTER_FINGER:
|
|
fp_dbg("finger was not centered, enroll should retry");
|
|
break;
|
|
case FP_ENROLL_RETRY_REMOVE_FINGER:
|
|
fp_dbg("scan failed, remove finger and retry");
|
|
break;
|
|
case FP_ENROLL_FAIL:
|
|
fp_err("enroll failed");
|
|
dev->__enroll_stage = -1;
|
|
break;
|
|
default:
|
|
fp_err("unrecognised return code %d", ret);
|
|
dev->__enroll_stage = -1;
|
|
return -EINVAL;
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
API_EXPORTED int fp_verify_finger(struct fp_dev *dev,
|
|
struct fp_print_data *enrolled_print)
|
|
{
|
|
struct fp_driver *drv = dev->drv;
|
|
int r;
|
|
|
|
if (!enrolled_print) {
|
|
fp_err("no print given");
|
|
return -EINVAL;
|
|
}
|
|
|
|
if (!drv->verify) {
|
|
fp_err("driver %s has no verify func", drv->name);
|
|
return -EINVAL;
|
|
}
|
|
|
|
if (!fpi_print_data_compatible(dev, enrolled_print)) {
|
|
fp_err("print is not compatible with device");
|
|
return -EINVAL;
|
|
}
|
|
|
|
fp_dbg("to be handled by %s", drv->name);
|
|
r = drv->verify(dev, enrolled_print);
|
|
if (r < 0) {
|
|
fp_dbg("verify error %d", r);
|
|
return r;
|
|
}
|
|
|
|
switch (r) {
|
|
case FP_VERIFY_NO_MATCH:
|
|
fp_dbg("result: no match");
|
|
break;
|
|
case FP_VERIFY_MATCH:
|
|
fp_dbg("result: match");
|
|
break;
|
|
case FP_VERIFY_RETRY:
|
|
fp_dbg("verify should retry");
|
|
break;
|
|
case FP_VERIFY_RETRY_TOO_SHORT:
|
|
fp_dbg("swipe was too short, verify should retry");
|
|
break;
|
|
case FP_VERIFY_RETRY_CENTER_FINGER:
|
|
fp_dbg("finger was not centered, verify should retry");
|
|
break;
|
|
case FP_VERIFY_RETRY_REMOVE_FINGER:
|
|
fp_dbg("scan failed, remove finger and retry");
|
|
break;
|
|
default:
|
|
fp_err("unrecognised return code %d", r);
|
|
return -EINVAL;
|
|
}
|
|
|
|
return r;
|
|
}
|
|
|
|
API_EXPORTED int fp_init(void)
|
|
{
|
|
fp_dbg("");
|
|
usb_init();
|
|
register_drivers();
|
|
return 0;
|
|
}
|
|
|
|
|