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>
42 #include <libjaylink/libjaylink.h>
44 static struct jaylink_context
*jayctx
;
45 static struct jaylink_device_handle
*devh
;
46 static struct jaylink_connection conn
;
47 static struct jaylink_connection connlist
[JAYLINK_MAX_CONNECTIONS
];
48 static enum jaylink_jtag_version jtag_command_version
;
49 static uint8_t caps
[JAYLINK_DEV_EXT_CAPS_SIZE
];
51 static uint32_t serial_number
;
52 static bool use_serial_number
;
53 static enum jaylink_usb_address usb_address
;
54 static bool use_usb_address
;
55 static enum jaylink_target_interface iface
= JAYLINK_TIF_JTAG
;
56 static bool trace_enabled
;
58 #define JLINK_MAX_SPEED 12000
59 #define JLINK_TAP_BUFFER_SIZE 2048
61 static unsigned int swd_buffer_size
= JLINK_TAP_BUFFER_SIZE
;
63 /* 256 byte non-volatile memory */
64 struct device_config
{
66 /* 0ffset 0x01 to 0x03 */
67 uint8_t reserved_1
[3];
68 uint32_t target_power
;
69 /* 0ffset 0x08 to 0x1f */
70 uint8_t reserved_2
[24];
71 /* IP only for J-Link Pro */
72 uint8_t ip_address
[4];
73 uint8_t subnet_mask
[4];
74 /* 0ffset 0x28 to 0x2f */
75 uint8_t reserved_3
[8];
76 uint8_t mac_address
[6];
77 /* 0ffset 0x36 to 0xff */
78 uint8_t reserved_4
[202];
79 } __attribute__ ((packed
));
81 static struct device_config config
;
82 static struct device_config tmp_config
;
84 /* Queue command functions */
85 static void jlink_end_state(tap_state_t state
);
86 static void jlink_state_move(void);
87 static void jlink_path_move(int num_states
, tap_state_t
*path
);
88 static void jlink_stableclocks(int num_cycles
);
89 static void jlink_runtest(int num_cycles
);
90 static void jlink_reset(int trst
, int srst
);
91 static int jlink_swd_run_queue(void);
92 static void jlink_swd_queue_cmd(uint8_t cmd
, uint32_t *dst
, uint32_t data
, uint32_t ap_delay_clk
);
93 static int jlink_swd_switch_seq(enum swd_special_seq seq
);
95 /* J-Link tap buffer functions */
96 static void jlink_tap_init(void);
97 static int jlink_flush(void);
99 * Queue data to go out and in, flushing the queue as many times as
102 * @param out A pointer to TDI data, if NULL, old stale data will be used.
103 * @param out_offset A bit offset for TDI data.
104 * @param tms_out A pointer to TMS data, if NULL, zeroes will be emitted.
105 * @param tms_offset A bit offset for TMS data.
106 * @param in A pointer to store TDO data to, if NULL the data will be discarded.
107 * @param in_offset A bit offset for TDO data.
108 * @param length Amount of bits to transfer out and in.
110 * @retval This function doesn't return any value.
112 static void jlink_clock_data(const uint8_t *out
, unsigned out_offset
,
113 const uint8_t *tms_out
, unsigned tms_offset
,
114 uint8_t *in
, unsigned in_offset
,
117 static enum tap_state jlink_last_state
= TAP_RESET
;
118 static int queued_retval
;
120 /***************************************************************************/
121 /* External interface implementation */
123 static void jlink_execute_stableclocks(struct jtag_command
*cmd
)
125 DEBUG_JTAG_IO("stableclocks %i cycles", cmd
->cmd
.runtest
->num_cycles
);
126 jlink_stableclocks(cmd
->cmd
.runtest
->num_cycles
);
129 static void jlink_execute_runtest(struct jtag_command
*cmd
)
131 DEBUG_JTAG_IO("runtest %i cycles, end in %i", cmd
->cmd
.runtest
->num_cycles
,
132 cmd
->cmd
.runtest
->end_state
);
134 jlink_end_state(cmd
->cmd
.runtest
->end_state
);
135 jlink_runtest(cmd
->cmd
.runtest
->num_cycles
);
138 static void jlink_execute_statemove(struct jtag_command
*cmd
)
140 DEBUG_JTAG_IO("statemove end in %i", cmd
->cmd
.statemove
->end_state
);
142 jlink_end_state(cmd
->cmd
.statemove
->end_state
);
146 static void jlink_execute_pathmove(struct jtag_command
*cmd
)
148 DEBUG_JTAG_IO("pathmove: %i states, end in %i",
149 cmd
->cmd
.pathmove
->num_states
,
150 cmd
->cmd
.pathmove
->path
[cmd
->cmd
.pathmove
->num_states
- 1]);
152 jlink_path_move(cmd
->cmd
.pathmove
->num_states
, cmd
->cmd
.pathmove
->path
);
155 static void jlink_execute_scan(struct jtag_command
*cmd
)
157 DEBUG_JTAG_IO("%s type:%d", cmd
->cmd
.scan
->ir_scan
? "IRSCAN" : "DRSCAN",
158 jtag_scan_type(cmd
->cmd
.scan
));
160 /* Make sure there are no trailing fields with num_bits == 0, or the logic below will fail. */
161 while (cmd
->cmd
.scan
->num_fields
> 0
162 && cmd
->cmd
.scan
->fields
[cmd
->cmd
.scan
->num_fields
- 1].num_bits
== 0) {
163 cmd
->cmd
.scan
->num_fields
--;
164 LOG_DEBUG("discarding trailing empty field");
167 if (cmd
->cmd
.scan
->num_fields
== 0) {
168 LOG_DEBUG("empty scan, doing nothing");
172 if (cmd
->cmd
.scan
->ir_scan
) {
173 if (tap_get_state() != TAP_IRSHIFT
) {
174 jlink_end_state(TAP_IRSHIFT
);
178 if (tap_get_state() != TAP_DRSHIFT
) {
179 jlink_end_state(TAP_DRSHIFT
);
184 jlink_end_state(cmd
->cmd
.scan
->end_state
);
186 struct scan_field
*field
= cmd
->cmd
.scan
->fields
;
187 unsigned scan_size
= 0;
189 for (int i
= 0; i
< cmd
->cmd
.scan
->num_fields
; i
++, field
++) {
190 scan_size
+= field
->num_bits
;
191 DEBUG_JTAG_IO("%s%s field %d/%d %d bits",
192 field
->in_value
? "in" : "",
193 field
->out_value
? "out" : "",
195 cmd
->cmd
.scan
->num_fields
,
198 if (i
== cmd
->cmd
.scan
->num_fields
- 1 && tap_get_state() != tap_get_end_state()) {
199 /* Last field, and we're leaving IRSHIFT/DRSHIFT. Clock last bit during tap
200 * movement. This last field can't have length zero, it was checked above. */
201 jlink_clock_data(field
->out_value
,
207 field
->num_bits
- 1);
208 uint8_t last_bit
= 0;
209 if (field
->out_value
)
210 bit_copy(&last_bit
, 0, field
->out_value
, field
->num_bits
- 1, 1);
211 uint8_t tms_bits
= 0x01;
212 jlink_clock_data(&last_bit
,
219 tap_set_state(tap_state_transition(tap_get_state(), 1));
220 jlink_clock_data(NULL
,
227 tap_set_state(tap_state_transition(tap_get_state(), 0));
229 jlink_clock_data(field
->out_value
,
238 if (tap_get_state() != tap_get_end_state()) {
239 jlink_end_state(tap_get_end_state());
243 DEBUG_JTAG_IO("%s scan, %i bits, end in %s",
244 (cmd
->cmd
.scan
->ir_scan
) ? "IR" : "DR", scan_size
,
245 tap_state_name(tap_get_end_state()));
248 static void jlink_execute_reset(struct jtag_command
*cmd
)
250 DEBUG_JTAG_IO("reset trst: %i srst %i", cmd
->cmd
.reset
->trst
,
251 cmd
->cmd
.reset
->srst
);
254 jlink_reset(cmd
->cmd
.reset
->trst
, cmd
->cmd
.reset
->srst
);
258 static void jlink_execute_sleep(struct jtag_command
*cmd
)
260 DEBUG_JTAG_IO("sleep %" PRIi32
"", cmd
->cmd
.sleep
->us
);
262 jtag_sleep(cmd
->cmd
.sleep
->us
);
265 static int jlink_execute_command(struct jtag_command
*cmd
)
268 case JTAG_STABLECLOCKS
:
269 jlink_execute_stableclocks(cmd
);
272 jlink_execute_runtest(cmd
);
275 jlink_execute_statemove(cmd
);
278 jlink_execute_pathmove(cmd
);
281 jlink_execute_scan(cmd
);
284 jlink_execute_reset(cmd
);
287 jlink_execute_sleep(cmd
);
290 LOG_ERROR("BUG: Unknown JTAG command type encountered.");
291 return ERROR_JTAG_QUEUE_FAILED
;
297 static int jlink_execute_queue(void)
300 struct jtag_command
*cmd
= jtag_command_queue
;
302 while (cmd
!= NULL
) {
303 ret
= jlink_execute_command(cmd
);
311 return jlink_flush();
314 static int jlink_speed(int speed
)
317 struct jaylink_speed tmp
;
320 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_SPEEDS
)) {
321 ret
= jaylink_get_speeds(devh
, &tmp
);
323 if (ret
!= JAYLINK_OK
) {
324 LOG_ERROR("jaylink_get_speeds() failed: %s.",
325 jaylink_strerror(ret
));
326 return ERROR_JTAG_DEVICE_ERROR
;
330 max_speed
= tmp
.freq
/ tmp
.div
;
332 max_speed
= JLINK_MAX_SPEED
;
336 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_ADAPTIVE_CLOCKING
)) {
337 LOG_ERROR("Adaptive clocking is not supported by the device.");
338 return ERROR_JTAG_NOT_IMPLEMENTED
;
341 speed
= JAYLINK_SPEED_ADAPTIVE_CLOCKING
;
342 } else if (speed
> max_speed
) {
343 LOG_INFO("Reduced speed from %d kHz to %d kHz (maximum).", speed
,
348 ret
= jaylink_set_speed(devh
, speed
);
350 if (ret
!= JAYLINK_OK
) {
351 LOG_ERROR("jaylink_set_speed() failed: %s.",
352 jaylink_strerror(ret
));
353 return ERROR_JTAG_DEVICE_ERROR
;
359 static int jlink_speed_div(int speed
, int *khz
)
366 static int jlink_khz(int khz
, int *jtag_speed
)
373 static bool read_device_config(struct device_config
*cfg
)
377 ret
= jaylink_read_raw_config(devh
, (uint8_t *)cfg
);
379 if (ret
!= JAYLINK_OK
) {
380 LOG_ERROR("jaylink_read_raw_config() failed: %s.",
381 jaylink_strerror(ret
));
385 if (cfg
->usb_address
== 0xff)
386 cfg
->usb_address
= 0x00;
388 if (cfg
->target_power
== 0xffffffff)
389 cfg
->target_power
= 0;
394 static int select_interface(void)
399 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SELECT_TIF
)) {
400 if (iface
!= JAYLINK_TIF_JTAG
) {
401 LOG_ERROR("Device supports JTAG transport only.");
402 return ERROR_JTAG_INIT_FAILED
;
408 ret
= jaylink_get_available_interfaces(devh
, &interfaces
);
410 if (ret
!= JAYLINK_OK
) {
411 LOG_ERROR("jaylink_get_available_interfaces() failed: %s.",
412 jaylink_strerror(ret
));
413 return ERROR_JTAG_INIT_FAILED
;
416 if (!(interfaces
& (1 << iface
))) {
417 LOG_ERROR("Selected transport is not supported by the device.");
418 return ERROR_JTAG_INIT_FAILED
;
421 ret
= jaylink_select_interface(devh
, iface
, NULL
);
424 LOG_ERROR("jaylink_select_interface() failed: %s.",
425 jaylink_strerror(ret
));
426 return ERROR_JTAG_INIT_FAILED
;
432 static int jlink_register(void)
439 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_REGISTER
))
442 ret
= jaylink_register(devh
, &conn
, connlist
, &count
);
444 if (ret
!= JAYLINK_OK
) {
445 LOG_ERROR("jaylink_register() failed: %s.", jaylink_strerror(ret
));
449 handle_found
= false;
451 for (i
= 0; i
< count
; i
++) {
452 if (connlist
[i
].handle
== conn
.handle
) {
459 LOG_ERROR("Registration failed: maximum number of connections on the "
468 * Adjust the SWD transaction buffer size depending on the free device internal
469 * memory. This ensures that the SWD transactions sent to the device do not
470 * exceed the internal memory of the device.
472 static bool adjust_swd_buffer_size(void)
477 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_FREE_MEMORY
))
480 ret
= jaylink_get_free_memory(devh
, &tmp
);
482 if (ret
!= JAYLINK_OK
) {
483 LOG_ERROR("jaylink_get_free_memory() failed: %s.",
484 jaylink_strerror(ret
));
489 LOG_ERROR("Not enough free device internal memory: %u bytes.", tmp
);
493 tmp
= MIN(JLINK_TAP_BUFFER_SIZE
, (tmp
- 16) / 2);
495 if (tmp
!= swd_buffer_size
) {
496 swd_buffer_size
= tmp
;
497 LOG_DEBUG("Adjusted SWD transaction buffer size to %u bytes.",
504 static int jaylink_log_handler(const struct jaylink_context
*ctx
,
505 enum jaylink_log_level level
, const char *format
, va_list args
,
511 case JAYLINK_LOG_LEVEL_ERROR
:
514 case JAYLINK_LOG_LEVEL_WARNING
:
515 tmp
= LOG_LVL_WARNING
;
518 * Forward info messages to the debug output because they are more verbose
519 * than info messages of OpenOCD.
521 case JAYLINK_LOG_LEVEL_INFO
:
522 case JAYLINK_LOG_LEVEL_DEBUG
:
525 case JAYLINK_LOG_LEVEL_DEBUG_IO
:
526 tmp
= LOG_LVL_DEBUG_IO
;
529 tmp
= LOG_LVL_WARNING
;
532 log_vprintf_lf(tmp
, __FILE__
, __LINE__
, __func__
, format
, args
);
537 static int jlink_init(void)
540 struct jaylink_device
**devs
;
544 char *firmware_version
;
545 struct jaylink_hardware_version hwver
;
546 struct jaylink_hardware_status hwstatus
;
547 enum jaylink_usb_address address
;
550 uint32_t host_interfaces
;
552 LOG_DEBUG("Using libjaylink %s (compiled with %s).",
553 jaylink_version_package_get_string(), JAYLINK_VERSION_PACKAGE_STRING
);
555 if (!jaylink_library_has_cap(JAYLINK_CAP_HIF_USB
) && use_usb_address
) {
556 LOG_ERROR("J-Link driver does not support USB devices.");
557 return ERROR_JTAG_INIT_FAILED
;
560 ret
= jaylink_init(&jayctx
);
562 if (ret
!= JAYLINK_OK
) {
563 LOG_ERROR("jaylink_init() failed: %s.", jaylink_strerror(ret
));
564 return ERROR_JTAG_INIT_FAILED
;
567 ret
= jaylink_log_set_callback(jayctx
, &jaylink_log_handler
, NULL
);
569 if (ret
!= JAYLINK_OK
) {
570 LOG_ERROR("jaylink_log_set_callback() failed: %s.",
571 jaylink_strerror(ret
));
572 jaylink_exit(jayctx
);
573 return ERROR_JTAG_INIT_FAILED
;
576 host_interfaces
= JAYLINK_HIF_USB
;
578 if (use_serial_number
)
579 host_interfaces
|= JAYLINK_HIF_TCP
;
581 ret
= jaylink_discovery_scan(jayctx
, host_interfaces
);
583 if (ret
!= JAYLINK_OK
) {
584 LOG_ERROR("jaylink_discovery_scan() failed: %s.",
585 jaylink_strerror(ret
));
586 jaylink_exit(jayctx
);
587 return ERROR_JTAG_INIT_FAILED
;
590 ret
= jaylink_get_devices(jayctx
, &devs
, &num_devices
);
592 if (ret
!= JAYLINK_OK
) {
593 LOG_ERROR("jaylink_get_devices() failed: %s.", jaylink_strerror(ret
));
594 jaylink_exit(jayctx
);
595 return ERROR_JTAG_INIT_FAILED
;
598 if (!use_serial_number
&& !use_usb_address
&& num_devices
> 1) {
599 LOG_ERROR("Multiple devices found, specify the desired device.");
600 jaylink_free_devices(devs
, true);
601 jaylink_exit(jayctx
);
602 return ERROR_JTAG_INIT_FAILED
;
605 found_device
= false;
607 for (i
= 0; devs
[i
]; i
++) {
608 if (use_serial_number
) {
609 ret
= jaylink_device_get_serial_number(devs
[i
], &tmp
);
611 if (ret
== JAYLINK_ERR_NOT_AVAILABLE
) {
613 } else if (ret
!= JAYLINK_OK
) {
614 LOG_WARNING("jaylink_device_get_serial_number() failed: %s.",
615 jaylink_strerror(ret
));
619 if (serial_number
!= tmp
)
623 if (use_usb_address
) {
624 ret
= jaylink_device_get_usb_address(devs
[i
], &address
);
626 if (ret
== JAYLINK_ERR_NOT_SUPPORTED
) {
628 } else if (ret
!= JAYLINK_OK
) {
629 LOG_WARNING("jaylink_device_get_usb_address() failed: %s.",
630 jaylink_strerror(ret
));
634 if (usb_address
!= address
)
638 ret
= jaylink_open(devs
[i
], &devh
);
640 if (ret
== JAYLINK_OK
) {
645 LOG_ERROR("Failed to open device: %s.", jaylink_strerror(ret
));
648 jaylink_free_devices(devs
, true);
651 LOG_ERROR("No J-Link device found.");
652 jaylink_exit(jayctx
);
653 return ERROR_JTAG_INIT_FAILED
;
657 * Be careful with changing the following initialization sequence because
658 * some devices are known to be sensitive regarding the order.
661 ret
= jaylink_get_firmware_version(devh
, &firmware_version
, &length
);
663 if (ret
!= JAYLINK_OK
) {
664 LOG_ERROR("jaylink_get_firmware_version() failed: %s.",
665 jaylink_strerror(ret
));
667 jaylink_exit(jayctx
);
668 return ERROR_JTAG_INIT_FAILED
;
669 } else if (length
> 0) {
670 LOG_INFO("%s", firmware_version
);
671 free(firmware_version
);
673 LOG_WARNING("Device responds empty firmware version string.");
676 memset(caps
, 0, JAYLINK_DEV_EXT_CAPS_SIZE
);
677 ret
= jaylink_get_caps(devh
, caps
);
679 if (ret
!= JAYLINK_OK
) {
680 LOG_ERROR("jaylink_get_caps() failed: %s.", jaylink_strerror(ret
));
682 jaylink_exit(jayctx
);
683 return ERROR_JTAG_INIT_FAILED
;
686 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_EXT_CAPS
)) {
687 ret
= jaylink_get_extended_caps(devh
, caps
);
689 if (ret
!= JAYLINK_OK
) {
690 LOG_ERROR("jaylink_get_extended_caps() failed: %s.",
691 jaylink_strerror(ret
));
693 jaylink_exit(jayctx
);
694 return ERROR_JTAG_INIT_FAILED
;
698 jtag_command_version
= JAYLINK_JTAG_VERSION_2
;
700 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_HW_VERSION
)) {
701 ret
= jaylink_get_hardware_version(devh
, &hwver
);
703 if (ret
!= JAYLINK_OK
) {
704 LOG_ERROR("Failed to retrieve hardware version: %s.",
705 jaylink_strerror(ret
));
707 jaylink_exit(jayctx
);
708 return ERROR_JTAG_INIT_FAILED
;
711 LOG_INFO("Hardware version: %u.%02u", hwver
.major
, hwver
.minor
);
713 if (hwver
.major
>= 5)
714 jtag_command_version
= JAYLINK_JTAG_VERSION_3
;
717 if (iface
== JAYLINK_TIF_SWD
) {
719 * Adjust the SWD transaction buffer size in case there is already
720 * allocated memory on the device. This happens for example if the
721 * memory for SWO capturing is still allocated because the software
722 * which used the device before has not been shut down properly.
724 if (!adjust_swd_buffer_size()) {
726 jaylink_exit(jayctx
);
727 return ERROR_JTAG_INIT_FAILED
;
731 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
732 if (!read_device_config(&config
)) {
733 LOG_ERROR("Failed to read device configuration data.");
735 jaylink_exit(jayctx
);
736 return ERROR_JTAG_INIT_FAILED
;
739 memcpy(&tmp_config
, &config
, sizeof(struct device_config
));
742 ret
= jaylink_get_hardware_status(devh
, &hwstatus
);
744 if (ret
!= JAYLINK_OK
) {
745 LOG_ERROR("jaylink_get_hardware_status() failed: %s.",
746 jaylink_strerror(ret
));
748 jaylink_exit(jayctx
);
749 return ERROR_JTAG_INIT_FAILED
;
752 LOG_INFO("VTarget = %u.%03u V", hwstatus
.target_voltage
/ 1000,
753 hwstatus
.target_voltage
% 1000);
757 strcpy(conn
.hid
, "0.0.0.0");
761 ret
= jlink_register();
763 if (ret
!= ERROR_OK
) {
765 jaylink_exit(jayctx
);
766 return ERROR_JTAG_INIT_FAILED
;
769 ret
= select_interface();
771 if (ret
!= ERROR_OK
) {
773 jaylink_exit(jayctx
);
781 jlink_speed(jtag_get_speed_khz());
783 if (iface
== JAYLINK_TIF_JTAG
) {
785 * J-Link devices with firmware version v5 and v6 seems to have an issue
786 * if the first tap move is not divisible by 8, so we send a TLR on
790 jlink_clock_data(NULL
, 0, &tms
, 0, NULL
, 0, 8);
798 static int jlink_quit(void)
804 ret
= jaylink_swo_stop(devh
);
806 if (ret
!= JAYLINK_OK
)
807 LOG_ERROR("jaylink_swo_stop() failed: %s.", jaylink_strerror(ret
));
810 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_REGISTER
)) {
811 ret
= jaylink_unregister(devh
, &conn
, connlist
, &count
);
813 if (ret
!= JAYLINK_OK
)
814 LOG_ERROR("jaylink_unregister() failed: %s.",
815 jaylink_strerror(ret
));
819 jaylink_exit(jayctx
);
824 /***************************************************************************/
825 /* Queue command implementations */
827 static void jlink_end_state(tap_state_t state
)
829 if (tap_is_state_stable(state
))
830 tap_set_end_state(state
);
832 LOG_ERROR("BUG: %i is not a valid end state", state
);
837 /* Goes to the end state. */
838 static void jlink_state_move(void)
841 uint8_t tms_scan_bits
;
843 tms_scan
= tap_get_tms_path(tap_get_state(), tap_get_end_state());
844 tms_scan_bits
= tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
846 jlink_clock_data(NULL
, 0, &tms_scan
, 0, NULL
, 0, tms_scan_bits
);
848 tap_set_state(tap_get_end_state());
851 static void jlink_path_move(int num_states
, tap_state_t
*path
)
856 for (i
= 0; i
< num_states
; i
++) {
857 if (path
[i
] == tap_state_transition(tap_get_state(), false))
858 jlink_clock_data(NULL
, 0, NULL
, 0, NULL
, 0, 1);
859 else if (path
[i
] == tap_state_transition(tap_get_state(), true))
860 jlink_clock_data(NULL
, 0, &tms
, 0, NULL
, 0, 1);
862 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition.",
863 tap_state_name(tap_get_state()), tap_state_name(path
[i
]));
867 tap_set_state(path
[i
]);
870 tap_set_end_state(tap_get_state());
873 static void jlink_stableclocks(int num_cycles
)
877 uint8_t tms
= tap_get_state() == TAP_RESET
;
878 /* Execute num_cycles. */
879 for (i
= 0; i
< num_cycles
; i
++)
880 jlink_clock_data(NULL
, 0, &tms
, 0, NULL
, 0, 1);
883 static void jlink_runtest(int num_cycles
)
885 tap_state_t saved_end_state
= tap_get_end_state();
887 /* Only do a state_move when we're not already in IDLE. */
888 if (tap_get_state() != TAP_IDLE
) {
889 jlink_end_state(TAP_IDLE
);
894 jlink_stableclocks(num_cycles
);
896 /* Finish in end_state. */
897 jlink_end_state(saved_end_state
);
899 if (tap_get_state() != tap_get_end_state())
903 static void jlink_reset(int trst
, int srst
)
905 LOG_DEBUG("TRST: %i, SRST: %i.", trst
, srst
);
907 /* Signals are active low. */
909 jaylink_set_reset(devh
);
912 jaylink_clear_reset(devh
);
915 jaylink_jtag_clear_trst(devh
);
918 jaylink_jtag_set_trst(devh
);
921 COMMAND_HANDLER(jlink_usb_command
)
926 command_print(CMD_CTX
, "Need exactly one argument for jlink usb.");
927 return ERROR_COMMAND_SYNTAX_ERROR
;
930 if (sscanf(CMD_ARGV
[0], "%i", &tmp
) != 1) {
931 command_print(CMD_CTX
, "Invalid USB address: %s.", CMD_ARGV
[0]);
935 if (tmp
< JAYLINK_USB_ADDRESS_0
|| tmp
> JAYLINK_USB_ADDRESS_3
) {
936 command_print(CMD_CTX
, "Invalid USB address: %s.", CMD_ARGV
[0]);
942 use_serial_number
= false;
943 use_usb_address
= true;
948 COMMAND_HANDLER(jlink_serial_command
)
953 command_print(CMD_CTX
, "Need exactly one argument for jlink serial.");
954 return ERROR_COMMAND_SYNTAX_ERROR
;
957 ret
= jaylink_parse_serial_number(CMD_ARGV
[0], &serial_number
);
959 if (ret
== JAYLINK_ERR
) {
960 command_print(CMD_CTX
, "Invalid serial number: %s.", CMD_ARGV
[0]);
962 } else if (ret
!= JAYLINK_OK
) {
963 command_print(CMD_CTX
, "jaylink_parse_serial_number() failed: %s.",
964 jaylink_strerror(ret
));
968 use_serial_number
= true;
969 use_usb_address
= false;
974 COMMAND_HANDLER(jlink_handle_hwstatus_command
)
977 struct jaylink_hardware_status status
;
979 ret
= jaylink_get_hardware_status(devh
, &status
);
981 if (ret
!= JAYLINK_OK
) {
982 command_print(CMD_CTX
, "jaylink_get_hardware_status() failed: %s.",
983 jaylink_strerror(ret
));
987 command_print(CMD_CTX
, "VTarget = %u.%03u V",
988 status
.target_voltage
/ 1000, status
.target_voltage
% 1000);
990 command_print(CMD_CTX
, "TCK = %u TDI = %u TDO = %u TMS = %u SRST = %u "
991 "TRST = %u", status
.tck
, status
.tdi
, status
.tdo
, status
.tms
,
992 status
.tres
, status
.trst
);
994 if (status
.target_voltage
< 1500)
995 command_print(CMD_CTX
, "Target voltage too low. Check target power.");
1000 COMMAND_HANDLER(jlink_handle_free_memory_command
)
1005 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_FREE_MEMORY
)) {
1006 command_print(CMD_CTX
, "Retrieval of free memory is not supported by "
1011 ret
= jaylink_get_free_memory(devh
, &tmp
);
1013 if (ret
!= JAYLINK_OK
) {
1014 command_print(CMD_CTX
, "jaylink_get_free_memory() failed: %s.",
1015 jaylink_strerror(ret
));
1019 command_print(CMD_CTX
, "Device has %u bytes of free memory.", tmp
);
1024 COMMAND_HANDLER(jlink_handle_jlink_jtag_command
)
1030 switch (jtag_command_version
) {
1031 case JAYLINK_JTAG_VERSION_2
:
1034 case JAYLINK_JTAG_VERSION_3
:
1041 command_print(CMD_CTX
, "JTAG command version: %i", version
);
1042 } else if (CMD_ARGC
== 1) {
1043 if (sscanf(CMD_ARGV
[0], "%i", &tmp
) != 1) {
1044 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
1045 return ERROR_COMMAND_SYNTAX_ERROR
;
1050 jtag_command_version
= JAYLINK_JTAG_VERSION_2
;
1053 jtag_command_version
= JAYLINK_JTAG_VERSION_3
;
1056 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
1057 return ERROR_COMMAND_SYNTAX_ERROR
;
1060 command_print(CMD_CTX
, "Need exactly one argument for jlink jtag.");
1061 return ERROR_COMMAND_SYNTAX_ERROR
;
1067 COMMAND_HANDLER(jlink_handle_target_power_command
)
1072 if (CMD_ARGC
!= 1) {
1073 command_print(CMD_CTX
, "Need exactly one argument for jlink "
1075 return ERROR_COMMAND_SYNTAX_ERROR
;
1078 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SET_TARGET_POWER
)) {
1079 command_print(CMD_CTX
, "Target power supply is not supported by the "
1084 if (!strcmp(CMD_ARGV
[0], "on")) {
1086 } else if (!strcmp(CMD_ARGV
[0], "off")) {
1089 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
1093 ret
= jaylink_set_target_power(devh
, enable
);
1095 if (ret
!= JAYLINK_OK
) {
1096 command_print(CMD_CTX
, "jaylink_set_target_power() failed: %s.",
1097 jaylink_strerror(ret
));
1104 static void show_config_usb_address(struct command_context
*ctx
)
1106 if (config
.usb_address
!= tmp_config
.usb_address
)
1107 command_print(ctx
, "USB address: %u [%u]", config
.usb_address
,
1108 tmp_config
.usb_address
);
1110 command_print(ctx
, "USB address: %u", config
.usb_address
);
1113 static void show_config_ip_address(struct command_context
*ctx
)
1115 if (!memcmp(config
.ip_address
, tmp_config
.ip_address
, 4))
1116 command_print(ctx
, "IP address: %d.%d.%d.%d",
1117 config
.ip_address
[3], config
.ip_address
[2],
1118 config
.ip_address
[1], config
.ip_address
[0]);
1120 command_print(ctx
, "IP address: %d.%d.%d.%d [%d.%d.%d.%d]",
1121 config
.ip_address
[3], config
.ip_address
[2],
1122 config
.ip_address
[1], config
.ip_address
[0],
1123 tmp_config
.ip_address
[3], tmp_config
.ip_address
[2],
1124 tmp_config
.ip_address
[1], tmp_config
.ip_address
[0]);
1126 if (!memcmp(config
.subnet_mask
, tmp_config
.subnet_mask
, 4))
1127 command_print(ctx
, "Subnet mask: %d.%d.%d.%d",
1128 config
.subnet_mask
[3], config
.subnet_mask
[2],
1129 config
.subnet_mask
[1], config
.subnet_mask
[0]);
1131 command_print(ctx
, "Subnet mask: %d.%d.%d.%d [%d.%d.%d.%d]",
1132 config
.subnet_mask
[3], config
.subnet_mask
[2],
1133 config
.subnet_mask
[1], config
.subnet_mask
[0],
1134 tmp_config
.subnet_mask
[3], tmp_config
.subnet_mask
[2],
1135 tmp_config
.subnet_mask
[1], tmp_config
.subnet_mask
[0]);
1138 static void show_config_mac_address(struct command_context
*ctx
)
1140 if (!memcmp(config
.mac_address
, tmp_config
.mac_address
, 6))
1141 command_print(ctx
, "MAC address: %.02x:%.02x:%.02x:%.02x:%.02x:%.02x",
1142 config
.mac_address
[5], config
.mac_address
[4],
1143 config
.mac_address
[3], config
.mac_address
[2],
1144 config
.mac_address
[1], config
.mac_address
[0]);
1146 command_print(ctx
, "MAC address: %.02x:%.02x:%.02x:%.02x:%.02x:%.02x "
1147 "[%.02x:%.02x:%.02x:%.02x:%.02x:%.02x]",
1148 config
.mac_address
[5], config
.mac_address
[4],
1149 config
.mac_address
[3], config
.mac_address
[2],
1150 config
.mac_address
[1], config
.mac_address
[0],
1151 tmp_config
.mac_address
[5], tmp_config
.mac_address
[4],
1152 tmp_config
.mac_address
[3], tmp_config
.mac_address
[2],
1153 tmp_config
.mac_address
[1], tmp_config
.mac_address
[0]);
1156 static void show_config_target_power(struct command_context
*ctx
)
1158 const char *target_power
;
1159 const char *current_target_power
;
1161 if (!config
.target_power
)
1162 target_power
= "off";
1164 target_power
= "on";
1166 if (!tmp_config
.target_power
)
1167 current_target_power
= "off";
1169 current_target_power
= "on";
1171 if (config
.target_power
!= tmp_config
.target_power
)
1172 command_print(ctx
, "Target power supply: %s [%s]", target_power
,
1173 current_target_power
);
1175 command_print(ctx
, "Target power supply: %s", target_power
);
1178 static void show_config(struct command_context
*ctx
)
1180 command_print(ctx
, "J-Link device configuration:");
1182 show_config_usb_address(ctx
);
1184 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SET_TARGET_POWER
))
1185 show_config_target_power(ctx
);
1187 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_ETHERNET
)) {
1188 show_config_ip_address(ctx
);
1189 show_config_mac_address(ctx
);
1193 static int poll_trace(uint8_t *buf
, size_t *size
)
1200 ret
= jaylink_swo_read(devh
, buf
, &length
);
1202 if (ret
!= JAYLINK_OK
) {
1203 LOG_ERROR("jaylink_swo_read() failed: %s.", jaylink_strerror(ret
));
1212 static uint32_t calculate_trace_buffer_size(void)
1217 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_FREE_MEMORY
))
1220 ret
= jaylink_get_free_memory(devh
, &tmp
);
1222 if (ret
!= JAYLINK_OK
) {
1223 LOG_ERROR("jaylink_get_free_memory() failed: %s.",
1224 jaylink_strerror(ret
));
1228 if (tmp
> 0x3fff || tmp
<= 0x600)
1233 return tmp
& 0xffffff00;
1236 static bool check_trace_freq(struct jaylink_swo_speed speed
,
1237 uint32_t trace_freq
)
1243 min
= fabs(1.0 - (speed
.freq
/ ((double)trace_freq
* speed
.min_div
)));
1245 for (divider
= speed
.min_div
; divider
< speed
.max_div
; divider
++) {
1246 deviation
= fabs(1.0 - (speed
.freq
/ ((double)trace_freq
* divider
)));
1248 if (deviation
< 0.03) {
1249 LOG_DEBUG("Found suitable frequency divider %u with deviation of "
1250 "%.02f %%.", divider
, deviation
);
1254 if (deviation
< min
)
1258 LOG_ERROR("Selected trace frequency is not supported by the device. "
1259 "Please choose a different trace frequency.");
1260 LOG_ERROR("Maximum permitted deviation is 3.00 %%, but only %.02f %% "
1261 "could be achieved.", min
* 100);
1266 static int config_trace(bool enabled
, enum tpiu_pin_protocol pin_protocol
,
1267 uint32_t port_size
, unsigned int *trace_freq
)
1270 uint32_t buffer_size
;
1271 struct jaylink_swo_speed speed
;
1273 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SWO
)) {
1274 LOG_ERROR("Trace capturing is not supported by the device.");
1278 if (pin_protocol
!= TPIU_PIN_PROTOCOL_ASYNC_UART
) {
1279 LOG_ERROR("Selected pin protocol is not supported.");
1283 trace_enabled
= enabled
;
1285 ret
= jaylink_swo_stop(devh
);
1287 if (ret
!= JAYLINK_OK
) {
1288 LOG_ERROR("jaylink_swo_stop() failed: %s.", jaylink_strerror(ret
));
1294 * Adjust the SWD transaction buffer size as stopping SWO capturing
1295 * deallocates device internal memory.
1297 if (!adjust_swd_buffer_size())
1303 buffer_size
= calculate_trace_buffer_size();
1306 LOG_ERROR("Not enough free device memory to start trace capturing.");
1310 ret
= jaylink_swo_get_speeds(devh
, JAYLINK_SWO_MODE_UART
, &speed
);
1312 if (ret
!= JAYLINK_OK
) {
1313 LOG_ERROR("jaylink_swo_get_speeds() failed: %s.",
1314 jaylink_strerror(ret
));
1319 *trace_freq
= speed
.freq
/ speed
.min_div
;
1321 if (!check_trace_freq(speed
, *trace_freq
))
1324 LOG_DEBUG("Using %u bytes device memory for trace capturing.", buffer_size
);
1326 ret
= jaylink_swo_start(devh
, JAYLINK_SWO_MODE_UART
, *trace_freq
,
1329 if (ret
!= JAYLINK_OK
) {
1330 LOG_ERROR("jaylink_start_swo() failed: %s.", jaylink_strerror(ret
));
1335 * Adjust the SWD transaction buffer size as starting SWO capturing
1336 * allocates device internal memory.
1338 if (!adjust_swd_buffer_size())
1344 COMMAND_HANDLER(jlink_handle_config_usb_address_command
)
1348 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1349 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1355 show_config_usb_address(CMD_CTX
);
1356 } else if (CMD_ARGC
== 1) {
1357 if (sscanf(CMD_ARGV
[0], "%" SCNd8
, &tmp
) != 1) {
1358 command_print(CMD_CTX
, "Invalid USB address: %s.", CMD_ARGV
[0]);
1362 if (tmp
> JAYLINK_USB_ADDRESS_3
) {
1363 command_print(CMD_CTX
, "Invalid USB address: %u.", tmp
);
1367 tmp_config
.usb_address
= tmp
;
1369 command_print(CMD_CTX
, "Need exactly one argument for jlink config "
1371 return ERROR_COMMAND_SYNTAX_ERROR
;
1377 COMMAND_HANDLER(jlink_handle_config_target_power_command
)
1381 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1382 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1387 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SET_TARGET_POWER
)) {
1388 command_print(CMD_CTX
, "Target power supply is not supported by the "
1394 show_config_target_power(CMD_CTX
);
1395 } else if (CMD_ARGC
== 1) {
1396 if (!strcmp(CMD_ARGV
[0], "on")) {
1398 } else if (!strcmp(CMD_ARGV
[0], "off")) {
1401 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
1405 tmp_config
.target_power
= enable
;
1407 command_print(CMD_CTX
, "Need exactly one argument for jlink config "
1409 return ERROR_COMMAND_SYNTAX_ERROR
;
1415 COMMAND_HANDLER(jlink_handle_config_mac_address_command
)
1422 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1423 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1428 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_ETHERNET
)) {
1429 command_print(CMD_CTX
, "Ethernet connectivity is not supported by the "
1435 show_config_mac_address(CMD_CTX
);
1436 } else if (CMD_ARGC
== 1) {
1439 if ((strlen(str
) != 17) || (str
[2] != ':' || str
[5] != ':' || \
1440 str
[8] != ':' || str
[11] != ':' || str
[14] != ':')) {
1441 command_print(CMD_CTX
, "Invalid MAC address format.");
1442 return ERROR_COMMAND_SYNTAX_ERROR
;
1445 for (i
= 5; i
>= 0; i
--) {
1446 addr
[i
] = strtoul(str
, &e
, 16);
1450 if (!(addr
[0] | addr
[1] | addr
[2] | addr
[3] | addr
[4] | addr
[5])) {
1451 command_print(CMD_CTX
, "Invalid MAC address: zero address.");
1452 return ERROR_COMMAND_SYNTAX_ERROR
;
1455 if (!(0x01 & addr
[0])) {
1456 command_print(CMD_CTX
, "Invalid MAC address: multicast address.");
1457 return ERROR_COMMAND_SYNTAX_ERROR
;
1460 memcpy(tmp_config
.mac_address
, addr
, sizeof(addr
));
1462 command_print(CMD_CTX
, "Need exactly one argument for jlink config "
1464 return ERROR_COMMAND_SYNTAX_ERROR
;
1470 static bool string_to_ip(const char *s
, uint8_t *ip
, int *pos
)
1474 const char *s_save
= s
;
1480 for (i
= 0; i
< 4; i
++) {
1481 lip
[i
] = strtoul(s
, &e
, 10);
1483 if (*e
!= '.' && i
!= 3)
1490 memcpy(ip
, lip
, sizeof(lip
));
1495 static void cpy_ip(uint8_t *dst
, uint8_t *src
)
1499 for (i
= 0, j
= 3; i
< 4; i
++, j
--)
1503 COMMAND_HANDLER(jlink_handle_config_ip_address_command
)
1505 uint8_t ip_address
[4];
1506 uint32_t subnet_mask
= 0;
1508 uint8_t subnet_bits
= 24;
1510 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1511 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1516 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_ETHERNET
)) {
1517 command_print(CMD_CTX
, "Ethernet connectivity is not supported by the "
1523 show_config_ip_address(CMD_CTX
);
1525 if (!string_to_ip(CMD_ARGV
[0], ip_address
, &i
))
1526 return ERROR_COMMAND_SYNTAX_ERROR
;
1528 len
= strlen(CMD_ARGV
[0]);
1530 /* Check for format A.B.C.D/E. */
1532 if (CMD_ARGV
[0][i
] != '/')
1533 return ERROR_COMMAND_SYNTAX_ERROR
;
1535 COMMAND_PARSE_NUMBER(u8
, CMD_ARGV
[0] + i
+ 1, subnet_bits
);
1536 } else if (CMD_ARGC
> 1) {
1537 if (!string_to_ip(CMD_ARGV
[1], (uint8_t *)&subnet_mask
, &i
))
1538 return ERROR_COMMAND_SYNTAX_ERROR
;
1542 subnet_mask
= (uint32_t)(subnet_bits
< 32 ?
1543 ((1ULL << subnet_bits
) - 1) : 0xffffffff);
1545 cpy_ip(tmp_config
.ip_address
, ip_address
);
1546 cpy_ip(tmp_config
.subnet_mask
, (uint8_t *)&subnet_mask
);
1552 COMMAND_HANDLER(jlink_handle_config_reset_command
)
1554 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
))
1557 memcpy(&tmp_config
, &config
, sizeof(struct device_config
));
1563 COMMAND_HANDLER(jlink_handle_config_write_command
)
1567 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1568 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1573 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_WRITE_CONFIG
)) {
1574 command_print(CMD_CTX
, "Writing configuration is not supported by the "
1579 if (!memcmp(&config
, &tmp_config
, sizeof(struct device_config
))) {
1580 command_print(CMD_CTX
, "Operation not performed due to no changes in "
1581 "the configuration.");
1585 ret
= jaylink_write_raw_config(devh
, (const uint8_t *)&tmp_config
);
1587 if (ret
!= JAYLINK_OK
) {
1588 LOG_ERROR("jaylink_write_raw_config() failed: %s.",
1589 jaylink_strerror(ret
));
1593 if (!read_device_config(&config
)) {
1594 LOG_ERROR("Failed to read device configuration for verification.");
1598 if (memcmp(&config
, &tmp_config
, sizeof(struct device_config
))) {
1599 LOG_ERROR("Verification of device configuration failed. Please check "
1604 memcpy(&tmp_config
, &config
, sizeof(struct device_config
));
1605 command_print(CMD_CTX
, "The new device configuration applies after power "
1606 "cycling the J-Link device.");
1611 COMMAND_HANDLER(jlink_handle_config_command
)
1613 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1614 command_print(CMD_CTX
, "Device doesn't support reading configuration.");
1619 show_config(CMD_CTX
);
1624 COMMAND_HANDLER(jlink_handle_emucom_write_command
)
1634 return ERROR_COMMAND_SYNTAX_ERROR
;
1636 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_EMUCOM
)) {
1637 LOG_ERROR("Device does not support EMUCOM.");
1641 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], channel
);
1643 tmp
= strlen(CMD_ARGV
[1]);
1646 LOG_ERROR("Data must be encoded as hexadecimal pairs.");
1647 return ERROR_COMMAND_ARGUMENT_INVALID
;
1650 buf
= malloc(tmp
/ 2);
1653 LOG_ERROR("Failed to allocate buffer.");
1657 dummy
= unhexify(buf
, CMD_ARGV
[1], tmp
/ 2);
1659 if (dummy
!= (tmp
/ 2)) {
1660 LOG_ERROR("Data must be encoded as hexadecimal pairs.");
1662 return ERROR_COMMAND_ARGUMENT_INVALID
;
1666 ret
= jaylink_emucom_write(devh
, channel
, buf
, &length
);
1670 if (ret
== JAYLINK_ERR_DEV_NOT_SUPPORTED
) {
1671 LOG_ERROR("Channel not supported by the device.");
1673 } else if (ret
!= JAYLINK_OK
) {
1674 LOG_ERROR("Failed to write to channel: %s.", jaylink_strerror(ret
));
1678 if (length
!= (tmp
/ 2))
1679 LOG_WARNING("Only %" PRIu32
" bytes written to the channel.", length
);
1684 COMMAND_HANDLER(jlink_handle_emucom_read_command
)
1693 return ERROR_COMMAND_SYNTAX_ERROR
;
1695 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_EMUCOM
)) {
1696 LOG_ERROR("Device does not support EMUCOM.");
1700 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], channel
);
1701 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
1703 buf
= malloc(length
* 3 + 1);
1706 LOG_ERROR("Failed to allocate buffer.");
1710 ret
= jaylink_emucom_read(devh
, channel
, buf
, &length
);
1712 if (ret
== JAYLINK_ERR_DEV_NOT_SUPPORTED
) {
1713 LOG_ERROR("Channel is not supported by the device.");
1716 } else if (ret
== JAYLINK_ERR_DEV_NOT_AVAILABLE
) {
1717 LOG_ERROR("Channel is not available for the requested amount of data. "
1718 "%" PRIu32
" bytes are avilable.", length
);
1721 } else if (ret
!= JAYLINK_OK
) {
1722 LOG_ERROR("Failed to read from channel: %s.", jaylink_strerror(ret
));
1727 tmp
= hexify((char *)buf
+ length
, buf
, length
, 2 * length
+ 1);
1729 if (tmp
!= 2 * length
) {
1730 LOG_ERROR("Failed to convert data into hexadecimal string.");
1735 command_print(CMD_CTX
, "%s", buf
+ length
);
1741 static const struct command_registration jlink_config_subcommand_handlers
[] = {
1744 .handler
= &jlink_handle_config_usb_address_command
,
1745 .mode
= COMMAND_EXEC
,
1746 .help
= "set the USB address",
1750 .name
= "targetpower",
1751 .handler
= &jlink_handle_config_target_power_command
,
1752 .mode
= COMMAND_EXEC
,
1753 .help
= "set the target power supply",
1758 .handler
= &jlink_handle_config_mac_address_command
,
1759 .mode
= COMMAND_EXEC
,
1760 .help
= "set the MAC Address",
1761 .usage
= "[ff:ff:ff:ff:ff:ff]",
1765 .handler
= &jlink_handle_config_ip_address_command
,
1766 .mode
= COMMAND_EXEC
,
1767 .help
= "set the IP address, where A.B.C.D is the IP address, "
1768 "E the bit of the subnet mask, F.G.H.I the subnet mask",
1769 .usage
= "[A.B.C.D[/E] [F.G.H.I]]",
1773 .handler
= &jlink_handle_config_reset_command
,
1774 .mode
= COMMAND_EXEC
,
1775 .help
= "undo configuration changes"
1779 .handler
= &jlink_handle_config_write_command
,
1780 .mode
= COMMAND_EXEC
,
1781 .help
= "write configuration to the device"
1783 COMMAND_REGISTRATION_DONE
1786 static const struct command_registration jlink_emucom_subcommand_handlers
[] = {
1789 .handler
= &jlink_handle_emucom_write_command
,
1790 .mode
= COMMAND_EXEC
,
1791 .help
= "write to a channel",
1792 .usage
= "<channel> <data>",
1796 .handler
= &jlink_handle_emucom_read_command
,
1797 .mode
= COMMAND_EXEC
,
1798 .help
= "read from a channel",
1799 .usage
= "<channel> <length>"
1801 COMMAND_REGISTRATION_DONE
1804 static const struct command_registration jlink_subcommand_handlers
[] = {
1807 .handler
= &jlink_handle_jlink_jtag_command
,
1808 .mode
= COMMAND_EXEC
,
1809 .help
= "select the JTAG command version",
1813 .name
= "targetpower",
1814 .handler
= &jlink_handle_target_power_command
,
1815 .mode
= COMMAND_EXEC
,
1816 .help
= "set the target power supply",
1821 .handler
= &jlink_handle_free_memory_command
,
1822 .mode
= COMMAND_EXEC
,
1823 .help
= "show free device memory"
1827 .handler
= &jlink_handle_hwstatus_command
,
1828 .mode
= COMMAND_EXEC
,
1829 .help
= "show the hardware status"
1833 .handler
= &jlink_usb_command
,
1834 .mode
= COMMAND_CONFIG
,
1835 .help
= "set the USB address of the device that should be used",
1840 .handler
= &jlink_serial_command
,
1841 .mode
= COMMAND_CONFIG
,
1842 .help
= "set the serial number of the device that should be used",
1843 .usage
= "<serial number>"
1847 .handler
= &jlink_handle_config_command
,
1848 .mode
= COMMAND_EXEC
,
1849 .help
= "access the device configuration. If no argument is given "
1850 "this will show the device configuration",
1851 .chain
= jlink_config_subcommand_handlers
,
1855 .mode
= COMMAND_EXEC
,
1856 .help
= "access EMUCOM channel",
1857 .chain
= jlink_emucom_subcommand_handlers
1859 COMMAND_REGISTRATION_DONE
1862 static const struct command_registration jlink_command_handlers
[] = {
1865 .mode
= COMMAND_ANY
,
1866 .help
= "perform jlink management",
1867 .chain
= jlink_subcommand_handlers
,
1869 COMMAND_REGISTRATION_DONE
1872 static int jlink_swd_init(void)
1874 iface
= JAYLINK_TIF_SWD
;
1879 static void jlink_swd_write_reg(uint8_t cmd
, uint32_t value
, uint32_t ap_delay_clk
)
1881 assert(!(cmd
& SWD_CMD_RnW
));
1882 jlink_swd_queue_cmd(cmd
, NULL
, value
, ap_delay_clk
);
1885 static void jlink_swd_read_reg(uint8_t cmd
, uint32_t *value
, uint32_t ap_delay_clk
)
1887 assert(cmd
& SWD_CMD_RnW
);
1888 jlink_swd_queue_cmd(cmd
, value
, 0, ap_delay_clk
);
1891 static int_least32_t jlink_swd_frequency(int_least32_t hz
)
1894 jlink_speed(hz
/ 1000);
1899 /***************************************************************************/
1900 /* J-Link tap functions */
1902 static unsigned tap_length
;
1903 /* In SWD mode use tms buffer for direction control */
1904 static uint8_t tms_buffer
[JLINK_TAP_BUFFER_SIZE
];
1905 static uint8_t tdi_buffer
[JLINK_TAP_BUFFER_SIZE
];
1906 static uint8_t tdo_buffer
[JLINK_TAP_BUFFER_SIZE
];
1908 struct pending_scan_result
{
1909 /** First bit position in tdo_buffer to read. */
1911 /** Number of bits to read. */
1913 /** Location to store the result */
1915 /** Offset in the destination buffer */
1916 unsigned buffer_offset
;
1919 #define MAX_PENDING_SCAN_RESULTS 256
1921 static int pending_scan_results_length
;
1922 static struct pending_scan_result pending_scan_results_buffer
[MAX_PENDING_SCAN_RESULTS
];
1924 static void jlink_tap_init(void)
1927 pending_scan_results_length
= 0;
1928 memset(tms_buffer
, 0, sizeof(tms_buffer
));
1929 memset(tdi_buffer
, 0, sizeof(tdi_buffer
));
1932 static void jlink_clock_data(const uint8_t *out
, unsigned out_offset
,
1933 const uint8_t *tms_out
, unsigned tms_offset
,
1934 uint8_t *in
, unsigned in_offset
,
1938 unsigned available_length
= JLINK_TAP_BUFFER_SIZE
- tap_length
/ 8;
1940 if (!available_length
||
1941 (in
&& pending_scan_results_length
== MAX_PENDING_SCAN_RESULTS
)) {
1942 if (jlink_flush() != ERROR_OK
)
1944 available_length
= JLINK_TAP_BUFFER_SIZE
;
1947 struct pending_scan_result
*pending_scan_result
=
1948 &pending_scan_results_buffer
[pending_scan_results_length
];
1950 unsigned scan_length
= length
> available_length
?
1951 available_length
: length
;
1954 buf_set_buf(out
, out_offset
, tdi_buffer
, tap_length
, scan_length
);
1956 buf_set_buf(tms_out
, tms_offset
, tms_buffer
, tap_length
, scan_length
);
1959 pending_scan_result
->first
= tap_length
;
1960 pending_scan_result
->length
= scan_length
;
1961 pending_scan_result
->buffer
= in
;
1962 pending_scan_result
->buffer_offset
= in_offset
;
1963 pending_scan_results_length
++;
1966 tap_length
+= scan_length
;
1967 out_offset
+= scan_length
;
1968 tms_offset
+= scan_length
;
1969 in_offset
+= scan_length
;
1970 length
-= scan_length
;
1971 } while (length
> 0);
1974 static int jlink_flush(void)
1982 jlink_last_state
= jtag_debug_state_machine(tms_buffer
, tdi_buffer
,
1983 tap_length
, jlink_last_state
);
1985 ret
= jaylink_jtag_io(devh
, tms_buffer
, tdi_buffer
, tdo_buffer
,
1986 tap_length
, jtag_command_version
);
1988 if (ret
!= JAYLINK_OK
) {
1989 LOG_ERROR("jaylink_jtag_io() failed: %s.", jaylink_strerror(ret
));
1991 return ERROR_JTAG_QUEUE_FAILED
;
1994 for (i
= 0; i
< pending_scan_results_length
; i
++) {
1995 struct pending_scan_result
*p
= &pending_scan_results_buffer
[i
];
1997 buf_set_buf(tdo_buffer
, p
->first
, p
->buffer
,
1998 p
->buffer_offset
, p
->length
);
2000 DEBUG_JTAG_IO("Pending scan result, length = %d.", p
->length
);
2008 static void fill_buffer(uint8_t *buf
, uint32_t val
, uint32_t len
)
2010 unsigned int tap_pos
= tap_length
;
2013 buf_set_u32(buf
, tap_pos
, 32, val
);
2019 buf_set_u32(buf
, tap_pos
, len
, val
);
2022 static void jlink_queue_data_out(const uint8_t *data
, uint32_t len
)
2024 const uint32_t dir_out
= 0xffffffff;
2027 bit_copy(tdi_buffer
, tap_length
, data
, 0, len
);
2029 fill_buffer(tdi_buffer
, 0, len
);
2031 fill_buffer(tms_buffer
, dir_out
, len
);
2035 static void jlink_queue_data_in(uint32_t len
)
2037 const uint32_t dir_in
= 0;
2039 fill_buffer(tms_buffer
, dir_in
, len
);
2043 static int jlink_swd_switch_seq(enum swd_special_seq seq
)
2050 LOG_DEBUG("SWD line reset");
2051 s
= swd_seq_line_reset
;
2052 s_len
= swd_seq_line_reset_len
;
2055 LOG_DEBUG("JTAG-to-SWD");
2056 s
= swd_seq_jtag_to_swd
;
2057 s_len
= swd_seq_jtag_to_swd_len
;
2060 LOG_DEBUG("SWD-to-JTAG");
2061 s
= swd_seq_swd_to_jtag
;
2062 s_len
= swd_seq_swd_to_jtag_len
;
2065 LOG_ERROR("Sequence %d not supported.", seq
);
2069 jlink_queue_data_out(s
, s_len
);
2074 static int jlink_swd_run_queue(void)
2079 LOG_DEBUG("Executing %d queued transactions.", pending_scan_results_length
);
2081 if (queued_retval
!= ERROR_OK
) {
2082 LOG_DEBUG("Skipping due to previous errors: %d.", queued_retval
);
2087 * A transaction must be followed by another transaction or at least 8 idle
2088 * cycles to ensure that data is clocked through the AP.
2090 jlink_queue_data_out(NULL
, 8);
2092 ret
= jaylink_swd_io(devh
, tms_buffer
, tdi_buffer
, tdo_buffer
, tap_length
);
2094 if (ret
!= JAYLINK_OK
) {
2095 LOG_ERROR("jaylink_swd_io() failed: %s.", jaylink_strerror(ret
));
2099 for (i
= 0; i
< pending_scan_results_length
; i
++) {
2100 int ack
= buf_get_u32(tdo_buffer
, pending_scan_results_buffer
[i
].first
, 3);
2102 if (ack
!= SWD_ACK_OK
) {
2103 LOG_DEBUG("SWD ack not OK: %d %s", ack
,
2104 ack
== SWD_ACK_WAIT
? "WAIT" : ack
== SWD_ACK_FAULT
? "FAULT" : "JUNK");
2105 queued_retval
= ack
== SWD_ACK_WAIT
? ERROR_WAIT
: ERROR_FAIL
;
2107 } else if (pending_scan_results_buffer
[i
].length
) {
2108 uint32_t data
= buf_get_u32(tdo_buffer
, 3 + pending_scan_results_buffer
[i
].first
, 32);
2109 int parity
= buf_get_u32(tdo_buffer
, 3 + 32 + pending_scan_results_buffer
[i
].first
, 1);
2111 if (parity
!= parity_u32(data
)) {
2112 LOG_ERROR("SWD: Read data parity mismatch.");
2113 queued_retval
= ERROR_FAIL
;
2117 if (pending_scan_results_buffer
[i
].buffer
)
2118 *(uint32_t *)pending_scan_results_buffer
[i
].buffer
= data
;
2124 ret
= queued_retval
;
2125 queued_retval
= ERROR_OK
;
2130 static void jlink_swd_queue_cmd(uint8_t cmd
, uint32_t *dst
, uint32_t data
, uint32_t ap_delay_clk
)
2132 uint8_t data_parity_trn
[DIV_ROUND_UP(32 + 1, 8)];
2133 if (tap_length
+ 46 + 8 + ap_delay_clk
>= sizeof(tdi_buffer
) * 8 ||
2134 pending_scan_results_length
== MAX_PENDING_SCAN_RESULTS
) {
2135 /* Not enough room in the queue. Run the queue. */
2136 queued_retval
= jlink_swd_run_queue();
2139 if (queued_retval
!= ERROR_OK
)
2142 cmd
|= SWD_CMD_START
| SWD_CMD_PARK
;
2144 jlink_queue_data_out(&cmd
, 8);
2146 pending_scan_results_buffer
[pending_scan_results_length
].first
= tap_length
;
2148 if (cmd
& SWD_CMD_RnW
) {
2149 /* Queue a read transaction. */
2150 pending_scan_results_buffer
[pending_scan_results_length
].length
= 32;
2151 pending_scan_results_buffer
[pending_scan_results_length
].buffer
= dst
;
2153 jlink_queue_data_in(1 + 3 + 32 + 1 + 1);
2155 /* Queue a write transaction. */
2156 pending_scan_results_buffer
[pending_scan_results_length
].length
= 0;
2157 jlink_queue_data_in(1 + 3 + 1);
2159 buf_set_u32(data_parity_trn
, 0, 32, data
);
2160 buf_set_u32(data_parity_trn
, 32, 1, parity_u32(data
));
2162 jlink_queue_data_out(data_parity_trn
, 32 + 1);
2165 pending_scan_results_length
++;
2167 /* Insert idle cycles after AP accesses to avoid WAIT. */
2168 if (cmd
& SWD_CMD_APnDP
)
2169 jlink_queue_data_out(NULL
, ap_delay_clk
);
2172 static const struct swd_driver jlink_swd
= {
2173 .init
= &jlink_swd_init
,
2174 .frequency
= &jlink_swd_frequency
,
2175 .switch_seq
= &jlink_swd_switch_seq
,
2176 .read_reg
= &jlink_swd_read_reg
,
2177 .write_reg
= &jlink_swd_write_reg
,
2178 .run
= &jlink_swd_run_queue
,
2181 static const char * const jlink_transports
[] = { "jtag", "swd", NULL
};
2183 struct jtag_interface jlink_interface
= {
2185 .commands
= jlink_command_handlers
,
2186 .transports
= jlink_transports
,
2188 .execute_queue
= &jlink_execute_queue
,
2189 .speed
= &jlink_speed
,
2190 .speed_div
= &jlink_speed_div
,
2192 .init
= &jlink_init
,
2193 .quit
= &jlink_quit
,
2194 .config_trace
= &config_trace
,
2195 .poll_trace
= &poll_trace
,