Zephyr API Documentation 4.4.0-rc1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches

Interfaces for Debug Access Port (DAP) Link backends. More...

Files

Data Structures

 DAP Link runtime context (opaque type). More...

Macros

#define DAP_LINK_CONTEXT_DEFINE(ctx_name, ctx_dev)
 Statically define a DAP Link context.

Functions

int dap_link_init (struct dap_link_context *const dap_link_ctx)
 Initialize a DAP Link context.
void dap_link_set_pkt_size (struct dap_link_context *const dap_link_ctx, const uint16_t pkt_size)
 Set the packet size used by a DAP Link backend.
int dap_link_backend_usb_init (struct dap_link_context *const dap_link_ctx)
 Initialize the DAP Link USB backend.

Detailed Description

Interfaces for Debug Access Port (DAP) Link backends.

Since
4.4
Version
0.1.0

Macro Definition Documentation

◆ DAP_LINK_CONTEXT_DEFINE

#define DAP_LINK_CONTEXT_DEFINE ( ctx_name,
ctx_dev )

#include <zephyr/dap/dap_link.h>

Value:
static struct dap_link_context ctx_name = { \
.dev = ctx_dev, \
}

Statically define a DAP Link context.

Example usage:

DAP_LINK_CONTEXT_DEFINE(sample_link_ctx,
DEVICE_DT_GET_ONE(zephyr_swdp_gpio));
#define DEVICE_DT_GET_ONE(compat)
Get a device reference from a devicetree compatible.
Definition device.h:367
Parameters
ctx_nameName of the static context object to define.
ctx_devSWDP device used by the DAP Link backend.

Function Documentation

◆ dap_link_backend_usb_init()

int dap_link_backend_usb_init ( struct dap_link_context *const dap_link_ctx)

#include <zephyr/dap/dap_link.h>

Initialize the DAP Link USB backend.

Parameters
[in]dap_link_ctxContext to bind to the USB backend.
Return values
0Successfully initialized the USB backend.
-errnoNegative error code on failure.

◆ dap_link_init()

int dap_link_init ( struct dap_link_context *const dap_link_ctx)

#include <zephyr/dap/dap_link.h>

Initialize a DAP Link context.

Parameters
[in]dap_link_ctxContext to initialize.
Return values
0Successfully initialized the context.
-errnoNegative error code on failure.

◆ dap_link_set_pkt_size()

void dap_link_set_pkt_size ( struct dap_link_context *const dap_link_ctx,
const uint16_t pkt_size )

#include <zephyr/dap/dap_link.h>

Set the packet size used by a DAP Link backend.

Parameters
[in]dap_link_ctxContext to update.
[in]pkt_sizePacket size (in bytes).