ch347.c

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0-or-later
 
/***************************************************************************
 *   Driver for CH347-JTAG interface V1.1                                  *
 *                                                                         *
 *   Copyright (C) 2022 by oidcat.                                         *
 *   Author: oidcatiot@163.com                                             *
 *                                                                         *
 *   Enhancements by EasyDevKits - info@easydevkits.com                    *
 *                                                                         *
 *   CH347 is a high-speed USB bus converter chip that provides UART, I2C  *
 *   and SPI synchronous serial ports and JTAG interface through USB bus.  *
 *                                                                         *
 *   The JTAG interface by CH347 can supports transmission frequency       *
 *   configuration up to 60MHz.                                            *
 *                                                                         *
 *   The USB2.0 to JTAG scheme based on CH347 can be used to build         *
 *   customized USB high-speed JTAG debugger and other products.           *
 *                                                                         *
 *            _____________                                                *
 *           |             |____JTAG/SWD (TDO,TDI,TMS,TCK,TRST)            *
 *      USB__|   CH347T/F  |                                               *
 *           |_____________|____UART(TXD1,RXD1,RTS1,CTS1,DTR1)             *
 *            ______|______                                                *
 *           |             |                                               *
 *           | 8 MHz XTAL  |                                               *
 *           |_____________|                                               *
 *                                                                         *
 *   This CH347 driver is tested with the CH347T chip in mode 3 and        *
 *   with the CH347F chip.                                                 *
 *                                                                         *
 *   The datasheet for the wch-ic.com's CH347 part is here:            *
 *   https://www.wch-ic.com/downloads/CH347DS1_PDF.html                    *
 *                                                                         *
 ***************************************************************************/
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
 
#if IS_CYGWIN == 1
#include "windows.h"
#undef LOG_ERROR
#endif
 
// project specific includes
#include <jtag/interface.h>
#include <jtag/commands.h>
#include <jtag/swd.h>
#include <jtag/adapter.h>
#include <helper/time_support.h>
#include <helper/replacements.h>
#include <helper/list.h>
#include <helper/binarybuffer.h>
#include "libusb_helper.h"
 
// system includes
#include <stdlib.h>
#include <string.h>
#include <sys/time.h>
#include <time.h>
#include <unistd.h>
 
#define TDI_H   BIT(4)
#define TDI_L   0
#define TMS_H   BIT(1)
#define TMS_L   0
#define TCK_H   BIT(0)
#define TCK_L   0
#define TRST_H BIT(5)
#define TRST_L 0
#define SRST_H BIT(6)
#define SRST_L 0
#define LED_ON 1
#define LED_OFF 0
#define GPIO_CNT    8 // the CH347 has 8 GPIO's
/* mask which GPIO's are available in mode 3 of the CH347T: only GPIO3 (Pin11 / SCL),
    GPIO4 (Pin15 / ACT), GPIO5 (Pin9 / TRST) and GPIO6 (Pin2 / CTS1) are possible */
#define CH347T_USABLE_GPIOS 0x78
/* On the CH347F the GPIO's share the pins with the interface signals: GPIO0 (Pin17),
    GPIO1 (Pin18), GPIO2 (Pin10), GPIO3 (Pin9 / TRST), GPIO4 (Pin23 / TCK + SWDCLK),
    GPIO5 (Pin24 / TDO), GPIO6 (Pin25 / TDI), GPIO7 (Pin26 / TMS + SWDIO). GPIO4 to GPIO7
    always carry a signal of the JTAG or SWD interface, so only GPIO0 to GPIO3 are left.
    GPIO3 is TRST, which is not a SWD signal. */
#define CH347F_USABLE_GPIOS 0x0F
/* In SWD mode the TRST pin is unused as a JTAG signal, so it can drive SRST through the GPIO
    command. TRST is Pin9 on both chips, but has a different GPIO number: GPIO5 on CH347T,
    GPIO3 on CH347F. */
#define CH347T_TRST_GPIO    5
#define CH347F_TRST_GPIO    3
/* For GPIO command: always set bits 7 and 6 for GPIO enable
    bits 5 and 4 for pin direction output bit 3 is the data bit */
#define GPIO_SET_L  (BIT(4) | BIT(5) | BIT(6) | BIT(7)) // value for setting a GPIO to low
#define GPIO_SET_H  (BIT(3) | BIT(4) | BIT(5) | BIT(6) | BIT(7)) // value for setting a GPIO to high
// enable the pin and set the direction to input, so the pin gets released
#define GPIO_SET_INPUT  (BIT(6) | BIT(7))
 
#define VENDOR_VERSION  0x5F // for getting the chip version
 
// maybe the hardware of the CH347 chip can capture only this amount of TDO bits
#define HW_TDO_BUF_SIZE 4096
// Don't send more than this amount of bytes via libusb in one packet. Also that is the limit for LARGER_PACK mode.
#define LARGER_PACK_MAX_SIZE    51200
// The data length contained in each command packet during USB high-speed operation
#define UCMDPKT_DATA_MAX_BYTES_USBHS    507
#define USBC_PACKET_USBHS   512 // Maximum data length per packet at USB high speed
#define CH347_CMD_HEADER    3 // Protocol header length (1 byte command type + 2 bytes data length)
#define CH347_CMD_INIT_READ_LEN 1 // JTAG_INIT/SWD_INIT/PIN_SET read one data byte
// if we send 9 in the init command we get the STANDARD mode or LARGER_PACK mode flag
#define CH347_CMD_INIT_GET_MODE_CLOCK_INDEX_VALUE 9
// No more bits are allowed per CH347_CMD_JTAG_BIT_OP command; this should be dividable by 8
#define MAX_BITS_PER_BIT_OP 248
 
/* Protocol transmission format: CMD (1 byte) + Length (2 bytes) + Data
    Parameter acquisition, used to obtain firmware version, JTAG interface related parameters, etc */
#define CH347_CMD_INFO_RD   0xCA
#define CH347_CMD_GPIO  0xCC // GPIO Command
#define CH347_CMD_JTAG_INIT 0xD0 // JTAG Interface initialization command
#define CH347_CMD_JTAG_BIT_OP   0xD1 // JTAG interface pin bit control command
#define CH347_CMD_JTAG_BIT_OP_RD    0xD2 // JTAG interface pin bit control and read commands
#define CH347_CMD_JTAG_DATA_SHIFT   0xD3 // JTAG interface data shift command
#define CH347_CMD_JTAG_DATA_SHIFT_RD    0xD4 // JTAG interface data shift and read command
#define CH347_CMD_PIN_SET   0xE2 // set pin functions (CH347F)
// for a single command these amount of data can be read at max
#define CH347_SINGLE_CMD_MAX_READ   MAX(GPIO_CNT, CH347_CMD_INIT_READ_LEN)
 
// for SWD
#define CH347_CMD_SWD_INIT  0xE5 // SWD Interface Initialization Command
#define CH347_CMD_SWD   0xE8 // SWD Command group header
#define CH347_CMD_SWD_REG_W 0xA0 // SWD Interface write reg
#define CH347_CMD_SWD_SEQ_W 0xA1 // SWD Interface write spec seq
#define CH347_CMD_SWD_REG_R 0xA2 // SWD Interface read  reg
#define CH347_MAX_PROCESSING_US 7000 // max time in us for packet processing
              // USB hosts disconnect the adapter if SWD processing takes more!
#define CH347_MAX_SEND_BUF  USBC_PACKET_USBHS
#define CH347_MAX_RECV_BUF  USBC_PACKET_USBHS
#define CH347_MAX_CMD_BUF   128
#define CH347_SWD_CLOCK_MAX 5000
#define CH347_SWD_CLOCK_BASE 1000
// limited by the longest sequence processing time
#define CH347_SWD_CLOCK_MAX_DIVISOR (CH347_MAX_PROCESSING_US / swd_seq_dormant_to_swd_len)
 
#define CH347_EPOUT 0x06u // the usb endpoint number for writing
#define CH347_EPIN  0x86u // the usb endpoint number for reading
#define CH347T_MPHSI_INTERFACE  2   // the CH347T JTAG interface is number 2
#define CH347F_MPHSI_INTERFACE  4   // the CH347F JTAG interface is number 4
#define USB_WRITE_TIMEOUT   500 // write timeout in milliseconds
#define USB_READ_TIMEOUT    500 // read timeout in milliseconds
// BCD version for devices that can use bytewise mode   below this version only bitwise mode can be used
#define BYTEWISE_MODE_VERSION   0x241
/* if the configuration is not setting the vendor id / product id we search for vendor id 1a86
    and product id's 0x55dd (CH347T chip in mode 3), 0x55de (CH347F chip) and 0x55e7 (other chip) */
#define DEFAULT_VENDOR_ID   0x1a86
#define DEFAULT_CH347T_PRODUCT_ID   0x55dd
#define DEFAULT_CH347F_PRODUCT_ID   0x55de
#define DEFAULT_OTHER_PRODUCT_ID    0x55e7
 
/* There are 3 different CH347 variants. The datasheet mentions the CH347T chip which has the product id 0x55dd
    as default when it's configured to mode 3. The CH347F chip is also mentioned in the datasheet and has the
    default product id 0x55de. The 3rd variant is not mentioned in a datasheet but was found here
    https://github.com/WCHSoftGroup/ch347
    The code from WCHSoftGroup is also searching for this product id */
enum ch347_variant {
    CH347T = 0, // The CH347T chip
    CH347F = 1, // The CH347F chip
    OTHER_PRODUCT_ID = 2, // other product id not mentioned in the datasheet
};
 
/* STANDARD_PACK means that we can send only one USBC_PACKET_USBHS-sized USB packet
    and then read data back. LARGER_PACK means, we can send packets as large as
    LARGER_PACK_MAX_SIZE. libusb splits there large packets into smaller USB packets and
    transmit the data. Then we read back the data in a bigger packet. */
enum pack_size {
    UNSET = -1,
    STANDARD_PACK = 0,
    LARGER_PACK = 1,
};
 
// for STANDARD_PACK mode: these are the 6 possible speeds; values in kHz
static const int ch347_standard_pack_clock_speeds[] = {
    1875, // 1.875 MHz (60000 : 32)
    3750, // 3.75 MHz (60000 : 16)
    7500, // 7.5 MHz (60000 : 8)
    15000, // 15 MHz (60000 : 4)
    30000, // 30 MHz (60000 : 2)
    60000 // 60 MHz
};
 
// for LARGER_PACK mode: these are the 8 possible speeds; values in kHz
static const int ch347_larger_pack_clock_speeds[] = {
    469, // 468.75 kHz (60000 : 128)
    938, // 937.5 kHz (60000 : 64)
    1875, // 1.875 MHz (60000 : 32)
    3750, // 3.75 MHz (60000 : 16)
    7500, // 7.5 MHz (60000 : 8)
    15000, // 15 MHz (60000 : 4)
    30000, // 30 MHz (60000 : 2)
    60000 // 60 MHz
};
 
struct ch347_cmd {
    uint8_t type; // the command type
    uint8_t *write_data; // data bytes for write
    uint16_t write_data_len; // count of data bytes in the write_data buffer
    uint16_t read_len; // if >0 a read is needed after this command
    uint16_t tdo_bit_count; // how many TDO bits are needed to shift in by this read
    struct list_head queue; // for handling a queue (list)
};
 
struct ch347_scan {
    struct scan_field *fields; // array of scan_field's for data from the device
    int fields_len; // scan_fields array length
    struct list_head queue; // for handling a queue (list)
};
 
struct ch347_info {
    // Record the CH347 pin status
    int tms_pin;
    int tdi_pin;
    int tck_pin;
    int trst_pin;
    int srst_pin;
 
    enum ch347_variant chip_variant; // ch347_variant for explanation
    // if true then we can't us the bytewise commands   due to a bug of the chip; depends on BYTEWISE_MODE_VERSION
    bool use_bitwise_mode;
    enum pack_size pack_size; // see: pack_size for explanation
    int max_len; // in STANDARD_PACK or bitwise mode we can send only one USBC_PACKET_USBHS sized package
    bool swclk_5mhz_supported;
 
    // a "scratchpad" where we record all bytes for one command
    uint8_t scratchpad_cmd_type; // command type
    uint8_t scratchpad[UCMDPKT_DATA_MAX_BYTES_USBHS]; // scratchpad buffer
    int scratchpad_idx; // current index in scratchpad
 
    // after a command is complete it will be stored for later processing
    struct list_head cmd_queue;
    // all data input scan fields are queued here
    struct list_head scan_queue;
    // read buffer for the single commands like CH347_CMD_GPIO and CH347_CMD_JTAG_INIT
    uint8_t single_read[CH347_SINGLE_CMD_MAX_READ];
    int singe_read_len; // data length in single_read
};
 
struct ch347_swd_io {
    uint8_t usb_cmd; // 0xA0, 0xA1, 0xA2
    uint8_t cmd;
    uint32_t *dst;
    uint32_t value;
    struct list_head list_entry;
};
 
struct ch347_swd_context {
    uint8_t send_buf[CH347_MAX_SEND_BUF];
    uint8_t recv_buf[CH347_MAX_RECV_BUF];
    int send_len;
    int recv_len;
    int need_recv_len;
    int queued_retval;
    int sent_cmd_count;
    unsigned int clk_divisor;
    unsigned int total_swd_clk;
    struct list_head send_cmd_head;
    struct list_head free_cmd_head;
    struct ch347_swd_io ch347_cmd_buf[CH347_MAX_CMD_BUF];
};
 
static struct ch347_swd_context ch347_swd_context;
static bool swd_mode;
static uint16_t default_ch347_vids[] = {DEFAULT_VENDOR_ID, DEFAULT_VENDOR_ID, DEFAULT_VENDOR_ID, 0};
static uint16_t default_ch347_pids[] = {DEFAULT_CH347T_PRODUCT_ID,
    DEFAULT_CH347F_PRODUCT_ID, DEFAULT_OTHER_PRODUCT_ID, 0};
static uint8_t ch347_activity_led_gpio_pin = 0xFF;
static bool ch347_activity_led_active_high;
// GPIO driving SRST in SWD mode, defaults to the otherwise unused TRST pin
static uint8_t ch347_srst_gpio_pin = 0xFF;
static bool ch347_srst_active_high;
/* Set after the CH347F dedicated SRST output is enabled and its pin byte
 * has been transmitted. JTAG pin bytes carry bit 6 only then. SWD leaves
 * this clear. */
static bool ch347_dedicated_srst_enabled;
static struct ch347_info ch347;
static struct libusb_device_handle *ch347_handle;
 
/* there are "single" commands. These commands can't be chained together and
    need to be send as single command and need a read after write */
static inline bool ch347_is_single_cmd_type(uint8_t type)
{
    return type == CH347_CMD_GPIO || type == CH347_CMD_JTAG_INIT || type == CH347_CMD_SWD_INIT ||
        type == CH347_CMD_PIN_SET;
}
 
static void log_buf_dump(const uint8_t *data, unsigned int size, bool recv)
{
    unsigned int i = 0, j = 0;
    unsigned int n = size * 3 + 1;
    char *str = malloc(n);
    if (!str)
        return;
 
    while (i < size && j < n) {
        uint8_t cmd = data[i++];
        hexify(str + j, &cmd, 1, n - j);
        j += 2;
        str[j++] = ' ';
 
        unsigned int cmd_payload_size = le_to_h_u16(data + i);
        if (i + 2 <= size && j + 4 < n) {
            hexify(str + j, data + i, 2, n - j);
            i += 2;
            j += 4;
            str[j++] = ' ';
        }
 
        if (cmd == CH347_CMD_SWD) {
            // nested SWD commands
            str[j] = '\0';
            if (i + cmd_payload_size > size) {
                LOG_DEBUG_IO("%s - bad size", str);
                cmd_payload_size = size - i;
            } else {
                LOG_DEBUG_IO("%s", str);
            }
            j = 0;
            unsigned int swd_base_i = i;
 
            while (i < swd_base_i + cmd_payload_size) {
                uint8_t swd_cmd = data[i++];
                hexify(str + j, &swd_cmd, 1, n - j);
                j += 2;
                str[j++] = ' ';
 
                unsigned int swd_bits = 0;
                unsigned int swd_payload_size = 0;
                if (!recv) {
                    if (i + 2 <= size) {
                        swd_bits = le_to_h_u16(data + i);
                        hexify(str + j, data + i, 2, n - j);
                        i += 2;
                        j += 4;
                        str[j++] = ' ';
                    }
                }
 
                switch (swd_cmd) {
                case CH347_CMD_SWD_REG_W:
                    if (recv)
                        swd_payload_size = 1;
                    else
                        swd_payload_size = DIV_ROUND_UP(swd_bits, 8);
                    break;
                case CH347_CMD_SWD_SEQ_W:
                    if (!recv)
                        swd_payload_size = DIV_ROUND_UP(swd_bits, 8);
                    break;
                case CH347_CMD_SWD_REG_R:
                    if (recv)
                        swd_payload_size = 1 + 4 + 1;
                    else
                        swd_payload_size = 1;
                    break;
                }
 
                hexify(str + j, data + i, MIN(swd_payload_size, size - i), n - j);
                i += swd_payload_size;
                j += 2 * swd_payload_size;
                str[j] = '\0';
                if (i > size)
                    LOG_DEBUG_IO("    %s - bad size", str);
                else
                    LOG_DEBUG_IO("    %s", str);
                j = 0;
            }
        } else {
            hexify(str + j, data + i, MIN(cmd_payload_size, size - i), n - j);
            i += cmd_payload_size;
            j += 2 * cmd_payload_size;
            str[j] = '\0';
            if (i > size)
                LOG_DEBUG_IO("%s - bad size", str);
            else
                LOG_DEBUG_IO("%s", str);
            j = 0;
        }
    }
    free(str);
}
 
static int ch347_write_data(uint8_t *data, int *length)
{
    int write_len = *length;
    int i = 0;
    int transferred = 0;
 
    while (true) {
        int retval = jtag_libusb_bulk_write(ch347_handle, CH347_EPOUT, (char *)&data[i],
            write_len, USB_WRITE_TIMEOUT, &transferred);
        if (retval != ERROR_OK) {
            LOG_ERROR("CH347 write fail");
            *length = 0;
            return retval;
        }
        i += transferred;
        if (i >= *length)
            break;
        write_len = *length - i;
    }
 
    if (LOG_LEVEL_IS(LOG_LVL_DEBUG_IO)) {
        LOG_DEBUG_IO("size=%d, buf=", i);
        log_buf_dump(data, i, false);
    }
 
    *length = i;
    return ERROR_OK;
}
 
static int ch347_read_data(uint8_t *data, int *length)
{
    int read_len = *length;
    int i = 0;
    int transferred = 0;
 
    while (true) {
        int retval = jtag_libusb_bulk_read(ch347_handle, CH347_EPIN, (char *)&data[i],
            read_len, USB_READ_TIMEOUT, &transferred);
        if (retval != ERROR_OK) {
            LOG_ERROR("CH347 read fail");
            *length = 0;
            return retval;
        }
 
        i += transferred;
        if (i >= *length)
            break;
        read_len = *length - i;
    }
 
    if (LOG_LEVEL_IS(LOG_LVL_DEBUG_IO)) {
        LOG_DEBUG_IO("size=%d, buf=", i);
        log_buf_dump(data, i, true);
    }
 
    *length = i;
    return ERROR_OK;
}
 
static void ch347_cmd_calc_reads(struct ch347_cmd *cmd)
{
    cmd->read_len = 0;
    cmd->tdo_bit_count = 0;
 
    switch (cmd->type) {
    case CH347_CMD_GPIO:
        // for GPIO we need to read back the same amount of data that we had send
        cmd->read_len = cmd->write_data_len;
        break;
    case CH347_CMD_JTAG_INIT:
    case CH347_CMD_SWD_INIT:
    case CH347_CMD_PIN_SET:
        // for JTAG_INIT/SWD_INIT/PIN_SET the amount is fixed
        cmd->read_len = CH347_CMD_INIT_READ_LEN;
        break;
    case CH347_CMD_JTAG_BIT_OP_RD:
        // for bit operations we need to count the TCK high edges
        for (int i = 0; i < cmd->write_data_len; i++) {
            if ((cmd->write_data[i] & TCK_H) == TCK_H) {
                cmd->read_len++;
                cmd->tdo_bit_count++;
            }
        }
        break;
    case CH347_CMD_JTAG_DATA_SHIFT_RD:
        // for byte operations: need to read one byte back for each data byte
        cmd->read_len = cmd->write_data_len;
        // we occupy 8 bits per byte in the TDO hardware buffer
        cmd->tdo_bit_count = cmd->read_len * 8;
        break;
    }
}
 
static int ch347_cmd_from_scratchpad(void)
{
    // nothing to do if no bytes are recorded
    if (!ch347.scratchpad_idx)
        return ERROR_OK;
 
    // malloc for the command and data bytes
    struct ch347_cmd *cmd = malloc(sizeof(struct ch347_cmd));
    if (cmd)
        cmd->write_data = malloc(ch347.scratchpad_idx);
    if (!cmd || !cmd->write_data) {
        LOG_ERROR("malloc failed");
        free(cmd);
        return ERROR_FAIL;
    }
 
    // copy data, calculate the reads and add to the command queue
    cmd->type = ch347.scratchpad_cmd_type;
    cmd->write_data_len = ch347.scratchpad_idx;
    memcpy(cmd->write_data, ch347.scratchpad, ch347.scratchpad_idx);
    ch347_cmd_calc_reads(cmd);
    list_add_tail(&cmd->queue, &ch347.cmd_queue);
 
    // cleanup the scratchpad for the next command
    ch347.scratchpad_cmd_type = 0;
    ch347.scratchpad_idx = 0;
    return ERROR_OK;
}
 
static int ch347_read_scan(uint8_t *decoded_buf, int decoded_buf_len, int raw_read_len)
{
    int read_len = raw_read_len;
    uint8_t *read_buf = malloc(read_len);
    if (!read_buf) {
        LOG_ERROR("malloc failed");
        return ERROR_FAIL;
    }
 
    int retval = ch347_read_data(read_buf, &read_len);
    if (retval != ERROR_OK) {
        free(read_buf);
        return retval;
    }
 
    int rd_idx = 0;
    int decoded_buf_idx = 0;
 
    while (rd_idx < read_len) {
        unsigned int type = read_buf[rd_idx++];
        uint16_t data_len = le_to_h_u16(&read_buf[rd_idx]);
        rd_idx += 2;
        if (decoded_buf_idx > decoded_buf_len) {
            LOG_ERROR("CH347 decoded_buf too small");
            free(read_buf);
            return ERROR_FAIL;
        }
 
        // nothing to decode? Only read to make the CH347 happy!
        if (!decoded_buf) {
            rd_idx += data_len;
            continue;
        }
 
        switch (type) {
        case CH347_CMD_GPIO:
        case CH347_CMD_JTAG_INIT:
        case CH347_CMD_SWD_INIT:
        case CH347_CMD_PIN_SET:
        case CH347_CMD_JTAG_DATA_SHIFT_RD:
            // for all bytewise commands: copy the data bytes
            memcpy(&decoded_buf[decoded_buf_idx], &read_buf[rd_idx], data_len);
            decoded_buf_idx += data_len;
            rd_idx += data_len;
            break;
        case CH347_CMD_JTAG_BIT_OP_RD:
            // for CH347_CMD_JTAG_BIT_OP_RD we need to copy bit by bit
            for (int i = 0; i < data_len; i++) {
                if (read_buf[rd_idx + i] & BIT(0))
                    decoded_buf[decoded_buf_idx + i / 8] |= BIT(i % 8);
                else
                    decoded_buf[decoded_buf_idx + i / 8] &= ~(BIT(i % 8));
            }
            rd_idx += data_len;
            decoded_buf_idx += DIV_ROUND_UP(data_len, 8);
            break;
        default:
            LOG_ERROR("CH347 read command fail");
            free(read_buf);
            return ERROR_FAIL;
        }
    }
 
    free(read_buf);
    return ERROR_OK;
}
 
static int ch347_scan_data_to_fields(uint8_t *decoded_buf, int decoded_buf_len)
{
    int byte_offset = 0;
    struct ch347_scan *scan;
    struct ch347_scan *tmp;
    int bit_offset = 0;
    list_for_each_entry_safe(scan, tmp, &ch347.scan_queue, queue) {
        for (int i = 0; i < scan->fields_len; i++) {
            int num_bits = scan->fields[i].num_bits;
            LOG_DEBUG("fields[%d].in_value[%d], read from bit offset: %d", i, num_bits, bit_offset);
            // only if we need the value
            if (scan->fields[i].in_value) {
                uint8_t *capture_buf = malloc(DIV_ROUND_UP(num_bits, 8));
                if (!capture_buf) {
                    LOG_ERROR("malloc failed");
                    return ERROR_FAIL;
                }
                uint8_t *captured = buf_set_buf(decoded_buf, bit_offset, capture_buf, 0, num_bits);
 
                if (LOG_LEVEL_IS(LOG_LVL_DEBUG_IO)) {
                    char *str = buf_to_hex_str(captured, num_bits);
                    LOG_DEBUG_IO("size=%d, buf=[%s]", num_bits, str);
                    free(str);
                }
 
                buf_cpy(captured, scan->fields[i].in_value, num_bits);
                free(capture_buf);
            } else {
                if (LOG_LEVEL_IS(LOG_LVL_DEBUG_IO))
                    LOG_DEBUG_IO("field skipped");
            }
            bit_offset += num_bits;
        }
        list_del(&scan->queue);
        free(scan);
        /* after one round of scan field processing the
            next data bits are read from the next data byte
            => round up and calculate the next start bit */
        byte_offset = DIV_ROUND_UP(bit_offset, 8);
        bit_offset = byte_offset * 8;
    }
 
    // if not all bytes are transferred: put the rest into single_read buffer
    if (byte_offset < decoded_buf_len) {
        ch347.singe_read_len = decoded_buf_len - byte_offset;
        LOG_DEBUG("single read of %d bytes", ch347.singe_read_len);
        if (ch347.singe_read_len > CH347_SINGLE_CMD_MAX_READ) {
            LOG_ERROR("Can't read more than %d bytes for a single command!", CH347_SINGLE_CMD_MAX_READ);
            ch347.singe_read_len = CH347_SINGLE_CMD_MAX_READ;
        }
        memcpy(ch347.single_read, &decoded_buf[byte_offset], ch347.singe_read_len);
    }
 
    return ERROR_OK;
}
 
static int ch347_cmd_transmit_queue(void)
{
    // queue last command
    int retval = ch347_cmd_from_scratchpad();
    if (retval != ERROR_OK)
        return retval;
 
    // nothing to do! => done here
    if (list_empty(&ch347.cmd_queue))
        return ERROR_OK;
 
    // calculate the needed buffer length for all decoded bytes
    struct ch347_cmd *cmd;
    int decoded_buf_len = 0;
    list_for_each_entry(cmd, &ch347.cmd_queue, queue)
        if (cmd->read_len > 0)
            decoded_buf_len += ch347_is_single_cmd_type(cmd->type) ?
                cmd->read_len : DIV_ROUND_UP(cmd->tdo_bit_count, 8);
 
    // create the buffer for all decoded bytes
    uint8_t *decoded_buf = NULL;
    int decoded_buf_idx = 0;
    if (decoded_buf_len > 0) {
        decoded_buf = malloc(decoded_buf_len);
        if (!decoded_buf) {
            LOG_ERROR("malloc failed");
            return ERROR_FAIL;
        }
    }
 
    while (!list_empty(&ch347.cmd_queue)) {
        struct ch347_cmd *last_cmd = NULL;
        int total_len = 0;
        int total_tdo_count = 0;
        int bytes_to_write = 0;
 
        list_for_each_entry(cmd, &ch347.cmd_queue, queue) {
            total_len += CH347_CMD_HEADER + cmd->write_data_len;
            total_tdo_count += cmd->tdo_bit_count;
            // don't exceed max length or max TDO bit count
            if (total_len >= ch347.max_len || total_tdo_count >= HW_TDO_BUF_SIZE)
                break;
            // remember the last cmd to send and bytes to send
            last_cmd = cmd;
            bytes_to_write = total_len;
        }
 
        // sanity checks
        if (!last_cmd || bytes_to_write == 0) {
            LOG_ERROR("Nothing to send!");
            free(decoded_buf);
            return ERROR_FAIL;
        }
 
        // create the write buffer
        uint8_t *write_buf = malloc(bytes_to_write);
        if (!write_buf) {
            LOG_ERROR("malloc failed");
            free(decoded_buf);
            return ERROR_FAIL;
        }
 
        int idx = 0;
        int bytes_to_read = 0;
        int current_decoded_buf_len = 0;
        struct ch347_cmd *tmp;
 
        list_for_each_entry_safe(cmd, tmp, &ch347.cmd_queue, queue) {
            // copy command to buffer
            write_buf[idx++] = cmd->type;
            h_u16_to_le(&write_buf[idx], cmd->write_data_len);
            idx += 2;
            memcpy(&write_buf[idx], cmd->write_data, cmd->write_data_len);
            idx += cmd->write_data_len;
            // need to read something back?
            if (cmd->read_len > 0) {
                bytes_to_read += CH347_CMD_HEADER + cmd->read_len;
                current_decoded_buf_len += ch347_is_single_cmd_type(cmd->type) ?
                    cmd->read_len : DIV_ROUND_UP(cmd->tdo_bit_count, 8);
            }
 
            // cmd data no longer needed
            list_del(&cmd->queue);
            free(cmd->write_data);
            free(cmd);
 
            if (cmd == last_cmd)
                break;
        }
 
        // write data to device
        retval = ch347_write_data(write_buf, &idx);
        free(write_buf);
        if (retval != ERROR_OK) {
            free(decoded_buf);
            return retval;
        }
 
        if (!bytes_to_read)
            continue;
 
        // Need only to execute a read without decoding the data to make the CH347 happy?
        if (!current_decoded_buf_len) {
            // read but don't decode anything
            retval = ch347_read_scan(NULL, 0, bytes_to_read);
        } else {
            retval = ch347_read_scan(&decoded_buf[decoded_buf_idx], current_decoded_buf_len, bytes_to_read);
            decoded_buf_idx += current_decoded_buf_len;
        }
 
        if (retval != ERROR_OK) {
            free(decoded_buf);
            return retval;
        }
    }
 
    // something decoded from the data read back from CH347?
    if (decoded_buf) {
        // put the decoded data into the scan fields or single_read buffer
        retval = ch347_scan_data_to_fields(decoded_buf, decoded_buf_len);
        free(decoded_buf);
    }
 
    return retval;
}
 
static int ch347_cmd_start_next(uint8_t type)
{
    // different command type or non chainable command? (GPIO commands can't be concat)
    uint8_t prev_type = ch347.scratchpad_cmd_type;
    if (prev_type != type || ch347_is_single_cmd_type(type)) {
        // something written in the scratchpad? => store it as command
        if (prev_type != 0 && ch347.scratchpad_idx > 0) {
            int retval = ch347_cmd_from_scratchpad();
            if (retval != ERROR_OK)
                return retval;
 
            /* if the last queued command is not chainable we should send it immediately
                because e.g. the GPIO command can't be combined with any other command */
            if (ch347_is_single_cmd_type(prev_type)) {
                retval = ch347_cmd_transmit_queue();
                if (retval != ERROR_OK)
                    return retval;
            }
        }
 
        /* before we can send non chainable command ("single" like GPIO command) we should send all
            other commands because we can't send it together with other commands */
        if (ch347_is_single_cmd_type(type)) {
            int retval = ch347_cmd_transmit_queue();
            if (retval != ERROR_OK)
                return retval;
        }
 
        // store the next command type
        ch347.scratchpad_cmd_type = type;
    }
 
    return ERROR_OK;
}
 
static int ch347_scan_queue_fields(struct scan_field *scan_fields, int scan_fields_len)
{
    // malloc for the scan struct
    struct ch347_scan *scan = malloc(sizeof(struct ch347_scan));
    if (!scan) {
        LOG_ERROR("malloc failed");
        return ERROR_FAIL;
    }
 
    scan->fields = scan_fields;
    scan->fields_len = scan_fields_len;
    list_add_tail(&scan->queue, &ch347.scan_queue);
    return ERROR_OK;
}
 
static int ch347_single_read_get_byte(int read_buf_idx, uint8_t *byte)
{
    int retval = ch347_cmd_transmit_queue();
    if (retval != ERROR_OK)
        return retval;
 
    if (read_buf_idx > CH347_SINGLE_CMD_MAX_READ || read_buf_idx < 0) {
        LOG_ERROR("read_buf_idx out of range");
        return ERROR_FAIL;
    }
 
    *byte = ch347.single_read[read_buf_idx];
    return ERROR_OK;
}
 
static void ch347_scratchpad_check_full(void)
{
    // if full create a new command in the queue
    if (ch347.scratchpad_idx == UCMDPKT_DATA_MAX_BYTES_USBHS) {
        uint8_t type = ch347.scratchpad_cmd_type;
        ch347_cmd_from_scratchpad();
        ch347.scratchpad_cmd_type = type;
    }
}
 
static int ch347_scratchpad_add_byte(uint8_t byte)
{
    if (ch347.scratchpad_cmd_type == 0) {
        LOG_ERROR("call ch347_next_cmd first!");
        return ERROR_FAIL;
    }
 
    ch347.scratchpad[ch347.scratchpad_idx++] = byte;
    ch347_scratchpad_check_full();
    return ERROR_OK;
}
 
static int ch347_scratchpad_add_pin_byte(void)
{
    uint8_t pins = ch347.tms_pin | ch347.tdi_pin | ch347.tck_pin | ch347.trst_pin;
 
    if (ch347_dedicated_srst_enabled)
        pins |= ch347.srst_pin;
 
    return ch347_scratchpad_add_byte(pins);
}
 
static int ch347_scratchpad_add_bytes(uint8_t *bytes, int count)
{
    if (ch347.scratchpad_cmd_type == 0) {
        LOG_ERROR("call ch347_next_cmd first!");
        return ERROR_FAIL;
    }
 
    int remaining = count;
    int bytes_idx = 0;
    while (remaining > 0) {
        int bytes_to_store = ch347.scratchpad_idx + remaining <= UCMDPKT_DATA_MAX_BYTES_USBHS ?
            remaining : UCMDPKT_DATA_MAX_BYTES_USBHS - ch347.scratchpad_idx;
 
        if (bytes)
            memcpy(&ch347.scratchpad[ch347.scratchpad_idx], &bytes[bytes_idx], bytes_to_store);
        else
            memset(&ch347.scratchpad[ch347.scratchpad_idx], 0, bytes_to_store);
 
        ch347.scratchpad_idx += bytes_to_store;
        bytes_idx += bytes_to_store;
        remaining -= bytes_to_store;
        ch347_scratchpad_check_full();
    }
 
    return ERROR_OK;
}
 
/* Drive SRST low at init only when the target is connected under reset.
 * srst_nogate is required as well: without it, JTAG is gated while SRST
 * is asserted. */
static bool ch347_dedicated_srst_assert_at_init(void)
{
    enum reset_types cfg = jtag_get_reset_config();
 
    return (cfg & (RESET_CNCT_UNDER_SRST | RESET_SRST_NO_GATING))
        == (RESET_CNCT_UNDER_SRST | RESET_SRST_NO_GATING);
}
 
static int ch347_srst_enable(void)
{
    int retval = ch347_cmd_start_next(CH347_CMD_PIN_SET);
    if (retval != ERROR_OK)
        return retval;
 
    uint8_t cmd_data[] = {0x00, 0x81, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
    retval = ch347_scratchpad_add_bytes(cmd_data, ARRAY_SIZE(cmd_data));
    if (retval != ERROR_OK)
        return retval;
 
    uint8_t init_result;
    retval = ch347_single_read_get_byte(0, &init_result);
    if (retval != ERROR_OK)
        return retval;
 
    LOG_DEBUG("CH347F PIN_SET result %02" PRIx8, init_result);
 
    ch347.srst_pin = ch347_dedicated_srst_assert_at_init() ? SRST_L : SRST_H;
    /* The pin byte merges bit 6 only while this flag is set. */
    ch347_dedicated_srst_enabled = true;
    retval = ch347_cmd_start_next(CH347_CMD_JTAG_BIT_OP);
    if (retval == ERROR_OK)
        retval = ch347_scratchpad_add_pin_byte();
    if (retval == ERROR_OK)
        retval = ch347_cmd_transmit_queue();
    return retval;
}
 
static int ch347_scratchpad_add_clock_tms(bool tms)
{
    ch347.tms_pin = tms ? TMS_H : TMS_L;
    ch347.tck_pin = TCK_L;
    int retval = ch347_scratchpad_add_pin_byte();
    if (retval != ERROR_OK)
        return retval;
 
    ch347.tck_pin = TCK_H;
    return ch347_scratchpad_add_pin_byte();
}
 
static int ch347_scratchpad_add_stableclocks(int count)
{
    if (ch347.scratchpad_cmd_type == 0) {
        int retval = ch347_cmd_start_next(CH347_CMD_JTAG_BIT_OP);
        if (retval != ERROR_OK)
            return retval;
    }
 
    bool tms = ch347.tms_pin == TMS_H;
    for (int i = 0; i < count; i++) {
        int retval = ch347_scratchpad_add_clock_tms(tms);
        if (retval != ERROR_OK)
            return retval;
    }
 
    return ERROR_OK;
}
 
static int ch347_scratchpad_add_idle_clock(void)
{
    ch347.tck_pin = TCK_L;
    return ch347_scratchpad_add_pin_byte();
}
 
static int ch347_scratchpad_add_tms_change(const uint8_t *tms_value, int step, int skip)
{
    LOG_DEBUG_IO("TMS Value: %02x..., step = %d, skip = %d", tms_value[0], step, skip);
 
    int retval = ch347_cmd_start_next(CH347_CMD_JTAG_BIT_OP);
    if (retval != ERROR_OK)
        return retval;
 
    for (int i = skip; i < step; i++) {
        retval = ch347_scratchpad_add_clock_tms((tms_value[i / 8] >> (i % 8)) & BIT(0));
        if (retval != ERROR_OK)
            return retval;
    }
 
    return ch347_scratchpad_add_idle_clock();
}
 
static int ch347_scratchpad_add_move_path(struct pathmove_command *cmd)
{
    LOG_DEBUG_IO("num_states=%d, last_state=%d", cmd->num_states, cmd->path[cmd->num_states - 1]);
 
    int retval = ch347_cmd_start_next(CH347_CMD_JTAG_BIT_OP);
    if (retval != ERROR_OK)
        return retval;
 
    for (unsigned int i = 0; i < cmd->num_states; i++) {
        if (tap_state_transition(tap_get_state(), false) == cmd->path[i]) {
            retval = ch347_scratchpad_add_clock_tms(0);
            if (retval != ERROR_OK)
                return retval;
        } else if (tap_state_transition(tap_get_state(), true) == cmd->path[i]) {
            retval = ch347_scratchpad_add_clock_tms(1);
            if (retval != ERROR_OK)
                return retval;
        } else {
            LOG_ERROR("No transition possible!");
            return ERROR_JTAG_TRANSITION_INVALID;
        }
        tap_set_state(cmd->path[i]);
    }
 
    return ch347_scratchpad_add_idle_clock();
}
 
static int ch347_scratchpad_add_move_state(enum tap_state state, int skip)
{
    uint8_t tms_scan;
    int tms_len;
 
    LOG_DEBUG_IO("from %s to %s", tap_state_name(tap_get_state()), tap_state_name(state));
    // don't do anything if we are already in the right state; but do execute always the TAP_RESET
    if (tap_get_state() == state && state != TAP_RESET)
        return ERROR_OK;
 
    tms_scan = tap_get_tms_path(tap_get_state(), state);
    tms_len = tap_get_tms_path_len(tap_get_state(), state);
    int retval = ch347_scratchpad_add_tms_change(&tms_scan, tms_len, skip);
    tap_set_state(state);
    return retval;
}
 
static int ch347_scratchpad_add_write_read(struct scan_command *cmd, uint8_t *bits, int bits_len, enum scan_type scan)
{
    // the bits and bytes to transfer
    int byte_count = bits_len / 8;
    int bit_count = bits_len % 8;
 
    // only bytes are not possible because we need to set TMS high for the last bit
    if (byte_count > 0 && bit_count == 0) {
        // make one byte to eight bits
        byte_count--;
        bit_count = 8;
    }
 
    // in bitwise mode only bits are allowed
    if (ch347.use_bitwise_mode) {
        byte_count = 0;
        bit_count = bits_len;
    }
 
    bool is_read = (scan == SCAN_IN || scan == SCAN_IO);
 
    // if we need to send bytes
    if (byte_count > 0) {
        // start the next cmd and copy the data out bytes to it
        int retval = ch347_cmd_start_next(is_read ? CH347_CMD_JTAG_DATA_SHIFT_RD : CH347_CMD_JTAG_DATA_SHIFT);
        if (retval != ERROR_OK)
            return retval;
 
        if (bits)
            retval = ch347_scratchpad_add_bytes(bits, byte_count);
        else
            retval = ch347_scratchpad_add_bytes(NULL, byte_count);
 
        if (retval != ERROR_OK)
            return retval;
    }
 
    // bits are always need to send; no possibility to not send bits
    int retval = ch347_cmd_start_next(is_read ? CH347_CMD_JTAG_BIT_OP_RD : CH347_CMD_JTAG_BIT_OP);
    if (retval != ERROR_OK)
        return retval;
 
    ch347.tms_pin = TMS_L;
    ch347.tdi_pin = TDI_L;
 
    for (int i = 0; i < bit_count; i++) {
        if (bits)
            ch347.tdi_pin = ((bits[byte_count + i / 8] >> i % 8) & BIT(0)) ? TDI_H : TDI_L;
 
        // for the last bit set TMS high to exit the shift state
        if (i + 1 == bit_count)
            ch347.tms_pin = TMS_H;
 
        ch347.tck_pin = TCK_L;
        retval = ch347_scratchpad_add_pin_byte();
        if (retval != ERROR_OK)
            return retval;
 
        ch347.tck_pin = TCK_H;
        retval = ch347_scratchpad_add_pin_byte();
        if (retval != ERROR_OK)
            return retval;
 
        /* cut the package after each MAX_BITS_PER_BIT_OP bits because it
            needs a dividable by 8 bits package */
        if (i > 0 && (i + 1) % MAX_BITS_PER_BIT_OP == 0) {
            retval = ch347_cmd_from_scratchpad();
            if (retval != ERROR_OK)
                return retval;
 
            retval = ch347_cmd_start_next(is_read ? CH347_CMD_JTAG_BIT_OP_RD : CH347_CMD_JTAG_BIT_OP);
            if (retval != ERROR_OK)
                return retval;
        }
    }
 
    // one TCK_L after the last bit
    retval = ch347_scratchpad_add_idle_clock();
    if (retval != ERROR_OK)
        return retval;
 
    // if read is involved we need to queue the scan fields
    if (is_read)
        return ch347_scan_queue_fields(cmd->fields, cmd->num_fields);
 
    return ERROR_OK;
}
 
static int ch347_scratchpad_add_run_test(int cycles, enum tap_state state)
{
    LOG_DEBUG_IO("cycles=%d, end_state=%d", cycles, state);
    int retval;
    if (tap_get_state() != TAP_IDLE) {
        retval = ch347_scratchpad_add_move_state(TAP_IDLE, 0);
        if (retval != ERROR_OK)
            return retval;
    }
 
    retval = ch347_scratchpad_add_stableclocks(cycles);
    if (retval != ERROR_OK)
        return retval;
 
    return ch347_scratchpad_add_move_state(state, 0);
}
 
static int ch347_scratchpad_add_scan(struct scan_command *cmd)
{
    static const char *const type2str[] = {"", "SCAN_IN", "SCAN_OUT", "SCAN_IO"};
 
    enum scan_type type = jtag_scan_type(cmd);
    uint8_t *buf = NULL;
    int scan_bits = jtag_build_buffer(cmd, &buf);
 
    // add a move to IRSHIFT or DRSHIFT state
    int retval;
    if (cmd->ir_scan)
        retval = ch347_scratchpad_add_move_state(TAP_IRSHIFT, 0);
    else
        retval = ch347_scratchpad_add_move_state(TAP_DRSHIFT, 0);
 
    if (retval != ERROR_OK) {
        free(buf);
        return retval;
    }
 
    if (LOG_LEVEL_IS(LOG_LVL_DEBUG_IO)) {
        char *log_buf = buf_to_hex_str(buf, scan_bits);
        LOG_DEBUG_IO("scan=%s, type=%s, bits=%d, buf=[%s], end_state=%d",
             cmd->ir_scan ? "IRSCAN" : "DRSCAN",
             type2str[type],
             scan_bits, log_buf, cmd->end_state);
        free(log_buf);
    }
 
    retval = ch347_scratchpad_add_write_read(cmd, buf, scan_bits, type);
    free(buf);
    if (retval != ERROR_OK)
        return retval;
 
    // add a move to the final state
    return ch347_scratchpad_add_move_state(cmd->end_state, 1);
}
 
static uint8_t ch347_usable_gpios(void)
{
    return ch347.chip_variant == CH347F ? CH347F_USABLE_GPIOS : CH347T_USABLE_GPIOS;
}
 
static int ch347_gpio_cmd(unsigned int gpio, uint8_t value, uint8_t *state)
{
    if (gpio >= GPIO_CNT) {
        LOG_ERROR("GPIO %u out of range", gpio);
        return ERROR_FAIL;
    }
 
    int retval = ch347_cmd_start_next(CH347_CMD_GPIO);
    if (retval != ERROR_OK)
        return retval;
 
    uint8_t gpios[GPIO_CNT];
    memset(gpios, 0, GPIO_CNT);
    gpios[gpio] = value;
    retval = ch347_scratchpad_add_bytes(gpios, GPIO_CNT);
    if (retval != ERROR_OK)
        return retval;
 
    return ch347_single_read_get_byte(gpio, state);
}
 
static uint8_t ch347_gpio_drive_value(bool level, enum adapter_gpio_drive_mode drive)
{
    switch (drive) {
    case ADAPTER_GPIO_DRIVE_MODE_OPEN_DRAIN:
        return level ? GPIO_SET_INPUT : GPIO_SET_L;
    case ADAPTER_GPIO_DRIVE_MODE_OPEN_SOURCE:
        return level ? GPIO_SET_H : GPIO_SET_INPUT;
    case ADAPTER_GPIO_DRIVE_MODE_PUSH_PULL:
        break;
    }
 
    return level ? GPIO_SET_H : GPIO_SET_L;
}
 
static int ch347_gpio_set(int gpio, bool data)
{
    /* always set bits 7 and 6 for GPIO enable
        bits 5 and 4 for pin direction output
        bit 3 is the data bit */
    uint8_t state;
    int retval = ch347_gpio_cmd(gpio, data ? GPIO_SET_H : GPIO_SET_L, &state);
    if (retval != ERROR_OK)
        return retval;
 
    // check in the read if the bit is set/cleared correctly
    if ((bool)(state & BIT(6)) != data) {
        LOG_ERROR("Output not set.");
        return ERROR_FAIL;
    }
 
    return ERROR_OK;
}
 
static int ch347_activity_led_set(int led_state)
{
    if (ch347_activity_led_gpio_pin != 0xFF)
        return ch347_gpio_set(ch347_activity_led_gpio_pin, ch347_activity_led_active_high ? led_state : 1 - led_state);
 
    // not configured => also OK
    return ERROR_OK;
}
 
static void ch347_warn_dedicated_srst_drive(void)
{
    static bool warned;
    enum adapter_gpio_drive_mode drive =
        adapter_gpio_get_config()[ADAPTER_GPIO_IDX_SRST].drive;
 
    if (warned || !(jtag_get_reset_config() & RESET_HAS_SRST))
        return;
    if (drive == ADAPTER_GPIO_DRIVE_MODE_PUSH_PULL)
        return;
 
    warned = true;
    LOG_WARNING("CH347F dedicated SRST is push-pull and ignores "
        "the reset_config drive mode; use 'reset_config srst_push_pull'");
}
 
static int ch347_reset(int trst, int srst)
{
    int retval;
    LOG_DEBUG_IO("reset trst: %i srst %i", trst, srst);
 
    if (swd_mode) {
        if (trst)
            LOG_WARNING("Asserting TRST not supported in SWD mode!");
 
        if (ch347_srst_gpio_pin == 0xFF) {
            if (srst) {
                LOG_ERROR("Asserting SRST not supported: no usable GPIO configured");
                return ERROR_FAIL;
            }
            return ERROR_OK;
        }
 
        /* Honour the drive mode of 'reset_config'. It defaults to open drain,
            which releases the pin instead of driving the inactive level, so the
            target can keep the line low on its own.
            Don't verify the readback: it reports the pin level, and the target
            is free to hold the reset line low itself, e.g. while it is in a
            watchdog reset loop. */
        bool level = srst ? ch347_srst_active_high : !ch347_srst_active_high;
        uint8_t value = ch347_gpio_drive_value(level,
            adapter_gpio_get_config()[ADAPTER_GPIO_IDX_SRST].drive);
        uint8_t state;
        return ch347_gpio_cmd(ch347_srst_gpio_pin, value, &state);
    }
 
    if (srst && !ch347_dedicated_srst_enabled) {
        LOG_ERROR("Asserting SRST not supported");
        return ERROR_FAIL;
    }
 
    retval = ch347_cmd_start_next(CH347_CMD_JTAG_BIT_OP);
    if (retval != ERROR_OK)
        return retval;
 
    ch347.trst_pin = trst ? TRST_L : TRST_H;
    if (ch347_dedicated_srst_enabled) {
        ch347_warn_dedicated_srst_drive();
        ch347.srst_pin = srst ? SRST_L : SRST_H;
    }
    retval = ch347_scratchpad_add_pin_byte();
    if (retval != ERROR_OK)
        return retval;
 
    retval = ch347_scratchpad_add_idle_clock();
    if (retval != ERROR_OK)
        return retval;
 
    return ch347_cmd_transmit_queue();
}
 
static int ch347_sleep(int us)
{
    LOG_DEBUG_IO("us=%d", us);
    int retval = ch347_cmd_transmit_queue();
    jtag_sleep(us);
    return retval;
}
 
static int ch347_execute_queue(struct jtag_command *cmd_queue)
{
    struct jtag_command *cmd = cmd_queue;
 
    int retval = ch347_activity_led_set(LED_ON);
    if (retval != ERROR_OK)
        return retval;
 
    while (retval == ERROR_OK && cmd) {
        switch (cmd->type) {
        case JTAG_RUNTEST:
            retval = ch347_scratchpad_add_run_test(cmd->cmd.runtest->num_cycles, cmd->cmd.runtest->end_state);
            break;
        case JTAG_STABLECLOCKS:
            retval = ch347_scratchpad_add_stableclocks(cmd->cmd.stableclocks->num_cycles);
            break;
        case JTAG_TLR_RESET:
            retval = ch347_scratchpad_add_move_state(cmd->cmd.statemove->end_state, 0);
            break;
        case JTAG_PATHMOVE:
            retval = ch347_scratchpad_add_move_path(cmd->cmd.pathmove);
            break;
        case JTAG_TMS:
            retval = ch347_scratchpad_add_tms_change(cmd->cmd.tms->bits, cmd->cmd.tms->num_bits, 0);
            break;
        case JTAG_SLEEP:
            retval = ch347_sleep(cmd->cmd.sleep->us);
            break;
        case JTAG_SCAN:
            retval = ch347_scratchpad_add_scan(cmd->cmd.scan);
            break;
        default:
            LOG_ERROR("BUG: unknown JTAG command type 0x%X", cmd->type);
            retval = ERROR_FAIL;
            break;
        }
 
        cmd = cmd->next;
    }
 
    if (retval != ERROR_OK)
        return retval;
 
    retval = ch347_cmd_transmit_queue();
    if (retval != ERROR_OK)
        return retval;
 
    return ch347_activity_led_set(LED_OFF);
}
 
static int ch347_open_device(void)
{
    const uint16_t *ch347_vids = default_ch347_vids;
    const uint16_t *ch347_pids = default_ch347_pids;
 
    if (adapter_usb_get_vids()[0] != 0) {
        ch347_vids = adapter_usb_get_vids();
        ch347_pids = adapter_usb_get_pids();
    }
 
    int retval = jtag_libusb_open(ch347_vids, ch347_pids,
        adapter_usb_get_product_name(), &ch347_handle, NULL);
    if (retval != ERROR_OK) {
        char error_message[256];
        snprintf(error_message, sizeof(error_message), "CH347 not found. Tried VID/PID pairs: ");
        for (int i = 0; ch347_vids[i] != 0; i++)
            snprintf(error_message + strlen(error_message), sizeof(error_message) - strlen(error_message),
                "%04x:%04x ", ch347_vids[i], ch347_pids[i]);
 
        LOG_ERROR("%s", error_message);
        return retval;
    }
 
    struct libusb_device_descriptor ch347_device_descriptor;
    libusb_device *device = libusb_get_device(ch347_handle);
    if (!device) {
        LOG_ERROR("CH347 error calling libusb_get_device");
        jtag_libusb_close(ch347_handle);
        return ERROR_FAIL;
    }
 
    retval = libusb_get_device_descriptor(device, &ch347_device_descriptor);
    if (retval != ERROR_OK) {
        LOG_ERROR("CH347 error getting device descriptor: %s", libusb_error_name(retval));
        jtag_libusb_close(ch347_handle);
        return retval;
    }
 
    // Fix for CH347F on ARM64
    // Force set configuration 1 (required on some ARM64 platforms)
    retval = libusb_set_configuration(ch347_handle, 1);
    if (retval != LIBUSB_SUCCESS && retval != LIBUSB_ERROR_BUSY)
        LOG_WARNING("CH347 set_configuration failed: %s", libusb_error_name(retval));
 
    // CH347T / CH347F detection
    // if we can claim interface 4 we found a CH347F chip; if we can claim interface 2 we found CH347T chip
    retval = libusb_claim_interface(ch347_handle, CH347F_MPHSI_INTERFACE);
    if (retval != ERROR_OK) {
        retval = libusb_claim_interface(ch347_handle, CH347T_MPHSI_INTERFACE);
        if (retval != ERROR_OK) {
            LOG_ERROR("CH347 unable to claim interface: %s", libusb_error_name(retval));
            jtag_libusb_close(ch347_handle);
            return retval;
        }
        ch347.chip_variant = CH347T;
    }   else {
        ch347.chip_variant = CH347F;
    }
 
    char firmware_version;
    retval = jtag_libusb_control_transfer(ch347_handle,
        LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE,
        VENDOR_VERSION, 0, 0, &firmware_version, sizeof(firmware_version),
        USB_WRITE_TIMEOUT, NULL);
    if (retval != ERROR_OK) {
        LOG_ERROR("CH347 unable to get firmware version");
        jtag_libusb_close(ch347_handle);
        return retval;
    }
 
    char manufacturer[256 + 1];
    if (libusb_get_string_descriptor_ascii(ch347_handle, ch347_device_descriptor.iManufacturer,
        (unsigned char *)manufacturer, sizeof(manufacturer) - 1) < 0) {
        strcpy(manufacturer, "(unknown)");
    }
    char product[256 + 1];
    if (libusb_get_string_descriptor_ascii(ch347_handle, ch347_device_descriptor.iProduct,
        (unsigned char *)product, sizeof(product) - 1) < 0) {
        strcpy(product, "(unknown)");
    }
    char serial_number[256 + 1];
    if (libusb_get_string_descriptor_ascii(ch347_handle, ch347_device_descriptor.iSerialNumber,
        (unsigned char *)serial_number, sizeof(serial_number) - 1) < 0) {
        strcpy(serial_number, "(unknown)");
    }
 
    LOG_INFO("CH347%c %s from vendor %s with serial number %s found. (Chip version=%X.%02X, Firmware=0x%02X)",
        ch347.chip_variant == CH347T ? 'T' : ch347.chip_variant == CH347F ? 'F' : '?',
        product,
        manufacturer,
        serial_number,
        (ch347_device_descriptor.bcdDevice >> 8) & 0xFF,
        ch347_device_descriptor.bcdDevice & 0xFF,
        firmware_version);
 
    if (ch347.chip_variant == CH347T && ch347_device_descriptor.bcdDevice < BYTEWISE_MODE_VERSION) {
        LOG_INFO("CH347T old version of the chip, JTAG only working in bitwise mode. For bytewise mode at least version %X.%X is needed.",
            (BYTEWISE_MODE_VERSION >> 8) & 0xFF,
            BYTEWISE_MODE_VERSION & 0xFF);
        ch347.use_bitwise_mode = true;
    } else {
        ch347.use_bitwise_mode = false;
    }
 
    if (ch347.chip_variant == CH347T) {
        if (swd_mode) {
            ch347.swclk_5mhz_supported = ch347_device_descriptor.bcdDevice >= 0x544;
 
            if (ch347_device_descriptor.bcdDevice < 0x441)
                LOG_WARNING("CH347T version older than 4.41 probably does not support SWD transport");
 
            if (ch347_device_descriptor.bcdDevice == 0x441)
                LOG_WARNING("If CH347T version 4.41 cannot connect or SWD fails often, insert a resistor to SWDIO circuit");
 
        } else if (ch347_device_descriptor.bcdDevice == 0x241) {
            LOG_WARNING("CH347T version 2.41 has very weird clock timing, may not work with a slower JTAG device");
        }
 
        if (ch347_device_descriptor.bcdDevice < 0x544)
            LOG_INFO("Please upgrade CH347T firmware to a production version >= 5.44");
 
    } else if (ch347.chip_variant == CH347F) {
        ch347.swclk_5mhz_supported = ch347_device_descriptor.bcdDevice >= 0x101;
 
        if (ch347_device_descriptor.bcdDevice < 0x101)
            LOG_INFO("Please upgrade CH347F firmware to a production version >= 1.1");
    }
 
    return ERROR_OK;
}
 
static int ch347_quit(void)
{
    // on close set the LED on, because the state without JTAG is on
    ch347_activity_led_set(LED_ON);
    int retval = ch347_cmd_transmit_queue();
    jtag_libusb_close(ch347_handle);
    LOG_DEBUG_IO("CH347 close");
    return retval;
}
 
static int ch347_adapter_init(uint8_t clock_index, bool *supports_larger_pack_mode)
{
    int retval = ch347_cmd_start_next(CH347_CMD_JTAG_INIT);
    if (retval != ERROR_OK)
        return retval;
 
    retval = ch347_scratchpad_add_byte(0);
    if (retval != ERROR_OK)
        return retval;
 
    retval = ch347_scratchpad_add_byte(clock_index);
    if (retval != ERROR_OK)
        return retval;
 
    for (int i = 0; i < 4; i++) {
        retval = ch347_scratchpad_add_pin_byte();
        if (retval != ERROR_OK)
            return retval;
    }
 
    uint8_t mode;
    retval = ch347_single_read_get_byte(0, &mode);
    if (retval != ERROR_OK)
        return retval;
 
    *supports_larger_pack_mode = mode != 0;
    return ERROR_OK;
}
 
static int ch347_adapter_supports_larger_pack_mode(bool *supports_larger_pack_mode)
{
    return ch347_adapter_init(CH347_CMD_INIT_GET_MODE_CLOCK_INDEX_VALUE, supports_larger_pack_mode);
}
 
static int ch347_adapter_set_speed(uint8_t clock_index)
{
    bool unused;
    return ch347_adapter_init(clock_index, &unused);
}
 
static int ch347_swd_init_cmd(uint8_t clock_divisor)
{
    int retval = ch347_cmd_start_next(CH347_CMD_SWD_INIT);
    if (retval != ERROR_OK)
        return retval;
 
    uint8_t cmd_data[] = {0x40, 0x42, 0x0f, 0x00, clock_divisor, 0x00, 0x00, 0x00 };
    retval = ch347_scratchpad_add_bytes(cmd_data, ARRAY_SIZE(cmd_data));
    if (retval != ERROR_OK)
        return retval;
 
    /* TODO: CH347_CMD_SWD_INIT reads one data byte.
            But how can we decide if SWD init was successfully executed?
            Return an error code if init was failed */
    uint8_t init_result = 0;
    retval = ch347_single_read_get_byte(0, &init_result);
    LOG_DEBUG("SWD init clk div %" PRIu8 ", result %02" PRIx8,
              clock_divisor, init_result);
    ch347_swd_context.clk_divisor = clock_divisor;
    return retval;
}
 
static int ch347_speed_set(int speed_index)
{
    if (swd_mode)
        return ch347_swd_init_cmd(speed_index);
 
    int retval = ch347_adapter_set_speed(speed_index);
    if (retval != ERROR_OK) {
        LOG_ERROR("Couldn't set CH347 speed");
        return retval;
    }
 
    return ERROR_OK;
}
 
static int ch347_init_pack_size(void)
{
    // already set?
    if (ch347.pack_size != UNSET)
        return ERROR_OK;
 
    // set the lower limit for starting
    ch347.max_len = MIN(USBC_PACKET_USBHS, LARGER_PACK_MAX_SIZE);
    bool supports_larger_pack_mode;
    int retval = ch347_adapter_supports_larger_pack_mode(&supports_larger_pack_mode);
    if (retval != ERROR_OK)
        return retval;
 
    ch347.pack_size = supports_larger_pack_mode ? LARGER_PACK : STANDARD_PACK;
    ch347.max_len = ch347.pack_size == STANDARD_PACK || ch347.use_bitwise_mode ?
        USBC_PACKET_USBHS : LARGER_PACK_MAX_SIZE;
    return ERROR_OK;
}
 
static int ch347_speed_get(int speed_idx, int *khz)
{
    if (swd_mode) {
        if (speed_idx)
            *khz = DIV_ROUND_UP(CH347_SWD_CLOCK_BASE, speed_idx);
        else
            *khz = CH347_SWD_CLOCK_MAX;
        return ERROR_OK;
    }
 
    int retval = ch347_init_pack_size();
    if (retval != ERROR_OK)
        return retval;
    const int *speeds = ch347.pack_size == STANDARD_PACK ?
        ch347_standard_pack_clock_speeds : ch347_larger_pack_clock_speeds;
    *khz = speeds[speed_idx];
    return ERROR_OK;
}
 
static int ch347_speed_get_index(int khz, int *speed_idx)
{
    if (khz == 0) {
        LOG_ERROR("Adaptive clocking not supported");
        return ERROR_FAIL;
    }
 
    if (swd_mode) {
        if (khz >= CH347_SWD_CLOCK_MAX && ch347.swclk_5mhz_supported) {
            *speed_idx = 0;
        } else {
            // Don't allow too low clk speeds: packet processing is limited to ~8 msec
            // or triggers host USB disconnect
            *speed_idx = MIN(DIV_ROUND_UP(CH347_SWD_CLOCK_BASE, khz),
                             (int)CH347_SWD_CLOCK_MAX_DIVISOR);
        }
        return ERROR_OK;
    }
 
    // when checking with speed index 9 we can see if the device supports STANDARD_PACK or LARGER_PACK mode
    int retval = ch347_init_pack_size();
    if (retval != ERROR_OK)
        return retval;
    // depending on pack size there are different fixed clock speeds possible
    const int *speeds = ch347.pack_size == STANDARD_PACK ?
        ch347_standard_pack_clock_speeds : ch347_larger_pack_clock_speeds;
    int length = ch347.pack_size == STANDARD_PACK ?
        ARRAY_SIZE(ch347_standard_pack_clock_speeds) : ARRAY_SIZE(ch347_larger_pack_clock_speeds);
    // find the suitable speed index
    int idx = length - 1;
    while (idx > 0 && speeds[idx] > khz)
        idx--;
 
    if (speeds[idx] > khz) {
        LOG_WARNING("Requested speed of %d kHz is not possible. Using %d kHz",
            khz, speeds[idx]);
    }
    *speed_idx = idx;
    return ERROR_OK;
}
 
static const struct command_registration ch347_command_handlers[] = {
    {
        .name = "ch347",
        .mode = COMMAND_ANY,
        .help = "perform ch347 management",
        .usage = "",
    },
    COMMAND_REGISTRATION_DONE
};
 
static void ch347_configure_activity_led(const struct adapter_gpio_config *led_config)
{
    uint8_t gpio = led_config->gpio_num;
    if (gpio >= GPIO_CNT || (BIT(gpio) & ch347_usable_gpios()) == 0)
        return;
 
    ch347_activity_led_gpio_pin = gpio;
    ch347_activity_led_active_high = !led_config->active_low;
}
 
static void ch347_configure_srst_gpio(const struct adapter_gpio_config *srst_config)
{
    ch347_srst_active_high = !srst_config->active_low;
 
    unsigned int gpio;
    if (srst_config->gpio_num == ADAPTER_GPIO_NOT_SET) {
        // the TRST pin is free in SWD mode, so use it by default
        gpio = ch347.chip_variant == CH347F ? CH347F_TRST_GPIO : CH347T_TRST_GPIO;
    } else {
        gpio = srst_config->gpio_num;
        if (gpio >= GPIO_CNT || (BIT(gpio) & ch347_usable_gpios()) == 0) {
            LOG_ERROR("GPIO %u can't be used for SRST, disabling SRST", gpio);
            ch347_srst_gpio_pin = 0xFF;
            return;
        }
    }
 
    /* Driving the same pin from two functions would let the LED activity
        toggle the reset line, so refuse to share it. */
    if (gpio == ch347_activity_led_gpio_pin) {
        LOG_ERROR("GPIO %u is already used as the activity LED, disabling SRST", gpio);
        ch347_srst_gpio_pin = 0xFF;
        return;
    }
 
    ch347_srst_gpio_pin = gpio;
}
 
static int ch347_init(void)
{
    int retval = ch347_open_device();
 
    if (retval != ERROR_OK) {
        LOG_ERROR("CH347 open error");
        return retval;
    }
 
    LOG_DEBUG_IO("CH347 open success");
 
    // CH347 JTAG init
    ch347.tck_pin = TCK_L;
    ch347.tms_pin = TMS_H;
    ch347.tdi_pin = TDI_L;
    ch347.trst_pin = TRST_H;
    ch347.srst_pin = SRST_H;
    ch347_dedicated_srst_enabled = false;
    INIT_LIST_HEAD(&ch347.cmd_queue);
    INIT_LIST_HEAD(&ch347.scan_queue);
 
    /* Static initial pack_size is STANDARD_PACK (0), which would look already
     * probed. max_len stays 0 until the probe, and PIN_SET uses this queue. */
    ch347.pack_size = UNSET;
 
    ch347_configure_activity_led(&adapter_gpio_get_config()[ADAPTER_GPIO_IDX_LED]);
 
    if (!swd_mode) {
        /* Pin 8 drives strong low after adapter power-up. On CH347F, enable the
         * dedicated SRST output and release it, even when reset_config
         * does not include SRST. Leave it asserted only for connect_assert_srst
         * together with srst_nogate. */
        if (ch347.chip_variant == CH347F) {
            retval = ch347_init_pack_size();
            if (retval != ERROR_OK)
                return retval;
 
            retval = ch347_srst_enable();
            if (retval != ERROR_OK) {
                LOG_ERROR("CH347F dedicated SRST enable failed");
                return retval;
            }
            ch347_warn_dedicated_srst_drive();
        }
        tap_set_state(TAP_RESET);
    } else {
        ch347_configure_srst_gpio(&adapter_gpio_get_config()[ADAPTER_GPIO_IDX_SRST]);
 
        retval = ch347_init_pack_size();
        if (retval != ERROR_OK)
            return retval;
 
        retval = ch347_swd_init_cmd(1);
    }
    return retval;
}
 
static int ch347_swd_init(void)
{
    LOG_INFO("CH347 SWD mode enabled");
    swd_mode = true;
    memset(&ch347_swd_context, 0, sizeof(ch347_swd_context));
 
    INIT_LIST_HEAD(&ch347_swd_context.send_cmd_head);
    INIT_LIST_HEAD(&ch347_swd_context.free_cmd_head);
 
    ch347_swd_context.queued_retval = ERROR_OK;
    // 0XE8 + 2byte len + N byte cmds
    ch347_swd_context.send_len = CH347_CMD_HEADER;
    // 0XE8 + 2byte len + N byte ack + data
    ch347_swd_context.need_recv_len = CH347_CMD_HEADER;
    struct ch347_swd_io *pswd_io = ch347_swd_context.ch347_cmd_buf;
    for (int i = 0; i < CH347_MAX_CMD_BUF; i++, pswd_io++) {
        INIT_LIST_HEAD(&pswd_io->list_entry);
        list_add_tail(&pswd_io->list_entry, &ch347_swd_context.free_cmd_head);
    }
    return ERROR_OK;
}
 
static struct ch347_swd_io *ch347_get_one_swd_io(void)
{
    struct ch347_swd_io *pswd_io;
    if (list_empty(&ch347_swd_context.free_cmd_head))
        return NULL;
 
    pswd_io = list_first_entry(&ch347_swd_context.free_cmd_head,
                   struct ch347_swd_io, list_entry);
    list_del_init(&pswd_io->list_entry);
    pswd_io->cmd = 0;
    pswd_io->usb_cmd = CH347_CMD_SWD_SEQ_W;
    pswd_io->dst = NULL;
    return pswd_io;
}
 
static int ch347_swd_queue_flush(void)
{
    int length = ch347_swd_context.send_len;
    ch347_swd_context.send_buf[0] = CH347_CMD_SWD;
    h_u16_to_le(&ch347_swd_context.send_buf[1], length - CH347_CMD_HEADER);
    int retval = ch347_write_data(ch347_swd_context.send_buf, &length);
    if (retval != ERROR_OK) {
        ch347_swd_context.queued_retval = retval;
        LOG_DEBUG("CH347WriteData error");
        return retval;
    }
 
    ch347_swd_context.recv_len = 0;
    length = ch347_swd_context.need_recv_len;
    retval = ch347_read_data(&ch347_swd_context.recv_buf[ch347_swd_context.recv_len], &length);
    if (retval != ERROR_OK) {
        ch347_swd_context.queued_retval = retval;
        LOG_DEBUG("CH347ReadData error");
        return retval;
    }
 
    ch347_swd_context.recv_len += length;
    if (ch347_swd_context.need_recv_len > ch347_swd_context.recv_len) {
        LOG_ERROR("write/read failed %d %d",
              ch347_swd_context.recv_len,
              ch347_swd_context.need_recv_len);
        retval = ERROR_FAIL;
    }
 
    return retval;
}
 
static void ch347_write_swd_reg(uint8_t cmd, const uint32_t out)
{
    ch347_swd_context.send_buf[ch347_swd_context.send_len++] = CH347_CMD_SWD_REG_W;
    // 8bit + 32bit +1bit
    ch347_swd_context.send_buf[ch347_swd_context.send_len++] = 0x29;
    ch347_swd_context.send_buf[ch347_swd_context.send_len++] = 0x00;
    ch347_swd_context.send_buf[ch347_swd_context.send_len++] = cmd;
    h_u32_to_le(&ch347_swd_context.send_buf[ch347_swd_context.send_len], out);
    ch347_swd_context.send_len += 4;
    ch347_swd_context.send_buf[ch347_swd_context.send_len++] = parity_u32(out);
    // 0xA0 +  1 byte(3bit ACK)
    ch347_swd_context.need_recv_len += (1 + 1);
    ch347_swd_context.total_swd_clk += 46;
}
 
static void ch347_write_spec_seq(const uint8_t *out, uint8_t out_len)
{
    ch347_swd_context.send_buf[ch347_swd_context.send_len++] =
        CH347_CMD_SWD_SEQ_W;
    ch347_swd_context.send_buf[ch347_swd_context.send_len++] = out_len;
    ch347_swd_context.send_buf[ch347_swd_context.send_len++] = 0x00;
    for (uint8_t i = 0; i < DIV_ROUND_UP(out_len, 8); i++)
        ch347_swd_context.send_buf[ch347_swd_context.send_len++] = out ? out[i] : 0x00;
    ch347_swd_context.need_recv_len += 1; // 0xA1
    ch347_swd_context.total_swd_clk += out_len;
}
 
static void ch347_read_swd_reg(uint8_t cmd)
{
    ch347_swd_context.send_buf[ch347_swd_context.send_len++] = CH347_CMD_SWD_REG_R;
    ch347_swd_context.send_buf[ch347_swd_context.send_len++] = 0x22;
    ch347_swd_context.send_buf[ch347_swd_context.send_len++] = 0x00;
    ch347_swd_context.send_buf[ch347_swd_context.send_len++] = cmd;
    // 0xA2 + 1 byte(3bit ACK) + 4 byte(data) + 1 byte(1bit parity+1bit trn)
    ch347_swd_context.need_recv_len += 1 + 1 + 4 + 1;
    ch347_swd_context.total_swd_clk += 46;
}
 
static int ch347_swd_switch_out(enum swd_special_seq seq, const uint8_t *out, unsigned int out_len)
{
    if ((ch347_swd_context.send_len + (1 + 2 + DIV_ROUND_UP(out_len, 8))) > CH347_MAX_SEND_BUF)
        return ERROR_FAIL;
    if ((ch347_swd_context.need_recv_len + 2) > CH347_MAX_RECV_BUF)
        return ERROR_FAIL;
 
    struct ch347_swd_io *pswd_io = ch347_get_one_swd_io();
    if (pswd_io) {
        ch347_write_spec_seq(out, out_len);
        list_add_tail(&pswd_io->list_entry, &ch347_swd_context.send_cmd_head);
        return ERROR_OK;
    } else {
        return ERROR_FAIL;
    }
}
 
// check read/write REG can fill in remaining buff
static bool ch347_chk_buf_size(uint8_t cmd, uint32_t ap_delay_clk)
{
    bool flush = false;
    int send_len = ch347_swd_context.send_len;
    int recv_len = ch347_swd_context.need_recv_len;
    int len;
    do {
        if (cmd & SWD_CMD_RNW) {
            len = 1 + 1 + 1 + 1; // 0xA2 + len + rev + cmd
            if (send_len + len > CH347_MAX_SEND_BUF)
                break;
            send_len += len;
            len = 1 + 1 + 4 + 1;
            /* 0xA2 + 1byte(3bit ack) +  4byte(data) +
               1byte(1bit parity+1bit trn) */
            if (recv_len + len > CH347_MAX_RECV_BUF)
                break;
            recv_len += len;
        } else {                         // write reg
            len = 1 + 1 + 1 + 1 + 4 + 1;
            // 0xA0 + len + rev  + cmd +data + parity
            if (send_len + len > CH347_MAX_SEND_BUF)
                break;
            send_len += len;
            len = 1 + 1; // 0xA0 + 1byte(3bit ack)
            if (recv_len + len > CH347_MAX_RECV_BUF)
                break;
            recv_len += len;
        }
        if (cmd & SWD_CMD_APNDP) {
            len = 1 + 1 + 1 + DIV_ROUND_UP(ap_delay_clk, 8);
            // 0xA1 + Len  + rev  + n byte(delay)
            if (send_len + len > CH347_MAX_SEND_BUF)
                break;
            len = 1; // 0xA1
            if ((recv_len + len) > CH347_MAX_RECV_BUF)
                break;
        }
        // swd packet requests
        flush = true;
    } while (false);
 
    return flush;
}
 
static int ch347_swd_run_queue_inner(void);
 
static int ch347_swd_send_idle(uint32_t ap_delay_clk)
{
    bool run_q = false;
    struct ch347_swd_io *pswd_io = NULL;
    unsigned int max_processing_clk = ch347_swd_context.clk_divisor
        ? CH347_MAX_PROCESSING_US / ch347_swd_context.clk_divisor
        : CH347_MAX_PROCESSING_US * 5;
    bool more_q_runs =
        1 + 1 + 1 + DIV_ROUND_UP(ap_delay_clk, 8) > CH347_MAX_SEND_BUF
        && ap_delay_clk > max_processing_clk;
 
    if (ch347_swd_context.sent_cmd_count) {
        unsigned int expected_total_clk = ch347_swd_context.total_swd_clk + ap_delay_clk;
        unsigned int expected_send_len = ch347_swd_context.send_len
                            + 1 + 1 + 1 + DIV_ROUND_UP(ap_delay_clk, 8);
                    // 0xA1 + Len  + rev  + n byte(delay)
        unsigned int expected_recv_len = ch347_swd_context.need_recv_len + 1;
                    // 0xA1
        unsigned int expected_time = ch347_swd_context.clk_divisor
                ? expected_total_clk * ch347_swd_context.clk_divisor
                : expected_total_clk / 5;
        if (expected_time > CH347_MAX_PROCESSING_US
                || expected_send_len > CH347_MAX_SEND_BUF
                || expected_recv_len > CH347_MAX_RECV_BUF) {
            int send_room = CH347_MAX_SEND_BUF - ch347_swd_context.send_len - 1 - 1 - 1;
            if (more_q_runs
                    && send_room > 0
                    && expected_recv_len <= CH347_MAX_RECV_BUF
                    && ch347_swd_context.total_swd_clk < max_processing_clk) {
                pswd_io = ch347_get_one_swd_io();
                if (pswd_io) {
                    // fill the rest of queue/time by part of delay
                    unsigned int this_delay_clk = MIN(ap_delay_clk, 255);
                    if ((unsigned int)send_room * 8 < this_delay_clk)
                        this_delay_clk = send_room * 8;
                    if (max_processing_clk - ch347_swd_context.total_swd_clk < this_delay_clk)
                        this_delay_clk = max_processing_clk - ch347_swd_context.total_swd_clk;
                    LOG_DEBUG_IO("partial delay %u clk", this_delay_clk);
                    ch347_write_spec_seq(NULL, this_delay_clk);
                    list_add_tail(&pswd_io->list_entry, &ch347_swd_context.send_cmd_head);
                    ap_delay_clk -= this_delay_clk;
                }
            }
            run_q = true;
        }
    }
 
    do {
        if (!run_q)
            pswd_io = ch347_get_one_swd_io();
 
        if (!pswd_io) {
            int retval = ch347_swd_run_queue_inner();
            if (retval != ERROR_OK)
                return retval;
 
            pswd_io = ch347_get_one_swd_io();
            if (!pswd_io) {
                LOG_ERROR("ch347 SWD queue not empty after ch347_swd_run_queue");
                ch347_swd_context.queued_retval = ERROR_FAIL;
                return ERROR_FAIL;
            }
        }
 
        unsigned int send_room = CH347_MAX_SEND_BUF - 1 - 1 - 1;
        unsigned int this_delay_clk = MIN(ap_delay_clk, 255);
        if (send_room * 8 < this_delay_clk)
            this_delay_clk = send_room * 8;
        if (max_processing_clk < this_delay_clk)
            this_delay_clk = max_processing_clk;
        LOG_DEBUG_IO("delay %u clk", this_delay_clk);
        ch347_write_spec_seq(NULL, this_delay_clk);
        list_add_tail(&pswd_io->list_entry, &ch347_swd_context.send_cmd_head);
        ap_delay_clk -= this_delay_clk;
        run_q = true;
        pswd_io = NULL;
    } while (ap_delay_clk);
    return ERROR_OK;
}
 
static int ch347_swd_run_queue_inner(void)
{
    LOG_DEBUG_IO("Executing %u queued transactions", ch347_swd_context.sent_cmd_count);
    if (ch347_swd_context.queued_retval != ERROR_OK) {
        LOG_DEBUG_IO("Skipping due to previous errors: %d", ch347_swd_context.queued_retval);
        goto skip;
    }
 
    int retval = ch347_swd_queue_flush();
    if (retval != ERROR_OK)
        return retval;
 
    if (ch347_swd_context.queued_retval != ERROR_OK) {
        LOG_ERROR("CH347 usb write/read failed - queued_retval");
        goto skip;
    }
    uint8_t *recv_buf = ch347_swd_context.recv_buf;
    int recv_len = 0;
    if (recv_buf[recv_len++] != CH347_CMD_SWD) { // 0XE8
        ch347_swd_context.queued_retval = ERROR_FAIL;
        LOG_ERROR("CH347 usb write/read failed - not CH347_CMD_SWD");
        goto skip;
    }
 
    int cmds_len = le_to_h_u16(&recv_buf[recv_len]);
    recv_len += 2; // cmds_len
    if ((cmds_len + CH347_CMD_HEADER) > ch347_swd_context.recv_len) {
        ch347_swd_context.queued_retval = ERROR_FAIL;
        LOG_ERROR("CH347 usb write/read failed - too long");
        goto skip;
    }
 
    struct list_head *tmp;
    struct list_head *pos;
    struct ch347_swd_io *pswd_io;
 
    list_for_each_safe(pos, tmp, &ch347_swd_context.send_cmd_head) {
        pswd_io = list_entry(pos, struct ch347_swd_io, list_entry);
        if (pswd_io->usb_cmd == CH347_CMD_SWD_SEQ_W) {
            if (recv_buf[recv_len++] != CH347_CMD_SWD_SEQ_W) {
                ch347_swd_context.queued_retval = ERROR_FAIL;
                LOG_ERROR("CH347 usb write/read failed - not CH347_CMD_SWD_SEQ_W");
                goto skip;
            }
        } else { // read/write Reg
            uint32_t ack;
            bool check_ack;
            // read  Reg
            if (recv_buf[recv_len] == CH347_CMD_SWD_REG_R) {
                recv_len++;
                ack = buf_get_u32(&recv_buf[recv_len++], 0, 3);
                /* Devices do not reply to DP_TARGETSEL write
                   cmd, ignore received ack */
                check_ack = swd_cmd_returns_ack(pswd_io->cmd);
                if (pswd_io->cmd & SWD_CMD_RNW) {
                    uint32_t data = buf_get_u32(&recv_buf[recv_len], 0, 32);
 
                    LOG_CUSTOM_LEVEL((check_ack && ack != SWD_ACK_OK)
                                        ? LOG_LVL_DEBUG : LOG_LVL_DEBUG_IO,
                                    "%s%s %s read reg %X = %08" PRIx32,
                                    check_ack ? "" : "ack ignored ",
                                    ack == SWD_ACK_OK ? "OK" :
                                        ack == SWD_ACK_WAIT ? "WAIT" :
                                        ack == SWD_ACK_FAULT  ? "FAULT" : "JUNK",
                                    pswd_io->cmd & SWD_CMD_APNDP ? "AP" : "DP",
                                    (pswd_io->cmd & SWD_CMD_A32) >> 1,
                                    data);
 
                    if (ack != SWD_ACK_OK && check_ack) {
                        ch347_swd_context.queued_retval = swd_ack_to_error_code(ack);
                        goto skip;
                    }
 
                    uint32_t parity = buf_get_u32(&recv_buf[recv_len], 32, 1);
                    if (parity != (uint32_t)parity_u32(data)) {
                        LOG_ERROR("SWD Read data parity mismatch");
                        ch347_swd_context.queued_retval = ERROR_FAIL;
                        goto skip;
                    }
 
                    if (pswd_io->dst)
                        *pswd_io->dst = data;
                } else {
                    ch347_swd_context.queued_retval = ERROR_FAIL;
                    LOG_ERROR("CH347 usb write/read failed - not SWD_CMD_RNW");
                    goto skip;
                }
                recv_len += 5;
            } else if (recv_buf[recv_len] == CH347_CMD_SWD_REG_W) {
                recv_len++;
                ack = buf_get_u32(&recv_buf[recv_len++], 0, 3);
                /* Devices do not reply to DP_TARGETSEL write
                   cmd, ignore received ack */
                check_ack = swd_cmd_returns_ack(pswd_io->cmd);
 
                LOG_CUSTOM_LEVEL((check_ack && ack != SWD_ACK_OK)
                                    ? LOG_LVL_DEBUG : LOG_LVL_DEBUG_IO,
                                 "%s%s %s write reg %X = %08" PRIx32,
                                 check_ack ? "" : "ack ignored ",
                                 ack == SWD_ACK_OK ? "OK" :
                                    ack == SWD_ACK_WAIT ? "WAIT" :
                                    ack == SWD_ACK_FAULT  ? "FAULT" : "JUNK",
                                 pswd_io->cmd & SWD_CMD_APNDP ? "AP" : "DP",
                                 (pswd_io->cmd & SWD_CMD_A32) >> 1,
                                 pswd_io->value);
 
                if (ack != SWD_ACK_OK && check_ack) {
                    ch347_swd_context.queued_retval = swd_ack_to_error_code(ack);
                    goto skip;
                }
            } else {
                ch347_swd_context.queued_retval = ERROR_FAIL;
                LOG_ERROR("CH347 usb write/read failed recv_len = %d", recv_len);
                goto skip;
            }
        }
        list_del_init(&pswd_io->list_entry);
        list_add_tail(&pswd_io->list_entry,
                  &ch347_swd_context.free_cmd_head);
    }
 
skip:
    if (!list_empty(&ch347_swd_context.send_cmd_head)) {
        list_for_each_safe(pos, tmp, &ch347_swd_context.send_cmd_head) {
            pswd_io = list_entry(pos, struct ch347_swd_io, list_entry);
            list_del_init(&pswd_io->list_entry);
            list_add_tail(&pswd_io->list_entry,
                      &ch347_swd_context.free_cmd_head);
        }
    }
 
    // 0xE8 + 2byte len
    ch347_swd_context.send_len = CH347_CMD_HEADER;
    // 0xE8 + 2byte len
    ch347_swd_context.need_recv_len = CH347_CMD_HEADER;
    ch347_swd_context.recv_len = 0;
    ch347_swd_context.sent_cmd_count = 0;
    ch347_swd_context.total_swd_clk = 0;
    retval = ch347_swd_context.queued_retval;
    ch347_swd_context.queued_retval = ERROR_OK;
    return retval;
}
 
static int ch347_swd_run_queue(void)
{
    /* A transaction must be followed by another transaction or at least 8
       idle cycles to ensure that data is clocked through the AP. */
    int retval = ch347_swd_send_idle(8);
    if (retval != ERROR_OK)
        return retval;
 
    return ch347_swd_run_queue_inner();
}
 
static int ch347_swd_queue_cmd(uint8_t cmd, uint32_t *dst, uint32_t data, uint32_t ap_delay_clk)
{
    int retval = ERROR_OK;
    bool run_q = false;
    if (ch347_swd_context.sent_cmd_count) {
        unsigned int expected_total_clk = ch347_swd_context.total_swd_clk
                            + 46 // SWD transaction
                            + ap_delay_clk
                            + 8; // 8 idle cycles at the end of queue
        unsigned int expected_time = ch347_swd_context.clk_divisor
                ? expected_total_clk * ch347_swd_context.clk_divisor
                : expected_total_clk / 5;
        if (expected_time > CH347_MAX_PROCESSING_US) {
            LOG_DEBUG_IO("Expected queue run %u cycles, with this cmd %u",
                         ch347_swd_context.total_swd_clk, expected_total_clk);
            run_q = true;
        } else if (!ch347_chk_buf_size(cmd, ap_delay_clk)) {
            run_q = true;
        }
    }
 
    struct ch347_swd_io *pswd_io = NULL;
    if (!run_q)
        pswd_io = ch347_get_one_swd_io();
 
    if (!pswd_io) {
        retval = ch347_swd_run_queue_inner();
        if (retval != ERROR_OK)
            return retval;
 
        pswd_io = ch347_get_one_swd_io();
        if (!pswd_io) {
            LOG_ERROR("ch347 SWD queue not empty after ch347_swd_run_queue");
            ch347_swd_context.queued_retval = ERROR_FAIL;
            return ERROR_FAIL;
        }
    }
 
    pswd_io->cmd = cmd | SWD_CMD_START | SWD_CMD_PARK;
 
    if (pswd_io->cmd & SWD_CMD_RNW) {
        pswd_io->usb_cmd = CH347_CMD_SWD_REG_R;
        pswd_io->dst = dst;
        ch347_read_swd_reg(pswd_io->cmd);
    } else {
        pswd_io->usb_cmd = CH347_CMD_SWD_REG_W;
        pswd_io->value = data;
        ch347_write_swd_reg(pswd_io->cmd, data);
    }
 
    ch347_swd_context.sent_cmd_count++;
    list_add_tail(&pswd_io->list_entry, &ch347_swd_context.send_cmd_head);
 
    // Insert idle cycles after AP accesses to avoid WAIT
    if (ap_delay_clk)
        retval = ch347_swd_send_idle(ap_delay_clk);
 
    return retval;
}
 
static int ch347_swd_switch_seq(enum swd_special_seq seq)
{
    switch (seq) {
    case LINE_RESET:
        LOG_DEBUG("SWD line reset");
        return ch347_swd_switch_out(seq, swd_seq_line_reset, swd_seq_line_reset_len);
    case JTAG_TO_SWD:
        LOG_DEBUG("JTAG-to-SWD");
        return ch347_swd_switch_out(seq, swd_seq_jtag_to_swd, swd_seq_jtag_to_swd_len);
    case JTAG_TO_DORMANT:
        LOG_DEBUG("JTAG-to-DORMANT");
        return ch347_swd_switch_out(seq, swd_seq_jtag_to_dormant, swd_seq_jtag_to_dormant_len);
    case SWD_TO_JTAG:
        LOG_DEBUG("SWD-to-JTAG");
        return ch347_swd_switch_out(seq, swd_seq_swd_to_jtag, swd_seq_swd_to_jtag_len);
    case SWD_TO_DORMANT:
        LOG_DEBUG("SWD-to-DORMANT");
        return ch347_swd_switch_out(seq, swd_seq_swd_to_dormant, swd_seq_swd_to_dormant_len);
    case DORMANT_TO_SWD:
        LOG_DEBUG("DORMANT-to-SWD");
        return ch347_swd_switch_out(seq, swd_seq_dormant_to_swd, swd_seq_dormant_to_swd_len);
    case DORMANT_TO_JTAG:
        LOG_DEBUG("DORMANT-to-JTAG");
        return ch347_swd_switch_out(seq, swd_seq_dormant_to_jtag, swd_seq_dormant_to_jtag_len);
    default:
        LOG_ERROR("Sequence %d not supported", seq);
        return ERROR_FAIL;
    }
}
 
static int ch347_swd_read_reg(uint8_t cmd, uint32_t *value, uint32_t ap_delay_clk)
{
    assert(cmd & SWD_CMD_RNW);
    return ch347_swd_queue_cmd(cmd, value, 0, ap_delay_clk);
}
 
static int ch347_swd_write_reg(uint8_t cmd, uint32_t value, uint32_t ap_delay_clk)
{
    assert(!(cmd & SWD_CMD_RNW));
    return ch347_swd_queue_cmd(cmd, NULL, value, ap_delay_clk);
}
 
static const struct swd_driver ch347_swd = {
    .init = ch347_swd_init,
    .switch_seq = ch347_swd_switch_seq,
    .read_reg = ch347_swd_read_reg,
    .write_reg = ch347_swd_write_reg,
    .run = ch347_swd_run_queue,
};
 
static struct jtag_interface ch347_interface = {
    .supported = DEBUG_CAP_TMS_SEQ,
    .execute_queue = ch347_execute_queue,
};
 
struct adapter_driver ch347_adapter_driver = {
    .name = "ch347",
    .transport_ids = TRANSPORT_JTAG | TRANSPORT_SWD,
    .transport_preferred_id = TRANSPORT_JTAG,
    .commands = ch347_command_handlers,
 
    .init = ch347_init,
    .quit = ch347_quit,
    .reset = ch347_reset,
    .speed = ch347_speed_set,
    .khz = ch347_speed_get_index,
    .speed_div = ch347_speed_get,
 
    .jtag_ops = &ch347_interface,
    .swd_ops = &ch347_swd,
};