DAP.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.
 */
/*!****************************************************************************
 *  @file       DAP.h
 *  @brief      <b>PRELIMINARY</b> DAP for EdgeAI
 *
 *  <b>WARNING</b> These APIs are <b>PRELIMINARY</b>, and subject to change in
 *  the next few months.
 *
 *  To use the DAP, include this header file in the application as follows:
 *  @code
 *  #include <ti/ai/edge_ai/DAP.h>
 *  @endcode
 *
 *  @anchor ti_edgeai_DAP_Overview
 *  # Overview #
 *  The Device Agent Protocol (DAP) is a serial communication protocol using
 *  packets that facilitates interaction between Edge AI Studio (the host) and
 *  TI Microcontrollers (the target devices). This protocol is specifically
 *  designed to support edge AI applications.
 *
 *  Communication follows a controller-responder model where the host initiates
 *  all transfers or commands, and the target device must acknowledge each
 *  command with a response. Depending on the command type, the target may send
 *  additional responses.
 *
 *  Application execution is controlled by the host through a variety of
 *  commands. The application can be configured to operate in one of four
 *  distinct pipeline modes, as specified in the #DAP_PipelineMode enumeration.
 *
 *  Configuration details specific to each pipeline mode are maintained in the
 *  #DAP_PipelineConfiguration structure. To retrieve this configuration
 *  information, the #DAP_getPipelineConfiguration() function can be utilized.
 *
 *  Depending on the active operation mode, the host may request various types
 *  of data from the target device. The readiness for data streaming can be
 *  determined using the DAP_isReadyToStartStreaming function. When streaming is
 *  available, data transmission is performed via the #DAP_sendData() function.
 *  The #DAP_SendDataType enumeration defines the supported data types for
 *  transmission.
 *
 *  # Design Architecture
 *  This protocol operates in duplex mode, enabling simultaneous transmission
 *  and reception of data packets. The implementation achieves this capability
 *  by separating functionality into dedicated RX (receiving) and TX
 *  (transmitting) tasks.
 *
 *  The RX task is in charge of receiving the packets, decoding them and
 *  constructing the response packet. The response packet is then posted in a
 *  message queue shared with the TX task.
 *
 *  The TX task is in charge of reading packets from the message queue and
 *  sending them over to the host through the transport layer.
 *
 *  The transport layer utilizes a serial communication protocol, with its
 *  backend implementation located in the ti/ai/edge_ai/dap/core/DAP_core.h
 *  file.
 *
 *  <hr>
 *  # Usage
 *  To use the DAP the application calls the following APIs:
 *    - DAP_init(): One time initialization of the DAP.
 *    - DAP_open(): Initializes the serial protocol, the message queue, and the
 *      RX and TX tasks.
 *
 ******************************************************************************
 */

#ifndef ti_edgeai_DAP__include
#define ti_edgeai_DAP__include

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

#include <ti/drivers/UART2.h>
#include <ti/drivers/dpl/MessageQueueP.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum
{
    DAP_PIPELINE_MODE_UNINITIALIZED      = 0x00,
    DAP_PIPELINE_MODE_DATA_ACQUISITION   = 0x01,
    DAP_PIPELINE_MODE_SENSOR_INFERENCING = 0x02,
    DAP_PIPELINE_MODE_HOST_INFERENCING   = 0x03,
    DAP_PIPELINE_MODE_LOOPBACK           = 0x04,
} DAP_PipelineMode;

typedef struct
{
    /* Mode of operation. */
    DAP_PipelineMode mode;
    /* Index of the model to use for Sensor and Host Inferencing modes. */
    uint8_t inferenceModelIndex;
    /* Indices of the sensors to be used for Data Acquisition and Sensor
     * Inferencing modes.
     */
    uint8_t inferenceSensorsIndex[10];
} DAP_PipelineConfiguration;

typedef struct
{
    UART2_Handle uartHandle;

    MessageQueueP_Handle messageQueueHandle;

    bool isCrc;

    bool startStreamingFlag;

    DAP_PipelineConfiguration pipelineConfig;
} DAP_Handle;

typedef enum
{
    DAP_SEND_DATA_TYPE_SENSOR_SIGNAL      = 0x01,
    DAP_SEND_DATA_TYPE_INFERENCING_SIGNAL = 0x03,
    DAP_SEND_DATA_TYPE_INFERENCING_RESULT = 0x04,
    DAP_SEND_DATA_TYPE_INFERENCING_VALUE  = 0x05,
    DAP_SEND_DATA_TYPE_INFERENCING_LOG    = 0x06,

} DAP_SendDataType;

float DAP_swapEndianness(float value);

void DAP_init(void);

void DAP_open(void);

void DAP_openOnHandle(UART2_Handle handle);

DAP_PipelineConfiguration DAP_getPipelineConfiguration(void);

uint32_t DAP_getSamplesToSend(void);

uint32_t DAP_getSamplingFrequency(void);

bool DAP_isReadyToStartStreaming(void);

void DAP_clearStreamingFlag(void);

void DAP_sendData(DAP_SendDataType sendDataType, void *data, size_t dataSize);

#ifdef __cplusplus
}
#endif
#endif /* ti_edgeai_DAP__include */