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(&last_bit
,
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
)
321 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_SPEEDS
)) {
322 ret
= jaylink_get_speeds(devh
, &freq
, ÷r
);
324 if (ret
!= JAYLINK_OK
) {
325 LOG_ERROR("jaylink_get_speeds() failed: %s.",
326 jaylink_strerror_name(ret
));
327 return ERROR_JTAG_DEVICE_ERROR
;
331 max_speed
= freq
/ divider
;
333 max_speed
= JLINK_MAX_SPEED
;
337 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_ADAPTIVE_CLOCKING
)) {
338 LOG_ERROR("Adaptive clocking is not supported by the device.");
339 return ERROR_JTAG_NOT_IMPLEMENTED
;
342 speed
= JAYLINK_SPEED_ADAPTIVE_CLOCKING
;
343 } else if (speed
> max_speed
) {
344 LOG_INFO("Reduced speed from %d kHz to %d kHz (maximum).", speed
,
349 ret
= jaylink_set_speed(devh
, speed
);
351 if (ret
!= JAYLINK_OK
) {
352 LOG_ERROR("jaylink_set_speed() failed: %s.",
353 jaylink_strerror_name(ret
));
354 return ERROR_JTAG_DEVICE_ERROR
;
360 static int jlink_speed_div(int speed
, int *khz
)
367 static int jlink_khz(int khz
, int *jtag_speed
)
374 static bool read_device_config(struct device_config
*cfg
)
378 ret
= jaylink_read_raw_config(devh
, (uint8_t *)cfg
);
380 if (ret
!= JAYLINK_OK
) {
381 LOG_ERROR("jaylink_read_raw_config() failed: %s.",
382 jaylink_strerror_name(ret
));
386 if (cfg
->usb_address
== 0xff)
387 cfg
->usb_address
= 0x00;
389 if (cfg
->target_power
== 0xffffffff)
390 cfg
->target_power
= 0;
395 static int select_interface(void)
400 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SELECT_TIF
)) {
401 if (iface
!= JAYLINK_TIF_JTAG
) {
402 LOG_ERROR("Device supports JTAG transport only.");
403 return ERROR_JTAG_INIT_FAILED
;
409 ret
= jaylink_get_available_interfaces(devh
, &interfaces
);
411 if (ret
!= JAYLINK_OK
) {
412 LOG_ERROR("jaylink_get_available_interfaces() failed: %s.",
413 jaylink_strerror_name(ret
));
414 return ERROR_JTAG_INIT_FAILED
;
417 if (!(interfaces
& (1 << iface
))) {
418 LOG_ERROR("Selected transport is not supported by the device.");
419 return ERROR_JTAG_INIT_FAILED
;
422 ret
= jaylink_select_interface(devh
, iface
, NULL
);
425 LOG_ERROR("jaylink_select_interface() failed: %s.",
426 jaylink_strerror_name(ret
));
427 return ERROR_JTAG_INIT_FAILED
;
433 static int jlink_register(void)
439 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_REGISTER
))
442 ret
= jaylink_register(devh
, &conn
, connlist
, NULL
, NULL
);
445 LOG_ERROR("jaylink_register() failed: %s.",
446 jaylink_strerror_name(ret
));
450 handle_found
= false;
452 for (i
= 0; i
< ret
; 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 jlink_init(void)
508 struct jaylink_device
**devs
;
512 char *firmware_version
;
513 struct jaylink_hardware_version hwver
;
514 struct jaylink_hardware_status hwstatus
;
515 enum jaylink_usb_address address
;
518 ret
= jaylink_init(&jayctx
);
520 if (ret
!= JAYLINK_OK
) {
521 LOG_ERROR("jaylink_init() failed: %s.",
522 jaylink_strerror_name(ret
));
523 return ERROR_JTAG_INIT_FAILED
;
526 ret
= jaylink_get_device_list(jayctx
, &devs
);
529 LOG_ERROR("jaylink_get_device_list() failed: %s.",
530 jaylink_strerror_name(ret
));
531 jaylink_exit(jayctx
);
532 return ERROR_JTAG_INIT_FAILED
;
535 found_device
= false;
537 if (!use_serial_number
&& !use_usb_address
)
538 LOG_INFO("No device selected, using first device.");
540 for (i
= 0; devs
[i
]; i
++) {
541 if (use_serial_number
) {
542 ret
= jaylink_device_get_serial_number(devs
[i
], &tmp
);
544 if (ret
== JAYLINK_ERR_NOT_AVAILABLE
) {
546 } else if (ret
!= JAYLINK_OK
) {
547 LOG_WARNING("jaylink_device_get_serial_number() failed: %s.",
548 jaylink_strerror_name(ret
));
552 if (serial_number
!= tmp
)
556 if (use_usb_address
) {
557 ret
= jaylink_device_get_usb_address(devs
[i
], &address
);
559 if (ret
!= JAYLINK_OK
) {
560 LOG_WARNING("jaylink_device_get_usb_address() failed: %s.",
561 jaylink_strerror_name(ret
));
565 if (usb_address
!= address
)
569 ret
= jaylink_open(devs
[i
], &devh
);
571 if (ret
== JAYLINK_OK
) {
576 LOG_ERROR("Failed to open device: %s.", jaylink_strerror_name(ret
));
579 jaylink_free_device_list(devs
, 1);
582 LOG_ERROR("No J-Link device found.");
583 jaylink_exit(jayctx
);
584 return ERROR_JTAG_INIT_FAILED
;
588 * Be careful with changing the following initialization sequence because
589 * some devices are known to be sensitive regarding the order.
592 ret
= jaylink_get_firmware_version(devh
, &firmware_version
, &length
);
594 if (ret
!= JAYLINK_OK
) {
595 LOG_ERROR("jaylink_get_firmware_version() failed: %s.",
596 jaylink_strerror_name(ret
));
598 jaylink_exit(jayctx
);
599 return ERROR_JTAG_INIT_FAILED
;
600 } else if (length
> 0) {
601 LOG_INFO("%s", firmware_version
);
602 free(firmware_version
);
604 LOG_WARNING("Device responds empty firmware version string.");
607 memset(caps
, 0, JAYLINK_DEV_EXT_CAPS_SIZE
);
608 ret
= jaylink_get_caps(devh
, caps
);
610 if (ret
!= JAYLINK_OK
) {
611 LOG_ERROR("jaylink_get_caps() failed: %s.", jaylink_strerror_name(ret
));
613 jaylink_exit(jayctx
);
614 return ERROR_JTAG_INIT_FAILED
;
617 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_EXT_CAPS
)) {
618 ret
= jaylink_get_extended_caps(devh
, caps
);
620 if (ret
!= JAYLINK_OK
) {
621 LOG_ERROR("jaylink_get_extended_caps() failed: %s.",
622 jaylink_strerror_name(ret
));
624 jaylink_exit(jayctx
);
625 return ERROR_JTAG_INIT_FAILED
;
629 jtag_command_version
= JAYLINK_JTAG_V2
;
631 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_HW_VERSION
)) {
632 ret
= jaylink_get_hardware_version(devh
, &hwver
);
634 if (ret
!= JAYLINK_OK
) {
635 LOG_ERROR("Failed to retrieve hardware version: %s.",
636 jaylink_strerror_name(ret
));
638 jaylink_exit(jayctx
);
639 return ERROR_JTAG_INIT_FAILED
;
642 LOG_INFO("Hardware version: %u.%02u", hwver
.major
, hwver
.minor
);
644 if (hwver
.major
>= 5)
645 jtag_command_version
= JAYLINK_JTAG_V3
;
648 if (iface
== JAYLINK_TIF_SWD
) {
650 * Adjust the SWD transaction buffer size in case there is already
651 * allocated memory on the device. This happens for example if the
652 * memory for SWO capturing is still allocated because the software
653 * which used the device before has not been shut down properly.
655 if (!adjust_swd_buffer_size()) {
657 jaylink_exit(jayctx
);
658 return ERROR_JTAG_INIT_FAILED
;
662 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
663 if (!read_device_config(&config
)) {
664 LOG_ERROR("Failed to read device configuration data.");
666 jaylink_exit(jayctx
);
667 return ERROR_JTAG_INIT_FAILED
;
670 memcpy(&tmp_config
, &config
, sizeof(struct device_config
));
673 ret
= jaylink_get_hardware_status(devh
, &hwstatus
);
675 if (ret
!= JAYLINK_OK
) {
676 LOG_ERROR("jaylink_get_hardware_status() failed: %s.",
677 jaylink_strerror_name(ret
));
679 jaylink_exit(jayctx
);
680 return ERROR_JTAG_INIT_FAILED
;
683 LOG_INFO("VTarget = %u.%03u V", hwstatus
.target_voltage
/ 1000,
684 hwstatus
.target_voltage
% 1000);
692 ret
= jlink_register();
694 if (ret
!= ERROR_OK
) {
696 jaylink_exit(jayctx
);
697 return ERROR_JTAG_INIT_FAILED
;
700 ret
= select_interface();
702 if (ret
!= ERROR_OK
) {
704 jaylink_exit(jayctx
);
712 jlink_speed(jtag_get_speed_khz());
714 if (iface
== JAYLINK_TIF_JTAG
) {
716 * J-Link devices with firmware version v5 and v6 seems to have an issue
717 * if the first tap move is not divisible by 8, so we send a TLR on
721 jlink_clock_data(NULL
, 0, &tms
, 0, NULL
, 0, 8);
729 static int jlink_quit(void)
734 ret
= jaylink_swo_stop(devh
);
736 if (ret
!= JAYLINK_OK
)
737 LOG_ERROR("jaylink_swo_stop() failed: %s.",
738 jaylink_strerror_name(ret
));
741 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_REGISTER
)) {
742 ret
= jaylink_unregister(devh
, &conn
, connlist
, NULL
, NULL
);
745 LOG_ERROR("jaylink_unregister() failed: %s.",
746 jaylink_strerror_name(ret
));
750 jaylink_exit(jayctx
);
755 /***************************************************************************/
756 /* Queue command implementations */
758 static void jlink_end_state(tap_state_t state
)
760 if (tap_is_state_stable(state
))
761 tap_set_end_state(state
);
763 LOG_ERROR("BUG: %i is not a valid end state", state
);
768 /* Goes to the end state. */
769 static void jlink_state_move(void)
772 uint8_t tms_scan_bits
;
774 tms_scan
= tap_get_tms_path(tap_get_state(), tap_get_end_state());
775 tms_scan_bits
= tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
777 jlink_clock_data(NULL
, 0, &tms_scan
, 0, NULL
, 0, tms_scan_bits
);
779 tap_set_state(tap_get_end_state());
782 static void jlink_path_move(int num_states
, tap_state_t
*path
)
787 for (i
= 0; i
< num_states
; i
++) {
788 if (path
[i
] == tap_state_transition(tap_get_state(), false))
789 jlink_clock_data(NULL
, 0, NULL
, 0, NULL
, 0, 1);
790 else if (path
[i
] == tap_state_transition(tap_get_state(), true))
791 jlink_clock_data(NULL
, 0, &tms
, 0, NULL
, 0, 1);
793 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition.",
794 tap_state_name(tap_get_state()), tap_state_name(path
[i
]));
798 tap_set_state(path
[i
]);
801 tap_set_end_state(tap_get_state());
804 static void jlink_stableclocks(int num_cycles
)
808 uint8_t tms
= tap_get_state() == TAP_RESET
;
809 /* Execute num_cycles. */
810 for (i
= 0; i
< num_cycles
; i
++)
811 jlink_clock_data(NULL
, 0, &tms
, 0, NULL
, 0, 1);
814 static void jlink_runtest(int num_cycles
)
816 tap_state_t saved_end_state
= tap_get_end_state();
818 /* Only do a state_move when we're not already in IDLE. */
819 if (tap_get_state() != TAP_IDLE
) {
820 jlink_end_state(TAP_IDLE
);
825 jlink_stableclocks(num_cycles
);
827 /* Finish in end_state. */
828 jlink_end_state(saved_end_state
);
830 if (tap_get_state() != tap_get_end_state())
834 static void jlink_reset(int trst
, int srst
)
836 LOG_DEBUG("TRST: %i, SRST: %i.", trst
, srst
);
838 /* Signals are active low. */
840 jaylink_set_reset(devh
);
843 jaylink_clear_reset(devh
);
846 jaylink_jtag_clear_trst(devh
);
849 jaylink_jtag_set_trst(devh
);
852 COMMAND_HANDLER(jlink_usb_command
)
857 command_print(CMD_CTX
, "Need exactly one argument for jlink usb.");
858 return ERROR_COMMAND_SYNTAX_ERROR
;
861 if (sscanf(CMD_ARGV
[0], "%i", &tmp
) != 1) {
862 command_print(CMD_CTX
, "Invalid USB address: %s.", CMD_ARGV
[0]);
866 if (tmp
< JAYLINK_USB_ADDRESS_0
|| tmp
> JAYLINK_USB_ADDRESS_3
) {
867 command_print(CMD_CTX
, "Invalid USB address: %s.", CMD_ARGV
[0]);
873 use_serial_number
= false;
874 use_usb_address
= true;
879 COMMAND_HANDLER(jlink_serial_command
)
882 command_print(CMD_CTX
, "Need exactly one argument for jlink serial.");
883 return ERROR_COMMAND_SYNTAX_ERROR
;
886 if (sscanf(CMD_ARGV
[0], "%" SCNd32
, &serial_number
) != 1) {
887 command_print(CMD_CTX
, "Invalid serial number: %s.", CMD_ARGV
[0]);
891 use_serial_number
= true;
892 use_usb_address
= false;
897 COMMAND_HANDLER(jlink_handle_hwstatus_command
)
900 struct jaylink_hardware_status status
;
902 ret
= jaylink_get_hardware_status(devh
, &status
);
904 if (ret
!= JAYLINK_OK
) {
905 command_print(CMD_CTX
, "jaylink_get_hardware_status() failed: %s.",
906 jaylink_strerror_name(ret
));
910 command_print(CMD_CTX
, "VTarget = %u.%03u V",
911 status
.target_voltage
/ 1000, status
.target_voltage
% 1000);
913 command_print(CMD_CTX
, "TCK = %u TDI = %u TDO = %u TMS = %u SRST = %u "
914 "TRST = %u", status
.tck
, status
.tdi
, status
.tdo
, status
.tms
,
915 status
.tres
, status
.trst
);
917 if (status
.target_voltage
< 1500)
918 command_print(CMD_CTX
, "Target voltage too low. Check target power.");
923 COMMAND_HANDLER(jlink_handle_free_memory_command
)
928 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_FREE_MEMORY
)) {
929 command_print(CMD_CTX
, "Retrieval of free memory is not supported by "
934 ret
= jaylink_get_free_memory(devh
, &tmp
);
936 if (ret
!= JAYLINK_OK
) {
937 command_print(CMD_CTX
, "jaylink_get_free_memory() failed: %s.",
938 jaylink_strerror_name(ret
));
942 command_print(CMD_CTX
, "Device has %u bytes of free memory.", tmp
);
947 COMMAND_HANDLER(jlink_handle_jlink_jtag_command
)
953 switch (jtag_command_version
) {
954 case JAYLINK_JTAG_V2
:
957 case JAYLINK_JTAG_V3
:
964 command_print(CMD_CTX
, "JTAG command version: %i", version
);
965 } else if (CMD_ARGC
== 1) {
966 if (sscanf(CMD_ARGV
[0], "%i", &tmp
) != 1) {
967 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
968 return ERROR_COMMAND_SYNTAX_ERROR
;
973 jtag_command_version
= JAYLINK_JTAG_V2
;
976 jtag_command_version
= JAYLINK_JTAG_V3
;
979 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
980 return ERROR_COMMAND_SYNTAX_ERROR
;
983 command_print(CMD_CTX
, "Need exactly one argument for jlink jtag.");
984 return ERROR_COMMAND_SYNTAX_ERROR
;
990 COMMAND_HANDLER(jlink_handle_target_power_command
)
996 command_print(CMD_CTX
, "Need exactly one argument for jlink "
998 return ERROR_COMMAND_SYNTAX_ERROR
;
1001 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SET_TARGET_POWER
)) {
1002 command_print(CMD_CTX
, "Target power supply is not supported by the "
1007 if (!strcmp(CMD_ARGV
[0], "on")) {
1009 } else if (!strcmp(CMD_ARGV
[0], "off")) {
1012 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
1016 ret
= jaylink_set_target_power(devh
, enable
);
1018 if (ret
!= JAYLINK_OK
) {
1019 command_print(CMD_CTX
, "jaylink_set_target_power() failed: %s.",
1020 jaylink_strerror_name(ret
));
1027 static void show_config_usb_address(struct command_context
*ctx
)
1029 if (config
.usb_address
!= tmp_config
.usb_address
)
1030 command_print(ctx
, "USB address: %u [%u]", config
.usb_address
,
1031 tmp_config
.usb_address
);
1033 command_print(ctx
, "USB address: %u", config
.usb_address
);
1036 static void show_config_ip_address(struct command_context
*ctx
)
1038 if (!memcmp(config
.ip_address
, tmp_config
.ip_address
, 4))
1039 command_print(ctx
, "IP address: %d.%d.%d.%d",
1040 config
.ip_address
[3], config
.ip_address
[2],
1041 config
.ip_address
[1], config
.ip_address
[0]);
1043 command_print(ctx
, "IP address: %d.%d.%d.%d [%d.%d.%d.%d]",
1044 config
.ip_address
[3], config
.ip_address
[2],
1045 config
.ip_address
[1], config
.ip_address
[0],
1046 tmp_config
.ip_address
[3], tmp_config
.ip_address
[2],
1047 tmp_config
.ip_address
[1], tmp_config
.ip_address
[0]);
1049 if (!memcmp(config
.subnet_mask
, tmp_config
.subnet_mask
, 4))
1050 command_print(ctx
, "Subnet mask: %d.%d.%d.%d",
1051 config
.subnet_mask
[3], config
.subnet_mask
[2],
1052 config
.subnet_mask
[1], config
.subnet_mask
[0]);
1054 command_print(ctx
, "Subnet mask: %d.%d.%d.%d [%d.%d.%d.%d]",
1055 config
.subnet_mask
[3], config
.subnet_mask
[2],
1056 config
.subnet_mask
[1], config
.subnet_mask
[0],
1057 tmp_config
.subnet_mask
[3], tmp_config
.subnet_mask
[2],
1058 tmp_config
.subnet_mask
[1], tmp_config
.subnet_mask
[0]);
1061 static void show_config_mac_address(struct command_context
*ctx
)
1063 if (!memcmp(config
.mac_address
, tmp_config
.mac_address
, 6))
1064 command_print(ctx
, "MAC address: %.02x:%.02x:%.02x:%.02x:%.02x:%.02x",
1065 config
.mac_address
[5], config
.mac_address
[4],
1066 config
.mac_address
[3], config
.mac_address
[2],
1067 config
.mac_address
[1], config
.mac_address
[0]);
1069 command_print(ctx
, "MAC address: %.02x:%.02x:%.02x:%.02x:%.02x:%.02x "
1070 "[%.02x:%.02x:%.02x:%.02x:%.02x:%.02x]",
1071 config
.mac_address
[5], config
.mac_address
[4],
1072 config
.mac_address
[3], config
.mac_address
[2],
1073 config
.mac_address
[1], config
.mac_address
[0],
1074 tmp_config
.mac_address
[5], tmp_config
.mac_address
[4],
1075 tmp_config
.mac_address
[3], tmp_config
.mac_address
[2],
1076 tmp_config
.mac_address
[1], tmp_config
.mac_address
[0]);
1079 static void show_config_target_power(struct command_context
*ctx
)
1081 const char *target_power
;
1082 const char *current_target_power
;
1084 if (!config
.target_power
)
1085 target_power
= "off";
1087 target_power
= "on";
1089 if (!tmp_config
.target_power
)
1090 current_target_power
= "off";
1092 current_target_power
= "on";
1094 if (config
.target_power
!= tmp_config
.target_power
)
1095 command_print(ctx
, "Target power supply: %s [%s]", target_power
,
1096 current_target_power
);
1098 command_print(ctx
, "Target power supply: %s", target_power
);
1101 static void show_config(struct command_context
*ctx
)
1103 command_print(ctx
, "J-Link device configuration:");
1105 show_config_usb_address(ctx
);
1107 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SET_TARGET_POWER
))
1108 show_config_target_power(ctx
);
1110 if (jaylink_has_cap(caps
, JAYLINK_DEV_CAP_ETHERNET
)) {
1111 show_config_ip_address(ctx
);
1112 show_config_mac_address(ctx
);
1116 static int poll_trace(uint8_t *buf
, size_t *size
)
1123 ret
= jaylink_swo_read(devh
, buf
, &length
);
1125 if (ret
!= JAYLINK_OK
) {
1126 LOG_ERROR("jaylink_swo_read() failed: %s.", jaylink_strerror_name(ret
));
1135 static uint32_t calculate_trace_buffer_size(void)
1140 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_GET_FREE_MEMORY
))
1143 ret
= jaylink_get_free_memory(devh
, &tmp
);
1145 if (ret
!= JAYLINK_OK
) {
1146 LOG_ERROR("jaylink_get_free_memory() failed: %s.",
1147 jaylink_strerror_name(ret
));
1151 if (tmp
> 0x3fff || tmp
<= 0x600)
1156 return tmp
& 0xffffff00;
1159 static bool check_trace_freq(struct jaylink_swo_speed speed
,
1160 uint32_t trace_freq
)
1166 min
= fabs(1.0 - (speed
.freq
/ ((double)trace_freq
* speed
.min_div
)));
1168 for (divider
= speed
.min_div
; divider
< speed
.max_div
; divider
++) {
1169 deviation
= fabs(1.0 - (speed
.freq
/ ((double)trace_freq
* divider
)));
1171 if (deviation
< 0.03) {
1172 LOG_DEBUG("Found suitable frequency divider %u with deviation of "
1173 "%.02f %%.", divider
, deviation
);
1177 if (deviation
< min
)
1181 LOG_ERROR("Selected trace frequency is not supported by the device. "
1182 "Please choose a different trace frequency.");
1183 LOG_ERROR("Maximum permitted deviation is 3.00 %%, but only %.02f %% "
1184 "could be achieved.", min
* 100);
1189 static int config_trace(bool enabled
, enum tpio_pin_protocol pin_protocol
,
1190 uint32_t port_size
, unsigned int *trace_freq
)
1193 uint32_t buffer_size
;
1194 struct jaylink_swo_speed speed
;
1196 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SWO
)) {
1197 LOG_ERROR("Trace capturing is not supported by the device.");
1201 if (pin_protocol
!= ASYNC_UART
) {
1202 LOG_ERROR("Selected pin protocol is not supported.");
1206 trace_enabled
= enabled
;
1208 ret
= jaylink_swo_stop(devh
);
1210 if (ret
!= JAYLINK_OK
) {
1211 LOG_ERROR("jaylink_swo_stop() failed: %s.", jaylink_strerror_name(ret
));
1217 * Adjust the SWD transaction buffer size as stopping SWO capturing
1218 * deallocates device internal memory.
1220 if (!adjust_swd_buffer_size())
1226 buffer_size
= calculate_trace_buffer_size();
1229 LOG_ERROR("Not enough free device memory to start trace capturing.");
1233 ret
= jaylink_swo_get_speeds(devh
, JAYLINK_SWO_MODE_UART
, &speed
);
1235 if (ret
!= JAYLINK_OK
) {
1236 LOG_ERROR("jaylink_swo_get_speeds() failed: %s.",
1237 jaylink_strerror_name(ret
));
1242 *trace_freq
= speed
.freq
/ speed
.min_div
;
1244 if (!check_trace_freq(speed
, *trace_freq
))
1247 LOG_DEBUG("Using %u bytes device memory for trace capturing.", buffer_size
);
1249 ret
= jaylink_swo_start(devh
, JAYLINK_SWO_MODE_UART
, *trace_freq
,
1252 if (ret
!= JAYLINK_OK
) {
1253 LOG_ERROR("jaylink_start_swo() failed: %s.",
1254 jaylink_strerror_name(ret
));
1259 * Adjust the SWD transaction buffer size as starting SWO capturing
1260 * allocates device internal memory.
1262 if (!adjust_swd_buffer_size())
1268 COMMAND_HANDLER(jlink_handle_config_usb_address_command
)
1272 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1273 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1279 show_config_usb_address(CMD_CTX
);
1280 } else if (CMD_ARGC
== 1) {
1281 if (sscanf(CMD_ARGV
[0], "%" SCNd8
, &tmp
) != 1) {
1282 command_print(CMD_CTX
, "Invalid USB address: %s.", CMD_ARGV
[0]);
1286 if (tmp
> JAYLINK_USB_ADDRESS_3
) {
1287 command_print(CMD_CTX
, "Invalid USB address: %u.", tmp
);
1291 tmp_config
.usb_address
= tmp
;
1293 command_print(CMD_CTX
, "Need exactly one argument for jlink config "
1295 return ERROR_COMMAND_SYNTAX_ERROR
;
1301 COMMAND_HANDLER(jlink_handle_config_target_power_command
)
1305 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1306 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1311 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_SET_TARGET_POWER
)) {
1312 command_print(CMD_CTX
, "Target power supply is not supported by the "
1318 show_config_target_power(CMD_CTX
);
1319 } else if (CMD_ARGC
== 1) {
1320 if (!strcmp(CMD_ARGV
[0], "on")) {
1322 } else if (!strcmp(CMD_ARGV
[0], "off")) {
1325 command_print(CMD_CTX
, "Invalid argument: %s.", CMD_ARGV
[0]);
1329 tmp_config
.target_power
= enable
;
1331 command_print(CMD_CTX
, "Need exactly one argument for jlink config "
1333 return ERROR_COMMAND_SYNTAX_ERROR
;
1339 COMMAND_HANDLER(jlink_handle_config_mac_address_command
)
1346 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1347 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1352 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_ETHERNET
)) {
1353 command_print(CMD_CTX
, "Ethernet connectivity is not supported by the "
1359 show_config_mac_address(CMD_CTX
);
1360 } else if (CMD_ARGC
== 1) {
1363 if ((strlen(str
) != 17) || (str
[2] != ':' || str
[5] != ':' || \
1364 str
[8] != ':' || str
[11] != ':' || str
[14] != ':')) {
1365 command_print(CMD_CTX
, "Invalid MAC address format.");
1366 return ERROR_COMMAND_SYNTAX_ERROR
;
1369 for (i
= 5; i
>= 0; i
--) {
1370 addr
[i
] = strtoul(str
, &e
, 16);
1374 if (!(addr
[0] | addr
[1] | addr
[2] | addr
[3] | addr
[4] | addr
[5])) {
1375 command_print(CMD_CTX
, "Invalid MAC address: zero address.");
1376 return ERROR_COMMAND_SYNTAX_ERROR
;
1379 if (!(0x01 & addr
[0])) {
1380 command_print(CMD_CTX
, "Invalid MAC address: multicast address.");
1381 return ERROR_COMMAND_SYNTAX_ERROR
;
1384 memcpy(tmp_config
.mac_address
, addr
, sizeof(addr
));
1386 command_print(CMD_CTX
, "Need exactly one argument for jlink config "
1388 return ERROR_COMMAND_SYNTAX_ERROR
;
1394 static bool string_to_ip(const char *s
, uint8_t *ip
, int *pos
)
1398 const char *s_save
= s
;
1404 for (i
= 0; i
< 4; i
++) {
1405 lip
[i
] = strtoul(s
, &e
, 10);
1407 if (*e
!= '.' && i
!= 3)
1414 memcpy(ip
, lip
, sizeof(lip
));
1419 static void cpy_ip(uint8_t *dst
, uint8_t *src
)
1423 for (i
= 0, j
= 3; i
< 4; i
++, j
--)
1427 COMMAND_HANDLER(jlink_handle_config_ip_address_command
)
1429 uint8_t ip_address
[4];
1430 uint32_t subnet_mask
= 0;
1432 uint8_t subnet_bits
= 24;
1434 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1435 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1440 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_ETHERNET
)) {
1441 command_print(CMD_CTX
, "Ethernet connectivity is not supported by the "
1447 show_config_ip_address(CMD_CTX
);
1449 if (!string_to_ip(CMD_ARGV
[0], ip_address
, &i
))
1450 return ERROR_COMMAND_SYNTAX_ERROR
;
1452 len
= strlen(CMD_ARGV
[0]);
1454 /* Check for format A.B.C.D/E. */
1456 if (CMD_ARGV
[0][i
] != '/')
1457 return ERROR_COMMAND_SYNTAX_ERROR
;
1459 COMMAND_PARSE_NUMBER(u8
, CMD_ARGV
[0] + i
+ 1, subnet_bits
);
1460 } else if (CMD_ARGC
> 1) {
1461 if (!string_to_ip(CMD_ARGV
[1], (uint8_t *)&subnet_mask
, &i
))
1462 return ERROR_COMMAND_SYNTAX_ERROR
;
1466 subnet_mask
= (uint32_t)(subnet_bits
< 32 ?
1467 ((1ULL << subnet_bits
) - 1) : 0xffffffff);
1469 cpy_ip(tmp_config
.ip_address
, ip_address
);
1470 cpy_ip(tmp_config
.subnet_mask
, (uint8_t *)&subnet_mask
);
1476 COMMAND_HANDLER(jlink_handle_config_reset_command
)
1478 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
))
1481 memcpy(&tmp_config
, &config
, sizeof(struct device_config
));
1487 COMMAND_HANDLER(jlink_handle_config_write_command
)
1491 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1492 command_print(CMD_CTX
, "Reading configuration is not supported by the "
1497 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_WRITE_CONFIG
)) {
1498 command_print(CMD_CTX
, "Writing configuration is not supported by the "
1503 if (!memcmp(&config
, &tmp_config
, sizeof(struct device_config
))) {
1504 command_print(CMD_CTX
, "Operation not performed due to no changes in "
1505 "the configuration.");
1509 ret
= jaylink_write_raw_config(devh
, (const uint8_t *)&tmp_config
);
1511 if (ret
!= JAYLINK_OK
) {
1512 LOG_ERROR("jaylink_write_raw_config() failed: %s.",
1513 jaylink_strerror_name(ret
));
1517 if (!read_device_config(&config
)) {
1518 LOG_ERROR("Failed to read device configuration for verification.");
1522 if (memcmp(&config
, &tmp_config
, sizeof(struct device_config
))) {
1523 LOG_ERROR("Verification of device configuration failed. Please check "
1528 memcpy(&tmp_config
, &config
, sizeof(struct device_config
));
1529 command_print(CMD_CTX
, "The new device configuration applies after power "
1530 "cycling the J-Link device.");
1535 COMMAND_HANDLER(jlink_handle_config_command
)
1537 if (!jaylink_has_cap(caps
, JAYLINK_DEV_CAP_READ_CONFIG
)) {
1538 command_print(CMD_CTX
, "Device doesn't support reading configuration.");
1543 show_config(CMD_CTX
);
1548 static const struct command_registration jlink_config_subcommand_handlers
[] = {
1551 .handler
= &jlink_handle_config_usb_address_command
,
1552 .mode
= COMMAND_EXEC
,
1553 .help
= "set the USB address",
1557 .name
= "targetpower",
1558 .handler
= &jlink_handle_config_target_power_command
,
1559 .mode
= COMMAND_EXEC
,
1560 .help
= "set the target power supply",
1565 .handler
= &jlink_handle_config_mac_address_command
,
1566 .mode
= COMMAND_EXEC
,
1567 .help
= "set the MAC Address",
1568 .usage
= "[ff:ff:ff:ff:ff:ff]",
1572 .handler
= &jlink_handle_config_ip_address_command
,
1573 .mode
= COMMAND_EXEC
,
1574 .help
= "set the IP address, where A.B.C.D is the IP address, "
1575 "E the bit of the subnet mask, F.G.H.I the subnet mask",
1576 .usage
= "[A.B.C.D[/E] [F.G.H.I]]",
1580 .handler
= &jlink_handle_config_reset_command
,
1581 .mode
= COMMAND_EXEC
,
1582 .help
= "undo configuration changes"
1586 .handler
= &jlink_handle_config_write_command
,
1587 .mode
= COMMAND_EXEC
,
1588 .help
= "write configuration to the device"
1590 COMMAND_REGISTRATION_DONE
1593 static const struct command_registration jlink_subcommand_handlers
[] = {
1596 .handler
= &jlink_handle_jlink_jtag_command
,
1597 .mode
= COMMAND_EXEC
,
1598 .help
= "select the JTAG command version",
1602 .name
= "targetpower",
1603 .handler
= &jlink_handle_target_power_command
,
1604 .mode
= COMMAND_EXEC
,
1605 .help
= "set the target power supply",
1610 .handler
= &jlink_handle_free_memory_command
,
1611 .mode
= COMMAND_EXEC
,
1612 .help
= "show free device memory"
1616 .handler
= &jlink_handle_hwstatus_command
,
1617 .mode
= COMMAND_EXEC
,
1618 .help
= "show the hardware status"
1622 .handler
= &jlink_usb_command
,
1623 .mode
= COMMAND_CONFIG
,
1624 .help
= "set the USB address of the device that should be used",
1629 .handler
= &jlink_serial_command
,
1630 .mode
= COMMAND_CONFIG
,
1631 .help
= "set the serial number of the device that should be used",
1632 .usage
= "<serial number>"
1636 .handler
= &jlink_handle_config_command
,
1637 .mode
= COMMAND_EXEC
,
1638 .help
= "access the device configuration. If no argument is given "
1639 "this will show the device configuration",
1640 .chain
= jlink_config_subcommand_handlers
,
1642 COMMAND_REGISTRATION_DONE
1645 static const struct command_registration jlink_command_handlers
[] = {
1648 .mode
= COMMAND_ANY
,
1649 .help
= "perform jlink management",
1650 .chain
= jlink_subcommand_handlers
,
1652 COMMAND_REGISTRATION_DONE
1655 static int jlink_swd_init(void)
1657 iface
= JAYLINK_TIF_SWD
;
1662 static void jlink_swd_write_reg(uint8_t cmd
, uint32_t value
, uint32_t ap_delay_clk
)
1664 assert(!(cmd
& SWD_CMD_RnW
));
1665 jlink_swd_queue_cmd(cmd
, NULL
, value
, ap_delay_clk
);
1668 static void jlink_swd_read_reg(uint8_t cmd
, uint32_t *value
, uint32_t ap_delay_clk
)
1670 assert(cmd
& SWD_CMD_RnW
);
1671 jlink_swd_queue_cmd(cmd
, value
, 0, ap_delay_clk
);
1674 static int_least32_t jlink_swd_frequency(int_least32_t hz
)
1677 jlink_speed(hz
/ 1000);
1682 /***************************************************************************/
1683 /* J-Link tap functions */
1685 static unsigned tap_length
;
1686 /* In SWD mode use tms buffer for direction control */
1687 static uint8_t tms_buffer
[JLINK_TAP_BUFFER_SIZE
];
1688 static uint8_t tdi_buffer
[JLINK_TAP_BUFFER_SIZE
];
1689 static uint8_t tdo_buffer
[JLINK_TAP_BUFFER_SIZE
];
1691 struct pending_scan_result
{
1692 /** First bit position in tdo_buffer to read. */
1694 /** Number of bits to read. */
1696 /** Location to store the result */
1698 /** Offset in the destination buffer */
1699 unsigned buffer_offset
;
1702 #define MAX_PENDING_SCAN_RESULTS 256
1704 static int pending_scan_results_length
;
1705 static struct pending_scan_result pending_scan_results_buffer
[MAX_PENDING_SCAN_RESULTS
];
1707 static void jlink_tap_init(void)
1710 pending_scan_results_length
= 0;
1711 memset(tms_buffer
, 0, sizeof(tdi_buffer
));
1714 static void jlink_clock_data(const uint8_t *out
, unsigned out_offset
,
1715 const uint8_t *tms_out
, unsigned tms_offset
,
1716 uint8_t *in
, unsigned in_offset
,
1720 unsigned available_length
= JLINK_TAP_BUFFER_SIZE
- tap_length
/ 8;
1722 if (!available_length
||
1723 (in
&& pending_scan_results_length
== MAX_PENDING_SCAN_RESULTS
)) {
1724 if (jlink_flush() != ERROR_OK
)
1726 available_length
= JLINK_TAP_BUFFER_SIZE
;
1729 struct pending_scan_result
*pending_scan_result
=
1730 &pending_scan_results_buffer
[pending_scan_results_length
];
1732 unsigned scan_length
= length
> available_length
?
1733 available_length
: length
;
1736 buf_set_buf(out
, out_offset
, tdi_buffer
, tap_length
, scan_length
);
1738 buf_set_buf(tms_out
, tms_offset
, tms_buffer
, tap_length
, scan_length
);
1741 pending_scan_result
->first
= tap_length
;
1742 pending_scan_result
->length
= scan_length
;
1743 pending_scan_result
->buffer
= in
;
1744 pending_scan_result
->buffer_offset
= in_offset
;
1745 pending_scan_results_length
++;
1748 tap_length
+= scan_length
;
1749 out_offset
+= scan_length
;
1750 tms_offset
+= scan_length
;
1751 in_offset
+= scan_length
;
1752 length
-= scan_length
;
1753 } while (length
> 0);
1756 static int jlink_flush(void)
1764 jlink_last_state
= jtag_debug_state_machine(tms_buffer
, tdi_buffer
,
1765 tap_length
, jlink_last_state
);
1767 ret
= jaylink_jtag_io(devh
, tms_buffer
, tdi_buffer
, tdo_buffer
,
1768 tap_length
, jtag_command_version
);
1770 if (ret
!= JAYLINK_OK
) {
1771 LOG_ERROR("jaylink_jtag_io() failed: %s.", jaylink_strerror_name(ret
));
1773 return ERROR_JTAG_QUEUE_FAILED
;
1776 for (i
= 0; i
< pending_scan_results_length
; i
++) {
1777 struct pending_scan_result
*p
= &pending_scan_results_buffer
[i
];
1779 buf_set_buf(tdo_buffer
, p
->first
, p
->buffer
,
1780 p
->buffer_offset
, p
->length
);
1782 DEBUG_JTAG_IO("Pending scan result, length = %d.", p
->length
);
1790 static void fill_buffer(uint8_t *buf
, uint32_t val
, uint32_t len
)
1792 unsigned int tap_pos
= tap_length
;
1795 buf_set_u32(buf
, tap_pos
, 32, val
);
1801 buf_set_u32(buf
, tap_pos
, len
, val
);
1804 static void jlink_queue_data_out(const uint8_t *data
, uint32_t len
)
1806 const uint32_t dir_out
= 0xffffffff;
1809 bit_copy(tdi_buffer
, tap_length
, data
, 0, len
);
1811 fill_buffer(tdi_buffer
, 0, len
);
1813 fill_buffer(tms_buffer
, dir_out
, len
);
1817 static void jlink_queue_data_in(uint32_t len
)
1819 const uint32_t dir_in
= 0;
1821 fill_buffer(tms_buffer
, dir_in
, len
);
1825 static int jlink_swd_switch_seq(enum swd_special_seq seq
)
1832 LOG_DEBUG("SWD line reset");
1833 s
= swd_seq_line_reset
;
1834 s_len
= swd_seq_line_reset_len
;
1837 LOG_DEBUG("JTAG-to-SWD");
1838 s
= swd_seq_jtag_to_swd
;
1839 s_len
= swd_seq_jtag_to_swd_len
;
1842 LOG_DEBUG("SWD-to-JTAG");
1843 s
= swd_seq_swd_to_jtag
;
1844 s_len
= swd_seq_swd_to_jtag_len
;
1847 LOG_ERROR("Sequence %d not supported.", seq
);
1851 jlink_queue_data_out(s
, s_len
);
1856 static int jlink_swd_run_queue(void)
1861 LOG_DEBUG("Executing %d queued transactions.", pending_scan_results_length
);
1863 if (queued_retval
!= ERROR_OK
) {
1864 LOG_DEBUG("Skipping due to previous errors: %d.", queued_retval
);
1869 * A transaction must be followed by another transaction or at least 8 idle
1870 * cycles to ensure that data is clocked through the AP.
1872 jlink_queue_data_out(NULL
, 8);
1874 ret
= jaylink_swd_io(devh
, tms_buffer
, tdi_buffer
, tdo_buffer
, tap_length
);
1876 if (ret
!= JAYLINK_OK
) {
1877 LOG_ERROR("jaylink_swd_io() failed: %s.", jaylink_strerror_name(ret
));
1881 for (i
= 0; i
< pending_scan_results_length
; i
++) {
1882 int ack
= buf_get_u32(tdo_buffer
, pending_scan_results_buffer
[i
].first
, 3);
1884 if (ack
!= SWD_ACK_OK
) {
1885 LOG_DEBUG("SWD ack not OK: %d %s", ack
,
1886 ack
== SWD_ACK_WAIT
? "WAIT" : ack
== SWD_ACK_FAULT
? "FAULT" : "JUNK");
1887 queued_retval
= ack
== SWD_ACK_WAIT
? ERROR_WAIT
: ERROR_FAIL
;
1889 } else if (pending_scan_results_buffer
[i
].length
) {
1890 uint32_t data
= buf_get_u32(tdo_buffer
, 3 + pending_scan_results_buffer
[i
].first
, 32);
1891 int parity
= buf_get_u32(tdo_buffer
, 3 + 32 + pending_scan_results_buffer
[i
].first
, 1);
1893 if (parity
!= parity_u32(data
)) {
1894 LOG_ERROR("SWD: Read data parity mismatch.");
1895 queued_retval
= ERROR_FAIL
;
1899 if (pending_scan_results_buffer
[i
].buffer
)
1900 *(uint32_t *)pending_scan_results_buffer
[i
].buffer
= data
;
1906 ret
= queued_retval
;
1907 queued_retval
= ERROR_OK
;
1912 static void jlink_swd_queue_cmd(uint8_t cmd
, uint32_t *dst
, uint32_t data
, uint32_t ap_delay_clk
)
1914 uint8_t data_parity_trn
[DIV_ROUND_UP(32 + 1, 8)];
1915 if (tap_length
+ 46 + 8 + ap_delay_clk
>= sizeof(tdi_buffer
) * 8 ||
1916 pending_scan_results_length
== MAX_PENDING_SCAN_RESULTS
) {
1917 /* Not enough room in the queue. Run the queue. */
1918 queued_retval
= jlink_swd_run_queue();
1921 if (queued_retval
!= ERROR_OK
)
1924 cmd
|= SWD_CMD_START
| SWD_CMD_PARK
;
1926 jlink_queue_data_out(&cmd
, 8);
1928 pending_scan_results_buffer
[pending_scan_results_length
].first
= tap_length
;
1930 if (cmd
& SWD_CMD_RnW
) {
1931 /* Queue a read transaction. */
1932 pending_scan_results_buffer
[pending_scan_results_length
].length
= 32;
1933 pending_scan_results_buffer
[pending_scan_results_length
].buffer
= dst
;
1935 jlink_queue_data_in(1 + 3 + 32 + 1 + 1);
1937 /* Queue a write transaction. */
1938 pending_scan_results_buffer
[pending_scan_results_length
].length
= 0;
1939 jlink_queue_data_in(1 + 3 + 1);
1941 buf_set_u32(data_parity_trn
, 0, 32, data
);
1942 buf_set_u32(data_parity_trn
, 32, 1, parity_u32(data
));
1944 jlink_queue_data_out(data_parity_trn
, 32 + 1);
1947 pending_scan_results_length
++;
1949 /* Insert idle cycles after AP accesses to avoid WAIT. */
1950 if (cmd
& SWD_CMD_APnDP
)
1951 jlink_queue_data_out(NULL
, ap_delay_clk
);
1954 static const struct swd_driver jlink_swd
= {
1955 .init
= &jlink_swd_init
,
1956 .frequency
= &jlink_swd_frequency
,
1957 .switch_seq
= &jlink_swd_switch_seq
,
1958 .read_reg
= &jlink_swd_read_reg
,
1959 .write_reg
= &jlink_swd_write_reg
,
1960 .run
= &jlink_swd_run_queue
,
1963 static const char * const jlink_transports
[] = { "jtag", "swd", NULL
};
1965 struct jtag_interface jlink_interface
= {
1967 .commands
= jlink_command_handlers
,
1968 .transports
= jlink_transports
,
1970 .execute_queue
= &jlink_execute_queue
,
1971 .speed
= &jlink_speed
,
1972 .speed_div
= &jlink_speed_div
,
1974 .init
= &jlink_init
,
1975 .quit
= &jlink_quit
,
1976 .config_trace
= &config_trace
,
1977 .poll_trace
= &poll_trace
,