OpenOCD
Data Structures | Macros | Functions | Variables
cmsis_dap_tcp.c File Reference
Include dependency graph for cmsis_dap_tcp.c:

Go to the source code of this file.

Data Structures

struct  cmsis_dap_backend_data
 

Macros

#define CMSIS_DAP_PACKET_SIZE   1024
 
#define CMSIS_DAP_TCP_PORT   4441
 
#define DAP_PKT_HDR_SIGNATURE   0x00504144
 
#define DAP_PKT_TYPE_REQUEST   0x01
 
#define DAP_PKT_TYPE_RESPONSE   0x02
 
#define DEFAULT_MIN_TIMEOUT_MS   150
 
#define HEADER_LENGTH_OFFSET   sizeof(uint32_t)
 
#define HEADER_PACKET_TYPE_OFFSET   (sizeof(uint32_t) + sizeof(uint16_t))
 
#define HEADER_RESERVED_OFFSET
 
#define HEADER_SIGNATURE_OFFSET   0
 
#define HEADER_SIZE
 
#define STRINGIFY(x)   #x
 

Functions

struct __attribute__ ((packed))
 
static int cmsis_dap_tcp_alloc (struct cmsis_dap *dap, unsigned int pkt_sz)
 
static void cmsis_dap_tcp_cancel_all (struct cmsis_dap *dap)
 
static void cmsis_dap_tcp_close (struct cmsis_dap *dap)
 
static void cmsis_dap_tcp_free (struct cmsis_dap *dap)
 
static int cmsis_dap_tcp_open (struct cmsis_dap *dap, const uint16_t vids[] __attribute__((unused)), const uint16_t pids[] __attribute__((unused)), const char *serial __attribute__((unused)))
 
static int cmsis_dap_tcp_read (struct cmsis_dap *dap, int transfer_timeout_ms, enum cmsis_dap_blocking blocking)
 
static int cmsis_dap_tcp_write (struct cmsis_dap *dap, int txlen, int timeout_ms)
 
 COMMAND_HANDLER (cmsis_dap_handle_tcp_host)
 
 COMMAND_HANDLER (cmsis_dap_handle_tcp_min_timeout)
 
 COMMAND_HANDLER (cmsis_dap_handle_tcp_port)
 
static bool is_socket_error_fatal (void)
 

Variables

const struct cmsis_dap_backend cmsis_dap_tcp_backend
 
static char * cmsis_dap_tcp_host
 
static int cmsis_dap_tcp_min_timeout_ms = DEFAULT_MIN_TIMEOUT_MS
 
static char * cmsis_dap_tcp_port = cmsis_dap_tcp_port_default
 
static char cmsis_dap_tcp_port_default [] = STRINGIFY(CMSIS_DAP_TCP_PORT)
 
const struct command_registration cmsis_dap_tcp_subcommand_handlers []
 

Macro Definition Documentation

◆ CMSIS_DAP_PACKET_SIZE

#define CMSIS_DAP_PACKET_SIZE   1024

Definition at line 67 of file cmsis_dap_tcp.c.

◆ CMSIS_DAP_TCP_PORT

#define CMSIS_DAP_TCP_PORT   4441

Definition at line 66 of file cmsis_dap_tcp.c.

◆ DAP_PKT_HDR_SIGNATURE

#define DAP_PKT_HDR_SIGNATURE   0x00504144

Definition at line 62 of file cmsis_dap_tcp.c.

◆ DAP_PKT_TYPE_REQUEST

#define DAP_PKT_TYPE_REQUEST   0x01

Definition at line 63 of file cmsis_dap_tcp.c.

◆ DAP_PKT_TYPE_RESPONSE

#define DAP_PKT_TYPE_RESPONSE   0x02

Definition at line 64 of file cmsis_dap_tcp.c.

◆ DEFAULT_MIN_TIMEOUT_MS

#define DEFAULT_MIN_TIMEOUT_MS   150

Definition at line 79 of file cmsis_dap_tcp.c.

◆ HEADER_LENGTH_OFFSET

#define HEADER_LENGTH_OFFSET   sizeof(uint32_t)

Definition at line 97 of file cmsis_dap_tcp.c.

◆ HEADER_PACKET_TYPE_OFFSET

#define HEADER_PACKET_TYPE_OFFSET   (sizeof(uint32_t) + sizeof(uint16_t))

Definition at line 98 of file cmsis_dap_tcp.c.

◆ HEADER_RESERVED_OFFSET

#define HEADER_RESERVED_OFFSET
Value:
(sizeof(uint32_t) + sizeof(uint16_t) + \
sizeof(uint8_t))

Definition at line 99 of file cmsis_dap_tcp.c.

◆ HEADER_SIGNATURE_OFFSET

#define HEADER_SIGNATURE_OFFSET   0

Definition at line 96 of file cmsis_dap_tcp.c.

◆ HEADER_SIZE

#define HEADER_SIZE
Value:
(sizeof(uint32_t) + sizeof(uint16_t) + \
2 * sizeof(uint8_t))

Definition at line 101 of file cmsis_dap_tcp.c.

◆ STRINGIFY

#define STRINGIFY (   x)    #x

Definition at line 59 of file cmsis_dap_tcp.c.

Function Documentation

◆ __attribute__()

struct __attribute__ ( (packed)  )

Definition at line 1 of file cmsis_dap_tcp.c.

◆ cmsis_dap_tcp_alloc()

static int cmsis_dap_tcp_alloc ( struct cmsis_dap *  dap,
unsigned int  pkt_sz 
)
static

Definition at line 422 of file cmsis_dap_tcp.c.

References cmsis_dap::bdata, cmsis_dap::command, ERROR_FAIL, ERROR_OK, HEADER_SIZE, LOG_ERROR, cmsis_dap::packet_buffer, cmsis_dap::packet_buffer_size, cmsis_dap::packet_size, cmsis_dap::packet_usable_size, cmsis_dap_backend_data::read_buffer, cmsis_dap_backend_data::read_buffer_consumed, cmsis_dap_backend_data::read_buffer_len, cmsis_dap_backend_data::read_buffer_size, and cmsis_dap::response.

Referenced by cmsis_dap_tcp_open().

◆ cmsis_dap_tcp_cancel_all()

static void cmsis_dap_tcp_cancel_all ( struct cmsis_dap *  dap)
static

Definition at line 457 of file cmsis_dap_tcp.c.

◆ cmsis_dap_tcp_close()

static void cmsis_dap_tcp_close ( struct cmsis_dap *  dap)
static

Definition at line 232 of file cmsis_dap_tcp.c.

References cmsis_dap::bdata, close_socket(), cmsis_dap_tcp_free(), log_socket_error(), NULL, and cmsis_dap_backend_data::sockfd.

Referenced by cmsis_dap_tcp_open().

◆ cmsis_dap_tcp_free()

static void cmsis_dap_tcp_free ( struct cmsis_dap *  dap)
static

Definition at line 451 of file cmsis_dap_tcp.c.

References NULL, and cmsis_dap::packet_buffer.

Referenced by cmsis_dap_tcp_close().

◆ cmsis_dap_tcp_open()

static int cmsis_dap_tcp_open ( struct cmsis_dap *  dap,
const uint16_t vids[]  __attribute__(unused),
const uint16_t pids[]  __attribute__(unused),
const char *serial   __attribute__(unused) 
)
static

Definition at line 148 of file cmsis_dap_tcp.c.

References cmsis_dap::bdata, CMSIS_DAP_PACKET_SIZE, cmsis_dap_tcp_alloc(), cmsis_dap_tcp_close(), cmsis_dap_tcp_host, cmsis_dap_tcp_port, ERROR_FAIL, ERROR_OK, LOG_DEBUG, LOG_ERROR, LOG_INFO, log_socket_error(), NULL, cmsis_dap_backend_data::socket_closed, and cmsis_dap_backend_data::sockfd.

◆ cmsis_dap_tcp_read()

static int cmsis_dap_tcp_read ( struct cmsis_dap *  dap,
int  transfer_timeout_ms,
enum cmsis_dap_blocking  blocking 
)
static

Definition at line 243 of file cmsis_dap_tcp.c.

References cmsis_dap::bdata, CMSIS_DAP_BLOCKING, CMSIS_DAP_NON_BLOCKING, cmsis_dap_tcp_min_timeout_ms, CMSIS_DAP_TIMEOUT_SHORT_MS, DAP_PKT_HDR_SIGNATURE, DAP_PKT_TYPE_RESPONSE, ERROR_FAIL, ERROR_TIMEOUT_REACHED, HEADER_LENGTH_OFFSET, HEADER_PACKET_TYPE_OFFSET, HEADER_RESERVED_OFFSET, HEADER_SIGNATURE_OFFSET, HEADER_SIZE, is_socket_error_fatal(), le_to_h_u16(), le_to_h_u32(), LOG_DEBUG_IO, LOG_ERROR, log_socket_error(), cmsis_dap_backend_data::read_buffer, cmsis_dap_backend_data::read_buffer_consumed, cmsis_dap_backend_data::read_buffer_len, cmsis_dap_backend_data::read_buffer_size, read_socket(), socket_block(), cmsis_dap_backend_data::socket_closed, socket_nonblock(), socket_recv_timeout(), cmsis_dap_backend_data::sockfd, and timeval_ms().

◆ cmsis_dap_tcp_write()

static int cmsis_dap_tcp_write ( struct cmsis_dap *  dap,
int  txlen,
int  timeout_ms 
)
static

Definition at line 377 of file cmsis_dap_tcp.c.

References cmsis_dap::bdata, DAP_PKT_HDR_SIGNATURE, DAP_PKT_TYPE_REQUEST, ERROR_FAIL, h_u16_to_le(), h_u32_to_le(), HEADER_LENGTH_OFFSET, HEADER_PACKET_TYPE_OFFSET, HEADER_RESERVED_OFFSET, HEADER_SIGNATURE_OFFSET, HEADER_SIZE, is_socket_error_fatal(), LOG_DEBUG_IO, LOG_ERROR, log_socket_error(), cmsis_dap::packet_buffer, cmsis_dap::packet_buffer_size, socket_block(), cmsis_dap_backend_data::socket_closed, socket_send_timeout(), cmsis_dap_backend_data::sockfd, and write_socket().

◆ COMMAND_HANDLER() [1/3]

COMMAND_HANDLER ( cmsis_dap_handle_tcp_host  )

Definition at line 477 of file cmsis_dap_tcp.c.

References CMD_ARGC, CMD_ARGV, cmsis_dap_tcp_host, ERROR_COMMAND_SYNTAX_ERROR, ERROR_FAIL, ERROR_OK, and LOG_ERROR.

◆ COMMAND_HANDLER() [2/3]

COMMAND_HANDLER ( cmsis_dap_handle_tcp_min_timeout  )

Definition at line 491 of file cmsis_dap_tcp.c.

◆ COMMAND_HANDLER() [3/3]

COMMAND_HANDLER ( cmsis_dap_handle_tcp_port  )

Definition at line 461 of file cmsis_dap_tcp.c.

References CMD_ARGC, CMD_ARGV, cmsis_dap_tcp_port, cmsis_dap_tcp_port_default, ERROR_COMMAND_SYNTAX_ERROR, ERROR_FAIL, ERROR_OK, and LOG_ERROR.

◆ is_socket_error_fatal()

static bool is_socket_error_fatal ( void  )
static

Definition at line 126 of file cmsis_dap_tcp.c.

Referenced by cmsis_dap_tcp_read(), and cmsis_dap_tcp_write().

Variable Documentation

◆ cmsis_dap_tcp_backend

const struct cmsis_dap_backend cmsis_dap_tcp_backend
Initial value:
= {
.name = "tcp",
.open = cmsis_dap_tcp_open,
.close = cmsis_dap_tcp_close,
.read = cmsis_dap_tcp_read,
.write = cmsis_dap_tcp_write,
.packet_buffer_alloc = cmsis_dap_tcp_alloc,
.packet_buffer_free = cmsis_dap_tcp_free,
.cancel_all = cmsis_dap_tcp_cancel_all,
}
cmsis_dap_tcp_free
static void cmsis_dap_tcp_free(struct cmsis_dap *dap)
Definition: cmsis_dap_tcp.c:451
cmsis_dap_tcp_read
static int cmsis_dap_tcp_read(struct cmsis_dap *dap, int transfer_timeout_ms, enum cmsis_dap_blocking blocking)
Definition: cmsis_dap_tcp.c:243
cmsis_dap_tcp_alloc
static int cmsis_dap_tcp_alloc(struct cmsis_dap *dap, unsigned int pkt_sz)
Definition: cmsis_dap_tcp.c:422
cmsis_dap_tcp_close
static void cmsis_dap_tcp_close(struct cmsis_dap *dap)
Definition: cmsis_dap_tcp.c:232
cmsis_dap_tcp_cancel_all
static void cmsis_dap_tcp_cancel_all(struct cmsis_dap *dap)
Definition: cmsis_dap_tcp.c:457
cmsis_dap_tcp_open
static int cmsis_dap_tcp_open(struct cmsis_dap *dap, const uint16_t vids[] __attribute__((unused)), const uint16_t pids[] __attribute__((unused)), const char *serial __attribute__((unused)))
Definition: cmsis_dap_tcp.c:148
cmsis_dap_tcp_write
static int cmsis_dap_tcp_write(struct cmsis_dap *dap, int txlen, int timeout_ms)
Definition: cmsis_dap_tcp.c:377

Definition at line 491 of file cmsis_dap_tcp.c.

◆ cmsis_dap_tcp_host

char* cmsis_dap_tcp_host
static

Definition at line 116 of file cmsis_dap_tcp.c.

Referenced by cmsis_dap_tcp_open(), and COMMAND_HANDLER().

◆ cmsis_dap_tcp_min_timeout_ms

int cmsis_dap_tcp_min_timeout_ms = DEFAULT_MIN_TIMEOUT_MS
static

Definition at line 119 of file cmsis_dap_tcp.c.

Referenced by cmsis_dap_tcp_read().

◆ cmsis_dap_tcp_port

char* cmsis_dap_tcp_port = cmsis_dap_tcp_port_default
static

Definition at line 118 of file cmsis_dap_tcp.c.

Referenced by cmsis_dap_tcp_open(), and COMMAND_HANDLER().

◆ cmsis_dap_tcp_port_default

char cmsis_dap_tcp_port_default[] = STRINGIFY(CMSIS_DAP_TCP_PORT)
static

Definition at line 117 of file cmsis_dap_tcp.c.

Referenced by COMMAND_HANDLER().

◆ cmsis_dap_tcp_subcommand_handlers

const struct command_registration cmsis_dap_tcp_subcommand_handlers[]
Initial value:
= {
{
.name = "host",
.handler = &cmsis_dap_handle_tcp_host,
.mode = COMMAND_CONFIG,
.help = "set the host name to use (for TCP backend only)",
.usage = "<host_name>",
},
{
.name = "port",
.handler = &cmsis_dap_handle_tcp_port,
.mode = COMMAND_CONFIG,
.help = "set the port number to use for DAP (for TCP backend only)",
.usage = "<port_number>",
},
{
.name = "min_timeout",
.handler = &cmsis_dap_handle_tcp_min_timeout,
.mode = COMMAND_CONFIG,
.help = "set the minimum timeout in milliseconds to wait for response "
"packets (for TCP backend only)",
.usage = "<milliseconds>",
},
COMMAND_REGISTRATION_DONE
}
COMMAND_REGISTRATION_DONE
#define COMMAND_REGISTRATION_DONE
Use this as the last entry in an array of command_registration records.
Definition: command.h:256
COMMAND_CONFIG
@ COMMAND_CONFIG
Definition: command.h:41

Definition at line 491 of file cmsis_dap_tcp.c.