35 #define DEFAULT_CLOCK_SPEED_KHZ 100U
129 LOG_ERROR(
"Debug Adapter has to be specified, "
130 "see \"adapter driver\" command");
141 LOG_WARNING(
"An adapter speed is not selected in the init scripts."
142 " OpenOCD will try to run the adapter at very low speed (%d kHz).",
144 LOG_WARNING(
"To remove this warnings and achieve reasonable communication speed with the target,"
145 " set \"adapter speed\" or \"jtag_rclk\" in the init scripts.");
162 int actual_khz = requested_khz;
172 LOG_INFO(
"adapter-specific clock speed value %d", speed_var);
173 else if (actual_khz) {
177 LOG_INFO(
"RCLK (adaptive clock speed) not supported - fallback to %d kHz"
180 LOG_INFO(
"clock speed %d kHz", actual_khz);
182 LOG_INFO(
"RCLK (adaptive clock speed)");
215 LOG_DEBUG(
"convert khz to adapter specific speed value");
221 LOG_ERROR(
"Translation from khz to adapter speed not implemented");
235 if ((retval !=
ERROR_OK) && fallback_speed_khz) {
279 LOG_ERROR(
"BUG: unknown adapter clock mode");
294 LOG_ERROR(
"Translation from adapter speed to khz not implemented");
312 #define USB_MAX_LOCATION_LENGTH 16
314 #ifdef HAVE_LIBUSB_GET_PORT_NUMBERS
315 static void adapter_usb_set_location(
const char *location)
333 size_t path_step, string_length;
344 ptr = strtok(loc,
"-");
350 string_length -=
strnlen(ptr, string_length);
352 if (atoi(ptr) != dev_bus)
356 while (path_step < path_len) {
357 ptr = strtok(
NULL,
".");
364 if (path_step < path_len && atoi(ptr) != port_path[path_step])
368 string_length -=
strnlen(ptr, string_length) + 1;
372 if (path_step == path_len && !string_length)
409 if (j & transport_ids)
431 LOG_WARNING(
"Adapter driver already configured, ignoring");
458 LOG_ERROR(
"The specified adapter driver was not found (%s)",
483 if (strcmp(*
CMD_ARGV,
"srst_gates_jtag") == 0)
485 else if (strcmp(*
CMD_ARGV,
"srst_nogate") == 0)
490 LOG_ERROR(
"extra reset_config %s spec (%s)",
501 else if (strcmp(*
CMD_ARGV,
"trst_only") == 0)
503 else if (strcmp(*
CMD_ARGV,
"srst_only") == 0)
505 else if (strcmp(*
CMD_ARGV,
"trst_and_srst") == 0)
510 LOG_ERROR(
"extra reset_config %s spec (%s)",
519 if (strcmp(*
CMD_ARGV,
"separate") == 0)
521 else if (strcmp(*
CMD_ARGV,
"srst_pulls_trst") == 0)
523 else if (strcmp(*
CMD_ARGV,
"trst_pulls_srst") == 0)
525 else if (strcmp(*
CMD_ARGV,
"combined") == 0)
530 LOG_ERROR(
"extra reset_config %s spec (%s)",
539 if (strcmp(*
CMD_ARGV,
"trst_open_drain") == 0)
541 else if (strcmp(*
CMD_ARGV,
"trst_push_pull") == 0)
546 LOG_ERROR(
"extra reset_config %s spec (%s)",
555 if (strcmp(*
CMD_ARGV,
"srst_push_pull") == 0)
557 else if (strcmp(*
CMD_ARGV,
"srst_open_drain") == 0)
562 LOG_ERROR(
"extra reset_config %s spec (%s)",
571 if (strcmp(*
CMD_ARGV,
"connect_assert_srst") == 0)
573 else if (strcmp(*
CMD_ARGV,
"connect_deassert_srst") == 0)
578 LOG_ERROR(
"extra reset_config %s spec (%s)",
617 modes[0] =
"srst_only";
620 modes[0] =
"trst_only";
623 modes[0] =
"trst_and_srst";
633 modes[1] =
"srst_pulls_trst";
636 modes[1] =
"trst_pulls_srst";
639 modes[1] =
"combined";
642 modes[1] =
"separate";
649 modes[3] =
" trst_open_drain";
651 modes[3] =
" trst_push_pull";
658 modes[2] =
" srst_nogate";
660 modes[2] =
" srst_gates_jtag";
663 modes[4] =
" srst_push_pull";
665 modes[4] =
" srst_open_drain";
668 modes[5] =
" connect_assert_srst";
670 modes[5] =
" connect_deassert_srst";
679 modes[2], modes[3], modes[4], modes[5]);
719 unsigned int khz = 0;
753 VALUE_UNDEFINED = -1,
758 enum values srst = VALUE_UNDEFINED;
759 enum values trst = VALUE_UNDEFINED;
784 value = (strcmp(
CMD_NAME,
"assert") == 0) ? VALUE_ASSERT : VALUE_DEASSERT;
785 if (strcmp(
CMD_ARGV[0],
"srst") == 0)
787 else if (strcmp(
CMD_ARGV[0],
"trst") == 0)
793 if (strcmp(
CMD_ARGV[1],
"assert") == 0)
794 value = VALUE_ASSERT;
795 else if (strcmp(
CMD_ARGV[1],
"deassert") == 0)
796 value = VALUE_DEASSERT;
800 if (strcmp(
CMD_ARGV[2],
"srst") == 0 && srst == VALUE_UNDEFINED)
802 else if (strcmp(
CMD_ARGV[2],
"trst") == 0 && trst == VALUE_UNDEFINED)
808 if (trst == VALUE_UNDEFINED) {
812 trst = VALUE_DEASSERT;
815 if (srst == VALUE_UNDEFINED) {
819 srst = VALUE_DEASSERT;
823 LOG_ERROR(
"transport has no trst signal");
848 const char *active_state = gpio_config->
active_low ?
"low" :
"high";
849 const char *dir =
"";
850 const char *
drive =
"";
851 const char *
pull =
"";
867 dir =
"bidirectional";
871 if (
gpio_map[gpio_idx].permit_drive_option) {
872 switch (gpio_config->
drive) {
874 drive =
", push-pull";
877 drive =
", open-drain";
880 drive =
", open-source";
885 switch (gpio_config->
pull) {
887 pull =
", pull-none";
893 pull =
", pull-down";
897 if (
gpio_map[gpio_idx].permit_init_state_option) {
911 command_print(
CMD,
"adapter gpio %s (%s): num %u, chip %d, active-%s%s%s%s",
938 if (gpio_idx == -1) {
958 if (strcmp(
CMD_ARGV[i],
"-chip") == 0) {
960 LOG_ERROR(
"-chip option requires a parameter");
969 if (strcmp(
CMD_ARGV[i],
"-active-high") == 0) {
974 if (strcmp(
CMD_ARGV[i],
"-active-low") == 0) {
980 if (
gpio_map[gpio_idx].permit_drive_option) {
981 if (strcmp(
CMD_ARGV[i],
"-push-pull") == 0) {
986 if (strcmp(
CMD_ARGV[i],
"-open-drain") == 0) {
991 if (strcmp(
CMD_ARGV[i],
"-open-source") == 0) {
998 if (strcmp(
CMD_ARGV[i],
"-pull-none") == 0) {
1003 if (strcmp(
CMD_ARGV[i],
"-pull-up") == 0) {
1008 if (strcmp(
CMD_ARGV[i],
"-pull-down") == 0) {
1014 if (
gpio_map[gpio_idx].permit_init_state_option) {
1015 if (strcmp(
CMD_ARGV[i],
"-init-inactive") == 0) {
1020 if (strcmp(
CMD_ARGV[i],
"-init-active") == 0) {
1027 strcmp(
CMD_ARGV[i],
"-init-input") == 0) {
1034 LOG_ERROR(
"illegal option for adapter %s %s: %s",
1049 #ifdef HAVE_LIBUSB_GET_PORT_NUMBERS
1053 adapter_usb_set_location(
CMD_ARGV[0]);
1062 #ifdef HAVE_LIBUSB_GET_PORT_NUMBERS
1065 .handler = &handle_usb_location_command,
1067 .help =
"display or set the USB bus location of the USB device",
1068 .usage =
"[<bus>-port[.port]...]",
1077 .handler = handle_adapter_srst_delay_command,
1079 .help =
"delay after deasserting SRST in ms",
1080 .usage =
"[milliseconds]",
1083 .name =
"pulse_width",
1084 .handler = handle_adapter_srst_pulse_width_command,
1086 .help =
"SRST assertion pulse width in ms",
1087 .usage =
"[milliseconds]",
1095 .handler = handle_adapter_driver_command,
1097 .help =
"Select a debug adapter driver",
1098 .usage =
"driver_name",
1102 .handler = handle_adapter_speed_command,
1104 .help =
"With an argument, change to the specified maximum "
1105 "jtag speed. For JTAG, 0 KHz signifies adaptive "
1107 "With or without argument, display current setting.",
1112 .handler = handle_adapter_serial_command,
1114 .help =
"Set the serial number of the adapter",
1115 .usage =
"serial_string",
1119 .handler = handle_adapter_list_command,
1121 .help =
"List all built-in debug adapter drivers",
1127 .handler = handle_adapter_name,
1128 .help =
"Returns the name of the currently "
1129 "selected adapter (driver)",
1135 .help =
"srst adapter command group",
1142 .help =
"usb adapter command group",
1148 .handler = handle_adapter_reset_de_assert,
1150 .help =
"Controls SRST and TRST lines.",
1151 .usage =
"|deassert [srst|trst [assert|deassert srst|trst]]",
1155 .handler = handle_adapter_reset_de_assert,
1157 .help =
"Controls SRST and TRST lines.",
1158 .usage =
"|assert [srst|trst [deassert|assert srst|trst]]",
1162 .handler = adapter_gpio_config_handler,
1164 .help =
"gpio adapter command group",
1165 .usage =
"[ tdo|tdi|tms|tck|trst|swdio|swdio_dir|swclk|srst|led"
1167 "[-chip chip_number] "
1168 "[-active-high|-active-low] "
1169 "[-push-pull|-open-drain|-open-source] "
1170 "[-pull-none|-pull-up|-pull-down]"
1171 "[-init-inactive|-init-active|-init-input] ]",
1180 .help =
"adapter command group",
1185 .
name =
"reset_config",
1186 .handler = handle_reset_config_command,
1188 .help =
"configure adapter reset behavior",
1189 .usage =
"[none|trst_only|srst_only|trst_and_srst] "
1190 "[srst_pulls_trst|trst_pulls_srst|combined|separate] "
1191 "[srst_gates_jtag|srst_nogate] "
1192 "[trst_push_pull|trst_open_drain] "
1193 "[srst_push_pull|srst_open_drain] "
1194 "[connect_deassert_srst|connect_assert_srst]",
static const struct command_registration adapter_srst_command_handlers[]
static int adapter_rclk_to_speed(unsigned int fallback_speed_khz, int *speed)
int adapter_config_rclk(unsigned int fallback_speed_khz)
Attempt to enable RTCK/RCLK.
const char * adapter_get_required_serial(void)
Retrieves the serial number set with command 'adapter serial'.
bool adapter_usb_location_equal(uint8_t dev_bus, uint8_t *port_path, size_t path_len)
const struct adapter_gpio_config * adapter_gpio_get_config(void)
Retrieves gpio configuration set with command "adapter gpio <signal_name>".
static void sync_adapter_reset_with_gpios(void)
static struct @16 adapter_config
Adapter configuration.
static int get_gpio_index(const char *signal_name)
enum adapter_clk_mode clock_mode
COMMAND_HANDLER(handle_adapter_name)
int rclk_fallback_speed_khz
static int adapter_set_speed(int speed)
int adapter_get_speed(int *speed)
bool is_adapter_initialized(void)
int adapter_quit(void)
Shutdown the debug adapter upon program exit.
unsigned int adapter_get_speed_khz(void)
Retrieves the clock speed of the adapter in kHz.
static int adapter_khz_to_speed(unsigned int khz, int *speed)
int adapter_get_speed_readable(int *khz)
Given a speed setting, use the interface speed_div callback to adjust the setting.
static const struct command_registration adapter_usb_command_handlers[]
#define DEFAULT_CLOCK_SPEED_KHZ
struct adapter_gpio_config gpios[ADAPTER_GPIO_IDX_NUM]
const char * adapter_usb_get_location(void)
int adapter_register_commands(struct command_context *ctx)
Register the commands which deal with arbitrary debug adapter drivers.
int adapter_init(struct command_context *cmd_ctx)
Do low-level setup like initializing registers, output signals, and clocking.
static const struct command_registration adapter_command_handlers[]
static int adapter_config_khz(unsigned int khz)
Attempt to configure the adapter for the specified kHz.
struct adapter_driver * adapter_driver
#define USB_MAX_LOCATION_LENGTH
static void adapter_driver_gpios_init(void)
static const struct command_registration interface_command_handlers[]
static COMMAND_HELPER(helper_adapter_gpio_print_config, enum adapter_gpio_config_index gpio_idx)
const char * adapter_gpio_get_name(enum adapter_gpio_config_index idx)
Retrieves gpio name.
@ ADAPTER_GPIO_INIT_STATE_ACTIVE
@ ADAPTER_GPIO_INIT_STATE_INPUT
@ ADAPTER_GPIO_INIT_STATE_INACTIVE
adapter_gpio_config_index
Adapter GPIO.
@ ADAPTER_GPIO_IDX_SWDIO_DIR
adapter_gpio_direction
Supported GPIO directions.
@ ADAPTER_GPIO_DIRECTION_OUTPUT
@ ADAPTER_GPIO_DIRECTION_INPUT
@ ADAPTER_GPIO_DIRECTION_BIDIRECTIONAL
@ ADAPTER_GPIO_DRIVE_MODE_OPEN_SOURCE
@ ADAPTER_GPIO_DRIVE_MODE_OPEN_DRAIN
@ ADAPTER_GPIO_DRIVE_MODE_PUSH_PULL
#define ADAPTER_GPIO_NOT_SET
void command_print_sameline(struct command_invocation *cmd, const char *format,...)
void command_print(struct command_invocation *cmd, const char *format,...)
#define CMD
Use this macro to access the command being handled, rather than accessing the variable directly.
#define CALL_COMMAND_HANDLER(name, extra ...)
Use this to macro to call a command helper (or a nested handler).
#define CMD_NAME
Use this macro to access the name of the command being handled, rather than accessing the variable di...
#define CMD_ARGV
Use this macro to access the arguments for the command being handled, rather than accessing the varia...
#define ERROR_COMMAND_SYNTAX_ERROR
#define CMD_ARGC
Use this macro to access the number of arguments for the command being handled, rather than accessing...
#define COMMAND_PARSE_NUMBER(type, in, out)
parses the string in into out as a type, or prints a command error and passes the error code to the c...
#define CMD_CTX
Use this macro to access the context of the command being handled, rather than accessing the variable...
#define COMMAND_REGISTRATION_DONE
Use this as the last entry in an array of command_registration records.
static int register_commands(struct command_context *cmd_ctx, const char *cmd_prefix, const struct command_registration *cmds)
Register one or more commands in the specified context, as children of parent (or top-level commends,...
static uint16_t direction
struct adapter_driver * adapter_drivers[]
The list of built-in JTAG interfaces, containing entries for those drivers that were enabled by the c...
Exports the list of JTAG interface drivers, along with routines for loading and unloading them dynami...
int adapter_resets(int trst, int srst)
bool transport_is_jtag(void)
Returns true if the current debug session is using JTAG as its transport.
unsigned int jtag_get_nsrst_delay(void)
struct jtag_tap * jtag_all_taps(void)
unsigned int jtag_get_nsrst_assert_width(void)
void jtag_set_nsrst_assert_width(unsigned int delay)
static enum reset_types jtag_reset_config
void jtag_tap_free(struct jtag_tap *tap)
void jtag_set_nsrst_delay(unsigned int delay)
void jtag_set_reset_config(enum reset_types type)
enum reset_types jtag_get_reset_config(void)
The JTAG interface can be implemented with a software or hardware fifo.
#define ERROR_JTAG_INIT_FAILED
#define ERROR_JTAG_INVALID_INTERFACE
#define SRST_DEASSERT
Defines arguments for reset functions.
#define LOG_WARNING(expr ...)
#define LOG_ERROR(expr ...)
#define LOG_INFO(expr ...)
#define LOG_DEBUG(expr ...)
char * strndup(const char *s, size_t n)
size_t strnlen(const char *s, size_t maxlen)
Represents a driver for a debugging interface.
int(* speed)(int speed)
Set the interface speed.
unsigned int transport_preferred_id
ID of transport that gets auto-selected when not specified by the user.
int(* khz)(int khz, int *jtag_speed)
Returns JTAG maximum speed for KHz.
int(* speed_div)(int speed, int *khz)
Calculate the clock frequency (in KHz) for the given speed.
unsigned int transport_ids
Bitmask of transport IDs supported in C code.
int(* init)(void)
Interface driver must initialize any resources and connect to a JTAG device.
const char *const name
The name of the interface driver.
int(* quit)(void)
Interface driver must tear down all resources and disconnect from the JTAG device.
Configuration options for a single GPIO.
enum adapter_gpio_pull pull
enum adapter_gpio_init_state init_state
enum adapter_gpio_drive_mode drive
enum adapter_gpio_direction direction
bool permit_init_state_option
struct jtag_tap * next_tap
int allow_transports(struct command_context *ctx, unsigned int transport_ids, unsigned int transport_preferred_id)
Called by debug adapter drivers, or affiliated Tcl config scripts, to declare the set of transports s...
const char * transport_name(unsigned int id)
#define TRANSPORT_VALID_MASK