mirror of
https://github.com/morgan9e/libfprint-fpc1020
synced 2026-04-14 00:14:16 +09:00
141 lines
4.2 KiB
C
141 lines
4.2 KiB
C
/*
|
|
* Driver API definitions
|
|
* Copyright (C) 2007-2008 Daniel Drake <dsd@gentoo.org>
|
|
* Copyright (C) 2018 Bastien Nocera <hadess@hadess.net>
|
|
*
|
|
* 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 __DRIVERS_API_H__
|
|
#define __DRIVERS_API_H__
|
|
|
|
#include <config.h>
|
|
#include <stdint.h>
|
|
#include <errno.h>
|
|
#include <string.h>
|
|
#include <stdlib.h>
|
|
#include <glib.h>
|
|
|
|
#include "fprint.h"
|
|
#include "fpi-log.h"
|
|
#include "fpi-core.h"
|
|
#include "fpi-ssm.h"
|
|
#include "fpi-poll.h"
|
|
#include "fpi-dev.h"
|
|
#include "fpi-usb.h"
|
|
#include "fpi-data.h"
|
|
#include "fpi-img.h"
|
|
#include "fpi-assembling.h"
|
|
#include "drivers/driver_ids.h"
|
|
|
|
enum fp_imgdev_state {
|
|
IMGDEV_STATE_INACTIVE,
|
|
IMGDEV_STATE_AWAIT_FINGER_ON,
|
|
IMGDEV_STATE_CAPTURE,
|
|
IMGDEV_STATE_AWAIT_FINGER_OFF,
|
|
};
|
|
|
|
enum fp_imgdev_action {
|
|
IMG_ACTION_NONE = 0,
|
|
IMG_ACTION_ENROLL,
|
|
IMG_ACTION_VERIFY,
|
|
IMG_ACTION_IDENTIFY,
|
|
IMG_ACTION_CAPTURE,
|
|
};
|
|
|
|
enum fp_imgdev_enroll_state {
|
|
IMG_ACQUIRE_STATE_NONE = 0,
|
|
IMG_ACQUIRE_STATE_ACTIVATING,
|
|
IMG_ACQUIRE_STATE_AWAIT_FINGER_ON,
|
|
IMG_ACQUIRE_STATE_AWAIT_IMAGE,
|
|
IMG_ACQUIRE_STATE_AWAIT_FINGER_OFF,
|
|
IMG_ACQUIRE_STATE_DONE,
|
|
IMG_ACQUIRE_STATE_DEACTIVATING,
|
|
};
|
|
|
|
enum fp_imgdev_enroll_state fpi_imgdev_get_action_state(struct fp_img_dev *imgdev);
|
|
enum fp_imgdev_action fpi_imgdev_get_action(struct fp_img_dev *imgdev);
|
|
int fpi_imgdev_get_action_result(struct fp_img_dev *imgdev);
|
|
void fpi_imgdev_set_action_result(struct fp_img_dev *imgdev, int action_result);
|
|
int fpi_imgdev_get_img_width(struct fp_img_dev *imgdev);
|
|
int fpi_imgdev_get_img_height(struct fp_img_dev *imgdev);
|
|
|
|
struct usb_id {
|
|
uint16_t vendor;
|
|
uint16_t product;
|
|
unsigned long driver_data;
|
|
};
|
|
|
|
enum fp_driver_type {
|
|
DRIVER_PRIMITIVE = 0,
|
|
DRIVER_IMAGING = 1,
|
|
};
|
|
|
|
struct fp_driver {
|
|
const uint16_t id;
|
|
const char *name;
|
|
const char *full_name;
|
|
const struct usb_id * const id_table;
|
|
enum fp_driver_type type;
|
|
enum fp_scan_type scan_type;
|
|
|
|
/* Device operations */
|
|
int (*discover)(struct libusb_device_descriptor *dsc, uint32_t *devtype);
|
|
int (*open)(struct fp_dev *dev, unsigned long driver_data);
|
|
void (*close)(struct fp_dev *dev);
|
|
int (*enroll_start)(struct fp_dev *dev);
|
|
int (*enroll_stop)(struct fp_dev *dev);
|
|
int (*verify_start)(struct fp_dev *dev);
|
|
int (*verify_stop)(struct fp_dev *dev, gboolean iterating);
|
|
int (*identify_start)(struct fp_dev *dev);
|
|
int (*identify_stop)(struct fp_dev *dev, gboolean iterating);
|
|
int (*capture_start)(struct fp_dev *dev);
|
|
int (*capture_stop)(struct fp_dev *dev);
|
|
};
|
|
|
|
/* flags for fp_img_driver.flags */
|
|
#define FP_IMGDRV_SUPPORTS_UNCONDITIONAL_CAPTURE (1 << 0)
|
|
|
|
struct fp_img_driver {
|
|
struct fp_driver driver;
|
|
uint16_t flags;
|
|
int img_width;
|
|
int img_height;
|
|
int bz3_threshold;
|
|
|
|
/* Device operations */
|
|
int (*open)(struct fp_img_dev *dev, unsigned long driver_data);
|
|
void (*close)(struct fp_img_dev *dev);
|
|
int (*activate)(struct fp_img_dev *dev, enum fp_imgdev_state state);
|
|
int (*change_state)(struct fp_img_dev *dev, enum fp_imgdev_state state);
|
|
void (*deactivate)(struct fp_img_dev *dev);
|
|
};
|
|
|
|
struct fp_minutiae;
|
|
|
|
/* for image drivers */
|
|
void fpi_imgdev_open_complete(struct fp_img_dev *imgdev, int status);
|
|
void fpi_imgdev_close_complete(struct fp_img_dev *imgdev);
|
|
void fpi_imgdev_activate_complete(struct fp_img_dev *imgdev, int status);
|
|
void fpi_imgdev_deactivate_complete(struct fp_img_dev *imgdev);
|
|
void fpi_imgdev_report_finger_status(struct fp_img_dev *imgdev,
|
|
gboolean present);
|
|
void fpi_imgdev_image_captured(struct fp_img_dev *imgdev, struct fp_img *img);
|
|
void fpi_imgdev_abort_scan(struct fp_img_dev *imgdev, int result);
|
|
void fpi_imgdev_session_error(struct fp_img_dev *imgdev, int error);
|
|
|
|
#endif
|
|
|