Wrapper for transport lifecycle operations. More...

Collaboration diagram for transport:

Data Fields
int(*	init )(struct command_context *ctx)
	server startup uses this method to validate transport configuration. More...

const char *	name
	Each transport has a unique name, used to select it from among the alternatives. More...

struct transport *	next
	Transports are stored in a singly linked list. More...

int(*	override_target )(const char **targetname)
	Optional. More...

int(*	select )(struct command_context *ctx)
	When a transport is selected, this method registers its commands and activates the transport (e.g. More...

Detailed Description

Wrapper for transport lifecycle operations.

OpenOCD talks to targets through some kind of debugging or programming adapter, using some protocol that probably has target-specific aspects.

A "transport" reflects electrical protocol to the target, e..g jtag, swd, spi, uart, ... NOT the messaging protocols layered over it (e.g. JTAG has eICE, CoreSight, Nexus, OnCE, and more).

In addition to the lifecycle operations packaged by this structure, a transport also involves an interface supported by debug adapters and used by components such as debug targets. For non-debug transports, there may be interfaces used to write to flash chips.

Definition at line 35 of file transport.h.

Field Documentation

◆ init

int(* transport::init) (struct command_context *ctx)

server startup uses this method to validate transport configuration.

(For example, with JTAG this interrogates the scan chain against the list of expected TAPs.)

Definition at line 58 of file transport.h.

Referenced by COMMAND_HANDLER(), and transport_register().

◆ name

const char* transport::name

Each transport has a unique name, used to select it from among the alternatives.

Examples might include "jtag", * "swd", "AVR_ISP" and more.

Definition at line 41 of file transport.h.

Referenced by COMMAND_HANDLER(), COMMAND_HELPER(), hl_transport_init(), and transport_register().

◆ next

struct transport* transport::next

Transports are stored in a singly linked list.

Definition at line 71 of file transport.h.

Referenced by COMMAND_HANDLER(), COMMAND_HELPER(), transport_register(), and transport_select().

◆ override_target

int(* transport::override_target) (const char **targetname)

Optional.

If defined, allows transport to override target name prior to initialisation.

Returns: ERROR_OK on success, or an error code on failure.

Definition at line 66 of file transport.h.

Referenced by target_create().

◆ select

int(* transport::select) (struct command_context *ctx)

When a transport is selected, this method registers its commands and activates the transport (e.g.

resets the link).

After those commands are registered, they will often be used for further configuration of the debug link.

Definition at line 51 of file transport.h.

Referenced by transport_register().

The documentation for this struct was generated from the following file:

transport.h