as608 basic driver modules More...

Data Structures
struct	as608_params_s
	as608 params structure definition More...

struct	as608_handle_s
	as608 handle structure definition More...

struct	as608_info_s
	as608 information structure definition More...

Typedefs
typedef struct as608_params_s	as608_params_t
	as608 params structure definition More...

typedef struct as608_handle_s	as608_handle_t
	as608 handle structure definition More...

typedef struct as608_info_s	as608_info_t
	as608 information structure definition More...

Enumerations
enum	as608_bool_t { AS608_BOOL_FALSE = 0x00 , AS608_BOOL_TRUE = 0x01 }
	as608 bool enumeration definition More...

enum	as608_level_t { AS608_LEVEL_1 = 0x0001 , AS608_LEVEL_2 = 0x0002 , AS608_LEVEL_3 = 0x0003 , AS608_LEVEL_4 = 0x0004 , AS608_LEVEL_5 = 0x0005 }
	as608 level enumeration definition More...

enum	as608_packet_size_t { AS608_PACKET_SIZE_32_BYTES = 0x0000 , AS608_PACKET_SIZE_64_BYTES = 0x0001 , AS608_PACKET_SIZE_128_BYTES = 0x0002 , AS608_PACKET_SIZE_256_BYTES = 0x0003 }
	as608 packet size enumeration definition More...

enum	as608_buffer_number_t { AS608_BUFFER_NUMBER_1 = 0x01 , AS608_BUFFER_NUMBER_2 = 0x02 }
	as608 buffer number enumeration definition More...

enum	as608_sensor_type_t { AS608_SENSOR_TYPE_FPC1011C = 0x0000 , AS608_SENSOR_TYPE_C500 = 0x0002 , AS608_SENSOR_TYPE_S500 = 0x0003 , AS608_SENSOR_TYPE_XWSEMI = 0x0007 , AS608_SENSOR_TYPE_CUSTOM = 0x0009 }
	as608 sensor type enumeration definition More...

enum	as608_burn_code_mode_t { AS608_BURN_CODE_MODE_INFO = 0x00 , AS608_BURN_CODE_MODE_FULL = 0x01 }
	as608 burn code mode enumeration definition More...

enum	as608_image_t { AS608_IMAGE_BIN = 0x00 , AS608_IMAGE_NO_FEATURE = 0x01 , AS608_IMAGE_FEATURE = 0x02 }
	as608 image enumeration definition More...

enum	as608_gpio_number_t { AS608_GPIO_NUMBER_0 = 0x00 , AS608_GPIO_NUMBER_1 = 0x01 }
	as608 gpio number enumeration definition More...

enum	as608_gpio_level_t { AS608_GPIO_LEVEL_LOW = 0x00 , AS608_GPIO_LEVEL_HIGH = 0x01 }
	as608 gpio level enumeration definition More...

enum	as608_status_t { AS608_STATUS_OK = 0x00 , AS608_STATUS_FRAME_ERROR = 0x01 , AS608_STATUS_NO_FINGERPRINT = 0x02 , AS608_STATUS_INPUT_ERROR = 0x03 , AS608_STATUS_IMAGE_TOO_DRY = 0x04 , AS608_STATUS_IMAGE_TOO_WET = 0x05 , AS608_STATUS_IMAGE_TOO_CLUTTER = 0x06 , AS608_STATUS_IMAGE_TOO_FEW_FEATURE = 0x07 , AS608_STATUS_NOT_MATCH = 0x08 , AS608_STATUS_NOT_FOUND = 0x09 , AS608_STATUS_FEATURE_COMBINE_ERROR = 0x0A , AS608_STATUS_LIB_ADDR_OVER = 0x0B , AS608_STATUS_LIB_READ_ERROR = 0x0C , AS608_STATUS_UPLOAD_FEATURE_ERROR = 0x0D , AS608_STATUS_NO_FRAME = 0x0E , AS608_STATUS_UPLOAD_IMAGE_ERROR = 0x0F , AS608_STATUS_LIB_DELETE_ERROR = 0x10 , AS608_STATUS_LIB_CLEAR_ERROR = 0x11 , AS608_STATUS_ENTER_LOW_POWER_ERROR = 0x12 , AS608_STATUS_COMMAND_INVALID = 0x13 , AS608_STATUS_RESET_ERROR = 0x14 , AS608_STATUS_BUFFER_INVALID = 0x15 , AS608_STATUS_UPDATE_ERROR = 0x16 , AS608_STATUS_NO_MOVE = 0x17 , AS608_STATUS_FLASH_ERROR = 0x18 , AS608_STATUS_F0_RESPONSE = 0xF0 , AS608_STATUS_F1_RESPONSE = 0xF1 , AS608_STATUS_FLASH_WRITE_SUM_ERROR = 0xF2 , AS608_STATUS_FLASH_WRITE_HEADER_ERROR = 0xF3 , AS608_STATUS_FLASH_WRITE_LENGTH_ERROR = 0xF4 , AS608_STATUS_FLASH_WRITE_LENGTH_TOO_LONG = 0xF5 , AS608_STATUS_FLASH_WRITE_ERROR = 0xF6 , AS608_STATUS_UNKNOWN = 0x19 , AS608_STATUS_REG_INVALID = 0x1A , AS608_STATUS_DATA_INVALID = 0x1B , AS608_STATUS_NOTE_PAGE_INVALID = 0x1C , AS608_STATUS_PORT_INVALID = 0x1D , AS608_STATUS_ENROOL_ERROR = 0x1E , AS608_STATUS_LIB_FULL = 0x1F }
	as608 status enumeration definition More...

Functions
uint8_t	as608_info (as608_info_t *info)
	get chip's information More...

uint8_t	as608_init (as608_handle_t *handle, uint32_t addr)
	initialize the chip More...

uint8_t	as608_deinit (as608_handle_t *handle)
	close the chip More...

uint8_t	as608_get_last_status (as608_handle_t handle, as608_status_t status)
	get the last status More...

uint8_t	as608_print_status (as608_handle_t *handle, as608_status_t status)
	print status More...

uint8_t	as608_get_image (as608_handle_t handle, uint32_t addr, as608_status_t status)
	get image More...

uint8_t	as608_generate_feature (as608_handle_t handle, uint32_t addr, as608_buffer_number_t num, as608_status_t status)
	generate feature More...

uint8_t	as608_match_feature (as608_handle_t handle, uint32_t addr, uint16_t score, as608_status_t *status)
	match feature More...

uint8_t	as608_search_feature (as608_handle_t handle, uint32_t addr, as608_buffer_number_t num, uint16_t start_page, uint16_t page_number, uint16_t found_page, uint16_t score, as608_status_t status)
	search feature More...

uint8_t	as608_combine_feature (as608_handle_t handle, uint32_t addr, as608_status_t status)
	combine feature More...

uint8_t	as608_store_feature (as608_handle_t handle, uint32_t addr, as608_buffer_number_t num, uint16_t page_number, as608_status_t status)
	store feature More...

uint8_t	as608_load_feature (as608_handle_t handle, uint32_t addr, as608_buffer_number_t num, uint16_t page_number, as608_status_t status)
	load feature More...

uint8_t	as608_upload_feature (as608_handle_t handle, uint32_t addr, as608_buffer_number_t num, uint8_t output_buffer, uint16_t output_len, as608_status_t status)
	upload feature More...

uint8_t	as608_download_feature (as608_handle_t handle, uint32_t addr, as608_buffer_number_t num, uint8_t input_buffer, uint16_t input_len, as608_status_t *status)
	download feature More...

uint8_t	as608_upload_image (as608_handle_t handle, uint32_t addr, uint8_t output_buffer, uint16_t output_len, as608_status_t status)
	upload image More...

uint8_t	as608_download_image (as608_handle_t handle, uint32_t addr, uint8_t input_buffer, uint16_t input_len, as608_status_t *status)
	download image More...

uint8_t	as608_delete_feature (as608_handle_t handle, uint32_t addr, uint16_t page_number, uint16_t number, as608_status_t status)
	delete feature More...

uint8_t	as608_empty_all_feature (as608_handle_t handle, uint32_t addr, as608_status_t status)
	empty all feature More...

uint8_t	as608_set_baud_rate (as608_handle_t handle, uint32_t addr, uint8_t n_9600, as608_status_t status)
	set baud rate More...

uint8_t	as608_set_level (as608_handle_t handle, uint32_t addr, as608_level_t level, as608_status_t status)
	set level More...

uint8_t	as608_set_packet_size (as608_handle_t handle, uint32_t addr, as608_packet_size_t size, as608_status_t status)
	set packet size More...

uint8_t	as608_get_params (as608_handle_t handle, uint32_t addr, as608_params_t param, as608_status_t *status)
	get params More...

uint8_t	as608_enroll (as608_handle_t handle, uint32_t addr, uint16_t page_number, as608_status_t *status)
	enroll More...

uint8_t	as608_identify (as608_handle_t handle, uint32_t addr, uint16_t page_number, uint16_t score, as608_status_t status)
	identify More...

uint8_t	as608_set_password (as608_handle_t handle, uint32_t addr, uint32_t password, as608_status_t status)
	set password More...

uint8_t	as608_verify_password (as608_handle_t handle, uint32_t addr, uint32_t password, as608_status_t status)
	verify password More...

uint8_t	as608_get_random (as608_handle_t handle, uint32_t addr, uint32_t randn, as608_status_t *status)
	get random More...

uint8_t	as608_set_chip_address (as608_handle_t handle, uint32_t addr, uint32_t new_addr, as608_status_t status)
	set the chip address More...

uint8_t	as608_get_flash_information (as608_handle_t handle, uint32_t addr, uint8_t output_buffer, uint16_t output_len, as608_status_t status)
	get flash information More...

uint8_t	as608_set_port (as608_handle_t handle, uint32_t addr, as608_bool_t enable, as608_status_t status)
	enable or disable port More...

uint8_t	as608_write_notepad (as608_handle_t handle, uint32_t addr, uint8_t page_number, uint8_t data[32], as608_status_t status)
	write notepad More...

uint8_t	as608_read_notepad (as608_handle_t handle, uint32_t addr, uint8_t page_number, uint8_t data[32], as608_status_t status)
	read notepad More...

uint8_t	as608_burn_code (as608_handle_t handle, uint32_t addr, as608_burn_code_mode_t mode, uint8_t input_buffer, uint16_t input_len, as608_status_t *status)
	burn code More...

uint8_t	as608_high_speed_search (as608_handle_t handle, uint32_t addr, as608_buffer_number_t buffer_number, uint16_t start_page, uint16_t page_number, uint16_t found_page, uint16_t score, as608_status_t status)
	high speed search More...

uint8_t	as608_generate_bin_image (as608_handle_t handle, uint32_t addr, as608_image_t image, as608_status_t status)
	generate bin image More...

uint8_t	as608_get_valid_template_number (as608_handle_t handle, uint32_t addr, uint16_t num, as608_status_t *status)
	get valid template number More...

uint8_t	as608_set_gpio_level (as608_handle_t handle, uint32_t addr, as608_gpio_number_t gpio, as608_gpio_level_t input_level, as608_gpio_level_t output_level, as608_status_t *status)
	set gpio level More...

uint8_t	as608_get_index_table (as608_handle_t handle, uint32_t addr, uint8_t num, uint8_t table[32], as608_status_t status)
	get index table More...

Detailed Description

as608 basic driver modules

Typedef Documentation

◆ as608_handle_t

typedef struct as608_handle_s as608_handle_t

as608 handle structure definition

◆ as608_info_t

typedef struct as608_info_s as608_info_t

as608 information structure definition

◆ as608_params_t

typedef struct as608_params_s as608_params_t

as608 params structure definition

Enumeration Type Documentation

◆ as608_bool_t

enum as608_bool_t

as608 bool enumeration definition

Enumerator
AS608_BOOL_FALSE	disable
AS608_BOOL_TRUE	enable

Definition at line 62 of file driver_as608.h.

◆ as608_buffer_number_t

enum as608_buffer_number_t

as608 buffer number enumeration definition

Enumerator
AS608_BUFFER_NUMBER_1	buffer 1
AS608_BUFFER_NUMBER_2	buffer 2

Definition at line 94 of file driver_as608.h.

◆ as608_burn_code_mode_t

enum as608_burn_code_mode_t

as608 burn code mode enumeration definition

Enumerator
AS608_BURN_CODE_MODE_INFO	only flash info
AS608_BURN_CODE_MODE_FULL	full

Definition at line 115 of file driver_as608.h.

◆ as608_gpio_level_t

enum as608_gpio_level_t

as608 gpio level enumeration definition

Enumerator
AS608_GPIO_LEVEL_LOW	level low
AS608_GPIO_LEVEL_HIGH	level high

Definition at line 143 of file driver_as608.h.

◆ as608_gpio_number_t

enum as608_gpio_number_t

as608 gpio number enumeration definition

Enumerator
AS608_GPIO_NUMBER_0	number 0
AS608_GPIO_NUMBER_1	number 1

Definition at line 134 of file driver_as608.h.

◆ as608_image_t

enum as608_image_t

as608 image enumeration definition

Enumerator
AS608_IMAGE_BIN	bin image
AS608_IMAGE_NO_FEATURE	no feature
AS608_IMAGE_FEATURE	feature

Definition at line 124 of file driver_as608.h.

◆ as608_level_t

enum as608_level_t

as608 level enumeration definition

Enumerator
AS608_LEVEL_1	level 1
AS608_LEVEL_2	level 2
AS608_LEVEL_3	level 3
AS608_LEVEL_4	level 4
AS608_LEVEL_5	level 5

Definition at line 71 of file driver_as608.h.

◆ as608_packet_size_t

enum as608_packet_size_t

as608 packet size enumeration definition

Enumerator
AS608_PACKET_SIZE_32_BYTES	32 bytes
AS608_PACKET_SIZE_64_BYTES	64 bytes
AS608_PACKET_SIZE_128_BYTES	128 bytes
AS608_PACKET_SIZE_256_BYTES	256 bytes

Definition at line 83 of file driver_as608.h.

◆ as608_sensor_type_t

enum as608_sensor_type_t

as608 sensor type enumeration definition

Enumerator
AS608_SENSOR_TYPE_FPC1011C	fpc1011c
AS608_SENSOR_TYPE_C500	c500
AS608_SENSOR_TYPE_S500	s500
AS608_SENSOR_TYPE_XWSEMI	xwsemi
AS608_SENSOR_TYPE_CUSTOM	custom

Definition at line 103 of file driver_as608.h.

◆ as608_status_t

enum as608_status_t

as608 status enumeration definition

Enumerator
AS608_STATUS_OK	ok
AS608_STATUS_FRAME_ERROR	frame error
AS608_STATUS_NO_FINGERPRINT	no fingerprint
AS608_STATUS_INPUT_ERROR	fingerprint image error
AS608_STATUS_IMAGE_TOO_DRY	fingerprint image too dry
AS608_STATUS_IMAGE_TOO_WET	fingerprint image too wet
AS608_STATUS_IMAGE_TOO_CLUTTER	fingerprint too clutter
AS608_STATUS_IMAGE_TOO_FEW_FEATURE	fingerprint feature too few
AS608_STATUS_NOT_MATCH	not match
AS608_STATUS_NOT_FOUND	not found
AS608_STATUS_FEATURE_COMBINE_ERROR	feature combine error
AS608_STATUS_LIB_ADDR_OVER	fingerprint lib addr is over
AS608_STATUS_LIB_READ_ERROR	fingerprint lib read error
AS608_STATUS_UPLOAD_FEATURE_ERROR	upload feature error
AS608_STATUS_NO_FRAME	no frame
AS608_STATUS_UPLOAD_IMAGE_ERROR	upload image error
AS608_STATUS_LIB_DELETE_ERROR	delete lib error
AS608_STATUS_LIB_CLEAR_ERROR	clear lib error
AS608_STATUS_ENTER_LOW_POWER_ERROR	enter low power error
AS608_STATUS_COMMAND_INVALID	command invalid
AS608_STATUS_RESET_ERROR	reset error
AS608_STATUS_BUFFER_INVALID	buffer invalid
AS608_STATUS_UPDATE_ERROR	update error
AS608_STATUS_NO_MOVE	no move
AS608_STATUS_FLASH_ERROR	flash error
AS608_STATUS_F0_RESPONSE	f0 response
AS608_STATUS_F1_RESPONSE	f1 response
AS608_STATUS_FLASH_WRITE_SUM_ERROR	flash sum error
AS608_STATUS_FLASH_WRITE_HEADER_ERROR	flash header error
AS608_STATUS_FLASH_WRITE_LENGTH_ERROR	flash length error
AS608_STATUS_FLASH_WRITE_LENGTH_TOO_LONG	flash length too long
AS608_STATUS_FLASH_WRITE_ERROR	flash write error
AS608_STATUS_UNKNOWN	unknown
AS608_STATUS_REG_INVALID	reg invalid
AS608_STATUS_DATA_INVALID	data invalid
AS608_STATUS_NOTE_PAGE_INVALID	note page invalid
AS608_STATUS_PORT_INVALID	port invalid
AS608_STATUS_ENROOL_ERROR	enrool error
AS608_STATUS_LIB_FULL	lib full

Definition at line 152 of file driver_as608.h.

Function Documentation

◆ as608_burn_code()

uint8_t as608_burn_code	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_burn_code_mode_t	mode,
		uint8_t *	input_buffer,
		uint16_t	input_len,
		as608_status_t *	status
	)

burn code

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	mode	burn mode
[in]	*input_buffer	pointer to an input buffer
[in]	input_len	input length
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 burn code failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 2706 of file driver_as608.c.

◆ as608_combine_feature()

uint8_t as608_combine_feature	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_status_t *	status
	)

combine feature

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 combine feature failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 908 of file driver_as608.c.

◆ as608_deinit()

uint8_t as608_deinit ( as608_handle_t * handle )

close the chip

Parameters

[in] *handle pointer to an as608 handle structure

Returns

status code

0 success
1 uart deinit failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 575 of file driver_as608.c.

◆ as608_delete_feature()

uint8_t as608_delete_feature	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint16_t	page_number,
		uint16_t	number,
		as608_status_t *	status
	)

delete feature

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	page_number	page number
[in]	number	deleted number
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 delete feature failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 1573 of file driver_as608.c.

◆ as608_download_feature()

uint8_t as608_download_feature	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_buffer_number_t	num,
		uint8_t *	input_buffer,
		uint16_t	input_len,
		as608_status_t *	status
	)

download feature

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	num	buffer num
[in]	*input_buffer	pointer to an input buffer
[in]	input_len	input length
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 download feature failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 1220 of file driver_as608.c.

◆ as608_download_image()

uint8_t as608_download_image	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint8_t *	input_buffer,
		uint16_t	input_len,
		as608_status_t *	status
	)

download image

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	*input_buffer	pointer to an input buffer
[in]	input_len	input length
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 download image failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 1450 of file driver_as608.c.

◆ as608_empty_all_feature()

uint8_t as608_empty_all_feature	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_status_t *	status
	)

empty all feature

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 empty all feature failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 1640 of file driver_as608.c.

◆ as608_enroll()

uint8_t as608_enroll	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint16_t *	page_number,
		as608_status_t *	status
	)

enroll

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[out]	*page_number	pointer to a page number buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 enroll failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 1981 of file driver_as608.c.

◆ as608_generate_bin_image()

uint8_t as608_generate_bin_image	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_image_t	image,
		as608_status_t *	status
	)

generate bin image

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	image	image type
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 generate bin image failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 2907 of file driver_as608.c.

◆ as608_generate_feature()

uint8_t as608_generate_feature	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_buffer_number_t	num,
		as608_status_t *	status
	)

generate feature

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	num	buffer number
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 generate feature failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 702 of file driver_as608.c.

◆ as608_get_flash_information()

uint8_t as608_get_flash_information	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint8_t *	output_buffer,
		uint16_t *	output_len,
		as608_status_t *	status
	)

get flash information

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[out]	*output_buffer	pointer to an output buffer
[in,out]	*output_len	pointer to an output length buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 get flash information failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid
7 buffer is full

Note: none

Definition at line 2387 of file driver_as608.c.

◆ as608_get_image()

uint8_t as608_get_image	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_status_t *	status
	)

get image

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 get image failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 638 of file driver_as608.c.

◆ as608_get_index_table()

uint8_t as608_get_index_table	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint8_t	num,
		uint8_t	table[32],
		as608_status_t *	status
	)

get index table

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	num	index number
[out]	*table	pointer to a table buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 get index table failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid
7 num > 3

Note: none

Definition at line 3109 of file driver_as608.c.

◆ as608_get_last_status()

uint8_t as608_get_last_status	(	as608_handle_t *	handle,
		as608_status_t *	status
	)

get the last status

Parameters

[in]	*handle	pointer to an as608 handle structure
[out]	*status	pointer to a status buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 607 of file driver_as608.c.

◆ as608_get_params()

uint8_t as608_get_params	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_params_t *	param,
		as608_status_t *	status
	)

get params

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[out]	*param	pointer to a param structure
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 get params failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 1904 of file driver_as608.c.

◆ as608_get_random()

uint8_t as608_get_random	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint32_t *	randn,
		as608_status_t *	status
	)

get random

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[out]	*randn	pointer to a random buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 get random failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 2249 of file driver_as608.c.

◆ as608_get_valid_template_number()

uint8_t as608_get_valid_template_number	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint16_t *	num,
		as608_status_t *	status
	)

get valid template number

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[out]	*num	pointer to a number buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 get valid template number failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 2972 of file driver_as608.c.

◆ as608_high_speed_search()

uint8_t as608_high_speed_search	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_buffer_number_t	buffer_number,
		uint16_t	start_page,
		uint16_t	page_number,
		uint16_t *	found_page,
		uint16_t *	score,
		as608_status_t *	status
	)

high speed search

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	buffer_number	buffer number
[in]	start_page	start page
[in]	page_number	page number
[out]	*found_page	pointer to a found page buffer
[out]	*score	pointer to a score buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 high speed search failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 2833 of file driver_as608.c.

◆ as608_identify()

uint8_t as608_identify	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint16_t *	page_number,
		uint16_t *	score,
		as608_status_t *	status
	)

identify

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[out]	*page_number	pointer to a page number buffer
[out]	*score	pointer to a score buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 identify failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 2047 of file driver_as608.c.

◆ as608_info()

uint8_t as608_info ( as608_info_t * info )

get chip's information

Parameters

[out] *info pointer to an as608 info structure

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 3499 of file driver_as608.c.

◆ as608_init()

uint8_t as608_init	(	as608_handle_t *	handle,
		uint32_t	addr
	)

initialize the chip

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address

Returns

status code

0 success
1 uart initialization failed
2 handle is NULL
3 linked functions is NULL
4 read params failed

Note: none

Definition at line 465 of file driver_as608.c.

◆ as608_load_feature()

uint8_t as608_load_feature	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_buffer_number_t	num,
		uint16_t	page_number,
		as608_status_t *	status
	)

load feature

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	num	buffer num
[in]	page_number	page number
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 load feature failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 1042 of file driver_as608.c.

◆ as608_match_feature()

uint8_t as608_match_feature	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint16_t *	score,
		as608_status_t *	status
	)

match feature

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[out]	*score	pointer to a score buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 match feature failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 767 of file driver_as608.c.

◆ as608_print_status()

uint8_t as608_print_status	(	as608_handle_t *	handle,
		as608_status_t	status
	)

print status

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	status	print status

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3176 of file driver_as608.c.

◆ as608_read_notepad()

uint8_t as608_read_notepad	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint8_t	page_number,
		uint8_t	data[32],
		as608_status_t *	status
	)

read notepad

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	page_number	page number
[out]	*data	pointer to an output buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 read notepad failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid
7 page_number > 16

Note: 0 <= page_number <= 15

Definition at line 2632 of file driver_as608.c.

◆ as608_search_feature()

uint8_t as608_search_feature	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_buffer_number_t	num,
		uint16_t	start_page,
		uint16_t	page_number,
		uint16_t *	found_page,
		uint16_t *	score,
		as608_status_t *	status
	)

search feature

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	num	buffer num
[in]	start_page	start page
[in]	page_number	page number
[out]	*found_page	pointer to a found page buffer
[out]	*score	pointer to a score buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 search feature failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 836 of file driver_as608.c.

◆ as608_set_baud_rate()

uint8_t as608_set_baud_rate	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint8_t	n_9600,
		as608_status_t *	status
	)

set baud rate

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	n_9600	n times of 9600
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 set baud rate failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 1704 of file driver_as608.c.

◆ as608_set_chip_address()

uint8_t as608_set_chip_address	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint32_t	new_addr,
		as608_status_t *	status
	)

set the chip address

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	new_addr	new address
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 set chip address failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 2317 of file driver_as608.c.

◆ as608_set_gpio_level()

uint8_t as608_set_gpio_level	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_gpio_number_t	gpio,
		as608_gpio_level_t	input_level,
		as608_gpio_level_t *	output_level,
		as608_status_t *	status
	)

set gpio level

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	gpio	gpio number
[in]	input_level	input level
[out]	*output_level	pointer to an output level buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 set gpio level failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 3039 of file driver_as608.c.

◆ as608_set_level()

uint8_t as608_set_level	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_level_t	level,
		as608_status_t *	status
	)

set level

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	level	input level
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 set level failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 1770 of file driver_as608.c.

◆ as608_set_packet_size()

uint8_t as608_set_packet_size	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_packet_size_t	size,
		as608_status_t *	status
	)

set packet size

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	size	packet size
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 set packet size failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 1836 of file driver_as608.c.

◆ as608_set_password()

uint8_t as608_set_password	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint32_t	password,
		as608_status_t *	status
	)

set password

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	password	set password
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 set password failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 2113 of file driver_as608.c.

◆ as608_set_port()

uint8_t as608_set_port	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_bool_t	enable,
		as608_status_t *	status
	)

enable or disable port

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	enable	bool value
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 set port failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 2491 of file driver_as608.c.

◆ as608_store_feature()

uint8_t as608_store_feature	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_buffer_number_t	num,
		uint16_t	page_number,
		as608_status_t *	status
	)

store feature

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	num	buffer num
[in]	page_number	page number
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 store feature failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 973 of file driver_as608.c.

◆ as608_upload_feature()

uint8_t as608_upload_feature	(	as608_handle_t *	handle,
		uint32_t	addr,
		as608_buffer_number_t	num,
		uint8_t *	output_buffer,
		uint16_t *	output_len,
		as608_status_t *	status
	)

upload feature

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	num	buffer num
[out]	*output_buffer	pointer to an output buffer
[in,out]	*output_len	pointer to an output length buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 upload feature failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid
7 buffer is full

Note: none

Definition at line 1113 of file driver_as608.c.

◆ as608_upload_image()

uint8_t as608_upload_image	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint8_t *	output_buffer,
		uint16_t *	output_len,
		as608_status_t *	status
	)

upload image

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[out]	*output_buffer	pointer to an output buffer
[in,out]	*output_len	pointer to an output length buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 upload image failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid
7 buffer is full

Note: none

Definition at line 1345 of file driver_as608.c.

◆ as608_verify_password()

uint8_t as608_verify_password	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint32_t	password,
		as608_status_t *	status
	)

verify password

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	password	verify password
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 verify password failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid

Note: none

Definition at line 2181 of file driver_as608.c.

◆ as608_write_notepad()

uint8_t as608_write_notepad	(	as608_handle_t *	handle,
		uint32_t	addr,
		uint8_t	page_number,
		uint8_t	data[32],
		as608_status_t *	status
	)

write notepad

Parameters

[in]	*handle	pointer to an as608 handle structure
[in]	addr	chip address
[in]	page_number	page number
[in]	*data	pointer to an input buffer
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 write notepad failed
2 handle is NULL
3 handle is not initialized
4 decode failed
5 addr is invalid
6 len is invalid
7 page_number > 16

Note: 0 <= page_number <= 15

Definition at line 2558 of file driver_as608.c.

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ as608_handle_t

◆ as608_info_t

◆ as608_params_t

Enumeration Type Documentation

◆ as608_bool_t

◆ as608_buffer_number_t

◆ as608_burn_code_mode_t

◆ as608_gpio_level_t

◆ as608_gpio_number_t

◆ as608_image_t

◆ as608_level_t

◆ as608_packet_size_t

◆ as608_sensor_type_t

◆ as608_status_t

Function Documentation

◆ as608_burn_code()

◆ as608_combine_feature()

◆ as608_deinit()

◆ as608_delete_feature()

◆ as608_download_feature()

◆ as608_download_image()

◆ as608_empty_all_feature()

◆ as608_enroll()

◆ as608_generate_bin_image()

◆ as608_generate_feature()

◆ as608_get_flash_information()

◆ as608_get_image()

◆ as608_get_index_table()

◆ as608_get_last_status()

◆ as608_get_params()

◆ as608_get_random()

◆ as608_get_valid_template_number()

◆ as608_high_speed_search()

◆ as608_identify()

◆ as608_info()

◆ as608_init()

◆ as608_load_feature()

◆ as608_match_feature()

◆ as608_print_status()

◆ as608_read_notepad()

◆ as608_search_feature()

◆ as608_set_baud_rate()

◆ as608_set_chip_address()

◆ as608_set_gpio_level()

◆ as608_set_level()

◆ as608_set_packet_size()

◆ as608_set_password()

◆ as608_set_port()

◆ as608_store_feature()

◆ as608_upload_feature()

◆ as608_upload_image()

◆ as608_verify_password()

◆ as608_write_notepad()