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_name(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_name(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_name(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_name(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_name(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.",
446 jaylink_strerror_name(ret
));
450 handle_found
= false;
452 for (i
= 0; i
< count
; i
++) {
453 if (connlist
[i
].handle
== conn
.handle
) {
460 LOG_ERROR("Registration failed: maximum number of connections on the "
469 * Adjust the SWD transaction buffer size depending on the free device internal
470 * memory. This ensures that the SWD transactions sent to the device do not
471 * exceed the internal memory of the device.
473 static bool adjust_swd_buffer_size(void)
478 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_FREE_MEMORY
))
481 ret
= jaylink_get_free_memory(devh
, &tmp
);
483 if (ret
!= JAYLINK_OK
) {
484 LOG_ERROR("jaylink_get_free_memory() failed: %s.",
485 jaylink_strerror_name(ret
));
490 LOG_ERROR("Not enough free device internal memory: %u bytes.", tmp
);
494 tmp
= MIN(JLINK_TAP_BUFFER_SIZE
, (tmp
- 16) / 2);
496 if (tmp
!= swd_buffer_size
) {
497 swd_buffer_size
= tmp
;
498 LOG_DEBUG("Adjusted SWD transaction buffer size to %u bytes.",
505 static int jaylink_log_handler(const struct jaylink_context
*ctx
,
506 enum jaylink_log_level level
, const char *format
, va_list args
,
512 case JAYLINK_LOG_LEVEL_ERROR
:
515 case JAYLINK_LOG_LEVEL_WARNING
:
516 tmp
= LOG_LVL_WARNING
;
519 * Forward info messages to the debug output because they are more verbose
520 * than info messages of OpenOCD.
522 case JAYLINK_LOG_LEVEL_INFO
:
523 case JAYLINK_LOG_LEVEL_DEBUG
:
526 case JAYLINK_LOG_LEVEL_DEBUG_IO
:
527 tmp
= LOG_LVL_DEBUG_IO
;
530 tmp
= LOG_LVL_WARNING
;
533 log_vprintf_lf(tmp
, __FILE__
, __LINE__
, __func__
, format
, args
);
538 static int jlink_init(void)
541 struct jaylink_device
**devs
;
545 char *firmware_version
;
546 struct jaylink_hardware_version hwver
;
547 struct jaylink_hardware_status hwstatus
;
548 enum jaylink_usb_address address
;
551 LOG_DEBUG("Using libjaylink %s (compiled with %s).",
552 jaylink_version_package_get_string(), JAYLINK_VERSION_PACKAGE_STRING
);
554 ret
= jaylink_init(&jayctx
);
556 if (ret
!= JAYLINK_OK
) {
557 LOG_ERROR("jaylink_init() failed: %s.",
558 jaylink_strerror_name(ret
));
559 return ERROR_JTAG_INIT_FAILED
;
562 ret
= jaylink_log_set_callback(jayctx
, &jaylink_log_handler
, NULL
);
564 if (ret
!= JAYLINK_OK
) {
565 LOG_ERROR("jaylink_log_set_callback() failed: %s.",
566 jaylink_strerror_name(ret
));
567 jaylink_exit(jayctx
);
568 return ERROR_JTAG_INIT_FAILED
;
571 ret
= jaylink_discovery_scan(jayctx
, 0);
573 if (ret
!= JAYLINK_OK
) {
574 LOG_ERROR("jaylink_discovery_scan() failed: %s.",
575 jaylink_strerror_name(ret
));
576 jaylink_exit(jayctx
);
577 return ERROR_JTAG_INIT_FAILED
;
580 ret
= jaylink_get_devices(jayctx
, &devs
, NULL
);
582 if (ret
!= JAYLINK_OK
) {
583 LOG_ERROR("jaylink_get_devices() failed: %s.",
584 jaylink_strerror_name(ret
));
585 jaylink_exit(jayctx
);
586 return ERROR_JTAG_INIT_FAILED
;
589 found_device
= false;
591 if (!use_serial_number
&& !use_usb_address
)
592 LOG_INFO("No device selected, using first device.");
594 for (i
= 0; devs
[i
]; i
++) {
595 if (use_serial_number
) {
596 ret
= jaylink_device_get_serial_number(devs
[i
], &tmp
);
598 if (ret
== JAYLINK_ERR_NOT_AVAILABLE
) {
600 } else if (ret
!= JAYLINK_OK
) {
601 LOG_WARNING("jaylink_device_get_serial_number() failed: %s.",
602 jaylink_strerror_name(ret
));
606 if (serial_number
!= tmp
)
610 if (use_usb_address
) {
611 ret
= jaylink_device_get_usb_address(devs
[i
], &address
);
613 if (ret
!= JAYLINK_OK
) {
614 LOG_WARNING("jaylink_device_get_usb_address() failed: %s.",
615 jaylink_strerror_name(ret
));
619 if (usb_address
!= address
)
623 ret
= jaylink_open(devs
[i
], &devh
);
625 if (ret
== JAYLINK_OK
) {
630 LOG_ERROR("Failed to open device: %s.", jaylink_strerror_name(ret
));
633 jaylink_free_devices(devs
, true);
636 LOG_ERROR("No J-Link device found.");
637 jaylink_exit(jayctx
);
638 return ERROR_JTAG_INIT_FAILED
;
642 * Be careful with changing the following initialization sequence because
643 * some devices are known to be sensitive regarding the order.
646 ret
= jaylink_get_firmware_version(devh
, &firmware_version
, &length
);
648 if (ret
!= JAYLINK_OK
) {
649 LOG_ERROR("jaylink_get_firmware_version() failed: %s.",
650 jaylink_strerror_name(ret
));
652 jaylink_exit(jayctx
);
653 return ERROR_JTAG_INIT_FAILED
;
654 } else if (length
> 0) {
655 LOG_INFO("%s", firmware_version
);
656 free(firmware_version
);
658 LOG_WARNING("Device responds empty firmware version string.");
661 memset(caps
, 0, JAYLINK_DEV_EXT_CAPS_SIZE
);
662 ret
= jaylink_get_caps(devh
, caps
);
664 if (ret
!= JAYLINK_OK
) {
665 LOG_ERROR("jaylink_get_caps() failed: %s.", jaylink_strerror_name(ret
));
667 jaylink_exit(jayctx
);
668 return ERROR_JTAG_INIT_FAILED
;
671 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_EXT_CAPS
)) {
672 ret
= jaylink_get_extended_caps(devh
, caps
);
674 if (ret
!= JAYLINK_OK
) {
675 LOG_ERROR("jaylink_get_extended_caps() failed: %s.",
676 jaylink_strerror_name(ret
));
678 jaylink_exit(jayctx
);
679 return ERROR_JTAG_INIT_FAILED
;
683 jtag_command_version
= JAYLINK_JTAG_VERSION_2
;
685 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_HW_VERSION
)) {
686 ret
= jaylink_get_hardware_version(devh
, &hwver
);
688 if (ret
!= JAYLINK_OK
) {
689 LOG_ERROR("Failed to retrieve hardware version: %s.",
690 jaylink_strerror_name(ret
));
692 jaylink_exit(jayctx
);
693 return ERROR_JTAG_INIT_FAILED
;
696 LOG_INFO("Hardware version: %u.%02u", hwver
.major
, hwver
.minor
);
698 if (hwver
.major
>= 5)
699 jtag_command_version
= JAYLINK_JTAG_VERSION_3
;
702 if (iface
== JAYLINK_TIF_SWD
) {
704 * Adjust the SWD transaction buffer size in case there is already
705 * allocated memory on the device. This happens for example if the
706 * memory for SWO capturing is still allocated because the software
707 * which used the device before has not been shut down properly.
709 if (!adjust_swd_buffer_size()) {
711 jaylink_exit(jayctx
);
712 return ERROR_JTAG_INIT_FAILED
;
716 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
717 if (!read_device_config(&config
)) {
718 LOG_ERROR("Failed to read device configuration data.");
720 jaylink_exit(jayctx
);
721 return ERROR_JTAG_INIT_FAILED
;
724 memcpy(&tmp_config
, &config
, sizeof(struct device_config
));
727 ret
= jaylink_get_hardware_status(devh
, &hwstatus
);
729 if (ret
!= JAYLINK_OK
) {
730 LOG_ERROR("jaylink_get_hardware_status() failed: %s.",
731 jaylink_strerror_name(ret
));
733 jaylink_exit(jayctx
);
734 return ERROR_JTAG_INIT_FAILED
;
737 LOG_INFO("VTarget = %u.%03u V", hwstatus
.target_voltage
/ 1000,
738 hwstatus
.target_voltage
% 1000);
742 strcpy(conn
.hid
, "0.0.0.0");
746 ret
= jlink_register();
748 if (ret
!= ERROR_OK
) {
750 jaylink_exit(jayctx
);
751 return ERROR_JTAG_INIT_FAILED
;
754 ret
= select_interface();
756 if (ret
!= ERROR_OK
) {
758 jaylink_exit(jayctx
);
766 jlink_speed(jtag_get_speed_khz());
768 if (iface
== JAYLINK_TIF_JTAG
) {
770 * J-Link devices with firmware version v5 and v6 seems to have an issue
771 * if the first tap move is not divisible by 8, so we send a TLR on
775 jlink_clock_data(NULL
, 0, &tms
, 0, NULL
, 0, 8);
783 static int jlink_quit(void)
789 ret
= jaylink_swo_stop(devh
);
791 if (ret
!= JAYLINK_OK
)
792 LOG_ERROR("jaylink_swo_stop() failed: %s.",
793 jaylink_strerror_name(ret
));
796 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_REGISTER
)) {
797 ret
= jaylink_unregister(devh
, &conn
, connlist
, &count
);
799 if (ret
!= JAYLINK_OK
)
800 LOG_ERROR("jaylink_unregister() failed: %s.",
801 jaylink_strerror_name(ret
));
805 jaylink_exit(jayctx
);
810 /***************************************************************************/
811 /* Queue command implementations */
813 static void jlink_end_state(tap_state_t state
)
815 if (tap_is_state_stable(state
))
816 tap_set_end_state(state
);
818 LOG_ERROR("BUG: %i is not a valid end state", state
);
823 /* Goes to the end state. */
824 static void jlink_state_move(void)
827 uint8_t tms_scan_bits
;
829 tms_scan
= tap_get_tms_path(tap_get_state(), tap_get_end_state());
830 tms_scan_bits
= tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
832 jlink_clock_data(NULL
, 0, &tms_scan
, 0, NULL
, 0, tms_scan_bits
);
834 tap_set_state(tap_get_end_state());
837 static void jlink_path_move(int num_states
, tap_state_t
*path
)
842 for (i
= 0; i
< num_states
; i
++) {
843 if (path
[i
] == tap_state_transition(tap_get_state(), false))
844 jlink_clock_data(NULL
, 0, NULL
, 0, NULL
, 0, 1);
845 else if (path
[i
] == tap_state_transition(tap_get_state(), true))
846 jlink_clock_data(NULL
, 0, &tms
, 0, NULL
, 0, 1);
848 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition.",
849 tap_state_name(tap_get_state()), tap_state_name(path
[i
]));
853 tap_set_state(path
[i
]);
856 tap_set_end_state(tap_get_state());
859 static void jlink_stableclocks(int num_cycles
)
863 uint8_t tms
= tap_get_state() == TAP_RESET
;
864 /* Execute num_cycles. */
865 for (i
= 0; i
< num_cycles
; i
++)
866 jlink_clock_data(NULL
, 0, &tms
, 0, NULL
, 0, 1);
869 static void jlink_runtest(int num_cycles
)
871 tap_state_t saved_end_state
= tap_get_end_state();
873 /* Only do a state_move when we're not already in IDLE. */
874 if (tap_get_state() != TAP_IDLE
) {
875 jlink_end_state(TAP_IDLE
);
880 jlink_stableclocks(num_cycles
);
882 /* Finish in end_state. */
883 jlink_end_state(saved_end_state
);
885 if (tap_get_state() != tap_get_end_state())
889 static void jlink_reset(int trst
, int srst
)
891 LOG_DEBUG("TRST: %i, SRST: %i.", trst
, srst
);
893 /* Signals are active low. */
895 jaylink_set_reset(devh
);
898 jaylink_clear_reset(devh
);
901 jaylink_jtag_clear_trst(devh
);
904 jaylink_jtag_set_trst(devh
);
907 COMMAND_HANDLER(jlink_usb_command
)
912 command_print(CMD_CTX
, "Need exactly one argument for jlink usb.");
913 return ERROR_COMMAND_SYNTAX_ERROR
;
916 if (sscanf(CMD_ARGV
[0], "%i", &tmp
) != 1) {
917 command_print(CMD_CTX
, "Invalid USB address: %s.", CMD_ARGV
[0]);
921 if (tmp
< JAYLINK_USB_ADDRESS_0
|| tmp
> JAYLINK_USB_ADDRESS_3
) {
922 command_print(CMD_CTX
, "Invalid USB address: %s.", CMD_ARGV
[0]);
928 use_serial_number
= false;
929 use_usb_address
= true;
934 COMMAND_HANDLER(jlink_serial_command
)
939 command_print(CMD_CTX
, "Need exactly one argument for jlink serial.");
940 return ERROR_COMMAND_SYNTAX_ERROR
;
943 ret
= jaylink_parse_serial_number(CMD_ARGV
[0], &serial_number
);
945 if (ret
== JAYLINK_ERR
) {
946 command_print(CMD_CTX
, "Invalid serial number: %s.", CMD_ARGV
[0]);
948 } else if (ret
!= JAYLINK_OK
) {
949 command_print(CMD_CTX
, "jaylink_parse_serial_number() failed: %s.",
950 jaylink_strerror_name(ret
));
954 use_serial_number
= true;
955 use_usb_address
= false;
960 COMMAND_HANDLER(jlink_handle_hwstatus_command
)
963 struct jaylink_hardware_status status
;
965 ret
= jaylink_get_hardware_status(devh
, &status
);
967 if (ret
!= JAYLINK_OK
) {
968 command_print(CMD_CTX
, "jaylink_get_hardware_status() failed: %s.",
969 jaylink_strerror_name(ret
));
973 command_print(CMD_CTX
, "VTarget = %u.%03u V",
974 status
.target_voltage
/ 1000, status
.target_voltage
% 1000);
976 command_print(CMD_CTX
, "TCK = %u TDI = %u TDO = %u TMS = %u SRST = %u "
977 "TRST = %u", status
.tck
, status
.tdi
, status
.tdo
, status
.tms
,
978 status
.tres
, status
.trst
);
980 if (status
.target_voltage
< 1500)
981 command_print(CMD_CTX
, "Target voltage too low. Check target power.");
986 COMMAND_HANDLER(jlink_handle_free_memory_command
)
991 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_FREE_MEMORY
)) {
992 command_print(CMD_CTX
, "Retrieval of free memory is not supported by "
997 ret
= jaylink_get_free_memory(devh
, &tmp
);
999 if (ret
!= JAYLINK_OK
) {
1000 command_print(CMD_CTX
, "jaylink_get_free_memory() failed: %s.",
1001 jaylink_strerror_name(ret
));
1005 command_print(CMD_CTX
, "Device has %u bytes of free memory.", tmp
);
1010 COMMAND_HANDLER(jlink_handle_jlink_jtag_command
)
1016 switch (jtag_command_version
) {
1017 case JAYLINK_JTAG_VERSION_2
:
1020 case JAYLINK_JTAG_VERSION_3
:
1027 command_print(CMD_CTX
, "JTAG command version: %i", version
);
1028 } else if (CMD_ARGC
== 1) {
1029 if (sscanf(CMD_ARGV
[0], "%i", &tmp
) != 1) {
1030 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
1031 return ERROR_COMMAND_SYNTAX_ERROR
;
1036 jtag_command_version
= JAYLINK_JTAG_VERSION_2
;
1039 jtag_command_version
= JAYLINK_JTAG_VERSION_3
;
1042 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
1043 return ERROR_COMMAND_SYNTAX_ERROR
;
1046 command_print(CMD_CTX
, "Need exactly one argument for jlink jtag.");
1047 return ERROR_COMMAND_SYNTAX_ERROR
;
1053 COMMAND_HANDLER(jlink_handle_target_power_command
)
1058 if (CMD_ARGC
!= 1) {
1059 command_print(CMD_CTX
, "Need exactly one argument for jlink "
1061 return ERROR_COMMAND_SYNTAX_ERROR
;
1064 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SET_TARGET_POWER
)) {
1065 command_print(CMD_CTX
, "Target power supply is not supported by the "
1070 if (!strcmp(CMD_ARGV
[0], "on")) {
1072 } else if (!strcmp(CMD_ARGV
[0], "off")) {
1075 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
1079 ret
= jaylink_set_target_power(devh
, enable
);
1081 if (ret
!= JAYLINK_OK
) {
1082 command_print(CMD_CTX
, "jaylink_set_target_power() failed: %s.",
1083 jaylink_strerror_name(ret
));
1090 static void show_config_usb_address(struct command_context
*ctx
)
1092 if (config
.usb_address
!= tmp_config
.usb_address
)
1093 command_print(ctx
, "USB address: %u [%u]", config
.usb_address
,
1094 tmp_config
.usb_address
);
1096 command_print(ctx
, "USB address: %u", config
.usb_address
);
1099 static void show_config_ip_address(struct command_context
*ctx
)
1101 if (!memcmp(config
.ip_address
, tmp_config
.ip_address
, 4))
1102 command_print(ctx
, "IP address: %d.%d.%d.%d",
1103 config
.ip_address
[3], config
.ip_address
[2],
1104 config
.ip_address
[1], config
.ip_address
[0]);
1106 command_print(ctx
, "IP address: %d.%d.%d.%d [%d.%d.%d.%d]",
1107 config
.ip_address
[3], config
.ip_address
[2],
1108 config
.ip_address
[1], config
.ip_address
[0],
1109 tmp_config
.ip_address
[3], tmp_config
.ip_address
[2],
1110 tmp_config
.ip_address
[1], tmp_config
.ip_address
[0]);
1112 if (!memcmp(config
.subnet_mask
, tmp_config
.subnet_mask
, 4))
1113 command_print(ctx
, "Subnet mask: %d.%d.%d.%d",
1114 config
.subnet_mask
[3], config
.subnet_mask
[2],
1115 config
.subnet_mask
[1], config
.subnet_mask
[0]);
1117 command_print(ctx
, "Subnet mask: %d.%d.%d.%d [%d.%d.%d.%d]",
1118 config
.subnet_mask
[3], config
.subnet_mask
[2],
1119 config
.subnet_mask
[1], config
.subnet_mask
[0],
1120 tmp_config
.subnet_mask
[3], tmp_config
.subnet_mask
[2],
1121 tmp_config
.subnet_mask
[1], tmp_config
.subnet_mask
[0]);
1124 static void show_config_mac_address(struct command_context
*ctx
)
1126 if (!memcmp(config
.mac_address
, tmp_config
.mac_address
, 6))
1127 command_print(ctx
, "MAC address: %.02x:%.02x:%.02x:%.02x:%.02x:%.02x",
1128 config
.mac_address
[5], config
.mac_address
[4],
1129 config
.mac_address
[3], config
.mac_address
[2],
1130 config
.mac_address
[1], config
.mac_address
[0]);
1132 command_print(ctx
, "MAC address: %.02x:%.02x:%.02x:%.02x:%.02x:%.02x "
1133 "[%.02x:%.02x:%.02x:%.02x:%.02x:%.02x]",
1134 config
.mac_address
[5], config
.mac_address
[4],
1135 config
.mac_address
[3], config
.mac_address
[2],
1136 config
.mac_address
[1], config
.mac_address
[0],
1137 tmp_config
.mac_address
[5], tmp_config
.mac_address
[4],
1138 tmp_config
.mac_address
[3], tmp_config
.mac_address
[2],
1139 tmp_config
.mac_address
[1], tmp_config
.mac_address
[0]);
1142 static void show_config_target_power(struct command_context
*ctx
)
1144 const char *target_power
;
1145 const char *current_target_power
;
1147 if (!config
.target_power
)
1148 target_power
= "off";
1150 target_power
= "on";
1152 if (!tmp_config
.target_power
)
1153 current_target_power
= "off";
1155 current_target_power
= "on";
1157 if (config
.target_power
!= tmp_config
.target_power
)
1158 command_print(ctx
, "Target power supply: %s [%s]", target_power
,
1159 current_target_power
);
1161 command_print(ctx
, "Target power supply: %s", target_power
);
1164 static void show_config(struct command_context
*ctx
)
1166 command_print(ctx
, "J-Link device configuration:");
1168 show_config_usb_address(ctx
);
1170 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SET_TARGET_POWER
))
1171 show_config_target_power(ctx
);
1173 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_ETHERNET
)) {
1174 show_config_ip_address(ctx
);
1175 show_config_mac_address(ctx
);
1179 static int poll_trace(uint8_t *buf
, size_t *size
)
1186 ret
= jaylink_swo_read(devh
, buf
, &length
);
1188 if (ret
!= JAYLINK_OK
) {
1189 LOG_ERROR("jaylink_swo_read() failed: %s.", jaylink_strerror_name(ret
));
1198 static uint32_t calculate_trace_buffer_size(void)
1203 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_FREE_MEMORY
))
1206 ret
= jaylink_get_free_memory(devh
, &tmp
);
1208 if (ret
!= JAYLINK_OK
) {
1209 LOG_ERROR("jaylink_get_free_memory() failed: %s.",
1210 jaylink_strerror_name(ret
));
1214 if (tmp
> 0x3fff || tmp
<= 0x600)
1219 return tmp
& 0xffffff00;
1222 static bool check_trace_freq(struct jaylink_swo_speed speed
,
1223 uint32_t trace_freq
)
1229 min
= fabs(1.0 - (speed
.freq
/ ((double)trace_freq
* speed
.min_div
)));
1231 for (divider
= speed
.min_div
; divider
< speed
.max_div
; divider
++) {
1232 deviation
= fabs(1.0 - (speed
.freq
/ ((double)trace_freq
* divider
)));
1234 if (deviation
< 0.03) {
1235 LOG_DEBUG("Found suitable frequency divider %u with deviation of "
1236 "%.02f %%.", divider
, deviation
);
1240 if (deviation
< min
)
1244 LOG_ERROR("Selected trace frequency is not supported by the device. "
1245 "Please choose a different trace frequency.");
1246 LOG_ERROR("Maximum permitted deviation is 3.00 %%, but only %.02f %% "
1247 "could be achieved.", min
* 100);
1252 static int config_trace(bool enabled
, enum tpio_pin_protocol pin_protocol
,
1253 uint32_t port_size
, unsigned int *trace_freq
)
1256 uint32_t buffer_size
;
1257 struct jaylink_swo_speed speed
;
1259 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SWO
)) {
1260 LOG_ERROR("Trace capturing is not supported by the device.");
1264 if (pin_protocol
!= ASYNC_UART
) {
1265 LOG_ERROR("Selected pin protocol is not supported.");
1269 trace_enabled
= enabled
;
1271 ret
= jaylink_swo_stop(devh
);
1273 if (ret
!= JAYLINK_OK
) {
1274 LOG_ERROR("jaylink_swo_stop() failed: %s.", jaylink_strerror_name(ret
));
1280 * Adjust the SWD transaction buffer size as stopping SWO capturing
1281 * deallocates device internal memory.
1283 if (!adjust_swd_buffer_size())
1289 buffer_size
= calculate_trace_buffer_size();
1292 LOG_ERROR("Not enough free device memory to start trace capturing.");
1296 ret
= jaylink_swo_get_speeds(devh
, JAYLINK_SWO_MODE_UART
, &speed
);
1298 if (ret
!= JAYLINK_OK
) {
1299 LOG_ERROR("jaylink_swo_get_speeds() failed: %s.",
1300 jaylink_strerror_name(ret
));
1305 *trace_freq
= speed
.freq
/ speed
.min_div
;
1307 if (!check_trace_freq(speed
, *trace_freq
))
1310 LOG_DEBUG("Using %u bytes device memory for trace capturing.", buffer_size
);
1312 ret
= jaylink_swo_start(devh
, JAYLINK_SWO_MODE_UART
, *trace_freq
,
1315 if (ret
!= JAYLINK_OK
) {
1316 LOG_ERROR("jaylink_start_swo() failed: %s.",
1317 jaylink_strerror_name(ret
));
1322 * Adjust the SWD transaction buffer size as starting SWO capturing
1323 * allocates device internal memory.
1325 if (!adjust_swd_buffer_size())
1331 COMMAND_HANDLER(jlink_handle_config_usb_address_command
)
1335 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1336 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1342 show_config_usb_address(CMD_CTX
);
1343 } else if (CMD_ARGC
== 1) {
1344 if (sscanf(CMD_ARGV
[0], "%" SCNd8
, &tmp
) != 1) {
1345 command_print(CMD_CTX
, "Invalid USB address: %s.", CMD_ARGV
[0]);
1349 if (tmp
> JAYLINK_USB_ADDRESS_3
) {
1350 command_print(CMD_CTX
, "Invalid USB address: %u.", tmp
);
1354 tmp_config
.usb_address
= tmp
;
1356 command_print(CMD_CTX
, "Need exactly one argument for jlink config "
1358 return ERROR_COMMAND_SYNTAX_ERROR
;
1364 COMMAND_HANDLER(jlink_handle_config_target_power_command
)
1368 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1369 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1374 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SET_TARGET_POWER
)) {
1375 command_print(CMD_CTX
, "Target power supply is not supported by the "
1381 show_config_target_power(CMD_CTX
);
1382 } else if (CMD_ARGC
== 1) {
1383 if (!strcmp(CMD_ARGV
[0], "on")) {
1385 } else if (!strcmp(CMD_ARGV
[0], "off")) {
1388 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
1392 tmp_config
.target_power
= enable
;
1394 command_print(CMD_CTX
, "Need exactly one argument for jlink config "
1396 return ERROR_COMMAND_SYNTAX_ERROR
;
1402 COMMAND_HANDLER(jlink_handle_config_mac_address_command
)
1409 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1410 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1415 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_ETHERNET
)) {
1416 command_print(CMD_CTX
, "Ethernet connectivity is not supported by the "
1422 show_config_mac_address(CMD_CTX
);
1423 } else if (CMD_ARGC
== 1) {
1426 if ((strlen(str
) != 17) || (str
[2] != ':' || str
[5] != ':' || \
1427 str
[8] != ':' || str
[11] != ':' || str
[14] != ':')) {
1428 command_print(CMD_CTX
, "Invalid MAC address format.");
1429 return ERROR_COMMAND_SYNTAX_ERROR
;
1432 for (i
= 5; i
>= 0; i
--) {
1433 addr
[i
] = strtoul(str
, &e
, 16);
1437 if (!(addr
[0] | addr
[1] | addr
[2] | addr
[3] | addr
[4] | addr
[5])) {
1438 command_print(CMD_CTX
, "Invalid MAC address: zero address.");
1439 return ERROR_COMMAND_SYNTAX_ERROR
;
1442 if (!(0x01 & addr
[0])) {
1443 command_print(CMD_CTX
, "Invalid MAC address: multicast address.");
1444 return ERROR_COMMAND_SYNTAX_ERROR
;
1447 memcpy(tmp_config
.mac_address
, addr
, sizeof(addr
));
1449 command_print(CMD_CTX
, "Need exactly one argument for jlink config "
1451 return ERROR_COMMAND_SYNTAX_ERROR
;
1457 static bool string_to_ip(const char *s
, uint8_t *ip
, int *pos
)
1461 const char *s_save
= s
;
1467 for (i
= 0; i
< 4; i
++) {
1468 lip
[i
] = strtoul(s
, &e
, 10);
1470 if (*e
!= '.' && i
!= 3)
1477 memcpy(ip
, lip
, sizeof(lip
));
1482 static void cpy_ip(uint8_t *dst
, uint8_t *src
)
1486 for (i
= 0, j
= 3; i
< 4; i
++, j
--)
1490 COMMAND_HANDLER(jlink_handle_config_ip_address_command
)
1492 uint8_t ip_address
[4];
1493 uint32_t subnet_mask
= 0;
1495 uint8_t subnet_bits
= 24;
1497 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1498 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1503 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_ETHERNET
)) {
1504 command_print(CMD_CTX
, "Ethernet connectivity is not supported by the "
1510 show_config_ip_address(CMD_CTX
);
1512 if (!string_to_ip(CMD_ARGV
[0], ip_address
, &i
))
1513 return ERROR_COMMAND_SYNTAX_ERROR
;
1515 len
= strlen(CMD_ARGV
[0]);
1517 /* Check for format A.B.C.D/E. */
1519 if (CMD_ARGV
[0][i
] != '/')
1520 return ERROR_COMMAND_SYNTAX_ERROR
;
1522 COMMAND_PARSE_NUMBER(u8
, CMD_ARGV
[0] + i
+ 1, subnet_bits
);
1523 } else if (CMD_ARGC
> 1) {
1524 if (!string_to_ip(CMD_ARGV
[1], (uint8_t *)&subnet_mask
, &i
))
1525 return ERROR_COMMAND_SYNTAX_ERROR
;
1529 subnet_mask
= (uint32_t)(subnet_bits
< 32 ?
1530 ((1ULL << subnet_bits
) - 1) : 0xffffffff);
1532 cpy_ip(tmp_config
.ip_address
, ip_address
);
1533 cpy_ip(tmp_config
.subnet_mask
, (uint8_t *)&subnet_mask
);
1539 COMMAND_HANDLER(jlink_handle_config_reset_command
)
1541 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
))
1544 memcpy(&tmp_config
, &config
, sizeof(struct device_config
));
1550 COMMAND_HANDLER(jlink_handle_config_write_command
)
1554 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1555 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1560 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_WRITE_CONFIG
)) {
1561 command_print(CMD_CTX
, "Writing configuration is not supported by the "
1566 if (!memcmp(&config
, &tmp_config
, sizeof(struct device_config
))) {
1567 command_print(CMD_CTX
, "Operation not performed due to no changes in "
1568 "the configuration.");
1572 ret
= jaylink_write_raw_config(devh
, (const uint8_t *)&tmp_config
);
1574 if (ret
!= JAYLINK_OK
) {
1575 LOG_ERROR("jaylink_write_raw_config() failed: %s.",
1576 jaylink_strerror_name(ret
));
1580 if (!read_device_config(&config
)) {
1581 LOG_ERROR("Failed to read device configuration for verification.");
1585 if (memcmp(&config
, &tmp_config
, sizeof(struct device_config
))) {
1586 LOG_ERROR("Verification of device configuration failed. Please check "
1591 memcpy(&tmp_config
, &config
, sizeof(struct device_config
));
1592 command_print(CMD_CTX
, "The new device configuration applies after power "
1593 "cycling the J-Link device.");
1598 COMMAND_HANDLER(jlink_handle_config_command
)
1600 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1601 command_print(CMD_CTX
, "Device doesn't support reading configuration.");
1606 show_config(CMD_CTX
);
1611 COMMAND_HANDLER(jlink_handle_emucom_write_command
)
1621 return ERROR_COMMAND_SYNTAX_ERROR
;
1623 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_EMUCOM
)) {
1624 LOG_ERROR("Device does not support EMUCOM.");
1628 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], channel
);
1630 tmp
= strlen(CMD_ARGV
[1]);
1633 LOG_ERROR("Data must be encoded as hexadecimal pairs.");
1634 return ERROR_COMMAND_ARGUMENT_INVALID
;
1637 buf
= malloc(tmp
/ 2);
1640 LOG_ERROR("Failed to allocate buffer.");
1644 dummy
= unhexify(buf
, CMD_ARGV
[1], tmp
/ 2);
1646 if (dummy
!= (tmp
/ 2)) {
1647 LOG_ERROR("Data must be encoded as hexadecimal pairs.");
1649 return ERROR_COMMAND_ARGUMENT_INVALID
;
1653 ret
= jaylink_emucom_write(devh
, channel
, buf
, &length
);
1657 if (ret
== JAYLINK_ERR_DEV_NOT_SUPPORTED
) {
1658 LOG_ERROR("Channel not supported by the device.");
1660 } else if (ret
!= JAYLINK_OK
) {
1661 LOG_ERROR("Failed to write to channel: %s.",
1662 jaylink_strerror_name(ret
));
1666 if (length
!= (tmp
/ 2))
1667 LOG_WARNING("Only %" PRIu32
" bytes written to the channel.", length
);
1672 COMMAND_HANDLER(jlink_handle_emucom_read_command
)
1681 return ERROR_COMMAND_SYNTAX_ERROR
;
1683 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_EMUCOM
)) {
1684 LOG_ERROR("Device does not support EMUCOM.");
1688 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], channel
);
1689 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
1691 buf
= malloc(length
* 3 + 1);
1694 LOG_ERROR("Failed to allocate buffer.");
1698 ret
= jaylink_emucom_read(devh
, channel
, buf
, &length
);
1700 if (ret
== JAYLINK_ERR_DEV_NOT_SUPPORTED
) {
1701 LOG_ERROR("Channel is not supported by the device.");
1704 } else if (ret
== JAYLINK_ERR_DEV_NOT_AVAILABLE
) {
1705 LOG_ERROR("Channel is not available for the requested amount of data. "
1706 "%" PRIu32
" bytes are avilable.", length
);
1709 } else if (ret
!= JAYLINK_OK
) {
1710 LOG_ERROR("Failed to read from channel: %s.",
1711 jaylink_strerror_name(ret
));
1716 tmp
= hexify((char *)buf
+ length
, buf
, length
, 2 * length
+ 1);
1718 if (tmp
!= 2 * length
) {
1719 LOG_ERROR("Failed to convert data into hexadecimal string.");
1724 command_print(CMD_CTX
, "%s", buf
+ length
);
1730 static const struct command_registration jlink_config_subcommand_handlers
[] = {
1733 .handler
= &jlink_handle_config_usb_address_command
,
1734 .mode
= COMMAND_EXEC
,
1735 .help
= "set the USB address",
1739 .name
= "targetpower",
1740 .handler
= &jlink_handle_config_target_power_command
,
1741 .mode
= COMMAND_EXEC
,
1742 .help
= "set the target power supply",
1747 .handler
= &jlink_handle_config_mac_address_command
,
1748 .mode
= COMMAND_EXEC
,
1749 .help
= "set the MAC Address",
1750 .usage
= "[ff:ff:ff:ff:ff:ff]",
1754 .handler
= &jlink_handle_config_ip_address_command
,
1755 .mode
= COMMAND_EXEC
,
1756 .help
= "set the IP address, where A.B.C.D is the IP address, "
1757 "E the bit of the subnet mask, F.G.H.I the subnet mask",
1758 .usage
= "[A.B.C.D[/E] [F.G.H.I]]",
1762 .handler
= &jlink_handle_config_reset_command
,
1763 .mode
= COMMAND_EXEC
,
1764 .help
= "undo configuration changes"
1768 .handler
= &jlink_handle_config_write_command
,
1769 .mode
= COMMAND_EXEC
,
1770 .help
= "write configuration to the device"
1772 COMMAND_REGISTRATION_DONE
1775 static const struct command_registration jlink_emucom_subcommand_handlers
[] = {
1778 .handler
= &jlink_handle_emucom_write_command
,
1779 .mode
= COMMAND_EXEC
,
1780 .help
= "write to a channel",
1781 .usage
= "<channel> <data>",
1785 .handler
= &jlink_handle_emucom_read_command
,
1786 .mode
= COMMAND_EXEC
,
1787 .help
= "read from a channel",
1788 .usage
= "<channel> <length>"
1790 COMMAND_REGISTRATION_DONE
1793 static const struct command_registration jlink_subcommand_handlers
[] = {
1796 .handler
= &jlink_handle_jlink_jtag_command
,
1797 .mode
= COMMAND_EXEC
,
1798 .help
= "select the JTAG command version",
1802 .name
= "targetpower",
1803 .handler
= &jlink_handle_target_power_command
,
1804 .mode
= COMMAND_EXEC
,
1805 .help
= "set the target power supply",
1810 .handler
= &jlink_handle_free_memory_command
,
1811 .mode
= COMMAND_EXEC
,
1812 .help
= "show free device memory"
1816 .handler
= &jlink_handle_hwstatus_command
,
1817 .mode
= COMMAND_EXEC
,
1818 .help
= "show the hardware status"
1822 .handler
= &jlink_usb_command
,
1823 .mode
= COMMAND_CONFIG
,
1824 .help
= "set the USB address of the device that should be used",
1829 .handler
= &jlink_serial_command
,
1830 .mode
= COMMAND_CONFIG
,
1831 .help
= "set the serial number of the device that should be used",
1832 .usage
= "<serial number>"
1836 .handler
= &jlink_handle_config_command
,
1837 .mode
= COMMAND_EXEC
,
1838 .help
= "access the device configuration. If no argument is given "
1839 "this will show the device configuration",
1840 .chain
= jlink_config_subcommand_handlers
,
1844 .mode
= COMMAND_EXEC
,
1845 .help
= "access EMUCOM channel",
1846 .chain
= jlink_emucom_subcommand_handlers
1848 COMMAND_REGISTRATION_DONE
1851 static const struct command_registration jlink_command_handlers
[] = {
1854 .mode
= COMMAND_ANY
,
1855 .help
= "perform jlink management",
1856 .chain
= jlink_subcommand_handlers
,
1858 COMMAND_REGISTRATION_DONE
1861 static int jlink_swd_init(void)
1863 iface
= JAYLINK_TIF_SWD
;
1868 static void jlink_swd_write_reg(uint8_t cmd
, uint32_t value
, uint32_t ap_delay_clk
)
1870 assert(!(cmd
& SWD_CMD_RnW
));
1871 jlink_swd_queue_cmd(cmd
, NULL
, value
, ap_delay_clk
);
1874 static void jlink_swd_read_reg(uint8_t cmd
, uint32_t *value
, uint32_t ap_delay_clk
)
1876 assert(cmd
& SWD_CMD_RnW
);
1877 jlink_swd_queue_cmd(cmd
, value
, 0, ap_delay_clk
);
1880 static int_least32_t jlink_swd_frequency(int_least32_t hz
)
1883 jlink_speed(hz
/ 1000);
1888 /***************************************************************************/
1889 /* J-Link tap functions */
1891 static unsigned tap_length
;
1892 /* In SWD mode use tms buffer for direction control */
1893 static uint8_t tms_buffer
[JLINK_TAP_BUFFER_SIZE
];
1894 static uint8_t tdi_buffer
[JLINK_TAP_BUFFER_SIZE
];
1895 static uint8_t tdo_buffer
[JLINK_TAP_BUFFER_SIZE
];
1897 struct pending_scan_result
{
1898 /** First bit position in tdo_buffer to read. */
1900 /** Number of bits to read. */
1902 /** Location to store the result */
1904 /** Offset in the destination buffer */
1905 unsigned buffer_offset
;
1908 #define MAX_PENDING_SCAN_RESULTS 256
1910 static int pending_scan_results_length
;
1911 static struct pending_scan_result pending_scan_results_buffer
[MAX_PENDING_SCAN_RESULTS
];
1913 static void jlink_tap_init(void)
1916 pending_scan_results_length
= 0;
1917 memset(tms_buffer
, 0, sizeof(tms_buffer
));
1918 memset(tdi_buffer
, 0, sizeof(tdi_buffer
));
1921 static void jlink_clock_data(const uint8_t *out
, unsigned out_offset
,
1922 const uint8_t *tms_out
, unsigned tms_offset
,
1923 uint8_t *in
, unsigned in_offset
,
1927 unsigned available_length
= JLINK_TAP_BUFFER_SIZE
- tap_length
/ 8;
1929 if (!available_length
||
1930 (in
&& pending_scan_results_length
== MAX_PENDING_SCAN_RESULTS
)) {
1931 if (jlink_flush() != ERROR_OK
)
1933 available_length
= JLINK_TAP_BUFFER_SIZE
;
1936 struct pending_scan_result
*pending_scan_result
=
1937 &pending_scan_results_buffer
[pending_scan_results_length
];
1939 unsigned scan_length
= length
> available_length
?
1940 available_length
: length
;
1943 buf_set_buf(out
, out_offset
, tdi_buffer
, tap_length
, scan_length
);
1945 buf_set_buf(tms_out
, tms_offset
, tms_buffer
, tap_length
, scan_length
);
1948 pending_scan_result
->first
= tap_length
;
1949 pending_scan_result
->length
= scan_length
;
1950 pending_scan_result
->buffer
= in
;
1951 pending_scan_result
->buffer_offset
= in_offset
;
1952 pending_scan_results_length
++;
1955 tap_length
+= scan_length
;
1956 out_offset
+= scan_length
;
1957 tms_offset
+= scan_length
;
1958 in_offset
+= scan_length
;
1959 length
-= scan_length
;
1960 } while (length
> 0);
1963 static int jlink_flush(void)
1971 jlink_last_state
= jtag_debug_state_machine(tms_buffer
, tdi_buffer
,
1972 tap_length
, jlink_last_state
);
1974 ret
= jaylink_jtag_io(devh
, tms_buffer
, tdi_buffer
, tdo_buffer
,
1975 tap_length
, jtag_command_version
);
1977 if (ret
!= JAYLINK_OK
) {
1978 LOG_ERROR("jaylink_jtag_io() failed: %s.", jaylink_strerror_name(ret
));
1980 return ERROR_JTAG_QUEUE_FAILED
;
1983 for (i
= 0; i
< pending_scan_results_length
; i
++) {
1984 struct pending_scan_result
*p
= &pending_scan_results_buffer
[i
];
1986 buf_set_buf(tdo_buffer
, p
->first
, p
->buffer
,
1987 p
->buffer_offset
, p
->length
);
1989 DEBUG_JTAG_IO("Pending scan result, length = %d.", p
->length
);
1997 static void fill_buffer(uint8_t *buf
, uint32_t val
, uint32_t len
)
1999 unsigned int tap_pos
= tap_length
;
2002 buf_set_u32(buf
, tap_pos
, 32, val
);
2008 buf_set_u32(buf
, tap_pos
, len
, val
);
2011 static void jlink_queue_data_out(const uint8_t *data
, uint32_t len
)
2013 const uint32_t dir_out
= 0xffffffff;
2016 bit_copy(tdi_buffer
, tap_length
, data
, 0, len
);
2018 fill_buffer(tdi_buffer
, 0, len
);
2020 fill_buffer(tms_buffer
, dir_out
, len
);
2024 static void jlink_queue_data_in(uint32_t len
)
2026 const uint32_t dir_in
= 0;
2028 fill_buffer(tms_buffer
, dir_in
, len
);
2032 static int jlink_swd_switch_seq(enum swd_special_seq seq
)
2039 LOG_DEBUG("SWD line reset");
2040 s
= swd_seq_line_reset
;
2041 s_len
= swd_seq_line_reset_len
;
2044 LOG_DEBUG("JTAG-to-SWD");
2045 s
= swd_seq_jtag_to_swd
;
2046 s_len
= swd_seq_jtag_to_swd_len
;
2049 LOG_DEBUG("SWD-to-JTAG");
2050 s
= swd_seq_swd_to_jtag
;
2051 s_len
= swd_seq_swd_to_jtag_len
;
2054 LOG_ERROR("Sequence %d not supported.", seq
);
2058 jlink_queue_data_out(s
, s_len
);
2063 static int jlink_swd_run_queue(void)
2068 LOG_DEBUG("Executing %d queued transactions.", pending_scan_results_length
);
2070 if (queued_retval
!= ERROR_OK
) {
2071 LOG_DEBUG("Skipping due to previous errors: %d.", queued_retval
);
2076 * A transaction must be followed by another transaction or at least 8 idle
2077 * cycles to ensure that data is clocked through the AP.
2079 jlink_queue_data_out(NULL
, 8);
2081 ret
= jaylink_swd_io(devh
, tms_buffer
, tdi_buffer
, tdo_buffer
, tap_length
);
2083 if (ret
!= JAYLINK_OK
) {
2084 LOG_ERROR("jaylink_swd_io() failed: %s.", jaylink_strerror_name(ret
));
2088 for (i
= 0; i
< pending_scan_results_length
; i
++) {
2089 int ack
= buf_get_u32(tdo_buffer
, pending_scan_results_buffer
[i
].first
, 3);
2091 if (ack
!= SWD_ACK_OK
) {
2092 LOG_DEBUG("SWD ack not OK: %d %s", ack
,
2093 ack
== SWD_ACK_WAIT
? "WAIT" : ack
== SWD_ACK_FAULT
? "FAULT" : "JUNK");
2094 queued_retval
= ack
== SWD_ACK_WAIT
? ERROR_WAIT
: ERROR_FAIL
;
2096 } else if (pending_scan_results_buffer
[i
].length
) {
2097 uint32_t data
= buf_get_u32(tdo_buffer
, 3 + pending_scan_results_buffer
[i
].first
, 32);
2098 int parity
= buf_get_u32(tdo_buffer
, 3 + 32 + pending_scan_results_buffer
[i
].first
, 1);
2100 if (parity
!= parity_u32(data
)) {
2101 LOG_ERROR("SWD: Read data parity mismatch.");
2102 queued_retval
= ERROR_FAIL
;
2106 if (pending_scan_results_buffer
[i
].buffer
)
2107 *(uint32_t *)pending_scan_results_buffer
[i
].buffer
= data
;
2113 ret
= queued_retval
;
2114 queued_retval
= ERROR_OK
;
2119 static void jlink_swd_queue_cmd(uint8_t cmd
, uint32_t *dst
, uint32_t data
, uint32_t ap_delay_clk
)
2121 uint8_t data_parity_trn
[DIV_ROUND_UP(32 + 1, 8)];
2122 if (tap_length
+ 46 + 8 + ap_delay_clk
>= sizeof(tdi_buffer
) * 8 ||
2123 pending_scan_results_length
== MAX_PENDING_SCAN_RESULTS
) {
2124 /* Not enough room in the queue. Run the queue. */
2125 queued_retval
= jlink_swd_run_queue();
2128 if (queued_retval
!= ERROR_OK
)
2131 cmd
|= SWD_CMD_START
| SWD_CMD_PARK
;
2133 jlink_queue_data_out(&cmd
, 8);
2135 pending_scan_results_buffer
[pending_scan_results_length
].first
= tap_length
;
2137 if (cmd
& SWD_CMD_RnW
) {
2138 /* Queue a read transaction. */
2139 pending_scan_results_buffer
[pending_scan_results_length
].length
= 32;
2140 pending_scan_results_buffer
[pending_scan_results_length
].buffer
= dst
;
2142 jlink_queue_data_in(1 + 3 + 32 + 1 + 1);
2144 /* Queue a write transaction. */
2145 pending_scan_results_buffer
[pending_scan_results_length
].length
= 0;
2146 jlink_queue_data_in(1 + 3 + 1);
2148 buf_set_u32(data_parity_trn
, 0, 32, data
);
2149 buf_set_u32(data_parity_trn
, 32, 1, parity_u32(data
));
2151 jlink_queue_data_out(data_parity_trn
, 32 + 1);
2154 pending_scan_results_length
++;
2156 /* Insert idle cycles after AP accesses to avoid WAIT. */
2157 if (cmd
& SWD_CMD_APnDP
)
2158 jlink_queue_data_out(NULL
, ap_delay_clk
);
2161 static const struct swd_driver jlink_swd
= {
2162 .init
= &jlink_swd_init
,
2163 .frequency
= &jlink_swd_frequency
,
2164 .switch_seq
= &jlink_swd_switch_seq
,
2165 .read_reg
= &jlink_swd_read_reg
,
2166 .write_reg
= &jlink_swd_write_reg
,
2167 .run
= &jlink_swd_run_queue
,
2170 static const char * const jlink_transports
[] = { "jtag", "swd", NULL
};
2172 struct jtag_interface jlink_interface
= {
2174 .commands
= jlink_command_handlers
,
2175 .transports
= jlink_transports
,
2177 .execute_queue
= &jlink_execute_queue
,
2178 .speed
= &jlink_speed
,
2179 .speed_div
= &jlink_speed_div
,
2181 .init
= &jlink_init
,
2182 .quit
= &jlink_quit
,
2183 .config_trace
= &config_trace
,
2184 .poll_trace
= &poll_trace
,