Felix Singer has submitted this change. ( https://review.coreboot.org/c/flashrom/+/67878 )
Change subject: dirtyjtag: Add DirtyJTAG programmer ......................................................................
dirtyjtag: Add DirtyJTAG programmer
Add a new programmer driver for the DirtyJTAG project (a USB-JTAG firmware for STM32 MCUs).
Successfully tested with DirtyJTAG 1.4 running on an Olimex STM32-H103 development board and a SST25VF020B SPI flash chip.
Change-Id: Ic43e9a014ed7d04e429e73b30c9dcfdde1a78913 Signed-off-by: Jean THOMAS virgule@jeanthomas.me Reviewed-on: https://review.coreboot.org/c/flashrom/+/67878 Reviewed-by: Felix Singer felixsinger@posteo.net Reviewed-by: Angel Pons th3fanbus@gmail.com Tested-by: build bot (Jenkins) no-reply@coreboot.org Reviewed-by: Nico Huber nico.h@gmx.de --- M Makefile A dirtyjtag_spi.c M flashrom.8.tmpl M include/programmer.h M meson.build M meson_options.txt M programmer_table.c M test_build.sh 8 files changed, 384 insertions(+), 5 deletions(-)
Approvals: build bot (Jenkins): Verified Nico Huber: Looks good to me, but someone else must approve Felix Singer: Looks good to me, approved Angel Pons: Looks good to me, approved
diff --git a/Makefile b/Makefile index f92cefd..a8df91f 100644 --- a/Makefile +++ b/Makefile @@ -161,6 +161,7 @@ CONFIG_PICKIT2_SPI \ CONFIG_RAIDEN_DEBUG_SPI \ CONFIG_STLINKV3_SPI \ + CONFIG_DIRTYJTAG_SPI \
DEPENDS_ON_LIBFTDI1 := \ CONFIG_FT2232_SPI \ @@ -521,6 +522,9 @@ # Digilent Development board JTAG CONFIG_DIGILENT_SPI ?= yes
+# DirtyJTAG +CONFIG_DIRTYJTAG_SPI ?= yes + # Disable J-Link for now. CONFIG_JLINK_SPI ?= no
@@ -771,6 +775,11 @@ PROGRAMMER_OBJS += digilent_spi.o endif
+ifeq ($(CONFIG_DIRTYJTAG_SPI), yes) +FEATURE_CFLAGS += -D'CONFIG_DIRTYJTAG_SPI=1' +PROGRAMMER_OBJS += dirtyjtag_spi.o +endif + ifeq ($(CONFIG_JLINK_SPI), yes) FEATURE_FLAGS += -D'CONFIG_JLINK_SPI=1' PROGRAMMER_OBJS += jlink_spi.o diff --git a/dirtyjtag_spi.c b/dirtyjtag_spi.c new file mode 100644 index 0000000..42169ed --- /dev/null +++ b/dirtyjtag_spi.c @@ -0,0 +1,320 @@ +/* + * This file is part of the flashrom project. + * + * Copyright (C) 2021-2022 Jean THOMAS virgule@jeanthomas.me + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + */ + +/* + * Driver for the DirtyJTAG project. + * See https://github.com/jeanthom/dirtyjtag for more info. + * + * SPI-JTAG Pin Mapping + * |=========|==========| + * | SPI pin | JTAG pin | + * |=========|==========| + * | #CS | TMS | + * | #WP | SRST | + * | #HOLD | TRST | + * | MISO | TDO | + * | MOSI | TDI | + * | CLK | TCK | + * |=========|==========| + */ + +#include <assert.h> +#include <stdlib.h> +#include <string.h> +#include <errno.h> +#include <libusb.h> +#include "programmer.h" + +struct dirtyjtag_spi_data { + struct libusb_context *libusb_ctx; + struct libusb_device_handle *libusb_handle; +}; + +static const struct dev_entry devs_dirtyjtag_spi[] = { + { 0x1209, 0xc0ca, OK, "DirtyJTAG", "JTAG probe" }, + { 0 }, +}; + +static const char dirtyjtag_write_endpoint = 0x01; +static const char dirtyjtag_read_endpoint = 0x82; +static const int dirtyjtag_timeout = 100 * 10; /* 100 ms */ + +enum dirtyjtag_command_identifier { + CMD_STOP = 0x00, + CMD_INFO = 0x01, + CMD_FREQ = 0x02, + CMD_XFER = 0x03, + CMD_SETSIG = 0x04, + CMD_GETSIG = 0x05, + CMD_CLK = 0x06 +}; + +enum dirtyjtag_signal_identifier { + SIG_TCK = 1 << 1, + SIG_TDI = 1 << 2, + SIG_TDO = 1 << 3, + SIG_TMS = 1 << 4, + SIG_TRST = 1 << 5, + SIG_SRST = 1 << 6 +}; + +static int dirtyjtag_send(struct dirtyjtag_spi_data *djtag_data, uint8_t *data, size_t len) +{ + int transferred; + int ret = libusb_bulk_transfer(djtag_data->libusb_handle, + dirtyjtag_write_endpoint, + data, + len, + &transferred, + dirtyjtag_timeout); + if (ret != 0) { + msg_perr("%s: failed to send query command\n", __func__); + return -1; + } + if (transferred != (int)len) { + msg_perr("%s: failed to send whole packet\n", __func__); + return -1; + } + + return 0; +} + +static int dirtyjtag_receive(struct dirtyjtag_spi_data *djtag_data, uint8_t *data, size_t buffer_len, int expected) +{ + int transferred; + int ret = libusb_bulk_transfer(djtag_data->libusb_handle, + dirtyjtag_read_endpoint, + data, + buffer_len, + &transferred, + dirtyjtag_timeout); + if (ret != 0) { + msg_perr("%s: Failed to read SPI commands\n", __func__); + return -1; + } + + if (expected != -1 && transferred != expected) { + msg_perr("%s: failed to meet expected\n", __func__); + return -1; + } + + return transferred; +} + +static int dirtyjtag_spi_shutdown(void *data) +{ + struct dirtyjtag_spi_data *djtag_data = (struct dirtyjtag_spi_data*)data; + libusb_release_interface(djtag_data->libusb_handle, 0); + libusb_attach_kernel_driver(djtag_data->libusb_handle, 0); + libusb_close(djtag_data->libusb_handle); + libusb_exit(djtag_data->libusb_ctx); + free(data); + return 0; +} + +static int dirtyjtag_djtag1_spi_send_command(struct dirtyjtag_spi_data *context, + unsigned int writecnt, unsigned int readcnt, + const unsigned char *writearr, unsigned char *readarr) +{ + const size_t max_xfer_size = 30; // max transfer size in DJTAG1 + size_t len = writecnt + readcnt; + size_t num_xfer = (len + max_xfer_size - 1 ) / max_xfer_size; // ceil(len/max_xfer_size) + + uint8_t *rxtx_buffer = malloc(max_xfer_size * num_xfer); + if (!rxtx_buffer) { + msg_perr("%s: Failed rxtx_buffer allocation\n", __func__); + return -1; + } + + memcpy(rxtx_buffer, writearr, writecnt); + for (size_t i = 0; i < num_xfer; i++) { + const size_t xfer_offset = i * max_xfer_size; + size_t txn_size = max_xfer_size; + if (i == num_xfer-1 && len % max_xfer_size != 0) + txn_size = len % max_xfer_size; + + uint8_t transfer_buffer[32] = { + CMD_XFER, + txn_size * 8 + }; + memcpy(transfer_buffer + 2, rxtx_buffer + xfer_offset, txn_size); + + if (dirtyjtag_send(context, transfer_buffer, sizeof(transfer_buffer))) + goto cleanup_fail; + + if (dirtyjtag_receive(context, transfer_buffer, sizeof(transfer_buffer), 32) < 0) + goto cleanup_fail; + + memcpy(rxtx_buffer + xfer_offset, transfer_buffer, txn_size); + } + memcpy(readarr, rxtx_buffer + writecnt, readcnt); + + free(rxtx_buffer); + + uint8_t tms_reset_buffer[] = { + CMD_SETSIG, + SIG_TMS, + SIG_TMS, + + CMD_STOP, + }; + dirtyjtag_send(context, tms_reset_buffer, sizeof(tms_reset_buffer)); + + return 0; + +cleanup_fail: + free(rxtx_buffer); + return -1; +} + +static int dirtyjtag_spi_spi_send_command(const struct flashctx *flash, + unsigned int writecnt, unsigned int readcnt, + const unsigned char *writearr, unsigned char *readarr) +{ + struct dirtyjtag_spi_data *djtag_data = flash->mst->spi.data; + return dirtyjtag_djtag1_spi_send_command(djtag_data, writecnt, readcnt, writearr, readarr); +} + +static const struct spi_master spi_master_dirtyjtag_spi = { + .features = SPI_MASTER_4BA, + .max_data_read = MAX_DATA_READ_UNLIMITED, + .max_data_write = MAX_DATA_WRITE_UNLIMITED, + .command = dirtyjtag_spi_spi_send_command, + .multicommand = default_spi_send_multicommand, + .read = default_spi_read, + .write_256 = default_spi_write_256, + .write_aai = default_spi_write_aai, + .shutdown = dirtyjtag_spi_shutdown, + .probe_opcode = default_spi_probe_opcode, +}; + +static int dirtyjtag_spi_init(const struct programmer_cfg *cfg) +{ + struct libusb_device_handle *handle = NULL; + struct dirtyjtag_spi_data *djtag_data = NULL; + + djtag_data = calloc(1, sizeof(struct dirtyjtag_spi_data)); + if (djtag_data == NULL) { + msg_perr("%s: failed to allocate internal driver data structure\n", __func__); + return -1; + } + + int ret = libusb_init(&djtag_data->libusb_ctx); + if (ret < 0) { + msg_perr("%s: couldn't initialize libusb!\n", __func__); + goto cleanup_djtag_struct; + } + +#if LIBUSB_API_VERSION < 0x01000106 + libusb_set_debug(djtag_data->libusb_ctx, 3); +#else + libusb_set_option(djtag_data->libusb_ctx, LIBUSB_OPTION_LOG_LEVEL, LIBUSB_LOG_LEVEL_INFO); +#endif + + uint16_t vid = devs_dirtyjtag_spi[0].vendor_id; + uint16_t pid = devs_dirtyjtag_spi[0].device_id; + handle = libusb_open_device_with_vid_pid(djtag_data->libusb_ctx, vid, pid); + if (handle == NULL) { + msg_perr("%s: couldn't open device %04x:%04x.\n", __func__, vid, pid); + goto cleanup_libusb_ctx; + } + + ret = libusb_detach_kernel_driver(handle, 0); + if (ret != 0 && ret != LIBUSB_ERROR_NOT_FOUND) { + msg_pwarn("Cannot detach the existing USB driver. Claiming the interface may fail. %s\n", + libusb_error_name(ret)); + } + + ret = libusb_claim_interface(handle, 0); + if (ret != 0) { + msg_perr("%s: failed to claim interface 0: '%s'\n", __func__, libusb_error_name(ret)); + goto cleanup_libusb_handle; + } + + djtag_data->libusb_handle = handle; + + unsigned long int freq = 100; + char *tmp = extract_programmer_param_str(cfg, "spispeed"); + if (tmp) { + char *units = tmp; + + errno = 0; + freq = strtoul(tmp, &units, 0); + if (errno) { + msg_perr("Invalid frequency "%s", %s\n", tmp, strerror(errno)); + free(tmp); + goto cleanup_libusb_handle; + } + + if (!strcasecmp(units, "hz")) { + freq /= 1000; + } else if (!strcasecmp(units, "khz")) { + /* Do nothing, already in the right unit */ + } else if (!strcasecmp(units, "mhz")) { + freq *= 1000; + } else { + msg_perr("Invalid unit: %s, use hz, khz or mhz\n", units); + free(tmp); + goto cleanup_libusb_handle; + } + + if (freq > UINT16_MAX) { + msg_perr("%s: Frequency set above DJTAG1 limits (%d kHz)", __func__, UINT16_MAX); + free(tmp); + goto cleanup_libusb_handle; + } + + msg_pinfo("%s: programmer speed set to %lu kHz\n", __func__, freq); + } + free(tmp); + + uint8_t commands[] = { + CMD_SETSIG, /* Set TDI/TCK to low, SRST/TRST/TMS to high */ + SIG_TDI | SIG_TMS | SIG_TCK | SIG_SRST | SIG_TRST, + SIG_SRST | SIG_TRST | SIG_TMS, + + CMD_FREQ, /* Set frequency */ + (freq >> 8) & 0xff, + freq & 0xff, + + CMD_STOP, + }; + ret = dirtyjtag_send(djtag_data, commands, sizeof(commands)); + if (ret != 0) { + msg_perr("%s: failed to configure DirtyJTAG into initialized state\n", __func__); + goto cleanup_libusb_handle; + } + + return register_spi_master(&spi_master_dirtyjtag_spi, (void*)djtag_data); + +cleanup_libusb_handle: + libusb_attach_kernel_driver(handle, 0); + libusb_close(handle); + +cleanup_libusb_ctx: + libusb_exit(djtag_data->libusb_ctx); + +cleanup_djtag_struct: + free(djtag_data); + return -1; +} + +const struct programmer_entry programmer_dirtyjtag_spi = { + .name = "dirtyjtag_spi", + .type = USB, + .devs.dev = devs_dirtyjtag_spi, + .init = dirtyjtag_spi_init, +}; diff --git a/flashrom.8.tmpl b/flashrom.8.tmpl index 5579011..e672869 100644 --- a/flashrom.8.tmpl +++ b/flashrom.8.tmpl @@ -431,6 +431,8 @@ .sp .BR "* mediatek_i2c_spi" " (for SPI flash ROMs attached to some Mediatek display devices accessible over I2C)" .sp +.BR "* dirtyjtag_spi" " (for SPI flash ROMs attached to DirtyJTAG-compatible devices)" +.sp Some programmers have optional or mandatory parameters which are described in detail in the .B PROGRAMMER-SPECIFIC INFORMATION @@ -1441,6 +1443,22 @@ .BR 62.5k ", " 125k ", " 250k ", " 500k ", " 1M ", " 2M " or " 4M (in Hz). The default is a frequency of 4 MHz. .sp +.BR "dirtyjtag_spi " programmer +.IP +An optional +.B freq +parameter specifies the frequency of the SPI bus. +Syntax is +.sp +.B " flashrom -p dirtyjtag_spi:spispeed=frequency" +.sp +where +.B spispeed +can be +.BR any value in hertz, kilohertz or megahertz supported by the +programmer. The default is a frequency of 100 KHz. +.sp +.SS .SS .BR "jlink_spi " programmer .IP @@ -1671,7 +1689,7 @@ have to be run as superuser/root, and need additional raw access permission. .sp .BR serprog ", " buspirate_spi ", " dediprog ", " usbblaster_spi ", " ft2232_spi ", " pickit2_spi ", " \ -ch341a_spi " and " digilent_spi +ch341a_spi ", " digilent_spi " and " dirtyjtag_spi can be run as normal user on most operating systems if appropriate device permissions are set. .sp diff --git a/include/programmer.h b/include/programmer.h index bfce5d6..9603443 100644 --- a/include/programmer.h +++ b/include/programmer.h @@ -95,6 +95,7 @@ extern const struct programmer_entry programmer_serprog; extern const struct programmer_entry programmer_stlinkv3_spi; extern const struct programmer_entry programmer_usbblaster_spi; +extern const struct programmer_entry programmer_dirtyjtag_spi;
int programmer_init(const struct programmer_entry *prog, const char *param); int programmer_shutdown(void); diff --git a/meson.build b/meson.build index 050631d..3a6cc41 100644 --- a/meson.build +++ b/meson.build @@ -202,6 +202,12 @@ 'srcs' : files('digilent_spi.c'), 'flags' : [ '-DCONFIG_DIGILENT_SPI=1' ], }, + 'dirtyjtag_spi' : { + 'deps' : [ libusb1 ], + 'groups' : [ group_usb, group_external ], + 'srcs' : files('dirtyjtag_spi.c'), + 'flags' : [ '-DCONFIG_DIRTYJTAG_SPI=1' ], + }, 'drkaiser' : { 'systems' : systems_hwaccess, 'deps' : [ libpci ], diff --git a/meson_options.txt b/meson_options.txt index be56ac7..8c04029 100644 --- a/meson_options.txt +++ b/meson_options.txt @@ -10,8 +10,8 @@ 'group_internal', 'group_external', 'group_ftdi', 'group_i2c', 'group_jlink', 'group_pci', 'group_serial', 'group_usb', 'atahpt', 'atapromise', 'atavia', 'buspirate_spi', 'ch341a_spi', 'dediprog', 'developerbox_spi', - 'digilent_spi', 'drkaiser', 'dummy', 'ft2232_spi', 'gfxnvidia', 'internal', 'it8212', 'jlink_spi', - 'linux_mtd', 'linux_spi', 'mediatek_i2c_spi', 'mstarddc_spi', 'nic3com', 'nicintel', + 'digilent_spi', 'dirtyjtag_spi', 'drkaiser', 'dummy', 'ft2232_spi', 'gfxnvidia', 'internal', 'it8212', + 'jlink_spi', 'linux_mtd', 'linux_spi', 'mediatek_i2c_spi', 'mstarddc_spi', 'nic3com', 'nicintel', 'nicintel_eeprom', 'nicintel_spi', 'nicnatsemi', 'nicrealtek', 'ogp_spi', 'parade_lspcon', 'pickit2_spi', 'pony_spi', 'raiden_debug_spi', 'rayer_spi', 'realtek_mst_i2c_spi', 'satamv', 'satasii', 'serprog', 'stlinkv3_spi', 'usbblaster_spi', diff --git a/programmer_table.c b/programmer_table.c index 818cea7..d58a155 100644 --- a/programmer_table.c +++ b/programmer_table.c @@ -167,6 +167,10 @@ #if CONFIG_STLINKV3_SPI == 1 &programmer_stlinkv3_spi, #endif + +#if CONFIG_DIRTYJTAG_SPI == 1 + &programmer_dirtyjtag_spi, +#endif };
const size_t programmer_table_size = ARRAY_SIZE(programmer_table); diff --git a/test_build.sh b/test_build.sh index 717df00..69d3a34 100755 --- a/test_build.sh +++ b/test_build.sh @@ -10,11 +10,11 @@ PICKIT2_SPI STLINKV3_SPI PARADE_LSPCON MEDIATEK_I2C_SPI REALTEK_MST_I2C_SPI DUMMY \ DRKAISER NICREALTEK NICNATSEMI NICINTEL NICINTEL_SPI NICINTEL_EEPROM OGP_SPI \ BUSPIRATE_SPI DEDIPROG DEVELOPERBOX_SPI SATAMV LINUX_MTD LINUX_SPI IT8212 \ - CH341A_SPI DIGILENT_SPI JLINK_SPI" + CH341A_SPI DIGILENT_SPI DIRTYJTAG_SPI JLINK_SPI"
meson_programmer_opts="all auto group_ftdi group_i2c group_jlink group_pci group_serial group_usb \ atahpt atapromise atavia buspirate_spi ch341a_spi dediprog developerbox_spi \ - digilent_spi drkaiser dummy ft2232_spi gfxnvidia internal it8212 \ + digilent_spi dirtyjtag_spi drkaiser dummy ft2232_spi gfxnvidia internal it8212 \ jlink_spi linux_mtd linux_spi parade_lspcon mediatek_i2c_spi mstarddc_spi \ nic3com nicintel nicintel_eeprom nicintel_spi nicnatsemi nicrealtek \ ogp_spi pickit2_spi pony_spi raiden_debug_spi rayer_spi realtek_mst_i2c_spi \
-
Felix Singer (Code Review)