biometrics.h File Reference

Main header file for biometrics driver API. More...

#include <zephyr/device.h>
#include <zephyr/kernel.h>
#include <errno.h>
#include <stddef.h>
#include <zephyr/types.h>
#include <zephyr/syscalls/biometrics.h>

Go to the source code of this file.

Data Structures
struct	biometric_capabilities
	Biometric sensor capabilities. More...
struct	biometric_match_result
	Result from a biometric match operation. More...
struct	biometric_capture_result
	Result from an enrollment capture operation. More...

Macros
#define	BIOMETRIC_STORAGE_DEVICE   BIT(0)
	Biometric storage modes.
#define	BIOMETRIC_STORAGE_HOST   BIT(1)
	Store on host system.

Enumerations
enum	biometric_sensor_type { BIOMETRIC_TYPE_FINGERPRINT , BIOMETRIC_TYPE_IRIS , BIOMETRIC_TYPE_FACE , BIOMETRIC_TYPE_VOICE }
	Biometrics sensor types. More...
enum	biometric_match_mode { BIOMETRIC_MATCH_VERIFY , BIOMETRIC_MATCH_IDENTIFY }
	Biometric matching modes. More...
enum	biometric_led_state { BIOMETRIC_LED_OFF , BIOMETRIC_LED_ON , BIOMETRIC_LED_BLINK , BIOMETRIC_LED_BREATHE }
	Biometric LED states. More...
enum	biometric_attribute {   BIOMETRIC_ATTR_MATCH_THRESHOLD , BIOMETRIC_ATTR_ENROLLMENT_QUALITY , BIOMETRIC_ATTR_SECURITY_LEVEL , BIOMETRIC_ATTR_TIMEOUT_MS ,   BIOMETRIC_ATTR_ANTI_SPOOF_LEVEL , BIOMETRIC_ATTR_IMAGE_QUALITY , BIOMETRIC_ATTR_COMMON_COUNT , BIOMETRIC_ATTR_PRIV_START = BIOMETRIC_ATTR_COMMON_COUNT ,   BIOMETRIC_ATTR_MAX = INT16_MAX }
	Biometric attribute types. More...

Functions
int	biometric_get_capabilities (const struct device *dev, struct biometric_capabilities *caps)
	Get biometric sensor capabilities.
int	biometric_attr_set (const struct device *dev, enum biometric_attribute attr, int32_t val)
	Set a biometric sensor attribute.
int	biometric_attr_get (const struct device *dev, enum biometric_attribute attr, int32_t *val)
	Get a biometric sensor attribute.
int	biometric_enroll_start (const struct device *dev, uint16_t template_id)
	Start biometric enrollment.
int	biometric_enroll_capture (const struct device *dev, k_timeout_t timeout, struct biometric_capture_result *result)
	Capture enrollment samples.
int	biometric_enroll_finalize (const struct device *dev)
	Finalize enrollment.
int	biometric_enroll_abort (const struct device *dev)
	Abort enrollment.
int	biometric_template_store (const struct device *dev, uint16_t id, const uint8_t *data, size_t size)
	Store biometric template.
int	biometric_template_read (const struct device *dev, uint16_t id, uint8_t *data, size_t size)
	Read biometric template.
int	biometric_template_delete (const struct device *dev, uint16_t id)
	Delete biometric template.
int	biometric_template_delete_all (const struct device *dev)
	Delete all biometric templates.
int	biometric_template_list (const struct device *dev, uint16_t *ids, size_t max_count, size_t *actual_count)
	List stored template IDs.
int	biometric_match (const struct device *dev, enum biometric_match_mode mode, uint16_t template_id, k_timeout_t timeout, struct biometric_match_result *result)
	Perform biometric matching.
int	biometric_led_control (const struct device *dev, enum biometric_led_state state)
	Control biometric sensor LED.

Detailed Description

Main header file for biometrics driver API.