7dfc8f3364
Usually by passing the dev it from an fpi_ssm callback, or simply using that callback argument.
86 lines
2.7 KiB
C
86 lines
2.7 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 __FPI_SSM_H__
|
|
#define __FPI_SSM_H__
|
|
|
|
#include <stdint.h>
|
|
#include <errno.h>
|
|
#include <string.h>
|
|
#include <stdlib.h>
|
|
#include <glib.h>
|
|
#include <libusb.h>
|
|
|
|
/* async drv <--> lib comms */
|
|
|
|
/**
|
|
* fpi_ssm:
|
|
*
|
|
* Sequential state machine that iterates sequentially over
|
|
* a predefined series of states. Can be terminated by either completion or
|
|
* failure error conditions.
|
|
*/
|
|
typedef struct fpi_ssm fpi_ssm;
|
|
|
|
/**
|
|
* ssm_completed_fn:
|
|
* @ssm: a #fpi_ssm state machine
|
|
* @dev: the #fp_dev fingerprint device
|
|
* @user_data: the user data passed to fpi_ssm_new()
|
|
*
|
|
* The callback called when a state machine completes successfully,
|
|
* as set when calling fpi_ssm_start().
|
|
*/
|
|
typedef void (*ssm_completed_fn)(fpi_ssm *ssm,
|
|
struct fp_dev *dev,
|
|
void *user_data);
|
|
|
|
/**
|
|
* ssm_handler_fn:
|
|
* @ssm: a #fpi_ssm state machine
|
|
* @dev: the #fp_dev fingerprint device
|
|
* @user_data: the user data passed to fpi_ssm_new()
|
|
*
|
|
* The callback called when a state machine transitions from one
|
|
* state to the next, as set when calling fpi_ssm_new().
|
|
*/
|
|
typedef void (*ssm_handler_fn)(fpi_ssm *ssm,
|
|
struct fp_dev *dev,
|
|
void *user_data);
|
|
|
|
/* for library and drivers */
|
|
fpi_ssm *fpi_ssm_new(struct fp_dev *dev,
|
|
ssm_handler_fn handler,
|
|
int nr_states,
|
|
void *user_data);
|
|
void fpi_ssm_free(fpi_ssm *machine);
|
|
void fpi_ssm_start(fpi_ssm *ssm, ssm_completed_fn callback);
|
|
void fpi_ssm_start_subsm(fpi_ssm *parent, fpi_ssm *child);
|
|
|
|
/* for drivers */
|
|
void fpi_ssm_next_state(fpi_ssm *machine);
|
|
void fpi_ssm_jump_to_state(fpi_ssm *machine, int state);
|
|
void fpi_ssm_mark_completed(fpi_ssm *machine);
|
|
void fpi_ssm_mark_failed(fpi_ssm *machine, int error);
|
|
void *fpi_ssm_get_user_data(fpi_ssm *machine);
|
|
int fpi_ssm_get_error(fpi_ssm *machine);
|
|
int fpi_ssm_get_cur_state(fpi_ssm *machine);
|
|
|
|
#endif
|