Biometrics Driver Backend API

Data Structures
struct	biometric_driver_api
	Driver Operations Biometrics driver operations More...

Typedefs
typedef int(*	biometric_api_get_capabilities) (const struct device *dev, struct biometric_capabilities *caps)
	Callback API to get sensor capabilities.
typedef int(*	biometric_api_attr_set) (const struct device *dev, enum biometric_attribute attr, int32_t val)
	Callback API to set a sensor attribute.
typedef int(*	biometric_api_attr_get) (const struct device *dev, enum biometric_attribute attr, int32_t *val)
	Callback API to get a sensor attribute.
typedef int(*	biometric_api_enroll_start) (const struct device *dev, uint16_t template_id)
	Callback API to start enrollment.
typedef int(*	biometric_api_enroll_capture) (const struct device *dev, k_timeout_t timeout, struct biometric_capture_result *result)
	Callback API to capture enrollment samples.
typedef int(*	biometric_api_enroll_finalize) (const struct device *dev)
	Callback API to finalize enrollment.
typedef int(*	biometric_api_enroll_abort) (const struct device *dev)
	Callback API to abort enrollment.
typedef int(*	biometric_api_template_store) (const struct device *dev, uint16_t id, const uint8_t *data, size_t size)
	Callback API to store template.
typedef int(*	biometric_api_template_read) (const struct device *dev, uint16_t id, uint8_t *data, size_t size)
	Callback API to read template data.
typedef int(*	biometric_api_template_delete) (const struct device *dev, uint16_t id)
	Callback API to delete template.
typedef int(*	biometric_api_template_delete_all) (const struct device *dev)
	Callback API to delete all templates.
typedef int(*	biometric_api_template_list) (const struct device *dev, uint16_t *ids, size_t max_count, size_t *actual_count)
	Callback API to list template IDs.
typedef int(*	biometric_api_match) (const struct device *dev, enum biometric_match_mode mode, uint16_t template_id, k_timeout_t timeout, struct biometric_match_result *result)
	Callback API to start matching operation.
typedef int(*	biometric_api_led_control) (const struct device *dev, enum biometric_led_state state)
	Callback API to control LED state.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a Biometrics driver.

Typedef Documentation

biometric_api_attr_get

typedef int(* biometric_api_attr_get) (const struct device *dev, enum biometric_attribute attr, int32_t *val)

#include <zephyr/drivers/biometrics.h>

Callback API to get a sensor attribute.

See biometric_attr_get() for argument description

biometric_api_attr_set

typedef int(* biometric_api_attr_set) (const struct device *dev, enum biometric_attribute attr, int32_t val)

#include <zephyr/drivers/biometrics.h>

Callback API to set a sensor attribute.

See biometric_attr_set() for argument description.

biometric_api_enroll_abort

typedef int(* biometric_api_enroll_abort) (const struct device *dev)

#include <zephyr/drivers/biometrics.h>

Callback API to abort enrollment.

See biometric_enroll_abort() for argument description

biometric_api_enroll_capture

typedef int(* biometric_api_enroll_capture) (const struct device *dev, k_timeout_t timeout, struct biometric_capture_result *result)

#include <zephyr/drivers/biometrics.h>

Callback API to capture enrollment samples.

See biometric_enroll_capture() for argument description

biometric_api_enroll_finalize

typedef int(* biometric_api_enroll_finalize) (const struct device *dev)

#include <zephyr/drivers/biometrics.h>

Callback API to finalize enrollment.

See biometric_enroll_finalize() for argument description

biometric_api_enroll_start

typedef int(* biometric_api_enroll_start) (const struct device *dev, uint16_t template_id)

#include <zephyr/drivers/biometrics.h>

Callback API to start enrollment.

See biometric_enroll_start() for argument description

biometric_api_get_capabilities

typedef int(* biometric_api_get_capabilities) (const struct device *dev, struct biometric_capabilities *caps)

#include <zephyr/drivers/biometrics.h>

Callback API to get sensor capabilities.

See biometric_get_capabilities() for argument description

biometric_api_led_control

typedef int(* biometric_api_led_control) (const struct device *dev, enum biometric_led_state state)

#include <zephyr/drivers/biometrics.h>

Callback API to control LED state.

See biometric_led_control() for argument description

biometric_api_match

typedef int(* biometric_api_match) (const struct device *dev, enum biometric_match_mode mode, uint16_t template_id, k_timeout_t timeout, struct biometric_match_result *result)

#include <zephyr/drivers/biometrics.h>

Callback API to start matching operation.

See biometric_match() for argument description

biometric_api_template_delete

typedef int(* biometric_api_template_delete) (const struct device *dev, uint16_t id)

#include <zephyr/drivers/biometrics.h>

Callback API to delete template.

See biometric_template_delete() for argument description

biometric_api_template_delete_all

typedef int(* biometric_api_template_delete_all) (const struct device *dev)

#include <zephyr/drivers/biometrics.h>

Callback API to delete all templates.

See biometric_template_delete_all() for argument description

biometric_api_template_list

typedef int(* biometric_api_template_list) (const struct device *dev, uint16_t *ids, size_t max_count, size_t *actual_count)

#include <zephyr/drivers/biometrics.h>

Callback API to list template IDs.

See biometric_template_list() for argument description

biometric_api_template_read

typedef int(* biometric_api_template_read) (const struct device *dev, uint16_t id, uint8_t *data, size_t size)

#include <zephyr/drivers/biometrics.h>

Callback API to read template data.

See biometric_template_read() for argument description

biometric_api_template_store

typedef int(* biometric_api_template_store) (const struct device *dev, uint16_t id, const uint8_t *data, size_t size)

#include <zephyr/drivers/biometrics.h>

Callback API to store template.

See biometric_template_store() for argument description