1 /***************************************************************************
2 * Copyright (C) 2011 by Martin Schmoelzer *
3 * <martin.schmoelzer@student.tuwien.ac.at> *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
26 #include <jtag/interface.h>
27 #include <jtag/commands.h>
28 #include <target/image.h>
29 #include "usb_common.h"
30 #include "OpenULINK/include/msgtypes.h"
32 /** USB Vendor ID of ULINK device in unconfigured state (no firmware loaded
33 * yet) or with OpenULINK firmware. */
34 #define ULINK_VID 0xC251
36 /** USB Product ID of ULINK device in unconfigured state (no firmware loaded
37 * yet) or with OpenULINK firmware. */
38 #define ULINK_PID 0x2710
40 /** Address of EZ-USB CPU Control & Status register. This register can be
41 * written by issuing a Control EP0 vendor request. */
42 #define CPUCS_REG 0x7F92
44 /** USB Control EP0 bRequest: "Firmware Load". */
45 #define REQUEST_FIRMWARE_LOAD 0xA0
47 /** Value to write into CPUCS to put EZ-USB into reset. */
48 #define CPU_RESET 0x01
50 /** Value to write into CPUCS to put EZ-USB out of reset. */
51 #define CPU_START 0x00
53 /** Base address of firmware in EZ-USB code space. */
54 #define FIRMWARE_ADDR 0x0000
56 /** USB interface number */
57 #define USB_INTERFACE 0
59 /** libusb timeout in ms */
60 #define USB_TIMEOUT 5000
62 /** Delay (in microseconds) to wait while EZ-USB performs ReNumeration. */
63 #define ULINK_RENUMERATION_DELAY 1500000
65 /** Default location of OpenULINK firmware image. */
66 #define ULINK_FIRMWARE_FILE PKGLIBDIR "/OpenULINK/ulink_firmware.hex"
68 /** Maximum size of a single firmware section. Entire EZ-USB code space = 8kB */
69 #define SECTION_BUFFERSIZE 8192
71 /** Tuning of OpenOCD SCAN commands split into multiple OpenULINK commands. */
72 #define SPLIT_SCAN_THRESHOLD 10
74 /** ULINK hardware type */
76 /** Original ULINK adapter, based on Cypress EZ-USB (AN2131):
77 * Full JTAG support, no SWD support. */
80 /** Newer ULINK adapter, based on NXP LPC2148. Currently unsupported. */
83 /** Newer ULINK adapter, based on EZ-USB FX2 + FPGA. Currently unsupported. */
86 /** Newer ULINK adapter, possibly based on ULINK 2. Currently unsupported. */
90 enum ulink_payload_direction
{
91 PAYLOAD_DIRECTION_OUT
,
95 enum ulink_delay_type
{
104 * OpenULINK command (OpenULINK command queue element).
106 * For the OUT direction payload, things are quite easy: Payload is stored
107 * in a rather small array (up to 63 bytes), the payload is always allocated
108 * by the function generating the command and freed by ulink_clear_queue().
110 * For the IN direction payload, things get a little bit more complicated:
111 * The maximum IN payload size for a single command is 64 bytes. Assume that
112 * a single OpenOCD command needs to scan 256 bytes. This results in the
113 * generation of four OpenULINK commands. The function generating these
114 * commands shall allocate an uint8_t[256] array. Each command's #payload_in
115 * pointer shall point to the corresponding offset where IN data shall be
116 * placed, while #payload_in_start shall point to the first element of the 256
118 * - first command: #payload_in_start + 0
119 * - second command: #payload_in_start + 64
120 * - third command: #payload_in_start + 128
121 * - fourth command: #payload_in_start + 192
123 * The last command sets #needs_postprocessing to true.
126 uint8_t id
; /* /< ULINK command ID */
128 uint8_t *payload_out
; /* /< OUT direction payload data */
129 uint8_t payload_out_size
; /* /< OUT direction payload size for this command */
131 uint8_t *payload_in_start
; /* /< Pointer to first element of IN payload array */
132 uint8_t *payload_in
; /* /< Pointer where IN payload shall be stored */
133 uint8_t payload_in_size
;/* /< IN direction payload size for this command */
135 /** Indicates if this command needs post-processing */
136 bool needs_postprocessing
;
138 /** Indicates if ulink_clear_queue() should free payload_in_start */
139 bool free_payload_in_start
;
141 /** Pointer to corresponding OpenOCD command for post-processing */
142 struct jtag_command
*cmd_origin
;
144 struct ulink_cmd
*next
; /* /< Pointer to next command (linked list) */
147 /** Describes one driver instance */
149 struct usb_dev_handle
*usb_handle
;
150 enum ulink_type type
;
152 int delay_scan_in
; /* /< Delay value for SCAN_IN commands */
153 int delay_scan_out
; /* /< Delay value for SCAN_OUT commands */
154 int delay_scan_io
; /* /< Delay value for SCAN_IO commands */
155 int delay_clock_tck
; /* /< Delay value for CLOCK_TMS commands */
156 int delay_clock_tms
; /* /< Delay value for CLOCK_TCK commands */
158 int commands_in_queue
; /* /< Number of commands in queue */
159 struct ulink_cmd
*queue_start
; /* /< Pointer to first command in queue */
160 struct ulink_cmd
*queue_end
; /* /< Pointer to last command in queue */
163 /**************************** Function Prototypes *****************************/
165 /* USB helper functions */
166 int ulink_usb_open(struct ulink
**device
);
167 int ulink_usb_close(struct ulink
**device
);
169 /* ULINK MCU (Cypress EZ-USB) specific functions */
170 int ulink_cpu_reset(struct ulink
*device
, char reset_bit
);
171 int ulink_load_firmware_and_renumerate(struct ulink
**device
, char *filename
,
173 int ulink_load_firmware(struct ulink
*device
, char *filename
);
174 int ulink_write_firmware_section(struct ulink
*device
,
175 struct image
*firmware_image
, int section_index
);
177 /* Generic helper functions */
178 void ulink_print_signal_states(uint8_t input_signals
, uint8_t output_signals
);
180 /* OpenULINK command generation helper functions */
181 int ulink_allocate_payload(struct ulink_cmd
*ulink_cmd
, int size
,
182 enum ulink_payload_direction direction
);
184 /* OpenULINK command queue helper functions */
185 int ulink_get_queue_size(struct ulink
*device
,
186 enum ulink_payload_direction direction
);
187 void ulink_clear_queue(struct ulink
*device
);
188 int ulink_append_queue(struct ulink
*device
, struct ulink_cmd
*ulink_cmd
);
189 int ulink_execute_queued_commands(struct ulink
*device
, int timeout
);
191 #ifdef _DEBUG_JTAG_IO_
192 const char *ulink_cmd_id_string(uint8_t id
);
193 void ulink_print_command(struct ulink_cmd
*ulink_cmd
);
194 void ulink_print_queue(struct ulink
*device
);
197 int ulink_append_scan_cmd(struct ulink
*device
,
198 enum scan_type scan_type
,
203 uint8_t tms_count_start
,
204 uint8_t tms_sequence_start
,
205 uint8_t tms_count_end
,
206 uint8_t tms_sequence_end
,
207 struct jtag_command
*origin
,
209 int ulink_append_clock_tms_cmd(struct ulink
*device
, uint8_t count
,
211 int ulink_append_clock_tck_cmd(struct ulink
*device
, uint16_t count
);
212 int ulink_append_get_signals_cmd(struct ulink
*device
);
213 int ulink_append_set_signals_cmd(struct ulink
*device
, uint8_t low
,
215 int ulink_append_sleep_cmd(struct ulink
*device
, uint32_t us
);
216 int ulink_append_configure_tck_cmd(struct ulink
*device
,
222 int ulink_append_led_cmd(struct ulink
*device
, uint8_t led_state
);
223 int ulink_append_test_cmd(struct ulink
*device
);
225 /* OpenULINK TCK frequency helper functions */
226 int ulink_calculate_delay(enum ulink_delay_type type
, long f
, int *delay
);
227 int ulink_calculate_frequency(enum ulink_delay_type type
, int delay
, long *f
);
229 /* Interface between OpenULINK and OpenOCD */
230 static void ulink_set_end_state(tap_state_t endstate
);
231 int ulink_queue_statemove(struct ulink
*device
);
233 int ulink_queue_scan(struct ulink
*device
, struct jtag_command
*cmd
);
234 int ulink_queue_tlr_reset(struct ulink
*device
, struct jtag_command
*cmd
);
235 int ulink_queue_runtest(struct ulink
*device
, struct jtag_command
*cmd
);
236 int ulink_queue_reset(struct ulink
*device
, struct jtag_command
*cmd
);
237 int ulink_queue_pathmove(struct ulink
*device
, struct jtag_command
*cmd
);
238 int ulink_queue_sleep(struct ulink
*device
, struct jtag_command
*cmd
);
239 int ulink_queue_stableclocks(struct ulink
*device
, struct jtag_command
*cmd
);
241 int ulink_post_process_scan(struct ulink_cmd
*ulink_cmd
);
242 int ulink_post_process_queue(struct ulink
*device
);
244 /* JTAG driver functions (registered in struct jtag_interface) */
245 static int ulink_execute_queue(void);
246 static int ulink_khz(int khz
, int *jtag_speed
);
247 static int ulink_speed(int speed
);
248 static int ulink_speed_div(int speed
, int *khz
);
249 static int ulink_init(void);
250 static int ulink_quit(void);
252 /****************************** Global Variables ******************************/
254 struct ulink
*ulink_handle
;
256 /**************************** USB helper functions ****************************/
259 * Opens the ULINK device and claims its USB interface.
261 * @param device pointer to struct ulink identifying ULINK driver instance.
262 * @return on success: ERROR_OK
263 * @return on failure: ERROR_FAIL
265 int ulink_usb_open(struct ulink
**device
)
268 struct usb_dev_handle
*usb_handle
;
270 /* Currently, only original ULINK is supported */
271 uint16_t vids
[] = { ULINK_VID
, 0 };
272 uint16_t pids
[] = { ULINK_PID
, 0 };
274 ret
= jtag_usb_open(vids
, pids
, &usb_handle
);
279 ret
= usb_claim_interface(usb_handle
, 0);
284 (*device
)->usb_handle
= usb_handle
;
285 (*device
)->type
= ULINK_1
;
291 * Releases the ULINK interface and closes the USB device handle.
293 * @param device pointer to struct ulink identifying ULINK driver instance.
294 * @return on success: ERROR_OK
295 * @return on failure: ERROR_FAIL
297 int ulink_usb_close(struct ulink
**device
)
299 if (usb_release_interface((*device
)->usb_handle
, 0) != 0)
302 if (usb_close((*device
)->usb_handle
) != 0)
305 (*device
)->usb_handle
= NULL
;
310 /******************* ULINK CPU (EZ-USB) specific functions ********************/
313 * Writes '0' or '1' to the CPUCS register, putting the EZ-USB CPU into reset
316 * @param device pointer to struct ulink identifying ULINK driver instance.
317 * @param reset_bit 0 to put CPU into reset, 1 to put CPU out of reset.
318 * @return on success: ERROR_OK
319 * @return on failure: ERROR_FAIL
321 int ulink_cpu_reset(struct ulink
*device
, char reset_bit
)
325 ret
= usb_control_msg(device
->usb_handle
,
326 (USB_ENDPOINT_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
),
327 REQUEST_FIRMWARE_LOAD
, CPUCS_REG
, 0, &reset_bit
, 1, USB_TIMEOUT
);
329 /* usb_control_msg() returns the number of bytes transferred during the
330 * DATA stage of the control transfer - must be exactly 1 in this case! */
337 * Puts the ULINK's EZ-USB microcontroller into reset state, downloads
338 * the firmware image, resumes the microcontroller and re-enumerates
341 * @param device pointer to struct ulink identifying ULINK driver instance.
342 * The usb_handle member will be modified during re-enumeration.
343 * @param filename path to the Intel HEX file containing the firmware image.
344 * @param delay the delay to wait for the device to re-enumerate.
345 * @return on success: ERROR_OK
346 * @return on failure: ERROR_FAIL
348 int ulink_load_firmware_and_renumerate(struct ulink
**device
,
349 char *filename
, uint32_t delay
)
353 /* Basic process: After downloading the firmware, the ULINK will disconnect
354 * itself and re-connect after a short amount of time so we have to close
355 * the handle and re-enumerate USB devices */
357 ret
= ulink_load_firmware(*device
, filename
);
361 ret
= ulink_usb_close(device
);
367 ret
= ulink_usb_open(device
);
375 * Downloads a firmware image to the ULINK's EZ-USB microcontroller
378 * @param device pointer to struct ulink identifying ULINK driver instance.
379 * @param filename an absolute or relative path to the Intel HEX file
380 * containing the firmware image.
381 * @return on success: ERROR_OK
382 * @return on failure: ERROR_FAIL
384 int ulink_load_firmware(struct ulink
*device
, char *filename
)
386 struct image ulink_firmware_image
;
389 ret
= ulink_cpu_reset(device
, CPU_RESET
);
390 if (ret
!= ERROR_OK
) {
391 LOG_ERROR("Could not halt ULINK CPU");
395 ulink_firmware_image
.base_address
= 0;
396 ulink_firmware_image
.base_address_set
= 0;
398 ret
= image_open(&ulink_firmware_image
, filename
, "ihex");
399 if (ret
!= ERROR_OK
) {
400 LOG_ERROR("Could not load firmware image");
404 /* Download all sections in the image to ULINK */
405 for (i
= 0; i
< ulink_firmware_image
.num_sections
; i
++) {
406 ret
= ulink_write_firmware_section(device
, &ulink_firmware_image
, i
);
411 image_close(&ulink_firmware_image
);
413 ret
= ulink_cpu_reset(device
, CPU_START
);
414 if (ret
!= ERROR_OK
) {
415 LOG_ERROR("Could not restart ULINK CPU");
423 * Send one contiguous firmware section to the ULINK's EZ-USB microcontroller
426 * @param device pointer to struct ulink identifying ULINK driver instance.
427 * @param firmware_image pointer to the firmware image that contains the section
428 * which should be sent to the ULINK's EZ-USB microcontroller.
429 * @param section_index index of the section within the firmware image.
430 * @return on success: ERROR_OK
431 * @return on failure: ERROR_FAIL
433 int ulink_write_firmware_section(struct ulink
*device
,
434 struct image
*firmware_image
, int section_index
)
436 uint16_t addr
, size
, bytes_remaining
, chunk_size
;
437 uint8_t data
[SECTION_BUFFERSIZE
];
438 uint8_t *data_ptr
= data
;
442 size
= (uint16_t)firmware_image
->sections
[section_index
].size
;
443 addr
= (uint16_t)firmware_image
->sections
[section_index
].base_address
;
445 LOG_DEBUG("section %02i at addr 0x%04x (size 0x%04x)", section_index
, addr
,
451 /* Copy section contents to local buffer */
452 ret
= image_read_section(firmware_image
, section_index
, 0, size
, data
,
455 if ((ret
!= ERROR_OK
) || (size_read
!= size
)) {
456 /* Propagating the return code would return '0' (misleadingly indicating
457 * successful execution of the function) if only the size check fails. */
461 bytes_remaining
= size
;
463 /* Send section data in chunks of up to 64 bytes to ULINK */
464 while (bytes_remaining
> 0) {
465 if (bytes_remaining
> 64)
468 chunk_size
= bytes_remaining
;
470 ret
= usb_control_msg(device
->usb_handle
,
471 (USB_ENDPOINT_OUT
| USB_TYPE_VENDOR
| USB_RECIP_DEVICE
),
472 REQUEST_FIRMWARE_LOAD
, addr
, FIRMWARE_ADDR
, (char *)data_ptr
,
473 chunk_size
, USB_TIMEOUT
);
475 if (ret
!= (int)chunk_size
) {
476 /* Abort if libusb sent less data than requested */
480 bytes_remaining
-= chunk_size
;
482 data_ptr
+= chunk_size
;
488 /************************** Generic helper functions **************************/
491 * Print state of interesting signals via LOG_INFO().
493 * @param input_signals input signal states as returned by CMD_GET_SIGNALS
494 * @param output_signals output signal states as returned by CMD_GET_SIGNALS
496 void ulink_print_signal_states(uint8_t input_signals
, uint8_t output_signals
)
498 LOG_INFO("ULINK signal states: TDI: %i, TDO: %i, TMS: %i, TCK: %i, TRST: %i,"
500 (output_signals
& SIGNAL_TDI
? 1 : 0),
501 (input_signals
& SIGNAL_TDO
? 1 : 0),
502 (output_signals
& SIGNAL_TMS
? 1 : 0),
503 (output_signals
& SIGNAL_TCK
? 1 : 0),
504 (output_signals
& SIGNAL_TRST
? 0 : 1),/* TRST and RESET are inverted */
505 (output_signals
& SIGNAL_RESET
? 0 : 1)); /* by hardware */
508 /**************** OpenULINK command generation helper functions ***************/
511 * Allocate and initialize space in memory for OpenULINK command payload.
513 * @param ulink_cmd pointer to command whose payload should be allocated.
514 * @param size the amount of memory to allocate (bytes).
515 * @param direction which payload to allocate.
516 * @return on success: ERROR_OK
517 * @return on failure: ERROR_FAIL
519 int ulink_allocate_payload(struct ulink_cmd
*ulink_cmd
, int size
,
520 enum ulink_payload_direction direction
)
524 payload
= calloc(size
, sizeof(uint8_t));
526 if (payload
== NULL
) {
527 LOG_ERROR("Could not allocate OpenULINK command payload: out of memory");
532 case PAYLOAD_DIRECTION_OUT
:
533 if (ulink_cmd
->payload_out
!= NULL
) {
534 LOG_ERROR("BUG: Duplicate payload allocation for OpenULINK command");
537 ulink_cmd
->payload_out
= payload
;
538 ulink_cmd
->payload_out_size
= size
;
541 case PAYLOAD_DIRECTION_IN
:
542 if (ulink_cmd
->payload_in_start
!= NULL
) {
543 LOG_ERROR("BUG: Duplicate payload allocation for OpenULINK command");
546 ulink_cmd
->payload_in_start
= payload
;
547 ulink_cmd
->payload_in
= payload
;
548 ulink_cmd
->payload_in_size
= size
;
550 /* By default, free payload_in_start in ulink_clear_queue(). Commands
551 * that do not want this behavior (e. g. split scans) must turn it off
553 ulink_cmd
->free_payload_in_start
= true;
561 /****************** OpenULINK command queue helper functions ******************/
564 * Get the current number of bytes in the queue, including command IDs.
566 * @param device pointer to struct ulink identifying ULINK driver instance.
567 * @param direction the transfer direction for which to get byte count.
568 * @return the number of bytes currently stored in the queue for the specified
571 int ulink_get_queue_size(struct ulink
*device
,
572 enum ulink_payload_direction direction
)
574 struct ulink_cmd
*current
= device
->queue_start
;
577 while (current
!= NULL
) {
579 case PAYLOAD_DIRECTION_OUT
:
580 sum
+= current
->payload_out_size
+ 1; /* + 1 byte for Command ID */
582 case PAYLOAD_DIRECTION_IN
:
583 sum
+= current
->payload_in_size
;
587 current
= current
->next
;
594 * Clear the OpenULINK command queue.
596 * @param device pointer to struct ulink identifying ULINK driver instance.
597 * @return on success: ERROR_OK
598 * @return on failure: ERROR_FAIL
600 void ulink_clear_queue(struct ulink
*device
)
602 struct ulink_cmd
*current
= device
->queue_start
;
603 struct ulink_cmd
*next
= NULL
;
605 while (current
!= NULL
) {
606 /* Save pointer to next element */
607 next
= current
->next
;
609 /* Free payloads: OUT payload can be freed immediately */
610 free(current
->payload_out
);
611 current
->payload_out
= NULL
;
613 /* IN payload MUST be freed ONLY if no other commands use the
614 * payload_in_start buffer */
615 if (current
->free_payload_in_start
== true) {
616 free(current
->payload_in_start
);
617 current
->payload_in_start
= NULL
;
618 current
->payload_in
= NULL
;
621 /* Free queue element */
624 /* Proceed with next element */
628 device
->commands_in_queue
= 0;
629 device
->queue_start
= NULL
;
630 device
->queue_end
= NULL
;
634 * Add a command to the OpenULINK command queue.
636 * @param device pointer to struct ulink identifying ULINK driver instance.
637 * @param ulink_cmd pointer to command that shall be appended to the OpenULINK
639 * @return on success: ERROR_OK
640 * @return on failure: ERROR_FAIL
642 int ulink_append_queue(struct ulink
*device
, struct ulink_cmd
*ulink_cmd
)
644 int newsize_out
, newsize_in
;
647 newsize_out
= ulink_get_queue_size(device
, PAYLOAD_DIRECTION_OUT
) + 1
648 + ulink_cmd
->payload_out_size
;
650 newsize_in
= ulink_get_queue_size(device
, PAYLOAD_DIRECTION_IN
)
651 + ulink_cmd
->payload_in_size
;
653 /* Check if the current command can be appended to the queue */
654 if ((newsize_out
> 64) || (newsize_in
> 64)) {
655 /* New command does not fit. Execute all commands in queue before starting
656 * new queue with the current command as first entry. */
657 ret
= ulink_execute_queued_commands(device
, USB_TIMEOUT
);
661 ret
= ulink_post_process_queue(device
);
665 ulink_clear_queue(device
);
668 if (device
->queue_start
== NULL
) {
669 /* Queue was empty */
670 device
->commands_in_queue
= 1;
672 device
->queue_start
= ulink_cmd
;
673 device
->queue_end
= ulink_cmd
;
675 /* There are already commands in the queue */
676 device
->commands_in_queue
++;
678 device
->queue_end
->next
= ulink_cmd
;
679 device
->queue_end
= ulink_cmd
;
686 * Sends all queued OpenULINK commands to the ULINK for execution.
688 * @param device pointer to struct ulink identifying ULINK driver instance.
689 * @return on success: ERROR_OK
690 * @return on failure: ERROR_FAIL
692 int ulink_execute_queued_commands(struct ulink
*device
, int timeout
)
694 struct ulink_cmd
*current
;
695 int ret
, i
, index_out
, index_in
, count_out
, count_in
;
698 #ifdef _DEBUG_JTAG_IO_
699 ulink_print_queue(device
);
706 for (current
= device
->queue_start
; current
; current
= current
->next
) {
707 /* Add command to packet */
708 buffer
[index_out
] = current
->id
;
712 for (i
= 0; i
< current
->payload_out_size
; i
++)
713 buffer
[index_out
+ i
] = current
->payload_out
[i
];
714 index_out
+= current
->payload_out_size
;
715 count_in
+= current
->payload_in_size
;
716 count_out
+= current
->payload_out_size
;
719 /* Send packet to ULINK */
720 ret
= usb_bulk_write(device
->usb_handle
, (2 | USB_ENDPOINT_OUT
),
721 (char *)buffer
, count_out
, timeout
);
724 if (ret
!= count_out
)
727 /* Wait for response if commands contain IN payload data */
729 ret
= usb_bulk_read(device
->usb_handle
, (2 | USB_ENDPOINT_IN
),
730 (char *)buffer
, 64, timeout
);
736 /* Write back IN payload data */
738 for (current
= device
->queue_start
; current
; current
= current
->next
) {
739 for (i
= 0; i
< current
->payload_in_size
; i
++) {
740 current
->payload_in
[i
] = buffer
[index_in
];
749 #ifdef _DEBUG_JTAG_IO_
752 * Convert an OpenULINK command ID (\a id) to a human-readable string.
754 * @param id the OpenULINK command ID.
755 * @return the corresponding human-readable string.
757 const char *ulink_cmd_id_string(uint8_t id
)
761 return "CMD_SCAN_IN";
763 case CMD_SLOW_SCAN_IN
:
764 return "CMD_SLOW_SCAN_IN";
767 return "CMD_SCAN_OUT";
769 case CMD_SLOW_SCAN_OUT
:
770 return "CMD_SLOW_SCAN_OUT";
773 return "CMD_SCAN_IO";
775 case CMD_SLOW_SCAN_IO
:
776 return "CMD_SLOW_SCAN_IO";
779 return "CMD_CLOCK_TMS";
781 case CMD_SLOW_CLOCK_TMS
:
782 return "CMD_SLOW_CLOCK_TMS";
785 return "CMD_CLOCK_TCK";
787 case CMD_SLOW_CLOCK_TCK
:
788 return "CMD_SLOW_CLOCK_TCK";
791 return "CMD_SLEEP_US";
794 return "CMD_SLEEP_MS";
796 case CMD_GET_SIGNALS
:
797 return "CMD_GET_SIGNALS";
799 case CMD_SET_SIGNALS
:
800 return "CMD_SET_SIGNALS";
802 case CMD_CONFIGURE_TCK_FREQ
:
803 return "CMD_CONFIGURE_TCK_FREQ";
806 return "CMD_SET_LEDS";
812 return "CMD_UNKNOWN";
818 * Print one OpenULINK command to stdout.
820 * @param ulink_cmd pointer to OpenULINK command.
822 void ulink_print_command(struct ulink_cmd
*ulink_cmd
)
826 printf(" %-22s | OUT size = %i, bytes = 0x",
827 ulink_cmd_id_string(ulink_cmd
->id
), ulink_cmd
->payload_out_size
);
829 for (i
= 0; i
< ulink_cmd
->payload_out_size
; i
++)
830 printf("%02X ", ulink_cmd
->payload_out
[i
]);
831 printf("\n | IN size = %i\n",
832 ulink_cmd
->payload_in_size
);
836 * Print the OpenULINK command queue to stdout.
838 * @param device pointer to struct ulink identifying ULINK driver instance.
840 void ulink_print_queue(struct ulink
*device
)
842 struct ulink_cmd
*current
;
844 printf("OpenULINK command queue:\n");
846 for (current
= device
->queue_start
; current
; current
= current
->next
)
847 ulink_print_command(current
);
850 #endif /* _DEBUG_JTAG_IO_ */
855 * Creates and appends a JTAG scan command to the OpenULINK command queue.
856 * A JTAG scan consists of three steps:
857 * - Move to the desired SHIFT state, depending on scan type (IR/DR scan).
858 * - Shift TDI data into the JTAG chain, optionally reading the TDO pin.
859 * - Move to the desired end state.
861 * @param device pointer to struct ulink identifying ULINK driver instance.
862 * @param scan_type the type of the scan (IN, OUT, IO (bidirectional)).
863 * @param scan_size_bits number of bits to shift into the JTAG chain.
864 * @param tdi pointer to array containing TDI data.
865 * @param tdo_start pointer to first element of array where TDO data shall be
866 * stored. See #ulink_cmd for details.
867 * @param tdo pointer to array where TDO data shall be stored
868 * @param tms_count_start number of TMS state transitions to perform BEFORE
869 * shifting data into the JTAG chain.
870 * @param tms_sequence_start sequence of TMS state transitions that will be
871 * performed BEFORE shifting data into the JTAG chain.
872 * @param tms_count_end number of TMS state transitions to perform AFTER
873 * shifting data into the JTAG chain.
874 * @param tms_sequence_end sequence of TMS state transitions that will be
875 * performed AFTER shifting data into the JTAG chain.
876 * @param origin pointer to OpenOCD command that generated this scan command.
877 * @param postprocess whether this command needs to be post-processed after
879 * @return on success: ERROR_OK
880 * @return on failure: ERROR_FAIL
882 int ulink_append_scan_cmd(struct ulink
*device
, enum scan_type scan_type
,
883 int scan_size_bits
, uint8_t *tdi
, uint8_t *tdo_start
, uint8_t *tdo
,
884 uint8_t tms_count_start
, uint8_t tms_sequence_start
, uint8_t tms_count_end
,
885 uint8_t tms_sequence_end
, struct jtag_command
*origin
, bool postprocess
)
887 struct ulink_cmd
*cmd
= calloc(1, sizeof(struct ulink_cmd
));
888 int ret
, i
, scan_size_bytes
;
889 uint8_t bits_last_byte
;
894 /* Check size of command. USB buffer can hold 64 bytes, 1 byte is command ID,
895 * 5 bytes are setup data -> 58 remaining payload bytes for TDI data */
896 if (scan_size_bits
> (58 * 8)) {
897 LOG_ERROR("BUG: Tried to create CMD_SCAN_IO OpenULINK command with too"
902 scan_size_bytes
= DIV_ROUND_UP(scan_size_bits
, 8);
904 bits_last_byte
= scan_size_bits
% 8;
905 if (bits_last_byte
== 0)
908 /* Allocate out_payload depending on scan type */
911 if (device
->delay_scan_in
< 0)
912 cmd
->id
= CMD_SCAN_IN
;
914 cmd
->id
= CMD_SLOW_SCAN_IN
;
915 ret
= ulink_allocate_payload(cmd
, 5, PAYLOAD_DIRECTION_OUT
);
918 if (device
->delay_scan_out
< 0)
919 cmd
->id
= CMD_SCAN_OUT
;
921 cmd
->id
= CMD_SLOW_SCAN_OUT
;
922 ret
= ulink_allocate_payload(cmd
, scan_size_bytes
+ 5, PAYLOAD_DIRECTION_OUT
);
925 if (device
->delay_scan_io
< 0)
926 cmd
->id
= CMD_SCAN_IO
;
928 cmd
->id
= CMD_SLOW_SCAN_IO
;
929 ret
= ulink_allocate_payload(cmd
, scan_size_bytes
+ 5, PAYLOAD_DIRECTION_OUT
);
932 LOG_ERROR("BUG: ulink_append_scan_cmd() encountered an unknown scan type");
940 /* Build payload_out that is common to all scan types */
941 cmd
->payload_out
[0] = scan_size_bytes
& 0xFF;
942 cmd
->payload_out
[1] = bits_last_byte
& 0xFF;
943 cmd
->payload_out
[2] = ((tms_count_start
& 0x0F) << 4) | (tms_count_end
& 0x0F);
944 cmd
->payload_out
[3] = tms_sequence_start
;
945 cmd
->payload_out
[4] = tms_sequence_end
;
947 /* Setup payload_out for types with OUT transfer */
948 if ((scan_type
== SCAN_OUT
) || (scan_type
== SCAN_IO
)) {
949 for (i
= 0; i
< scan_size_bytes
; i
++)
950 cmd
->payload_out
[i
+ 5] = tdi
[i
];
953 /* Setup payload_in pointers for types with IN transfer */
954 if ((scan_type
== SCAN_IN
) || (scan_type
== SCAN_IO
)) {
955 cmd
->payload_in_start
= tdo_start
;
956 cmd
->payload_in
= tdo
;
957 cmd
->payload_in_size
= scan_size_bytes
;
960 cmd
->needs_postprocessing
= postprocess
;
961 cmd
->cmd_origin
= origin
;
963 /* For scan commands, we free payload_in_start only when the command is
964 * the last in a series of split commands or a stand-alone command */
965 cmd
->free_payload_in_start
= postprocess
;
967 return ulink_append_queue(device
, cmd
);
971 * Perform TAP state transitions
973 * @param device pointer to struct ulink identifying ULINK driver instance.
974 * @param count defines the number of TCK clock cycles generated (up to 8).
975 * @param sequence defines the TMS pin levels for each state transition. The
976 * Least-Significant Bit is read first.
977 * @return on success: ERROR_OK
978 * @return on failure: ERROR_FAIL
980 int ulink_append_clock_tms_cmd(struct ulink
*device
, uint8_t count
,
983 struct ulink_cmd
*cmd
= calloc(1, sizeof(struct ulink_cmd
));
989 if (device
->delay_clock_tms
< 0)
990 cmd
->id
= CMD_CLOCK_TMS
;
992 cmd
->id
= CMD_SLOW_CLOCK_TMS
;
994 /* CMD_CLOCK_TMS has two OUT payload bytes and zero IN payload bytes */
995 ret
= ulink_allocate_payload(cmd
, 2, PAYLOAD_DIRECTION_OUT
);
999 cmd
->payload_out
[0] = count
;
1000 cmd
->payload_out
[1] = sequence
;
1002 return ulink_append_queue(device
, cmd
);
1006 * Generate a defined amount of TCK clock cycles
1008 * All other JTAG signals are left unchanged.
1010 * @param device pointer to struct ulink identifying ULINK driver instance.
1011 * @param count the number of TCK clock cycles to generate.
1012 * @return on success: ERROR_OK
1013 * @return on failure: ERROR_FAIL
1015 int ulink_append_clock_tck_cmd(struct ulink
*device
, uint16_t count
)
1017 struct ulink_cmd
*cmd
= calloc(1, sizeof(struct ulink_cmd
));
1023 if (device
->delay_clock_tck
< 0)
1024 cmd
->id
= CMD_CLOCK_TCK
;
1026 cmd
->id
= CMD_SLOW_CLOCK_TCK
;
1028 /* CMD_CLOCK_TCK has two OUT payload bytes and zero IN payload bytes */
1029 ret
= ulink_allocate_payload(cmd
, 2, PAYLOAD_DIRECTION_OUT
);
1030 if (ret
!= ERROR_OK
)
1033 cmd
->payload_out
[0] = count
& 0xff;
1034 cmd
->payload_out
[1] = (count
>> 8) & 0xff;
1036 return ulink_append_queue(device
, cmd
);
1040 * Read JTAG signals.
1042 * @param device pointer to struct ulink identifying ULINK driver instance.
1043 * @return on success: ERROR_OK
1044 * @return on failure: ERROR_FAIL
1046 int ulink_append_get_signals_cmd(struct ulink
*device
)
1048 struct ulink_cmd
*cmd
= calloc(1, sizeof(struct ulink_cmd
));
1054 cmd
->id
= CMD_GET_SIGNALS
;
1055 cmd
->needs_postprocessing
= true;
1057 /* CMD_GET_SIGNALS has two IN payload bytes */
1058 ret
= ulink_allocate_payload(cmd
, 2, PAYLOAD_DIRECTION_IN
);
1060 if (ret
!= ERROR_OK
)
1063 return ulink_append_queue(device
, cmd
);
1067 * Arbitrarily set JTAG output signals.
1069 * @param device pointer to struct ulink identifying ULINK driver instance.
1070 * @param low defines which signals will be de-asserted. Each bit corresponds
1079 * @param high defines which signals will be asserted.
1080 * @return on success: ERROR_OK
1081 * @return on failure: ERROR_FAIL
1083 int ulink_append_set_signals_cmd(struct ulink
*device
, uint8_t low
,
1086 struct ulink_cmd
*cmd
= calloc(1, sizeof(struct ulink_cmd
));
1092 cmd
->id
= CMD_SET_SIGNALS
;
1094 /* CMD_SET_SIGNALS has two OUT payload bytes and zero IN payload bytes */
1095 ret
= ulink_allocate_payload(cmd
, 2, PAYLOAD_DIRECTION_OUT
);
1097 if (ret
!= ERROR_OK
)
1100 cmd
->payload_out
[0] = low
;
1101 cmd
->payload_out
[1] = high
;
1103 return ulink_append_queue(device
, cmd
);
1107 * Sleep for a pre-defined number of microseconds
1109 * @param device pointer to struct ulink identifying ULINK driver instance.
1110 * @param us the number microseconds to sleep.
1111 * @return on success: ERROR_OK
1112 * @return on failure: ERROR_FAIL
1114 int ulink_append_sleep_cmd(struct ulink
*device
, uint32_t us
)
1116 struct ulink_cmd
*cmd
= calloc(1, sizeof(struct ulink_cmd
));
1122 cmd
->id
= CMD_SLEEP_US
;
1124 /* CMD_SLEEP_US has two OUT payload bytes and zero IN payload bytes */
1125 ret
= ulink_allocate_payload(cmd
, 2, PAYLOAD_DIRECTION_OUT
);
1127 if (ret
!= ERROR_OK
)
1130 cmd
->payload_out
[0] = us
& 0x00ff;
1131 cmd
->payload_out
[1] = (us
>> 8) & 0x00ff;
1133 return ulink_append_queue(device
, cmd
);
1137 * Set TCK delay counters
1139 * @param device pointer to struct ulink identifying ULINK driver instance.
1140 * @param delay_scan_in delay count top value in jtag_slow_scan_in() function.
1141 * @param delay_scan_out delay count top value in jtag_slow_scan_out() function.
1142 * @param delay_scan_io delay count top value in jtag_slow_scan_io() function.
1143 * @param delay_tck delay count top value in jtag_clock_tck() function.
1144 * @param delay_tms delay count top value in jtag_slow_clock_tms() function.
1145 * @return on success: ERROR_OK
1146 * @return on failure: ERROR_FAIL
1148 int ulink_append_configure_tck_cmd(struct ulink
*device
, int delay_scan_in
,
1149 int delay_scan_out
, int delay_scan_io
, int delay_tck
, int delay_tms
)
1151 struct ulink_cmd
*cmd
= calloc(1, sizeof(struct ulink_cmd
));
1157 cmd
->id
= CMD_CONFIGURE_TCK_FREQ
;
1159 /* CMD_CONFIGURE_TCK_FREQ has five OUT payload bytes and zero
1160 * IN payload bytes */
1161 ret
= ulink_allocate_payload(cmd
, 5, PAYLOAD_DIRECTION_OUT
);
1162 if (ret
!= ERROR_OK
)
1165 if (delay_scan_in
< 0)
1166 cmd
->payload_out
[0] = 0;
1168 cmd
->payload_out
[0] = (uint8_t)delay_scan_in
;
1170 if (delay_scan_out
< 0)
1171 cmd
->payload_out
[1] = 0;
1173 cmd
->payload_out
[1] = (uint8_t)delay_scan_out
;
1175 if (delay_scan_io
< 0)
1176 cmd
->payload_out
[2] = 0;
1178 cmd
->payload_out
[2] = (uint8_t)delay_scan_io
;
1181 cmd
->payload_out
[3] = 0;
1183 cmd
->payload_out
[3] = (uint8_t)delay_tck
;
1186 cmd
->payload_out
[4] = 0;
1188 cmd
->payload_out
[4] = (uint8_t)delay_tms
;
1190 return ulink_append_queue(device
, cmd
);
1194 * Turn on/off ULINK LEDs.
1196 * @param device pointer to struct ulink identifying ULINK driver instance.
1197 * @param led_state which LED(s) to turn on or off. The following bits
1198 * influence the LEDS:
1199 * - Bit 0: Turn COM LED on
1200 * - Bit 1: Turn RUN LED on
1201 * - Bit 2: Turn COM LED off
1202 * - Bit 3: Turn RUN LED off
1203 * If both the on-bit and the off-bit for the same LED is set, the LED is
1205 * @return on success: ERROR_OK
1206 * @return on failure: ERROR_FAIL
1208 int ulink_append_led_cmd(struct ulink
*device
, uint8_t led_state
)
1210 struct ulink_cmd
*cmd
= calloc(1, sizeof(struct ulink_cmd
));
1216 cmd
->id
= CMD_SET_LEDS
;
1218 /* CMD_SET_LEDS has one OUT payload byte and zero IN payload bytes */
1219 ret
= ulink_allocate_payload(cmd
, 1, PAYLOAD_DIRECTION_OUT
);
1220 if (ret
!= ERROR_OK
)
1223 cmd
->payload_out
[0] = led_state
;
1225 return ulink_append_queue(device
, cmd
);
1229 * Test command. Used to check if the ULINK device is ready to accept new
1232 * @param device pointer to struct ulink identifying ULINK driver instance.
1233 * @return on success: ERROR_OK
1234 * @return on failure: ERROR_FAIL
1236 int ulink_append_test_cmd(struct ulink
*device
)
1238 struct ulink_cmd
*cmd
= calloc(1, sizeof(struct ulink_cmd
));
1246 /* CMD_TEST has one OUT payload byte and zero IN payload bytes */
1247 ret
= ulink_allocate_payload(cmd
, 1, PAYLOAD_DIRECTION_OUT
);
1248 if (ret
!= ERROR_OK
)
1251 cmd
->payload_out
[0] = 0xAA;
1253 return ulink_append_queue(device
, cmd
);
1256 /****************** OpenULINK TCK frequency helper functions ******************/
1259 * Calculate delay values for a given TCK frequency.
1261 * The OpenULINK firmware uses five different speed values for different
1262 * commands. These speed values are calculated in these functions.
1264 * The five different commands which support variable TCK frequency are
1265 * implemented twice in the firmware:
1266 * 1. Maximum possible frequency without any artificial delay
1267 * 2. Variable frequency with artificial linear delay loop
1269 * To set the ULINK to maximum frequency, it is only neccessary to use the
1270 * corresponding command IDs. To set the ULINK to a lower frequency, the
1271 * delay loop top values have to be calculated first. Then, a
1272 * CMD_CONFIGURE_TCK_FREQ command needs to be sent to the ULINK device.
1274 * The delay values are described by linear equations:
1276 * (t = period, k = constant, x = delay value, d = constant)
1278 * Thus, the delay can be calculated as in the following equation:
1281 * The constants in these equations have been determined and validated by
1282 * measuring the frequency resulting from different delay values.
1284 * @param type for which command to calculate the delay value.
1285 * @param f TCK frequency for which to calculate the delay value in Hz.
1286 * @param delay where to store resulting delay value.
1287 * @return on success: ERROR_OK
1288 * @return on failure: ERROR_FAIL
1290 int ulink_calculate_delay(enum ulink_delay_type type
, long f
, int *delay
)
1294 /* Calculate period of requested TCK frequency */
1295 t
= 1.0 / (float)(f
);
1298 case DELAY_CLOCK_TCK
:
1299 x
= (t
- (float)(6E-6)) / (float)(4E-6);
1301 case DELAY_CLOCK_TMS
:
1302 x
= (t
- (float)(8.5E-6)) / (float)(4E-6);
1305 x
= (t
- (float)(8.8308E-6)) / (float)(4E-6);
1307 case DELAY_SCAN_OUT
:
1308 x
= (t
- (float)(1.0527E-5)) / (float)(4E-6);
1311 x
= (t
- (float)(1.3132E-5)) / (float)(4E-6);
1318 /* Check if the delay value is negative. This happens when a frequency is
1319 * requested that is too high for the delay loop implementation. In this
1320 * case, set delay value to zero. */
1324 /* We need to convert the exact delay value to an integer. Therefore, we
1325 * round the exact value UP to ensure that the resulting frequency is NOT
1326 * higher than the requested frequency. */
1329 /* Check if the value is within limits */
1333 *delay
= (int)x_ceil
;
1339 * Calculate frequency for a given delay value.
1341 * Similar to the #ulink_calculate_delay function, this function calculates the
1342 * TCK frequency for a given delay value by using linear equations of the form:
1344 * (t = period, k = constant, x = delay value, d = constant)
1346 * @param type for which command to calculate the delay value.
1347 * @param delay delay value for which to calculate the resulting TCK frequency.
1348 * @param f where to store the resulting TCK frequency.
1349 * @return on success: ERROR_OK
1350 * @return on failure: ERROR_FAIL
1352 int ulink_calculate_frequency(enum ulink_delay_type type
, int delay
, long *f
)
1354 float t
, f_float
, f_rounded
;
1360 case DELAY_CLOCK_TCK
:
1362 t
= (float)(2.666E-6);
1364 t
= (float)(4E-6) * (float)(delay
) + (float)(6E-6);
1366 case DELAY_CLOCK_TMS
:
1368 t
= (float)(5.666E-6);
1370 t
= (float)(4E-6) * (float)(delay
) + (float)(8.5E-6);
1374 t
= (float)(5.5E-6);
1376 t
= (float)(4E-6) * (float)(delay
) + (float)(8.8308E-6);
1378 case DELAY_SCAN_OUT
:
1380 t
= (float)(7.0E-6);
1382 t
= (float)(4E-6) * (float)(delay
) + (float)(1.0527E-5);
1386 t
= (float)(9.926E-6);
1388 t
= (float)(4E-6) * (float)(delay
) + (float)(1.3132E-5);
1396 f_rounded
= roundf(f_float
);
1397 *f
= (long)f_rounded
;
1402 /******************* Interface between OpenULINK and OpenOCD ******************/
1405 * Sets the end state follower (see interface.h) if \a endstate is a stable
1408 * @param endstate the state the end state follower should be set to.
1410 static void ulink_set_end_state(tap_state_t endstate
)
1412 if (tap_is_state_stable(endstate
))
1413 tap_set_end_state(endstate
);
1415 LOG_ERROR("BUG: %s is not a valid end state", tap_state_name(endstate
));
1421 * Move from the current TAP state to the current TAP end state.
1423 * @param device pointer to struct ulink identifying ULINK driver instance.
1424 * @return on success: ERROR_OK
1425 * @return on failure: ERROR_FAIL
1427 int ulink_queue_statemove(struct ulink
*device
)
1429 uint8_t tms_sequence
, tms_count
;
1432 if (tap_get_state() == tap_get_end_state()) {
1433 /* Do nothing if we are already there */
1437 tms_sequence
= tap_get_tms_path(tap_get_state(), tap_get_end_state());
1438 tms_count
= tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
1440 ret
= ulink_append_clock_tms_cmd(device
, tms_count
, tms_sequence
);
1442 if (ret
== ERROR_OK
)
1443 tap_set_state(tap_get_end_state());
1449 * Perform a scan operation on a JTAG register.
1451 * @param device pointer to struct ulink identifying ULINK driver instance.
1452 * @param cmd pointer to the command that shall be executed.
1453 * @return on success: ERROR_OK
1454 * @return on failure: ERROR_FAIL
1456 int ulink_queue_scan(struct ulink
*device
, struct jtag_command
*cmd
)
1458 uint32_t scan_size_bits
, scan_size_bytes
, bits_last_scan
;
1459 uint32_t scans_max_payload
, bytecount
;
1460 uint8_t *tdi_buffer_start
= NULL
, *tdi_buffer
= NULL
;
1461 uint8_t *tdo_buffer_start
= NULL
, *tdo_buffer
= NULL
;
1463 uint8_t first_tms_count
, first_tms_sequence
;
1464 uint8_t last_tms_count
, last_tms_sequence
;
1466 uint8_t tms_count_pause
, tms_sequence_pause
;
1467 uint8_t tms_count_resume
, tms_sequence_resume
;
1469 uint8_t tms_count_start
, tms_sequence_start
;
1470 uint8_t tms_count_end
, tms_sequence_end
;
1472 enum scan_type type
;
1475 /* Determine scan size */
1476 scan_size_bits
= jtag_scan_size(cmd
->cmd
.scan
);
1477 scan_size_bytes
= DIV_ROUND_UP(scan_size_bits
, 8);
1479 /* Determine scan type (IN/OUT/IO) */
1480 type
= jtag_scan_type(cmd
->cmd
.scan
);
1482 /* Determine number of scan commands with maximum payload */
1483 scans_max_payload
= scan_size_bytes
/ 58;
1485 /* Determine size of last shift command */
1486 bits_last_scan
= scan_size_bits
- (scans_max_payload
* 58 * 8);
1488 /* Allocate TDO buffer if required */
1489 if ((type
== SCAN_IN
) || (type
== SCAN_IO
)) {
1490 tdo_buffer_start
= calloc(sizeof(uint8_t), scan_size_bytes
);
1492 if (tdo_buffer_start
== NULL
)
1495 tdo_buffer
= tdo_buffer_start
;
1498 /* Fill TDI buffer if required */
1499 if ((type
== SCAN_OUT
) || (type
== SCAN_IO
)) {
1500 jtag_build_buffer(cmd
->cmd
.scan
, &tdi_buffer_start
);
1501 tdi_buffer
= tdi_buffer_start
;
1504 /* Get TAP state transitions */
1505 if (cmd
->cmd
.scan
->ir_scan
) {
1506 ulink_set_end_state(TAP_IRSHIFT
);
1507 first_tms_count
= tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
1508 first_tms_sequence
= tap_get_tms_path(tap_get_state(), tap_get_end_state());
1510 tap_set_state(TAP_IRSHIFT
);
1511 tap_set_end_state(cmd
->cmd
.scan
->end_state
);
1512 last_tms_count
= tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
1513 last_tms_sequence
= tap_get_tms_path(tap_get_state(), tap_get_end_state());
1515 /* TAP state transitions for split scans */
1516 tms_count_pause
= tap_get_tms_path_len(TAP_IRSHIFT
, TAP_IRPAUSE
);
1517 tms_sequence_pause
= tap_get_tms_path(TAP_IRSHIFT
, TAP_IRPAUSE
);
1518 tms_count_resume
= tap_get_tms_path_len(TAP_IRPAUSE
, TAP_IRSHIFT
);
1519 tms_sequence_resume
= tap_get_tms_path(TAP_IRPAUSE
, TAP_IRSHIFT
);
1521 ulink_set_end_state(TAP_DRSHIFT
);
1522 first_tms_count
= tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
1523 first_tms_sequence
= tap_get_tms_path(tap_get_state(), tap_get_end_state());
1525 tap_set_state(TAP_DRSHIFT
);
1526 tap_set_end_state(cmd
->cmd
.scan
->end_state
);
1527 last_tms_count
= tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
1528 last_tms_sequence
= tap_get_tms_path(tap_get_state(), tap_get_end_state());
1530 /* TAP state transitions for split scans */
1531 tms_count_pause
= tap_get_tms_path_len(TAP_DRSHIFT
, TAP_DRPAUSE
);
1532 tms_sequence_pause
= tap_get_tms_path(TAP_DRSHIFT
, TAP_DRPAUSE
);
1533 tms_count_resume
= tap_get_tms_path_len(TAP_DRPAUSE
, TAP_DRSHIFT
);
1534 tms_sequence_resume
= tap_get_tms_path(TAP_DRPAUSE
, TAP_DRSHIFT
);
1537 /* Generate scan commands */
1538 bytecount
= scan_size_bytes
;
1539 while (bytecount
> 0) {
1540 if (bytecount
== scan_size_bytes
) {
1541 /* This is the first scan */
1542 tms_count_start
= first_tms_count
;
1543 tms_sequence_start
= first_tms_sequence
;
1545 /* Resume from previous scan */
1546 tms_count_start
= tms_count_resume
;
1547 tms_sequence_start
= tms_sequence_resume
;
1550 if (bytecount
> 58) { /* Full scan, at least one scan will follow */
1551 tms_count_end
= tms_count_pause
;
1552 tms_sequence_end
= tms_sequence_pause
;
1554 ret
= ulink_append_scan_cmd(device
,
1569 /* Update TDI and TDO buffer pointers */
1570 if (tdi_buffer_start
!= NULL
)
1572 if (tdo_buffer_start
!= NULL
)
1574 } else if (bytecount
== 58) { /* Full scan, no further scans */
1575 tms_count_end
= last_tms_count
;
1576 tms_sequence_end
= last_tms_sequence
;
1578 ret
= ulink_append_scan_cmd(device
,
1592 } else {/* Scan with less than maximum payload, no further scans */
1593 tms_count_end
= last_tms_count
;
1594 tms_sequence_end
= last_tms_sequence
;
1596 ret
= ulink_append_scan_cmd(device
,
1612 if (ret
!= ERROR_OK
) {
1613 free(tdi_buffer_start
);
1618 free(tdi_buffer_start
);
1620 /* Set current state to the end state requested by the command */
1621 tap_set_state(cmd
->cmd
.scan
->end_state
);
1627 * Move the TAP into the Test Logic Reset state.
1629 * @param device pointer to struct ulink identifying ULINK driver instance.
1630 * @param cmd pointer to the command that shall be executed.
1631 * @return on success: ERROR_OK
1632 * @return on failure: ERROR_FAIL
1634 int ulink_queue_tlr_reset(struct ulink
*device
, struct jtag_command
*cmd
)
1638 ret
= ulink_append_clock_tms_cmd(device
, 5, 0xff);
1640 if (ret
== ERROR_OK
)
1641 tap_set_state(TAP_RESET
);
1649 * Generate TCK clock cycles while remaining
1650 * in the Run-Test/Idle state.
1652 * @param device pointer to struct ulink identifying ULINK driver instance.
1653 * @param cmd pointer to the command that shall be executed.
1654 * @return on success: ERROR_OK
1655 * @return on failure: ERROR_FAIL
1657 int ulink_queue_runtest(struct ulink
*device
, struct jtag_command
*cmd
)
1661 /* Only perform statemove if the TAP currently isn't in the TAP_IDLE state */
1662 if (tap_get_state() != TAP_IDLE
) {
1663 ulink_set_end_state(TAP_IDLE
);
1664 ulink_queue_statemove(device
);
1667 /* Generate the clock cycles */
1668 ret
= ulink_append_clock_tck_cmd(device
, cmd
->cmd
.runtest
->num_cycles
);
1669 if (ret
!= ERROR_OK
)
1672 /* Move to end state specified in command */
1673 if (cmd
->cmd
.runtest
->end_state
!= tap_get_state()) {
1674 tap_set_end_state(cmd
->cmd
.runtest
->end_state
);
1675 ulink_queue_statemove(device
);
1682 * Execute a JTAG_RESET command
1684 * @param cmd pointer to the command that shall be executed.
1685 * @return on success: ERROR_OK
1686 * @return on failure: ERROR_FAIL
1688 int ulink_queue_reset(struct ulink
*device
, struct jtag_command
*cmd
)
1690 uint8_t low
= 0, high
= 0;
1692 if (cmd
->cmd
.reset
->trst
) {
1693 tap_set_state(TAP_RESET
);
1694 high
|= SIGNAL_TRST
;
1698 if (cmd
->cmd
.reset
->srst
)
1699 high
|= SIGNAL_RESET
;
1701 low
|= SIGNAL_RESET
;
1703 return ulink_append_set_signals_cmd(device
, low
, high
);
1707 * Move to one TAP state or several states in succession.
1709 * @param device pointer to struct ulink identifying ULINK driver instance.
1710 * @param cmd pointer to the command that shall be executed.
1711 * @return on success: ERROR_OK
1712 * @return on failure: ERROR_FAIL
1714 int ulink_queue_pathmove(struct ulink
*device
, struct jtag_command
*cmd
)
1716 int ret
, i
, num_states
, batch_size
, state_count
;
1718 uint8_t tms_sequence
;
1720 num_states
= cmd
->cmd
.pathmove
->num_states
;
1721 path
= cmd
->cmd
.pathmove
->path
;
1724 while (num_states
> 0) {
1727 /* Determine batch size */
1728 if (num_states
>= 8)
1731 batch_size
= num_states
;
1733 for (i
= 0; i
< batch_size
; i
++) {
1734 if (tap_state_transition(tap_get_state(), false) == path
[state_count
]) {
1735 /* Append '0' transition: clear bit 'i' in tms_sequence */
1736 buf_set_u32(&tms_sequence
, i
, 1, 0x0);
1737 } else if (tap_state_transition(tap_get_state(), true)
1738 == path
[state_count
]) {
1739 /* Append '1' transition: set bit 'i' in tms_sequence */
1740 buf_set_u32(&tms_sequence
, i
, 1, 0x1);
1742 /* Invalid state transition */
1743 LOG_ERROR("BUG: %s -> %s isn't a valid TAP state transition",
1744 tap_state_name(tap_get_state()),
1745 tap_state_name(path
[state_count
]));
1749 tap_set_state(path
[state_count
]);
1754 /* Append CLOCK_TMS command to OpenULINK command queue */
1756 "pathmove batch: count = %i, sequence = 0x%x", batch_size
, tms_sequence
);
1757 ret
= ulink_append_clock_tms_cmd(ulink_handle
, batch_size
, tms_sequence
);
1758 if (ret
!= ERROR_OK
)
1766 * Sleep for a specific amount of time.
1768 * @param device pointer to struct ulink identifying ULINK driver instance.
1769 * @param cmd pointer to the command that shall be executed.
1770 * @return on success: ERROR_OK
1771 * @return on failure: ERROR_FAIL
1773 int ulink_queue_sleep(struct ulink
*device
, struct jtag_command
*cmd
)
1775 /* IMPORTANT! Due to the time offset in command execution introduced by
1776 * command queueing, this needs to be implemented in the ULINK device */
1777 return ulink_append_sleep_cmd(device
, cmd
->cmd
.sleep
->us
);
1781 * Generate TCK cycles while remaining in a stable state.
1783 * @param device pointer to struct ulink identifying ULINK driver instance.
1784 * @param cmd pointer to the command that shall be executed.
1786 int ulink_queue_stableclocks(struct ulink
*device
, struct jtag_command
*cmd
)
1789 unsigned num_cycles
;
1791 if (!tap_is_state_stable(tap_get_state())) {
1792 LOG_ERROR("JTAG_STABLECLOCKS: state not stable");
1796 num_cycles
= cmd
->cmd
.stableclocks
->num_cycles
;
1798 /* TMS stays either high (Test Logic Reset state) or low (all other states) */
1799 if (tap_get_state() == TAP_RESET
)
1800 ret
= ulink_append_set_signals_cmd(device
, 0, SIGNAL_TMS
);
1802 ret
= ulink_append_set_signals_cmd(device
, SIGNAL_TMS
, 0);
1804 if (ret
!= ERROR_OK
)
1807 while (num_cycles
> 0) {
1808 if (num_cycles
> 0xFFFF) {
1809 /* OpenULINK CMD_CLOCK_TCK can generate up to 0xFFFF (uint16_t) cycles */
1810 ret
= ulink_append_clock_tck_cmd(device
, 0xFFFF);
1811 num_cycles
-= 0xFFFF;
1813 ret
= ulink_append_clock_tck_cmd(device
, num_cycles
);
1817 if (ret
!= ERROR_OK
)
1825 * Post-process JTAG_SCAN command
1827 * @param ulink_cmd pointer to OpenULINK command that shall be processed.
1828 * @return on success: ERROR_OK
1829 * @return on failure: ERROR_FAIL
1831 int ulink_post_process_scan(struct ulink_cmd
*ulink_cmd
)
1833 struct jtag_command
*cmd
= ulink_cmd
->cmd_origin
;
1836 switch (jtag_scan_type(cmd
->cmd
.scan
)) {
1839 ret
= jtag_read_buffer(ulink_cmd
->payload_in_start
, cmd
->cmd
.scan
);
1842 /* Nothing to do for OUT scans */
1846 LOG_ERROR("BUG: ulink_post_process_scan() encountered an unknown"
1856 * Perform post-processing of commands after OpenULINK queue has been executed.
1858 * @param device pointer to struct ulink identifying ULINK driver instance.
1859 * @return on success: ERROR_OK
1860 * @return on failure: ERROR_FAIL
1862 int ulink_post_process_queue(struct ulink
*device
)
1864 struct ulink_cmd
*current
;
1865 struct jtag_command
*openocd_cmd
;
1868 current
= device
->queue_start
;
1870 while (current
!= NULL
) {
1871 openocd_cmd
= current
->cmd_origin
;
1873 /* Check if a corresponding OpenOCD command is stored for this
1874 * OpenULINK command */
1875 if ((current
->needs_postprocessing
== true) && (openocd_cmd
!= NULL
)) {
1876 switch (openocd_cmd
->type
) {
1878 ret
= ulink_post_process_scan(current
);
1880 case JTAG_TLR_RESET
:
1885 case JTAG_STABLECLOCKS
:
1886 /* Nothing to do for these commands */
1891 LOG_ERROR("BUG: ulink_post_process_queue() encountered unknown JTAG "
1896 if (ret
!= ERROR_OK
)
1900 current
= current
->next
;
1906 /**************************** JTAG driver functions ***************************/
1909 * Executes the JTAG Command Queue.
1911 * This is done in three stages: First, all OpenOCD commands are processed into
1912 * queued OpenULINK commands. Next, the OpenULINK command queue is sent to the
1913 * ULINK device and data received from the ULINK device is cached. Finally,
1914 * the post-processing function writes back data to the corresponding OpenOCD
1917 * @return on success: ERROR_OK
1918 * @return on failure: ERROR_FAIL
1920 static int ulink_execute_queue(void)
1922 struct jtag_command
*cmd
= jtag_command_queue
;
1926 switch (cmd
->type
) {
1928 ret
= ulink_queue_scan(ulink_handle
, cmd
);
1930 case JTAG_TLR_RESET
:
1931 ret
= ulink_queue_tlr_reset(ulink_handle
, cmd
);
1934 ret
= ulink_queue_runtest(ulink_handle
, cmd
);
1937 ret
= ulink_queue_reset(ulink_handle
, cmd
);
1940 ret
= ulink_queue_pathmove(ulink_handle
, cmd
);
1943 ret
= ulink_queue_sleep(ulink_handle
, cmd
);
1945 case JTAG_STABLECLOCKS
:
1946 ret
= ulink_queue_stableclocks(ulink_handle
, cmd
);
1950 LOG_ERROR("BUG: encountered unknown JTAG command type");
1954 if (ret
!= ERROR_OK
)
1960 if (ulink_handle
->commands_in_queue
> 0) {
1961 ret
= ulink_execute_queued_commands(ulink_handle
, USB_TIMEOUT
);
1962 if (ret
!= ERROR_OK
)
1965 ret
= ulink_post_process_queue(ulink_handle
);
1966 if (ret
!= ERROR_OK
)
1969 ulink_clear_queue(ulink_handle
);
1976 * Set the TCK frequency of the ULINK adapter.
1978 * @param khz desired JTAG TCK frequency.
1979 * @param jtag_speed where to store corresponding adapter-specific speed value.
1980 * @return on success: ERROR_OK
1981 * @return on failure: ERROR_FAIL
1983 static int ulink_khz(int khz
, int *jtag_speed
)
1988 LOG_ERROR("RCLK not supported");
1992 /* CLOCK_TCK commands are decoupled from others. Therefore, the frequency
1993 * setting can be done independently from all other commands. */
1995 ulink_handle
->delay_clock_tck
= -1;
1997 ret
= ulink_calculate_delay(DELAY_CLOCK_TCK
, khz
* 1000,
1998 &ulink_handle
->delay_clock_tck
);
1999 if (ret
!= ERROR_OK
)
2003 /* SCAN_{IN,OUT,IO} commands invoke CLOCK_TMS commands. Therefore, if the
2004 * requested frequency goes below the maximum frequency for SLOW_CLOCK_TMS
2005 * commands, all SCAN commands MUST also use the variable frequency
2006 * implementation! */
2008 ulink_handle
->delay_clock_tms
= -1;
2009 ulink_handle
->delay_scan_in
= -1;
2010 ulink_handle
->delay_scan_out
= -1;
2011 ulink_handle
->delay_scan_io
= -1;
2013 ret
= ulink_calculate_delay(DELAY_CLOCK_TMS
, khz
* 1000,
2014 &ulink_handle
->delay_clock_tms
);
2015 if (ret
!= ERROR_OK
)
2018 ret
= ulink_calculate_delay(DELAY_SCAN_IN
, khz
* 1000,
2019 &ulink_handle
->delay_scan_in
);
2020 if (ret
!= ERROR_OK
)
2023 ret
= ulink_calculate_delay(DELAY_SCAN_OUT
, khz
* 1000,
2024 &ulink_handle
->delay_scan_out
);
2025 if (ret
!= ERROR_OK
)
2028 ret
= ulink_calculate_delay(DELAY_SCAN_IO
, khz
* 1000,
2029 &ulink_handle
->delay_scan_io
);
2030 if (ret
!= ERROR_OK
)
2034 #ifdef _DEBUG_JTAG_IO_
2035 long f_tck
, f_tms
, f_scan_in
, f_scan_out
, f_scan_io
;
2037 ulink_calculate_frequency(DELAY_CLOCK_TCK
, ulink_handle
->delay_clock_tck
,
2039 ulink_calculate_frequency(DELAY_CLOCK_TMS
, ulink_handle
->delay_clock_tms
,
2041 ulink_calculate_frequency(DELAY_SCAN_IN
, ulink_handle
->delay_scan_in
,
2043 ulink_calculate_frequency(DELAY_SCAN_OUT
, ulink_handle
->delay_scan_out
,
2045 ulink_calculate_frequency(DELAY_SCAN_IO
, ulink_handle
->delay_scan_io
,
2048 DEBUG_JTAG_IO("ULINK TCK setup: delay_tck = %i (%li Hz),",
2049 ulink_handle
->delay_clock_tck
, f_tck
);
2050 DEBUG_JTAG_IO(" delay_tms = %i (%li Hz),",
2051 ulink_handle
->delay_clock_tms
, f_tms
);
2052 DEBUG_JTAG_IO(" delay_scan_in = %i (%li Hz),",
2053 ulink_handle
->delay_scan_in
, f_scan_in
);
2054 DEBUG_JTAG_IO(" delay_scan_out = %i (%li Hz),",
2055 ulink_handle
->delay_scan_out
, f_scan_out
);
2056 DEBUG_JTAG_IO(" delay_scan_io = %i (%li Hz),",
2057 ulink_handle
->delay_scan_io
, f_scan_io
);
2060 /* Configure the ULINK device with the new delay values */
2061 ret
= ulink_append_configure_tck_cmd(ulink_handle
,
2062 ulink_handle
->delay_scan_in
,
2063 ulink_handle
->delay_scan_out
,
2064 ulink_handle
->delay_scan_io
,
2065 ulink_handle
->delay_clock_tck
,
2066 ulink_handle
->delay_clock_tms
);
2068 if (ret
!= ERROR_OK
)
2077 * Set the TCK frequency of the ULINK adapter.
2079 * Because of the way the TCK frequency is set up in the OpenULINK firmware,
2080 * there are five different speed settings. To simplify things, the
2081 * adapter-specific speed setting value is identical to the TCK frequency in
2084 * @param speed desired adapter-specific speed value.
2085 * @return on success: ERROR_OK
2086 * @return on failure: ERROR_FAIL
2088 static int ulink_speed(int speed
)
2092 return ulink_khz(speed
, &dummy
);
2096 * Convert adapter-specific speed value to corresponding TCK frequency in kHz.
2098 * Because of the way the TCK frequency is set up in the OpenULINK firmware,
2099 * there are five different speed settings. To simplify things, the
2100 * adapter-specific speed setting value is identical to the TCK frequency in
2103 * @param speed adapter-specific speed value.
2104 * @param khz where to store corresponding TCK frequency in kHz.
2105 * @return on success: ERROR_OK
2106 * @return on failure: ERROR_FAIL
2108 static int ulink_speed_div(int speed
, int *khz
)
2116 * Initiates the firmware download to the ULINK adapter and prepares
2119 * @return on success: ERROR_OK
2120 * @return on failure: ERROR_FAIL
2122 static int ulink_init(void)
2125 char str_manufacturer
[20];
2126 bool download_firmware
= false;
2128 uint8_t input_signals
, output_signals
;
2130 ulink_handle
= calloc(1, sizeof(struct ulink
));
2131 if (ulink_handle
== NULL
)
2136 ret
= ulink_usb_open(&ulink_handle
);
2137 if (ret
!= ERROR_OK
) {
2138 LOG_ERROR("Could not open ULINK device");
2142 /* Get String Descriptor to determine if firmware needs to be loaded */
2143 ret
= usb_get_string_simple(ulink_handle
->usb_handle
, 1, str_manufacturer
, 20);
2145 /* Could not get descriptor -> Unconfigured or original Keil firmware */
2146 download_firmware
= true;
2148 /* We got a String Descriptor, check if it is the correct one */
2149 if (strncmp(str_manufacturer
, "OpenULINK", 9) != 0)
2150 download_firmware
= true;
2153 if (download_firmware
== true) {
2154 LOG_INFO("Loading OpenULINK firmware. This is reversible by power-cycling"
2156 ret
= ulink_load_firmware_and_renumerate(&ulink_handle
,
2157 ULINK_FIRMWARE_FILE
, ULINK_RENUMERATION_DELAY
);
2158 if (ret
!= ERROR_OK
) {
2159 LOG_ERROR("Could not download firmware and re-numerate ULINK");
2163 LOG_INFO("ULINK device is already running OpenULINK firmware");
2165 /* Initialize OpenULINK command queue */
2166 ulink_clear_queue(ulink_handle
);
2168 /* Issue one test command with short timeout */
2169 ret
= ulink_append_test_cmd(ulink_handle
);
2170 if (ret
!= ERROR_OK
)
2173 ret
= ulink_execute_queued_commands(ulink_handle
, 200);
2174 if (ret
!= ERROR_OK
) {
2175 /* Sending test command failed. The ULINK device may be forever waiting for
2176 * the host to fetch an USB Bulk IN packet (e. g. OpenOCD crashed or was
2177 * shut down by the user via Ctrl-C. Try to retrieve this Bulk IN packet. */
2178 dummy
= calloc(64, sizeof(uint8_t));
2180 ret
= usb_bulk_read(ulink_handle
->usb_handle
, (2 | USB_ENDPOINT_IN
),
2181 (char *)dummy
, 64, 200);
2186 /* Bulk IN transfer failed -> unrecoverable error condition */
2187 LOG_ERROR("Cannot communicate with ULINK device. Disconnect ULINK from "
2188 "the USB port and re-connect, then re-run OpenOCD");
2191 #ifdef _DEBUG_USB_COMMS_
2193 /* Successfully received Bulk IN packet -> continue */
2194 LOG_INFO("Recovered from lost Bulk IN packet");
2198 ulink_clear_queue(ulink_handle
);
2200 ulink_append_get_signals_cmd(ulink_handle
);
2201 ulink_execute_queued_commands(ulink_handle
, 200);
2203 /* Post-process the single CMD_GET_SIGNALS command */
2204 input_signals
= ulink_handle
->queue_start
->payload_in
[0];
2205 output_signals
= ulink_handle
->queue_start
->payload_in
[1];
2207 ulink_print_signal_states(input_signals
, output_signals
);
2209 ulink_clear_queue(ulink_handle
);
2215 * Closes the USB handle for the ULINK device.
2217 * @return on success: ERROR_OK
2218 * @return on failure: ERROR_FAIL
2220 static int ulink_quit(void)
2224 ret
= ulink_usb_close(&ulink_handle
);
2231 * Set a custom path to ULINK firmware image and force downloading to ULINK.
2233 COMMAND_HANDLER(ulink_download_firmware_handler
)
2238 return ERROR_COMMAND_SYNTAX_ERROR
;
2241 LOG_INFO("Downloading ULINK firmware image %s", CMD_ARGV
[0]);
2243 /* Download firmware image in CMD_ARGV[0] */
2244 ret
= ulink_load_firmware_and_renumerate(&ulink_handle
, (char *)CMD_ARGV
[0],
2245 ULINK_RENUMERATION_DELAY
);
2250 /*************************** Command Registration **************************/
2252 static const struct command_registration ulink_command_handlers
[] = {
2254 .name
= "ulink_download_firmware",
2255 .handler
= &ulink_download_firmware_handler
,
2256 .mode
= COMMAND_EXEC
,
2257 .help
= "download firmware image to ULINK device",
2258 .usage
= "path/to/ulink_firmware.hex",
2260 COMMAND_REGISTRATION_DONE
,
2263 struct jtag_interface ulink_interface
= {
2266 .commands
= ulink_command_handlers
,
2267 .transports
= jtag_only
,
2269 .execute_queue
= ulink_execute_queue
,
2271 .speed
= ulink_speed
,
2272 .speed_div
= ulink_speed_div
,
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)