This is an automated email from Gerrit. "Nicolas Derumigny <nicolas.derumi...@inria.fr>" just uploaded a new patch set to Gerrit, which you can find at https://review.openocd.org/c/openocd/+/8595
-- gerrit commit 22de5cbfe81b6659c4486fcc72700ef316edc5d1 Author: Nicolas Derumigny <nicolas.derumi...@inria.fr> Date: Tue Nov 26 09:59:20 2024 +0100 jtag: drivers: xlnx-axi-xvc: Add support for Xilinx XVC over direct bus interface (AXI) This change allow to use direct mapping of the JTAG interface using Xilinx Virtual Cable (XVC) over AXI. This merges the existing XVC PCIe code and the patch proposed by Jeremy Garff (https://review.openocd.org/c/openocd/+/6594). This is useful when using on a Zynq/ZynqMP/uBlaze host with direct access to the debug bridge over AXI. You can then use the debug bridge Xilinx IP (AXIXVC) to debug a remote device. Signed-off-by: Nicolas Derumigny <nicolas.derumi...@inria.fr> Change-Id: I934591b489e30b400b87772b1437e6030440904c diff --git a/configure.ac b/configure.ac index 567152b0a6..b4a7ac8750 100644 --- a/configure.ac +++ b/configure.ac @@ -158,7 +158,10 @@ m4_define([LIBJAYLINK_ADAPTERS], [[[jlink], [SEGGER J-Link Programmer], [JLINK]]]) m4_define([PCIE_ADAPTERS], - [[[xlnx_pcie_xvc], [Xilinx XVC/PCIe], [XLNX_PCIE_XVC]]]) + [[[xlnx_pcie_xvc], [Xilinx XVC/PCIe], [XLNX_XVC]]]) + +m4_define([AXI_ADAPTERS], + [[[xlnx_axi_xvc], [Xilinx XVC/AXI], [XLNX_XVC]]]) m4_define([SERIAL_PORT_ADAPTERS], [[[buspirate], [Bus Pirate], [BUS_PIRATE]]]) @@ -291,6 +294,7 @@ AC_ARG_ADAPTERS([ LIBGPIOD_ADAPTERS, SERIAL_PORT_ADAPTERS, PCIE_ADAPTERS, + AXI_ADAPTERS, LIBJAYLINK_ADAPTERS ],[auto]) @@ -727,6 +731,8 @@ PROCESS_ADAPTERS([LIBJAYLINK_ADAPTERS], ["x$use_internal_libjaylink" = "xyes" -o PROCESS_ADAPTERS([PCIE_ADAPTERS], ["x$is_linux" = "xyes"], [Linux build]) PROCESS_ADAPTERS([SERIAL_PORT_ADAPTERS], ["x$can_build_buspirate" = "xyes"], [internal error: validation should happen beforehand]) +PROCESS_ADAPTERS([PCIE_ADAPTERS], ["x$is_linux" = "xyes" -a "x$use_libgpiod" = "xyes"], [Linux build and libgpiod]) +PROCESS_ADAPTERS([AXI_ADAPTERS], ["x$is_linux" = "xyes" -a "x$use_libgpiod" = "xyes"], [Linux build and libgpiod]) PROCESS_ADAPTERS([DUMMY_ADAPTER], [true], [unused]) AS_IF([test "x$enable_linuxgpiod" != "xno"], [ @@ -875,7 +881,8 @@ m4_foreach([adapter], [USB1_ADAPTERS, HIDAPI_ADAPTERS, HIDAPI_USB1_ADAPTERS, LIBFTDI_ADAPTERS, LIBFTDI_USB1_ADAPTERS, LIBGPIOD_ADAPTERS, - LIBJAYLINK_ADAPTERS, PCIE_ADAPTERS, SERIAL_PORT_ADAPTERS, + LIBJAYLINK_ADAPTERS, PCIE_ADAPTERS, + AXI_ADAPTERS, SERIAL_PORT_ADAPTERS, DUMMY_ADAPTER, OPTIONAL_LIBRARIES, COVERAGE], diff --git a/doc/openocd.texi b/doc/openocd.texi index 9b5cfbb83e..93884968df 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -613,6 +613,12 @@ emulation model of target hardware. @item @b{xlnx_pcie_xvc} @* A JTAG driver exposing Xilinx Virtual Cable over PCI Express to OpenOCD as JTAG/SWD interface. +@* Link: @url{https://www.xilinx.com/products/intellectual-property/debug-bridge.html} + +@item @b{xlnx_axi_xvc} +@* A JTAG driver exposing JTAG to OpenOCD over AXI-mapped registers. +@* Link: @url{https://docs.amd.com/r/en-US/pg437-axi-jtag/Introduction} +@* Link: @url{https://china.xilinx.com/support/documentation/application_notes/xapp1251-xvc-zynq-petalinux.pdf} @item @b{linuxgpiod} @* A bitbang JTAG driver using Linux GPIO through library libgpiod. @@ -3320,6 +3326,29 @@ The string will be of the format "DDDD:BB:SS.F" such as "0000:65:00.1". @end deffn @end deffn +@deffn {Interface Driver} {xlnx_axi_xvc} +This driver supports the Xilinx JTAG mapping over AXI using the AXI to JTAG +Converter or the AXI-to-JTAG mode of the debug bridge. +It is commonly found in Xilinx MPSoC based designs. It allows debugging +fabric based JTAG/SWD devices such as Cortex-M1/M3 or RISC-Vsoftcores. Access to this +is exposed via extended capability registers in the AXI-mapped configuration space. + +@deffn {Config Command} {xlnx_axi_xvc dev_addr} addr +Specifies the address of the AXI-mapped registers via parameter @var{addr}. + +The correct value for @var{addr} is specified in the "Address Editor" tab +in Vivado. +@end deffn + +@deffn {Config Command} {xlnx_axi_xvc trst} trst_gpio_signal_name +Specifies the GPIOD name of the TRST signal via parameter @var{trst_gpio_signal_name"}. +@end deffn + +@deffn {Config Command} {xlnx_axi_xvc srst} trst_gpio_signal_name +Specifies the GPIOD name of the SRST signal via parameter @var{srst_gpio_signal_name"}. +@end deffn +@end deffn + @deffn {Interface Driver} {bcm2835gpio} This SoC is present in Raspberry Pi which is a cheap single-board computer exposing some GPIOs on its expansion header. diff --git a/src/jtag/drivers/Makefile.am b/src/jtag/drivers/Makefile.am index 8be834859c..d6dd7877b2 100644 --- a/src/jtag/drivers/Makefile.am +++ b/src/jtag/drivers/Makefile.am @@ -173,8 +173,8 @@ endif if SYSFSGPIO DRIVERFILES += %D%/sysfsgpio.c endif -if XLNX_PCIE_XVC -DRIVERFILES += %D%/xlnx-pcie-xvc.c +if XLNX_XVC +DRIVERFILES += %D%/xlnx-xvc.c endif if BCM2835GPIO DRIVERFILES += %D%/bcm2835gpio.c diff --git a/src/jtag/drivers/xlnx-pcie-xvc.c b/src/jtag/drivers/xlnx-pcie-xvc.c deleted file mode 100644 index d90a022cda..0000000000 --- a/src/jtag/drivers/xlnx-pcie-xvc.c +++ /dev/null @@ -1,705 +0,0 @@ -// SPDX-License-Identifier: GPL-2.0-only - -/* - * Copyright (c) 2019 Google, LLC. - * Author: Moritz Fischer <mori...@google.com> - */ - -#ifdef HAVE_CONFIG_H -#include "config.h" -#endif - -#include <stdint.h> -#include <stdlib.h> -#include <math.h> -#include <unistd.h> -#include <linux/pci.h> - -#include <jtag/interface.h> -#include <jtag/swd.h> -#include <jtag/commands.h> -#include <helper/replacements.h> -#include <helper/bits.h> - -/* Available only from kernel v4.10 */ -#ifndef PCI_CFG_SPACE_EXP_SIZE -#define PCI_CFG_SPACE_EXP_SIZE 4096 -#endif - -#define PCIE_EXT_CAP_LST 0x100 - -#define XLNX_XVC_EXT_CAP 0x00 -#define XLNX_XVC_VSEC_HDR 0x04 -#define XLNX_XVC_LEN_REG 0x0C -#define XLNX_XVC_TMS_REG 0x10 -#define XLNX_XVC_TDX_REG 0x14 - -#define XLNX_XVC_CAP_SIZE 0x20 -#define XLNX_XVC_VSEC_ID 0x8 -#define XLNX_XVC_MAX_BITS 0x20 - -#define MASK_ACK(x) (((x) >> 9) & 0x7) -#define MASK_PAR(x) ((int)((x) & 0x1)) - -struct xlnx_pcie_xvc { - int fd; - unsigned int offset; - char *device; -}; - -static struct xlnx_pcie_xvc xlnx_pcie_xvc_state; -static struct xlnx_pcie_xvc *xlnx_pcie_xvc = &xlnx_pcie_xvc_state; - -static int xlnx_pcie_xvc_read_reg(const int offset, uint32_t *val) -{ - uint32_t res; - int err; - - /* Note: This should be ok endianness-wise because by going - * through sysfs the kernel does the conversion in the config - * space accessor functions - */ - err = pread(xlnx_pcie_xvc->fd, &res, sizeof(res), - xlnx_pcie_xvc->offset + offset); - if (err != sizeof(res)) { - LOG_ERROR("Failed to read offset %x", offset); - return ERROR_JTAG_DEVICE_ERROR; - } - - if (val) - *val = res; - - return ERROR_OK; -} - -static int xlnx_pcie_xvc_write_reg(const int offset, const uint32_t val) -{ - int err; - - /* Note: This should be ok endianness-wise because by going - * through sysfs the kernel does the conversion in the config - * space accessor functions - */ - err = pwrite(xlnx_pcie_xvc->fd, &val, sizeof(val), - xlnx_pcie_xvc->offset + offset); - if (err != sizeof(val)) { - LOG_ERROR("Failed to write offset: %x with value: %" PRIx32, - offset, val); - return ERROR_JTAG_DEVICE_ERROR; - } - - return ERROR_OK; -} - -static int xlnx_pcie_xvc_transact(size_t num_bits, uint32_t tms, uint32_t tdi, - uint32_t *tdo) -{ - int err; - - err = xlnx_pcie_xvc_write_reg(XLNX_XVC_LEN_REG, num_bits); - if (err != ERROR_OK) - return err; - - err = xlnx_pcie_xvc_write_reg(XLNX_XVC_TMS_REG, tms); - if (err != ERROR_OK) - return err; - - err = xlnx_pcie_xvc_write_reg(XLNX_XVC_TDX_REG, tdi); - if (err != ERROR_OK) - return err; - - err = xlnx_pcie_xvc_read_reg(XLNX_XVC_TDX_REG, tdo); - if (err != ERROR_OK) - return err; - - if (tdo) - LOG_DEBUG_IO("Transact num_bits: %zu, tms: %" PRIx32 ", tdi: %" PRIx32 ", tdo: %" PRIx32, - num_bits, tms, tdi, *tdo); - else - LOG_DEBUG_IO("Transact num_bits: %zu, tms: %" PRIx32 ", tdi: %" PRIx32 ", tdo: <null>", - num_bits, tms, tdi); - return ERROR_OK; -} - -static int xlnx_pcie_xvc_execute_stableclocks(struct jtag_command *cmd) -{ - int tms = tap_get_state() == TAP_RESET ? 1 : 0; - size_t left = cmd->cmd.stableclocks->num_cycles; - size_t write; - int err; - - LOG_DEBUG("stableclocks %u cycles", cmd->cmd.runtest->num_cycles); - - while (left) { - write = MIN(XLNX_XVC_MAX_BITS, left); - err = xlnx_pcie_xvc_transact(write, tms, 0, NULL); - if (err != ERROR_OK) - return err; - left -= write; - }; - - return ERROR_OK; -} - -static int xlnx_pcie_xvc_execute_statemove(size_t skip) -{ - uint8_t tms_scan = tap_get_tms_path(tap_get_state(), - tap_get_end_state()); - int tms_count = tap_get_tms_path_len(tap_get_state(), - tap_get_end_state()); - int err; - - LOG_DEBUG("statemove starting at (skip: %zu) %s end in %s", skip, - tap_state_name(tap_get_state()), - tap_state_name(tap_get_end_state())); - - - err = xlnx_pcie_xvc_transact(tms_count - skip, tms_scan >> skip, 0, NULL); - if (err != ERROR_OK) - return err; - - tap_set_state(tap_get_end_state()); - - return ERROR_OK; -} - -static int xlnx_pcie_xvc_execute_runtest(struct jtag_command *cmd) -{ - int err = ERROR_OK; - - LOG_DEBUG("runtest %u cycles, end in %i", - cmd->cmd.runtest->num_cycles, - cmd->cmd.runtest->end_state); - - tap_state_t tmp_state = tap_get_end_state(); - - if (tap_get_state() != TAP_IDLE) { - tap_set_end_state(TAP_IDLE); - err = xlnx_pcie_xvc_execute_statemove(0); - if (err != ERROR_OK) - return err; - }; - - size_t left = cmd->cmd.runtest->num_cycles; - size_t write; - - while (left) { - write = MIN(XLNX_XVC_MAX_BITS, left); - err = xlnx_pcie_xvc_transact(write, 0, 0, NULL); - if (err != ERROR_OK) - return err; - left -= write; - }; - - tap_set_end_state(tmp_state); - if (tap_get_state() != tap_get_end_state()) - err = xlnx_pcie_xvc_execute_statemove(0); - - return err; -} - -static int xlnx_pcie_xvc_execute_pathmove(struct jtag_command *cmd) -{ - unsigned int num_states = cmd->cmd.pathmove->num_states; - tap_state_t *path = cmd->cmd.pathmove->path; - int err = ERROR_OK; - - LOG_DEBUG("pathmove: %u states, end in %i", - cmd->cmd.pathmove->num_states, - cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]); - - for (unsigned int i = 0; i < num_states; i++) { - if (path[i] == tap_state_transition(tap_get_state(), false)) { - err = xlnx_pcie_xvc_transact(1, 1, 0, NULL); - } else if (path[i] == tap_state_transition(tap_get_state(), true)) { - err = xlnx_pcie_xvc_transact(1, 0, 0, NULL); - } else { - LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition.", - tap_state_name(tap_get_state()), - tap_state_name(path[i])); - err = ERROR_JTAG_QUEUE_FAILED; - } - if (err != ERROR_OK) - return err; - tap_set_state(path[i]); - } - - tap_set_end_state(tap_get_state()); - - return ERROR_OK; -} - -static int xlnx_pcie_xvc_execute_scan(struct jtag_command *cmd) -{ - enum scan_type type = jtag_scan_type(cmd->cmd.scan); - tap_state_t saved_end_state = cmd->cmd.scan->end_state; - bool ir_scan = cmd->cmd.scan->ir_scan; - uint32_t tdi, tms, tdo; - uint8_t *buf, *rd_ptr; - int err, scan_size; - size_t write; - size_t left; - - scan_size = jtag_build_buffer(cmd->cmd.scan, &buf); - rd_ptr = buf; - LOG_DEBUG("%s scan type %d %d bits; starts in %s end in %s", - (cmd->cmd.scan->ir_scan) ? "IR" : "DR", type, scan_size, - tap_state_name(tap_get_state()), - tap_state_name(cmd->cmd.scan->end_state)); - - /* If we're in TAP_DR_SHIFT state but need to do a IR_SCAN or - * vice-versa, do a statemove to corresponding other state, then restore - * end state - */ - if (ir_scan && tap_get_state() != TAP_IRSHIFT) { - tap_set_end_state(TAP_IRSHIFT); - err = xlnx_pcie_xvc_execute_statemove(0); - if (err != ERROR_OK) - goto out_err; - tap_set_end_state(saved_end_state); - } else if (!ir_scan && (tap_get_state() != TAP_DRSHIFT)) { - tap_set_end_state(TAP_DRSHIFT); - err = xlnx_pcie_xvc_execute_statemove(0); - if (err != ERROR_OK) - goto out_err; - tap_set_end_state(saved_end_state); - } - - left = scan_size; - while (left) { - write = MIN(XLNX_XVC_MAX_BITS, left); - /* the last TMS should be a 1, to leave the state */ - tms = left <= XLNX_XVC_MAX_BITS ? BIT(write - 1) : 0; - tdi = (type != SCAN_IN) ? buf_get_u32(rd_ptr, 0, write) : 0; - err = xlnx_pcie_xvc_transact(write, tms, tdi, type != SCAN_OUT ? - &tdo : NULL); - if (err != ERROR_OK) - goto out_err; - left -= write; - if (type != SCAN_OUT) - buf_set_u32(rd_ptr, 0, write, tdo); - rd_ptr += sizeof(uint32_t); - }; - - err = jtag_read_buffer(buf, cmd->cmd.scan); - free(buf); - - if (tap_get_state() != tap_get_end_state()) - err = xlnx_pcie_xvc_execute_statemove(1); - - return err; - -out_err: - free(buf); - return err; -} - -static void xlnx_pcie_xvc_execute_reset(struct jtag_command *cmd) -{ - LOG_DEBUG("reset trst: %i srst: %i", cmd->cmd.reset->trst, - cmd->cmd.reset->srst); -} - -static void xlnx_pcie_xvc_execute_sleep(struct jtag_command *cmd) -{ - LOG_DEBUG("sleep %" PRIu32 "", cmd->cmd.sleep->us); - usleep(cmd->cmd.sleep->us); -} - -static int xlnx_pcie_xvc_execute_tms(struct jtag_command *cmd) -{ - const size_t num_bits = cmd->cmd.tms->num_bits; - const uint8_t *bits = cmd->cmd.tms->bits; - size_t left, write; - uint32_t tms; - int err; - - LOG_DEBUG("execute tms %zu", num_bits); - - left = num_bits; - while (left) { - write = MIN(XLNX_XVC_MAX_BITS, left); - tms = buf_get_u32(bits, 0, write); - err = xlnx_pcie_xvc_transact(write, tms, 0, NULL); - if (err != ERROR_OK) - return err; - left -= write; - bits += 4; - }; - - return ERROR_OK; -} - -static int xlnx_pcie_xvc_execute_command(struct jtag_command *cmd) -{ - LOG_DEBUG("%s: cmd->type: %u", __func__, cmd->type); - switch (cmd->type) { - case JTAG_STABLECLOCKS: - return xlnx_pcie_xvc_execute_stableclocks(cmd); - case JTAG_RUNTEST: - return xlnx_pcie_xvc_execute_runtest(cmd); - case JTAG_TLR_RESET: - tap_set_end_state(cmd->cmd.statemove->end_state); - return xlnx_pcie_xvc_execute_statemove(0); - case JTAG_PATHMOVE: - return xlnx_pcie_xvc_execute_pathmove(cmd); - case JTAG_SCAN: - return xlnx_pcie_xvc_execute_scan(cmd); - case JTAG_RESET: - xlnx_pcie_xvc_execute_reset(cmd); - break; - case JTAG_SLEEP: - xlnx_pcie_xvc_execute_sleep(cmd); - break; - case JTAG_TMS: - return xlnx_pcie_xvc_execute_tms(cmd); - default: - LOG_ERROR("BUG: Unknown JTAG command type encountered."); - return ERROR_JTAG_QUEUE_FAILED; - } - - return ERROR_OK; -} - -static int xlnx_pcie_xvc_execute_queue(struct jtag_command *cmd_queue) -{ - struct jtag_command *cmd = cmd_queue; - int ret; - - while (cmd) { - ret = xlnx_pcie_xvc_execute_command(cmd); - - if (ret != ERROR_OK) - return ret; - - cmd = cmd->next; - } - - return ERROR_OK; -} - - -static int xlnx_pcie_xvc_init(void) -{ - char filename[PATH_MAX]; - uint32_t cap, vh; - int err; - - snprintf(filename, PATH_MAX, "/sys/bus/pci/devices/%s/config", - xlnx_pcie_xvc->device); - xlnx_pcie_xvc->fd = open(filename, O_RDWR | O_SYNC); - if (xlnx_pcie_xvc->fd < 0) { - LOG_ERROR("Failed to open device: %s", filename); - return ERROR_JTAG_INIT_FAILED; - } - - LOG_INFO("Scanning PCIe device %s's for Xilinx XVC/PCIe ...", - xlnx_pcie_xvc->device); - /* Parse the PCIe extended capability list and try to find - * vendor specific header */ - xlnx_pcie_xvc->offset = PCIE_EXT_CAP_LST; - while (xlnx_pcie_xvc->offset <= PCI_CFG_SPACE_EXP_SIZE - sizeof(cap) && - xlnx_pcie_xvc->offset >= PCIE_EXT_CAP_LST) { - err = xlnx_pcie_xvc_read_reg(XLNX_XVC_EXT_CAP, &cap); - if (err != ERROR_OK) - return err; - LOG_DEBUG("Checking capability at 0x%x; id=0x%04" PRIx32 " version=0x%" PRIx32 " next=0x%" PRIx32, - xlnx_pcie_xvc->offset, - PCI_EXT_CAP_ID(cap), - PCI_EXT_CAP_VER(cap), - PCI_EXT_CAP_NEXT(cap)); - if (PCI_EXT_CAP_ID(cap) == PCI_EXT_CAP_ID_VNDR) { - err = xlnx_pcie_xvc_read_reg(XLNX_XVC_VSEC_HDR, &vh); - if (err != ERROR_OK) - return err; - LOG_DEBUG("Checking possible match at 0x%x; id: 0x%" PRIx32 "; rev: 0x%" PRIx32 "; length: 0x%" PRIx32, - xlnx_pcie_xvc->offset, - PCI_VNDR_HEADER_ID(vh), - PCI_VNDR_HEADER_REV(vh), - PCI_VNDR_HEADER_LEN(vh)); - if ((PCI_VNDR_HEADER_ID(vh) == XLNX_XVC_VSEC_ID) && - (PCI_VNDR_HEADER_LEN(vh) == XLNX_XVC_CAP_SIZE)) - break; - } - xlnx_pcie_xvc->offset = PCI_EXT_CAP_NEXT(cap); - } - if ((xlnx_pcie_xvc->offset > PCI_CFG_SPACE_EXP_SIZE - XLNX_XVC_CAP_SIZE) || - xlnx_pcie_xvc->offset < PCIE_EXT_CAP_LST) { - close(xlnx_pcie_xvc->fd); - return ERROR_JTAG_INIT_FAILED; - } - - LOG_INFO("Found Xilinx XVC/PCIe capability at offset: 0x%x", xlnx_pcie_xvc->offset); - - return ERROR_OK; -} - -static int xlnx_pcie_xvc_quit(void) -{ - int err; - - err = close(xlnx_pcie_xvc->fd); - if (err) - return err; - - return ERROR_OK; -} - -COMMAND_HANDLER(xlnx_pcie_xvc_handle_config_command) -{ - if (CMD_ARGC < 1) - return ERROR_COMMAND_SYNTAX_ERROR; - - /* we can't really free this in a safe manner, so at least - * limit the memory we're leaking by freeing the old one first - * before allocating a new one ... - */ - free(xlnx_pcie_xvc->device); - - xlnx_pcie_xvc->device = strdup(CMD_ARGV[0]); - return ERROR_OK; -} - -static const struct command_registration xlnx_pcie_xvc_subcommand_handlers[] = { - { - .name = "config", - .handler = xlnx_pcie_xvc_handle_config_command, - .mode = COMMAND_CONFIG, - .help = "Configure XVC/PCIe JTAG adapter", - .usage = "device", - }, - COMMAND_REGISTRATION_DONE -}; - -static const struct command_registration xlnx_pcie_xvc_command_handlers[] = { - { - .name = "xlnx_pcie_xvc", - .mode = COMMAND_ANY, - .help = "perform xlnx_pcie_xvc management", - .chain = xlnx_pcie_xvc_subcommand_handlers, - .usage = "", - }, - COMMAND_REGISTRATION_DONE -}; - -static struct jtag_interface xlnx_pcie_xvc_jtag_ops = { - .execute_queue = &xlnx_pcie_xvc_execute_queue, -}; - -static int xlnx_pcie_xvc_swd_sequence(const uint8_t *seq, size_t length) -{ - size_t left, write; - uint32_t send; - int err; - - left = length; - while (left) { - write = MIN(XLNX_XVC_MAX_BITS, left); - send = buf_get_u32(seq, 0, write); - err = xlnx_pcie_xvc_transact(write, send, 0, NULL); - if (err != ERROR_OK) - return err; - left -= write; - seq += sizeof(uint32_t); - }; - - return ERROR_OK; -} - -static int xlnx_pcie_xvc_swd_switch_seq(enum swd_special_seq seq) -{ - switch (seq) { - case LINE_RESET: - LOG_DEBUG("SWD line reset"); - return xlnx_pcie_xvc_swd_sequence(swd_seq_line_reset, - swd_seq_line_reset_len); - case JTAG_TO_SWD: - LOG_DEBUG("JTAG-to-SWD"); - return xlnx_pcie_xvc_swd_sequence(swd_seq_jtag_to_swd, - swd_seq_jtag_to_swd_len); - case SWD_TO_JTAG: - LOG_DEBUG("SWD-to-JTAG"); - return xlnx_pcie_xvc_swd_sequence(swd_seq_swd_to_jtag, - swd_seq_swd_to_jtag_len); - default: - LOG_ERROR("Sequence %d not supported", seq); - return ERROR_FAIL; - } - - return ERROR_OK; -} - -static int queued_retval; - -static void xlnx_pcie_xvc_swd_write_reg(uint8_t cmd, uint32_t value, - uint32_t ap_delay_clk); - -static void swd_clear_sticky_errors(void) -{ - xlnx_pcie_xvc_swd_write_reg(swd_cmd(false, false, DP_ABORT), - STKCMPCLR | STKERRCLR | WDERRCLR | ORUNERRCLR, 0); -} - -static void xlnx_pcie_xvc_swd_read_reg(uint8_t cmd, uint32_t *value, - uint32_t ap_delay_clk) -{ - uint32_t res, ack, rpar; - int err; - - assert(cmd & SWD_CMD_RNW); - - cmd |= SWD_CMD_START | SWD_CMD_PARK; - /* cmd + ack */ - err = xlnx_pcie_xvc_transact(12, cmd, 0, &res); - if (err != ERROR_OK) - goto err_out; - - ack = MASK_ACK(res); - - /* read data */ - err = xlnx_pcie_xvc_transact(32, 0, 0, &res); - if (err != ERROR_OK) - goto err_out; - - /* parity + trn */ - err = xlnx_pcie_xvc_transact(2, 0, 0, &rpar); - if (err != ERROR_OK) - goto err_out; - - LOG_DEBUG("%s %s %s reg %X = %08"PRIx32, - ack == SWD_ACK_OK ? "OK" : ack == SWD_ACK_WAIT ? - "WAIT" : ack == SWD_ACK_FAULT ? "FAULT" : "JUNK", - cmd & SWD_CMD_APNDP ? "AP" : "DP", - cmd & SWD_CMD_RNW ? "read" : "write", - (cmd & SWD_CMD_A32) >> 1, - res); - switch (ack) { - case SWD_ACK_OK: - if (MASK_PAR(rpar) != parity_u32(res)) { - LOG_DEBUG_IO("Wrong parity detected"); - queued_retval = ERROR_FAIL; - return; - } - if (value) - *value = res; - if (cmd & SWD_CMD_APNDP) - err = xlnx_pcie_xvc_transact(ap_delay_clk, 0, 0, NULL); - queued_retval = err; - return; - case SWD_ACK_WAIT: - LOG_DEBUG_IO("SWD_ACK_WAIT"); - swd_clear_sticky_errors(); - return; - case SWD_ACK_FAULT: - LOG_DEBUG_IO("SWD_ACK_FAULT"); - queued_retval = ack; - return; - default: - LOG_DEBUG_IO("No valid acknowledge: ack=%02"PRIx32, ack); - queued_retval = ack; - return; - } -err_out: - queued_retval = err; -} - -static void xlnx_pcie_xvc_swd_write_reg(uint8_t cmd, uint32_t value, - uint32_t ap_delay_clk) -{ - uint32_t res, ack; - int err; - - assert(!(cmd & SWD_CMD_RNW)); - - cmd |= SWD_CMD_START | SWD_CMD_PARK; - /* cmd + trn + ack */ - err = xlnx_pcie_xvc_transact(13, cmd, 0, &res); - if (err != ERROR_OK) - goto err_out; - - ack = MASK_ACK(res); - - /* write data */ - err = xlnx_pcie_xvc_transact(32, value, 0, NULL); - if (err != ERROR_OK) - goto err_out; - - /* parity + trn */ - err = xlnx_pcie_xvc_transact(2, parity_u32(value), 0, NULL); - if (err != ERROR_OK) - goto err_out; - - LOG_DEBUG("%s %s %s reg %X = %08"PRIx32, - ack == SWD_ACK_OK ? "OK" : ack == SWD_ACK_WAIT ? - "WAIT" : ack == SWD_ACK_FAULT ? "FAULT" : "JUNK", - cmd & SWD_CMD_APNDP ? "AP" : "DP", - cmd & SWD_CMD_RNW ? "read" : "write", - (cmd & SWD_CMD_A32) >> 1, - value); - - switch (ack) { - case SWD_ACK_OK: - if (cmd & SWD_CMD_APNDP) - err = xlnx_pcie_xvc_transact(ap_delay_clk, 0, 0, NULL); - queued_retval = err; - return; - case SWD_ACK_WAIT: - LOG_DEBUG_IO("SWD_ACK_WAIT"); - swd_clear_sticky_errors(); - return; - case SWD_ACK_FAULT: - LOG_DEBUG_IO("SWD_ACK_FAULT"); - queued_retval = ack; - return; - default: - LOG_DEBUG_IO("No valid acknowledge: ack=%02"PRIx32, ack); - queued_retval = ack; - return; - } - -err_out: - queued_retval = err; -} - -static int xlnx_pcie_xvc_swd_run_queue(void) -{ - int err; - - /* we want at least 8 idle cycles between each transaction */ - err = xlnx_pcie_xvc_transact(8, 0, 0, NULL); - if (err != ERROR_OK) - return err; - - err = queued_retval; - queued_retval = ERROR_OK; - LOG_DEBUG("SWD queue return value: %02x", err); - - return err; -} - -static int xlnx_pcie_xvc_swd_init(void) -{ - return ERROR_OK; -} - -static const struct swd_driver xlnx_pcie_xvc_swd_ops = { - .init = xlnx_pcie_xvc_swd_init, - .switch_seq = xlnx_pcie_xvc_swd_switch_seq, - .read_reg = xlnx_pcie_xvc_swd_read_reg, - .write_reg = xlnx_pcie_xvc_swd_write_reg, - .run = xlnx_pcie_xvc_swd_run_queue, -}; - -static const char * const xlnx_pcie_xvc_transports[] = { "jtag", "swd", NULL }; - -struct adapter_driver xlnx_pcie_xvc_adapter_driver = { - .name = "xlnx_pcie_xvc", - .transports = xlnx_pcie_xvc_transports, - .commands = xlnx_pcie_xvc_command_handlers, - - .init = &xlnx_pcie_xvc_init, - .quit = &xlnx_pcie_xvc_quit, - - .jtag_ops = &xlnx_pcie_xvc_jtag_ops, - .swd_ops = &xlnx_pcie_xvc_swd_ops, -}; diff --git a/src/jtag/drivers/xlnx-xvc.c b/src/jtag/drivers/xlnx-xvc.c new file mode 100644 index 0000000000..c83e385cfd --- /dev/null +++ b/src/jtag/drivers/xlnx-xvc.c @@ -0,0 +1,1120 @@ +// SPDX-License-Identifier: GPL-2.0-only + +/* + * Copyright (C) 2019 Google, LLC. + * Moritz Fischer <mori...@google.com> + * + * Copyright (C) 2021 Western Digital Corporation or its affiliates + * Jeremy Garff <jeremy.ga...@wdc.com> + * + * Copyright (C) 2024 Inria + * Nicolas Derumigny <nicolas.derumi...@inria.fr> + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include <stdint.h> +#include <stdlib.h> +#include <unistd.h> +#include <linux/pci.h> +#include <sys/mman.h> + +#include <jtag/interface.h> +#include <jtag/swd.h> +#include <jtag/commands.h> +#include <helper/replacements.h> +#include <helper/bits.h> + +#include <gpiod.h> + +/* Available only from kernel v4.10 */ +#ifndef PCI_CFG_SPACE_EXP_SIZE +#define PCI_CFG_SPACE_EXP_SIZE 4096 +#endif + +#define PCIE_EXT_CAP_LST 0x100 + +#define XLNX_PCIE_XVC_EXT_CAP 0x00 +#define XLNX_PCIE_XVC_VSEC_HDR 0x04 +#define XLNX_PCIE_XVC_LEN_REG 0x0C +#define XLNX_PCIE_XVC_TMS_REG 0x10 +#define XLNX_PCIE_XVC_TDX_REG 0x14 + +#define XLNX_PCIE_XVC_CAP_SIZE 0x20 +#define XLNX_PCIE_XVC_VSEC_ID 0x8 + +#define XLNX_AXI_XVC_LEN_REG 0x00 +#define XLNX_AXI_XVC_TMS_REG 0x04 +#define XLNX_AXI_XVC_TDI_REG 0x08 +#define XLNX_AXI_XVC_TDO_REG 0x0c +#define XLNX_AXI_XVC_CTRL_REG 0x10 +#define XLNX_AXI_XVC_MAX_REG 0x18 + +#define XLNX_AXI_XVC_CTRL_REG_ENABLE_MASK 0x01 + +#define XLNX_XVC_MAX_BITS 0x20 + +#define MASK_ACK(x) (((x) >> 9) & 0x7) +#define MASK_PAR(x) ((int)((x) & 0x1)) + +struct xlnx_pcie_xvc { + int fd; + unsigned int offset; + char *device; +}; + +struct xlnx_axi_signal { + char *name; + struct gpiod_line *line; +}; + +struct xlnx_axi_xvc { + int fd; + uint32_t *base; + char *device; + struct xlnx_axi_signal trst; + struct xlnx_axi_signal srst; +}; + +enum xlnx_xvc_type_t { + PCIE, + AXI +}; + +static struct xlnx_pcie_xvc xlnx_pcie_xvc_state; +static struct xlnx_pcie_xvc *xlnx_pcie_xvc = &xlnx_pcie_xvc_state; +static struct xlnx_axi_xvc xlnx_axi_xvc_state; +static struct xlnx_axi_xvc *xlnx_axi_xvc = &xlnx_axi_xvc_state; + +static int xlnx_pcie_xvc_read_reg(const int offset, uint32_t *val) +{ + uint32_t res; + int err; + + /* Note: This should be ok endianness-wise because by going + * through sysfs the kernel does the conversion in the config + * space accessor functions + */ + err = pread(xlnx_pcie_xvc->fd, &res, sizeof(res), + xlnx_pcie_xvc->offset + offset); + if (err != sizeof(res)) { + LOG_ERROR("Failed to read offset 0x%x", offset); + return ERROR_JTAG_DEVICE_ERROR; + } + + if (val) + *val = res; + + return ERROR_OK; +} + +static int xlnx_axi_xvc_read_reg(const int offset, uint32_t *val) +{ + uintptr_t b = ((uintptr_t)xlnx_axi_xvc->base) + offset; + volatile uint32_t *w = (uint32_t *)b; + + if (val) { + __sync_synchronize(); + *val = *w; + } + + return ERROR_OK; +} + +static int xlnx_pcie_xvc_write_reg(const int offset, const uint32_t val) +{ + int err; + + /* Note: This should be ok endianness-wise because by going + * through sysfs the kernel does the conversion in the config + * space accessor functions + */ + err = pwrite(xlnx_pcie_xvc->fd, &val, sizeof(val), + xlnx_pcie_xvc->offset + offset); + if (err != sizeof(val)) { + LOG_ERROR("Failed to write offset: 0x%x with value: %" PRIx32, + offset, val); + return ERROR_JTAG_DEVICE_ERROR; + } + + return ERROR_OK; +} + +static int xlnx_axi_xvc_write_reg(const int offset, const uint32_t val) +{ + uintptr_t b = ((uintptr_t)xlnx_axi_xvc->base) + offset; + volatile uint32_t *w = (uint32_t *)b; + + *w = val; + __sync_synchronize(); + + return ERROR_OK; +} + +static int xlnx_pcie_xvc_transact(size_t num_bits, uint32_t tms, uint32_t tdi, + uint32_t *tdo) +{ + int err; + + err = xlnx_pcie_xvc_write_reg(XLNX_PCIE_XVC_LEN_REG, num_bits); + if (err != ERROR_OK) + return err; + + err = xlnx_pcie_xvc_write_reg(XLNX_PCIE_XVC_TMS_REG, tms); + if (err != ERROR_OK) + return err; + + err = xlnx_pcie_xvc_write_reg(XLNX_PCIE_XVC_TDX_REG, tdi); + if (err != ERROR_OK) + return err; + + err = xlnx_pcie_xvc_read_reg(XLNX_PCIE_XVC_TDX_REG, tdo); + if (err != ERROR_OK) + return err; + + if (tdo) + LOG_DEBUG_IO("Transact num_bits: %zu, tms: %" PRIx32 ", tdi: %" PRIx32 ", tdo: %" PRIx32, + num_bits, tms, tdi, *tdo); + else + LOG_DEBUG_IO("Transact num_bits: %zu, tms: %" PRIx32 ", tdi: %" PRIx32 ", tdo: <null>", + num_bits, tms, tdi); + return ERROR_OK; +} + +static int xlnx_axi_xvc_transact(size_t num_bits, uint32_t tms, uint32_t tdi, + uint32_t *tdo) +{ + uint32_t ctrl; + int done = 0; + int err; + + err = xlnx_axi_xvc_write_reg(XLNX_AXI_XVC_LEN_REG, num_bits); + if (err != ERROR_OK) + return err; + + err = xlnx_axi_xvc_write_reg(XLNX_AXI_XVC_TMS_REG, tms); + if (err != ERROR_OK) + return err; + + err = xlnx_axi_xvc_write_reg(XLNX_AXI_XVC_TDI_REG, tdi); + if (err != ERROR_OK) + return err; + + err = xlnx_axi_xvc_write_reg(XLNX_AXI_XVC_CTRL_REG, XLNX_AXI_XVC_CTRL_REG_ENABLE_MASK); + if (err != ERROR_OK) + return err; + + while (!done) { + err = xlnx_axi_xvc_read_reg(XLNX_AXI_XVC_CTRL_REG, &ctrl); + if (err != ERROR_OK) + return err; + + if (!(ctrl & XLNX_AXI_XVC_CTRL_REG_ENABLE_MASK)) + done = 1; + + /* + There is no delay here intentionally. The usleep() + function doesn't block and burns CPU cycles anyway. + The turnaround time is fast enough at high JTAG rates + that adding the call can slow down the overall + throughput. So we'll just sacrifice the CPU to get + best performance. + + Additionally there is no timeout. The underlying + hardware is guaranteed to unset the enable bit within + 32 JTAG clock cycles. There is no hardware condition + that will keep it set forever. Essentially, the hardware + is also our timeout mechanism. + */ + } + + err = xlnx_axi_xvc_read_reg(XLNX_AXI_XVC_TDO_REG, tdo); + if (err != ERROR_OK) + return err; + + if (tdo) + LOG_DEBUG_IO("Transact num_bits: %zu, tms: 0x%x, tdi: 0x%x, tdo: 0x%x", + num_bits, tms, tdi, *tdo); + else + LOG_DEBUG_IO("Transact num_bits: %zu, tms: 0x%x, tdi: 0x%x, tdo: <null>", + num_bits, tms, tdi); + return ERROR_OK; +} + +static int xlnx_xvc_transact(size_t num_bits, uint32_t tms, uint32_t tdi, + uint32_t *tdo, enum xlnx_xvc_type_t xvc_type) +{ + if (xvc_type == PCIE) + return xlnx_pcie_xvc_transact(num_bits, tms, tdi, tdo); + assert(xvc_type == AXI); + return xlnx_axi_xvc_transact(num_bits, tms, tdi, tdo); +} + +static int xlnx_xvc_execute_stableclocks(struct jtag_command *cmd, enum xlnx_xvc_type_t xvc_type) +{ + int tms = tap_get_state() == TAP_RESET ? 1 : 0; + size_t left = cmd->cmd.stableclocks->num_cycles; + size_t write; + int err; + + LOG_DEBUG("stableclocks %u cycles", cmd->cmd.runtest->num_cycles); + + while (left) { + write = MIN(XLNX_XVC_MAX_BITS, left); + err = xlnx_xvc_transact(write, tms, 0, NULL, xvc_type); + if (err != ERROR_OK) + return err; + left -= write; + }; + + return ERROR_OK; +} + +static int xlnx_xvc_execute_statemove(size_t skip, enum xlnx_xvc_type_t xvc_type) +{ + uint8_t tms_scan = tap_get_tms_path(tap_get_state(), + tap_get_end_state()); + int tms_count = tap_get_tms_path_len(tap_get_state(), + tap_get_end_state()); + int err; + + LOG_DEBUG("statemove starting at (skip: %zu) %s end in %s", skip, + tap_state_name(tap_get_state()), + tap_state_name(tap_get_end_state())); + + + err = xlnx_xvc_transact(tms_count - skip, tms_scan >> skip, 0, NULL, xvc_type); + if (err != ERROR_OK) + return err; + + tap_set_state(tap_get_end_state()); + + return ERROR_OK; +} + +static int xlnx_xvc_execute_runtest(struct jtag_command *cmd, + enum xlnx_xvc_type_t xvc_type) +{ + int err = ERROR_OK; + + LOG_DEBUG("runtest %u cycles, end in %i", + cmd->cmd.runtest->num_cycles, + cmd->cmd.runtest->end_state); + + tap_state_t tmp_state = tap_get_end_state(); + + if (tap_get_state() != TAP_IDLE) { + tap_set_end_state(TAP_IDLE); + err = xlnx_xvc_execute_statemove(0, xvc_type); + if (err != ERROR_OK) + return err; + }; + + size_t left = cmd->cmd.runtest->num_cycles; + size_t write; + + while (left) { + write = MIN(XLNX_XVC_MAX_BITS, left); + err = xlnx_xvc_transact(write, 0, 0, NULL, xvc_type); + if (err != ERROR_OK) + return err; + left -= write; + }; + + tap_set_end_state(tmp_state); + if (tap_get_state() != tap_get_end_state()) + err = xlnx_xvc_execute_statemove(0, xvc_type); + + return err; +} + +static int xlnx_xvc_execute_pathmove(struct jtag_command *cmd, + enum xlnx_xvc_type_t xvc_type) +{ + unsigned int num_states = cmd->cmd.pathmove->num_states; + tap_state_t *path = cmd->cmd.pathmove->path; + int err = ERROR_OK; + + LOG_DEBUG("pathmove: %u states, end in %i", + cmd->cmd.pathmove->num_states, + cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]); + + for (unsigned int i = 0; i < num_states; i++) { + if (path[i] == tap_state_transition(tap_get_state(), false)) { + err = xlnx_xvc_transact(1, 1, 0, NULL, xvc_type); + } else if (path[i] == tap_state_transition(tap_get_state(), true)) { + err = xlnx_xvc_transact(1, 0, 0, NULL, xvc_type); + } else { + LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition.", + tap_state_name(tap_get_state()), + tap_state_name(path[i])); + err = ERROR_JTAG_QUEUE_FAILED; + } + if (err != ERROR_OK) + return err; + tap_set_state(path[i]); + } + + tap_set_end_state(tap_get_state()); + + return ERROR_OK; +} + +static int xlnx_xvc_execute_scan(struct jtag_command *cmd, + enum xlnx_xvc_type_t xvc_type) +{ + enum scan_type type = jtag_scan_type(cmd->cmd.scan); + tap_state_t saved_end_state = cmd->cmd.scan->end_state; + bool ir_scan = cmd->cmd.scan->ir_scan; + uint32_t tdi, tms, tdo; + uint8_t *buf, *rd_ptr; + int err, scan_size; + size_t write; + size_t left; + + scan_size = jtag_build_buffer(cmd->cmd.scan, &buf); + rd_ptr = buf; + LOG_DEBUG("%s scan type %d %d bits; starts in %s end in %s", + (cmd->cmd.scan->ir_scan) ? "IR" : "DR", type, scan_size, + tap_state_name(tap_get_state()), + tap_state_name(cmd->cmd.scan->end_state)); + + /* If we're in TAP_DR_SHIFT state but need to do a IR_SCAN or + * vice-versa, do a statemove to corresponding other state, then restore + * end state + */ + if (ir_scan && tap_get_state() != TAP_IRSHIFT) { + tap_set_end_state(TAP_IRSHIFT); + err = xlnx_xvc_execute_statemove(0, xvc_type); + if (err != ERROR_OK) + goto out_err; + tap_set_end_state(saved_end_state); + } else if (!ir_scan && (tap_get_state() != TAP_DRSHIFT)) { + tap_set_end_state(TAP_DRSHIFT); + err = xlnx_xvc_execute_statemove(0, xvc_type); + if (err != ERROR_OK) + goto out_err; + tap_set_end_state(saved_end_state); + } + + left = scan_size; + while (left) { + write = MIN(XLNX_XVC_MAX_BITS, left); + /* the last TMS should be a 1, to leave the state */ + tms = left <= XLNX_XVC_MAX_BITS ? BIT(write - 1) : 0; + tdi = (type != SCAN_IN) ? buf_get_u32(rd_ptr, 0, write) : 0; + err = xlnx_xvc_transact(write, tms, tdi, type != SCAN_OUT ? + &tdo : NULL, xvc_type); + if (err != ERROR_OK) + goto out_err; + left -= write; + if (type != SCAN_OUT) + buf_set_u32(rd_ptr, 0, write, tdo); + rd_ptr += sizeof(uint32_t); + }; + + err = jtag_read_buffer(buf, cmd->cmd.scan); + free(buf); + + if (tap_get_state() != tap_get_end_state()) + err = xlnx_xvc_execute_statemove(1, xvc_type); + + return err; + +out_err: + free(buf); + return err; +} + +static void xlnx_xvc_execute_reset(struct jtag_command *cmd, + enum xlnx_xvc_type_t xvc_type) +{ + LOG_DEBUG("reset trst: %i srst: %i", cmd->cmd.reset->trst, + cmd->cmd.reset->srst); + + if (xvc_type == AXI) { + if (xlnx_axi_xvc->srst.line) { + gpiod_line_set_value(xlnx_axi_xvc->srst.line, + cmd->cmd.reset->srst ? 0 : 1); + } + + if (xlnx_axi_xvc->trst.line) { + if (cmd->cmd.reset->trst) + tap_set_state(TAP_RESET); + + gpiod_line_set_value(xlnx_axi_xvc->trst.line, + cmd->cmd.reset->trst ? 0 : 1); + } + } +} + +static void xlnx_xvc_execute_sleep(struct jtag_command *cmd) +{ + LOG_DEBUG("sleep %" PRIu32 "", cmd->cmd.sleep->us); + usleep(cmd->cmd.sleep->us); +} + +static int xlnx_xvc_execute_tms(struct jtag_command *cmd, + enum xlnx_xvc_type_t xvc_type) +{ + const size_t num_bits = cmd->cmd.tms->num_bits; + const uint8_t *bits = cmd->cmd.tms->bits; + size_t left, write; + uint32_t tms; + int err; + + LOG_DEBUG("execute tms %zu", num_bits); + + left = num_bits; + while (left) { + write = MIN(XLNX_XVC_MAX_BITS, left); + tms = buf_get_u32(bits, 0, write); + err = xlnx_xvc_transact(write, tms, 0, NULL, xvc_type); + if (err != ERROR_OK) + return err; + left -= write; + bits += 4; + }; + + return ERROR_OK; +} + +static int xlnx_xvc_execute_command(struct jtag_command *cmd, + enum xlnx_xvc_type_t xvc_type) +{ + LOG_DEBUG("%s: cmd->type: %u", __func__, cmd->type); + switch (cmd->type) { + case JTAG_STABLECLOCKS: + return xlnx_xvc_execute_stableclocks(cmd, xvc_type); + case JTAG_RUNTEST: + return xlnx_xvc_execute_runtest(cmd, xvc_type); + case JTAG_TLR_RESET: + tap_set_end_state(cmd->cmd.statemove->end_state); + return xlnx_xvc_execute_statemove(0, xvc_type); + case JTAG_PATHMOVE: + return xlnx_xvc_execute_pathmove(cmd, xvc_type); + case JTAG_SCAN: + return xlnx_xvc_execute_scan(cmd, xvc_type); + case JTAG_RESET: + xlnx_xvc_execute_reset(cmd, xvc_type); + break; + case JTAG_SLEEP: + xlnx_xvc_execute_sleep(cmd); + break; + case JTAG_TMS: + return xlnx_xvc_execute_tms(cmd, xvc_type); + default: + LOG_ERROR("BUG: Unknown JTAG command type encountered."); + return ERROR_JTAG_QUEUE_FAILED; + } + + return ERROR_OK; +} + +static int xlnx_xvc_execute_queue(struct jtag_command *cmd_queue, + enum xlnx_xvc_type_t xvc_type) +{ + struct jtag_command *cmd = cmd_queue; + int ret; + + while (cmd) { + ret = xlnx_xvc_execute_command(cmd, xvc_type); + + if (ret != ERROR_OK) + return ret; + + cmd = cmd->next; + } + + return ERROR_OK; +} + +static int xlnx_pcie_xvc_execute_queue(struct jtag_command *cmd_queue) +{ + return xlnx_xvc_execute_queue(cmd_queue, PCIE); +} + +static int xlnx_axi_xvc_execute_queue(struct jtag_command *cmd_queue) +{ + return xlnx_xvc_execute_queue(cmd_queue, AXI); +} + +static int xlnx_pcie_xvc_init(void) +{ + char filename[PATH_MAX]; + uint32_t cap, vh; + int err; + + snprintf(filename, PATH_MAX, "/sys/bus/pci/devices/%s/config", + xlnx_pcie_xvc->device); + xlnx_pcie_xvc->fd = open(filename, O_RDWR | O_SYNC); + if (xlnx_pcie_xvc->fd < 0) { + LOG_ERROR("Failed to open device: %s", filename); + return ERROR_JTAG_INIT_FAILED; + } + + LOG_INFO("Scanning PCIe device %s's for Xilinx XVC/PCIe ...", + xlnx_pcie_xvc->device); + /* Parse the PCIe extended capability list and try to find + * vendor specific header */ + xlnx_pcie_xvc->offset = PCIE_EXT_CAP_LST; + while (xlnx_pcie_xvc->offset <= PCI_CFG_SPACE_EXP_SIZE - sizeof(cap) && + xlnx_pcie_xvc->offset >= PCIE_EXT_CAP_LST) { + err = xlnx_pcie_xvc_read_reg(XLNX_PCIE_XVC_EXT_CAP, &cap); + if (err != ERROR_OK) + return err; + LOG_DEBUG("Checking capability at 0x%x; id=0x%04" PRIx32 " version=0x%" PRIx32 " next=0x%" PRIx32, + xlnx_pcie_xvc->offset, + PCI_EXT_CAP_ID(cap), + PCI_EXT_CAP_VER(cap), + PCI_EXT_CAP_NEXT(cap)); + if (PCI_EXT_CAP_ID(cap) == PCI_EXT_CAP_ID_VNDR) { + err = xlnx_pcie_xvc_read_reg(XLNX_PCIE_XVC_VSEC_HDR, &vh); + if (err != ERROR_OK) + return err; + LOG_DEBUG("Checking possible match at 0x%x; id: 0x%" PRIx32 "; rev: 0x%" PRIx32 "; length: 0x%" PRIx32, + xlnx_pcie_xvc->offset, + PCI_VNDR_HEADER_ID(vh), + PCI_VNDR_HEADER_REV(vh), + PCI_VNDR_HEADER_LEN(vh)); + if ((PCI_VNDR_HEADER_ID(vh) == XLNX_PCIE_XVC_VSEC_ID) && + (PCI_VNDR_HEADER_LEN(vh) == XLNX_PCIE_XVC_CAP_SIZE)) + break; + } + xlnx_pcie_xvc->offset = PCI_EXT_CAP_NEXT(cap); + } + if ((xlnx_pcie_xvc->offset > PCI_CFG_SPACE_EXP_SIZE - XLNX_PCIE_XVC_CAP_SIZE) || + xlnx_pcie_xvc->offset < PCIE_EXT_CAP_LST) { + close(xlnx_pcie_xvc->fd); + return ERROR_JTAG_INIT_FAILED; + } + + LOG_INFO("Found Xilinx XVC/PCIe capability at offset: 0x%x", xlnx_pcie_xvc->offset); + + return ERROR_OK; +} + +static int xlnx_axi_xvc_gpio_init(char *name, struct gpiod_line **line) +{ + struct gpiod_line_request_config config = { + .request_type = GPIOD_LINE_REQUEST_DIRECTION_OUTPUT, + }; + int result; + + /* Lookup the signal by name */ + *line = gpiod_line_find(name); + if (!*line) { + LOG_ERROR("GPIO Lookup failed for signal %s, check device-tree\n", + name); + return ERROR_JTAG_INIT_FAILED; + } + + /* Request the signal and set the direction and default value */ + result = gpiod_line_request(*line, &config, 1); + if (result) { + LOG_ERROR("Unable to request GPIO signals %s\n", name); + return ERROR_JTAG_INIT_FAILED; + } + + return ERROR_OK; +} + +static int xlnx_axi_xvc_init(void) +{ + uint64_t baseaddr; + + if (xlnx_axi_xvc->device) { + baseaddr = strtoul(xlnx_axi_xvc->device, NULL, 0); + } else { + LOG_ERROR("Please set device addr."); + return ERROR_JTAG_INIT_FAILED; + } + + xlnx_axi_xvc->fd = open("/dev/mem", O_RDWR | O_SYNC); + if (xlnx_axi_xvc->fd < 0) { + LOG_ERROR("Failed to open /dev/mem. Check permissions."); + return ERROR_JTAG_INIT_FAILED; + } + + xlnx_axi_xvc->base = mmap(0, XLNX_AXI_XVC_MAX_REG, PROT_READ | PROT_WRITE, + MAP_SHARED, xlnx_axi_xvc->fd, baseaddr); + if (xlnx_axi_xvc->base == MAP_FAILED) { + LOG_ERROR("mmap() failed. Check permissions."); + close(xlnx_axi_xvc->fd); + return ERROR_JTAG_INIT_FAILED; + } + + LOG_INFO("Mapped Xilinx XVC/AXI vaddr %p paddr 0x%lx", + xlnx_axi_xvc->base, baseaddr); + + if (xlnx_axi_xvc->trst.name) { + int result = xlnx_axi_xvc_gpio_init(xlnx_axi_xvc->trst.name, + &xlnx_axi_xvc->trst.line); + if (result) { + LOG_ERROR("Failed to init TRST"); + return result; + } + + LOG_INFO("Using signal %s for TRST", xlnx_axi_xvc->trst.name); + } + + if (xlnx_axi_xvc->srst.name) { + int result = xlnx_axi_xvc_gpio_init(xlnx_axi_xvc->srst.name, + &xlnx_axi_xvc->srst.line); + if (result) { + LOG_ERROR("Failed to init SRST"); + return result; + } + + LOG_INFO("Using signal %s for SRST", xlnx_axi_xvc->srst.name); + } + + return ERROR_OK; +} + +static int xlnx_pcie_xvc_quit(void) +{ + int err; + + err = close(xlnx_pcie_xvc->fd); + if (err) + return err; + + return ERROR_OK; +} + +static int xlnx_axi_xvc_quit(void) +{ + int err; + + munmap(xlnx_axi_xvc->base, XLNX_AXI_XVC_MAX_REG); + + err = close(xlnx_axi_xvc->fd); + if (err) + return err; + + return ERROR_OK; +} + +COMMAND_HANDLER(xlnx_pcie_xvc_handle_config_command) +{ + if (CMD_ARGC < 1) + return ERROR_COMMAND_SYNTAX_ERROR; + + /* we can't really free this in a safe manner, so at least + * limit the memory we're leaking by freeing the old one first + * before allocating a new one ... + */ + free(xlnx_pcie_xvc->device); + + xlnx_pcie_xvc->device = strdup(CMD_ARGV[0]); + return ERROR_OK; +} + +COMMAND_HANDLER(xlnx_axi_xvc_handle_dev_addr_command) +{ + if (CMD_ARGC < 1) + return ERROR_COMMAND_SYNTAX_ERROR; + + /* we can't really free this in a safe manner, so at least + * limit the memory we're leaking by freeing the old one first + * before allocating a new one ... + */ + if (xlnx_axi_xvc->device) + free(xlnx_axi_xvc->device); + + xlnx_axi_xvc->device = strdup(CMD_ARGV[0]); + + return ERROR_OK; +} + +COMMAND_HANDLER(xlnx_axi_xvc_handle_srst_command) +{ + if (CMD_ARGC < 1) + return ERROR_COMMAND_SYNTAX_ERROR; + + /* we can't really free this in a safe manner, so at least + * limit the memory we're leaking by freeing the old one first + * before allocating a new one ... + */ + if (xlnx_axi_xvc->srst.name) + free(xlnx_axi_xvc->srst.name); + + xlnx_axi_xvc->srst.name = strdup(CMD_ARGV[0]); + + return ERROR_OK; +} + +COMMAND_HANDLER(xlnx_axi_xvc_handle_trst_command) +{ + if (CMD_ARGC < 1) + return ERROR_COMMAND_SYNTAX_ERROR; + + /* we can't really free this in a safe manner, so at least + * limit the memory we're leaking by freeing the old one first + * before allocating a new one ... + */ + if (xlnx_axi_xvc->trst.name) + free(xlnx_axi_xvc->trst.name); + + xlnx_axi_xvc->trst.name = strdup(CMD_ARGV[0]); + + return ERROR_OK; +} + +static const struct command_registration xlnx_pcie_xvc_subcommand_handlers[] = { + { + .name = "config", + .handler = xlnx_pcie_xvc_handle_config_command, + .mode = COMMAND_CONFIG, + .help = "Configure XVC/PCIe JTAG adapter", + .usage = "device", + }, + COMMAND_REGISTRATION_DONE +}; + +static const struct command_registration xlnx_pcie_xvc_command_handlers[] = { + { + .name = "xlnx_pcie_xvc", + .mode = COMMAND_ANY, + .help = "perform xlnx_pcie_xvc management", + .chain = xlnx_pcie_xvc_subcommand_handlers, + .usage = "", + }, + COMMAND_REGISTRATION_DONE +}; + +static const struct command_registration xlnx_axi_xvc_subcommand_handlers[] = { + { + .name = "dev_addr", + .handler = xlnx_axi_xvc_handle_dev_addr_command, + .mode = COMMAND_CONFIG, + .help = "Configure XVC/AXI JTAG device memory address", + .usage = "addr", + }, + { + .name = "trst", + .handler = xlnx_axi_xvc_handle_trst_command, + .mode = COMMAND_CONFIG, + .help = "Configure XVC/AXI JTAG TRST GPIO name", + .usage = "trst_gpio_signal_name", + }, + { + .name = "srst", + .handler = xlnx_axi_xvc_handle_srst_command, + .mode = COMMAND_CONFIG, + .help = "Configure XVC/AXI JTAG SRST GPIOD name", + .usage = "srst_gpio_signal_name", + }, + COMMAND_REGISTRATION_DONE +}; + +static const struct command_registration xlnx_axi_xvc_command_handlers[] = { + { + .name = "xlnx_axi_xvc", + .mode = COMMAND_ANY, + .help = "perform xlnx_axi_xvc management", + .chain = xlnx_axi_xvc_subcommand_handlers, + .usage = "", + }, + COMMAND_REGISTRATION_DONE +}; + +static struct jtag_interface xlnx_pcie_xvc_jtag_ops = { + .execute_queue = &xlnx_pcie_xvc_execute_queue, +}; + +static struct jtag_interface xlnx_axi_xvc_jtag_ops = { + .execute_queue = &xlnx_axi_xvc_execute_queue, +}; + +static int xlnx_xvc_swd_sequence(const uint8_t *seq, size_t length, + enum xlnx_xvc_type_t xvc_type) +{ + size_t left, write; + uint32_t send; + int err; + + left = length; + while (left) { + write = MIN(XLNX_XVC_MAX_BITS, left); + send = buf_get_u32(seq, 0, write); + err = xlnx_xvc_transact(write, send, 0, NULL, xvc_type); + if (err != ERROR_OK) + return err; + left -= write; + seq += sizeof(uint32_t); + }; + + return ERROR_OK; +} + +static int xlnx_xvc_swd_switch_seq(enum swd_special_seq seq, + enum xlnx_xvc_type_t xvc_type) +{ + switch (seq) { + case LINE_RESET: + LOG_DEBUG("SWD line reset"); + return xlnx_xvc_swd_sequence(swd_seq_line_reset, + swd_seq_line_reset_len, xvc_type); + case JTAG_TO_SWD: + LOG_DEBUG("JTAG-to-SWD"); + return xlnx_xvc_swd_sequence(swd_seq_jtag_to_swd, + swd_seq_jtag_to_swd_len, xvc_type); + case SWD_TO_JTAG: + LOG_DEBUG("SWD-to-JTAG"); + return xlnx_xvc_swd_sequence(swd_seq_swd_to_jtag, + swd_seq_swd_to_jtag_len, xvc_type); + default: + LOG_ERROR("Sequence %d not supported", seq); + return ERROR_FAIL; + } + + return ERROR_OK; +} + +static int xlnx_pcie_xvc_swd_switch_seq(enum swd_special_seq seq) +{ + return xlnx_xvc_swd_switch_seq(seq, PCIE); +} + +static int xlnx_axi_xvc_swd_switch_seq(enum swd_special_seq seq) +{ + return xlnx_xvc_swd_switch_seq(seq, AXI); +} + +static int queued_retval; + +static void xlnx_xvc_swd_write_reg(uint8_t cmd, uint32_t value, + uint32_t ap_delay_clk, + enum xlnx_xvc_type_t xvc_type); + +static void swd_clear_sticky_errors(enum xlnx_xvc_type_t xvc_type) +{ + xlnx_xvc_swd_write_reg(swd_cmd(false, false, DP_ABORT), + STKCMPCLR | STKERRCLR | WDERRCLR | ORUNERRCLR, 0, xvc_type); +} + +static void xlnx_xvc_swd_read_reg(uint8_t cmd, uint32_t *value, + uint32_t ap_delay_clk, + enum xlnx_xvc_type_t xvc_type) +{ + uint32_t res, ack, rpar; + int err; + + assert(cmd & SWD_CMD_RNW); + + cmd |= SWD_CMD_START | SWD_CMD_PARK; + /* cmd + ack */ + err = xlnx_xvc_transact(12, cmd, 0, &res, xvc_type); + if (err != ERROR_OK) + goto err_out; + + ack = MASK_ACK(res); + + /* read data */ + err = xlnx_xvc_transact(32, 0, 0, &res, xvc_type); + if (err != ERROR_OK) + goto err_out; + + /* parity + trn */ + err = xlnx_xvc_transact(2, 0, 0, &rpar, xvc_type); + if (err != ERROR_OK) + goto err_out; + + LOG_DEBUG("%s %s %s reg %X = %08" PRIx32, + ack == SWD_ACK_OK ? "OK" : ack == SWD_ACK_WAIT ? + "WAIT" : ack == SWD_ACK_FAULT ? "FAULT" : "JUNK", + cmd & SWD_CMD_APNDP ? "AP" : "DP", + cmd & SWD_CMD_RNW ? "read" : "write", + (cmd & SWD_CMD_A32) >> 1, + res); + switch (ack) { + case SWD_ACK_OK: + if (MASK_PAR(rpar) != parity_u32(res)) { + LOG_DEBUG_IO("Wrong parity detected"); + queued_retval = ERROR_FAIL; + return; + } + if (value) + *value = res; + if (cmd & SWD_CMD_APNDP) + err = xlnx_xvc_transact(ap_delay_clk, 0, 0, NULL, xvc_type); + queued_retval = err; + return; + case SWD_ACK_WAIT: + LOG_DEBUG_IO("SWD_ACK_WAIT"); + swd_clear_sticky_errors(xvc_type); + return; + case SWD_ACK_FAULT: + LOG_DEBUG_IO("SWD_ACK_FAULT"); + queued_retval = ack; + return; + default: + LOG_DEBUG_IO("No valid acknowledge: ack=%02" PRIx32, ack); + queued_retval = ack; + return; + } +err_out: + queued_retval = err; +} + +static void xlnx_pcie_xvc_swd_read_reg(uint8_t cmd, uint32_t *value, + uint32_t ap_delay_clk) +{ + xlnx_xvc_swd_read_reg(cmd, value, ap_delay_clk, PCIE); +} + +static void xlnx_axi_xvc_swd_read_reg(uint8_t cmd, uint32_t *value, + uint32_t ap_delay_clk) +{ + xlnx_xvc_swd_read_reg(cmd, value, ap_delay_clk, AXI); +} + +static void xlnx_xvc_swd_write_reg(uint8_t cmd, uint32_t value, + uint32_t ap_delay_clk, + enum xlnx_xvc_type_t xvc_type) +{ + uint32_t res, ack; + int err; + + assert(!(cmd & SWD_CMD_RNW)); + + cmd |= SWD_CMD_START | SWD_CMD_PARK; + /* cmd + trn + ack */ + err = xlnx_xvc_transact(13, cmd, 0, &res, xvc_type); + if (err != ERROR_OK) + goto err_out; + + ack = MASK_ACK(res); + + /* write data */ + err = xlnx_xvc_transact(32, value, 0, NULL, xvc_type); + if (err != ERROR_OK) + goto err_out; + + /* parity + trn */ + err = xlnx_xvc_transact(2, parity_u32(value), 0, NULL, xvc_type); + if (err != ERROR_OK) + goto err_out; + + LOG_DEBUG("%s %s %s reg %X = %08" PRIx32, + ack == SWD_ACK_OK ? "OK" : ack == SWD_ACK_WAIT ? + "WAIT" : ack == SWD_ACK_FAULT ? "FAULT" : "JUNK", + cmd & SWD_CMD_APNDP ? "AP" : "DP", + cmd & SWD_CMD_RNW ? "read" : "write", + (cmd & SWD_CMD_A32) >> 1, + value); + + switch (ack) { + case SWD_ACK_OK: + if (cmd & SWD_CMD_APNDP) + err = xlnx_xvc_transact(ap_delay_clk, 0, 0, NULL, xvc_type); + queued_retval = err; + return; + case SWD_ACK_WAIT: + LOG_DEBUG_IO("SWD_ACK_WAIT"); + swd_clear_sticky_errors(xvc_type); + return; + case SWD_ACK_FAULT: + LOG_DEBUG_IO("SWD_ACK_FAULT"); + queued_retval = ack; + return; + default: + LOG_DEBUG_IO("No valid acknowledge: ack=%02" PRIx32, ack); + queued_retval = ack; + return; + } + +err_out: + queued_retval = err; +} + +static void xlnx_pcie_xvc_swd_write_reg(uint8_t cmd, uint32_t value, + uint32_t ap_delay_clk) +{ + xlnx_xvc_swd_write_reg(cmd, value, ap_delay_clk, PCIE); +} + +static void xlnx_axi_xvc_swd_write_reg(uint8_t cmd, uint32_t value, + uint32_t ap_delay_clk) +{ + xlnx_xvc_swd_write_reg(cmd, value, ap_delay_clk, AXI); +} + +static int xlnx_xvc_swd_run_queue(enum xlnx_xvc_type_t xvc_type) +{ + int err; + + /* we want at least 8 idle cycles between each transaction */ + err = xlnx_xvc_transact(8, 0, 0, NULL, xvc_type); + if (err != ERROR_OK) + return err; + + err = queued_retval; + queued_retval = ERROR_OK; + LOG_DEBUG("SWD queue return value: %02x", err); + + return err; +} + +static int xlnx_pcie_xvc_swd_run_queue(void) +{ + return xlnx_xvc_swd_run_queue(PCIE); +} + +static int xlnx_axi_xvc_swd_run_queue(void) +{ + return xlnx_xvc_swd_run_queue(AXI); +} + +static int xlnx_xvc_swd_init(void) +{ + return ERROR_OK; +} + +static const struct swd_driver xlnx_pcie_xvc_swd_ops = { + .init = xlnx_xvc_swd_init, + .switch_seq = xlnx_pcie_xvc_swd_switch_seq, + .read_reg = xlnx_pcie_xvc_swd_read_reg, + .write_reg = xlnx_pcie_xvc_swd_write_reg, + .run = xlnx_pcie_xvc_swd_run_queue, +}; + +static const struct swd_driver xlnx_axi_xvc_swd_ops = { + .init = xlnx_xvc_swd_init, + .switch_seq = xlnx_axi_xvc_swd_switch_seq, + .read_reg = xlnx_axi_xvc_swd_read_reg, + .write_reg = xlnx_axi_xvc_swd_write_reg, + .run = xlnx_axi_xvc_swd_run_queue, +}; + +static const char * const xlnx_pcie_xvc_transports[] = { "jtag", "swd", NULL }; + +static const char * const xlnx_axi_xvc_transports[] = { "jtag", "swd", NULL }; + +struct adapter_driver xlnx_pcie_xvc_adapter_driver = { + .name = "xlnx_pcie_xvc", + .transports = xlnx_pcie_xvc_transports, + .commands = xlnx_pcie_xvc_command_handlers, + + .init = &xlnx_pcie_xvc_init, + .quit = &xlnx_pcie_xvc_quit, + + .jtag_ops = &xlnx_pcie_xvc_jtag_ops, + .swd_ops = &xlnx_pcie_xvc_swd_ops, +}; + +struct adapter_driver xlnx_axi_xvc_adapter_driver = { + .name = "xlnx_axi_xvc", + .transports = xlnx_axi_xvc_transports, + .commands = xlnx_axi_xvc_command_handlers, + + .init = &xlnx_axi_xvc_init, + .quit = &xlnx_axi_xvc_quit, + + .jtag_ops = &xlnx_axi_xvc_jtag_ops, + .swd_ops = &xlnx_axi_xvc_swd_ops, +}; diff --git a/src/jtag/interface.h b/src/jtag/interface.h index b448851dc4..f357e550c2 100644 --- a/src/jtag/interface.h +++ b/src/jtag/interface.h @@ -403,5 +403,6 @@ extern struct adapter_driver vdebug_adapter_driver; extern struct adapter_driver vsllink_adapter_driver; extern struct adapter_driver xds110_adapter_driver; extern struct adapter_driver xlnx_pcie_xvc_adapter_driver; +extern struct adapter_driver xlnx_axi_xvc_adapter_driver; #endif /* OPENOCD_JTAG_INTERFACE_H */ diff --git a/src/jtag/interfaces.c b/src/jtag/interfaces.c index 67f0838e39..b6905e73e4 100644 --- a/src/jtag/interfaces.c +++ b/src/jtag/interfaces.c @@ -123,8 +123,9 @@ struct adapter_driver *adapter_drivers[] = { #if BUILD_LINUXGPIOD == 1 &linuxgpiod_adapter_driver, #endif -#if BUILD_XLNX_PCIE_XVC == 1 +#if BUILD_XLNX_XVC == 1 &xlnx_pcie_xvc_adapter_driver, + &xlnx_axi_xvc_adapter_driver, #endif #if BUILD_BCM2835GPIO == 1 &bcm2835gpio_adapter_driver, diff --git a/src/jtag/startup.tcl b/src/jtag/startup.tcl index 2d8ebf0410..88d802fcbe 100644 --- a/src/jtag/startup.tcl +++ b/src/jtag/startup.tcl @@ -413,6 +413,12 @@ proc xlnx_pcie_xvc_config args { eval xlnx_pcie_xvc config $args } +lappend _telnet_autocomplete_skip xlnx_axi_xvc_config +proc xlnx_axi_xvc_config args { + echo "DEPRECATED! use 'xlnx_axi_xvc config' not 'xlnx_axi_xvc_config'" + eval xlnx_axi_xvc config $args +} + lappend _telnet_autocomplete_skip ulink_download_firmware proc ulink_download_firmware args { echo "DEPRECATED! use 'ulink download_firmware' not 'ulink_download_firmware'" --