Web Analytics

Kneron PLUS data structure

Include Header File: kp_struct.h

Defines

Define Value Description
APP_PADDING_BYTES 28 Default padding size
KP_MAX_INPUT_NODE_COUNT 50 Supported maximum number of the model input node (Note: The KL520, KL720, and KL630 only support maximum 5 inputs.)
KP_MAX_MODEL_COUNT 16 Supported maximum number of the models (Note: The KL520, KL720, and KL630 only support maximum 16 models.)
KDP2_MAGIC_TYPE_COMMAND 0xAB67CD13 Magic number for data check
KDP2_MAGIC_TYPE_INFERENCE 0x11FF22AA Magic number for data check
KDP2_MAGIC_TYPE_INFERENCE_V2 0x11FF22AB Magic number for data check
KDP2_MAGIC_TYPE_CUSTOMIZED 0x11FF33CC Magic number for customized data
KDP2_MAGIC_TYPE_CHECKPOINT_DATA 0x34ABF977 Magic number for debug checkpoint data
KDP2_MAGIC_TYPE_CHECKPOINT_DATA_V2 0x34ABF978 Magic number for debug checkpoint data
KDP2_MAGIC_TYPE_JSON 0x22EE3A86 Magic number for json file stream
MAX_CROP_BOX 4 MAX crop count
YOLO_GOOD_BOX_MAX 500 maximum number of bounding boxes for Yolo models
LAND_MARK_POINTS 5 the number of land marks points
FR_FEAT_LENGTH 256 the length of one feature map

Simple Typedefs

typedef kp_device_group_s *kp_device_group_t;

a pointer handle represent connected Kneron device.

Enumerations

KP_API_RETURN_CODE

enum KP_API_RETURN_CODE {...}

return code of most APIs.

Enumerator
KP_SUCCESS = 0,
KP_ERROR_USB_IO_N1 = -1,
KP_ERROR_USB_INVALID_PARAM_N2 = -2,
KP_ERROR_USB_ACCESS_N3 = -3,
KP_ERROR_USB_NO_DEVICE_N4 = -4,
KP_ERROR_USB_NOT_FOUND_N5 = -5,
KP_ERROR_USB_BUSY_N6 = -6,
KP_ERROR_USB_TIMEOUT_N7 = -7,
KP_ERROR_USB_OVERFLOW_N8 = -8,
KP_ERROR_USB_PIPE_N9 = -9,
KP_ERROR_USB_INTERRUPTED_N10 = -10,
KP_ERROR_USB_NO_MEM_N11 = -11,
KP_ERROR_USB_NOT_SUPPORTED_N12 = -12,
KP_ERROR_USB_OTHER_N99 = -99,
KP_ERROR_WDI_BEGIN = -200,
KP_ERROR_WDI_IO_N1 = -201,
KP_ERROR_WDI_INVALID_PARAM_N2 = -202,
KP_ERROR_WDI_ACCESS_N3 = -203,
KP_ERROR_WDI_NO_DEVICE_N4 = -204,
KP_ERROR_WDI_NOT_FOUND_N5 = -205,
KP_ERROR_WDI_BUSY_N6 = -206,
KP_ERROR_WDI_TIMEOUT_N7 = -207,
KP_ERROR_WDI_OVERFLOW_N8 = -208,
KP_ERROR_WDI_PENDING_INSTALLATION_N9 = -209,
KP_ERROR_WDI_INTERRUPTED_N10 = -210,
KP_ERROR_WDI_RESOURCE_N11 = -211,
KP_ERROR_WDI_NOT_SUPPORTED_N12 = -212,
KP_ERROR_WDI_EXISTS_N13 = -213,
KP_ERROR_WDI_USER_CANCEL_N14 = -214,
KP_ERROR_WDI_NEEDS_ADMIN_N15 = -215,
KP_ERROR_WDI_WOW64_N16 = -216,
KP_ERROR_WDI_INF_SYNTAX_N17 = -217,
KP_ERROR_WDI_CAT_MISSING_N18 = -218,
KP_ERROR_WDI_UNSIGNED_N19 = -219,
KP_ERROR_WDI_OTHER_N99 = -299,
KP_ERROR_MEMORY_ALLOCATION_FAILURE_9 = 9,
KP_ERROR_DEVICE_NOT_EXIST_10 = 10,
KP_ERROR_DEVICE_INCORRECT_RESPONSE_11 = 11,
KP_ERROR_INVALID_PARAM_12 = 12,
KP_ERROR_SEND_DESC_FAIL_13 = 13,
KP_ERROR_SEND_DATA_FAIL_14 = 14,
KP_ERROR_SEND_DATA_TOO_LARGE_15 = 15,
KP_ERROR_RECV_DESC_FAIL_16 = 16,
KP_ERROR_RECV_DATA_FAIL_17 = 17,
KP_ERROR_RECV_DATA_TOO_LARGE_18 = 18,
KP_ERROR_FW_UPDATE_FAILED_19 = 19,
KP_ERROR_FILE_OPEN_FAILED_20 = 20,
KP_ERROR_INVALID_MODEL_21 = 21,
KP_ERROR_IMAGE_RESOLUTION_TOO_SMALL_22 = 22,
KP_ERROR_IMAGE_INVALID_WIDTH_23 = 23,
KP_ERROR_INVALID_FIRMWARE_24 = 24,
KP_ERROR_RESET_FAILED_25 = 25,
KP_ERROR_DEVICES_NUMBER_26 = 26,
KP_ERROR_CONFIGURE_DEVICE_27 = 27,
KP_ERROR_CONNECT_FAILED_28 = 28,
KP_ERROR_DEVICE_GROUP_MIX_PRODUCT_29 = 29,
KP_ERROR_RECEIVE_INCORRECT_HEADER_STAMP_30 = 30,
KP_ERROR_RECEIVE_SIZE_MISMATCH_31 = 31,
KP_ERROR_RECEIVE_JOB_ID_MISMATCH_32 = 32,
KP_ERROR_INVALID_CUSTOMIZED_JOB_ID_33 = 33,
KP_ERROR_FW_LOAD_FAILED_34 = 34,
KP_ERROR_MODEL_NOT_LOADED_35 = 35,
KP_ERROR_INVALID_CHECKPOINT_DATA_36 = 36,
KP_DBG_CHECKPOINT_END_37 = 37,
KP_ERROR_INVALID_HOST_38 = 38,
KP_ERROR_MEMORY_FREE_FAILURE_39 = 39,
KP_ERROR_USB_BOOT_LOAD_SECOND_MODEL_40 = 40,
KP_ERROR_CHECK_FW_VERSION_FAILED_41 = 41,
KP_ERROR_FIFOQ_INPUT_BUFF_COUNT_NOT_ENOUGH_42 = 42,
KP_ERROR_FIFOQ_SETTING_FAILED_43 = 43,
KP_ERROR_UNSUPPORTED_DEVICE_44 = 44,
KP_ERROR_IMAGE_INVALID_HEIGHT_45 = 45,
KP_ERROR_ADJUST_DDR_HEAP_FAILED_46 = 46,
KP_ERROR_DEVICE_NOT_ACCESSIBLE_47 = 47,
KP_ERROR_INVALID_INPUT_NODE_DATA_NUMBER_48 = 48,
KP_ERROR_OTHER_99 = 99,
KP_FW_ERROR_UNKNOWN_APP = 100,
KP_FW_INFERENCE_ERROR_101 = 101,
KP_FW_DDR_MALLOC_FAILED_102 = 102,
KP_FW_INFERENCE_TIMEOUT_103 = 103,
KP_FW_LOAD_MODEL_FAILED_104 = 104,
KP_FW_CONFIG_POST_PROC_ERROR_MALLOC_FAILED_105 = 105,
KP_FW_CONFIG_POST_PROC_ERROR_NO_SPACE_106 = 106,
KP_FW_IMAGE_SIZE_NOT_MATCH_MODEL_INPUT_107 = 107,
KP_FW_NOT_SUPPORT_PREPROCESSING_108 = 108,
KP_FW_GET_MODEL_INFO_FAILED_109 = 109,
KP_FW_WRONG_INPUT_BUFFER_COUNT_110 = 110,
KP_FW_INVALID_PRE_PROC_MODEL_INPUT_SIZE_111 = 111,
KP_FW_INVALID_INPUT_CROP_PARAM_112 = 112,
KP_FW_ERROR_FILE_OPEN_FAILED_113 = 113,
KP_FW_ERROR_FILE_STATE_FAILED_114 = 114,
KP_FW_ERROR_FILE_READ_FAILED_115 = 115,
KP_FW_ERROR_FILE_WRITE_FAILED_116 = 116,
KP_FW_ERROR_FILE_CHMOD_FAILED_117 = 117,
KP_FW_ERROR_FILE_FAILED_OTHER_118 = 118,
KP_FW_ERROR_INVALID_BOOT_CONFIG_119 = 119,
KP_FW_ERROR_LOADER_ERROR_120 = 120,
KP_FW_ERROR_POSIX_SPAWN_FAILED_121 = 121,
KP_FW_ERROR_USB_SEND_FAILED_122 = 122,
KP_FW_ERROR_USB_RECEIVE_FAILED_123 = 123,
KP_FW_ERROR_HANDLE_NOT_READY_124 = 124,
KP_FW_FIFOQ_ACCESS_FAILED_125 = 125,
KP_FW_FIFOQ_NOT_READY_126 = 126,
KP_FW_ERROR_FILE_SEEK_FAILED_127 = 127,
KP_FW_ERROR_FILE_FLUSH_FAILED_128 = 128,
KP_FW_ERROR_FILE_SYNC_FAILED_129 = 129,
KP_FW_ERROR_FILE_CLOSE_FAILED_130 = 130,
KP_FW_ERROR_MODEL_EXIST_CPU_NODE_131 = 131,
KP_FW_ERROR_MODEL_EXIST_CONST_INPUT_NODE_132 = 132,
KP_FW_ERROR_GET_MSG_QUEUE_FAILED_133 = 133,
KP_FW_ERROR_SEND_MSG_QUEUE_FAILED_134 = 134,
KP_FW_ERROR_RECV_MSG_QUEUE_FAILED_135 = 135,
KP_FW_ERROR_UNSUPPORT_TOOLCHAIN_VERSION_136 = 136,
KP_FW_NCPU_ERR_BEGIN = 200,
KP_FW_NCPU_INVALID_IMAGE_201 = 201,
KP_FW_NCPU_INPROC_FAILED_202 = 202,
KP_FW_NCPU_CPU_OP_NOT_FOUND_203 = 203,
KP_FW_NCPU_MYSTERY_OP_NOT_FOUND_204 = 204,
KP_FW_EFUSE_CAN_NOT_BURN_300 = 300,
KP_FW_EFUSE_PROTECTED_301 = 301,
KP_FW_EFUSE_OTHER_302 = 302,
KP_FW_APP_MASK_FDFR_ENROLL_WITH_MASKED_FACE_10000 = 10000,
KP_FW_APP_SEG_INSUFFICIENT_RESULT_BUFFER_SIZE_10001 = 10001,

kp_channel_ordering_t

typedef enum kp_channel_ordering_t {...}

enum for generic raw data channel ordering

Enumerator
KP_CHANNEL_ORDERING_HCW = 0, KL520 default, height/channel/width in order
KP_CHANNEL_ORDERING_CHW = 1, KL720, KL630 default, channel/height/width in order
KP_CHANNEL_ORDERING_HWC = 2, TensorFlow style, height/width/channel in order
KP_CHANNEL_ORDERING_DEFAULT = 3, KL520, KL630, KL720 use their default, others use onnx shape order

kp_dbg_checkpoint_flag_t

typedef enum kp_dbg_checkpoint_flag_t {...}

Inference debug checkpoints in bit-fields format

Enumerator
KP_DBG_CHECKPOINT_BEFORE_PREPROCESS = 0x1 << 0, Checkpoint data(image) at before-pre_processing stage
KP_DBG_CHECKPOINT_AFTER_PREPROCESS = 0x1 << 1, Checkpoint data(image) at after-pre_processing stage
KP_DBG_CHECKPOINT_AFTER_INFERENCE = 0x1 << 2, Checkpoint data(fixed-point raw) at after-inference stage
KP_DBG_CHECKPOINT_BEFORE_CPU_OP = 0x1 << 3, Checkpoint data(cpu operation) at before-cpu operation stage
KP_DBG_CHECKPOINT_AFTER_CPU_OP = 0x1 << 4, Checkpoint data(cpu operation) at after-cpu operation stage

kp_dtype_t

typedef enum kp_dtype_t {...}

enum for kneron data type

Enumerator
KP_DTYPE_UNKNOWN = 0, unknown data type
KP_DTYPE_INT8 = 1, represent one scalar value by int8_t data type
KP_DTYPE_INT16 = 2, represent one scalar value by int16_t data type
KP_DTYPE_INT32 = 3, represent one scalar value by int32_t data type
KP_DTYPE_INT64 = 4, represent one scalar value by int64_t data type
KP_DTYPE_UINT8 = 5, represent one scalar value by uint8_t data type
KP_DTYPE_UINT16 = 6, represent one scalar value by uint16_t data type
KP_DTYPE_UINT32 = 7, represent one scalar value by uint32_t data type
KP_DTYPE_UINT64 = 8, represent one scalar value by uint64_t data type
KP_DTYPE_FLOAT32 = 9, represent one scalar value by float32 data type
KP_DTYPE_BFLOAT16 = 10, represent one scalar value by bfloat16 data type (store in uint16_t 2 bytes)
KP_DTYPE_DOUBLE64 = 11 represent one scalar value by double64 data type

kp_fixed_point_dtype_t

typedef enum kp_fixed_point_dtype_t {...}

enum for fixed-point data type

Enumerator
KP_FIXED_POINT_DTYPE_UNKNOWN = 0, unknown data type
KP_FIXED_POINT_DTYPE_INT8 = 1, represent one fixed-point value by 8-bit data type
KP_FIXED_POINT_DTYPE_INT16 = 2, represent one fixed-point value by 16-bit data type

kp_image_format_t

typedef enum kp_image_format_t {...}

image format supported for inference.

Enumerator
KP_IMAGE_FORMAT_UNKNOWN = 0x0,
KP_IMAGE_FORMAT_RGB565 = 0x60, RGB565 16bits
KP_IMAGE_FORMAT_RGBA8888 = 0x0D, RGBA8888 32bits
KP_IMAGE_FORMAT_YUYV = 0x2F, YUYV 16bits
KP_IMAGE_FORMAT_YCBCR422_CRY1CBY0 = 0x30, YCbCr422 (order: CrY1CbY0) 16bits
KP_IMAGE_FORMAT_YCBCR422_CBY1CRY0 = 0x31, YCbCr422 (order: CbY1CrY0) 16bits
KP_IMAGE_FORMAT_YCBCR422_Y1CRY0CB = 0x32, YCbCr422 (order: Y1CrY0Cb) 16bits
KP_IMAGE_FORMAT_YCBCR422_Y1CBY0CR = 0x33, YCbCr422 (order: Y1CbY0Cr) 16bits
KP_IMAGE_FORMAT_YCBCR422_CRY0CBY1 = 0x34, YCbCr422 (order: CrY0CbY1) 16bits
KP_IMAGE_FORMAT_YCBCR422_CBY0CRY1 = 0x35, YCbCr422 (order: CbY0CrY1) 16bits
KP_IMAGE_FORMAT_YCBCR422_Y0CRY1CB = 0x36, YCbCr422 (order: Y0CrY1Cb) 16bits
KP_IMAGE_FORMAT_YCBCR422_Y0CBY1CR = 0x37, YCbCr422 (order: Y0CbY1Cr) 16bits
KP_IMAGE_FORMAT_RAW8 = 0x20, RAW 8bits
KP_IMAGE_FORMAT_YUV420 = 0x70, YUV420 (planar) 12bits (KL630 only)

kp_model_target_chip_t

typedef enum kp_model_target_chip_t {...}

model target chip.

Enumerator
KP_MODEL_TARGET_CHIP_UNKNOWN = 0,
KP_MODEL_TARGET_CHIP_KL520 = 1, model for kl520
KP_MODEL_TARGET_CHIP_KL720 = 2, model for kl720
KP_MODEL_TARGET_CHIP_KL530 = 3, model for kl530
KP_MODEL_TARGET_CHIP_KL730 = 4, model for kl730
KP_MODEL_TARGET_CHIP_KL630 = 5, model for kl630
KP_MODEL_TARGET_CHIP_KL540 = 6, model for kl540

kp_model_tensor_data_layout_t

typedef enum kp_model_tensor_data_layout_t {...}

npu raw data layout format for tensors.

Enumerator
KP_MODEL_TENSOR_DATA_LAYOUT_UNKNOWN = 0,
KP_MODEL_TENSOR_DATA_LAYOUT_4W4C8B = 1, width: 4 scalars, channel: 4 scalars, depth: 8 bits
KP_MODEL_TENSOR_DATA_LAYOUT_1W16C8B = 2, width: 1 scalars, channel: 16 scalars, depth: 8 bits
KP_MODEL_TENSOR_DATA_LAYOUT_16W1C8B = 3, width: 16 scalars, channel: 1 scalars, depth: 8 bits
KP_MODEL_TENSOR_DATA_LAYOUT_8W1C16B = 4, width: 8 scalars, channel: 1 scalars, depth: 16 bits
KP_MODEL_TENSOR_DATA_LAYOUT_4W4C8BHL = 5, width: 4 scalars, channel: 4 scalars, depth: 16 bits, and store scalar into 2 entries with "High 8-bit" and "Low 8-bit"
KP_MODEL_TENSOR_DATA_LAYOUT_1W16C8BHL = 6, width: 1 scalars, channel: 16 scalars, depth: 16 bits, and store scalar into 2 entries with "High 8-bit" and "Low 8-bit"
KP_MODEL_TENSOR_DATA_LAYOUT_16W1C8BHL = 7, width: 16 scalars, channel: 1 scalars, depth: 16 bits, and store scalar into 2 entries with "High 8-bit" and "Low 8-bit"
KP_MODEL_TENSOR_DATA_LAYOUT_RAW_8B = 8, packed int8_t data, depth: 8 bits
KP_MODEL_TENSOR_DATA_LAYOUT_RAW_16B = 9, packed int16_t data, depth: 16 bits
KP_MODEL_TENSOR_DATA_LAYOUT_RAW_FLOAT = 10, packed float data, depth: 32 bits

kp_model_tensor_shape_info_version_t

typedef enum kp_model_tensor_shape_info_version_t {...}

shape information version for tensors.

Enumerator
KP_MODEL_TENSOR_SHAPE_INFO_VERSION_UNKNOWN = 0, unknow version
KP_MODEL_TENSOR_SHAPE_INFO_VERSION_1 = 1, version 1 - for KL520, KL720 and KL630
KP_MODEL_TENSOR_SHAPE_INFO_VERSION_2 = 2 version 2 - for KL730

kp_normalize_mode_t

typedef enum kp_normalize_mode_t {...}

normalization mode

Enumerator
KP_NORMALIZE_DISABLE = 0xFF, disable normalize
KP_NORMALIZE_KNERON = 0x1, RGB/256 - 0.5, refer to the toolchain manual
KP_NORMALIZE_TENSOR_FLOW = 0x2, RGB/127.5 - 1.0, refer to the toolchain manual
KP_NORMALIZE_YOLO = 0x3, RGB/255.0, refer to the toolchain manual
KP_NORMALIZE_CUSTOMIZED_DEFAULT = 0x4, customized, default, refer to the toolchain manual
KP_NORMALIZE_CUSTOMIZED_SUB128 = 0x5, customized, subtract 128, refer to the toolchain manual
KP_NORMALIZE_CUSTOMIZED_DIV2 = 0x6, customized, divide by 2, refer to the toolchain manual
KP_NORMALIZE_CUSTOMIZED_SUB128_DIV2 = 0x7, customized, subtract 128 and divide by 2, refer to the toolchain manual

kp_padding_mode_t

typedef enum kp_padding_mode_t {...}

padding mode

Enumerator
KP_PADDING_DISABLE = 0x1, Disable Padding in Pre-process
KP_PADDING_CORNER = 0x2, Using Corner Padding in Pre-process
KP_PADDING_SYMMETRIC = 0x3, Using Symmetric Padding in Pre-process

kp_product_id_t

typedef enum kp_product_id_t {...}

enum for USB PID(Product ID)

Enumerator
KP_DEVICE_KL520 = 0x100, KL520 USB PID
KP_DEVICE_KL720 = 0x720, KL720 USB PID
KP_DEVICE_KL720_LEGACY = 0x200, KL720 Legacy USB PID
KP_DEVICE_KL530 = 0x530, KL530 USB PID
KP_DEVICE_KL830 = 0x832, KL830 USB PID
KP_DEVICE_KL730 = 0x732, KL730 USB PID
KP_DEVICE_KL630 = 0x630, KL630 USB PID
KP_DEVICE_KL540 = 0x540, KL540 USB PID

kp_quantization_parameters_version_t

typedef enum kp_quantization_parameters_version_t {...}

quantization parameters version for tensors.

Enumerator
KP_MODEL_QUANTIZATION_PARAMS_VERSION_UNKNOWN = 0, unknow version
KP_MODEL_QUANTIZATION_PARAMS_VERSION_1 = 1, version 1 - for KL520, KL720, KL630 and KL730

kp_reset_mode_t

typedef enum kp_reset_mode_t {...}

reset mode

Enumerator
KP_RESET_REBOOT = 0, Highest level to reset Kneron device. Kneron device would disconnect after this reset.
KP_RESET_INFERENCE = 1, Soft reset: reset inference FIFO queue.
KP_RESET_SHUTDOWN = 2, Shut down Kneron device. For KL520, only useful if HW circuit supports (ex. 96 board), dongle is not supported. For KL720, this function is not supported.
KP_RESET_REBOOT_SYSTEM = 3, Reboot entire system

kp_resize_mode_t

typedef enum kp_resize_mode_t {...}

resize mode

Enumerator
KP_RESIZE_DISABLE = 0x1, Disable Resize in Pre-process
KP_RESIZE_ENABLE = 0x2, Enable Resize in Pre-process

kp_usb_speed_t

typedef enum kp_usb_speed_t {...}

enum for USB speed mode

Enumerator
KP_USB_SPEED_UNKNOWN = 0,
KP_USB_SPEED_LOW = 1,
KP_USB_SPEED_FULL = 2,
KP_USB_SPEED_HIGH = 3,
KP_USB_SPEED_SUPER = 4,

Structs

kp_available_ddr_config_t

typedef struct kp_available_ddr_config_t {...}

Describe DDR memory space current configuration

Members
uint32_t ddr_available_begin; Available DDR space begin address
uint32_t ddr_available_end; Available DDR space end address
uint32_t ddr_model_end; Model used DDR space end address
uint32_t ddr_fifoq_allocated; Whether FIFO queue has been configured

kp_bounding_box_t

typedef struct kp_bounding_box_t {...}

describe a bounding box

Members
float x1; top-left corner: x
float y1; top-left corner: y
float x2; bottom-right corner: x
float y2; bottom-right corner: y
float score; probability score
int32_t class_num; class # (of many) with highest probability

kp_classification_result_t

typedef struct kp_classification_result_t {...}

describe a classification result

Members
int32_t class_num; class # (of many) with highest probability
float score; probability score

kp_dbg_checkpoint_data_after_cpu_op_t

typedef struct kp_dbg_checkpoint_data_after_cpu_op_t {...}

Inference debug data structure represents for "after-cpu operation"

Members
kp_inference_header_stamp_t header_stamp; magic_type = 'KDP2_MAGIC_TYPE_CHECKPOINT_DATA'
uint32_t checkpoint_tag; refer to kp_dbg_checkpoint_flag_t
int target_inf_model; inferencing model
uint32_t num_nodes; number of output nodes
kp_tensor_descriptor_t *node_metadata; array of model output node metada
uint32_t total_output_size; total raw output size in bytes
uint8_t *raw_output; truly raw output from NPU

kp_dbg_checkpoint_data_after_inference_t

typedef struct kp_dbg_checkpoint_data_after_inference_t {...}

Inference debug data structure represents for "after-inference"

Members
kp_inference_header_stamp_t header_stamp; magic_type = 'KDP2_MAGIC_TYPE_CHECKPOINT_DATA'
uint32_t checkpoint_tag; refer to kp_dbg_checkpoint_flag_t
int target_inf_model; inferencing model
uint32_t num_nodes; number of output nodes
kp_tensor_descriptor_t *node_metadata; array of model output node metada
uint32_t total_output_size; total raw output size in bytes
uint8_t *raw_output; truly raw output from NPU

kp_dbg_checkpoint_data_after_preprocess_t

typedef struct kp_dbg_checkpoint_data_after_preprocess_t {...}

Inference debug data structure represents for "after-pre_process"

Members
kp_inference_header_stamp_t header_stamp; magic_type = 'KDP2_MAGIC_TYPE_CHECKPOINT_DATA'
uint32_t checkpoint_tag; refer to kp_dbg_checkpoint_flag_t
uint32_t img_width; image width in pixels
uint32_t img_height; image height in pixels
uint32_t img_format; image format, refer to kp_image_format_t
int target_inf_model; inferencing model
uint32_t img_index; index of input image
uint8_t image[]; image raw data

kp_dbg_checkpoint_data_before_cpu_op_t

typedef struct kp_dbg_checkpoint_data_before_cpu_op_t {...}

Inference debug data structure represents for "before-cpu operation"

Members
kp_inference_header_stamp_t header_stamp; magic_type = 'KDP2_MAGIC_TYPE_CHECKPOINT_DATA'
uint32_t checkpoint_tag; refer to kp_dbg_checkpoint_flag_t
int target_inf_model; inferencing model
uint32_t num_nodes; number of output nodes
kp_tensor_descriptor_t *node_metadata; array of model output node metada
uint32_t total_output_size; total raw output size in bytes
uint8_t *raw_output; truly raw output from NPU

kp_dbg_checkpoint_data_before_preprocess_t

typedef struct kp_dbg_checkpoint_data_before_preprocess_t {...}

Inference debug data structure represents for "before-pre_process"

Members
kp_inference_header_stamp_t header_stamp; magic_type = 'KDP2_MAGIC_TYPE_CHECKPOINT_DATA'
uint32_t checkpoint_tag; refer to kp_dbg_checkpoint_flag_t
uint32_t img_x; image position X
uint32_t img_y; image position Y
uint32_t img_width; image width in pixels
uint32_t img_height; image height in pixels
uint32_t img_format; image format, refer to kp_image_format_t
int target_inf_model; inferencing model
uint32_t img_index; index of input image
uint8_t image[]; image raw data

kp_ddr_manage_attr_t

typedef struct kp_ddr_manage_attr_t {...}

attribute for configuring ddr

Members
uint32_t model_size; DDR space for model
uint32_t input_buffer_size; input buffer size for FIFO queue
uint32_t input_buffer_count; input buffer count for FIFO queue
uint32_t result_buffer_size; result buffer size for FIFO queue
uint32_t result_buffer_count; result buffer count for FIFO queue

kp_device_descriptor_t

typedef struct kp_device_descriptor_t {...}

information of device (USB)

Members
uint32_t port_id; an unique ID representing for a Kneron device, can be used as input while connecting devices
uint16_t vendor_id; supposed to be 0x3231.
uint16_t product_id; enum kp_product_id_t.
int link_speed; enum kp_usb_speed_t.
uint32_t kn_number; KN number.
bool isConnectable; indicate if this device is connectable.
char port_path[20]; "busNo-hub_portNo-device_portNo"
ex: "1-2-3", means bus 1 - (hub) port 2 - (device) port 3
char firmware[30]; Firmware description.

kp_device_group_s

typedef struct kp_device_group_s {...}

a handle represent connected Kneron device.

Members
int timeout; global timeout value for all USB communications with the device
int num_device; number of devices in device group
kp_product_id_t product_id; enum kp_product_id_t
kp_model_nef_descriptor_t loaded_model_desc; a basic descriptor for a NEF
kp_ddr_manage_attr_t ddr_attr; attribute for configuring ddr

kp_devices_list_t

typedef struct kp_devices_list_t {...}

information of connected devices from USB perspectives.

Members
int num_dev; connected devices
kp_device_descriptor_t device[]; real index range from 0 ~ (num_dev-1)

kp_face_occlude_result_t

typedef struct kp_face_occlude_result_t {...}

describe a face occlusion output result after post-processing

Members
float yaw; value of yaw
float pitch; value of pitch
float roll; value of roll
float occ; occlusion score

kp_fifo_queue_config_t

typedef struct kp_fifo_queue_config_t {...}

Describe FIFO Queue current configuration

Members
uint32_t fifoq_input_buf_count; Input buffer count for FIFO queue, 0 if FIFO queue has not been set
uint32_t fifoq_input_buf_size; Input buffer size for FIFO queue, 0 if FIFO queue has not been set
uint32_t fifoq_result_buf_count; Input buffer count for FIFO queue, 0 if FIFO queue has not been set
uint32_t fifoq_result_buf_size; Input buffer size for FIFO queue, 0 if FIFO queue has not been set

kp_file_schema_version_t

typedef struct kp_file_schema_version_t {...}

a basic descriptor for setup.bin file schema version

Members
uint32_t major; major number
uint32_t minor; minor number
uint32_t revision; revision number

kp_firmware_version_t

typedef struct kp_firmware_version_t {...}

describe version string

Members
uint8_t reserved; for backward compatibility
uint8_t major; major number
uint8_t minor; minor number
uint8_t update; update number
uint32_t build; build number

kp_fr_result_t

typedef struct kp_fr_result_t {...}

describe a feature map

Members
float feature_map[FR_FEAT_LENGTH]; feature map in floating point
int8_t feature_map_fixed[FR_FEAT_LENGTH]; feature map in fixed point

kp_generic_data_inference_desc_t

typedef struct kp_generic_data_inference_desc_t {...}

inference descriptor for multiple input images bypass pre-processing

Members
uint32_t inference_number; inference sequence number
uint32_t model_id; target inference model ID
uint32_t num_input_node_data; number of data for input nodes
kp_generic_input_node_data_t input_node_data_list[KP_MAX_INPUT_NODE_COUNT]; list of data for each input node(maps to input nodes order of model)

kp_generic_data_inference_result_header_t

typedef struct kp_generic_data_inference_result_header_t {...}

inference RAW output descriptor for multiple input and bypass pre-processing

Members
uint32_t inference_number; inference sequence number
uint32_t crop_number; crop box sequence number
uint32_t num_output_node; total number of output nodes
uint32_t product_id; product id, refer to kp_product_id_t

kp_generic_image_inference_desc_t

typedef struct kp_generic_image_inference_desc_t {...}

inference descriptor for images

Members
uint32_t inference_number; inference sequence number
uint32_t model_id; target inference model ID
uint32_t num_input_node_image; number of images for input nodes
kp_generic_input_node_image_t input_node_image_list[KP_MAX_INPUT_NODE_COUNT]; list of image data for each input node(maps to input nodes order of model)

kp_generic_image_inference_result_header_t

typedef struct kp_generic_image_inference_result_header_t {...}

inference RAW output descriptor

Members
uint32_t inference_number; inference sequence number
uint32_t crop_number; crop box sequence number
uint32_t num_output_node; total number of output nodes
uint32_t product_id; product id, refer to kp_product_id_t
uint32_t num_pre_proc_info; number of pre_proc_info is available
kp_hw_pre_proc_info_t pre_proc_info[KP_MAX_INPUT_NODE_COUNT]; hardware pre-process related value

kp_generic_input_node_data_t

typedef struct kp_generic_input_node_data_t {...}

inference RAW descriptor for one image under bypass pre process

Members
uint32_t buffer_size; buffer size
uint8_t *buffer; buffer of input data

kp_generic_input_node_image_t

typedef struct kp_generic_input_node_image_t {...}

inference RAW descriptor for one image

Members
uint32_t width; image width
uint32_t height; image height
uint32_t resize_mode; resize mode, refer to kp_resize_mode_t
uint32_t padding_mode; padding mode, refer to kp_resize_mode_t
uint32_t image_format; image format, refer to kp_image_format_t
uint32_t normalize_mode; inference normalization, refer to kp_normalize_mode_t
uint32_t crop_count; crop count
kp_inf_crop_box_t inf_crop[MAX_CROP_BOX]; box information to crop
uint8_t *image_buffer; image buffer

kp_hw_pre_proc_info_t

typedef struct kp_hw_pre_proc_info_t {...}

hardware pre-process related value for raw output result

Members
uint32_t img_width; image width before hardware pre-process
uint32_t img_height; image height before hardware pre-process
uint32_t resized_img_width; image width after resize
uint32_t resized_img_height; image height after resize
uint32_t pad_top; pixels padding on top
uint32_t pad_bottom; pixels padding on bottom
uint32_t pad_left; pixels padding on left
uint32_t pad_right; pixels padding on right
uint32_t model_input_width; model required input width
uint32_t model_input_height; model required input height
kp_inf_crop_box_t crop_area; info of crop area (may not be the same as input due to hw limit)

kp_inf_configuration_t

typedef struct kp_inf_configuration_t {...}

data structure for inference configurations

Members
bool enable_frame_drop; enable this to keep inference non-blocking by dropping oldest and unprocessed frames

kp_inf_crop_box_t

typedef struct kp_inf_crop_box_t {...}

data structure for a crop

Members
uint32_t crop_number; index number
uint32_t x1; top-left corner: x
uint32_t y1; top-left corner: y
uint32_t width; width
uint32_t height; height

kp_inf_fixed_node_output_t

typedef struct kp_inf_fixed_node_output_t {...}

RAW node output in fixed-point format

Members
char* name; name of node
uint32_t shape_len; length of shape
int32_t* shape; shape
kp_quantization_parameters_t quantization_parameters; quantization parameters
uint32_t fixed_point_dtype; enum kp_fixed_point_dtype_t
uint32_t num_data; total number of fixed-point values
fixed_node_output_data_t data; data of fixed-point values in 8-bits/16-bits (depended on fixed_point_dtype) ref. fixed_node_output_data_t

kp_inf_float_node_output_t

typedef struct kp_inf_float_node_output_t {...}

RAW node output in floating-point format

Members
char* name; name of node
uint32_t shape_len; length of shape
int32_t* shape; shape
uint32_t num_data; total number of floating-point values
float data[]; array of floating-point values

kp_inf_raw_fixed_node_metadata_t

typedef struct kp_inf_raw_fixed_node_metadata_t {...}

Metadata of RAW node output in fixed-point format

Members
kp_tensor_descriptor_t tensor_descriptor; tensor information

kp_inf_raw_fixed_node_output_t

typedef struct kp_inf_raw_fixed_node_output_t {...}

RAW node output in raw fixed-point format (with width padding and device channel ordering)

Members
kp_inf_raw_fixed_node_metadata_t metadata; metadata of RAW node output in fixed-point format
uint32_t num_data; total number of NPU raw data
int8_t *data; array of NPU raw data

kp_inference_header_stamp_t

typedef struct kp_inference_header_stamp_t {...}

header stamp for user-defined data transfer

Members
uint32_t magic_type; must be 'KDP2_MAGIC_TYPE_XXXXXX'
uint32_t total_size; total size of user-defined header data struct and data (image)
uint32_t job_id; user-defined ID to synchronize with firmware side, must >= 1000
uint32_t status_code; this field is valid only for result data, refer to KP_API_RETURN_CODE
uint32_t total_image; total number of images for this inference
uint32_t image_index; the index of the image in this transmission

kp_landmark_result_t

typedef struct kp_landmark_result_t {...}

describe a landmark

Members
kp_point_t marks[LAND_MARK_POINTS]; landmark points
float score; score of this landmark
float blur; blur score of this landmark
int32_t class_num; class number

kp_model_nef_descriptor_t

typedef struct kp_model_nef_descriptor_t {...}

a basic descriptor for a NEF

Members
uint32_t magic; magic number for model_nef_descriptor (0x5AA55AA5)
kp_model_nef_metadata_t metadata; nef metadata
uint32_t target; target chip of all models (1: KL520, 2: KL720, etc.)
uint32_t crc; crc of all models
uint32_t num_models; number of models
kp_single_model_descriptor_t* models; model descriptors

kp_model_nef_metadata_t

typedef struct kp_model_nef_metadata_t {...}

a basic descriptor for a NEF metadata

Members
uint32_t kn_num; target KN number device of encrypted all models
char* toolchain_version; toolchain version of all models
char* compiler_version; compiler version of all models
kp_nef_schema_version_t nef_schema_version; schema version of nef
char* platform; usb dongle, 96 board, etc.

kp_nef_schema_version_t

typedef struct kp_nef_schema_version_t {...}

a basic descriptor for nef schema version

Members
uint32_t major; major number
uint32_t minor; minor number
uint32_t revision; revision number

kp_point_t

typedef struct kp_point_t {...}

decribe a point

Members
uint32_t x; x value
uint32_t y; y value

kp_quantization_parameters_t

typedef struct kp_quantization_parameters_t {...}

a basic descriptor for quantization parameters

Members
uint32_t version; quantization parameters version (ref. kp_model_tensor_shape_info_version_t)
kp_quantization_parameters_data_t quantization_parameters_data; quantization parameters data

kp_quantization_parameters_v1_t

typedef struct kp_quantization_parameters_v1_t {...}

a basic descriptor for quantization parameters (version 1)

Members
uint32_t quantized_axis; the axis along which the fixed-point quantization information performed
uint32_t quantized_fixed_point_descriptor_num; numbers of fixed-point quantization information
kp_quantized_fixed_point_descriptor_t* quantized_fixed_point_descriptor; array of fixed-point quantization information

kp_quantized_fixed_point_descriptor_t

typedef struct kp_quantized_fixed_point_descriptor_t {...}

a basic descriptor for a fixed-point quantization information

Members
int32_t radix; radix of node
uint32_t scale_dtype; datatype of scale (ref. kp_dtype_t)
kp_scale_t scale; scale of node

kp_setup_bin_schema_version_t

typedef struct kp_setup_bin_schema_version_t {...}

a basic descriptor for setup.bin schema version

Members
uint32_t major; major number
uint32_t minor; minor number
uint32_t revision; revision number

kp_single_model_descriptor_t

typedef struct kp_single_model_descriptor_t {...}

a basic descriptor for a model

Members
uint32_t target; target chip of model
uint32_t version; version of model
uint32_t id; id of model
uint32_t input_nodes_num; number of model input nodes
kp_tensor_descriptor_t* input_nodes; array of model output node information
uint32_t output_nodes_num; number of model output nodes
kp_tensor_descriptor_t* output_nodes; array of model output node information
kp_setup_bin_schema_version_t setup_bin_schema_version; schema version of setup.bin
kp_file_schema_version_t file_schema_version; file schema version of setup.bin
uint32_t max_raw_out_size; needed raw output buffer size for this model

kp_system_info_t

typedef struct kp_system_info_t {...}

describe system information

Members
uint32_t kn_number; Chip K/N number
kp_firmware_version_t firmware_version; FW version

kp_tensor_descriptor_t

typedef struct kp_tensor_descriptor_t {...}

a basic descriptor for a node in model

Members
uint32_t index; index of node
char* name; name of node
uint32_t data_layout; npu memory layout (ref. kp_model_tensor_data_layout_t)
kp_tensor_shape_info_t tensor_shape_info; shape information
kp_quantization_parameters_t quantization_parameters; quantization parameters

kp_tensor_shape_info_t

typedef struct kp_tensor_shape_info_t {...}

a basic descriptor for a node in model

Members
uint32_t version; shape information version (ref. kp_model_tensor_shape_info_version_t)
kp_tensor_shape_info_data_t tensor_shape_info_data; shape information data

kp_tensor_shape_info_v1_t

typedef struct kp_tensor_shape_info_v1_t {...}

a shape descriptor for a tensor (version 1)

Members
uint32_t shape_npu_len; length of npu shape (Default value: 4)
int32_t* shape_npu; npu shape (Default dimension order: BxCxHxW)
uint32_t shape_onnx_len; length of onnx shape
int32_t* shape_onnx; onnx shape
uint32_t axis_permutation_len; length of remap axis permutation
int32_t* axis_permutation_onnx_to_npu; remap axis permutation from onnx to npu shape (shape_intrp_dim)

kp_tensor_shape_info_v2_t

typedef struct kp_tensor_shape_info_v2_t {...}

a shape descriptor for a tensor (version 2)

Members
uint32_t shape_len; length of shape
int32_t* shape; shape
uint32_t* stride_onnx; data access stride of ONNX (in scalar)
uint32_t* stride_npu; data access stride of NPU (in scalar)

kp_yolo_result_t

typedef struct kp_yolo_result_t {...}

describe a yolo output result after post-processing

Members
uint32_t class_count; total class count detectable by model
uint32_t box_count; boxes of all classes
kp_bounding_box_t boxes[YOLO_GOOD_BOX_MAX]; box information

Unions

fixed_node_output_data_t

typedef union fixed_node_output_data_t {...}

data of fixed-point values in 8-bits/16-bits (depended on fixed_point_dtype)

Members
int8_t int8[1]; array of fixed-point values in 8-bits
int16_t int16[1]; array of fixed-point values in 16-bits

kp_quantization_parameters_data_t

typedef union kp_quantization_parameters_data_t {...}

a basic descriptor for quantization parameters (version 1)

Members
kp_quantization_parameters_v1_t v1; quantization parameters - version 1

kp_scale_t

typedef union kp_scale_t {...}

a scale of node

Members
int8_t scale_int8; scale of node in data type int8
int16_t scale_int16; scale of node in data type int16
int32_t scale_int32; scale of node in data type int32
int64_t scale_int64; scale of node in data type int64
uint8_t scale_uint8; scale of node in data type uint8
uint16_t scale_uint16; scale of node in data type uint16
uint32_t scale_uint32; scale of node in data type uint32
uint64_t scale_uint64; scale of node in data type uint64
uint16_t scale_bfloat16; scale of node in data type bfloat16 (store in uint16_t 2 bytes)
float scale_float32; scale of node in data type float32
double scale_double64; scale of node in data type double64

kp_tensor_shape_info_data_t

typedef union kp_tensor_shape_info_data_t {...}

a shape descriptor data for a tensor

Members
kp_tensor_shape_info_v1_t v1; shape information - version 1
kp_tensor_shape_info_v2_t v2; shape information - version 2