Common APIs

hlml_return_t hlml_init( void )

Operation:

This API should always be called first before any other API can be called.

Return Value:

• HLML_SUCCESS if initialization succeeded.

• HLML_ERROR_UNKNOWN on any unexpected error.

• HLML_ERROR_ALREADY_INITIALIZED if function was already called.

hlml_return_t hlml_init_with_flags( unsigned int mode )

Operation:

This API should always be called first before any other API can be called.

Parameters:

Parameter	Description
Mode	[in] Initialization mode – should be set to 0.

Return Value:

• HLML_SUCCESS if initialization succeeded.

• HLML_ERROR_UNKNOWN on any unexpected error.

• HLML_ERROR_ALREADY_INITIALIZED if function was already called.

hlml_return_t hlml_return_t hlml_shutdown(void)

Operation:

This API should always be called last, after completing all calls to other APIs. The API properly cleans up allocated resources.

Return Value:

• HLML_SUCCESS if shutdown succeeded.

hlml_return_t hlml_device_get_count ( unsigned int* device_count )

Operation:

Retrieves the number of AIP devices in the system.

Parameters:

Parameter	Description
device_count	[out] Reference in which to return the number of accessible AIPs.

Return Value:

• HLML_SUCCESS if device_count has been set.

• HLML_ERROR_UNINITIALIZED if the library has not been successfully initialized.

• HLML_ERROR_INVALID_ARGUMENT if device_count is NULL.

• HLML_ERROR_UNKNOWN on any unexpected error.