Menu
▾
▴
[OpenOCD-commit] Main OpenOCD repository branch, master, updated. v0.12.0-1139-g68b6d3ad4
|
From: openocd-gerrit <ope...@us...> - 2025-08-17 13:43:24
|
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Main OpenOCD repository".
The branch, master has been updated
via 68b6d3ad477b45a54282571ebd4ed8a53cf7dd90 (commit)
from c132aed2a611a16f4759626123ab78e446a737ce (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 68b6d3ad477b45a54282571ebd4ed8a53cf7dd90
Author: Adrien Charruel <ach...@na...>
Date: Fri Nov 8 15:18:07 2024 +0100
jtag/driver/angie: Update Angie probe driver
Update jtag driver code to reflect these changes and properly drive
Angie probe.
The rationale behind this is to increase the probe performances,
especially in use cases when large files shall be loaded on a target.
The USB transfer performances are now close to those obtained with a
standard FTDI probe.
Change-Id: I3b31d75a3f66c2d07fed8c7423f765acc30925f8
Signed-off-by: Adrien Charruel <ach...@na...>
Reviewed-on: https://review.openocd.org/c/openocd/+/8711
Tested-by: jenkins
Reviewed-by: Antonio Borneo <bor...@gm...>
diff --git a/contrib/60-openocd.rules b/contrib/60-openocd.rules
index 6632841a4..2a2fe88e6 100644
--- a/contrib/60-openocd.rules
+++ b/contrib/60-openocd.rules
@@ -252,8 +252,6 @@ ATTRS{idVendor}=="303a", ATTRS{idProduct}=="1002", MODE="660", GROUP="plugdev",
# ANGIE USB-JTAG Adapter
ATTRS{idVendor}=="584e", ATTRS{idProduct}=="414f", MODE="660", GROUP="plugdev", TAG+="uaccess"
ATTRS{idVendor}=="584e", ATTRS{idProduct}=="424e", MODE="660", GROUP="plugdev", TAG+="uaccess"
-ATTRS{idVendor}=="584e", ATTRS{idProduct}=="4255", MODE="660", GROUP="plugdev", TAG+="uaccess"
-ATTRS{idVendor}=="584e", ATTRS{idProduct}=="4355", MODE="660", GROUP="plugdev", TAG+="uaccess"
ATTRS{idVendor}=="584e", ATTRS{idProduct}=="4a55", MODE="660", GROUP="plugdev", TAG+="uaccess"
# Marvell Sheevaplug
diff --git a/src/jtag/drivers/Makefile.am b/src/jtag/drivers/Makefile.am
index e55e0478c..481840504 100644
--- a/src/jtag/drivers/Makefile.am
+++ b/src/jtag/drivers/Makefile.am
@@ -127,8 +127,6 @@ endif
if ANGIE
angiedir = $(pkgdatadir)/angie
DRIVERFILES += %D%/angie.c
- DRIVERFILES += %D%/angie/include/msgtypes.h
- EXTRA_DIST += %D%/angie/README
dist_angie_DATA = %D%/angie/angie_firmware.bin
dist_angie_DATA += %D%/angie/angie_bitstream.bit
%C%_libocdjtagdrivers_la_LIBADD += -lm
diff --git a/src/jtag/drivers/angie.c b/src/jtag/drivers/angie.c
index 56a118eae..6d8dc2c3b 100644
--- a/src/jtag/drivers/angie.c
+++ b/src/jtag/drivers/angie.c
@@ -1,274 +1,398 @@
// SPDX-License-Identifier: GPL-2.0-or-later
-/***************************************************************************
- File : angie.c *
- Contents : OpenOCD driver code for NanoXplore USB-JTAG ANGIE *
- adapter hardware. *
- Based on openULINK driver code by: Martin Schmoelzer. *
- Copyright 2023, Ahmed Errached BOUDJELIDA, NanoXplore SAS. *
- <abo...@na...> *
- <ahm...@gm...> *
- ***************************************************************************/
+/****************************************************************************
+ * File : angie.c
+ * Contents : Driver code for NanoXplore USB-JTAG ANGIE
+ * adapter hardware.
+ * Based on FT232R driver code by: Serge Vakulenko
+ *
+ * Copyright 2024, Ahmed BOUDJELIDA, NanoXplore SAS.
+ * <abo...@na...>
+ ****************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
-#include <stdio.h>
-#include <stdlib.h>
-#include <math.h>
-#include "helper/system.h"
-#include <helper/types.h>
+#if IS_CYGWIN == 1
+#include "windows.h"
+#undef LOG_ERROR
+#endif
+
+// project specific includes
+#include <jtag/adapter.h>
#include <jtag/interface.h>
#include <jtag/commands.h>
+#include <helper/time_support.h>
+#include "libusb_helper.h"
#include <target/image.h>
#include <libusb.h>
-#include "libusb_helper.h"
-#include "angie/include/msgtypes.h"
-/** USB Vendor ID of ANGIE device in unconfigured state (no firmware loaded
- * yet) or with its firmware. */
-#define ANGIE_VID 0x584e
+// system includes
+#include <string.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <sys/time.h>
+#include <time.h>
+
+/*
+ * Sync bit bang mode is implemented as described in FTDI Application
+ * Note AN232R-01: "Bit Bang Modes for the ANGIE and FT245R".
+ */
-/** USB Product ID of ANGIE device in unconfigured state (no firmware loaded
- * yet) or with its firmware. */
-#define ANGIE_PID 0x414F
-#define ANGIE_PID_2 0x424e
-#define ANGIE_PID_3 0x4255
-#define ANGIE_PID_4 0x4355
-#define ANGIE_PID_5 0x4a55
+/**
+ * USB endpoints.
+ */
+#define IN_EP 0x84
+#define OUT_EP 0x02
-/** Address of EZ-USB ANGIE CPU Control & Status register. This register can be
- * written by issuing a Control EP0 vendor request. */
-#define CPUCS_REG 0xE600
+/**
+ * Address of EZ-USB ANGIE CPU Control & Status register.
+ * This register can be written by issuing a Control EP0 vendor request.
+ */
+#define CPUCS_REG 0xE600
/** USB Control EP0 bRequest: "Firmware Load". */
#define REQUEST_FIRMWARE_LOAD 0xA0
/** Value to write into CPUCS to put EZ-USB ANGIE into reset. */
-#define CPU_RESET 0x01
+#define CPU_RESET 0x01
/** Value to write into CPUCS to put EZ-USB ANGIE out of reset. */
-#define CPU_START 0x00
+#define CPU_START 0x00
/** Base address of firmware in EZ-USB ANGIE code space. */
-#define FIRMWARE_ADDR 0x0000
-
-/** USB interface number */
-#define USB_INTERFACE 0
+#define FIRMWARE_ADDR 0x0000
/** Delay (in microseconds) to wait while EZ-USB performs ReNumeration. */
-#define ANGIE_RENUMERATION_DELAY_US 1500000
+#define ANGIE_RENUMERATION_DELAY_US 800000
/** Default location of ANGIE firmware image. */
-#define ANGIE_FIRMWARE_FILE PKGDATADIR "/angie/angie_firmware.bin"
+#define ANGIE_FIRMWARE_FILE PKGDATADIR "/angie/angie_firmware.bin"
/** Default location of ANGIE firmware image. */
-#define ANGIE_BITSTREAM_FILE PKGDATADIR "/angie/angie_bitstream.bit"
+#define ANGIE_BITSTREAM_FILE PKGDATADIR "/angie/angie_bitstream.bit"
+
+/**
+ * Maximum size of a single firmware section.
+ * Entire EZ-USB ANGIE code space = 16kB
+ */
+#define ANGIE_FW_SECTION_SIZE 16384
+
+/** Vendor Requests */
+#define VR_CFGOPEN 0xB0
+#define VR_DATAOUTOPEN 0xB2
+
+#define ANGIE_VID 0x584E /* NX Vendor id */
+#define ANGIE_NPROG_PID 0x424E /* ANGIE non programmed */
+#define ANGIE_PROG_OOCD_PID 0x414F /* ANGIE programmed OpenOCD */
+#define ANGIE_PROG_NXB2_PID 0x4a55 /* ANGIE programmed Nxbase2 */
+
+#define TCK_GPIO 0
+#define TDI_GPIO 1
+#define TDO_GPIO 2
+#define TMS_GPIO 3
+#define NTRST_GPIO 4
+#define NSYSRST_GPIO 6
-/** Maximum size of a single firmware section. Entire EZ-USB ANGIE code space = 16kB */
-#define SECTION_BUFFERSIZE 16384
+#define ANGIE_XFER_BUFFER_TOTAL_SIZE (16 * 1024)
+#define ANGIE_USB_BULK_SIZE 512
-/** Tuning of OpenOCD SCAN commands split into multiple ANGIE commands. */
-#define SPLIT_SCAN_THRESHOLD 10
+/** USB timeout delay in milliseconds */
+#define ANGIE_USB_TIMEOUT_MS 1000
-/** ANGIE hardware type */
-enum angie_type {
- ANGIE,
+/**
+ * List of elements used in a multiple commands reply.
+ */
+struct read_queue {
+ struct list_head list;
};
-enum angie_payload_direction {
- PAYLOAD_DIRECTION_OUT,
- PAYLOAD_DIRECTION_IN
+/**
+ * Entry element used to forge a reply buffer for openocd JTAG core.
+ */
+struct read_queue_entry {
+ const struct scan_command *cmd;
+ int reply_buffer_offset;
+ uint8_t *buffer;
+ struct list_head list;
};
-enum angie_delay_type {
- DELAY_CLOCK_TCK,
- DELAY_CLOCK_TMS,
- DELAY_SCAN_IN,
- DELAY_SCAN_OUT,
- DELAY_SCAN_IO
+/**
+ * Angie device main context
+ */
+struct angie {
+ struct libusb_device_handle *usbdev;
+ uint8_t xfer_buffer[ANGIE_XFER_BUFFER_TOTAL_SIZE];
+ size_t xfer_buffer_len;
+ uint8_t reply_buffer[ANGIE_XFER_BUFFER_TOTAL_SIZE];
+ size_t reply_buffer_len;
+ struct read_queue read_queue;
};
/**
- * ANGIE command (ANGIE command queue element).
+ * Angie device singleton
+ */
+struct angie *angie_handle;
+
+/**
+ * Init read queue list
*
- * For the OUT direction payload, things are quite easy: Payload is stored
- * in a rather small array (up to 63 bytes), the payload is always allocated
- * by the function generating the command and freed by angie_clear_queue().
+ * @param queue: pointer on the read queue head
+ */
+static void angie_read_queue_init(struct read_queue *queue)
+{
+ INIT_LIST_HEAD(&queue->list);
+}
+
+
+/**
+ * Add a single entry to the read queue
*
- * For the IN direction payload, things get a little bit more complicated:
- * The maximum IN payload size for a single command is 64 bytes. Assume that
- * a single OpenOCD command needs to scan 256 bytes. This results in the
- * generation of four ANGIE commands. The function generating these
- * commands shall allocate an uint8_t[256] array. Each command's #payload_in
- * pointer shall point to the corresponding offset where IN data shall be
- * placed, while #payload_in_start shall point to the first element of the 256
- * byte array.
- * - first command: #payload_in_start + 0
- * - second command: #payload_in_start + 64
- * - third command: #payload_in_start + 128
- * - fourth command: #payload_in_start + 192
+ * @param queue: read queue list
+ * @param entry to append
+ */
+static void angie_read_queue_add(struct read_queue *queue,
+ struct read_queue_entry *entry)
+{
+ list_add_tail(&entry->list, &queue->list);
+}
+
+/**
+ * Execute elements enqueued in the read queue list
*
- * The last command sets #needs_postprocessing to true.
+ * @param queue: read queue list
+ * @param device: pointer on the angie device
*/
-struct angie_cmd {
- uint8_t id; /**< ANGIE command ID */
+static void angie_read_queue_execute(struct read_queue *queue,
+ struct angie *device)
+{
+ struct read_queue_entry *entry;
+ struct read_queue_entry *tmp;
+
+ list_for_each_entry_safe(entry, tmp, &queue->list, list) {
+ int scan_size = jtag_scan_size(entry->cmd);
+
+ // iterate over each bit in scan data
+ for (int bit_cnt = 0; bit_cnt < scan_size; bit_cnt++) {
+ // calculate byte index
+ int bytec = bit_cnt / 8;
+ // calculate bit mask: isolate the specific bit in corresponding byte
+ int bcval = 1 << (bit_cnt % 8);
+ // extract tdo value using index: "bit0_index + bit_cnt*2 + 1"
+ int val = device->reply_buffer[entry->reply_buffer_offset + bit_cnt * 2 + 1];
+ if (val & (1 << TDO_GPIO))
+ entry->buffer[bytec] |= bcval;
+ else
+ entry->buffer[bytec] &= ~bcval;
+ }
+
+ jtag_read_buffer(entry->buffer, entry->cmd);
- uint8_t *payload_out; /**< Pointer where OUT payload shall be stored */
- uint8_t payload_out_size; /**< OUT direction payload size for this command */
+ list_del(&entry->list);
+ free(entry->buffer);
+ free(entry);
+ }
+}
- uint8_t *payload_in_start; /**< Pointer to first element of IN payload array */
- uint8_t *payload_in; /**< Pointer where IN payload shall be stored */
- uint8_t payload_in_size; /**< IN direction payload size for this command */
+/**
+ * Clear the read queue list
+ *
+ * @param queue: read queue list
+ */
+static void angie_read_queue_clean(struct read_queue *queue)
+{
+ struct read_queue_entry *entry;
+ struct read_queue_entry *tmp;
- /** Indicates if this command needs post-processing */
- bool needs_postprocessing;
+ list_for_each_entry_safe(entry, tmp, &queue->list, list) {
+ list_del(&entry->list);
+ free(entry->buffer);
+ free(entry);
+ }
+}
- /** Indicates if angie_clear_queue() should free payload_in_start */
- bool free_payload_in_start;
+/**
+ * Flush a chunk of Angie's buffer
+ *
+ * USB write is done by configuring GPIF register on the target and calling
+ * a USB bulk transfer.
+ * Sequentially a USB read transferred is issued of the same size.
+ * All the operation are synchronous.
+ * Then the read queue list is executed once the read buffer has been retrieved.
+ *
+ * @param device: Angie device pointer
+ * @param xfer_size: amount of bytes to transfer
+ * @param offset: total bytes already sent during this transfer, this will
+ * offset the receive buffer accordingly
+ * @param bytes_sent: will contain the amount of bytes sent
+ * @return ERROR_OK on success, negative error code otherwise
+ */
+static int angie_buffer_flush_chunk(struct angie *device,
+ int xfer_size,
+ int offset,
+ int *bytes_sent)
+{
+ uint8_t gpifcnt[4];
+ int sent_chunk_size = 0, bytes_received = 0;
- /** Pointer to corresponding OpenOCD command for post-processing */
- struct jtag_command *cmd_origin;
+ if (bytes_sent)
+ *bytes_sent = 0;
- struct angie_cmd *next; /**< Pointer to next command (linked list) */
-};
+ h_u32_to_be(gpifcnt, xfer_size);
-/** Describes one driver instance */
-struct angie {
- struct libusb_context *libusb_ctx;
- struct libusb_device_handle *usb_device_handle;
- enum angie_type type;
-
- unsigned int ep_in; /**< IN endpoint number */
- unsigned int ep_out; /**< OUT endpoint number */
-
- /* delay value for "SLOW_CLOCK commands" in [0:255] range in units of 4 us;
- -1 means no need for delay */
- int delay_scan_in; /**< Delay value for SCAN_IN commands */
- int delay_scan_out; /**< Delay value for SCAN_OUT commands */
- int delay_scan_io; /**< Delay value for SCAN_IO commands */
- int delay_clock_tck; /**< Delay value for CLOCK_TMS commands */
- int delay_clock_tms; /**< Delay value for CLOCK_TCK commands */
-
- int commands_in_queue; /**< Number of commands in queue */
- struct angie_cmd *queue_start; /**< Pointer to first command in queue */
- struct angie_cmd *queue_end; /**< Pointer to last command in queue */
-};
+ int ret = jtag_libusb_control_transfer(device->usbdev,
+ LIBUSB_ENDPOINT_OUT | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE,
+ VR_DATAOUTOPEN, 0, 0, (char *)gpifcnt, sizeof(gpifcnt),
+ ANGIE_USB_TIMEOUT_MS, NULL);
+ if (ret != ERROR_OK) {
+ LOG_ERROR("Failed to send GPIF count to target");
+ return ret;
+ }
-/**************************** Function Prototypes *****************************/
-
-/* USB helper functions */
-static int angie_usb_open(struct angie *device);
-static int angie_usb_close(struct angie *device);
-
-/* ANGIE MCU (Cypress EZ-USB) specific functions */
-static int angie_cpu_reset(struct angie *device, char reset_bit);
-static int angie_load_firmware_and_renumerate(struct angie *device, const char *filename,
- uint32_t delay_us);
-static int angie_load_firmware(struct angie *device, const char *filename);
-static int angie_load_bitstream(struct angie *device, const char *filename);
-static int angie_i2c_write(struct angie *device, uint8_t *i2c_data, uint8_t i2c_data_size);
-static int angie_io_extender_config(struct angie *device, uint8_t i2c_adr, uint8_t cfg_value);
-static int angie_write_firmware_section(struct angie *device,
- struct image *firmware_image, int section_index);
-
-/* Generic helper functions */
-static void angie_dump_signal_states(uint8_t input_signals, uint8_t output_signals);
-
-/* ANGIE command generation helper functions */
-static int angie_allocate_payload(struct angie_cmd *angie_cmd, int size,
- enum angie_payload_direction direction);
-
-/* ANGIE command queue helper functions */
-static int angie_get_queue_size(struct angie *device,
- enum angie_payload_direction direction);
-static void angie_clear_queue(struct angie *device);
-static int angie_append_queue(struct angie *device, struct angie_cmd *angie_cmd);
-static int angie_execute_queued_commands(struct angie *device, int timeout_ms);
-
-static void angie_dump_queue(struct angie *device);
-
-static int angie_append_scan_cmd(struct angie *device,
- enum scan_type scan_type,
- int scan_size_bits,
- uint8_t *tdi,
- uint8_t *tdo_start,
- uint8_t *tdo,
- uint8_t tms_count_start,
- uint8_t tms_sequence_start,
- uint8_t tms_count_end,
- uint8_t tms_sequence_end,
- struct jtag_command *origin,
- bool postprocess);
-static int angie_append_clock_tms_cmd(struct angie *device, uint8_t count,
- uint8_t sequence);
-static int angie_append_clock_tck_cmd(struct angie *device, uint16_t count);
-static int angie_append_get_signals_cmd(struct angie *device);
-static int angie_append_set_signals_cmd(struct angie *device, uint8_t low,
- uint8_t high);
-static int angie_append_sleep_cmd(struct angie *device, uint32_t us);
-static int angie_append_configure_tck_cmd(struct angie *device,
- int delay_scan_in,
- int delay_scan_out,
- int delay_scan_io,
- int delay_tck,
- int delay_tms);
-static int angie_append_test_cmd(struct angie *device);
-
-/* ANGIE TCK frequency helper functions */
-static int angie_calculate_delay(enum angie_delay_type type, long f, int *delay);
-
-/* Interface between ANGIE and OpenOCD */
-static void angie_set_end_state(enum tap_state endstate);
-static int angie_queue_statemove(struct angie *device);
-
-static int angie_queue_scan(struct angie *device, struct jtag_command *cmd);
-static int angie_queue_tlr_reset(struct angie *device, struct jtag_command *cmd);
-static int angie_queue_runtest(struct angie *device, struct jtag_command *cmd);
-static int angie_queue_pathmove(struct angie *device, struct jtag_command *cmd);
-static int angie_queue_sleep(struct angie *device, struct jtag_command *cmd);
-static int angie_queue_stableclocks(struct angie *device, struct jtag_command *cmd);
-
-static int angie_post_process_scan(struct angie_cmd *angie_cmd);
-static int angie_post_process_queue(struct angie *device);
-
-/* adapter driver functions */
-static int angie_execute_queue(struct jtag_command *cmd_queue);
-static int angie_khz(int khz, int *jtag_speed);
-static int angie_speed(int speed);
-static int angie_speed_div(int speed, int *khz);
-static int angie_init(void);
-static int angie_quit(void);
-static int angie_reset(int trst, int srst);
-
-/****************************** Global Variables ******************************/
-
-static struct angie *angie_handle;
-
-/**************************** USB helper functions ****************************/
+ ret = jtag_libusb_bulk_write(device->usbdev, OUT_EP,
+ (char *)device->xfer_buffer + offset,
+ xfer_size, ANGIE_USB_TIMEOUT_MS, &sent_chunk_size);
+ if (ret != ERROR_OK) {
+ LOG_ERROR("USB bulk transfer failed");
+ return ret;
+ }
+
+ ret = jtag_libusb_bulk_read(device->usbdev, IN_EP,
+ (char *)device->reply_buffer + offset,
+ sent_chunk_size, ANGIE_USB_TIMEOUT_MS, &bytes_received);
+ if (ret != ERROR_OK) {
+ LOG_ERROR("Failed to read USB reply");
+ return ret;
+ }
+
+ if (sent_chunk_size == xfer_size && bytes_received == xfer_size) {
+ device->reply_buffer_len += xfer_size;
+ device->xfer_buffer_len -= xfer_size;
+ if (bytes_sent)
+ *bytes_sent += sent_chunk_size;
+ } else {
+ return ERROR_FAIL;
+ }
+
+ return ERROR_OK;
+}
/**
- * Opens the ANGIE device
+ * Flush Angie transfer buffer
*
- * @param device pointer to struct angie identifying ANGIE driver instance.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
+ * Flush is done by chunks of 512 bytes to match hardware internal FIFOs.
+ * Then the read queue list is executed once the read buffer has been retrieved.
+ *
+ * @param device: Angie device pointer
+ * @return ERROR_OK on success, negative error code otherwise
*/
-static int angie_usb_open(struct angie *device)
+static int angie_buffer_flush(struct angie *device)
+{
+ if (device->xfer_buffer_len == 0)
+ return ERROR_OK;
+
+ int total_bytes_sent = 0;
+ device->reply_buffer_len = 0;
+
+ do {
+ int sent_chunk_size;
+ size_t xfer_size = MIN(device->xfer_buffer_len, ANGIE_USB_BULK_SIZE);
+ int ret = angie_buffer_flush_chunk(device, xfer_size,
+ total_bytes_sent, &sent_chunk_size);
+ if (ret != ERROR_OK)
+ return ret;
+ total_bytes_sent += sent_chunk_size;
+ } while (device->xfer_buffer_len > 0);
+
+ angie_read_queue_execute(&device->read_queue, device);
+
+ return ERROR_OK;
+}
+
+/**
+ * Check if transfer buffer has enough remaining space for a given size.
+ * If the buffer is not large enough, flush it.
+ *
+ * @param device: Angie device pointer
+ * @param size to check
+ * @return ERROR_OK on success, negative error code otherwise
+ */
+static int angie_buffer_flush_check(struct angie *device, size_t size)
+{
+ if (device->xfer_buffer_len + size >= ANGIE_XFER_BUFFER_TOTAL_SIZE)
+ return angie_buffer_flush(device);
+ return ERROR_OK;
+}
+
+/**
+ * Append a single byte value to the transfer buffer
+ *
+ * @param device: Angie device pointer
+ * @param value to append
+ * @return ERROR_OK on success, negative error code otherwise
+ */
+static int angie_buffer_append_simple(struct angie *device, uint8_t value)
{
- struct libusb_device_handle *usb_device_handle;
- const uint16_t vids[] = {ANGIE_VID, ANGIE_VID, ANGIE_VID, ANGIE_VID, ANGIE_VID, 0};
- const uint16_t pids[] = {ANGIE_PID, ANGIE_PID_2, ANGIE_PID_3, ANGIE_PID_4, ANGIE_PID_5, 0};
+ if (device->xfer_buffer_len >= ANGIE_XFER_BUFFER_TOTAL_SIZE) {
+ int ret = angie_buffer_flush(device);
+ if (ret != ERROR_OK)
+ return ret;
+ }
+ device->xfer_buffer[device->xfer_buffer_len++] = value;
+ return ERROR_OK;
+}
- int ret = jtag_libusb_open(vids, pids, NULL, &usb_device_handle, NULL);
+/**
+ * Append a bit-bang JTAG value to the transfer buffer.
+ *
+ * @param device: Angie device pointer
+ * @param tck value
+ * @param tms value
+ * @param tdi value
+ * @return ERROR_OK on success, negative error code otherwise
+ */
+static int angie_buffer_append(struct angie *device, int tck, int tms, int tdi)
+{
+ uint8_t val = (1 << NTRST_GPIO) | (1 << NSYSRST_GPIO);
+ if (tck)
+ val |= (1 << TCK_GPIO);
+ if (tms)
+ val |= (1 << TMS_GPIO);
+ if (tdi)
+ val |= (1 << TDI_GPIO);
+
+ return angie_buffer_append_simple(device, val);
+}
+/**
+ * Open Angie USB interface
+ *
+ * @param device: Angie device pointer
+ * @return ERROR_OK on success, negative error code otherwise
+ */
+static int angie_usb_open(struct angie *device)
+{
+ uint16_t avids[] = {
+ ANGIE_VID,
+ ANGIE_VID,
+ ANGIE_VID,
+ 0,
+ };
+ uint16_t apids[] = {
+ ANGIE_NPROG_PID,
+ ANGIE_PROG_OOCD_PID,
+ ANGIE_PROG_NXB2_PID,
+ 0,
+ };
+ struct libusb_device_handle *usb_dev;
+
+ int ret = jtag_libusb_open(avids, apids, NULL, &usb_dev, NULL);
if (ret != ERROR_OK) {
- LOG_ERROR("Could not find and open ANGIE");
+ LOG_ERROR("Failed to open ANGIE USB interface");
return ret;
}
- device->usb_device_handle = usb_device_handle;
- device->type = ANGIE;
+ device->usbdev = usb_dev;
return ERROR_OK;
}
@@ -276,80 +400,84 @@ static int angie_usb_open(struct angie *device)
/**
* Releases the ANGIE interface and closes the USB device handle.
*
- * @param device pointer to struct angie identifying ANGIE driver instance.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
+ * @param device: Angie device pointer
+ * @return ERROR_OK on success, negative error code otherwise
*/
static int angie_usb_close(struct angie *device)
{
- if (device->usb_device_handle) {
- if (libusb_release_interface(device->usb_device_handle, 0) != 0) {
+ int ret = ERROR_OK;
+
+ if (device->usbdev) {
+ if (libusb_release_interface(device->usbdev, 0) != LIBUSB_SUCCESS) {
LOG_ERROR("Could not release interface 0");
- return ERROR_FAIL;
+ ret = ERROR_FAIL;
}
- jtag_libusb_close(device->usb_device_handle);
- device->usb_device_handle = NULL;
+ jtag_libusb_close(device->usbdev);
+ device->usbdev = NULL;
}
- return ERROR_OK;
-}
-/******************* ANGIE CPU (EZ-USB) specific functions ********************/
+ return ret;
+}
/**
* Writes '0' or '1' to the CPUCS register, putting the EZ-USB CPU into reset
* or out of reset.
*
- * @param device pointer to struct angie identifying ANGIE driver instance.
+ * @param device: Angie device pointer
* @param reset_bit 0 to put CPU into reset, 1 to put CPU out of reset.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
+ * @return ERROR_OK on success, negative error code otherwise
*/
static int angie_cpu_reset(struct angie *device, char reset_bit)
{
- return jtag_libusb_control_transfer(device->usb_device_handle,
- (LIBUSB_ENDPOINT_OUT | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE),
- REQUEST_FIRMWARE_LOAD, CPUCS_REG, 0, &reset_bit, 1, LIBUSB_TIMEOUT_MS, NULL);
+ return jtag_libusb_control_transfer(device->usbdev,
+ LIBUSB_ENDPOINT_OUT | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE,
+ REQUEST_FIRMWARE_LOAD, CPUCS_REG, 0, &reset_bit, 1,
+ ANGIE_USB_TIMEOUT_MS, NULL);
}
/**
- * Puts the ANGIE's EZ-USB microcontroller into reset state, downloads
- * the firmware image, resumes the microcontroller and re-enumerates
- * USB devices.
+ * Send one contiguous firmware section to the ANGIE's EZ-USB microcontroller
+ * over the USB bus.
*
- * @param device pointer to struct angie identifying ANGIE driver instance.
- * The usb_handle member will be modified during re-enumeration.
- * @param filename path to the Intel HEX file containing the firmware image.
- * @param delay_us the delay to wait for the device to re-enumerate.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
+ * @param device: Angie device pointer
+ * @param address: address of the firmware section
+ * @param data: pointer to the data to be sent
+ * @param size: size of the data
+ * @return ERROR_OK on success, negative error code otherwise
*/
-static int angie_load_firmware_and_renumerate(struct angie *device,
- const char *filename, uint32_t delay_us)
+static int angie_write_firmware_section(struct angie *device, uint16_t address,
+ uint8_t *data, size_t size)
{
- int ret;
+ int bytes_remaining = size;
- /* Basic process: After downloading the firmware, the ANGIE will disconnect
- * itself and re-connect after a short amount of time so we have to close
- * the handle and re-enumerate USB devices */
+ // Send section data in chunks of up to 64 bytes to ANGIE
+ while (bytes_remaining > 0) {
+ int chunk_size;
+ int transferred;
- ret = angie_load_firmware(device, filename);
- if (ret != ERROR_OK)
- return ret;
+ if (bytes_remaining > 64)
+ chunk_size = 64;
+ else
+ chunk_size = bytes_remaining;
- ret = angie_usb_close(device);
- if (ret != ERROR_OK)
- return ret;
+ int ret = jtag_libusb_control_transfer(device->usbdev,
+ LIBUSB_ENDPOINT_OUT | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE,
+ REQUEST_FIRMWARE_LOAD, address, FIRMWARE_ADDR, (char *)data,
+ chunk_size, ANGIE_USB_TIMEOUT_MS, &transferred);
- usleep(delay_us);
+ if (ret != ERROR_OK)
+ return ret;
- ret = angie_usb_open(device);
- if (ret != ERROR_OK)
- return ret;
+ if (transferred != chunk_size) {
+ // Abort if libusb sent less data than requested
+ return ERROR_FAIL;
+ }
- ret = libusb_claim_interface(angie_handle->usb_device_handle, 0);
- if (ret != LIBUSB_SUCCESS)
- return ERROR_FAIL;
+ bytes_remaining -= chunk_size;
+ address += chunk_size;
+ data += chunk_size;
+ }
return ERROR_OK;
}
@@ -358,18 +486,16 @@ static int angie_load_firmware_and_renumerate(struct angie *device,
* Downloads a firmware image to the ANGIE's EZ-USB microcontroller
* over the USB bus.
*
- * @param device pointer to struct angie identifying ANGIE driver instance.
- * @param filename an absolute or relative path to the Intel HEX file
+ * @param device: Angie device pointer
+ * @param filename: an absolute or relative path to the Intel HEX file
* containing the firmware image.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
+ * @return ERROR_OK on success, negative error code otherwise
*/
static int angie_load_firmware(struct angie *device, const char *filename)
{
struct image angie_firmware_image;
- int ret;
- ret = angie_cpu_reset(device, CPU_RESET);
+ int ret = angie_cpu_reset(device, CPU_RESET);
if (ret != ERROR_OK) {
LOG_ERROR("Could not halt ANGIE CPU");
return ret;
@@ -384,12 +510,34 @@ static int angie_load_firmware(struct angie *device, const char *filename)
return ret;
}
- /* Download all sections in the image to ANGIE */
+ uint8_t *data = malloc(ANGIE_FW_SECTION_SIZE);
+ if (!data) {
+ LOG_ERROR("Out of memory");
+ return ERROR_FAIL;
+ }
+
+ // Download all sections in the image to ANGIE
for (unsigned int i = 0; i < angie_firmware_image.num_sections; i++) {
- ret = angie_write_firmware_section(device, &angie_firmware_image, i);
+ size_t size_read;
+ uint32_t size = angie_firmware_image.sections[i].size;
+ int addr = angie_firmware_image.sections[i].base_address;
+
+ LOG_DEBUG("section %02i at addr 0x%04x (size 0x%04" PRIx32 ")",
+ i, addr, size);
+
+ ret = image_read_section(&angie_firmware_image, i, 0,
+ size, data, &size_read);
+ if (ret != ERROR_OK)
+ goto exit;
+ if (size_read != size) {
+ ret = ERROR_FAIL;
+ goto exit;
+ }
+
+ ret = angie_write_firmware_section(device, addr, data, size);
if (ret != ERROR_OK) {
LOG_ERROR("Could not write firmware section");
- return ret;
+ goto exit;
}
}
@@ -398,9 +546,52 @@ static int angie_load_firmware(struct angie *device, const char *filename)
ret = angie_cpu_reset(device, CPU_START);
if (ret != ERROR_OK) {
LOG_ERROR("Could not restart ANGIE CPU");
- return ret;
+ goto exit;
}
+exit:
+ free(data);
+ return ret;
+}
+
+/**
+ * Puts the ANGIE's EZ-USB microcontroller into reset state, downloads
+ * the firmware image, resumes the microcontroller and re-enumerates
+ * USB devices.
+ *
+ * @param device: Angie device pointer
+ * The usb_handle member will be modified during re-enumeration.
+ * @param filename: path to the Intel HEX file containing the firmware image.
+ * @param delay_us: the delay to wait for the device to re-enumerate.
+ * @return ERROR_OK on success, negative error code otherwise
+ */
+static int angie_load_firmware_and_renumerate(struct angie *device,
+ const char *filename,
+ uint32_t delay_us)
+{
+ /*
+ * Basic process: After downloading the firmware, the ANGIE will disconnect
+ * itself and re-connect after a short amount of time so we have to close
+ * the handle and re-enumerate USB devices.
+ */
+
+ int ret = angie_load_firmware(device, filename);
+ if (ret != ERROR_OK)
+ return ret;
+
+ ret = angie_usb_close(device);
+ if (ret != ERROR_OK)
+ return ret;
+
+ usleep(delay_us);
+
+ ret = angie_usb_open(device);
+ if (ret != ERROR_OK)
+ return ret;
+
+ if (libusb_claim_interface(angie_handle->usbdev, 0) != LIBUSB_SUCCESS)
+ return ERROR_FAIL;
+
return ERROR_OK;
}
@@ -408,1982 +599,766 @@ static int angie_load_firmware(struct angie *device, const char *filename)
* Downloads a bitstream file to the ANGIE's FPGA through the EZ-USB microcontroller
* over the USB bus.
*
- * @param device pointer to struct angie identifying ANGIE driver instance.
- * @param filename an absolute or relative path to the Xilinx .bit file
+ * @param device: Angie device pointer
+ * @param filename: an absolute or relative path to the Xilinx .bit file
* containing the bitstream data.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
+ * @return ERROR_OK on success, negative error code otherwise
*/
static int angie_load_bitstream(struct angie *device, const char *filename)
{
- int ret, transferred;
+ int ret = ERROR_OK, transferred;
const char *bitstream_file_path = filename;
FILE *bitstream_file = NULL;
char *bitstream_data = NULL;
- size_t bitstream_size = 0;
uint8_t gpifcnt[4];
- /* Open the bitstream file */
+ // Open the bitstream file
bitstream_file = fopen(bitstream_file_path, "rb");
if (!bitstream_file) {
LOG_ERROR("Failed to open bitstream file: %s\n", bitstream_file_path);
- return ERROR_FAIL;
+ ret = ERROR_FAIL;
+ goto exit;
}
- /* Get the size of the bitstream file */
+ // Get the size of the bitstream file
fseek(bitstream_file, 0, SEEK_END);
- bitstream_size = ftell(bitstream_file);
+ size_t bitstream_size = ftell(bitstream_file);
fseek(bitstream_file, 0, SEEK_SET);
- /* Allocate memory for the bitstream data */
+ // Allocate memory for the bitstream data
bitstream_data = malloc(bitstream_size);
if (!bitstream_data) {
LOG_ERROR("Failed to allocate memory for bitstream data.");
- fclose(bitstream_file);
- return ERROR_FAIL;
+ ret = ERROR_FAIL;
+ goto exit;
}
- /* Read the bitstream data from the file */
+ // Read the bitstream data from the file
if (fread(bitstream_data, 1, bitstream_size, bitstream_file) != bitstream_size) {
LOG_ERROR("Failed to read bitstream data.");
- free(bitstream_data);
- fclose(bitstream_file);
- return ERROR_FAIL;
+ ret = ERROR_FAIL;
+ goto exit;
}
+ // CFG Open
h_u32_to_be(gpifcnt, bitstream_size);
-
- /* CFGopen */
- ret = jtag_libusb_control_transfer(device->usb_device_handle,
- 0x00, 0xB0, 0, 0, (char *)gpifcnt, 4, LIBUSB_TIMEOUT_MS, &transferred);
+ ret = jtag_libusb_control_transfer(device->usbdev,
+ LIBUSB_ENDPOINT_OUT | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE,
+ VR_CFGOPEN, 0, 0, (char *)gpifcnt, sizeof(gpifcnt),
+ ANGIE_USB_TIMEOUT_MS, &transferred);
if (ret != ERROR_OK) {
LOG_ERROR("Failed opencfg");
- /* Abort if libusb sent less data than requested */
- return ERROR_FAIL;
+ goto exit;
}
- /* Send the bitstream data to the microcontroller */
+ // Send the bitstream data to the microcontroller
int actual_length = 0;
- ret = jtag_libusb_bulk_write(device->usb_device_handle, 0x02, bitstream_data, bitstream_size, 1000, &actual_length);
+ ret = jtag_libusb_bulk_write(device->usbdev, OUT_EP, bitstream_data,
+ bitstream_size, ANGIE_USB_TIMEOUT_MS, &actual_length);
if (ret != ERROR_OK) {
LOG_ERROR("Failed to send bitstream data: %s", libusb_strerror(ret));
- free(bitstream_data);
- fclose(bitstream_file);
- return ERROR_FAIL;
+ goto exit;
}
LOG_INFO("Bitstream sent successfully.");
- /* Clean up */
+exit:
free(bitstream_data);
- fclose(bitstream_file);
+ if (bitstream_file)
+ fclose(bitstream_file);
- /* CFGclose */
- transferred = 0;
- ret = jtag_libusb_control_transfer(device->usb_device_handle,
- 0x00, 0xB1, 0, 0, NULL, 0, LIBUSB_TIMEOUT_MS, &transferred);
- if (ret != ERROR_OK) {
- LOG_ERROR("Failed cfgclose");
- /* Abort if libusb sent less data than requested */
- return ERROR_FAIL;
- }
- return ERROR_OK;
+ return ret;
}
/**
- * Send an i2c write operation to dev-board components.
+ * Check if Angie firmware must be updated
*
- * @param device pointer to struct angie identifying ANGIE driver instance.
- * @param i2c_data table of i2c data that we want to write to slave device.
- * @param i2c_data_size the size of i2c data table.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
+ * @param device: Angie device pointer
+ * @return true if update is needed, false otherwise
*/
-static int angie_i2c_write(struct angie *device, uint8_t *i2c_data, uint8_t i2c_data_size)
+static bool angie_is_firmware_needed(struct angie *device)
{
- char i2c_data_buffer[i2c_data_size + 2];
- char buffer_received[1];
- int ret, transferred;
- i2c_data_buffer[0] = 0; // write = 0
- i2c_data_buffer[1] = i2c_data_size - 1; // i2c_data count (without address)
-
- for (uint8_t i = 0; i < i2c_data_size; i++)
- i2c_data_buffer[i + 2] = i2c_data[i];
-
- // Send i2c packet to Dev-board and configure its clock source /
- ret = jtag_libusb_bulk_write(device->usb_device_handle, 0x06, i2c_data_buffer,
- i2c_data_size + 2, 1000, &transferred);
- if (ret != ERROR_OK) {
- LOG_ERROR("Error in i2c clock gen configuration : ret ERROR");
- return ret;
- }
- if (transferred != i2c_data_size + 2) {
- LOG_ERROR("Error in i2c clock gen configuration : bytes transferred");
- return ERROR_FAIL;
- }
+ struct libusb_device_descriptor desc;
- usleep(500);
+ // Get String Descriptor to determine if firmware needs to be loaded
+ int ret = libusb_get_device_descriptor(libusb_get_device(angie_handle->usbdev),
+ &desc);
+ if (ret != LIBUSB_SUCCESS)
+ // Could not get descriptor -> Unconfigured or original Keil firmware
+ return true;
+ else if (desc.idProduct != ANGIE_PROG_OOCD_PID)
+ return true;
- // Receive packet from ANGIE /
- ret = jtag_libusb_bulk_write(device->usb_device_handle, 0x88, buffer_received, 1, 1000, &transferred);
- if (ret != ERROR_OK) {
- LOG_ERROR("Error in i2c clock gen configuration : ret ERROR");
- return ret;
+ return false;
+}
+
+/**
+ * Set TAP end state
+ *
+ * @param state
+ */
+static void angie_set_end_state(enum tap_state state)
+{
+ if (tap_is_state_stable(state)) {
+ tap_set_end_state(state);
+ } else {
+ LOG_ERROR("BUG: %i is not a valid end state", state);
+ exit(-1);
}
- return ERROR_OK;
}
/**
- * Configure dev-board gpio extender modules by configuring their
- * register 3 and register 1 responsible for IO directions and values.
+ * Move TAP to given state
*
- * @param device pointer to struct angie identifying ANGIE driver instance.
- * @param i2c_adr i2c address of the gpio extender.
- * @param cfg_value IOs configuration to be written in register Number 3.
- * @param value the IOs value to be written in register Number 1.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
+ * @param device: Angie device pointer
+ * @param skip: number of state to skip during move
+ * @return ERROR_OK on success, negative error code otherwise
*/
-static int angie_io_extender_config(struct angie *device, uint8_t i2c_adr, uint8_t cfg_value)
+static int angie_state_move(struct angie *device, int skip)
{
- uint8_t ioconfig[3] = {i2c_adr, 3, cfg_value};
- int ret = angie_i2c_write(device, ioconfig, 3);
+ int ret;
+ int tms = 0;
+ 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());
+
+ // tms_scan has 8 bits that we bitbang one by one
+ for (int i = skip; i < tms_count; i++) {
+ tms = (tms_scan >> i) & 1;
+ ret = angie_buffer_append(device, 0, tms, 0);
+ if (ret != ERROR_OK)
+ return ret;
+ ret = angie_buffer_append(device, 1, tms, 0);
+ if (ret != ERROR_OK)
+ return ret;
+ }
+ ret = angie_buffer_append(device, 0, tms, 0);
if (ret != ERROR_OK)
return ret;
- usleep(500);
- return ret;
+ tap_set_state(tap_get_end_state());
+
+ return ERROR_OK;
}
/**
- * Send one contiguous firmware section to the ANGIE's EZ-USB microcontroller
- * over the USB bus.
+ * Return JTAG SCAN command size in bytes
*
- * @param device pointer to struct angie identifying ANGIE driver instance.
- * @param firmware_image pointer to the firmware image that contains the section
- * which should be sent to the ANGIE's EZ-USB microcontroller.
- * @param section_index index of the section within the firmware image.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
+ * @param device: Angie device pointer
+ * @param cmd: SCAN command
+ * @return size of command in the transfer buffer in bytes
*/
-static int angie_write_firmware_section(struct angie *device,
- struct image *firmware_image, int section_index)
+static int angie_jtag_scan_size(struct angie *device,
+ const struct scan_command *cmd)
{
- int addr, bytes_remaining, chunk_size;
- uint8_t data[SECTION_BUFFERSIZE];
- uint8_t *data_ptr = data;
- uint16_t size;
- size_t size_read;
- int ret, transferred;
+ int cmd_size = 0;
+ int count = 0;
- size = (uint16_t)firmware_image->sections[section_index].size;
- addr = (uint16_t)firmware_image->sections[section_index].base_address;
+ // move to TAP_IRSHIFT or TAP_DRSHIFT state
+ if (cmd->ir_scan)
+ count = tap_get_tms_path_len(tap_get_state(), TAP_IRSHIFT);
+ else
+ count = tap_get_tms_path_len(tap_get_state(), TAP_DRSHIFT);
+ cmd_size += count * 2 + 1;
+
+ // add scan size
+ cmd_size += jtag_scan_size(cmd) * 2;
+
+ /*
+ * move to cmd specified end state
+ * Also, see below function
+ * we *KNOW* the above loop transitioned out of
+ * the shift state, so we skip the first state
+ * and move directly to the end state.
+ */
+ if (cmd->ir_scan)
+ count = tap_get_tms_path_len(TAP_IRSHIFT, cmd->end_state) - 1;
+ else
+ count = tap_get_tms_path_len(TAP_DRSHIFT, cmd->end_state) - 1;
+ cmd_size += count * 2 + 1;
- LOG_DEBUG("section %02i at addr 0x%04x (size 0x%04" PRIx16 ")", section_index, addr,
- size);
+ return cmd_size;
+}
- /* Copy section contents to local buffer */
- ret = image_read_section(firmware_image, section_index, 0, size, data,
- &size_read);
+/**
+ * Execute JTAG SCAN command
+ *
+ * @param device: Angie device pointer
+ * @param cmd: SCAN command
+ * @return ERROR_OK on success, negative error code otherwise
+ */
+static int angie_jtag_execute_scan(struct angie *device,
+ const struct scan_command *cmd)
+{
+ uint8_t *buffer = NULL;
+ LOG_DEBUG_IO("SCAN: size=%d %s scan end in %s", jtag_scan_size(cmd),
+ (cmd->ir_scan) ? "IR" : "DR", tap_state_name(cmd->end_state));
+ if (cmd->ir_scan) {
+ if (tap_get_state() != TAP_IRSHIFT)
+ angie_set_end_state(TAP_IRSHIFT);
+ } else {
+ if (tap_get_state() != TAP_DRSHIFT)
+ angie_set_end_state(TAP_DRSHIFT);
+ }
+ int ret = angie_state_move(device, 0);
if (ret != ERROR_OK)
return ret;
- if (size_read != size)
- return ERROR_FAIL;
+ angie_set_end_state(cmd->end_state);
+
+ // Execute scan
+ int scan_size = jtag_build_buffer(cmd, &buffer);
+ enum scan_type type = jtag_scan_type(cmd);
+
+ // starting byte index
+ int start_offset = device->xfer_buffer_len;
+
+ // iterate over each bit in all scan data
+ int tms = 0;
+ int tdi = 0;
+ for (int i = 0; i < scan_size; i++) {
+ // calculate tms
+ // if we finish shifting tdi bits : '1' , else '0'
+ tms = (i == scan_size - 1) ? 1 : 0;
+ // calculate byte index
+ int bytec = i / 8;
+ // calculate bit mask: isolate the specific bit in corresponding byte
+ int bcval = 1 << (i % 8);
+ // if type is not SCAN_IN (not just reading data)
+ // and the bit masked is '1' then tdi = '1'
+ tdi = 0;
+ if (type != SCAN_IN && (buffer[bytec] & bcval))
+ tdi = 1;
+ // write tdi and tms twice in tck=0 and tck=1
+ ret = angie_buffer_append(device, 0, tms, tdi);
+ if (ret != ERROR_OK)
+ return ret;
+ ret = angie_buffer_append(device, 1, tms, tdi);
+ if (ret != ERROR_OK)
+ return ret;
+ }
- bytes_remaining = size;
+ angie_set_end_state(cmd->end_state);
+ if (tap_get_state() != tap_get_end_state()) {
+ /*
+ * We *KNOW* the above loop transitioned out of
+ * the shift state, so we skip the first state
+ * and move directly to the end state.
+ */
+ ret = angie_state_move(device, 1);
+ if (ret != ERROR_OK)
+ return ret;
+ }
- /* Send section data in chunks of up to 64 bytes to ANGIE */
- while (bytes_remaining > 0) {
- if (bytes_remaining > 64)
- chunk_size = 64;
- else
- chunk_size = bytes_remaining;
-
- ret = jtag_libusb_control_transfer(device->usb_device_handle,
- (LIBUSB_ENDPOINT_OUT | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE),
- REQUEST_FIRMWARE_LOAD, addr, FIRMWARE_ADDR, (char *)data_ptr,
- chunk_size, LIBUSB_TIMEOUT_MS, &transferred);
-
- if (ret != ERROR_OK)
- return ret;
-
- if (transferred != chunk_size) {
- /* Abort if libusb sent less data than requested */
+ if (jtag_scan_type(cmd) != SCAN_OUT) {
+ // queue read back buffer for further processing
+ struct read_queue_entry *entry = malloc(sizeof(*entry));
+ if (!entry) {
+ LOG_ERROR("Out of memory");
+ free(buffer);
return ERROR_FAIL;
}
- bytes_remaining -= chunk_size;
- addr += chunk_size;
- data_ptr += chunk_size;
- }
-
- return ERROR_OK;
-}
-
-/************************** Generic helper functions **************************/
-
-/**
- * Print state of interesting signals via LOG_INFO().
- *
- * @param input_signals input signal states as returned by CMD_GET_SIGNALS
- * @param output_signals output signal states as returned by CMD_GET_SIGNALS
- */
-static void angie_dump_signal_states(uint8_t input_signals, uint8_t output_signals)
-{
- LOG_INFO("ANGIE signal states: TDI: %i, TDO: %i, TMS: %i, TCK: %i, TRST: %i "
- "SRST: %i",
- (output_signals & SIGNAL_TDI ? 1 : 0),
- (input_signals & SIGNAL_TDO ? 1 : 0),
- (output_signals & SIGNAL_TMS ? 1 : 0),
- (output_signals & SIGNAL_TCK ? 1 : 0),
- (output_signals & SIGNAL_TRST ? 1 : 0),
- (output_signals & SIGNAL_SRST ? 1 : 0));
-}
-
-/**************** ANGIE command generation helper functions ***************/
-
-/**
- * Allocate and initialize space in memory for ANGIE command payload.
- *
- * @param angie_cmd pointer to command whose payload should be allocated.
- * @param size the amount of memory to allocate (bytes).
- * @param direction which payload to allocate.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
- */
-static int angie_allocate_payload(struct angie_cmd *angie_cmd, int size,
- enum angie_payload_direction direction)
-{
- uint8_t *payload;
-
- payload = calloc(size, sizeof(uint8_t));
-
- if (!payload) {
- LOG_ERROR("Could not allocate ANGIE command payload: out of memory");
- return ERROR_FAIL;
- }
-
- switch (direction) {
- case PAYLOAD_DIRECTION_OUT:
- if (angie_cmd->payload_out) {
- LOG_ERROR("BUG: Duplicate payload allocation for ANGIE command");
- free(payload);
- return ERROR_FAIL;
- }
- angie_cmd->payload_out = payload;
- angie_cmd->payload_out_size = size;
- break;
- case PAYLOAD_DIRECTION_IN:
- if (angie_cmd->payload_in_start) {
- LOG_ERROR("BUG: Duplicate payload allocation for ANGIE command");
- free(payload);
- return ERROR_FAIL;
- }
-
- angie_cmd->payload_in_start = payload;
- angie_cmd->payload_in = payload;
- angie_cmd->payload_in_size = size;
-
- /* By default, free payload_in_start in angie_clear_queue(). Commands
- * that do not want this behavior (e. g. split scans) must turn it off
- * separately! */
- angie_cmd->free_payload_in_start = true;
-
- break;
- }
-
- return ERROR_OK;
-}
-
-/****************** ANGIE command queue helper functions ******************/
-
-/**
- * Get the current number of bytes in the queue, including command IDs.
- *
- * @param device pointer to struct angie identifying ANGIE driver instance.
- * @param direction the transfer direction for which to get byte count.
- * @return the number of bytes currently stored in the queue for the specified
- * direction.
- */
-static int angie_get_queue_size(struct angie *device,
- enum angie_payload_direction direction)
-{
- struct angie_cmd *current = device->queue_start;
- int sum = 0;
-
- while (current) {
- switch (direction) {
- case PAYLOAD_DIRECTION_OUT:
- sum += current->payload_out_size + 1; /* + 1 byte for Command ID */
- break;
- case PAYLOAD_DIRECTION_IN:
- sum += current->payload_in_size;
- break;
- }
-
- current = current->next;
- }
-
- return sum;
-}
-
-/**
- * Clear the ANGIE command queue.
- *
- * @param device pointer to struct angie identifying ANGIE driver instance.
- */
-static void angie_clear_queue(struct angie *device)
-{
- struct angie_cmd *current = device->queue_start;
- struct angie_cmd *next = NULL;
-
- while (current) {
- /* Save pointer to next element */
- next = current->next;
-
- /* Free payloads: OUT payload can be freed immediately */
- free(current->payload_out);
- current->payload_out = NULL;
-
- /* IN payload MUST be freed ONLY if no other commands use the
- * payload_in_start buffer */
- if (current->free_payload_in_start) {
- free(current->payload_in_start);
- current->payload_in_start = NULL;
- current->payload_in = NULL;
- }
-
- /* Free queue element */
- free(current);
-
- /* Proceed with next element */
- current = next;
- }
-
- device->commands_in_queue = 0;
- device->queue_start = NULL;
- device->queue_end = NULL;
-}
-
-/**
- * Add a command to the ANGIE command queue.
- *
- * @param device pointer to struct angie identifying ANGIE driver instance.
- * @param angie_cmd pointer to command that shall be appended to the ANGIE
- * command queue.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
- */
-static int angie_append_queue(struct angie *device, struct angie_cmd *angie_cmd)
-{
- int newsize_out, newsize_in;
- int ret = ERROR_OK;
-
- newsize_out = angie_get_queue_size(device, PAYLOAD_DIRECTION_OUT) + 1
- + angie_cmd->payload_out_size;
-
- newsize_in = angie_get_queue_size(device, PAYLOAD_DIRECTION_IN)
- + angie_cmd->payload_in_size;
-
- /* Check if the current command can be appended to the queue */
- if (newsize_out > 64 || newsize_in > 64) {
- /* New command does not fit. Execute all commands in queue before starting
- * new queue with the current command as first entry. */
- ret = angie_execute_queued_commands(device, LIBUSB_TIMEOUT_MS);
-
- if (ret == ERROR_OK)
- ret = angie_post_process_queue(device);
-
- if (ret == ERROR_OK)
- angie_clear_queue(device);
- }
-
- if (!device->queue_start) {
- /* Queue was empty */
- device->commands_in_queue = 1;
-
- device->queue_start = angie_cmd;
- device->queue_end = angie_cmd;
- } else {
- /* There are already commands in the queue */
- device->commands_in_queue++;
-
- device->queue_end->next = angie_cmd;
- device->queue_end = angie_cmd;
- }
-
- if (ret != ERROR_OK)
- angie_clear_queue(device);
-
- return ret;
-}
-
-/**
- * Sends all queued ANGIE commands to the ANGIE for execution.
- *
- * @param device pointer to struct angie identifying ANGIE driver instance.
- * @param timeout_ms
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
- */
-static int angie_execute_queued_commands(struct angie *device, int timeout_ms)
-{
- struct angie_cmd *current;
- int ret, i, index_out, index_in, count_out, count_in, transferred;
- uint8_t buffer[64];
-
- if (LOG_LEVEL_IS(LOG_LVL_DEBUG_IO))
- angie_dump_queue(device);
-
- index_out = 0;
- count_out = 0;
- count_in = 0;
-
- for (current = device->queue_start; current; current = current->next) {
- /* Add command to packet */
- buffer[index_out] = current->id;
- index_out++;
- count_out++;
-
- for (i = 0; i < current->payload_out_size; i++)
- buffer[index_out + i] = current->payload_out[i];
- index_out += current->payload_out_size;
- count_in += current->payload_in_size;
- count_out += current->payload_out_size;
- }
-
- /* Send packet to ANGIE */
- ret = jtag_libusb_bulk_write(device->usb_device_handle, device->ep_out,
- (char *)buffer, count_out, timeout_ms, &transferred);
- if (ret != ERROR_OK) {
- LOG_ERROR("Libusb bulk write queued commands failed.");
- return ret;
- }
- if (transferred != count_out) {
- LOG_ERROR("Libusb bulk write queued commands failed: transferred byte count");
- return ERROR_FAIL;
- }
-
- /* Wait for response if commands contain IN payload data */
- if (count_in > 0) {
- ret = jtag_libusb_bulk_write(device->usb_device_handle, device->ep_in,
- (char *)buffer, count_in, timeout_ms, &transferred);
- if (ret != ERROR_OK) {
- LOG_ERROR("Libusb bulk write input payload data failed");
- return ret;
- }
- if (transferred != count_in) {
- LOG_ERROR("Libusb bulk write input payload data failed: transferred byte count");
- return ERROR_FAIL;
- }
-
- /* Write back IN payload data */
- index_in = 0;
- for (current = device->queue_start; current; current = current->next) {
- for (i = 0; i < current->payload_in_size; i++) {
- current->payload_in[i] = buffer[index_in];
- index_in++;
- }
- }
- }
- return ERROR_OK;
-}
-
-/**
- * Convert an ANGIE command ID (\a id) to a human-readable string.
- *
- * @param id the ANGIE command ID.
- * @return the corresponding human-readable string.
- */
-static const char *angie_cmd_id_string(uint8_t id)
-{
- switch (id) {
- case CMD_SCAN_IN:
- return "CMD_SCAN_IN";
- case CMD_SLOW_SCAN_IN:
- return "CMD_SLOW_SCAN_IN";
- case CMD_SCAN_OUT:
- return "CMD_SCAN_OUT";
- case CMD_SLOW_SCAN_OUT:
- return "CMD_SLOW_SCAN_OUT";
- case CMD_SCAN_IO:
- return "CMD_SCAN_IO";
- case CMD_SLOW_SCAN_IO:
- return "CMD_SLOW_SCAN_IO";
- case CMD_CLOCK_TMS:
- return "CMD_CLOCK_TMS";
- case CMD_SLOW_CLOCK_TMS:
- return "CMD_SLOW_CLOCK_TMS";
- case CMD_CLOCK_TCK:
- return "CMD_CLOCK_TCK";
- case CMD_SLOW_CLOCK_TCK:
- return "CMD_SLOW_CLOCK_TCK";
- case CMD_SLEEP_US:
- return "CMD_SLEEP_US";
- case CMD_SLEEP_MS:
- return "CMD_SLEEP_MS";
- case CMD_GET_SIGNALS:
- return "CMD_GET_SIGNALS";
- case CMD_SET_SIGNALS:
- return "CMD_SET_SIGNALS";
- case CMD_CONFIGURE_TCK_FREQ:
- return "CMD_CONFIGURE_TCK_FREQ";
- case CMD_SET_LEDS:
- return "CMD_SET_LEDS";
- case CMD_TEST:
- return "CMD_TEST";
- default:
- return "CMD_UNKNOWN";
- }
-}
-
-/**
- * Print one ANGIE command to stdout.
- *
- * @param angie_cmd pointer to ANGIE command.
- */
-static void angie_dump_command(struct angie_cmd *angie_cmd)
-{
- char hex[64 * 3];
- for (int i = 0; i < angie_cmd->payload_out_size; i++)
- sprintf(hex + 3 * i, "%02" PRIX8 " ", angie_cmd->payload_out[i]);
-
- hex[3 * angie_cmd->payload_out_size - 1] = 0;
- LOG_DEBUG_IO(" %-22s | OUT size = %" PRIi8 ", bytes = %s",
- angie_cmd_id_string(angie_cmd->id), angie_cmd->payload_out_size, hex);
-
- LOG_DEBUG_IO("\n | IN size = %" PRIi8 "\n", angie_cmd->payload_in_size);
-}
-
-/**
- * Print the ANGIE command queue to stdout.
- *
- * @param device pointer to struct angie identifying ANGIE driver instance.
- */
-static void angie_dump_queue(struct angie *device)
-{
- struct angie_cmd *current;
-
- LOG_DEBUG_IO("ANGIE command queue:\n");
-
- for (current = device->queue_start; current; current = current->next)
- angie_dump_command(current);
-}
-
-/**
- * Perform JTAG scan
- *
- * Creates and appends a JTAG scan command to the ANGIE command queue.
- * A JTAG scan consists of three steps:
- * - Move to the desired SHIFT state, depending on scan type (IR/DR scan).
- * - Shift TDI data into the JTAG chain, optionally reading the TDO pin.
- * - Move to the desired end state.
- *
- * @param device pointer to struct angie identifying ANGIE driver instance.
- * @param scan_type the type of the scan (IN, OUT, IO (bidirectional)).
- * @param scan_size_bits number of bits to shift into the JTAG chain.
- * @param tdi pointer to array containing TDI data.
- * @param tdo_start pointer to first element of array where TDO data shall be
- * stored. See #angie_cmd for details.
- * @param tdo pointer to array where TDO data shall be stored
- * @param tms_count_start number of TMS state transitions to perform BEFORE
- * shifting data into the JTAG chain.
- * @param tms_sequence_start sequence of TMS state transitions that will be
- * performed BEFORE shifting data into the JTAG chain.
- * @param tms_count_end number of TMS state transitions to perform AFTER
- * shifting data into the JTAG chain.
- * @param tms_sequence_end sequence of TMS state transitions that will be
- * performed AFTER shifting data into the JTAG chain.
- * @param origin pointer to OpenOCD command that generated this scan command.
- * @param postprocess whether this command needs to be post-processed after
- * execution.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
- */
-static int angie_append_scan_cmd(struct angie *device, enum scan_type scan_type,
- int scan_size_bits, uint8_t *tdi, uint8_t *tdo_start, uint8_t *tdo,
- uint8_t tms_count_start, uint8_t tms_sequence_start, uint8_t tms_count_end,
- uint8_t tms_sequence_end, struct jtag_command *origin, bool postprocess)
-{
- struct angie_cmd *cmd = calloc(1, sizeof(struct angie_cmd));
- int ret, i, scan_size_bytes;
- uint8_t bits_last_byte;
-
- if (!cmd)
- return ERROR_FAIL;
-
- /* Check size of command. USB buffer can hold 64 bytes, 1 byte is command ID,
- * 5 bytes are setup data -> 58 remaining payload bytes for TDI data */
- if (scan_size_bits > (58 * 8)) {
- LOG_ERROR("BUG: Tried to create CMD_SCAN_IO ANGIE command with too"
- " large payload");
- free(cmd);
- return ERROR_FAIL;
- }
-
- scan_size_bytes = DIV_ROUND_UP(scan_size_bits, 8);
-
- bits_last_byte = scan_size_bits % 8;
- if (bits_last_byte == 0)
- bits_last_byte = 8;
-
- /* Allocate out_payload depending on scan type */
- switch (scan_type) {
- case SCAN_IN:
- if (device->delay_scan_in < 0)
- cmd->id = CMD_SCAN_IN;
- else
- cmd->id = CMD_SLOW_SCAN_IN;
- ret = angie_allocate_payload(cmd, 5, PAYLOAD_DIRECTION_IN);
- break;
- case SCAN_OUT:
- if (device->delay_scan_out < 0)
- cmd->id = CMD_SCAN_OUT;
- else
- cmd->id = CMD_SLOW_SCAN_OUT;
- ret = angie_allocate_payload(cmd, scan_size_bytes + 5, PAYLOAD_DIRECTION_OUT);
- break;
- case SCAN_IO:
- if (device->delay_scan_io < 0)
- cmd->id = CMD_SCAN_IO;
- else
- cmd->id = CMD_SLOW_SCAN_IO;
- ret = angie_allocate_payload(cmd, scan_size_bytes + 5, PAYLOAD_DIRECTION_OUT);
- break;
- default:
- LOG_ERROR("BUG: 'append scan cmd' encountered an unknown scan type");
- ret = ERROR_FAIL;
- break;
- }
-
- if (ret != ERROR_OK) {
- free(cmd);
- return ret;
- }
-
- /* Build payload_out that is common to all scan types */
- cmd->payload_out[0] = scan_size_bytes & 0xFF;
- cmd->payload_out[1] = bits_last_byte & 0xFF;
- cmd->payload_out[2] = ((tms_count_start & 0x0F) << 4) | (tms_count_end & 0x0F);
- cmd->payload_out[3] = tms_sequence_start;
- cmd->payload_out[4] = tms_sequence_end;
-
- /* Setup payload_out for types with OUT transfer */
- if (scan_type == SCAN_OUT || scan_type == SCAN_IO) {
- for (i = 0; i < scan_size_bytes; i++)
- cmd->payload_out[i + 5] = tdi[i];
- }
-
- /* Setup payload_in pointers for types with IN transfer */
- if (scan_type == SCAN_IN || scan_type == SCAN_IO) {
- cmd->payload_in_start = tdo_start;
- cmd->payload_in = tdo;
- cmd->payload_in_size = scan_size_bytes;
- }
-
- cmd->needs_postprocessing = postprocess;
- cmd->cmd_origin = origin;
-
- /* For scan commands, we free payload_in_start only when the command is
- * the last in a series of split commands or a stand-alone command */
- cmd->free_payload_in_start = postprocess;
-
- return angie_append_queue(device, cmd);
-}
-
-/**
- * Perform TAP state transitions
- *
- * @param device pointer to struct angie identifying ANGIE driver instance.
- * @param count defines the number of TCK clock cycles generated (up to 8).
- * @param sequence defines the TMS pin levels for each state transition. The
- * Least-Significant Bit is read first.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
- */
-static int angie_append_clock_tms_cmd(struct angie *device, uint8_t count,
- uint8_t sequence)
-{
- struct angie_cmd *cmd = calloc(1, sizeof(struct angie_cmd));
- int ret;
-
- if (!cmd) {
- LOG_ERROR("Out of memory");
- return ERROR_FAIL;
- }
-
- if (device->delay_clock_tms < 0)
- cmd->id = CMD_CLOCK_TMS;
- else
- cmd->id = CMD_SLOW_CLOCK_TMS;
-
- /* CMD_CLOCK_TMS has two OUT payload bytes and zero IN payload bytes */
- ret = angie_allocate_payload(cmd, 2, PAYLOAD_DIRECTION_OUT);
- if (ret != ERROR_OK) {
- free(cmd);
- return ret;
- }
-
- cmd->payload_out[0] = count;
- cmd->payload_out[1] = sequence;
-
- return angie_append_queue(device, cmd);
-}
-
-/**
- * Generate a defined amount of TCK clock cycles
- *
- * All other JTAG signals are left unchanged.
- *
- * @param device pointer to struct angie identifying ANGIE driver instance.
- * @param count the number of TCK clock cycles to generate.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
- */
-static int angie_append_clock_tck_cmd(struct angie *device, uint16_t count)
-{
- struct angie_cmd *cmd = calloc(1, sizeof(struct angie_cmd));
- int ret;
-
- if (!cmd) {
- LOG_ERROR("Out of memory");
- return ERROR_FAIL;
- }
-
- if (device->delay_clock_tck < 0)
- cmd->id = CMD_CLOCK_TCK;
- else
- cmd->id = CMD_SLOW_CLOCK_TCK;
-
- /* CMD_CLOCK_TCK has two OUT payload bytes and zero IN payload bytes */
- ret = angie_allocate_payload(cmd, 2, PAYLOAD_DIRECTION_OUT);
- if (ret != ERROR_OK) {
- free(cmd);
- return ret;
- }
-
- cmd->payload_out[0] = count & 0xff;
- cmd->payload_out[1] = (count >> 8) & 0xff;
-
- return angie_append_queue(device, cmd);
-}
-
-/**
- * Read JTAG signals.
- *
- * @param device pointer to struct angie identifying ANGIE driver instance.
- * @return on success: ERROR_OK
- * @return on failure: ERROR_FAIL
- */
-...
[truncated message content] |
