nrf_axon_driver.h File Reference

#include <stdint.h>
#include <stdbool.h>

Go to the source code of this file.

Data Structures
struct	nrf_axon_cmd_buffer_info_s
	Internal structure supplied by user but managed by the driver to track execution progress. More...
struct	nrf_axon_queued_cmd_info_wrapper_s
	Used as a parameter to nrf_axon_queue_cmd_buf for asynchronous execution. More...

Macros
#define	NRF_AXON_GENERATE_VERSION(major, minor, patch)
#define	NRF_AXON_VERSION   NRF_AXON_GENERATE_VERSION(1, 3, 0)

Typedefs
typedef uint32_t	NRF_AXON_PLATFORM_BITWIDTH_UNSIGNED_TYPE
typedef int32_t	NRF_AXON_PLATFORM_BITWIDTH_SIGNED_TYPE
typedef struct nrf_axon_queued_cmd_info_wrapper_s	nrf_axon_queued_cmd_info_wrapper_s
	Used as a parameter to nrf_axon_queue_cmd_buf for asynchronous execution.

Enumerations
enum	nrf_axon_result_e {   NRF_AXON_RESULT_MUTEX_FAILED = -203 , NRF_AXON_RESULT_INVALID_MODEL = -202 , NRF_AXON_RESULT_BUFFER_TOO_SMALL = -18 , NRF_AXON_RESULT_INVALID_CMD_BUF = -17 ,   NRF_AXON_RESULT_FAILURE_MISSING_NULL_COEF = -14 , NRF_AXON_RESULT_NULL_BUFFER = -13 , NRF_AXON_RESULT_FAILURE_INVALID_ROUNDING = -12 , NRF_AXON_RESULT_FAILURE_MISALIGNED_BUFFER = -7 ,   NRF_AXON_RESULT_FAILURE_UNSUPPORTED_HARDWARE = -6 , NRF_AXON_RESULT_FAILURE_HARDWARE_ERROR = -5 , NRF_AXON_RESULT_FAILURE_INVALID_LENGTH = -2 , NRF_AXON_RESULT_FAILURE = -1 ,   NRF_AXON_RESULT_SUCCESS = 0 , NRF_AXON_RESULT_NOT_FINISHED = 1 , NRF_AXON_RESULT_EVENT_PENDING = 3 }
	Axon driver return codes. More...
enum	nrf_axon_syncmode_blocking_e {   NRF_AXON_SYNC_MODE_BLOCKING_INVALID , NRF_AXON_SYNC_MODE_BLOCKING_POLLING , NRF_AXON_SYNC_MODE_BLOCKING_EVENT , NRF_AXON_SYNC_MODE_BLOCKING_DEFERRED ,   NRF_AXON_SYNC_MODE_BLOCKING_COUNT }
	Specifies the blocking mechanism for synchronous Axon command buffer execution. More...

Functions
nrf_axon_result_e	nrf_axon_queue_cmd_buf (nrf_axon_queued_cmd_info_wrapper_s *cmd_buf_wrapper)
	Asynchronous command buffer execution.
nrf_axon_result_e	nrf_axon_run_cmd_buf_sync (nrf_axon_cmd_buffer_info_s *cmd_buf_info, nrf_axon_syncmode_blocking_e block_mode, bool keep_reservation)
	Synchronous command buffer execution.
nrf_axon_result_e	nrf_axon_init_command_buffer_info (nrf_axon_cmd_buffer_info_s *cmd_buf_info_ptr, const NRF_AXON_PLATFORM_BITWIDTH_UNSIGNED_TYPE *cmd_buf, uint32_t buffer_length)
	binds a command buffer to an nrf_axon_cmd_buffer_info_s struct and initializes it. Need only be called once per command buffer.