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, write to the *
29 * Free Software Foundation, Inc., *
30 ***************************************************************************/
39 #include <jtag/interface.h>
41 #include <jtag/commands.h>
43 #include <libjaylink/libjaylink.h>
45 static struct jaylink_context
*jayctx
;
46 static struct jaylink_device_handle
*devh
;
47 static struct jaylink_connection conn
;
48 static struct jaylink_connection connlist
[JAYLINK_MAX_CONNECTIONS
];
49 static enum jaylink_jtag_version jtag_command_version
;
50 static uint8_t caps
[JAYLINK_DEV_EXT_CAPS_SIZE
];
52 static uint32_t serial_number
;
53 static bool use_serial_number
;
54 static enum jaylink_usb_address usb_address
;
55 static bool use_usb_address
;
56 static enum jaylink_target_interface iface
= JAYLINK_TIF_JTAG
;
57 static bool trace_enabled
;
59 #define JLINK_MAX_SPEED 12000
60 #define JLINK_TAP_BUFFER_SIZE 2048
62 static unsigned int swd_buffer_size
= JLINK_TAP_BUFFER_SIZE
;
64 /* 256 byte non-volatile memory */
65 struct device_config
{
67 /* 0ffset 0x01 to 0x03 */
68 uint8_t reserved_1
[3];
69 uint32_t target_power
;
70 /* 0ffset 0x08 to 0x1f */
71 uint8_t reserved_2
[24];
72 /* IP only for J-Link Pro */
73 uint8_t ip_address
[4];
74 uint8_t subnet_mask
[4];
75 /* 0ffset 0x28 to 0x2f */
76 uint8_t reserved_3
[8];
77 uint8_t mac_address
[6];
78 /* 0ffset 0x36 to 0xff */
79 uint8_t reserved_4
[202];
80 } __attribute__ ((packed
));
82 static struct device_config config
;
83 static struct device_config tmp_config
;
85 /* Queue command functions */
86 static void jlink_end_state(tap_state_t state
);
87 static void jlink_state_move(void);
88 static void jlink_path_move(int num_states
, tap_state_t
*path
);
89 static void jlink_stableclocks(int num_cycles
);
90 static void jlink_runtest(int num_cycles
);
91 static void jlink_reset(int trst
, int srst
);
92 static int jlink_swd_run_queue(void);
93 static void jlink_swd_queue_cmd(uint8_t cmd
, uint32_t *dst
, uint32_t data
, uint32_t ap_delay_clk
);
94 static int jlink_swd_switch_seq(enum swd_special_seq seq
);
96 /* J-Link tap buffer functions */
97 static void jlink_tap_init(void);
98 static int jlink_flush(void);
100 * Queue data to go out and in, flushing the queue as many times as
103 * @param out A pointer to TDI data, if NULL, old stale data will be used.
104 * @param out_offset A bit offset for TDI data.
105 * @param tms_out A pointer to TMS data, if NULL, zeroes will be emitted.
106 * @param tms_offset A bit offset for TMS data.
107 * @param in A pointer to store TDO data to, if NULL the data will be discarded.
108 * @param in_offset A bit offset for TDO data.
109 * @param length Amount of bits to transfer out and in.
111 * @retval This function doesn't return any value.
113 static void jlink_clock_data(const uint8_t *out
, unsigned out_offset
,
114 const uint8_t *tms_out
, unsigned tms_offset
,
115 uint8_t *in
, unsigned in_offset
,
118 static enum tap_state jlink_last_state
= TAP_RESET
;
119 static int queued_retval
;
121 /***************************************************************************/
122 /* External interface implementation */
124 static void jlink_execute_stableclocks(struct jtag_command
*cmd
)
126 DEBUG_JTAG_IO("stableclocks %i cycles", cmd
->cmd
.runtest
->num_cycles
);
127 jlink_stableclocks(cmd
->cmd
.runtest
->num_cycles
);
130 static void jlink_execute_runtest(struct jtag_command
*cmd
)
132 DEBUG_JTAG_IO("runtest %i cycles, end in %i", cmd
->cmd
.runtest
->num_cycles
,
133 cmd
->cmd
.runtest
->end_state
);
135 jlink_end_state(cmd
->cmd
.runtest
->end_state
);
136 jlink_runtest(cmd
->cmd
.runtest
->num_cycles
);
139 static void jlink_execute_statemove(struct jtag_command
*cmd
)
141 DEBUG_JTAG_IO("statemove end in %i", cmd
->cmd
.statemove
->end_state
);
143 jlink_end_state(cmd
->cmd
.statemove
->end_state
);
147 static void jlink_execute_pathmove(struct jtag_command
*cmd
)
149 DEBUG_JTAG_IO("pathmove: %i states, end in %i",
150 cmd
->cmd
.pathmove
->num_states
,
151 cmd
->cmd
.pathmove
->path
[cmd
->cmd
.pathmove
->num_states
- 1]);
153 jlink_path_move(cmd
->cmd
.pathmove
->num_states
, cmd
->cmd
.pathmove
->path
);
156 static void jlink_execute_scan(struct jtag_command
*cmd
)
158 DEBUG_JTAG_IO("%s type:%d", cmd
->cmd
.scan
->ir_scan
? "IRSCAN" : "DRSCAN",
159 jtag_scan_type(cmd
->cmd
.scan
));
161 /* Make sure there are no trailing fields with num_bits == 0, or the logic below will fail. */
162 while (cmd
->cmd
.scan
->num_fields
> 0
163 && cmd
->cmd
.scan
->fields
[cmd
->cmd
.scan
->num_fields
- 1].num_bits
== 0) {
164 cmd
->cmd
.scan
->num_fields
--;
165 LOG_DEBUG("discarding trailing empty field");
168 if (cmd
->cmd
.scan
->num_fields
== 0) {
169 LOG_DEBUG("empty scan, doing nothing");
173 if (cmd
->cmd
.scan
->ir_scan
) {
174 if (tap_get_state() != TAP_IRSHIFT
) {
175 jlink_end_state(TAP_IRSHIFT
);
179 if (tap_get_state() != TAP_DRSHIFT
) {
180 jlink_end_state(TAP_DRSHIFT
);
185 jlink_end_state(cmd
->cmd
.scan
->end_state
);
187 struct scan_field
*field
= cmd
->cmd
.scan
->fields
;
188 unsigned scan_size
= 0;
190 for (int i
= 0; i
< cmd
->cmd
.scan
->num_fields
; i
++, field
++) {
191 scan_size
+= field
->num_bits
;
192 DEBUG_JTAG_IO("%s%s field %d/%d %d bits",
193 field
->in_value
? "in" : "",
194 field
->out_value
? "out" : "",
196 cmd
->cmd
.scan
->num_fields
,
199 if (i
== cmd
->cmd
.scan
->num_fields
- 1 && tap_get_state() != tap_get_end_state()) {
200 /* Last field, and we're leaving IRSHIFT/DRSHIFT. Clock last bit during tap
201 * movement. This last field can't have length zero, it was checked above. */
202 jlink_clock_data(field
->out_value
,
208 field
->num_bits
- 1);
209 uint8_t last_bit
= 0;
210 if (field
->out_value
)
211 bit_copy(&last_bit
, 0, field
->out_value
, field
->num_bits
- 1, 1);
212 uint8_t tms_bits
= 0x01;
213 jlink_clock_data(&last_bit
,
220 tap_set_state(tap_state_transition(tap_get_state(), 1));
221 jlink_clock_data(&last_bit
,
228 tap_set_state(tap_state_transition(tap_get_state(), 0));
230 jlink_clock_data(field
->out_value
,
239 if (tap_get_state() != tap_get_end_state()) {
240 jlink_end_state(tap_get_end_state());
244 DEBUG_JTAG_IO("%s scan, %i bits, end in %s",
245 (cmd
->cmd
.scan
->ir_scan
) ? "IR" : "DR", scan_size
,
246 tap_state_name(tap_get_end_state()));
249 static void jlink_execute_reset(struct jtag_command
*cmd
)
251 DEBUG_JTAG_IO("reset trst: %i srst %i", cmd
->cmd
.reset
->trst
,
252 cmd
->cmd
.reset
->srst
);
255 jlink_reset(cmd
->cmd
.reset
->trst
, cmd
->cmd
.reset
->srst
);
259 static void jlink_execute_sleep(struct jtag_command
*cmd
)
261 DEBUG_JTAG_IO("sleep %" PRIi32
"", cmd
->cmd
.sleep
->us
);
263 jtag_sleep(cmd
->cmd
.sleep
->us
);
266 static int jlink_execute_command(struct jtag_command
*cmd
)
269 case JTAG_STABLECLOCKS
:
270 jlink_execute_stableclocks(cmd
);
273 jlink_execute_runtest(cmd
);
276 jlink_execute_statemove(cmd
);
279 jlink_execute_pathmove(cmd
);
282 jlink_execute_scan(cmd
);
285 jlink_execute_reset(cmd
);
288 jlink_execute_sleep(cmd
);
291 LOG_ERROR("BUG: Unknown JTAG command type encountered.");
292 return ERROR_JTAG_QUEUE_FAILED
;
298 static int jlink_execute_queue(void)
301 struct jtag_command
*cmd
= jtag_command_queue
;
303 while (cmd
!= NULL
) {
304 ret
= jlink_execute_command(cmd
);
312 return jlink_flush();
315 static int jlink_speed(int speed
)
322 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_SPEEDS
)) {
323 ret
= jaylink_get_speeds(devh
, &freq
, ÷r
);
325 if (ret
!= JAYLINK_OK
) {
326 LOG_ERROR("jaylink_get_speeds() failed: %s.",
327 jaylink_strerror_name(ret
));
328 return ERROR_JTAG_DEVICE_ERROR
;
332 max_speed
= freq
/ divider
;
334 max_speed
= JLINK_MAX_SPEED
;
338 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_ADAPTIVE_CLOCKING
)) {
339 LOG_ERROR("Adaptive clocking is not supported by the device.");
340 return ERROR_JTAG_NOT_IMPLEMENTED
;
343 speed
= JAYLINK_SPEED_ADAPTIVE_CLOCKING
;
344 } else if (speed
> max_speed
) {
345 LOG_INFO("Reduced speed from %d kHz to %d kHz (maximum).", speed
,
350 ret
= jaylink_set_speed(devh
, speed
);
352 if (ret
!= JAYLINK_OK
) {
353 LOG_ERROR("jaylink_set_speed() failed: %s.",
354 jaylink_strerror_name(ret
));
355 return ERROR_JTAG_DEVICE_ERROR
;
361 static int jlink_speed_div(int speed
, int *khz
)
368 static int jlink_khz(int khz
, int *jtag_speed
)
375 static bool read_device_config(struct device_config
*cfg
)
379 ret
= jaylink_read_raw_config(devh
, (uint8_t *)cfg
);
381 if (ret
!= JAYLINK_OK
) {
382 LOG_ERROR("jaylink_read_raw_config() failed: %s.",
383 jaylink_strerror_name(ret
));
387 if (cfg
->usb_address
== 0xff)
388 cfg
->usb_address
= 0x00;
390 if (cfg
->target_power
== 0xffffffff)
391 cfg
->target_power
= 0;
396 static int select_interface(void)
401 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SELECT_TIF
)) {
402 if (iface
!= JAYLINK_TIF_JTAG
) {
403 LOG_ERROR("Device supports JTAG transport only.");
404 return ERROR_JTAG_INIT_FAILED
;
410 ret
= jaylink_get_available_interfaces(devh
, &interfaces
);
412 if (ret
!= JAYLINK_OK
) {
413 LOG_ERROR("jaylink_get_available_interfaces() failed: %s.",
414 jaylink_strerror_name(ret
));
415 return ERROR_JTAG_INIT_FAILED
;
418 if (!(interfaces
& (1 << iface
))) {
419 LOG_ERROR("Selected transport is not supported by the device.");
420 return ERROR_JTAG_INIT_FAILED
;
423 ret
= jaylink_select_interface(devh
, iface
, NULL
);
426 LOG_ERROR("jaylink_select_interface() failed: %s.",
427 jaylink_strerror_name(ret
));
428 return ERROR_JTAG_INIT_FAILED
;
434 static int jlink_register(void)
440 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_REGISTER
))
443 ret
= jaylink_register(devh
, &conn
, connlist
, NULL
, NULL
);
446 LOG_ERROR("jaylink_register() failed: %s.",
447 jaylink_strerror_name(ret
));
451 handle_found
= false;
453 for (i
= 0; i
< ret
; i
++) {
454 if (connlist
[i
].handle
== conn
.handle
) {
461 LOG_ERROR("Registration failed: maximum number of connections on the "
470 * Adjust the SWD transaction buffer size depending on the free device internal
471 * memory. This ensures that the SWD transactions sent to the device do not
472 * exceed the internal memory of the device.
474 static bool adjust_swd_buffer_size(void)
479 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_FREE_MEMORY
))
482 ret
= jaylink_get_free_memory(devh
, &tmp
);
484 if (ret
!= JAYLINK_OK
) {
485 LOG_ERROR("jaylink_get_free_memory() failed: %s.",
486 jaylink_strerror_name(ret
));
491 LOG_ERROR("Not enough free device internal memory: %u bytes.", tmp
);
495 tmp
= MIN(JLINK_TAP_BUFFER_SIZE
, (tmp
- 16) / 2);
497 if (tmp
!= swd_buffer_size
) {
498 swd_buffer_size
= tmp
;
499 LOG_DEBUG("Adjusted SWD transaction buffer size to %u bytes.",
506 static int jlink_init(void)
509 struct jaylink_device
**devs
;
513 char *firmware_version
;
514 struct jaylink_hardware_version hwver
;
515 struct jaylink_hardware_status hwstatus
;
516 enum jaylink_usb_address address
;
519 ret
= jaylink_init(&jayctx
);
521 if (ret
!= JAYLINK_OK
) {
522 LOG_ERROR("jaylink_init() failed: %s.",
523 jaylink_strerror_name(ret
));
524 return ERROR_JTAG_INIT_FAILED
;
527 ret
= jaylink_get_device_list(jayctx
, &devs
);
530 LOG_ERROR("jaylink_get_device_list() failed: %s.",
531 jaylink_strerror_name(ret
));
532 jaylink_exit(jayctx
);
533 return ERROR_JTAG_INIT_FAILED
;
536 found_device
= false;
538 if (!use_serial_number
&& !use_usb_address
)
539 LOG_INFO("No device selected, using first device.");
541 for (i
= 0; devs
[i
]; i
++) {
542 if (use_serial_number
) {
543 ret
= jaylink_device_get_serial_number(devs
[i
], &tmp
);
545 if (ret
== JAYLINK_ERR_NOT_AVAILABLE
) {
547 } else if (ret
!= JAYLINK_OK
) {
548 LOG_WARNING("jaylink_device_get_serial_number() failed: %s.",
549 jaylink_strerror_name(ret
));
553 if (serial_number
!= tmp
)
557 if (use_usb_address
) {
558 ret
= jaylink_device_get_usb_address(devs
[i
], &address
);
560 if (ret
!= JAYLINK_OK
) {
561 LOG_WARNING("jaylink_device_get_usb_address() failed: %s.",
562 jaylink_strerror_name(ret
));
566 if (usb_address
!= address
)
570 ret
= jaylink_open(devs
[i
], &devh
);
572 if (ret
== JAYLINK_OK
) {
577 LOG_ERROR("Failed to open device: %s.", jaylink_strerror_name(ret
));
580 jaylink_free_device_list(devs
, 1);
583 LOG_ERROR("No J-Link device found.");
584 jaylink_exit(jayctx
);
585 return ERROR_JTAG_INIT_FAILED
;
589 * Be careful with changing the following initialization sequence because
590 * some devices are known to be sensitive regarding the order.
593 ret
= jaylink_get_firmware_version(devh
, &firmware_version
, &length
);
595 if (ret
!= JAYLINK_OK
) {
596 LOG_ERROR("jaylink_get_firmware_version() failed: %s.",
597 jaylink_strerror_name(ret
));
599 jaylink_exit(jayctx
);
600 return ERROR_JTAG_INIT_FAILED
;
601 } else if (length
> 0) {
602 LOG_INFO("%s", firmware_version
);
603 free(firmware_version
);
605 LOG_WARNING("Device responds empty firmware version string.");
608 memset(caps
, 0, JAYLINK_DEV_EXT_CAPS_SIZE
);
609 ret
= jaylink_get_caps(devh
, caps
);
611 if (ret
!= JAYLINK_OK
) {
612 LOG_ERROR("jaylink_get_caps() failed: %s.", jaylink_strerror_name(ret
));
614 jaylink_exit(jayctx
);
615 return ERROR_JTAG_INIT_FAILED
;
618 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_EXT_CAPS
)) {
619 ret
= jaylink_get_extended_caps(devh
, caps
);
621 if (ret
!= JAYLINK_OK
) {
622 LOG_ERROR("jaylink_get_extended_caps() failed: %s.",
623 jaylink_strerror_name(ret
));
625 jaylink_exit(jayctx
);
626 return ERROR_JTAG_INIT_FAILED
;
630 jtag_command_version
= JAYLINK_JTAG_V2
;
632 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_HW_VERSION
)) {
633 ret
= jaylink_get_hardware_version(devh
, &hwver
);
635 if (ret
!= JAYLINK_OK
) {
636 LOG_ERROR("Failed to retrieve hardware version: %s.",
637 jaylink_strerror_name(ret
));
639 jaylink_exit(jayctx
);
640 return ERROR_JTAG_INIT_FAILED
;
643 LOG_INFO("Hardware version: %u.%02u", hwver
.major
, hwver
.minor
);
645 if (hwver
.major
>= 5)
646 jtag_command_version
= JAYLINK_JTAG_V3
;
649 if (iface
== JAYLINK_TIF_SWD
) {
651 * Adjust the SWD transaction buffer size in case there is already
652 * allocated memory on the device. This happens for example if the
653 * memory for SWO capturing is still allocated because the software
654 * which used the device before has not been shut down properly.
656 if (!adjust_swd_buffer_size()) {
658 jaylink_exit(jayctx
);
659 return ERROR_JTAG_INIT_FAILED
;
663 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
664 if (!read_device_config(&config
)) {
665 LOG_ERROR("Failed to read device configuration data.");
667 jaylink_exit(jayctx
);
668 return ERROR_JTAG_INIT_FAILED
;
671 memcpy(&tmp_config
, &config
, sizeof(struct device_config
));
674 ret
= jaylink_get_hardware_status(devh
, &hwstatus
);
676 if (ret
!= JAYLINK_OK
) {
677 LOG_ERROR("jaylink_get_hardware_status() failed: %s.",
678 jaylink_strerror_name(ret
));
680 jaylink_exit(jayctx
);
681 return ERROR_JTAG_INIT_FAILED
;
684 LOG_INFO("VTarget = %u.%03u V", hwstatus
.target_voltage
/ 1000,
685 hwstatus
.target_voltage
% 1000);
693 ret
= jlink_register();
695 if (ret
!= ERROR_OK
) {
697 jaylink_exit(jayctx
);
698 return ERROR_JTAG_INIT_FAILED
;
701 ret
= select_interface();
703 if (ret
!= ERROR_OK
) {
705 jaylink_exit(jayctx
);
713 jlink_speed(jtag_get_speed_khz());
715 if (iface
== JAYLINK_TIF_JTAG
) {
717 * J-Link devices with firmware version v5 and v6 seems to have an issue
718 * if the first tap move is not divisible by 8, so we send a TLR on
722 jlink_clock_data(NULL
, 0, &tms
, 0, NULL
, 0, 8);
730 static int jlink_quit(void)
735 ret
= jaylink_swo_stop(devh
);
737 if (ret
!= JAYLINK_OK
)
738 LOG_ERROR("jaylink_swo_stop() failed: %s.",
739 jaylink_strerror_name(ret
));
742 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_REGISTER
)) {
743 ret
= jaylink_unregister(devh
, &conn
, connlist
, NULL
, NULL
);
746 LOG_ERROR("jaylink_unregister() failed: %s.",
747 jaylink_strerror_name(ret
));
751 jaylink_exit(jayctx
);
756 /***************************************************************************/
757 /* Queue command implementations */
759 static void jlink_end_state(tap_state_t state
)
761 if (tap_is_state_stable(state
))
762 tap_set_end_state(state
);
764 LOG_ERROR("BUG: %i is not a valid end state", state
);
769 /* Goes to the end state. */
770 static void jlink_state_move(void)
773 uint8_t tms_scan_bits
;
775 tms_scan
= tap_get_tms_path(tap_get_state(), tap_get_end_state());
776 tms_scan_bits
= tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
778 jlink_clock_data(NULL
, 0, &tms_scan
, 0, NULL
, 0, tms_scan_bits
);
780 tap_set_state(tap_get_end_state());
783 static void jlink_path_move(int num_states
, tap_state_t
*path
)
788 for (i
= 0; i
< num_states
; i
++) {
789 if (path
[i
] == tap_state_transition(tap_get_state(), false))
790 jlink_clock_data(NULL
, 0, NULL
, 0, NULL
, 0, 1);
791 else if (path
[i
] == tap_state_transition(tap_get_state(), true))
792 jlink_clock_data(NULL
, 0, &tms
, 0, NULL
, 0, 1);
794 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition.",
795 tap_state_name(tap_get_state()), tap_state_name(path
[i
]));
799 tap_set_state(path
[i
]);
802 tap_set_end_state(tap_get_state());
805 static void jlink_stableclocks(int num_cycles
)
809 uint8_t tms
= tap_get_state() == TAP_RESET
;
810 /* Execute num_cycles. */
811 for (i
= 0; i
< num_cycles
; i
++)
812 jlink_clock_data(NULL
, 0, &tms
, 0, NULL
, 0, 1);
815 static void jlink_runtest(int num_cycles
)
817 tap_state_t saved_end_state
= tap_get_end_state();
819 /* Only do a state_move when we're not already in IDLE. */
820 if (tap_get_state() != TAP_IDLE
) {
821 jlink_end_state(TAP_IDLE
);
826 jlink_stableclocks(num_cycles
);
828 /* Finish in end_state. */
829 jlink_end_state(saved_end_state
);
831 if (tap_get_state() != tap_get_end_state())
835 static void jlink_reset(int trst
, int srst
)
837 LOG_DEBUG("TRST: %i, SRST: %i.", trst
, srst
);
839 /* Signals are active low. */
841 jaylink_set_reset(devh
);
844 jaylink_clear_reset(devh
);
847 jaylink_jtag_clear_trst(devh
);
850 jaylink_jtag_set_trst(devh
);
853 COMMAND_HANDLER(jlink_usb_command
)
858 command_print(CMD_CTX
, "Need exactly one argument for jlink usb.");
859 return ERROR_COMMAND_SYNTAX_ERROR
;
862 if (sscanf(CMD_ARGV
[0], "%i", &tmp
) != 1) {
863 command_print(CMD_CTX
, "Invalid USB address: %s.", CMD_ARGV
[0]);
867 if (tmp
< JAYLINK_USB_ADDRESS_0
|| tmp
> JAYLINK_USB_ADDRESS_3
) {
868 command_print(CMD_CTX
, "Invalid USB address: %s.", CMD_ARGV
[0]);
874 use_serial_number
= false;
875 use_usb_address
= true;
880 COMMAND_HANDLER(jlink_serial_command
)
883 command_print(CMD_CTX
, "Need exactly one argument for jlink serial.");
884 return ERROR_COMMAND_SYNTAX_ERROR
;
887 if (sscanf(CMD_ARGV
[0], "%" SCNd32
, &serial_number
) != 1) {
888 command_print(CMD_CTX
, "Invalid serial number: %s.", CMD_ARGV
[0]);
892 use_serial_number
= true;
893 use_usb_address
= false;
898 COMMAND_HANDLER(jlink_handle_hwstatus_command
)
901 struct jaylink_hardware_status status
;
903 ret
= jaylink_get_hardware_status(devh
, &status
);
905 if (ret
!= JAYLINK_OK
) {
906 command_print(CMD_CTX
, "jaylink_get_hardware_status() failed: %s.",
907 jaylink_strerror_name(ret
));
911 command_print(CMD_CTX
, "VTarget = %u.%03u V",
912 status
.target_voltage
/ 1000, status
.target_voltage
% 1000);
914 command_print(CMD_CTX
, "TCK = %u TDI = %u TDO = %u TMS = %u SRST = %u "
915 "TRST = %u", status
.tck
, status
.tdi
, status
.tdo
, status
.tms
,
916 status
.tres
, status
.trst
);
918 if (status
.target_voltage
< 1500)
919 command_print(CMD_CTX
, "Target voltage too low. Check target power.");
924 COMMAND_HANDLER(jlink_handle_free_memory_command
)
929 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_FREE_MEMORY
)) {
930 command_print(CMD_CTX
, "Retrieval of free memory is not supported by "
935 ret
= jaylink_get_free_memory(devh
, &tmp
);
937 if (ret
!= JAYLINK_OK
) {
938 command_print(CMD_CTX
, "jaylink_get_free_memory() failed: %s.",
939 jaylink_strerror_name(ret
));
943 command_print(CMD_CTX
, "Device has %u bytes of free memory.", tmp
);
948 COMMAND_HANDLER(jlink_handle_jlink_jtag_command
)
954 switch (jtag_command_version
) {
955 case JAYLINK_JTAG_V2
:
958 case JAYLINK_JTAG_V3
:
965 command_print(CMD_CTX
, "JTAG command version: %i", version
);
966 } else if (CMD_ARGC
== 1) {
967 if (sscanf(CMD_ARGV
[0], "%i", &tmp
) != 1) {
968 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
969 return ERROR_COMMAND_SYNTAX_ERROR
;
974 jtag_command_version
= JAYLINK_JTAG_V2
;
977 jtag_command_version
= JAYLINK_JTAG_V3
;
980 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
981 return ERROR_COMMAND_SYNTAX_ERROR
;
984 command_print(CMD_CTX
, "Need exactly one argument for jlink jtag.");
985 return ERROR_COMMAND_SYNTAX_ERROR
;
991 COMMAND_HANDLER(jlink_handle_target_power_command
)
997 command_print(CMD_CTX
, "Need exactly one argument for jlink "
999 return ERROR_COMMAND_SYNTAX_ERROR
;
1002 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SET_TARGET_POWER
)) {
1003 command_print(CMD_CTX
, "Target power supply is not supported by the "
1008 if (!strcmp(CMD_ARGV
[0], "on")) {
1010 } else if (!strcmp(CMD_ARGV
[0], "off")) {
1013 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
1017 ret
= jaylink_set_target_power(devh
, enable
);
1019 if (ret
!= JAYLINK_OK
) {
1020 command_print(CMD_CTX
, "jaylink_set_target_power() failed: %s.",
1021 jaylink_strerror_name(ret
));
1028 static void show_config_usb_address(struct command_context
*ctx
)
1030 if (config
.usb_address
!= tmp_config
.usb_address
)
1031 command_print(ctx
, "USB address: %u [%u]", config
.usb_address
,
1032 tmp_config
.usb_address
);
1034 command_print(ctx
, "USB address: %u", config
.usb_address
);
1037 static void show_config_ip_address(struct command_context
*ctx
)
1039 if (!memcmp(config
.ip_address
, tmp_config
.ip_address
, 4))
1040 command_print(ctx
, "IP address: %d.%d.%d.%d",
1041 config
.ip_address
[3], config
.ip_address
[2],
1042 config
.ip_address
[1], config
.ip_address
[0]);
1044 command_print(ctx
, "IP address: %d.%d.%d.%d [%d.%d.%d.%d]",
1045 config
.ip_address
[3], config
.ip_address
[2],
1046 config
.ip_address
[1], config
.ip_address
[0],
1047 tmp_config
.ip_address
[3], tmp_config
.ip_address
[2],
1048 tmp_config
.ip_address
[1], tmp_config
.ip_address
[0]);
1050 if (!memcmp(config
.subnet_mask
, tmp_config
.subnet_mask
, 4))
1051 command_print(ctx
, "Subnet mask: %d.%d.%d.%d",
1052 config
.subnet_mask
[3], config
.subnet_mask
[2],
1053 config
.subnet_mask
[1], config
.subnet_mask
[0]);
1055 command_print(ctx
, "Subnet mask: %d.%d.%d.%d [%d.%d.%d.%d]",
1056 config
.subnet_mask
[3], config
.subnet_mask
[2],
1057 config
.subnet_mask
[1], config
.subnet_mask
[0],
1058 tmp_config
.subnet_mask
[3], tmp_config
.subnet_mask
[2],
1059 tmp_config
.subnet_mask
[1], tmp_config
.subnet_mask
[0]);
1062 static void show_config_mac_address(struct command_context
*ctx
)
1064 if (!memcmp(config
.mac_address
, tmp_config
.mac_address
, 6))
1065 command_print(ctx
, "MAC address: %.02x:%.02x:%.02x:%.02x:%.02x:%.02x",
1066 config
.mac_address
[5], config
.mac_address
[4],
1067 config
.mac_address
[3], config
.mac_address
[2],
1068 config
.mac_address
[1], config
.mac_address
[0]);
1070 command_print(ctx
, "MAC address: %.02x:%.02x:%.02x:%.02x:%.02x:%.02x "
1071 "[%.02x:%.02x:%.02x:%.02x:%.02x:%.02x]",
1072 config
.mac_address
[5], config
.mac_address
[4],
1073 config
.mac_address
[3], config
.mac_address
[2],
1074 config
.mac_address
[1], config
.mac_address
[0],
1075 tmp_config
.mac_address
[5], tmp_config
.mac_address
[4],
1076 tmp_config
.mac_address
[3], tmp_config
.mac_address
[2],
1077 tmp_config
.mac_address
[1], tmp_config
.mac_address
[0]);
1080 static void show_config_target_power(struct command_context
*ctx
)
1082 const char *target_power
;
1083 const char *current_target_power
;
1085 if (!config
.target_power
)
1086 target_power
= "off";
1088 target_power
= "on";
1090 if (!tmp_config
.target_power
)
1091 current_target_power
= "off";
1093 current_target_power
= "on";
1095 if (config
.target_power
!= tmp_config
.target_power
)
1096 command_print(ctx
, "Target power supply: %s [%s]", target_power
,
1097 current_target_power
);
1099 command_print(ctx
, "Target power supply: %s", target_power
);
1102 static void show_config(struct command_context
*ctx
)
1104 command_print(ctx
, "J-Link device configuration:");
1106 show_config_usb_address(ctx
);
1108 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SET_TARGET_POWER
))
1109 show_config_target_power(ctx
);
1111 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_ETHERNET
)) {
1112 show_config_ip_address(ctx
);
1113 show_config_mac_address(ctx
);
1117 static int poll_trace(uint8_t *buf
, size_t *size
)
1124 ret
= jaylink_swo_read(devh
, buf
, &length
);
1126 if (ret
!= JAYLINK_OK
) {
1127 LOG_ERROR("jaylink_swo_read() failed: %s.", jaylink_strerror_name(ret
));
1136 static uint32_t calculate_trace_buffer_size(void)
1141 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_FREE_MEMORY
))
1144 ret
= jaylink_get_free_memory(devh
, &tmp
);
1146 if (ret
!= JAYLINK_OK
) {
1147 LOG_ERROR("jaylink_get_free_memory() failed: %s.",
1148 jaylink_strerror_name(ret
));
1152 if (tmp
> 0x3fff || tmp
<= 0x600)
1157 return tmp
& 0xffffff00;
1160 static bool check_trace_freq(struct jaylink_swo_speed speed
,
1161 uint32_t trace_freq
)
1167 min
= fabs(1.0 - (speed
.freq
/ ((double)trace_freq
* speed
.min_div
)));
1169 for (divider
= speed
.min_div
; divider
< speed
.max_div
; divider
++) {
1170 deviation
= fabs(1.0 - (speed
.freq
/ ((double)trace_freq
* divider
)));
1172 if (deviation
< 0.03) {
1173 LOG_DEBUG("Found suitable frequency divider %u with deviation of "
1174 "%.02f %%.", divider
, deviation
);
1178 if (deviation
< min
)
1182 LOG_ERROR("Selected trace frequency is not supported by the device. "
1183 "Please choose a different trace frequency.");
1184 LOG_ERROR("Maximum permitted deviation is 3.00 %%, but only %.02f %% "
1185 "could be achieved.", min
* 100);
1190 static int config_trace(bool enabled
, enum tpio_pin_protocol pin_protocol
,
1191 uint32_t port_size
, unsigned int *trace_freq
)
1194 uint32_t buffer_size
;
1195 struct jaylink_swo_speed speed
;
1197 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SWO
)) {
1198 LOG_ERROR("Trace capturing is not supported by the device.");
1202 if (pin_protocol
!= ASYNC_UART
) {
1203 LOG_ERROR("Selected pin protocol is not supported.");
1207 trace_enabled
= enabled
;
1209 ret
= jaylink_swo_stop(devh
);
1211 if (ret
!= JAYLINK_OK
) {
1212 LOG_ERROR("jaylink_swo_stop() failed: %s.", jaylink_strerror_name(ret
));
1218 * Adjust the SWD transaction buffer size as stopping SWO capturing
1219 * deallocates device internal memory.
1221 if (!adjust_swd_buffer_size())
1227 buffer_size
= calculate_trace_buffer_size();
1230 LOG_ERROR("Not enough free device memory to start trace capturing.");
1234 ret
= jaylink_swo_get_speeds(devh
, JAYLINK_SWO_MODE_UART
, &speed
);
1236 if (ret
!= JAYLINK_OK
) {
1237 LOG_ERROR("jaylink_swo_get_speeds() failed: %s.",
1238 jaylink_strerror_name(ret
));
1243 *trace_freq
= speed
.freq
/ speed
.min_div
;
1245 if (!check_trace_freq(speed
, *trace_freq
))
1248 LOG_DEBUG("Using %u bytes device memory for trace capturing.", buffer_size
);
1250 ret
= jaylink_swo_start(devh
, JAYLINK_SWO_MODE_UART
, *trace_freq
,
1253 if (ret
!= JAYLINK_OK
) {
1254 LOG_ERROR("jaylink_start_swo() failed: %s.",
1255 jaylink_strerror_name(ret
));
1260 * Adjust the SWD transaction buffer size as starting SWO capturing
1261 * allocates device internal memory.
1263 if (!adjust_swd_buffer_size())
1269 COMMAND_HANDLER(jlink_handle_config_usb_address_command
)
1273 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1274 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1280 show_config_usb_address(CMD_CTX
);
1281 } else if (CMD_ARGC
== 1) {
1282 if (sscanf(CMD_ARGV
[0], "%" SCNd8
, &tmp
) != 1) {
1283 command_print(CMD_CTX
, "Invalid USB address: %s.", CMD_ARGV
[0]);
1287 if (tmp
> JAYLINK_USB_ADDRESS_3
) {
1288 command_print(CMD_CTX
, "Invalid USB address: %u.", tmp
);
1292 tmp_config
.usb_address
= tmp
;
1294 command_print(CMD_CTX
, "Need exactly one argument for jlink config "
1296 return ERROR_COMMAND_SYNTAX_ERROR
;
1302 COMMAND_HANDLER(jlink_handle_config_target_power_command
)
1306 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1307 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1312 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SET_TARGET_POWER
)) {
1313 command_print(CMD_CTX
, "Target power supply is not supported by the "
1319 show_config_target_power(CMD_CTX
);
1320 } else if (CMD_ARGC
== 1) {
1321 if (!strcmp(CMD_ARGV
[0], "on")) {
1323 } else if (!strcmp(CMD_ARGV
[0], "off")) {
1326 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
1330 tmp_config
.target_power
= enable
;
1332 command_print(CMD_CTX
, "Need exactly one argument for jlink config "
1334 return ERROR_COMMAND_SYNTAX_ERROR
;
1340 COMMAND_HANDLER(jlink_handle_config_mac_address_command
)
1347 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1348 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1353 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_ETHERNET
)) {
1354 command_print(CMD_CTX
, "Ethernet connectivity is not supported by the "
1360 show_config_mac_address(CMD_CTX
);
1361 } else if (CMD_ARGC
== 1) {
1364 if ((strlen(str
) != 17) || (str
[2] != ':' || str
[5] != ':' || \
1365 str
[8] != ':' || str
[11] != ':' || str
[14] != ':')) {
1366 command_print(CMD_CTX
, "Invalid MAC address format.");
1367 return ERROR_COMMAND_SYNTAX_ERROR
;
1370 for (i
= 5; i
>= 0; i
--) {
1371 addr
[i
] = strtoul(str
, &e
, 16);
1375 if (!(addr
[0] | addr
[1] | addr
[2] | addr
[3] | addr
[4] | addr
[5])) {
1376 command_print(CMD_CTX
, "Invalid MAC address: zero address.");
1377 return ERROR_COMMAND_SYNTAX_ERROR
;
1380 if (!(0x01 & addr
[0])) {
1381 command_print(CMD_CTX
, "Invalid MAC address: multicast address.");
1382 return ERROR_COMMAND_SYNTAX_ERROR
;
1385 memcpy(tmp_config
.mac_address
, addr
, sizeof(addr
));
1387 command_print(CMD_CTX
, "Need exactly one argument for jlink config "
1389 return ERROR_COMMAND_SYNTAX_ERROR
;
1395 static bool string_to_ip(const char *s
, uint8_t *ip
, int *pos
)
1399 const char *s_save
= s
;
1405 for (i
= 0; i
< 4; i
++) {
1406 lip
[i
] = strtoul(s
, &e
, 10);
1408 if (*e
!= '.' && i
!= 3)
1415 memcpy(ip
, lip
, sizeof(lip
));
1420 static void cpy_ip(uint8_t *dst
, uint8_t *src
)
1424 for (i
= 0, j
= 3; i
< 4; i
++, j
--)
1428 COMMAND_HANDLER(jlink_handle_config_ip_address_command
)
1430 uint8_t ip_address
[4];
1431 uint32_t subnet_mask
= 0;
1433 uint8_t subnet_bits
= 24;
1435 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1436 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1441 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_ETHERNET
)) {
1442 command_print(CMD_CTX
, "Ethernet connectivity is not supported by the "
1448 show_config_ip_address(CMD_CTX
);
1450 if (!string_to_ip(CMD_ARGV
[0], ip_address
, &i
))
1451 return ERROR_COMMAND_SYNTAX_ERROR
;
1453 len
= strlen(CMD_ARGV
[0]);
1455 /* Check for format A.B.C.D/E. */
1457 if (CMD_ARGV
[0][i
] != '/')
1458 return ERROR_COMMAND_SYNTAX_ERROR
;
1460 COMMAND_PARSE_NUMBER(u8
, CMD_ARGV
[0] + i
+ 1, subnet_bits
);
1461 } else if (CMD_ARGC
> 1) {
1462 if (!string_to_ip(CMD_ARGV
[1], (uint8_t *)&subnet_mask
, &i
))
1463 return ERROR_COMMAND_SYNTAX_ERROR
;
1467 subnet_mask
= (uint32_t)(subnet_bits
< 32 ?
1468 ((1ULL << subnet_bits
) - 1) : 0xffffffff);
1470 cpy_ip(tmp_config
.ip_address
, ip_address
);
1471 cpy_ip(tmp_config
.subnet_mask
, (uint8_t *)&subnet_mask
);
1477 COMMAND_HANDLER(jlink_handle_config_reset_command
)
1479 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
))
1482 memcpy(&tmp_config
, &config
, sizeof(struct device_config
));
1488 COMMAND_HANDLER(jlink_handle_config_write_command
)
1492 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1493 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1498 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_WRITE_CONFIG
)) {
1499 command_print(CMD_CTX
, "Writing configuration is not supported by the "
1504 if (!memcmp(&config
, &tmp_config
, sizeof(struct device_config
))) {
1505 command_print(CMD_CTX
, "Operation not performed due to no changes in "
1506 "the configuration.");
1510 ret
= jaylink_write_raw_config(devh
, (const uint8_t *)&tmp_config
);
1512 if (ret
!= JAYLINK_OK
) {
1513 LOG_ERROR("jaylink_write_raw_config() failed: %s.",
1514 jaylink_strerror_name(ret
));
1518 if (!read_device_config(&config
)) {
1519 LOG_ERROR("Failed to read device configuration for verification.");
1523 if (memcmp(&config
, &tmp_config
, sizeof(struct device_config
))) {
1524 LOG_ERROR("Verification of device configuration failed. Please check "
1529 memcpy(&tmp_config
, &config
, sizeof(struct device_config
));
1530 command_print(CMD_CTX
, "The new device configuration applies after power "
1531 "cycling the J-Link device.");
1536 COMMAND_HANDLER(jlink_handle_config_command
)
1538 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1539 command_print(CMD_CTX
, "Device doesn't support reading configuration.");
1544 show_config(CMD_CTX
);
1549 static const struct command_registration jlink_config_subcommand_handlers
[] = {
1552 .handler
= &jlink_handle_config_usb_address_command
,
1553 .mode
= COMMAND_EXEC
,
1554 .help
= "set the USB address",
1558 .name
= "targetpower",
1559 .handler
= &jlink_handle_config_target_power_command
,
1560 .mode
= COMMAND_EXEC
,
1561 .help
= "set the target power supply",
1566 .handler
= &jlink_handle_config_mac_address_command
,
1567 .mode
= COMMAND_EXEC
,
1568 .help
= "set the MAC Address",
1569 .usage
= "[ff:ff:ff:ff:ff:ff]",
1573 .handler
= &jlink_handle_config_ip_address_command
,
1574 .mode
= COMMAND_EXEC
,
1575 .help
= "set the IP address, where A.B.C.D is the IP address, "
1576 "E the bit of the subnet mask, F.G.H.I the subnet mask",
1577 .usage
= "[A.B.C.D[/E] [F.G.H.I]]",
1581 .handler
= &jlink_handle_config_reset_command
,
1582 .mode
= COMMAND_EXEC
,
1583 .help
= "undo configuration changes"
1587 .handler
= &jlink_handle_config_write_command
,
1588 .mode
= COMMAND_EXEC
,
1589 .help
= "write configuration to the device"
1591 COMMAND_REGISTRATION_DONE
1594 static const struct command_registration jlink_subcommand_handlers
[] = {
1597 .handler
= &jlink_handle_jlink_jtag_command
,
1598 .mode
= COMMAND_EXEC
,
1599 .help
= "select the JTAG command version",
1603 .name
= "targetpower",
1604 .handler
= &jlink_handle_target_power_command
,
1605 .mode
= COMMAND_EXEC
,
1606 .help
= "set the target power supply",
1611 .handler
= &jlink_handle_free_memory_command
,
1612 .mode
= COMMAND_EXEC
,
1613 .help
= "show free device memory"
1617 .handler
= &jlink_handle_hwstatus_command
,
1618 .mode
= COMMAND_EXEC
,
1619 .help
= "show the hardware status"
1623 .handler
= &jlink_usb_command
,
1624 .mode
= COMMAND_CONFIG
,
1625 .help
= "set the USB address of the device that should be used",
1630 .handler
= &jlink_serial_command
,
1631 .mode
= COMMAND_CONFIG
,
1632 .help
= "set the serial number of the device that should be used",
1633 .usage
= "<serial number>"
1637 .handler
= &jlink_handle_config_command
,
1638 .mode
= COMMAND_EXEC
,
1639 .help
= "access the device configuration. If no argument is given "
1640 "this will show the device configuration",
1641 .chain
= jlink_config_subcommand_handlers
,
1643 COMMAND_REGISTRATION_DONE
1646 static const struct command_registration jlink_command_handlers
[] = {
1649 .mode
= COMMAND_ANY
,
1650 .help
= "perform jlink management",
1651 .chain
= jlink_subcommand_handlers
,
1653 COMMAND_REGISTRATION_DONE
1656 static int jlink_swd_init(void)
1658 iface
= JAYLINK_TIF_SWD
;
1663 static void jlink_swd_write_reg(uint8_t cmd
, uint32_t value
, uint32_t ap_delay_clk
)
1665 assert(!(cmd
& SWD_CMD_RnW
));
1666 jlink_swd_queue_cmd(cmd
, NULL
, value
, ap_delay_clk
);
1669 static void jlink_swd_read_reg(uint8_t cmd
, uint32_t *value
, uint32_t ap_delay_clk
)
1671 assert(cmd
& SWD_CMD_RnW
);
1672 jlink_swd_queue_cmd(cmd
, value
, 0, ap_delay_clk
);
1675 static int_least32_t jlink_swd_frequency(int_least32_t hz
)
1678 jlink_speed(hz
/ 1000);
1683 /***************************************************************************/
1684 /* J-Link tap functions */
1686 static unsigned tap_length
;
1687 /* In SWD mode use tms buffer for direction control */
1688 static uint8_t tms_buffer
[JLINK_TAP_BUFFER_SIZE
];
1689 static uint8_t tdi_buffer
[JLINK_TAP_BUFFER_SIZE
];
1690 static uint8_t tdo_buffer
[JLINK_TAP_BUFFER_SIZE
];
1692 struct pending_scan_result
{
1693 /** First bit position in tdo_buffer to read. */
1695 /** Number of bits to read. */
1697 /** Location to store the result */
1699 /** Offset in the destination buffer */
1700 unsigned buffer_offset
;
1703 #define MAX_PENDING_SCAN_RESULTS 256
1705 static int pending_scan_results_length
;
1706 static struct pending_scan_result pending_scan_results_buffer
[MAX_PENDING_SCAN_RESULTS
];
1708 static void jlink_tap_init(void)
1711 pending_scan_results_length
= 0;
1712 memset(tms_buffer
, 0, sizeof(tdi_buffer
));
1715 static void jlink_clock_data(const uint8_t *out
, unsigned out_offset
,
1716 const uint8_t *tms_out
, unsigned tms_offset
,
1717 uint8_t *in
, unsigned in_offset
,
1721 unsigned available_length
= JLINK_TAP_BUFFER_SIZE
- tap_length
/ 8;
1723 if (!available_length
||
1724 (in
&& pending_scan_results_length
== MAX_PENDING_SCAN_RESULTS
)) {
1725 if (jlink_flush() != ERROR_OK
)
1727 available_length
= JLINK_TAP_BUFFER_SIZE
;
1730 struct pending_scan_result
*pending_scan_result
=
1731 &pending_scan_results_buffer
[pending_scan_results_length
];
1733 unsigned scan_length
= length
> available_length
?
1734 available_length
: length
;
1737 buf_set_buf(out
, out_offset
, tdi_buffer
, tap_length
, scan_length
);
1739 buf_set_buf(tms_out
, tms_offset
, tms_buffer
, tap_length
, scan_length
);
1742 pending_scan_result
->first
= tap_length
;
1743 pending_scan_result
->length
= scan_length
;
1744 pending_scan_result
->buffer
= in
;
1745 pending_scan_result
->buffer_offset
= in_offset
;
1746 pending_scan_results_length
++;
1749 tap_length
+= scan_length
;
1750 out_offset
+= scan_length
;
1751 tms_offset
+= scan_length
;
1752 in_offset
+= scan_length
;
1753 length
-= scan_length
;
1754 } while (length
> 0);
1757 static int jlink_flush(void)
1765 jlink_last_state
= jtag_debug_state_machine(tms_buffer
, tdi_buffer
,
1766 tap_length
, jlink_last_state
);
1768 ret
= jaylink_jtag_io(devh
, tms_buffer
, tdi_buffer
, tdo_buffer
,
1769 tap_length
, jtag_command_version
);
1771 if (ret
!= JAYLINK_OK
) {
1772 LOG_ERROR("jaylink_jtag_io() failed: %s.", jaylink_strerror_name(ret
));
1774 return ERROR_JTAG_QUEUE_FAILED
;
1777 for (i
= 0; i
< pending_scan_results_length
; i
++) {
1778 struct pending_scan_result
*p
= &pending_scan_results_buffer
[i
];
1780 buf_set_buf(tdo_buffer
, p
->first
, p
->buffer
,
1781 p
->buffer_offset
, p
->length
);
1783 DEBUG_JTAG_IO("Pending scan result, length = %d.", p
->length
);
1791 static void fill_buffer(uint8_t *buf
, uint32_t val
, uint32_t len
)
1793 unsigned int tap_pos
= tap_length
;
1796 buf_set_u32(buf
, tap_pos
, 32, val
);
1802 buf_set_u32(buf
, tap_pos
, len
, val
);
1805 static void jlink_queue_data_out(const uint8_t *data
, uint32_t len
)
1807 const uint32_t dir_out
= 0xffffffff;
1810 bit_copy(tdi_buffer
, tap_length
, data
, 0, len
);
1812 fill_buffer(tdi_buffer
, 0, len
);
1814 fill_buffer(tms_buffer
, dir_out
, len
);
1818 static void jlink_queue_data_in(uint32_t len
)
1820 const uint32_t dir_in
= 0;
1822 fill_buffer(tms_buffer
, dir_in
, len
);
1826 static int jlink_swd_switch_seq(enum swd_special_seq seq
)
1833 LOG_DEBUG("SWD line reset");
1834 s
= swd_seq_line_reset
;
1835 s_len
= swd_seq_line_reset_len
;
1838 LOG_DEBUG("JTAG-to-SWD");
1839 s
= swd_seq_jtag_to_swd
;
1840 s_len
= swd_seq_jtag_to_swd_len
;
1843 LOG_DEBUG("SWD-to-JTAG");
1844 s
= swd_seq_swd_to_jtag
;
1845 s_len
= swd_seq_swd_to_jtag_len
;
1848 LOG_ERROR("Sequence %d not supported.", seq
);
1852 jlink_queue_data_out(s
, s_len
);
1857 static int jlink_swd_run_queue(void)
1862 LOG_DEBUG("Executing %d queued transactions.", pending_scan_results_length
);
1864 if (queued_retval
!= ERROR_OK
) {
1865 LOG_DEBUG("Skipping due to previous errors: %d.", queued_retval
);
1870 * A transaction must be followed by another transaction or at least 8 idle
1871 * cycles to ensure that data is clocked through the AP.
1873 jlink_queue_data_out(NULL
, 8);
1875 ret
= jaylink_swd_io(devh
, tms_buffer
, tdi_buffer
, tdo_buffer
, tap_length
);
1877 if (ret
!= JAYLINK_OK
) {
1878 LOG_ERROR("jaylink_swd_io() failed: %s.", jaylink_strerror_name(ret
));
1882 for (i
= 0; i
< pending_scan_results_length
; i
++) {
1883 int ack
= buf_get_u32(tdo_buffer
, pending_scan_results_buffer
[i
].first
, 3);
1885 if (ack
!= SWD_ACK_OK
) {
1886 LOG_DEBUG("SWD ack not OK: %d %s", ack
,
1887 ack
== SWD_ACK_WAIT
? "WAIT" : ack
== SWD_ACK_FAULT
? "FAULT" : "JUNK");
1888 queued_retval
= ack
== SWD_ACK_WAIT
? ERROR_WAIT
: ERROR_FAIL
;
1890 } else if (pending_scan_results_buffer
[i
].length
) {
1891 uint32_t data
= buf_get_u32(tdo_buffer
, 3 + pending_scan_results_buffer
[i
].first
, 32);
1892 int parity
= buf_get_u32(tdo_buffer
, 3 + 32 + pending_scan_results_buffer
[i
].first
, 1);
1894 if (parity
!= parity_u32(data
)) {
1895 LOG_ERROR("SWD: Read data parity mismatch.");
1896 queued_retval
= ERROR_FAIL
;
1900 if (pending_scan_results_buffer
[i
].buffer
)
1901 *(uint32_t *)pending_scan_results_buffer
[i
].buffer
= data
;
1907 ret
= queued_retval
;
1908 queued_retval
= ERROR_OK
;
1913 static void jlink_swd_queue_cmd(uint8_t cmd
, uint32_t *dst
, uint32_t data
, uint32_t ap_delay_clk
)
1915 uint8_t data_parity_trn
[DIV_ROUND_UP(32 + 1, 8)];
1916 if (tap_length
+ 46 + 8 + ap_delay_clk
>= sizeof(tdi_buffer
) * 8 ||
1917 pending_scan_results_length
== MAX_PENDING_SCAN_RESULTS
) {
1918 /* Not enough room in the queue. Run the queue. */
1919 queued_retval
= jlink_swd_run_queue();
1922 if (queued_retval
!= ERROR_OK
)
1925 cmd
|= SWD_CMD_START
| SWD_CMD_PARK
;
1927 jlink_queue_data_out(&cmd
, 8);
1929 pending_scan_results_buffer
[pending_scan_results_length
].first
= tap_length
;
1931 if (cmd
& SWD_CMD_RnW
) {
1932 /* Queue a read transaction. */
1933 pending_scan_results_buffer
[pending_scan_results_length
].length
= 32;
1934 pending_scan_results_buffer
[pending_scan_results_length
].buffer
= dst
;
1936 jlink_queue_data_in(1 + 3 + 32 + 1 + 1);
1938 /* Queue a write transaction. */
1939 pending_scan_results_buffer
[pending_scan_results_length
].length
= 0;
1940 jlink_queue_data_in(1 + 3 + 1);
1942 buf_set_u32(data_parity_trn
, 0, 32, data
);
1943 buf_set_u32(data_parity_trn
, 32, 1, parity_u32(data
));
1945 jlink_queue_data_out(data_parity_trn
, 32 + 1);
1948 pending_scan_results_length
++;
1950 /* Insert idle cycles after AP accesses to avoid WAIT. */
1951 if (cmd
& SWD_CMD_APnDP
)
1952 jlink_queue_data_out(NULL
, ap_delay_clk
);
1955 static const struct swd_driver jlink_swd
= {
1956 .init
= &jlink_swd_init
,
1957 .frequency
= &jlink_swd_frequency
,
1958 .switch_seq
= &jlink_swd_switch_seq
,
1959 .read_reg
= &jlink_swd_read_reg
,
1960 .write_reg
= &jlink_swd_write_reg
,
1961 .run
= &jlink_swd_run_queue
,
1964 static const char * const jlink_transports
[] = { "jtag", "swd", NULL
};
1966 struct jtag_interface jlink_interface
= {
1968 .commands
= jlink_command_handlers
,
1969 .transports
= jlink_transports
,
1971 .execute_queue
= &jlink_execute_queue
,
1972 .speed
= &jlink_speed
,
1973 .speed_div
= &jlink_speed_div
,
1975 .init
= &jlink_init
,
1976 .quit
= &jlink_quit
,
1977 .config_trace
= &config_trace
,
1978 .poll_trace
= &poll_trace
,