libfprint/libfprint/drivers/synaptics/bmkt.h

/*
 * Synaptics MiS Fingerprint Sensor Interface
 * Copyright (C) 2019 Synaptics Inc
 *
 * 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
 */

#pragma once

/**< User ID maximum length allowed */
#define BMKT_MAX_USER_ID_LEN 100
/**< Software Part Number length */
#define BMKT_PART_NUM_LEN 10
/**< Software supplier identification length */
#define BMKT_SUPPLIER_ID_LEN 2

/**< Maximum namber of templates for storing in internal flash of the fingerprint sensor */
#define BMKT_MAX_NUM_TEMPLATES_INTERNAL_FLASH 15

#include <stdint.h>
#include "bmkt_response.h"

/*!
 *******************************************************************************
 **  Type definition for result
 */
/** No error; Operation successfully completed. */
#define BMKT_SUCCESS 0
/** Fingerprint system not initialized */
#define BMKT_FP_SYSTEM_NOT_INITIALIZED 101
/** Fingerprint system busy performing another operation */
#define BMKT_FP_SYSTEM_BUSY 102
/** Operation not allowed */
#define BMKT_OPERATION_DENIED 103
/** System ran out of memory while performing operation */
#define BMKT_OUT_OF_MEMORY 104
/** Corrupt message, CRC check fail or truncated message */
#define BMKT_CORRUPT_MESSAGE 110
/** One of the command parameters is outside the range of valid values */
#define BMKT_INVALID_PARAM 111
/** Unrecognized message or message with invalid message ID */
#define BMKT_UNRECOGNIZED_MESSAGE 112
/** Operation time out */
#define BMKT_OP_TIME_OUT 113
/** General error – cause of error cannot be determined */
#define BMKT_GENERAL_ERROR 114

#define BMKT_SET_SECURITY_LEVEL_FAIL 120
#define BMKT_GET_SECURITY_LEVEL_FAIL 121

/** Fingerprint sensor reset while operation was being performed */
#define BMKT_SENSOR_RESET 201
/** Fingerprint sensor malfunctioned */
#define BMKT_SENSOR_MALFUNCTION 202
/** Fingerprint sensor cannot be accessed despite repeated attempts */
#define BMKT_SENSOR_TAMPERED 203
/**
 * BMKT_SENSOR_NOT_INIT:
 * Fingerprint sensor module not initialized yet – not ready for use
 * (different from error code 101 which indicates that the entire system
 * has not been initialized)
 */
#define BMKT_SENSOR_NOT_INIT 204
/** Number of re-pairing operations exceeded limit or re-pairing has been disabled */
#define BMKT_OWNERSHIP_RESET_MAX_EXCEEDED 205
/**
 * BMKT_SENSOR_STIMULUS_ERROR:
 * There is a finger or debris on the sensor that needs to be removed
 * before issuing this command
 */
#define BMKT_SENSOR_STIMULUS_ERROR 213
/**
 * BMKT_CORRUPT_TEMPLATE_DATA:
 * One of the fingerprint templates stored on flash is corrupt.
 * This error code is returned in case of failure in finding a fingerprint match
 * during identify or verify operations while also detecting that one or more
 * fingerprint templates stored on the flash has become corrupted
 */
#define BMKT_CORRUPT_TEMPLATE_DATA 300
/** Failed to extract features from fingerprint image acquired by sensor */
#define BMKT_FEATURE_EXTRACT_FAIL 301
/** Failed to generate fingerprint template */
#define BMKT_ENROLL_FAIL 302
/** Specified finger already enrolled for this user */
#define BMKT_ENROLLMENT_EXISTS 303
/** Invalid fingerprint image */
#define BMKT_INVALID_FP_IMAGE 304
/** No matching user fingerprint template found in database */
#define BMKT_FP_NO_MATCH 404
/** Fingerprint database is full */
#define BMKT_FP_DATABASE_FULL 501
/** Fingerprint database is empty */
#define BMKT_FP_DATABASE_EMPTY 502
/** Cannot access fingerprint database */
#define BMKT_FP_DATABASE_ACCESS_FAIL 503
/** Fingerprint template record does not exist */
#define BMKT_FP_DATABASE_NO_RECORD_EXISTS 504
/** Failed to read/write system parameters stored on flash */
#define BMKT_FP_PARAM_ACCESS_FAIL 505
/** Fingerprint is a spoof */
#define BMKT_FP_SPOOF_ALERT 801
/** Anti-spoof module failure */
#define BMKT_ANTI_SPOOF_MODULE_FAIL 802

#define BMKT_CORRUPT_UPDATE_IMAGE 901
#define BMKT_SYSTEM_UPDATE_FAIL 902

#define BMKT_EVENT_NOT_SET 1000
#define BMKT_SENSOR_NOT_READY 1001
#define BMKT_TIMEOUT 1002
#define BMKT_SENSOR_RESPONSE_PENDING 1003


#ifdef __cplusplus
extern "C" {
#endif

/**
 * bmkt_mode:
 * Fingerprint system operational mode values level 1
 */
typedef enum bmkt_mode {
  BMKT_STATE_UNINIT    = 0xFF,
  BMKT_STATE_IDLE      = 0x00,
  BMKT_STATE_ENROLL    = 0x10,
  BMKT_STATE_IDENTIFY  = 0x20,
  BMKT_STATE_VERIFY    = 0x30,
  BMKT_STATE_DB_OPS    = 0x40,
  BMKT_STATE_SYS_TEST  = 0x50,
  BMKT_STATE_SYS_OPS   = 0x60,
} bmkt_mode_t;

/**
 * bmkt_mode_level2:
 * Fingerprint system operational mode values level 2
 */
typedef enum bmkt_mode_level2 {
  BMKT_STATE_L2_IDLE                  = 0x00,
  BMKT_STATE_L2_STARTING              = 0x11,
  BMKT_STATE_L2_WAITING_FOR_FINGER    = 0x12,
  BMKT_STATE_L2_CAPTURE_IMAGE         = 0x13,
  BMKT_STATE_L2_CAPTURE_COMPLETE      = 0x14,
  BMKT_STATE_L2_EXTRACT_FEATURE       = 0x15,
  BMKT_STATE_L2_CREATE_TEMPLATE       = 0x16,
  BMKT_STATE_L2_READING_FROM_FLASH    = 0x17,
  BMKT_STATE_L2_WRITING_TO_FLASH      = 0x18,
  BMKT_STATE_L2_FINISHING             = 0x19,
  BMKT_STATE_L2_CANCELING_OP          = 0x20,
  BMKT_STATE_L2_MATCHING              = 0x21,
  BMKT_STATE_L2_TRANSMITTING_RESPONSE = 0x22,
  BMKT_STATE_L2_READY_POWER_DOWN      = 0xF0,
} bmkt_mode_level2_t;

/**
 * bmkt_transport_type:
 * Fingerprint system transport types
 */
typedef enum bmkt_transport_type {
  BMKT_TRANSPORT_TYPE_USB = 0,
} bmkt_transport_type_t;

/**
 * bmkt_usb_config:
 * Structure represcontainingenting USB configuration details
 */
typedef struct bmkt_usb_config
{
  int product_id;       /**< USB device product ID */
} bmkt_usb_config_t;

/**
 * bmkt_transport_config_t:
 * Union containing transport configuration details
 */
typedef union
{
  bmkt_usb_config_t usb_config;
} bmkt_transport_config_t;

/**
 * bmkt_sensor_desc_t:
 * Structure containing fingerprint system description
 */
typedef struct bmkt_sensor_desc
{
  int product_id;
  int flags;
} bmkt_sensor_desc_t;

/**
 * bmkt_finger_state_t:
 * Finger state representation values.
 */
typedef enum {
  BMKT_FINGER_STATE_UNKNOWN    = 0,
  BMKT_FINGER_STATE_ON_SENSOR,
  BMKT_FINGER_STATE_NOT_ON_SENSOR,
} bmkt_finger_state_t;

/**
 * bmkt_finger_event_t:
 * Structure containing finger state
 */
typedef struct bmkt_finger_event
{
  bmkt_finger_state_t finger_state;
} bmkt_finger_event_t;

typedef struct bmkt_user_id
{
  uint8_t user_id_len;
  uint8_t user_id[BMKT_MAX_USER_ID_LEN];
} bmkt_user_id_t;

#ifdef __cplusplus
}
#endif