nrf_axon_driver.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdbool.h>
 
#define NRF_AXON_GENERATE_VERSION(major, minor, patch) \
        (((major) << 16) | ((minor) << 8) | (patch))
#define NRF_AXON_VERSION NRF_AXON_GENERATE_VERSION(2, 0, 1)
 
 
#if !defined(AXON_FORCE_32BIT_ADDR) && \
        ((defined(__SIZEOF_POINTER__) && (__SIZEOF_POINTER__ == 8)) || \
         defined(_WIN64))
typedef uint64_t NRF_AXON_PLATFORM_BITWIDTH_UNSIGNED_TYPE;
typedef int64_t NRF_AXON_PLATFORM_BITWIDTH_SIGNED_TYPE;
#else
typedef uint32_t NRF_AXON_PLATFORM_BITWIDTH_UNSIGNED_TYPE;
typedef int32_t NRF_AXON_PLATFORM_BITWIDTH_SIGNED_TYPE;
#endif
 
#ifdef NRF_AXON_SIMULATION
# define NRF_AXON_CMD_BUFFER_ALIGN
#else
# define NRF_AXON_CMD_BUFFER_ALIGN alignas(8)
#endif
 
#define NRF_AXON_CEIL_BITS(x, y) ((((((x)+(1<<(y))-1)))>>(y))<<(y))
#define NRF_AXON_NPU_OUTPUT_STRIDE(width, byte_width) NRF_AXON_CEIL_BITS((width)*(byte_width), 2)
 
typedef enum {
        /* driver version does not support the model  */
        NRF_AXON_RESULT_DRIVER_VERSION_TOO_OLD        = -205,
        /* too many intrinsics using intrinsics  */
        NRF_AXON_RESULT_TOO_MANY_NESTED_SYNC_CMDS     = -204,
        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,
} nrf_axon_result_e;
 
typedef struct {
        uint32_t length;
        const NRF_AXON_PLATFORM_BITWIDTH_UNSIGNED_TYPE *cmd_buf_ptr;
        uint32_t cur_segment_offset;
} nrf_axon_cmd_buffer_info_s;
 
typedef enum {
        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,
} nrf_axon_syncmode_blocking_e;
 
 
typedef struct nrf_axon_queued_cmd_info_wrapper_s {
        nrf_axon_cmd_buffer_info_s *cmd_buf_info;
        void *callback_context;
        void (*callback_function)(nrf_axon_result_e result, void *callback_context);
        void (*copy_input_function)(void *callback_context);
        void (*copy_result_function)(void *callback_context);
        struct nrf_axon_queued_cmd_info_wrapper_s *next;
} nrf_axon_queued_cmd_info_wrapper_s;
 
nrf_axon_result_e nrf_axon_queue_cmd_buf(nrf_axon_queued_cmd_info_wrapper_s *cmd_buf_wrapper);
 
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);
 
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);
 
#ifdef __cplusplus
}
#endif