DAP_core.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025-2026, Texas Instruments Incorporated
 * 
 *  All rights reserved not granted herein.
 *  Limited License.
 * 
 *  Texas Instruments Incorporated grants a world-wide, royalty-free,
 *  non-exclusive license under copyrights and patents it now or hereafter
 *  owns or controls to make, have made, use, import, offer to sell and sell
 *  ("Utilize") this software subject to the terms herein. With respect to the
 *  foregoing patent license, such license is granted solely to the extent that
 *  any such patent is necessary to Utilize the software alone. The patent
 *  license shall not apply to any combinations which include this software,
 *  other than combinations with devices manufactured by or for TI ("TI
 *  Devices"). No hardware patent is licensed hereunder.
 * 
 *  Redistributions must preserve existing copyright notices and reproduce
 *  this license (including the above copyright notice and the disclaimer and
 *  (if applicable) source code license limitations below) in the documentation
 *  and/or other materials provided with the distribution.
 * 
 *  Redistribution and use in binary form, without modification, are permitted
 *  provided that the following conditions are met:
 * 
 *    * No reverse engineering, decompilation, or disassembly of this software
 *      is permitted with respect to any software provided in binary form.
 *    * Any redistribution and use are licensed by TI for use only with TI Devices.
 *    * Nothing shall obligate TI to provide you with source code for the software
 *      licensed and provided to you in object code.
 * 
 *  If software source code is provided to you, modification and redistribution
 *  of the source code are permitted provided that the following conditions are
 *  met:
 * 
 *    * Any redistribution and use of the source code, including any resulting
 *      derivative works, are licensed by TI for use only with TI Devices.
 *    * Any redistribution and use of any object code compiled from the source
 *      code and any resulting derivative works, are licensed by TI for use
 *      only with TI Devices.
 * 
 *  Neither the name of Texas Instruments Incorporated nor the names of its
 *  suppliers may be used to endorse or promote products derived from this
 *  software without specific prior written permission.
 * 
 *  DISCLAIMER.
 * 
 *  THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
 *  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 *  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 *  IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 *  OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ti_edgeai_DAP_core__include
#define ti_edgeai_DAP_core__include

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

#include <ti/ai/edge_ai/dap/DAP.h>

#ifdef __cplusplus
extern "C" {
#endif

#define DAP_MAX_FRAME_SIZE_BYTES (1024)

typedef struct
{
    uint8_t buffer[DAP_MAX_FRAME_SIZE_BYTES];

    size_t length;

    uint16_t index;
} DAP_Frame;

typedef enum
{
    DAP_ERROR_TYPE_NONE                 = 0x00,
    DAP_ERROR_TYPE_MISMATCH_START_BYTE  = 0xE1,
    DAP_ERROR_TYPE_MISMATCH_END_BYTE    = 0xE2,
    DAP_ERROR_TYPE_ADDR_RANGE           = 0xE3,
    DAP_ERROR_TYPE_MISMATCH_CRC         = 0xE4,
    DAP_ERROR_TYPE_MISMATCH_TARGET_ADDR = 0xE5
} DAP_ErrorType;

typedef enum
{
    DAP_ERROR_COMMAND                   = 0x00,
    DAP_GET_CAPABILITIES_COMMAND        = 0x01,
    DAP_LIST_SENSORS_COMMAND            = 0x02,
    DAP_CONFIGURE_PIPELINE_COMMAND      = 0x03,
    DAP_LIST_MODELS_COMMAND             = 0x04,
    DAP_REMOVE_MODEL_COMMAND            = 0x05,
    DAP_START_MODEL_UPLOAD_COMMAND      = 0x06,
    DAP_END_MODEL_UPLOAD_COMMAND        = 0x07,
    DAP_START_STREAMING_COMMAND         = 0x08,
    DAP_STOP_STREAMING_COMMAND          = 0x09,
    DAP_LIST_INFERENCING_VALUES_COMMAND = 0x0a,
    // reserved1 = 0x0b,
    DAP_READ_PROPERTY_COMMAND           = 0x0c,
    DAP_WRITE_PROPERTY_COMMAND          = 0x0d,
    DAP_LIST_PROPERTIES_COMMAND         = 0x0e,
    DAP_SEND_DATA_COMMAND               = 0x10,
    DAP_RECEIVE_DATA_COMMAND            = 0x10,
} DAP_CommandType;

typedef enum
{
    DAP_GET_CAPABILITIES_CMD_FIXED_LENGHT        = 0,
    DAP_LIST_SENSORS_FIXED_CMD_LENGHT            = 0,
    DAP_CONFIGURE_PIPELINE_CMD_FIXED_LENGHT      = 2,
    DAP_LIST_MODELS_CMD_FIXED_LENGHT             = 0,
    DAP_REMOVE_MODEL_CMD_FIXED_LENGTH            = 1,
    DAP_START_MODEL_UPLOAD_CMD_FIXED_LENGTH      = 0,
    DAP_END_MODEL_UPLOAD_CMD_FIXED_LENGTH        = 4,
    DAP_START_STREAMING_CMD_FIXED_LENGHT         = 0,
    DAP_STOP_STREAMING_CMD_FIXED_LENGHT          = 0,
    DAP_LIST_INFERENCING_VALUES_CMD_FIXED_LENGTH = 0,
    DAP_READ_PROPERTY_CMD_FIXED_LENGHT           = 1,
    DAP_WRITE_PROPERTY_CMD_FIXED_LENGHT          = 1,
    DAP_LIST_PROPERTIES_CMD_FIXED_LENGHT         = 0,
    DAP_DATA_CMD_FIXED_LENGTH                    = 0
} DAP_CommandPayloadFixedLength;

typedef enum
{
    DAP_ERROR_FIXED_LENGHT                   = 2,
    DAP_GET_CAPABILITIES_FIXED_LENGHT        = 4,
    DAP_LIST_SENSORS_FIXED_LENGHT            = 2,
    DAP_CONFIGURE_PIPELINE_FIXED_LENGHT      = 0,
    DAP_LIST_MODELS_FIXED_LENGHT             = 2,
    DAP_REMOVE_MODEL_FIXED_LENGTH            = 0,
    DAP_START_MODEL_UPLOAD_FIXED_LENGTH      = 0,
    DAP_END_MODEL_UPLOAD_FIXED_LENGTH        = 0,
    DAP_START_STREAMING_FIXED_LENGHT         = 0,
    DAP_STOP_STREAMING_FIXED_LENGHT          = 0,
    DAP_LIST_INFERENCING_VALUES_FIXED_LENGTH = 3,
    DAP_READ_PROPERTY_FIXED_LENGHT           = 1,
    DAP_WRITE_PROPERTY_FIXED_LENGHT          = 1,
    DAP_LIST_PROPERTIES_FIXED_LENGHT         = 3,
    DAP_DATA_FIXED_LENGTH                    = 0
} DAP_ResponsePayloadFixedLength;

typedef enum
{
    DAP_DATA_TYPE_INT8    = 0x01,
    DAP_DATA_TYPE_INT16   = 0x02,
    DAP_DATA_TYPE_INT32   = 0x03,
    DAP_DATA_TYPE_UINT8   = 0x04,
    DAP_DATA_TYPE_UINT16  = 0x05,
    DAP_DATA_TYPE_UINT32  = 0x06,
    DAP_DATA_TYPE_FLOAT16 = 0x07,
    DAP_DATA_TYPE_FLOAT32 = 0x08,
    DAP_DATA_TYPE_FLOAT64 = 0x09,
} DAP_DataTypes;

typedef struct
{
    const char *name;
    DAP_DataTypes dataFormat;
    union
    {
        uint8_t u8;
        uint16_t u16;
        uint32_t u32;
        int8_t i8;
        int16_t i16;
        int32_t i32;
        float f16;
        float f32;
        double f64;
    } value;
} DAP_Property;

typedef struct
{
    const char *info;
    DAP_DataTypes dataFormat;
} DAP_Inference;

DAP_ErrorType DAP_verifyFrame(DAP_Frame *frame);

void DAP_serviceCommand(DAP_Handle *dapHandle, DAP_Frame *commandFrame);

void DAP_sendError(DAP_Handle *dapHandle, DAP_CommandType command, const char errorMessage[]);

void DAP_receiveDataCommand(DAP_Handle *dapHandle, DAP_SendDataType sendDataType, void *data, size_t dataSize);

#ifdef __cplusplus
}
#endif
#endif /* ti_edgeai_DAP_core__include */