ThinkFinger - A fingerprint scanner driver for SGS

Typedefs
typedef unsigned int	u32
typedef unsigned short	u16
typedef unsigned char	u8
typedef struct libthinkfinger_s	libthinkfinger
typedef void(*	libthinkfinger_state_cb )(libthinkfinger_state state, void *data)
	callback function which the driver invokes to report a new state of the scanner
Enumerations
enum	libthinkfinger_init_status {   TF_INIT_SUCCESS = 0x00, TF_INIT_NO_MEMORY = 0x01, TF_INIT_USB_INIT_SUCCESS = 0x02, TF_INIT_USB_DEVICE_NOT_FOUND = 0x03,   TF_INIT_USB_OPEN_FAILED = 0x04, TF_INIT_USB_CLAIM_FAILED = 0x05, TF_INIT_USB_HELLO_FAILED = 0x06, TF_INIT_UNDEFINED = 0xff }
enum	libthinkfinger_task {   TF_TASK_IDLE = 0x00, TF_TASK_INIT = 0x01, TF_TASK_ACQUIRE = 0x02, TF_TASK_VERIFY = 0x03,   TF_TASK_UNDEFINED = 0xff }
enum	libthinkfinger_state {   TF_STATE_INITIAL = 0x00, TF_STATE_UNCHANGED = 0x01, TF_STATE_SWIPE_0 = 0x02, TF_STATE_SWIPE_1 = 0x03,   TF_STATE_SWIPE_2 = 0x04, TF_STATE_SWIPE_SUCCESS = 0x05, TF_STATE_SWIPE_FAILED = 0x06, TF_STATE_ENROLL_SUCCESS = 0x07,   TF_STATE_ACQUIRE_SUCCESS = 0x08, TF_STATE_ACQUIRE_FAILED = 0x09, TF_STATE_VERIFY_SUCCESS = 0x0a, TF_STATE_VERIFY_FAILED = 0x0b,   TF_STATE_OPEN_FAILED = 0xfb, TF_STATE_SIGINT = 0xfc, TF_STATE_USB_ERROR = 0xfd, TF_STATE_COMM_FAILED = 0xfe,   TF_STATE_UNDEFINED = 0xff }
enum	libthinkfinger_result {   TF_RESULT_ACQUIRE_SUCCESS = TF_STATE_ACQUIRE_SUCCESS, TF_RESULT_ACQUIRE_FAILED = TF_STATE_ACQUIRE_FAILED, TF_RESULT_VERIFY_SUCCESS = TF_STATE_VERIFY_SUCCESS, TF_RESULT_VERIFY_FAILED = TF_STATE_VERIFY_FAILED,   TF_RESULT_OPEN_FAILED = TF_STATE_OPEN_FAILED, TF_RESULT_SIGINT = TF_STATE_SIGINT, TF_RESULT_USB_ERROR = TF_STATE_USB_ERROR, TF_RESULT_COMM_FAILED = TF_STATE_COMM_FAILED,   TF_RESULT_UNDEFINED = TF_STATE_UNDEFINED }
Functions
int	libthinkfinger_set_file (libthinkfinger *tf, const char *file)
	set file the fingerprint should be written to
int	libthinkfinger_set_callback (libthinkfinger *tf, libthinkfinger_state_cb state, void *data)
	set the callback function being invoked to report a new state of the scanner
libthinkfinger_result	libthinkfinger_acquire (libthinkfinger *tf)
	acquire fingerprint
libthinkfinger_result	libthinkfinger_verify (libthinkfinger *tf)
	verify fingerprint
libthinkfinger *	libthinkfinger_new (libthinkfinger_init_status *init_status)
	create a struct libthinkfinger
int	libthinkfinger_has_device (libthinkfinger *tf)
	check to see if a scanner device is present
void	libthinkfinger_free (libthinkfinger *tf)
	free an instance of libthinkfinger

---

Detailed Description

Thomson Microelectronics fingerprint reader

---

Typedef Documentation

typedef void(* libthinkfinger_state_cb)(libthinkfinger_state state, void *data)

callback function which the driver invokes to report a new state of the scanner

Parameters:

	state	status libthinkfinger_state
	data	void pointer to user data

Returns:

void

---

Function Documentation

libthinkfinger_result libthinkfinger_acquire

(

libthinkfinger *

tf

)

acquire fingerprint

acquires a fingerprint and stores it to disk on success

Parameters:

tf

struct libthinkfinger

Returns:

libthinkfinger_result

void libthinkfinger_free

(

libthinkfinger *

tf

)

free an instance of libthinkfinger

Parameters:

tf

pointer to struct libthinkfinger

Returns:

void

int libthinkfinger_has_device

(

libthinkfinger *

tf

)

check to see if a scanner device is present

check to see if a scanner device is present

Parameters:

tf

struct libthinkfinger

Returns:

TRUE if a device is present

libthinkfinger* libthinkfinger_new

(

libthinkfinger_init_status *

init_status

)

create a struct libthinkfinger

create a struct libthinkfinger and return a pointer to struct libthinkfinger on success.

Parameters:

reference

to libthinkfinger_init_status

Returns:

pointer to struct libthinkfinger on success, else NULL

int libthinkfinger_set_callback	(	libthinkfinger *	tf,
		libthinkfinger_state_cb	state,
		void *	data
	)

set the callback function being invoked to report a new state of the scanner

Parameters:

	tf	struct libthinkfinger
	state	status libthinkfinger_state
	data	void pointer to user data

Returns:

0 on success, else -1

int libthinkfinger_set_file	(	libthinkfinger *	tf,
		const char *	file
	)

set file the fingerprint should be written to

Parameters:

	tf	struct libthinkfinger
	file	filename

Returns:

0 on success, else -1

libthinkfinger_result libthinkfinger_verify

(

libthinkfinger *

tf

)

verify fingerprint

verifies a fingerprint

Parameters:

tf

struct libthinkfinger

Returns:

libthinkfinger_result