1 /***************************************************************************
2 * Copyright (C) 2007 by Juergen Stuber <juergen@jstuber.net> *
3 * based on Dominic Rath's and Benedikt Sauter's usbprog.c *
5 * Copyright (C) 2008 by Spencer Oliver *
6 * spen@spen-soft.co.uk *
8 * Copyright (C) 2011 by Jean-Christophe PLAGNIOL-VIILARD *
9 * plagnioj@jcrosoft.com *
11 * Copyright (C) 2015 by Marc Schink *
12 * openocd-dev@marcschink.de *
14 * Copyright (C) 2015 by Paul Fertser *
15 * fercerpav@gmail.com *
17 * This program is free software; you can redistribute it and/or modify *
18 * it under the terms of the GNU General Public License as published by *
19 * the Free Software Foundation; either version 2 of the License, or *
20 * (at your option) any later version. *
22 * This program is distributed in the hope that it will be useful, *
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
25 * GNU General Public License for more details. *
27 * You should have received a copy of the GNU General Public License *
28 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
29 ***************************************************************************/
38 #include <jtag/interface.h>
40 #include <jtag/commands.h>
41 #include <jtag/drivers/jtag_usb_common.h>
42 #include <src/helper/replacements.h>
43 #include <target/cortex_m.h>
45 #include <libjaylink/libjaylink.h>
47 static struct jaylink_context *jayctx;
48 static struct jaylink_device_handle *devh;
49 static struct jaylink_connection conn;
50 static struct jaylink_connection connlist[JAYLINK_MAX_CONNECTIONS];
51 static enum jaylink_jtag_version jtag_command_version;
52 static uint8_t caps[JAYLINK_DEV_EXT_CAPS_SIZE];
54 static uint32_t serial_number;
55 static bool use_serial_number;
56 static bool use_usb_location;
57 static enum jaylink_usb_address usb_address;
58 static bool use_usb_address;
59 static enum jaylink_target_interface iface = JAYLINK_TIF_JTAG;
60 static bool trace_enabled;
62 #define JLINK_MAX_SPEED 12000
63 #define JLINK_TAP_BUFFER_SIZE 2048
65 static unsigned int swd_buffer_size = JLINK_TAP_BUFFER_SIZE;
67 /* Maximum SWO frequency deviation. */
68 #define SWO_MAX_FREQ_DEV 0.03
70 /* 256 byte non-volatile memory */
71 struct device_config {
73 /* 0ffset 0x01 to 0x03 */
74 uint8_t reserved_1[3];
75 uint32_t target_power;
76 /* 0ffset 0x08 to 0x1f */
77 uint8_t reserved_2[24];
78 /* IP only for J-Link Pro */
79 uint8_t ip_address[4];
80 uint8_t subnet_mask[4];
81 /* 0ffset 0x28 to 0x2f */
82 uint8_t reserved_3[8];
83 uint8_t mac_address[6];
84 /* 0ffset 0x36 to 0xff */
85 uint8_t reserved_4[202];
86 } __attribute__ ((packed));
88 static struct device_config config;
89 static struct device_config tmp_config;
91 /* Queue command functions */
92 static void jlink_end_state(tap_state_t state);
93 static void jlink_state_move(void);
94 static void jlink_path_move(int num_states, tap_state_t *path);
95 static void jlink_stableclocks(int num_cycles);
96 static void jlink_runtest(int num_cycles);
97 static void jlink_reset(int trst, int srst);
98 static int jlink_reset_safe(int trst, int srst);
99 static int jlink_swd_run_queue(void);
100 static void jlink_swd_queue_cmd(uint8_t cmd, uint32_t *dst, uint32_t data, uint32_t ap_delay_clk);
101 static int jlink_swd_switch_seq(enum swd_special_seq seq);
103 /* J-Link tap buffer functions */
104 static void jlink_tap_init(void);
105 static int jlink_flush(void);
107 * Queue data to go out and in, flushing the queue as many times as
110 * @param out A pointer to TDI data, if NULL, old stale data will be used.
111 * @param out_offset A bit offset for TDI data.
112 * @param tms_out A pointer to TMS data, if NULL, zeroes will be emitted.
113 * @param tms_offset A bit offset for TMS data.
114 * @param in A pointer to store TDO data to, if NULL the data will be discarded.
115 * @param in_offset A bit offset for TDO data.
116 * @param length Amount of bits to transfer out and in.
118 * @retval This function doesn't return any value.
120 static void jlink_clock_data(const uint8_t *out, unsigned out_offset,
121 const uint8_t *tms_out, unsigned tms_offset,
122 uint8_t *in, unsigned in_offset,
125 static enum tap_state jlink_last_state = TAP_RESET;
126 static int queued_retval;
128 /***************************************************************************/
129 /* External interface implementation */
131 static void jlink_execute_stableclocks(struct jtag_command *cmd)
133 LOG_DEBUG_IO("stableclocks %i cycles", cmd->cmd.runtest->num_cycles);
134 jlink_stableclocks(cmd->cmd.runtest->num_cycles);
137 static void jlink_execute_runtest(struct jtag_command *cmd)
139 LOG_DEBUG_IO("runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles,
140 cmd->cmd.runtest->end_state);
142 jlink_end_state(cmd->cmd.runtest->end_state);
143 jlink_runtest(cmd->cmd.runtest->num_cycles);
146 static void jlink_execute_statemove(struct jtag_command *cmd)
148 LOG_DEBUG_IO("statemove end in %i", cmd->cmd.statemove->end_state);
150 jlink_end_state(cmd->cmd.statemove->end_state);
154 static void jlink_execute_pathmove(struct jtag_command *cmd)
156 LOG_DEBUG_IO("pathmove: %i states, end in %i",
157 cmd->cmd.pathmove->num_states,
158 cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
160 jlink_path_move(cmd->cmd.pathmove->num_states, cmd->cmd.pathmove->path);
163 static void jlink_execute_scan(struct jtag_command *cmd)
165 LOG_DEBUG_IO("%s type:%d", cmd->cmd.scan->ir_scan ? "IRSCAN" : "DRSCAN",
166 jtag_scan_type(cmd->cmd.scan));
168 /* Make sure there are no trailing fields with num_bits == 0, or the logic below will fail. */
169 while (cmd->cmd.scan->num_fields > 0
170 && cmd->cmd.scan->fields[cmd->cmd.scan->num_fields - 1].num_bits == 0) {
171 cmd->cmd.scan->num_fields--;
172 LOG_DEBUG("discarding trailing empty field");
175 if (cmd->cmd.scan->num_fields == 0) {
176 LOG_DEBUG("empty scan, doing nothing");
180 if (cmd->cmd.scan->ir_scan) {
181 if (tap_get_state() != TAP_IRSHIFT) {
182 jlink_end_state(TAP_IRSHIFT);
186 if (tap_get_state() != TAP_DRSHIFT) {
187 jlink_end_state(TAP_DRSHIFT);
192 jlink_end_state(cmd->cmd.scan->end_state);
194 struct scan_field *field = cmd->cmd.scan->fields;
195 unsigned scan_size = 0;
197 for (int i = 0; i < cmd->cmd.scan->num_fields; i++, field++) {
198 scan_size += field->num_bits;
199 LOG_DEBUG_IO("%s%s field %d/%d %d bits",
200 field->in_value ? "in" : "",
201 field->out_value ? "out" : "",
203 cmd->cmd.scan->num_fields,
206 if (i == cmd->cmd.scan->num_fields - 1 && tap_get_state() != tap_get_end_state()) {
207 /* Last field, and we're leaving IRSHIFT/DRSHIFT. Clock last bit during tap
208 * movement. This last field can't have length zero, it was checked above. */
209 jlink_clock_data(field->out_value,
215 field->num_bits - 1);
216 uint8_t last_bit = 0;
217 if (field->out_value)
218 bit_copy(&last_bit, 0, field->out_value, field->num_bits - 1, 1);
219 uint8_t tms_bits = 0x01;
220 jlink_clock_data(&last_bit,
227 tap_set_state(tap_state_transition(tap_get_state(), 1));
228 jlink_clock_data(NULL,
235 tap_set_state(tap_state_transition(tap_get_state(), 0));
237 jlink_clock_data(field->out_value,
246 if (tap_get_state() != tap_get_end_state()) {
247 jlink_end_state(tap_get_end_state());
251 LOG_DEBUG_IO("%s scan, %i bits, end in %s",
252 (cmd->cmd.scan->ir_scan) ? "IR" : "DR", scan_size,
253 tap_state_name(tap_get_end_state()));
256 static void jlink_execute_sleep(struct jtag_command *cmd)
258 LOG_DEBUG_IO("sleep %" PRIu32 "", cmd->cmd.sleep->us);
260 jtag_sleep(cmd->cmd.sleep->us);
263 static int jlink_execute_command(struct jtag_command *cmd)
266 case JTAG_STABLECLOCKS:
267 jlink_execute_stableclocks(cmd);
270 jlink_execute_runtest(cmd);
273 jlink_execute_statemove(cmd);
276 jlink_execute_pathmove(cmd);
279 jlink_execute_scan(cmd);
282 jlink_execute_sleep(cmd);
285 LOG_ERROR("BUG: Unknown JTAG command type encountered");
286 return ERROR_JTAG_QUEUE_FAILED;
292 static int jlink_execute_queue(void)
295 struct jtag_command *cmd = jtag_command_queue;
297 while (cmd != NULL) {
298 ret = jlink_execute_command(cmd);
306 return jlink_flush();
309 static int jlink_speed(int speed)
312 struct jaylink_speed tmp;
315 if (jaylink_has_cap(caps, JAYLINK_DEV_CAP_GET_SPEEDS)) {
316 ret = jaylink_get_speeds(devh, &tmp);
318 if (ret != JAYLINK_OK) {
319 LOG_ERROR("jaylink_get_speeds() failed: %s",
320 jaylink_strerror(ret));
321 return ERROR_JTAG_DEVICE_ERROR;
325 max_speed = tmp.freq / tmp.div;
327 max_speed = JLINK_MAX_SPEED;
331 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_ADAPTIVE_CLOCKING)) {
332 LOG_ERROR("Adaptive clocking is not supported by the device");
333 return ERROR_JTAG_NOT_IMPLEMENTED;
336 speed = JAYLINK_SPEED_ADAPTIVE_CLOCKING;
337 } else if (speed > max_speed) {
338 LOG_INFO("Reduced speed from %d kHz to %d kHz (maximum)", speed,
343 ret = jaylink_set_speed(devh, speed);
345 if (ret != JAYLINK_OK) {
346 LOG_ERROR("jaylink_set_speed() failed: %s",
347 jaylink_strerror(ret));
348 return ERROR_JTAG_DEVICE_ERROR;
354 static int jlink_speed_div(int speed, int *khz)
361 static int jlink_khz(int khz, int *jtag_speed)
368 static bool read_device_config(struct device_config *cfg)
372 ret = jaylink_read_raw_config(devh, (uint8_t *)cfg);
374 if (ret != JAYLINK_OK) {
375 LOG_ERROR("jaylink_read_raw_config() failed: %s",
376 jaylink_strerror(ret));
380 if (cfg->usb_address == 0xff)
381 cfg->usb_address = 0x00;
383 if (cfg->target_power == 0xffffffff)
384 cfg->target_power = 0;
389 static int select_interface(void)
394 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_SELECT_TIF)) {
395 if (iface != JAYLINK_TIF_JTAG) {
396 LOG_ERROR("Device supports JTAG transport only");
397 return ERROR_JTAG_INIT_FAILED;
403 ret = jaylink_get_available_interfaces(devh, &interfaces);
405 if (ret != JAYLINK_OK) {
406 LOG_ERROR("jaylink_get_available_interfaces() failed: %s",
407 jaylink_strerror(ret));
408 return ERROR_JTAG_INIT_FAILED;
411 if (!(interfaces & (1 << iface))) {
412 LOG_ERROR("Selected transport is not supported by the device");
413 return ERROR_JTAG_INIT_FAILED;
416 ret = jaylink_select_interface(devh, iface, NULL);
419 LOG_ERROR("jaylink_select_interface() failed: %s",
420 jaylink_strerror(ret));
421 return ERROR_JTAG_INIT_FAILED;
427 static int jlink_register(void)
434 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_REGISTER))
437 ret = jaylink_register(devh, &conn, connlist, &count);
439 if (ret != JAYLINK_OK) {
440 LOG_ERROR("jaylink_register() failed: %s", jaylink_strerror(ret));
444 handle_found = false;
446 for (i = 0; i < count; i++) {
447 if (connlist[i].handle == conn.handle) {
454 LOG_ERROR("Registration failed: maximum number of connections on the "
463 * Adjust the SWD transaction buffer size depending on the free device internal
464 * memory. This ensures that the SWD transactions sent to the device do not
465 * exceed the internal memory of the device.
467 static bool adjust_swd_buffer_size(void)
472 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_GET_FREE_MEMORY))
475 ret = jaylink_get_free_memory(devh, &tmp);
477 if (ret != JAYLINK_OK) {
478 LOG_ERROR("jaylink_get_free_memory() failed: %s",
479 jaylink_strerror(ret));
484 LOG_ERROR("Not enough free device internal memory: %" PRIu32 " bytes", tmp);
488 tmp = MIN(JLINK_TAP_BUFFER_SIZE, (tmp - 16) / 2);
490 if (tmp != swd_buffer_size) {
491 swd_buffer_size = tmp;
492 LOG_DEBUG("Adjusted SWD transaction buffer size to %u bytes",
499 static int jaylink_log_handler(const struct jaylink_context *ctx,
500 enum jaylink_log_level level, const char *format, va_list args,
506 case JAYLINK_LOG_LEVEL_ERROR:
509 case JAYLINK_LOG_LEVEL_WARNING:
510 tmp = LOG_LVL_WARNING;
513 * Forward info messages to the debug output because they are more verbose
514 * than info messages of OpenOCD.
516 case JAYLINK_LOG_LEVEL_INFO:
517 case JAYLINK_LOG_LEVEL_DEBUG:
520 case JAYLINK_LOG_LEVEL_DEBUG_IO:
521 tmp = LOG_LVL_DEBUG_IO;
524 tmp = LOG_LVL_WARNING;
527 log_vprintf_lf(tmp, __FILE__, __LINE__, __func__, format, args);
532 static bool jlink_usb_location_equal(struct jaylink_device *dev)
540 retval = jaylink_device_get_usb_bus_ports(dev, &bus, &ports, &num_ports);
542 if (retval == JAYLINK_ERR_NOT_SUPPORTED) {
544 } else if (retval != JAYLINK_OK) {
545 LOG_WARNING("jaylink_device_get_usb_bus_ports() failed: %s",
546 jaylink_strerror(retval));
550 equal = jtag_usb_location_equal(bus, ports, num_ports);
557 static int jlink_open_device(uint32_t ifaces, bool *found_device)
559 int ret = jaylink_discovery_scan(jayctx, ifaces);
560 if (ret != JAYLINK_OK) {
561 LOG_ERROR("jaylink_discovery_scan() failed: %s", jaylink_strerror(ret));
562 jaylink_exit(jayctx);
563 return ERROR_JTAG_INIT_FAILED;
567 struct jaylink_device **devs;
568 ret = jaylink_get_devices(jayctx, &devs, &num_devices);
570 if (ret != JAYLINK_OK) {
571 LOG_ERROR("jaylink_get_devices() failed: %s", jaylink_strerror(ret));
572 jaylink_exit(jayctx);
573 return ERROR_JTAG_INIT_FAILED;
576 use_usb_location = (jtag_usb_get_location() != NULL);
578 if (!use_serial_number && !use_usb_address && !use_usb_location && num_devices > 1) {
579 LOG_ERROR("Multiple devices found, specify the desired device");
580 jaylink_free_devices(devs, true);
581 jaylink_exit(jayctx);
582 return ERROR_JTAG_INIT_FAILED;
585 *found_device = false;
587 for (size_t i = 0; devs[i]; i++) {
588 struct jaylink_device *dev = devs[i];
590 if (use_serial_number) {
592 ret = jaylink_device_get_serial_number(dev, &tmp);
594 if (ret == JAYLINK_ERR_NOT_AVAILABLE) {
596 } else if (ret != JAYLINK_OK) {
597 LOG_WARNING("jaylink_device_get_serial_number() failed: %s",
598 jaylink_strerror(ret));
602 if (serial_number != tmp)
606 if (use_usb_address) {
607 enum jaylink_usb_address address;
608 ret = jaylink_device_get_usb_address(dev, &address);
610 if (ret == JAYLINK_ERR_NOT_SUPPORTED) {
612 } else if (ret != JAYLINK_OK) {
613 LOG_WARNING("jaylink_device_get_usb_address() failed: %s",
614 jaylink_strerror(ret));
618 if (usb_address != address)
622 if (use_usb_location && !jlink_usb_location_equal(dev))
625 ret = jaylink_open(dev, &devh);
627 if (ret == JAYLINK_OK) {
628 *found_device = true;
632 LOG_ERROR("Failed to open device: %s", jaylink_strerror(ret));
635 jaylink_free_devices(devs, true);
640 static int jlink_init(void)
643 char *firmware_version;
644 struct jaylink_hardware_version hwver;
645 struct jaylink_hardware_status hwstatus;
648 LOG_DEBUG("Using libjaylink %s (compiled with %s)",
649 jaylink_version_package_get_string(), JAYLINK_VERSION_PACKAGE_STRING);
651 if (!jaylink_library_has_cap(JAYLINK_CAP_HIF_USB) && use_usb_address) {
652 LOG_ERROR("J-Link driver does not support USB devices");
653 return ERROR_JTAG_INIT_FAILED;
656 ret = jaylink_init(&jayctx);
658 if (ret != JAYLINK_OK) {
659 LOG_ERROR("jaylink_init() failed: %s", jaylink_strerror(ret));
660 return ERROR_JTAG_INIT_FAILED;
663 ret = jaylink_log_set_callback(jayctx, &jaylink_log_handler, NULL);
665 if (ret != JAYLINK_OK) {
666 LOG_ERROR("jaylink_log_set_callback() failed: %s",
667 jaylink_strerror(ret));
668 jaylink_exit(jayctx);
669 return ERROR_JTAG_INIT_FAILED;
673 ret = jlink_open_device(JAYLINK_HIF_USB, &found_device);
677 if (!found_device && use_serial_number) {
678 ret = jlink_open_device(JAYLINK_HIF_TCP, &found_device);
684 LOG_ERROR("No J-Link device found");
685 jaylink_exit(jayctx);
686 return ERROR_JTAG_INIT_FAILED;
690 * Be careful with changing the following initialization sequence because
691 * some devices are known to be sensitive regarding the order.
694 ret = jaylink_get_firmware_version(devh, &firmware_version, &length);
696 if (ret != JAYLINK_OK) {
697 LOG_ERROR("jaylink_get_firmware_version() failed: %s",
698 jaylink_strerror(ret));
700 jaylink_exit(jayctx);
701 return ERROR_JTAG_INIT_FAILED;
702 } else if (length > 0) {
703 LOG_INFO("%s", firmware_version);
704 free(firmware_version);
706 LOG_WARNING("Device responds empty firmware version string");
709 memset(caps, 0, JAYLINK_DEV_EXT_CAPS_SIZE);
710 ret = jaylink_get_caps(devh, caps);
712 if (ret != JAYLINK_OK) {
713 LOG_ERROR("jaylink_get_caps() failed: %s", jaylink_strerror(ret));
715 jaylink_exit(jayctx);
716 return ERROR_JTAG_INIT_FAILED;
719 if (jaylink_has_cap(caps, JAYLINK_DEV_CAP_GET_EXT_CAPS)) {
720 ret = jaylink_get_extended_caps(devh, caps);
722 if (ret != JAYLINK_OK) {
723 LOG_ERROR("jaylink_get_extended_caps() failed: %s",
724 jaylink_strerror(ret));
726 jaylink_exit(jayctx);
727 return ERROR_JTAG_INIT_FAILED;
731 jtag_command_version = JAYLINK_JTAG_VERSION_2;
733 if (jaylink_has_cap(caps, JAYLINK_DEV_CAP_GET_HW_VERSION)) {
734 ret = jaylink_get_hardware_version(devh, &hwver);
736 if (ret != JAYLINK_OK) {
737 LOG_ERROR("Failed to retrieve hardware version: %s",
738 jaylink_strerror(ret));
740 jaylink_exit(jayctx);
741 return ERROR_JTAG_INIT_FAILED;
744 LOG_INFO("Hardware version: %u.%02u", hwver.major, hwver.minor);
746 if (hwver.major >= 5)
747 jtag_command_version = JAYLINK_JTAG_VERSION_3;
750 if (iface == JAYLINK_TIF_SWD) {
752 * Adjust the SWD transaction buffer size in case there is already
753 * allocated memory on the device. This happens for example if the
754 * memory for SWO capturing is still allocated because the software
755 * which used the device before has not been shut down properly.
757 if (!adjust_swd_buffer_size()) {
759 jaylink_exit(jayctx);
760 return ERROR_JTAG_INIT_FAILED;
764 if (jaylink_has_cap(caps, JAYLINK_DEV_CAP_READ_CONFIG)) {
765 if (!read_device_config(&config)) {
766 LOG_ERROR("Failed to read device configuration data");
768 jaylink_exit(jayctx);
769 return ERROR_JTAG_INIT_FAILED;
772 memcpy(&tmp_config, &config, sizeof(struct device_config));
775 ret = jaylink_get_hardware_status(devh, &hwstatus);
777 if (ret != JAYLINK_OK) {
778 LOG_ERROR("jaylink_get_hardware_status() failed: %s",
779 jaylink_strerror(ret));
781 jaylink_exit(jayctx);
782 return ERROR_JTAG_INIT_FAILED;
785 LOG_INFO("VTarget = %u.%03u V", hwstatus.target_voltage / 1000,
786 hwstatus.target_voltage % 1000);
790 strcpy(conn.hid, "0.0.0.0");
794 ret = jlink_register();
796 if (ret != ERROR_OK) {
798 jaylink_exit(jayctx);
799 return ERROR_JTAG_INIT_FAILED;
802 ret = select_interface();
804 if (ret != ERROR_OK) {
806 jaylink_exit(jayctx);
814 jlink_speed(jtag_get_speed_khz());
816 if (iface == JAYLINK_TIF_JTAG) {
818 * J-Link devices with firmware version v5 and v6 seems to have an issue
819 * if the first tap move is not divisible by 8, so we send a TLR on
823 jlink_clock_data(NULL, 0, &tms, 0, NULL, 0, 8);
831 static int jlink_quit(void)
837 ret = jaylink_swo_stop(devh);
839 if (ret != JAYLINK_OK)
840 LOG_ERROR("jaylink_swo_stop() failed: %s", jaylink_strerror(ret));
843 if (jaylink_has_cap(caps, JAYLINK_DEV_CAP_REGISTER)) {
844 ret = jaylink_unregister(devh, &conn, connlist, &count);
846 if (ret != JAYLINK_OK)
847 LOG_ERROR("jaylink_unregister() failed: %s",
848 jaylink_strerror(ret));
852 jaylink_exit(jayctx);
857 /***************************************************************************/
858 /* Queue command implementations */
860 static void jlink_end_state(tap_state_t state)
862 if (tap_is_state_stable(state))
863 tap_set_end_state(state);
865 LOG_ERROR("BUG: %i is not a valid end state", state);
870 /* Goes to the end state. */
871 static void jlink_state_move(void)
874 uint8_t tms_scan_bits;
876 tms_scan = tap_get_tms_path(tap_get_state(), tap_get_end_state());
877 tms_scan_bits = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
879 jlink_clock_data(NULL, 0, &tms_scan, 0, NULL, 0, tms_scan_bits);
881 tap_set_state(tap_get_end_state());
884 static void jlink_path_move(int num_states, tap_state_t *path)
889 for (i = 0; i < num_states; i++) {
890 if (path[i] == tap_state_transition(tap_get_state(), false))
891 jlink_clock_data(NULL, 0, NULL, 0, NULL, 0, 1);
892 else if (path[i] == tap_state_transition(tap_get_state(), true))
893 jlink_clock_data(NULL, 0, &tms, 0, NULL, 0, 1);
895 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
896 tap_state_name(tap_get_state()), tap_state_name(path[i]));
900 tap_set_state(path[i]);
903 tap_set_end_state(tap_get_state());
906 static void jlink_stableclocks(int num_cycles)
910 uint8_t tms = tap_get_state() == TAP_RESET;
911 /* Execute num_cycles. */
912 for (i = 0; i < num_cycles; i++)
913 jlink_clock_data(NULL, 0, &tms, 0, NULL, 0, 1);
916 static void jlink_runtest(int num_cycles)
918 tap_state_t saved_end_state = tap_get_end_state();
920 /* Only do a state_move when we're not already in IDLE. */
921 if (tap_get_state() != TAP_IDLE) {
922 jlink_end_state(TAP_IDLE);
927 jlink_stableclocks(num_cycles);
929 /* Finish in end_state. */
930 jlink_end_state(saved_end_state);
932 if (tap_get_state() != tap_get_end_state())
936 static void jlink_reset(int trst, int srst)
938 LOG_DEBUG("TRST: %i, SRST: %i", trst, srst);
940 /* Signals are active low. */
942 jaylink_set_reset(devh);
945 jaylink_clear_reset(devh);
948 jaylink_jtag_clear_trst(devh);
951 jaylink_jtag_set_trst(devh);
954 static int jlink_reset_safe(int trst, int srst)
957 jlink_reset(trst, srst);
958 return jlink_flush();
961 COMMAND_HANDLER(jlink_usb_command)
966 command_print(CMD, "Need exactly one argument for jlink usb");
967 return ERROR_COMMAND_SYNTAX_ERROR;
970 if (sscanf(CMD_ARGV[0], "%i", &tmp) != 1) {
971 command_print(CMD, "Invalid USB address: %s", CMD_ARGV[0]);
975 if (tmp < JAYLINK_USB_ADDRESS_0 || tmp > JAYLINK_USB_ADDRESS_3) {
976 command_print(CMD, "Invalid USB address: %s", CMD_ARGV[0]);
982 use_serial_number = false;
983 use_usb_address = true;
988 COMMAND_HANDLER(jlink_serial_command)
993 command_print(CMD, "Need exactly one argument for jlink serial");
994 return ERROR_COMMAND_SYNTAX_ERROR;
997 ret = jaylink_parse_serial_number(CMD_ARGV[0], &serial_number);
999 if (ret == JAYLINK_ERR) {
1000 command_print(CMD, "Invalid serial number: %s", CMD_ARGV[0]);
1002 } else if (ret != JAYLINK_OK) {
1003 command_print(CMD, "jaylink_parse_serial_number() failed: %s",
1004 jaylink_strerror(ret));
1008 use_serial_number = true;
1009 use_usb_address = false;
1014 COMMAND_HANDLER(jlink_handle_hwstatus_command)
1017 struct jaylink_hardware_status status;
1019 ret = jaylink_get_hardware_status(devh, &status);
1021 if (ret != JAYLINK_OK) {
1022 command_print(CMD, "jaylink_get_hardware_status() failed: %s",
1023 jaylink_strerror(ret));
1027 command_print(CMD, "VTarget = %u.%03u V",
1028 status.target_voltage / 1000, status.target_voltage % 1000);
1030 command_print(CMD, "TCK = %u TDI = %u TDO = %u TMS = %u SRST = %u "
1031 "TRST = %u", status.tck, status.tdi, status.tdo, status.tms,
1032 status.tres, status.trst);
1034 if (status.target_voltage < 1500)
1035 command_print(CMD, "Target voltage too low. Check target power");
1040 COMMAND_HANDLER(jlink_handle_free_memory_command)
1045 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_GET_FREE_MEMORY)) {
1046 command_print(CMD, "Retrieval of free memory is not supported by "
1051 ret = jaylink_get_free_memory(devh, &tmp);
1053 if (ret != JAYLINK_OK) {
1054 command_print(CMD, "jaylink_get_free_memory() failed: %s",
1055 jaylink_strerror(ret));
1059 command_print(CMD, "Device has %" PRIu32 " bytes of free memory", tmp);
1064 COMMAND_HANDLER(jlink_handle_jlink_jtag_command)
1070 switch (jtag_command_version) {
1071 case JAYLINK_JTAG_VERSION_2:
1074 case JAYLINK_JTAG_VERSION_3:
1081 command_print(CMD, "JTAG command version: %i", version);
1082 } else if (CMD_ARGC == 1) {
1083 if (sscanf(CMD_ARGV[0], "%i", &tmp) != 1) {
1084 command_print(CMD, "Invalid argument: %s", CMD_ARGV[0]);
1085 return ERROR_COMMAND_SYNTAX_ERROR;
1090 jtag_command_version = JAYLINK_JTAG_VERSION_2;
1093 jtag_command_version = JAYLINK_JTAG_VERSION_3;
1096 command_print(CMD, "Invalid argument: %s", CMD_ARGV[0]);
1097 return ERROR_COMMAND_SYNTAX_ERROR;
1100 command_print(CMD, "Need exactly one argument for jlink jtag");
1101 return ERROR_COMMAND_SYNTAX_ERROR;
1107 COMMAND_HANDLER(jlink_handle_target_power_command)
1112 if (CMD_ARGC != 1) {
1113 command_print(CMD, "Need exactly one argument for jlink targetpower");
1114 return ERROR_COMMAND_SYNTAX_ERROR;
1117 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_SET_TARGET_POWER)) {
1118 command_print(CMD, "Target power supply is not supported by the "
1123 if (!strcmp(CMD_ARGV[0], "on")) {
1125 } else if (!strcmp(CMD_ARGV[0], "off")) {
1128 command_print(CMD, "Invalid argument: %s", CMD_ARGV[0]);
1132 ret = jaylink_set_target_power(devh, enable);
1134 if (ret != JAYLINK_OK) {
1135 command_print(CMD, "jaylink_set_target_power() failed: %s",
1136 jaylink_strerror(ret));
1143 static void show_config_usb_address(struct command_invocation *cmd)
1145 if (config.usb_address != tmp_config.usb_address)
1146 command_print(cmd, "USB address: %u [%u]", config.usb_address,
1147 tmp_config.usb_address);
1149 command_print(cmd, "USB address: %u", config.usb_address);
1152 static void show_config_ip_address(struct command_invocation *cmd)
1154 if (!memcmp(config.ip_address, tmp_config.ip_address, 4))
1155 command_print(cmd, "IP address: %d.%d.%d.%d",
1156 config.ip_address[3], config.ip_address[2],
1157 config.ip_address[1], config.ip_address[0]);
1159 command_print(cmd, "IP address: %d.%d.%d.%d [%d.%d.%d.%d]",
1160 config.ip_address[3], config.ip_address[2],
1161 config.ip_address[1], config.ip_address[0],
1162 tmp_config.ip_address[3], tmp_config.ip_address[2],
1163 tmp_config.ip_address[1], tmp_config.ip_address[0]);
1165 if (!memcmp(config.subnet_mask, tmp_config.subnet_mask, 4))
1166 command_print(cmd, "Subnet mask: %d.%d.%d.%d",
1167 config.subnet_mask[3], config.subnet_mask[2],
1168 config.subnet_mask[1], config.subnet_mask[0]);
1170 command_print(cmd, "Subnet mask: %d.%d.%d.%d [%d.%d.%d.%d]",
1171 config.subnet_mask[3], config.subnet_mask[2],
1172 config.subnet_mask[1], config.subnet_mask[0],
1173 tmp_config.subnet_mask[3], tmp_config.subnet_mask[2],
1174 tmp_config.subnet_mask[1], tmp_config.subnet_mask[0]);
1177 static void show_config_mac_address(struct command_invocation *cmd)
1179 if (!memcmp(config.mac_address, tmp_config.mac_address, 6))
1180 command_print(cmd, "MAC address: %.02x:%.02x:%.02x:%.02x:%.02x:%.02x",
1181 config.mac_address[5], config.mac_address[4],
1182 config.mac_address[3], config.mac_address[2],
1183 config.mac_address[1], config.mac_address[0]);
1185 command_print(cmd, "MAC address: %.02x:%.02x:%.02x:%.02x:%.02x:%.02x "
1186 "[%.02x:%.02x:%.02x:%.02x:%.02x:%.02x]",
1187 config.mac_address[5], config.mac_address[4],
1188 config.mac_address[3], config.mac_address[2],
1189 config.mac_address[1], config.mac_address[0],
1190 tmp_config.mac_address[5], tmp_config.mac_address[4],
1191 tmp_config.mac_address[3], tmp_config.mac_address[2],
1192 tmp_config.mac_address[1], tmp_config.mac_address[0]);
1195 static void show_config_target_power(struct command_invocation *cmd)
1197 const char *target_power;
1198 const char *current_target_power;
1200 if (!config.target_power)
1201 target_power = "off";
1203 target_power = "on";
1205 if (!tmp_config.target_power)
1206 current_target_power = "off";
1208 current_target_power = "on";
1210 if (config.target_power != tmp_config.target_power)
1211 command_print(cmd, "Target power supply: %s [%s]", target_power,
1212 current_target_power);
1214 command_print(cmd, "Target power supply: %s", target_power);
1217 static void show_config(struct command_invocation *cmd)
1219 command_print(cmd, "J-Link device configuration:");
1221 show_config_usb_address(cmd);
1223 if (jaylink_has_cap(caps, JAYLINK_DEV_CAP_SET_TARGET_POWER))
1224 show_config_target_power(cmd);
1226 if (jaylink_has_cap(caps, JAYLINK_DEV_CAP_ETHERNET)) {
1227 show_config_ip_address(cmd);
1228 show_config_mac_address(cmd);
1232 static int poll_trace(uint8_t *buf, size_t *size)
1239 ret = jaylink_swo_read(devh, buf, &length);
1241 if (ret != JAYLINK_OK) {
1242 LOG_ERROR("jaylink_swo_read() failed: %s", jaylink_strerror(ret));
1251 static uint32_t calculate_trace_buffer_size(void)
1256 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_GET_FREE_MEMORY))
1259 ret = jaylink_get_free_memory(devh, &tmp);
1261 if (ret != JAYLINK_OK) {
1262 LOG_ERROR("jaylink_get_free_memory() failed: %s",
1263 jaylink_strerror(ret));
1267 if (tmp > 0x3fff || tmp <= 0x600)
1272 return tmp & 0xffffff00;
1275 static bool calculate_swo_prescaler(unsigned int traceclkin_freq,
1276 uint32_t trace_freq, uint16_t *prescaler)
1278 unsigned int presc = (traceclkin_freq + trace_freq / 2) / trace_freq;
1279 if (presc == 0 || presc > TPIU_ACPR_MAX_SWOSCALER + 1)
1282 /* Probe's UART speed must be within 3% of the TPIU's SWO baud rate. */
1283 unsigned int max_deviation = (traceclkin_freq * 3) / 100;
1284 if (presc * trace_freq < traceclkin_freq - max_deviation ||
1285 presc * trace_freq > traceclkin_freq + max_deviation)
1293 static bool detect_swo_freq_and_prescaler(struct jaylink_swo_speed speed,
1294 unsigned int traceclkin_freq, unsigned int *trace_freq,
1295 uint16_t *prescaler)
1301 for (divider = speed.min_div; divider <= speed.max_div; divider++) {
1302 *trace_freq = speed.freq / divider;
1303 presc = ((1.0 - SWO_MAX_FREQ_DEV) * traceclkin_freq) / *trace_freq + 1;
1305 if (presc > TPIU_ACPR_MAX_SWOSCALER + 1)
1308 deviation = fabs(1.0 - ((double)*trace_freq * presc / traceclkin_freq));
1310 if (deviation <= SWO_MAX_FREQ_DEV) {
1319 static int config_trace(bool enabled, enum tpiu_pin_protocol pin_protocol,
1320 uint32_t port_size, unsigned int *trace_freq,
1321 unsigned int traceclkin_freq, uint16_t *prescaler)
1324 uint32_t buffer_size;
1325 struct jaylink_swo_speed speed;
1330 trace_enabled = enabled;
1332 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_SWO)) {
1336 LOG_ERROR("Trace capturing is not supported by the device");
1340 ret = jaylink_swo_stop(devh);
1342 if (ret != JAYLINK_OK) {
1343 LOG_ERROR("jaylink_swo_stop() failed: %s", jaylink_strerror(ret));
1349 * Adjust the SWD transaction buffer size as stopping SWO capturing
1350 * deallocates device internal memory.
1352 if (!adjust_swd_buffer_size())
1358 if (pin_protocol != TPIU_PIN_PROTOCOL_ASYNC_UART) {
1359 LOG_ERROR("Selected pin protocol is not supported");
1363 buffer_size = calculate_trace_buffer_size();
1366 LOG_ERROR("Not enough free device memory to start trace capturing");
1370 ret = jaylink_swo_get_speeds(devh, JAYLINK_SWO_MODE_UART, &speed);
1372 if (ret != JAYLINK_OK) {
1373 LOG_ERROR("jaylink_swo_get_speeds() failed: %s",
1374 jaylink_strerror(ret));
1378 if (*trace_freq > 0) {
1379 divider = speed.freq / *trace_freq;
1380 min_freq = speed.freq / speed.max_div;
1381 max_freq = speed.freq / speed.min_div;
1383 if (*trace_freq > max_freq) {
1384 LOG_INFO("Given SWO frequency too high, using %" PRIu32 " Hz instead",
1386 *trace_freq = max_freq;
1387 } else if (*trace_freq < min_freq) {
1388 LOG_INFO("Given SWO frequency too low, using %" PRIu32 " Hz instead",
1390 *trace_freq = min_freq;
1391 } else if (*trace_freq != speed.freq / divider) {
1392 *trace_freq = speed.freq / divider;
1394 LOG_INFO("Given SWO frequency is not supported by the device, "
1395 "using %u Hz instead", *trace_freq);
1398 if (!calculate_swo_prescaler(traceclkin_freq, *trace_freq,
1400 LOG_ERROR("SWO frequency is not suitable. Please choose a "
1401 "different frequency or use auto-detection");
1405 LOG_INFO("Trying to auto-detect SWO frequency");
1407 if (!detect_swo_freq_and_prescaler(speed, traceclkin_freq, trace_freq,
1409 LOG_ERROR("Maximum permitted frequency deviation of %.02f %% "
1410 "could not be achieved", SWO_MAX_FREQ_DEV);
1411 LOG_ERROR("Auto-detection of SWO frequency failed");
1415 LOG_INFO("Using SWO frequency of %u Hz", *trace_freq);
1418 ret = jaylink_swo_start(devh, JAYLINK_SWO_MODE_UART, *trace_freq,
1421 if (ret != JAYLINK_OK) {
1422 LOG_ERROR("jaylink_start_swo() failed: %s", jaylink_strerror(ret));
1426 LOG_DEBUG("Using %" PRIu32 " bytes device memory for trace capturing",
1430 * Adjust the SWD transaction buffer size as starting SWO capturing
1431 * allocates device internal memory.
1433 if (!adjust_swd_buffer_size())
1439 COMMAND_HANDLER(jlink_handle_config_usb_address_command)
1443 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_READ_CONFIG)) {
1444 command_print(CMD, "Reading configuration is not supported by the "
1450 show_config_usb_address(CMD);
1451 } else if (CMD_ARGC == 1) {
1452 if (sscanf(CMD_ARGV[0], "%" SCNd8, &tmp) != 1) {
1453 command_print(CMD, "Invalid USB address: %s", CMD_ARGV[0]);
1457 if (tmp > JAYLINK_USB_ADDRESS_3) {
1458 command_print(CMD, "Invalid USB address: %u", tmp);
1462 tmp_config.usb_address = tmp;
1464 command_print(CMD, "Need exactly one argument for jlink config usb");
1465 return ERROR_COMMAND_SYNTAX_ERROR;
1471 COMMAND_HANDLER(jlink_handle_config_target_power_command)
1475 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_READ_CONFIG)) {
1476 command_print(CMD, "Reading configuration is not supported by the "
1481 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_SET_TARGET_POWER)) {
1482 command_print(CMD, "Target power supply is not supported by the "
1488 show_config_target_power(CMD);
1489 } else if (CMD_ARGC == 1) {
1490 if (!strcmp(CMD_ARGV[0], "on")) {
1492 } else if (!strcmp(CMD_ARGV[0], "off")) {
1495 command_print(CMD, "Invalid argument: %s", CMD_ARGV[0]);
1499 tmp_config.target_power = enable;
1501 command_print(CMD, "Need exactly one argument for jlink config "
1503 return ERROR_COMMAND_SYNTAX_ERROR;
1509 COMMAND_HANDLER(jlink_handle_config_mac_address_command)
1516 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_READ_CONFIG)) {
1517 command_print(CMD, "Reading configuration is not supported by the "
1522 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_ETHERNET)) {
1523 command_print(CMD, "Ethernet connectivity is not supported by the "
1529 show_config_mac_address(CMD);
1530 } else if (CMD_ARGC == 1) {
1533 if ((strlen(str) != 17) || (str[2] != ':' || str[5] != ':' ||
1534 str[8] != ':' || str[11] != ':' || str[14] != ':')) {
1535 command_print(CMD, "Invalid MAC address format");
1536 return ERROR_COMMAND_SYNTAX_ERROR;
1539 for (i = 5; i >= 0; i--) {
1540 addr[i] = strtoul(str, &e, 16);
1544 if (!(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5])) {
1545 command_print(CMD, "Invalid MAC address: zero address");
1546 return ERROR_COMMAND_SYNTAX_ERROR;
1549 if (!(0x01 & addr[0])) {
1550 command_print(CMD, "Invalid MAC address: multicast address");
1551 return ERROR_COMMAND_SYNTAX_ERROR;
1554 memcpy(tmp_config.mac_address, addr, sizeof(addr));
1556 command_print(CMD, "Need exactly one argument for jlink config mac");
1557 return ERROR_COMMAND_SYNTAX_ERROR;
1563 static bool string_to_ip(const char *s, uint8_t *ip, int *pos)
1567 const char *s_save = s;
1573 for (i = 0; i < 4; i++) {
1574 lip[i] = strtoul(s, &e, 10);
1576 if (*e != '.' && i != 3)
1583 memcpy(ip, lip, sizeof(lip));
1588 static void cpy_ip(uint8_t *dst, uint8_t *src)
1592 for (i = 0, j = 3; i < 4; i++, j--)
1596 COMMAND_HANDLER(jlink_handle_config_ip_address_command)
1598 uint8_t ip_address[4];
1599 uint32_t subnet_mask = 0;
1601 uint8_t subnet_bits = 24;
1603 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_READ_CONFIG)) {
1604 command_print(CMD, "Reading configuration is not supported by the "
1609 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_ETHERNET)) {
1610 command_print(CMD, "Ethernet connectivity is not supported by the "
1616 show_config_ip_address(CMD);
1618 if (!string_to_ip(CMD_ARGV[0], ip_address, &i))
1619 return ERROR_COMMAND_SYNTAX_ERROR;
1621 len = strlen(CMD_ARGV[0]);
1623 /* Check for format A.B.C.D/E. */
1625 if (CMD_ARGV[0][i] != '/')
1626 return ERROR_COMMAND_SYNTAX_ERROR;
1628 COMMAND_PARSE_NUMBER(u8, CMD_ARGV[0] + i + 1, subnet_bits);
1629 } else if (CMD_ARGC > 1) {
1630 if (!string_to_ip(CMD_ARGV[1], (uint8_t *)&subnet_mask, &i))
1631 return ERROR_COMMAND_SYNTAX_ERROR;
1635 subnet_mask = (uint32_t)(subnet_bits < 32 ?
1636 ((1ULL << subnet_bits) - 1) : 0xffffffff);
1638 cpy_ip(tmp_config.ip_address, ip_address);
1639 cpy_ip(tmp_config.subnet_mask, (uint8_t *)&subnet_mask);
1645 COMMAND_HANDLER(jlink_handle_config_reset_command)
1647 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_READ_CONFIG))
1650 memcpy(&tmp_config, &config, sizeof(struct device_config));
1656 COMMAND_HANDLER(jlink_handle_config_write_command)
1660 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_READ_CONFIG)) {
1661 command_print(CMD, "Reading configuration is not supported by the "
1666 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_WRITE_CONFIG)) {
1667 command_print(CMD, "Writing configuration is not supported by the "
1672 if (!memcmp(&config, &tmp_config, sizeof(struct device_config))) {
1673 command_print(CMD, "Operation not performed due to no changes in "
1674 "the configuration");
1678 ret = jaylink_write_raw_config(devh, (const uint8_t *)&tmp_config);
1680 if (ret != JAYLINK_OK) {
1681 LOG_ERROR("jaylink_write_raw_config() failed: %s",
1682 jaylink_strerror(ret));
1686 if (!read_device_config(&config)) {
1687 LOG_ERROR("Failed to read device configuration for verification");
1691 if (memcmp(&config, &tmp_config, sizeof(struct device_config))) {
1692 LOG_ERROR("Verification of device configuration failed. Please check "
1697 memcpy(&tmp_config, &config, sizeof(struct device_config));
1698 command_print(CMD, "The new device configuration applies after power "
1699 "cycling the J-Link device");
1704 COMMAND_HANDLER(jlink_handle_config_command)
1706 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_READ_CONFIG)) {
1707 command_print(CMD, "Device doesn't support reading configuration");
1717 COMMAND_HANDLER(jlink_handle_emucom_write_command)
1727 return ERROR_COMMAND_SYNTAX_ERROR;
1729 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_EMUCOM)) {
1730 LOG_ERROR("Device does not support EMUCOM");
1734 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], channel);
1736 tmp = strlen(CMD_ARGV[1]);
1739 LOG_ERROR("Data must be encoded as hexadecimal pairs");
1740 return ERROR_COMMAND_ARGUMENT_INVALID;
1743 buf = malloc(tmp / 2);
1746 LOG_ERROR("Failed to allocate buffer");
1750 dummy = unhexify(buf, CMD_ARGV[1], tmp / 2);
1752 if (dummy != (tmp / 2)) {
1753 LOG_ERROR("Data must be encoded as hexadecimal pairs");
1755 return ERROR_COMMAND_ARGUMENT_INVALID;
1759 ret = jaylink_emucom_write(devh, channel, buf, &length);
1763 if (ret == JAYLINK_ERR_DEV_NOT_SUPPORTED) {
1764 LOG_ERROR("Channel not supported by the device");
1766 } else if (ret != JAYLINK_OK) {
1767 LOG_ERROR("Failed to write to channel: %s", jaylink_strerror(ret));
1771 if (length != (tmp / 2))
1772 LOG_WARNING("Only %" PRIu32 " bytes written to the channel", length);
1777 COMMAND_HANDLER(jlink_handle_emucom_read_command)
1786 return ERROR_COMMAND_SYNTAX_ERROR;
1788 if (!jaylink_has_cap(caps, JAYLINK_DEV_CAP_EMUCOM)) {
1789 LOG_ERROR("Device does not support EMUCOM");
1793 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], channel);
1794 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
1796 buf = malloc(length * 3 + 1);
1799 LOG_ERROR("Failed to allocate buffer");
1803 ret = jaylink_emucom_read(devh, channel, buf, &length);
1805 if (ret == JAYLINK_ERR_DEV_NOT_SUPPORTED) {
1806 LOG_ERROR("Channel is not supported by the device");
1809 } else if (ret == JAYLINK_ERR_DEV_NOT_AVAILABLE) {
1810 LOG_ERROR("Channel is not available for the requested amount of data. "
1811 "%" PRIu32 " bytes are available", length);
1814 } else if (ret != JAYLINK_OK) {
1815 LOG_ERROR("Failed to read from channel: %s", jaylink_strerror(ret));
1820 tmp = hexify((char *)buf + length, buf, length, 2 * length + 1);
1822 if (tmp != 2 * length) {
1823 LOG_ERROR("Failed to convert data into hexadecimal string");
1828 command_print(CMD, "%s", buf + length);
1834 static const struct command_registration jlink_config_subcommand_handlers[] = {
1837 .handler = &jlink_handle_config_usb_address_command,
1838 .mode = COMMAND_EXEC,
1839 .help = "set the USB address",
1843 .name = "targetpower",
1844 .handler = &jlink_handle_config_target_power_command,
1845 .mode = COMMAND_EXEC,
1846 .help = "set the target power supply",
1851 .handler = &jlink_handle_config_mac_address_command,
1852 .mode = COMMAND_EXEC,
1853 .help = "set the MAC Address",
1854 .usage = "[ff:ff:ff:ff:ff:ff]",
1858 .handler = &jlink_handle_config_ip_address_command,
1859 .mode = COMMAND_EXEC,
1860 .help = "set the IP address, where A.B.C.D is the IP address, "
1861 "E the bit of the subnet mask, F.G.H.I the subnet mask",
1862 .usage = "[A.B.C.D[/E] [F.G.H.I]]",
1866 .handler = &jlink_handle_config_reset_command,
1867 .mode = COMMAND_EXEC,
1868 .help = "undo configuration changes",
1873 .handler = &jlink_handle_config_write_command,
1874 .mode = COMMAND_EXEC,
1875 .help = "write configuration to the device",
1878 COMMAND_REGISTRATION_DONE
1881 static const struct command_registration jlink_emucom_subcommand_handlers[] = {
1884 .handler = &jlink_handle_emucom_write_command,
1885 .mode = COMMAND_EXEC,
1886 .help = "write to a channel",
1887 .usage = "<channel> <data>",
1891 .handler = &jlink_handle_emucom_read_command,
1892 .mode = COMMAND_EXEC,
1893 .help = "read from a channel",
1894 .usage = "<channel> <length>"
1896 COMMAND_REGISTRATION_DONE
1899 static const struct command_registration jlink_subcommand_handlers[] = {
1902 .handler = &jlink_handle_jlink_jtag_command,
1903 .mode = COMMAND_EXEC,
1904 .help = "select the JTAG command version",
1908 .name = "targetpower",
1909 .handler = &jlink_handle_target_power_command,
1910 .mode = COMMAND_EXEC,
1911 .help = "set the target power supply",
1916 .handler = &jlink_handle_free_memory_command,
1917 .mode = COMMAND_EXEC,
1918 .help = "show free device memory",
1923 .handler = &jlink_handle_hwstatus_command,
1924 .mode = COMMAND_EXEC,
1925 .help = "show the hardware status",
1930 .handler = &jlink_usb_command,
1931 .mode = COMMAND_CONFIG,
1932 .help = "set the USB address of the device that should be used",
1937 .handler = &jlink_serial_command,
1938 .mode = COMMAND_CONFIG,
1939 .help = "set the serial number of the device that should be used",
1940 .usage = "<serial number>"
1944 .handler = &jlink_handle_config_command,
1945 .mode = COMMAND_EXEC,
1946 .help = "access the device configuration. If no argument is given "
1947 "this will show the device configuration",
1948 .chain = jlink_config_subcommand_handlers,
1953 .mode = COMMAND_EXEC,
1954 .help = "access EMUCOM channel",
1955 .chain = jlink_emucom_subcommand_handlers,
1958 COMMAND_REGISTRATION_DONE
1961 static const struct command_registration jlink_command_handlers[] = {
1964 .mode = COMMAND_ANY,
1965 .help = "perform jlink management",
1966 .chain = jlink_subcommand_handlers,
1969 COMMAND_REGISTRATION_DONE
1972 static int jlink_swd_init(void)
1974 iface = JAYLINK_TIF_SWD;
1979 static void jlink_swd_write_reg(uint8_t cmd, uint32_t value, uint32_t ap_delay_clk)
1981 assert(!(cmd & SWD_CMD_RnW));
1982 jlink_swd_queue_cmd(cmd, NULL, value, ap_delay_clk);
1985 static void jlink_swd_read_reg(uint8_t cmd, uint32_t *value, uint32_t ap_delay_clk)
1987 assert(cmd & SWD_CMD_RnW);
1988 jlink_swd_queue_cmd(cmd, value, 0, ap_delay_clk);
1991 /***************************************************************************/
1992 /* J-Link tap functions */
1994 static unsigned tap_length;
1995 /* In SWD mode use tms buffer for direction control */
1996 static uint8_t tms_buffer[JLINK_TAP_BUFFER_SIZE];
1997 static uint8_t tdi_buffer[JLINK_TAP_BUFFER_SIZE];
1998 static uint8_t tdo_buffer[JLINK_TAP_BUFFER_SIZE];
2000 struct pending_scan_result {
2001 /** First bit position in tdo_buffer to read. */
2003 /** Number of bits to read. */
2005 /** Location to store the result */
2007 /** Offset in the destination buffer */
2008 unsigned buffer_offset;
2011 #define MAX_PENDING_SCAN_RESULTS 256
2013 static int pending_scan_results_length;
2014 static struct pending_scan_result pending_scan_results_buffer[MAX_PENDING_SCAN_RESULTS];
2016 static void jlink_tap_init(void)
2019 pending_scan_results_length = 0;
2020 memset(tms_buffer, 0, sizeof(tms_buffer));
2021 memset(tdi_buffer, 0, sizeof(tdi_buffer));
2024 static void jlink_clock_data(const uint8_t *out, unsigned out_offset,
2025 const uint8_t *tms_out, unsigned tms_offset,
2026 uint8_t *in, unsigned in_offset,
2030 unsigned available_length = JLINK_TAP_BUFFER_SIZE - tap_length / 8;
2032 if (!available_length ||
2033 (in && pending_scan_results_length == MAX_PENDING_SCAN_RESULTS)) {
2034 if (jlink_flush() != ERROR_OK)
2036 available_length = JLINK_TAP_BUFFER_SIZE;
2039 struct pending_scan_result *pending_scan_result =
2040 &pending_scan_results_buffer[pending_scan_results_length];
2042 unsigned scan_length = length > available_length ?
2043 available_length : length;
2046 buf_set_buf(out, out_offset, tdi_buffer, tap_length, scan_length);
2048 buf_set_buf(tms_out, tms_offset, tms_buffer, tap_length, scan_length);
2051 pending_scan_result->first = tap_length;
2052 pending_scan_result->length = scan_length;
2053 pending_scan_result->buffer = in;
2054 pending_scan_result->buffer_offset = in_offset;
2055 pending_scan_results_length++;
2058 tap_length += scan_length;
2059 out_offset += scan_length;
2060 tms_offset += scan_length;
2061 in_offset += scan_length;
2062 length -= scan_length;
2063 } while (length > 0);
2066 static int jlink_flush(void)
2074 jlink_last_state = jtag_debug_state_machine(tms_buffer, tdi_buffer,
2075 tap_length, jlink_last_state);
2077 ret = jaylink_jtag_io(devh, tms_buffer, tdi_buffer, tdo_buffer,
2078 tap_length, jtag_command_version);
2080 if (ret != JAYLINK_OK) {
2081 LOG_ERROR("jaylink_jtag_io() failed: %s", jaylink_strerror(ret));
2083 return ERROR_JTAG_QUEUE_FAILED;
2086 for (i = 0; i < pending_scan_results_length; i++) {
2087 struct pending_scan_result *p = &pending_scan_results_buffer[i];
2089 buf_set_buf(tdo_buffer, p->first, p->buffer,
2090 p->buffer_offset, p->length);
2092 LOG_DEBUG_IO("Pending scan result, length = %d", p->length);
2100 static void fill_buffer(uint8_t *buf, uint32_t val, uint32_t len)
2102 unsigned int tap_pos = tap_length;
2105 buf_set_u32(buf, tap_pos, 32, val);
2111 buf_set_u32(buf, tap_pos, len, val);
2114 static void jlink_queue_data_out(const uint8_t *data, uint32_t len)
2116 const uint32_t dir_out = 0xffffffff;
2119 bit_copy(tdi_buffer, tap_length, data, 0, len);
2121 fill_buffer(tdi_buffer, 0, len);
2123 fill_buffer(tms_buffer, dir_out, len);
2127 static void jlink_queue_data_in(uint32_t len)
2129 const uint32_t dir_in = 0;
2131 fill_buffer(tms_buffer, dir_in, len);
2135 static int jlink_swd_switch_seq(enum swd_special_seq seq)
2142 LOG_DEBUG("SWD line reset");
2143 s = swd_seq_line_reset;
2144 s_len = swd_seq_line_reset_len;
2147 LOG_DEBUG("JTAG-to-SWD");
2148 s = swd_seq_jtag_to_swd;
2149 s_len = swd_seq_jtag_to_swd_len;
2152 LOG_DEBUG("SWD-to-JTAG");
2153 s = swd_seq_swd_to_jtag;
2154 s_len = swd_seq_swd_to_jtag_len;
2157 LOG_ERROR("Sequence %d not supported", seq);
2161 jlink_queue_data_out(s, s_len);
2166 static int jlink_swd_run_queue(void)
2171 LOG_DEBUG("Executing %d queued transactions", pending_scan_results_length);
2173 if (queued_retval != ERROR_OK) {
2174 LOG_DEBUG("Skipping due to previous errors: %d", queued_retval);
2179 * A transaction must be followed by another transaction or at least 8 idle
2180 * cycles to ensure that data is clocked through the AP.
2182 jlink_queue_data_out(NULL, 8);
2184 ret = jaylink_swd_io(devh, tms_buffer, tdi_buffer, tdo_buffer, tap_length);
2186 if (ret != JAYLINK_OK) {
2187 LOG_ERROR("jaylink_swd_io() failed: %s", jaylink_strerror(ret));
2191 for (i = 0; i < pending_scan_results_length; i++) {
2192 int ack = buf_get_u32(tdo_buffer, pending_scan_results_buffer[i].first, 3);
2194 if (ack != SWD_ACK_OK) {
2195 LOG_DEBUG("SWD ack not OK: %d %s", ack,
2196 ack == SWD_ACK_WAIT ? "WAIT" : ack == SWD_ACK_FAULT ? "FAULT" : "JUNK");
2197 queued_retval = ack == SWD_ACK_WAIT ? ERROR_WAIT : ERROR_FAIL;
2199 } else if (pending_scan_results_buffer[i].length) {
2200 uint32_t data = buf_get_u32(tdo_buffer, 3 + pending_scan_results_buffer[i].first, 32);
2201 int parity = buf_get_u32(tdo_buffer, 3 + 32 + pending_scan_results_buffer[i].first, 1);
2203 if (parity != parity_u32(data)) {
2204 LOG_ERROR("SWD: Read data parity mismatch");
2205 queued_retval = ERROR_FAIL;
2209 if (pending_scan_results_buffer[i].buffer)
2210 *(uint32_t *)pending_scan_results_buffer[i].buffer = data;
2216 ret = queued_retval;
2217 queued_retval = ERROR_OK;
2222 static void jlink_swd_queue_cmd(uint8_t cmd, uint32_t *dst, uint32_t data, uint32_t ap_delay_clk)
2224 uint8_t data_parity_trn[DIV_ROUND_UP(32 + 1, 8)];
2225 if (tap_length + 46 + 8 + ap_delay_clk >= swd_buffer_size * 8 ||
2226 pending_scan_results_length == MAX_PENDING_SCAN_RESULTS) {
2227 /* Not enough room in the queue. Run the queue. */
2228 queued_retval = jlink_swd_run_queue();
2231 if (queued_retval != ERROR_OK)
2234 cmd |= SWD_CMD_START | SWD_CMD_PARK;
2236 jlink_queue_data_out(&cmd, 8);
2238 pending_scan_results_buffer[pending_scan_results_length].first = tap_length;
2240 if (cmd & SWD_CMD_RnW) {
2241 /* Queue a read transaction. */
2242 pending_scan_results_buffer[pending_scan_results_length].length = 32;
2243 pending_scan_results_buffer[pending_scan_results_length].buffer = dst;
2245 jlink_queue_data_in(1 + 3 + 32 + 1 + 1);
2247 /* Queue a write transaction. */
2248 pending_scan_results_buffer[pending_scan_results_length].length = 0;
2249 jlink_queue_data_in(1 + 3 + 1);
2251 buf_set_u32(data_parity_trn, 0, 32, data);
2252 buf_set_u32(data_parity_trn, 32, 1, parity_u32(data));
2254 jlink_queue_data_out(data_parity_trn, 32 + 1);
2257 pending_scan_results_length++;
2259 /* Insert idle cycles after AP accesses to avoid WAIT. */
2260 if (cmd & SWD_CMD_APnDP)
2261 jlink_queue_data_out(NULL, ap_delay_clk);
2264 static const struct swd_driver jlink_swd = {
2265 .init = &jlink_swd_init,
2266 .switch_seq = &jlink_swd_switch_seq,
2267 .read_reg = &jlink_swd_read_reg,
2268 .write_reg = &jlink_swd_write_reg,
2269 .run = &jlink_swd_run_queue,
2272 static const char * const jlink_transports[] = { "jtag", "swd", NULL };
2274 static struct jtag_interface jlink_interface = {
2275 .execute_queue = &jlink_execute_queue,
2278 struct adapter_driver jlink_adapter_driver = {
2280 .transports = jlink_transports,
2281 .commands = jlink_command_handlers,
2283 .init = &jlink_init,
2284 .quit = &jlink_quit,
2285 .reset = &jlink_reset_safe,
2286 .speed = &jlink_speed,
2288 .speed_div = &jlink_speed_div,
2289 .config_trace = &config_trace,
2290 .poll_trace = &poll_trace,
2292 .jtag_ops = &jlink_interface,
2293 .swd_ops = &jlink_swd,