nrf_axon_platform_reserve_for_driver()

bool nrf_axon_platform_reserve_for_driver

(

)

Reserves Axon hardware use for asynchronous job processing by the driver.

This function must not be called from user code!!!

Non-blocking call to reserve the axons hardware for the driver to service the asynchronous command queue. The driver will never call this function more than once before calling nrf_axon_platform_reserve_for_driver(). The driver will always call nrf_axon_platform_reserve_for_driver() exactly once after calling this function.

Note

This function can only fail if there is a synchronous user that owns the reservation via a call to nrf_axon_platform_reserve_for_user(). Since there is no mechanism for the driver to request the reservation again in the future, the function nrf_axon_platform_free_reservation_from_user() must check with the driver to see if it is waiting for the reservation (via nrf_axon_queue_not_empty()) and start it if it is (via nrf_axon_start_queue_processing())

Return values

true	Axon hardware successfully reserved for the driver.
false	Axon hardware is use by a user, unavailable to the driver.