Kneron PLUS data structure
Include Header File: kp_struct.h
- Defines
- APP_PADDING_BYTES
- MAX_INPUT_NODE_COUNT
- KDP2_MAGIC_TYPE_COMMAND
- KDP2_MAGIC_TYPE_INFERENCE
- KDP2_MAGIC_TYPE_CUSTOMIZED
- KDP2_MAGIC_TYPE_CHECKPOINT_DATA
- MAX_CROP_BOX
- YOLO_GOOD_BOX_MAX
- LAND_MARK_POINTS
- FR_FEAT_LENGTH
- Simple Typedef
- Enumerations
- Structs
- kp_available_ddr_config_t
- kp_bounding_box_t
- kp_classification_result_t
- kp_dbg_checkpoint_data_after_cpu_op_t
- kp_dbg_checkpoint_data_after_inference_t
- kp_dbg_checkpoint_data_after_preprocess_t
- kp_dbg_checkpoint_data_before_cpu_op_t
- kp_dbg_checkpoint_data_before_preprocess_t
- kp_ddr_manage_attr_t
- kp_device_descriptor_t
- kp_device_group_s
- kp_devices_list_t
- kp_file_schema_version_t
- kp_firmware_version_t
- kp_fr_result_t
- kp_generic_data_inference_desc_t
- kp_generic_data_inference_result_header_t
- kp_generic_image_inference_desc_t
- kp_generic_image_inference_result_header_t
- kp_generic_input_node_data_t
- kp_generic_input_node_image_t
- kp_hw_pre_proc_info_t
- kp_inf_configuration_t
- kp_inf_crop_box_t
- kp_inf_fixed_node_output_t
- kp_inf_float_node_output_t
- kp_inf_raw_fixed_node_metadata_t
- kp_inf_raw_fixed_node_output_t
- kp_inference_header_stamp_t
- kp_landmark_result_t
- kp_model_nef_descriptor_t
- kp_model_nef_metadata_t
- kp_nef_schema_version_t
- kp_point_t
- kp_quantization_parameters_t
- kp_quantized_fixed_point_descriptor_t
- kp_setup_bin_schema_version_t
- kp_single_model_descriptor_t
- kp_system_info_t
- kp_tensor_descriptor_t
- kp_yolo_result_t
- Unions
Defines
Define | Value | Description |
---|---|---|
APP_PADDING_BYTES | 28 | Default padding size |
MAX_INPUT_NODE_COUNT | 5 | Supported maximum count of the model input node |
KDP2_MAGIC_TYPE_COMMAND | 0xAB67CD13 | Magic number for data check |
KDP2_MAGIC_TYPE_INFERENCE | 0x11FF22AA | 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 |
MAX_CROP_BOX | 4 | MAX crop count |
YOLO_GOOD_BOX_MAX | 100 | 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_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_NCPU_ERR_BEGIN = 200, | |
KP_FW_NCPU_INVALID_IMAGE_201 = 201, | |
KP_FW_EFUSE_CAN_NOT_BURN_300 = 300, | |
KP_FW_EFUSE_PROTECTED_301 = 301, | |
KP_FW_EFUSE_OTHER_302 = 302, |
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 default, channel/height/width in 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_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_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_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 bits, channel: 4 bits, depth: 8 bits |
KP_MODEL_TENSOR_DATA_LAYOUT_1W16C8B = 2, | width: 1 bits, channel: 16 bits, depth: 8 bits |
KP_MODEL_TENSOR_DATA_LAYOUT_16W1C8B = 3, | width: 16 bits, channel: 4 bits, depth: 8 bits |
KP_MODEL_TENSOR_DATA_LAYOUT_8W1C16B = 4, | width: 8 bits, channel: 1 bits, depth: 16 bits |
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_reset_mode_t
typedef enum kp_reset_mode_t {...}
reset mode
Enumerator | |
---|---|
KP_RESET_REBOOT = 0, | Higheset 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 bord), dongle is not supported. For KL720, this function is not supported. |
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_inf_raw_fixed_node_metadata_t node_metadata[50]; | 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_inf_raw_fixed_node_metadata_t node_metadata[50]; | 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_inf_raw_fixed_node_metadata_t node_metadata[50]; | 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 image_buffer_size; | image buffer size for FIFO queue |
uint32_t image_buffer_count; | image 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_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[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[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[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 | |
---|---|
uint32_t width; | node width |
uint32_t height; | node height |
uint32_t channel; | node channel |
int32_t radix; | radix for fixed/floating point conversion |
float scale; | scale for fixed/floating point conversion |
float factor; | conversion factor for fixed-point to floating-point conversion - formula: 1 / (scale * (2 ^ radix)) |
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 | |
---|---|
uint32_t width; | node width |
uint32_t height; | node height |
uint32_t channel; | node channel |
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 | |
---|---|
uint32_t height; | node height |
uint32_t channel; | node channel |
uint32_t width; | node width, should be aligned to 16 bytes for futher processing due to low level output |
int32_t radix; | radix for fixed/floating point conversion |
float scale; | scale for fixed/floating point conversion |
uint32_t data_layout; | npu memory layout (ref. kp_model_tensor_data_layout_t) |
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 fixed-poiont values, should be metadata->width (aligned to 16 bytes) * metadata->height * metadata->channel |
int8_t *data; | array of fixed-point values |
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 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 | |
---|---|
float scale; | scale of node |
int32_t radix; | radix 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 shape_npu_len; | length of npu shape |
uint32_t* shape_npu; | npu shape |
uint32_t shape_onnx_len; | length of onnx shape |
uint32_t* shape_onnx; | onnx shape |
uint32_t data_layout; | npu memory layout |
kp_quantization_parameters_t quantization_parameters; | quantization parameters |
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 |