Fir list

Classes
struct	face_sdk__fir_list
	List of FIRs for matching. More...

Typedefs
typedef enum face_sdk__architecture_type_t uint32_t struct face_sdk__fir_list	face_sdk__fir_list_t
	List of FIRs for matching.

Functions
bool	face_sdk__fir_list__get_addr (const face_sdk__fir_list_t *fir_list, uint64_t *addr)
	Retrieves face_sdk__fir_list_t object address * *. More...
bool	face_sdk__fir_list__add (const face_sdk__fir_list_t *fir_list, const face_sdk__fir_t *fir, uint32_t *index)
	Adds FIR to the fir list. More...
bool	face_sdk__fir_list__remove (const face_sdk__fir_list_t *fir_list, const uint32_t index, face_sdk__fir_list_removed_item_t **removed_item)
	Removes FIR from the fir list by index. More...
bool	face_sdk__fir_list__get_size (const face_sdk__fir_list_t *fir_list, uint32_t *value)
	Retrieves size of fir list. More...
bool	face_sdk__fir_list__reserve (const face_sdk__fir_list_t *fir_list, const face_sdk__fir_t *fir, uint32_t count)
	Reserves memory for FIRs data. More...
bool	face_sdk__make_fir_list (face_sdk__fir_list_t **fir_list)
	Makes empty fir list object. More...
bool	face_sdk__make_fir_list_1 (enum face_sdk__architecture_type_t type, face_sdk__fir_list_t **fir_list)
	Makes empty fir list object with specified architecture. More...
void	face_sdk__fir_list_free (face_sdk__fir_list_t *fir_list)
	Destroys fir list object. More...

Detailed Description

Function Documentation

face_sdk__fir_list__add()

bool face_sdk__fir_list__add	(	const face_sdk__fir_list_t *	fir_list,
		const face_sdk__fir_t *	fir,
		uint32_t *	index
	)

Adds FIR to the fir list.

Parameters

[in]	fir_list	Fir list object
[in]	fir	Fir object to add
[out]	index	Index of added fir

Returns

true on success, false on failure. See last_error

face_sdk__fir_list__get_addr()

bool face_sdk__fir_list__get_addr	(	const face_sdk__fir_list_t *	fir_list,
		uint64_t *	addr
	)

Retrieves face_sdk__fir_list_t object address * *.

Parameters

[in]	fir_list	face_sdk__fir_list_t object *
[out]	addr	Object address * *

Returns

true on success, false on failure. See last_error

face_sdk__fir_list__get_size()

bool face_sdk__fir_list__get_size	(	const face_sdk__fir_list_t *	fir_list,
		uint32_t *	value
	)

Retrieves size of fir list.

Parameters

[in]	fir_list	Fir list object
[out]	value	Number of firs in fir_list

Returns

true on success, false on failure. See last_error

face_sdk__fir_list__remove()

bool face_sdk__fir_list__remove	(	const face_sdk__fir_list_t *	fir_list,
		const uint32_t	index,
		face_sdk__fir_list_removed_item_t **	removed_item
	)

Removes FIR from the fir list by index.

Parameters

[in]	fir_list	Fir list object
[in]	index	Index of fir to remove
[out]	removed_item	Removed item descriptor

Returns

true on success, false on failure. See last_error

face_sdk__fir_list__reserve()

bool face_sdk__fir_list__reserve	(	const face_sdk__fir_list_t *	fir_list,
		const face_sdk__fir_t *	fir,
		uint32_t	count
	)

Reserves memory for FIRs data.

Parameters

[in]	fir_list	Fir list object
[in]	fir	Reference fir object to determine fir size
[in]	count	Number of items to be stored in fir_list

Returns

true on success, false on failure. See last_error

face_sdk__fir_list_free()

void face_sdk__fir_list_free

(

face_sdk__fir_list_t *

fir_list

)

Destroys fir list object.

Parameters

[in]

fir_list

Fir list object

face_sdk__make_fir_list()

bool face_sdk__make_fir_list

(

face_sdk__fir_list_t **

fir_list

)

Makes empty fir list object.

Parameters

[out]

fir_list

Fir list object

Returns

true on success, false on failure. See last_error

face_sdk__make_fir_list_1()

bool face_sdk__make_fir_list_1	(	enum face_sdk__architecture_type_t	type,
		face_sdk__fir_list_t **	fir_list
	)

Makes empty fir list object with specified architecture.

Parameters

[in]	type	architecture type. Use face_sdk__is_architecture_available to check architecture availability
[out]	fir_list	Fir list object

Returns

true on success, false on failure. See last_error