FPC AllKey Pro API. More...

#include <stdint.h>

Include dependency graph for fpc_api.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	fpc_frame_hdr_t
	Frame Header. More...

struct	fpc_cmd_hdr_t
	Command Header. More...

struct	fpc_frame_hdr_sec_addon_t
	Frame Header Addon for secure Protocol. More...

struct	fpc_cmd_status_response_t
	Payload definition of the CMD_STATUS Response / Event. More...

struct	fpc_cmd_version_response_t
	Payload definition of the CMD_VERSION Response. More...

struct	fpc_cmd_set_crypto_key_request_t
	Payload definition AES Key Provisioning CMD_SET_CRYPTO_KEY Request. More...

struct	fpc_id_type_t
	Template ID specifier payload. More...

struct	fpc_cmd_capture_request_t
	Payload definition of the CMD_CAPTURE Request command. More...

struct	fpc_cmd_enroll_request_t
	Payload definition of the CMD_ENROLL Request. More...

struct	fpc_cmd_enroll_status_response_t
	Payload definition of the CMD_ENROLL Status Event. More...

struct	fpc_cmd_identify_request_t
	Payload definition of the CMD_IDENTIFY Request. More...

struct	fpc_cmd_identify_status_response_t
	Payload definition of the CMD_IDENTIFY Event. More...

struct	fpc_cmd_template_delete_request_t
	Payload definition of the CMD_DELETE_TEMPLATE Request. More...

struct	fpc_cmd_template_info_response_t
	Payload definition of the CMD_LIST_TEMPLATES Response. More...

struct	fpc_cmd_template_data_request_t
	Payload definition of the Template Data (GET & PUT) Request. More...

struct	fpc_cmd_template_data_response_t
	Payload definition of the Template Data Response. More...

struct	fpc_cmd_image_request_t
	Payload definition of the Image request command. More...

struct	fpc_cmd_image_response_t
	Payload definition of the Image response command. More...

struct	fpc_cmd_navigation_request_t
	Payload definition of the CMD_NAVIGATION Request. More...

struct	fpc_cmd_navigation_status_event_t
	Payload definition of the CMD_NAVIGATION Event. More...

struct	fpc_cmd_navigation_ps_status_event_t
	Payload definition of the CMD_NAVIGATION_PS Event. More...

struct	fpc_cmd_data_put_request_t
	Payload for CMD_DATA_PUT request. More...

struct	fpc_cmd_data_put_response_t
	Payload for CMD_DATA_PUT response. More...

struct	fpc_cmd_data_get_request_t
	Payload for CMD_DATA_GET request. More...

struct	fpc_cmd_data_get_response_t
	Payload for CMD_DATA_GET response. More...

struct	fpc_system_config_t
	System Configuration parameters. More...

struct	fpc_cmd_get_config_request_t
	Payload definition of the CMD_GET_SYSTEM_CONFIG Request. More...

struct	fpc_cmd_get_config_response_t
	Payload definition of the CMD_GET_SYSTEM_CONFIG Response. More...

struct	fpc_cmd_set_config_request_t
	Payload definition of the CMD_SET_SYSTEM_CONFIG Request. More...

struct	fpc_cmd_pinctrl_gpio_request_t
	Payload definition of the CMD_GPIO_CONTROL Request. More...

struct	fpc_cmd_pinctrl_gpio_response_t
	Payload definition of the CMD_GPIO_CONTROL Response. More...

struct	fpc_cmd_bist_response_t

Macros
#define	FPC_RESULT_OK 0

#define	FPC_PENDING_OPERATION 1

#define	FPC_RESULT_DATA_NOT_SET 2

#define	FPC_RESULT_CMD_ID_NOT_SUPPORTED 3

#define	FPC_RESULT_FAILURE 11

#define	FPC_RESULT_INVALID_PARAM 12

#define	FPC_RESULT_WRONG_STATE 13

#define	FPC_RESULT_OUT_OF_MEMORY 14

#define	FPC_RESULT_TIMEOUT 15

#define	FPC_RESULT_NOT_SUPPORTED 16

#define	FPC_RESULT_USER_ID_EXISTS 20

#define	FPC_RESULT_USER_ID_NOT_FOUND 21

#define	FPC_RESULT_STORAGE_IS_FULL 22

#define	FPC_RESULT_FLASH_ERROR 23

#define	FPC_RESULT_IDENTIFY_LOCKOUT 24

#define	FPC_RESULT_STORAGE_IS_EMPTY 25

#define	FPC_RESULT_IO_BUSY 31

#define	FPC_RESULT_IO_RUNTIME_FAILURE 32

#define	FPC_RESULT_IO_BAD_DATA 33

#define	FPC_RESULT_IO_NOT_SUPPORTED 34

#define	FPC_RESULT_IO_NO_DATA 35

#define	FPC_RESULT_COULD_NOT_ARM 40

#define	FPC_RESULT_CAPTURE_FAILED 41

#define	FPC_RESULT_BAD_IMAGE_QUALITY 42

#define	FPC_RESULT_NO_IMAGE 43

#define	FPC_RESULT_SENSOR_ERROR 50

#define	FPC_RESULT_PROTOCOL_VERSION_ERROR 70

#define	FPC_STARTUP_FAILURE 101

#define	FPC_FRAME_PROTOCOL_VERSION 0x0004
	Frame Protocol Version. More...

#define	FPC_FRAME_TYPE_CMD_REQUEST 0x11
	Frame Type. More...

#define	FPC_FRAME_TYPE_CMD_RESPONSE 0x12

#define	FPC_FRAME_TYPE_CMD_EVENT 0x13

#define	FPC_FRAME_FLAG_SECURE 0x0001
	Frame Flags. More...

#define	FPC_FRAME_FLAG_SENDER_HOST 0x0010

#define	FPC_FRAME_FLAG_SENDER_FW_BL 0x0020

#define	FPC_FRAME_FLAG_SENDER_FW_APP 0x0040

#define	MAX_HOST_PACKET_SIZE_DEFAULT (2 * 1024)

#define	FPC_AES_GCM_IV_SIZE 12

#define	FPC_AES_GCM_TAG_SIZE 16

#define	CMD_STATUS 0x0040
	Command IDs. More...

#define	CMD_VERSION 0x0041

#define	CMD_BIST 0x0044

#define	CMD_CAPTURE 0x0050

#define	CMD_ABORT 0x0052

#define	CMD_IMAGE_DATA 0x0053

#define	CMD_ENROLL 0x0054

#define	CMD_IDENTIFY 0x0055

#define	CMD_LIST_TEMPLATES 0x0060

#define	CMD_DELETE_TEMPLATE 0x0061

#define	CMD_GET_TEMPLATE_DATA 0x0062

#define	CMD_PUT_TEMPLATE_DATA 0x0063

#define	CMD_GET_SYSTEM_CONFIG 0x006A

#define	CMD_SET_SYSTEM_CONFIG 0x006B

#define	CMD_RESET 0x0072

#define	CMD_SET_CRYPTO_KEY 0x0083

#define	CMD_SET_DBG_LOG_LEVEL 0x00B0

#define	CMD_FACTORY_RESET 0x00FA

#define	CMD_DATA_GET 0x0101

#define	CMD_DATA_PUT 0x0102

#define	CMD_NAVIGATION 0x0200

#define	CMD_NAVIGATION_PS 0x0201

#define	CMD_GPIO_CONTROL 0x0300

#define	EVENT_NONE 0
	Status Event. More...

#define	EVENT_IDLE 1

#define	EVENT_FINGER_DETECT 3

#define	EVENT_FINGER_LOST 4

#define	EVENT_IMAGE_READY 5

#define	EVENT_CMD_FAILED 6

#define	STATE_APP_FW_READY 0x0001
	System States (Bitmap). More...

#define	STATE_SECURE_INTERFACE 0x0002

#define	STATE_CAPTURE 0x0004

#define	STATE_IMAGE_AVAILABLE 0x0010

#define	STATE_DATA_TRANSFER 0x0040

#define	STATE_FINGER_DOWN 0x0080

#define	STATE_SYS_ERROR 0x0400

#define	STATE_ENROLL 0x1000

#define	STATE_IDENTIFY 0x2000

#define	STATE_NAVIGATION 0x4000

#define	ENROLL_FEEDBACK_DONE 1
	Enrollment Feedback. More...

#define	ENROLL_FEEDBACK_PROGRESS 2

#define	ENROLL_FEEDBACK_REJECT_LOW_QUALITY 3

#define	ENROLL_FEEDBACK_REJECT_LOW_COVERAGE 4

#define	ENROLL_FEEDBACK_REJECT_LOW_MOBILITY 5

#define	ENROLL_FEEDBACK_REJECT_OTHER 6

#define	ENROLL_FEEDBACK_PROGRESS_IMMOBILE 7

#define	IDENTIFY_RESULT_MATCH 0x61EC
	Identify match results. More...

#define	IDENTIFY_RESULT_NO_MATCH 0xBAAD

#define	CMD_IMAGE_REQUEST_TYPE_INFO_RAW 0
	Image request types. More...

#define	CMD_IMAGE_REQUEST_TYPE_INFO_FMI 1

#define	CMD_IMAGE_REQUEST_TYPE_GET_RAW 2

#define	CMD_IMAGE_REQUEST_TYPE_GET_FMI 3

#define	CMD_NAV_EVENT_NONE 0
	Navigation events. More...

#define	CMD_NAV_EVENT_UP 1

#define	CMD_NAV_EVENT_DOWN 2

#define	CMD_NAV_EVENT_RIGHT 3

#define	CMD_NAV_EVENT_LEFT 4

#define	CMD_NAV_EVENT_PRESS 5

#define	CMD_NAV_EVENT_LONG_PRESS 6

#define	CMD_NAV_CFG_ORIENTATION_0 0x00000000
	Navigation configuration. More...

#define	CMD_NAV_CFG_ORIENTATION_90 0x00000001

#define	CMD_NAV_CFG_ORIENTATION_180 0x00000002

#define	CMD_NAV_CFG_ORIENTATION_270 0x00000003

#define	CMD_NAV_CFG_ORIENTATION_MASK 0x00000003

#define	CMD_NAV_CFG_SKIP_FINGER_STABLE 0x00000004

#define	CMD_NAV_CFG_SEND_SAMPLE_DATA 0x00000008

#define	ID_TYPE_NONE 0x1012
	Template ID NONE, option valid for: More...

#define	ID_TYPE_ALL 0x2023
	Template ID ALL, option valid for: More...

#define	ID_TYPE_SPECIFIED 0x3034
	Template ID SPECIFIED, option valid for: More...

#define	ID_TYPE_GENERATE_NEW 0x4045
	Template ID GENERATE NEW, option valid for: More...

#define	CFG_VERSION 2

#define	CFG_SYS_FLAG_STATUS_EVT_AT_BOOT 0x00000001
	System Configuration Flags. More...

#define	CFG_SYS_FLAG_UART_IN_STOP_MODE 0x00000010

#define	CFG_SYS_FLAG_UART_IRQ_BEFORE_TX 0x00000020

#define	CFG_SYS_FLAG_ALLOW_FACTORY_RESET 0x00000100

#define	CFG_UART_BAUDRATE_9600 1
	UART baudrate definitions. More...

#define	CFG_UART_BAUDRATE_19200 2

#define	CFG_UART_BAUDRATE_57600 3

#define	CFG_UART_BAUDRATE_115200 4

#define	CFG_UART_BAUDRATE_921600 5

#define	FPC_SYS_CFG_TYPE_DEFAULT 0

#define	FPC_SYS_CFG_TYPE_CUSTOM 1

#define	GPIO_CONTROL_SUB_CMD_GET 0

#define	GPIO_CONTROL_SUB_CMD_SET 1

#define	GPIO_CONTROL_MODE_NOT_USED 0

#define	GPIO_CONTROL_MODE_OUTPUT_PP 1

#define	GPIO_CONTROL_MODE_OUTPUT_OD 2

#define	GPIO_CONTROL_MODE_INPUT_PULL_NONE 3

#define	GPIO_CONTROL_MODE_INPUT_PULL_UP 4

#define	GPIO_CONTROL_MODE_INPUT_PULL_DOWN 5

#define	GPIO_CONTROL_STATE_RESET 0

#define	GPIO_CONTROL_STATE_SET 1

Typedefs
typedef uint16_t	fpc_result_t

Enumerations
enum	fpc_cmd_data_type_t { FPC_CMD_DATA_TYPE_NONE , FPC_CMD_DATA_TYPE_RAM , FPC_CMD_DATA_TYPE_FILE }

Detailed Description

FPC AllKey Pro API.

This is the Command Interface for the Fingerprint Sensor Module fpc2534.

Macro Definition Documentation

◆ CFG_SYS_FLAG_ALLOW_FACTORY_RESET

#define CFG_SYS_FLAG_ALLOW_FACTORY_RESET 0x00000100

By default, it is not allowed to do a factory reset (remove templates, AES keys and configuration data). By setting this flag, it becomes an allowed operation.

◆ CFG_SYS_FLAG_STATUS_EVT_AT_BOOT

#define CFG_SYS_FLAG_STATUS_EVT_AT_BOOT 0x00000001

System Configuration Flags.

Send Status Event after system boot.

◆ CFG_SYS_FLAG_UART_IN_STOP_MODE

#define CFG_SYS_FLAG_UART_IN_STOP_MODE 0x00000010

Let system go into stop mode when using UART interface. This requires the system to be woken via wake-up pin (CS) before sending any UART data to host.

◆ CFG_SYS_FLAG_UART_IRQ_BEFORE_TX

#define CFG_SYS_FLAG_UART_IRQ_BEFORE_TX 0x00000020

Set IRQ pin before SiP sends UART data. The delay between IRQ and start of data is configurable via uart_delay_before_irq_ms

◆ CFG_UART_BAUDRATE_115200

#define CFG_UART_BAUDRATE_115200 4

◆ CFG_UART_BAUDRATE_19200

#define CFG_UART_BAUDRATE_19200 2

◆ CFG_UART_BAUDRATE_57600

#define CFG_UART_BAUDRATE_57600 3

◆ CFG_UART_BAUDRATE_921600

#define CFG_UART_BAUDRATE_921600 5

◆ CFG_UART_BAUDRATE_9600

#define CFG_UART_BAUDRATE_9600 1

UART baudrate definitions.

◆ CFG_VERSION

#define CFG_VERSION 2

Version of System Configuration Structure

◆ CMD_ABORT

#define CMD_ABORT 0x0052

◆ CMD_BIST

#define CMD_BIST 0x0044

◆ CMD_CAPTURE

#define CMD_CAPTURE 0x0050

◆ CMD_DATA_GET

#define CMD_DATA_GET 0x0101

◆ CMD_DATA_PUT

#define CMD_DATA_PUT 0x0102

◆ CMD_DELETE_TEMPLATE

#define CMD_DELETE_TEMPLATE 0x0061

◆ CMD_ENROLL

#define CMD_ENROLL 0x0054

◆ CMD_FACTORY_RESET

#define CMD_FACTORY_RESET 0x00FA

◆ CMD_GET_SYSTEM_CONFIG

#define CMD_GET_SYSTEM_CONFIG 0x006A

◆ CMD_GET_TEMPLATE_DATA

#define CMD_GET_TEMPLATE_DATA 0x0062

◆ CMD_GPIO_CONTROL

#define CMD_GPIO_CONTROL 0x0300

◆ CMD_IDENTIFY

#define CMD_IDENTIFY 0x0055

◆ CMD_IMAGE_DATA

#define CMD_IMAGE_DATA 0x0053

◆ CMD_IMAGE_REQUEST_TYPE_GET_FMI

#define CMD_IMAGE_REQUEST_TYPE_GET_FMI 3

◆ CMD_IMAGE_REQUEST_TYPE_GET_RAW

#define CMD_IMAGE_REQUEST_TYPE_GET_RAW 2

◆ CMD_IMAGE_REQUEST_TYPE_INFO_FMI

#define CMD_IMAGE_REQUEST_TYPE_INFO_FMI 1

◆ CMD_IMAGE_REQUEST_TYPE_INFO_RAW

#define CMD_IMAGE_REQUEST_TYPE_INFO_RAW 0

Image request types.

◆ CMD_LIST_TEMPLATES

#define CMD_LIST_TEMPLATES 0x0060

◆ CMD_NAV_CFG_ORIENTATION_0

#define CMD_NAV_CFG_ORIENTATION_0 0x00000000

Navigation configuration.

◆ CMD_NAV_CFG_ORIENTATION_180

#define CMD_NAV_CFG_ORIENTATION_180 0x00000002

◆ CMD_NAV_CFG_ORIENTATION_270

#define CMD_NAV_CFG_ORIENTATION_270 0x00000003

◆ CMD_NAV_CFG_ORIENTATION_90

#define CMD_NAV_CFG_ORIENTATION_90 0x00000001

◆ CMD_NAV_CFG_ORIENTATION_MASK

#define CMD_NAV_CFG_ORIENTATION_MASK 0x00000003

◆ CMD_NAV_CFG_SEND_SAMPLE_DATA

#define CMD_NAV_CFG_SEND_SAMPLE_DATA 0x00000008

◆ CMD_NAV_CFG_SKIP_FINGER_STABLE

#define CMD_NAV_CFG_SKIP_FINGER_STABLE 0x00000004

◆ CMD_NAV_EVENT_DOWN

#define CMD_NAV_EVENT_DOWN 2

◆ CMD_NAV_EVENT_LEFT

#define CMD_NAV_EVENT_LEFT 4

◆ CMD_NAV_EVENT_LONG_PRESS

#define CMD_NAV_EVENT_LONG_PRESS 6

◆ CMD_NAV_EVENT_NONE

#define CMD_NAV_EVENT_NONE 0

Navigation events.

◆ CMD_NAV_EVENT_PRESS

#define CMD_NAV_EVENT_PRESS 5

◆ CMD_NAV_EVENT_RIGHT

#define CMD_NAV_EVENT_RIGHT 3

◆ CMD_NAV_EVENT_UP

#define CMD_NAV_EVENT_UP 1

◆ CMD_NAVIGATION

#define CMD_NAVIGATION 0x0200

◆ CMD_NAVIGATION_PS

#define CMD_NAVIGATION_PS 0x0201

◆ CMD_PUT_TEMPLATE_DATA

#define CMD_PUT_TEMPLATE_DATA 0x0063

◆ CMD_RESET

#define CMD_RESET 0x0072

◆ CMD_SET_CRYPTO_KEY

#define CMD_SET_CRYPTO_KEY 0x0083

◆ CMD_SET_DBG_LOG_LEVEL

#define CMD_SET_DBG_LOG_LEVEL 0x00B0

◆ CMD_SET_SYSTEM_CONFIG

#define CMD_SET_SYSTEM_CONFIG 0x006B

◆ CMD_STATUS

#define CMD_STATUS 0x0040

Command IDs.

◆ CMD_VERSION

#define CMD_VERSION 0x0041

◆ ENROLL_FEEDBACK_DONE

#define ENROLL_FEEDBACK_DONE 1

Enrollment Feedback.

◆ ENROLL_FEEDBACK_PROGRESS

#define ENROLL_FEEDBACK_PROGRESS 2

◆ ENROLL_FEEDBACK_PROGRESS_IMMOBILE

#define ENROLL_FEEDBACK_PROGRESS_IMMOBILE 7

◆ ENROLL_FEEDBACK_REJECT_LOW_COVERAGE

#define ENROLL_FEEDBACK_REJECT_LOW_COVERAGE 4

◆ ENROLL_FEEDBACK_REJECT_LOW_MOBILITY

#define ENROLL_FEEDBACK_REJECT_LOW_MOBILITY 5

◆ ENROLL_FEEDBACK_REJECT_LOW_QUALITY

#define ENROLL_FEEDBACK_REJECT_LOW_QUALITY 3

◆ ENROLL_FEEDBACK_REJECT_OTHER

#define ENROLL_FEEDBACK_REJECT_OTHER 6

◆ EVENT_CMD_FAILED

#define EVENT_CMD_FAILED 6

◆ EVENT_FINGER_DETECT

#define EVENT_FINGER_DETECT 3

◆ EVENT_FINGER_LOST

#define EVENT_FINGER_LOST 4

◆ EVENT_IDLE

#define EVENT_IDLE 1

◆ EVENT_IMAGE_READY

#define EVENT_IMAGE_READY 5

◆ EVENT_NONE

#define EVENT_NONE 0

Status Event.

◆ FPC_AES_GCM_IV_SIZE

#define FPC_AES_GCM_IV_SIZE 12

◆ FPC_AES_GCM_TAG_SIZE

#define FPC_AES_GCM_TAG_SIZE 16

◆ FPC_FRAME_FLAG_SECURE

#define FPC_FRAME_FLAG_SECURE 0x0001

Frame Flags.

◆ FPC_FRAME_FLAG_SENDER_FW_APP

#define FPC_FRAME_FLAG_SENDER_FW_APP 0x0040

◆ FPC_FRAME_FLAG_SENDER_FW_BL

#define FPC_FRAME_FLAG_SENDER_FW_BL 0x0020

◆ FPC_FRAME_FLAG_SENDER_HOST

#define FPC_FRAME_FLAG_SENDER_HOST 0x0010

◆ FPC_FRAME_PROTOCOL_VERSION

#define FPC_FRAME_PROTOCOL_VERSION 0x0004

Frame Protocol Version.

◆ FPC_FRAME_TYPE_CMD_EVENT

#define FPC_FRAME_TYPE_CMD_EVENT 0x13

◆ FPC_FRAME_TYPE_CMD_REQUEST

#define FPC_FRAME_TYPE_CMD_REQUEST 0x11

Frame Type.

◆ FPC_FRAME_TYPE_CMD_RESPONSE

#define FPC_FRAME_TYPE_CMD_RESPONSE 0x12

◆ FPC_PENDING_OPERATION

#define FPC_PENDING_OPERATION 1

◆ FPC_RESULT_BAD_IMAGE_QUALITY

#define FPC_RESULT_BAD_IMAGE_QUALITY 42

◆ FPC_RESULT_CAPTURE_FAILED

#define FPC_RESULT_CAPTURE_FAILED 41

◆ FPC_RESULT_CMD_ID_NOT_SUPPORTED

#define FPC_RESULT_CMD_ID_NOT_SUPPORTED 3

◆ FPC_RESULT_COULD_NOT_ARM

#define FPC_RESULT_COULD_NOT_ARM 40

◆ FPC_RESULT_DATA_NOT_SET

#define FPC_RESULT_DATA_NOT_SET 2

◆ FPC_RESULT_FAILURE

#define FPC_RESULT_FAILURE 11

◆ FPC_RESULT_FLASH_ERROR

#define FPC_RESULT_FLASH_ERROR 23

◆ FPC_RESULT_IDENTIFY_LOCKOUT

#define FPC_RESULT_IDENTIFY_LOCKOUT 24

◆ FPC_RESULT_INVALID_PARAM

#define FPC_RESULT_INVALID_PARAM 12

◆ FPC_RESULT_IO_BAD_DATA

#define FPC_RESULT_IO_BAD_DATA 33

◆ FPC_RESULT_IO_BUSY

#define FPC_RESULT_IO_BUSY 31

◆ FPC_RESULT_IO_NO_DATA

#define FPC_RESULT_IO_NO_DATA 35

◆ FPC_RESULT_IO_NOT_SUPPORTED

#define FPC_RESULT_IO_NOT_SUPPORTED 34

◆ FPC_RESULT_IO_RUNTIME_FAILURE

#define FPC_RESULT_IO_RUNTIME_FAILURE 32

◆ FPC_RESULT_NO_IMAGE

#define FPC_RESULT_NO_IMAGE 43

◆ FPC_RESULT_NOT_SUPPORTED

#define FPC_RESULT_NOT_SUPPORTED 16

◆ FPC_RESULT_OK

#define FPC_RESULT_OK 0

◆ FPC_RESULT_OUT_OF_MEMORY

#define FPC_RESULT_OUT_OF_MEMORY 14

◆ FPC_RESULT_PROTOCOL_VERSION_ERROR

#define FPC_RESULT_PROTOCOL_VERSION_ERROR 70

◆ FPC_RESULT_SENSOR_ERROR

#define FPC_RESULT_SENSOR_ERROR 50

◆ FPC_RESULT_STORAGE_IS_EMPTY

#define FPC_RESULT_STORAGE_IS_EMPTY 25

◆ FPC_RESULT_STORAGE_IS_FULL

#define FPC_RESULT_STORAGE_IS_FULL 22

◆ FPC_RESULT_TIMEOUT

#define FPC_RESULT_TIMEOUT 15

◆ FPC_RESULT_USER_ID_EXISTS

#define FPC_RESULT_USER_ID_EXISTS 20

◆ FPC_RESULT_USER_ID_NOT_FOUND

#define FPC_RESULT_USER_ID_NOT_FOUND 21

◆ FPC_RESULT_WRONG_STATE

#define FPC_RESULT_WRONG_STATE 13

◆ FPC_STARTUP_FAILURE

#define FPC_STARTUP_FAILURE 101

◆ FPC_SYS_CFG_TYPE_CUSTOM

#define FPC_SYS_CFG_TYPE_CUSTOM 1

◆ FPC_SYS_CFG_TYPE_DEFAULT

#define FPC_SYS_CFG_TYPE_DEFAULT 0

◆ GPIO_CONTROL_MODE_INPUT_PULL_DOWN

#define GPIO_CONTROL_MODE_INPUT_PULL_DOWN 5

◆ GPIO_CONTROL_MODE_INPUT_PULL_NONE

#define GPIO_CONTROL_MODE_INPUT_PULL_NONE 3

◆ GPIO_CONTROL_MODE_INPUT_PULL_UP

#define GPIO_CONTROL_MODE_INPUT_PULL_UP 4

◆ GPIO_CONTROL_MODE_NOT_USED

#define GPIO_CONTROL_MODE_NOT_USED 0

◆ GPIO_CONTROL_MODE_OUTPUT_OD

#define GPIO_CONTROL_MODE_OUTPUT_OD 2

◆ GPIO_CONTROL_MODE_OUTPUT_PP

#define GPIO_CONTROL_MODE_OUTPUT_PP 1

◆ GPIO_CONTROL_STATE_RESET

#define GPIO_CONTROL_STATE_RESET 0

◆ GPIO_CONTROL_STATE_SET

#define GPIO_CONTROL_STATE_SET 1

◆ GPIO_CONTROL_SUB_CMD_GET

#define GPIO_CONTROL_SUB_CMD_GET 0

◆ GPIO_CONTROL_SUB_CMD_SET

#define GPIO_CONTROL_SUB_CMD_SET 1

◆ ID_TYPE_ALL

#define ID_TYPE_ALL 0x2023

Template ID ALL, option valid for:

CMD_IDENTIFY Request CMD_DELETE_TEMPLATE Request

◆ ID_TYPE_GENERATE_NEW

#define ID_TYPE_GENERATE_NEW 0x4045

Template ID GENERATE NEW, option valid for:

CMD_ENROLL Request

◆ ID_TYPE_NONE

#define ID_TYPE_NONE 0x1012

Template ID NONE, option valid for:

CMD_IDENTIFY Result (In No Match case)

◆ ID_TYPE_SPECIFIED

#define ID_TYPE_SPECIFIED 0x3034

Template ID SPECIFIED, option valid for:

CMD_IDENTIFY Request (Verify) and Response CMD_ENROLL Request CMD_DELETE_TEMPLATE Request

◆ IDENTIFY_RESULT_MATCH

#define IDENTIFY_RESULT_MATCH 0x61EC

Identify match results.

◆ IDENTIFY_RESULT_NO_MATCH

#define IDENTIFY_RESULT_NO_MATCH 0xBAAD

◆ MAX_HOST_PACKET_SIZE_DEFAULT

#define MAX_HOST_PACKET_SIZE_DEFAULT (2 * 1024)

◆ STATE_APP_FW_READY

#define STATE_APP_FW_READY 0x0001

System States (Bitmap).

◆ STATE_CAPTURE

#define STATE_CAPTURE 0x0004

◆ STATE_DATA_TRANSFER

#define STATE_DATA_TRANSFER 0x0040

◆ STATE_ENROLL

#define STATE_ENROLL 0x1000

◆ STATE_FINGER_DOWN

#define STATE_FINGER_DOWN 0x0080

◆ STATE_IDENTIFY

#define STATE_IDENTIFY 0x2000

◆ STATE_IMAGE_AVAILABLE

#define STATE_IMAGE_AVAILABLE 0x0010

◆ STATE_NAVIGATION

#define STATE_NAVIGATION 0x4000

◆ STATE_SECURE_INTERFACE

#define STATE_SECURE_INTERFACE 0x0002

◆ STATE_SYS_ERROR

#define STATE_SYS_ERROR 0x0400

Typedef Documentation

◆ fpc_result_t

typedef uint16_t fpc_result_t

Enumeration Type Documentation

◆ fpc_cmd_data_type_t

enum fpc_cmd_data_type_t

Enumerator
FPC_CMD_DATA_TYPE_NONE
FPC_CMD_DATA_TYPE_RAM
FPC_CMD_DATA_TYPE_FILE

Classes

Macros

Typedefs

Enumerations