OpenOCD
xds110.c
Go to the documentation of this file.
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 
3 /***************************************************************************
4  * Copyright (C) 2017 by Texas Instruments, Inc. *
5  ***************************************************************************/
6 
7 #ifdef HAVE_CONFIG_H
8 #include "config.h"
9 #endif
10 
11 #include <transport/transport.h>
12 #include <jtag/adapter.h>
13 #include <jtag/swd.h>
14 #include <jtag/interface.h>
15 #include <jtag/commands.h>
16 #include <jtag/tcl.h>
17 #include <libusb.h>
18 
19 /* XDS110 stand-alone probe voltage supply limits */
20 #define XDS110_MIN_VOLTAGE 1800
21 #define XDS110_MAX_VOLTAGE 3600
22 
23 /* XDS110 stand-alone probe hardware ID */
24 #define XDS110_STAND_ALONE_ID 0x21
25 
26 /* Firmware version that introduced OpenOCD support via block accesses */
27 #define OCD_FIRMWARE_VERSION 0x02030011
28 #define OCD_FIRMWARE_UPGRADE \
29  "XDS110: upgrade to version 2.3.0.11+ for improved support"
30 
31 /* Firmware version that introduced improved TCK performance */
32 #define FAST_TCK_FIRMWARE_VERSION 0x03000000
33 
34 /* Firmware version that introduced 10 MHz and 12 MHz TCK support */
35 #define FAST_TCK_PLUS_FIRMWARE_VERSION 0x03000003
36 
37 /***************************************************************************
38  * USB Connection Buffer Definitions *
39  ***************************************************************************/
40 
41 /* Max USB packet size for up to USB 3.0 */
42 #define MAX_PACKET 1024
43 
44 /*
45  * Maximum data payload that can be handled in a single call
46  * Limitation is the size of the buffers in the XDS110 firmware
47  */
48 #define MAX_DATA_BLOCK 4096
49 
50 #ifndef USB_PAYLOAD_SIZE
51 /* Largest data block plus parameters */
52 #define USB_PAYLOAD_SIZE (MAX_DATA_BLOCK + 60)
53 #endif
54 #define MAX_RESULT_QUEUE (MAX_DATA_BLOCK / 4)
55 
56 /***************************************************************************
57  * XDS110 Firmware API Definitions *
58  ***************************************************************************/
59 
60 /*
61  * Default values controlling how the host communicates commands
62  * with XDS110 firmware (automatic retry count and wait timeout)
63  */
64 #define DEFAULT_ATTEMPTS (1)
65 #define DEFAULT_TIMEOUT (4000)
66 
67 /* XDS110 API error codes */
68 #define SC_ERR_NONE 0
69 #define SC_ERR_XDS110_FAIL -261
70 #define SC_ERR_SWD_WAIT -613
71 #define SC_ERR_SWD_FAULT -614
72 #define SC_ERR_SWD_PROTOCOL -615
73 #define SC_ERR_SWD_PARITY -616
74 #define SC_ERR_SWD_DEVICE_ID -617
75 
76 /* TCK frequency limits */
77 #define XDS110_MIN_TCK_SPEED 100 /* kHz */
78 #define XDS110_MAX_SLOW_TCK_SPEED 2500 /* kHz */
79 #define XDS110_MAX_FAST_TCK_SPEED 14000 /* kHz */
80 #define XDS110_DEFAULT_TCK_SPEED 2500 /* kHz */
81 
82 /* Fixed TCK delay values for "Fast" TCK frequencies */
83 #define FAST_TCK_DELAY_14000_KHZ 0
84 #define FAST_TCK_DELAY_10000_KHZ 0xfffffffd
85 #define FAST_TCK_DELAY_12000_KHZ 0xfffffffe
86 #define FAST_TCK_DELAY_8500_KHZ 1
87 #define FAST_TCK_DELAY_5500_KHZ 2
88 /* For TCK frequencies below 5500 kHz, use calculated delay */
89 
90 /* Scan mode on connect */
91 #define MODE_JTAG 1
92 
93 /* XDS110 API JTAG state definitions */
94 #define XDS_JTAG_STATE_RESET 1
95 #define XDS_JTAG_STATE_IDLE 2
96 #define XDS_JTAG_STATE_SHIFT_DR 3
97 #define XDS_JTAG_STATE_SHIFT_IR 4
98 #define XDS_JTAG_STATE_PAUSE_DR 5
99 #define XDS_JTAG_STATE_PAUSE_IR 6
100 #define XDS_JTAG_STATE_EXIT1_DR 8
101 #define XDS_JTAG_STATE_EXIT1_IR 9
102 #define XDS_JTAG_STATE_EXIT2_DR 10
103 #define XDS_JTAG_STATE_EXIT2_IR 11
104 #define XDS_JTAG_STATE_SELECT_DR 12
105 #define XDS_JTAG_STATE_SELECT_IR 13
106 #define XDS_JTAG_STATE_UPDATE_DR 14
107 #define XDS_JTAG_STATE_UPDATE_IR 15
108 #define XDS_JTAG_STATE_CAPTURE_DR 16
109 #define XDS_JTAG_STATE_CAPTURE_IR 17
110 
111 /* XDS110 API JTAG transit definitions */
112 #define XDS_JTAG_TRANSIT_QUICKEST 1
113 #define XDS_JTAG_TRANSIT_VIA_CAPTURE 2
114 #define XDS_JTAG_TRANSIT_VIA_IDLE 3
115 
116 /* DAP register definitions as used by XDS110 APIs */
117 
118 #define DAP_AP 0 /* DAP AP register type */
119 #define DAP_DP 1 /* DAP DP register type */
120 
121 #define DAP_DP_IDCODE 0x0 /* DAP DP IDCODE register (read only) */
122 #define DAP_DP_ABORT 0x0 /* DAP DP ABORT register (write only) */
123 #define DAP_DP_STAT 0x4 /* DAP DP STAT register (for read only) */
124 #define DAP_DP_CTRL 0x4 /* DAP DP CTRL register (for write only) */
125 #define DAP_DP_ADDR 0x8 /* DAP DP SELECT register (legacy name) */
126 #define DAP_DP_RESEND 0x8 /* DAP DP RESEND register (read only) */
127 #define DAP_DP_SELECT 0x8 /* DAP DP SELECT register (write only) */
128 #define DAP_DP_RDBUFF 0xc /* DAP DP RDBUFF Read Buffer register */
129 
130 #define DAP_AP_CSW 0x00 /* DAP AP Control Status Word */
131 #define DAP_AP_TAR 0x04 /* DAP AP Transfer Address */
132 #define DAP_AP_DRW 0x0C /* DAP AP Data Read/Write */
133 #define DAP_AP_BD0 0x10 /* DAP AP Banked Data 0 */
134 #define DAP_AP_BD1 0x14 /* DAP AP Banked Data 1 */
135 #define DAP_AP_BD2 0x18 /* DAP AP Banked Data 2 */
136 #define DAP_AP_BD3 0x1C /* DAP AP Banked Data 3 */
137 #define DAP_AP_RTBL 0xF8 /* DAP AP Debug ROM Table */
138 #define DAP_AP_IDR 0xFC /* DAP AP Identification Register */
139 
140 /* Command packet definitions */
141 
142 #define XDS_OUT_LEN 1 /* command (byte) */
143 #define XDS_IN_LEN 4 /* error code (int) */
144 
145 /* XDS API Commands */
146 #define XDS_CONNECT 0x01 /* Connect JTAG connection */
147 #define XDS_DISCONNECT 0x02 /* Disconnect JTAG connection */
148 #define XDS_VERSION 0x03 /* Get firmware version and hardware ID */
149 #define XDS_SET_TCK 0x04 /* Set TCK delay (to set TCK frequency) */
150 #define XDS_SET_TRST 0x05 /* Assert or deassert nTRST signal */
151 #define XDS_CYCLE_TCK 0x07 /* Toggle TCK for a number of cycles */
152 #define XDS_GOTO_STATE 0x09 /* Go to requested JTAG state */
153 #define XDS_JTAG_SCAN 0x0c /* Send and receive JTAG scan */
154 #define XDS_SET_SRST 0x0e /* Assert or deassert nSRST signal */
155 #define CMAPI_CONNECT 0x0f /* CMAPI connect */
156 #define CMAPI_DISCONNECT 0x10 /* CMAPI disconnect */
157 #define CMAPI_ACQUIRE 0x11 /* CMAPI acquire */
158 #define CMAPI_RELEASE 0x12 /* CMAPI release */
159 #define CMAPI_REG_READ 0x15 /* CMAPI DAP register read */
160 #define CMAPI_REG_WRITE 0x16 /* CMAPI DAP register write */
161 #define SWD_CONNECT 0x17 /* Switch from JTAG to SWD connection */
162 #define SWD_DISCONNECT 0x18 /* Switch from SWD to JTAG connection */
163 #define CJTAG_CONNECT 0x2b /* Switch from JTAG to cJTAG connection */
164 #define CJTAG_DISCONNECT 0x2c /* Switch from cJTAG to JTAG connection */
165 #define XDS_SET_SUPPLY 0x32 /* Set up stand-alone probe upply voltage */
166 #define OCD_DAP_REQUEST 0x3a /* Handle block of DAP requests */
167 #define OCD_SCAN_REQUEST 0x3b /* Handle block of JTAG scan requests */
168 #define OCD_PATHMOVE 0x3c /* Handle PATHMOVE to navigate JTAG states */
169 
170 #define CMD_IR_SCAN 1
171 #define CMD_DR_SCAN 2
172 #define CMD_RUNTEST 3
173 #define CMD_STABLECLOCKS 4
174 
175 /* Array to convert from OpenOCD tap_state_t to XDS JTAG state */
176 static const uint32_t xds_jtag_state[] = {
177  XDS_JTAG_STATE_EXIT2_DR, /* TAP_DREXIT2 = 0x0 */
178  XDS_JTAG_STATE_EXIT1_DR, /* TAP_DREXIT1 = 0x1 */
179  XDS_JTAG_STATE_SHIFT_DR, /* TAP_DRSHIFT = 0x2 */
180  XDS_JTAG_STATE_PAUSE_DR, /* TAP_DRPAUSE = 0x3 */
181  XDS_JTAG_STATE_SELECT_IR, /* TAP_IRSELECT = 0x4 */
182  XDS_JTAG_STATE_UPDATE_DR, /* TAP_DRUPDATE = 0x5 */
183  XDS_JTAG_STATE_CAPTURE_DR, /* TAP_DRCAPTURE = 0x6 */
184  XDS_JTAG_STATE_SELECT_DR, /* TAP_DRSELECT = 0x7 */
185  XDS_JTAG_STATE_EXIT2_IR, /* TAP_IREXIT2 = 0x8 */
186  XDS_JTAG_STATE_EXIT1_IR, /* TAP_IREXIT1 = 0x9 */
187  XDS_JTAG_STATE_SHIFT_IR, /* TAP_IRSHIFT = 0xa */
188  XDS_JTAG_STATE_PAUSE_IR, /* TAP_IRPAUSE = 0xb */
189  XDS_JTAG_STATE_IDLE, /* TAP_IDLE = 0xc */
190  XDS_JTAG_STATE_UPDATE_IR, /* TAP_IRUPDATE = 0xd */
191  XDS_JTAG_STATE_CAPTURE_IR, /* TAP_IRCAPTURE = 0xe */
192  XDS_JTAG_STATE_RESET, /* TAP_RESET = 0xf */
193 };
194 
195 struct scan_result {
196  bool first;
197  uint8_t *buffer;
198  uint32_t num_bits;
199 };
200 
201 struct xds110_info {
202  /* USB connection handles and data buffers */
203  struct libusb_context *ctx;
204  struct libusb_device_handle *dev;
206  unsigned char write_packet[3];
208  /* Device vid/pid */
209  uint16_t vid;
210  uint16_t pid;
211  /* Debug interface */
212  uint8_t interface;
213  uint8_t endpoint_in;
214  uint8_t endpoint_out;
215  /* Status flags */
221  /* DAP register caches */
222  uint32_t select;
223  uint32_t rdbuff;
225  /* TCK speed and delay count*/
226  uint32_t speed;
227  uint32_t delay_count;
228  /* XDS110 voltage supply setting */
229  uint32_t voltage;
230  /* XDS110 firmware and hardware version */
231  uint32_t firmware;
232  uint16_t hardware;
233  /* Transaction queues */
234  unsigned char txn_requests[MAX_DATA_BLOCK];
238  uint32_t txn_result_size;
240 };
241 
242 static struct xds110_info xds110 = {
243  .ctx = NULL,
244  .dev = NULL,
245  .vid = 0,
246  .pid = 0,
247  .interface = 0,
248  .endpoint_in = 0,
249  .endpoint_out = 0,
250  .is_connected = false,
251  .is_cmapi_connected = false,
252  .is_cmapi_acquired = false,
253  .is_swd_mode = false,
254  .is_ap_dirty = false,
255  .speed = XDS110_DEFAULT_TCK_SPEED,
256  .delay_count = 0,
257  .voltage = 0,
258  .firmware = 0,
259  .hardware = 0,
260  .txn_request_size = 0,
261  .txn_result_size = 0,
262  .txn_result_count = 0
263 };
264 
265 static inline void xds110_set_u32(uint8_t *buffer, uint32_t value)
266 {
267  buffer[3] = (value >> 24) & 0xff;
268  buffer[2] = (value >> 16) & 0xff;
269  buffer[1] = (value >> 8) & 0xff;
270  buffer[0] = (value >> 0) & 0xff;
271 }
272 
273 static inline void xds110_set_u16(uint8_t *buffer, uint16_t value)
274 {
275  buffer[1] = (value >> 8) & 0xff;
276  buffer[0] = (value >> 0) & 0xff;
277 }
278 
279 static inline uint32_t xds110_get_u32(uint8_t *buffer)
280 {
281  uint32_t value = (((uint32_t)buffer[3]) << 24) |
282  (((uint32_t)buffer[2]) << 16) |
283  (((uint32_t)buffer[1]) << 8) |
284  (((uint32_t)buffer[0]) << 0);
285  return value;
286 }
287 
288 static inline uint16_t xds110_get_u16(uint8_t *buffer)
289 {
290  uint16_t value = (((uint32_t)buffer[1]) << 8) |
291  (((uint32_t)buffer[0]) << 0);
292  return value;
293 }
294 
295 /***************************************************************************
296  * usb connection routines *
297  * *
298  * The following functions handle connecting, reading, and writing to *
299  * the XDS110 over USB using the libusb library. *
300  ***************************************************************************/
301 
302 static bool usb_connect(void)
303 {
304  struct libusb_context *ctx = NULL;
305  struct libusb_device **list = NULL;
306  struct libusb_device_handle *dev = NULL;
307 
308  struct libusb_device_descriptor desc;
309 
310  /* The vid/pids of possible XDS110 configurations */
311  uint16_t vids[] = { 0x0451, 0x0451, 0x1cbe };
312  uint16_t pids[] = { 0xbef3, 0xbef4, 0x02a5 };
313  /* Corresponding interface and endpoint numbers for configurations */
314  uint8_t interfaces[] = { 2, 2, 0 };
315  uint8_t endpoints_in[] = { 3, 3, 1 };
316  uint8_t endpoints_out[] = { 2, 2, 1 };
317 
318  ssize_t count = 0;
319  ssize_t i = 0;
320  int result = 0;
321  bool found = false;
322  uint32_t device = 0;
323  bool match = false;
324 
325  /* Initialize libusb context */
326  result = libusb_init(&ctx);
327 
328  if (result == 0) {
329  /* Get list of USB devices attached to system */
330  count = libusb_get_device_list(ctx, &list);
331  if (count <= 0) {
332  result = -1;
333  list = NULL;
334  }
335  }
336 
337  if (result == 0) {
338  /* Scan through list of devices for any XDS110s */
339  for (i = 0; i < count; i++) {
340  /* Check for device vid/pid match */
341  libusb_get_device_descriptor(list[i], &desc);
342  match = false;
343  for (device = 0; device < ARRAY_SIZE(vids); device++) {
344  if (desc.idVendor == vids[device] &&
345  desc.idProduct == pids[device]) {
346  match = true;
347  break;
348  }
349  }
350  if (match) {
351  result = libusb_open(list[i], &dev);
352  if (result == 0) {
353  const int max_data = 256;
354  unsigned char data[max_data + 1];
355  *data = '\0';
356 
357  /* May be the requested device if serial number matches */
359  /* No serial number given; match first XDS110 found */
360  found = true;
361  break;
362  } else {
363  /* Get the device's serial number string */
364  result = libusb_get_string_descriptor_ascii(dev,
365  desc.iSerialNumber, data, max_data);
366  if (result > 0 &&
367  strcmp((char *)data, adapter_get_required_serial()) == 0) {
368  found = true;
369  break;
370  }
371  }
372 
373  /* If we fall though to here, we don't want this device */
374  libusb_close(dev);
375  dev = NULL;
376  }
377  }
378  }
379  }
380 
381  /*
382  * We can fall through the for() loop with two possible exit conditions:
383  * 1) found the right XDS110, and that device is open
384  * 2) didn't find the XDS110, and no devices are currently open
385  */
386 
387  if (list) {
388  /* Free the device list, we're done with it */
389  libusb_free_device_list(list, 1);
390  }
391 
392  if (found) {
393  /* Save the vid/pid of the device we're using */
394  xds110.vid = vids[device];
395  xds110.pid = pids[device];
396 
397  /* Save the debug interface and endpoints for the device */
398  xds110.interface = interfaces[device];
399  xds110.endpoint_in = endpoints_in[device] | LIBUSB_ENDPOINT_IN;
400  xds110.endpoint_out = endpoints_out[device] | LIBUSB_ENDPOINT_OUT;
401 
402  /* Save the context and device handles */
403  xds110.ctx = ctx;
404  xds110.dev = dev;
405 
406  /* Set libusb to auto detach kernel */
407  (void)libusb_set_auto_detach_kernel_driver(dev, 1);
408 
409  /* Claim the debug interface on the XDS110 */
410  result = libusb_claim_interface(dev, xds110.interface);
411  } else {
412  /* Couldn't find an XDS110, flag the error */
413  result = -1;
414  }
415 
416  /* On an error, clean up what we can */
417  if (result != 0) {
418  if (dev) {
419  /* Release the debug and data interface on the XDS110 */
420  (void)libusb_release_interface(dev, xds110.interface);
421  libusb_close(dev);
422  }
423  if (ctx)
424  libusb_exit(ctx);
425  xds110.ctx = NULL;
426  xds110.dev = NULL;
427  }
428 
429  /* Log the results */
430  if (result == 0)
431  LOG_INFO("XDS110: connected");
432  else
433  LOG_ERROR("XDS110: failed to connect");
434 
435  return (result == 0) ? true : false;
436 }
437 
438 static void usb_disconnect(void)
439 {
440  if (xds110.dev) {
441  /* Release the debug and data interface on the XDS110 */
442  (void)libusb_release_interface(xds110.dev, xds110.interface);
443  libusb_close(xds110.dev);
444  xds110.dev = NULL;
445  }
446  if (xds110.ctx) {
447  libusb_exit(xds110.ctx);
448  xds110.ctx = NULL;
449  }
450 
451  LOG_INFO("XDS110: disconnected");
452 }
453 
454 static bool usb_read(unsigned char *buffer, int size, int *bytes_read,
455  int timeout)
456 {
457  int result;
458 
459  if (!xds110.dev || !buffer || !bytes_read)
460  return false;
461 
462  /* Force a non-zero timeout to prevent blocking */
463  if (timeout == 0)
465 
466  result = libusb_bulk_transfer(xds110.dev, xds110.endpoint_in, buffer, size,
467  bytes_read, timeout);
468 
469  return (result == 0) ? true : false;
470 }
471 
472 static bool usb_write(unsigned char *buffer, int size, int *written)
473 {
474  int bytes_written = 0;
475  int result = LIBUSB_SUCCESS;
476  int retries = 0;
477 
478  if (!xds110.dev || !buffer)
479  return false;
480 
481  result = libusb_bulk_transfer(xds110.dev, xds110.endpoint_out, buffer,
482  size, &bytes_written, 0);
483 
484  while (result == LIBUSB_ERROR_PIPE && retries < 3) {
485  /* Try clearing the pipe stall and retry transfer */
486  libusb_clear_halt(xds110.dev, xds110.endpoint_out);
487  result = libusb_bulk_transfer(xds110.dev, xds110.endpoint_out, buffer,
488  size, &bytes_written, 0);
489  retries++;
490  }
491 
492  if (written)
493  *written = bytes_written;
494 
495  return (result == 0 && size == bytes_written) ? true : false;
496 }
497 
498 static bool usb_get_response(uint32_t *total_bytes_read, uint32_t timeout)
499 {
500  static unsigned char buffer[MAX_PACKET];
501  int bytes_read;
502  uint16_t size;
503  uint16_t count;
504  bool success;
505 
506  size = 0;
507  success = true;
508  while (success) {
509  success = usb_read(buffer, sizeof(buffer), &bytes_read, timeout);
510  if (success) {
511  /*
512  * Validate that this appears to be a good response packet
513  * First check it contains enough data for header and error
514  * code, plus the first character is the start character
515  */
516  if (bytes_read >= 7 && '*' == buffer[0]) {
517  /* Extract the payload size */
518  size = xds110_get_u16(&buffer[1]);
519  /* Sanity test on payload size */
520  if (USB_PAYLOAD_SIZE >= size && 4 <= size) {
521  /* Check we didn't get more data than expected */
522  if ((bytes_read - 3) <= size) {
523  /* Packet appears to be valid, move on */
524  break;
525  }
526  }
527  }
528  }
529  /*
530  * Somehow received an invalid packet, retry till we
531  * time out or a valid response packet is received
532  */
533  }
534 
535  /* Abort now if we didn't receive a valid response */
536  if (!success) {
537  if (total_bytes_read)
538  *total_bytes_read = 0;
539  return false;
540  }
541 
542  /* Build the return payload into xds110.read_payload */
543 
544  /* Copy over payload data from received buffer (skipping header) */
545  count = 0;
546  bytes_read -= 3;
547  memcpy((void *)&xds110.read_payload[count], (void *)&buffer[3], bytes_read);
548  count += bytes_read;
549  /*
550  * Drop timeout to just 1/2 second. Once the XDS110 starts sending
551  * a response, the remaining packets should arrive in short order
552  */
553  if (timeout > 500)
554  timeout = 500; /* ms */
555 
556  /* If there's more data to retrieve, get it now */
557  while ((count < size) && success) {
558  success = usb_read(buffer, sizeof(buffer), &bytes_read, timeout);
559  if (success) {
560  if ((count + bytes_read) > size) {
561  /* Read too much data, not a valid packet, abort */
562  success = false;
563  } else {
564  /* Copy this data over to xds110.read_payload */
565  memcpy((void *)&xds110.read_payload[count], (void *)buffer,
566  bytes_read);
567  count += bytes_read;
568  }
569  }
570  }
571 
572  if (!success)
573  count = 0;
574  if (total_bytes_read)
575  *total_bytes_read = count;
576 
577  return success;
578 }
579 
580 static bool usb_send_command(uint16_t size)
581 {
582  /* Check the packet length */
583  if (size > USB_PAYLOAD_SIZE)
584  return false;
585 
586  /* Place the start character into the packet buffer */
587  xds110.write_packet[0] = '*';
588 
589  /* Place the payload size into the packet buffer */
591 
592  /* Adjust size to include header */
593  size += 3;
594 
595  /* Send the data via the USB connection */
596  return usb_write(xds110.write_packet, (int)size, NULL);
597 }
598 
599 /***************************************************************************
600  * XDS110 firmware API routines *
601  * *
602  * The following functions handle calling into the XDS110 firmware to *
603  * perform requested debug actions. *
604  ***************************************************************************/
605 
606 static bool xds_execute(uint32_t out_length, uint32_t in_length,
607  uint32_t attempts, uint32_t timeout)
608 {
609  bool done = false;
610  bool success = true;
611  int error = 0;
612  uint32_t bytes_read = 0;
613 
614  if (!xds110.dev)
615  return false;
616 
617  while (!done && attempts > 0) {
618  attempts--;
619 
620  /* Send command to XDS110 */
621  success = usb_send_command(out_length);
622 
623  if (success) {
624  /* Get response from XDS110 */
625  success = usb_get_response(&bytes_read, timeout);
626  }
627 
628  if (success) {
629  /* Check for valid response from XDS code handling */
630  if (bytes_read != in_length) {
631  /* Unexpected amount of data returned */
632  success = false;
633  LOG_DEBUG("XDS110: command 0x%02x return %" PRIu32 " bytes, expected %" PRIu32,
634  xds110.write_payload[0], bytes_read, in_length);
635  } else {
636  /* Extract error code from return packet */
637  error = (int)xds110_get_u32(&xds110.read_payload[0]);
638  done = true;
639  if (error != SC_ERR_NONE)
640  LOG_DEBUG("XDS110: command 0x%02x returned error %d",
641  xds110.write_payload[0], error);
642  }
643  }
644  }
645 
646  if (!success)
647  error = SC_ERR_XDS110_FAIL;
648 
649  if (error != 0)
650  success = false;
651 
652  return success;
653 }
654 
655 static bool xds_connect(void)
656 {
657  bool success;
658 
660 
663 
664  return success;
665 }
666 
667 static bool xds_disconnect(void)
668 {
669  bool success;
670 
672 
675 
676  return success;
677 }
678 
679 static bool xds_version(uint32_t *firmware_id, uint16_t *hardware_id)
680 {
681  uint8_t *fw_id_pntr = &xds110.read_payload[XDS_IN_LEN + 0]; /* 32-bits */
682  uint8_t *hw_id_pntr = &xds110.read_payload[XDS_IN_LEN + 4]; /* 16-bits */
683 
684  bool success;
685 
687 
690 
691  if (success) {
692  if (firmware_id)
693  *firmware_id = xds110_get_u32(fw_id_pntr);
694  if (hardware_id)
695  *hardware_id = xds110_get_u16(hw_id_pntr);
696  }
697 
698  return success;
699 }
700 
701 static bool xds_set_tck_delay(uint32_t delay)
702 {
703  uint8_t *delay_pntr = &xds110.write_payload[XDS_OUT_LEN + 0]; /* 32-bits */
704 
705  bool success;
706 
708 
709  xds110_set_u32(delay_pntr, delay);
710 
713 
714  return success;
715 }
716 
717 static bool xds_set_trst(uint8_t trst)
718 {
719  uint8_t *trst_pntr = &xds110.write_payload[XDS_OUT_LEN + 0]; /* 8-bits */
720 
721  bool success;
722 
724 
725  *trst_pntr = trst;
726 
729 
730  return success;
731 }
732 
733 static bool xds_cycle_tck(uint32_t count)
734 {
735  uint8_t *count_pntr = &xds110.write_payload[XDS_OUT_LEN + 0]; /* 32-bits */
736 
737  bool success;
738 
740 
741  xds110_set_u32(count_pntr, count);
742 
745 
746  return success;
747 }
748 
749 static bool xds_goto_state(uint32_t state)
750 {
751  uint8_t *state_pntr = &xds110.write_payload[XDS_OUT_LEN + 0]; /* 32-bits */
752  uint8_t *transit_pntr = &xds110.write_payload[XDS_OUT_LEN+4]; /* 32-bits */
753 
754  bool success;
755 
757 
758  xds110_set_u32(state_pntr, state);
760 
763 
764  return success;
765 }
766 
767 static bool xds_jtag_scan(uint32_t shift_state, uint16_t shift_bits,
768  uint32_t end_state, uint8_t *data_out, uint8_t *data_in)
769 {
770  uint8_t *bits_pntr = &xds110.write_payload[XDS_OUT_LEN + 0]; /* 16-bits */
771  uint8_t *path_pntr = &xds110.write_payload[XDS_OUT_LEN + 2]; /* 8-bits */
772  uint8_t *trans1_pntr = &xds110.write_payload[XDS_OUT_LEN + 3]; /* 8-bits */
773  uint8_t *end_pntr = &xds110.write_payload[XDS_OUT_LEN + 4]; /* 8-bits */
774  uint8_t *trans2_pntr = &xds110.write_payload[XDS_OUT_LEN + 5]; /* 8-bits */
775  uint8_t *pre_pntr = &xds110.write_payload[XDS_OUT_LEN + 6]; /* 16-bits */
776  uint8_t *pos_pntr = &xds110.write_payload[XDS_OUT_LEN + 8]; /* 16-bits */
777  uint8_t *delay_pntr = &xds110.write_payload[XDS_OUT_LEN + 10]; /* 16-bits */
778  uint8_t *rep_pntr = &xds110.write_payload[XDS_OUT_LEN + 12]; /* 16-bits */
779  uint8_t *out_pntr = &xds110.write_payload[XDS_OUT_LEN + 14]; /* 16-bits */
780  uint8_t *in_pntr = &xds110.write_payload[XDS_OUT_LEN + 16]; /* 16-bits */
781  uint8_t *data_out_pntr = &xds110.write_payload[XDS_OUT_LEN + 18];
782  uint8_t *data_in_pntr = &xds110.read_payload[XDS_IN_LEN+0];
783 
784  uint16_t total_bytes = DIV_ROUND_UP(shift_bits, 8);
785 
786  bool success;
787 
789 
790  xds110_set_u16(bits_pntr, shift_bits); /* bits to scan */
791  *path_pntr = (uint8_t)(shift_state & 0xff); /* IR vs DR path */
792  *trans1_pntr = (uint8_t)XDS_JTAG_TRANSIT_QUICKEST; /* start state route */
793  *end_pntr = (uint8_t)(end_state & 0xff); /* JTAG state after scan */
794  *trans2_pntr = (uint8_t)XDS_JTAG_TRANSIT_QUICKEST; /* end state route */
795  xds110_set_u16(pre_pntr, 0); /* number of preamble bits */
796  xds110_set_u16(pos_pntr, 0); /* number of postamble bits */
797  xds110_set_u16(delay_pntr, 0); /* number of extra TCKs after scan */
798  xds110_set_u16(rep_pntr, 1); /* number of repetitions */
799  xds110_set_u16(out_pntr, total_bytes); /* out buffer offset (if repeats) */
800  xds110_set_u16(in_pntr, total_bytes); /* in buffer offset (if repeats) */
801 
802  memcpy((void *)data_out_pntr, (void *)data_out, total_bytes);
803 
804  success = xds_execute(XDS_OUT_LEN + 18 + total_bytes,
806 
807  if (success)
808  memcpy((void *)data_in, (void *)data_in_pntr, total_bytes);
809 
810  return success;
811 }
812 
813 static bool xds_set_srst(uint8_t srst)
814 {
815  uint8_t *srst_pntr = &xds110.write_payload[XDS_OUT_LEN + 0]; /* 8-bits */
816 
817  bool success;
818 
820 
821  *srst_pntr = srst;
822 
825 
826  return success;
827 }
828 
829 static bool cmapi_connect(uint32_t *idcode)
830 {
831  uint8_t *idcode_pntr = &xds110.read_payload[XDS_IN_LEN + 0]; /* 32-bits */
832 
833  bool success;
834 
836 
839 
840  if (success) {
841  if (idcode)
842  *idcode = xds110_get_u32(idcode_pntr);
843  }
844 
845  return success;
846 }
847 
848 static bool cmapi_disconnect(void)
849 {
850  bool success;
851 
853 
856 
857  return success;
858 }
859 
860 static bool cmapi_acquire(void)
861 {
862  bool success;
863 
865 
868 
869  return success;
870 }
871 
872 static bool cmapi_release(void)
873 {
874  bool success;
875 
877 
880 
881  return success;
882 }
883 
884 static bool cmapi_read_dap_reg(uint32_t type, uint32_t ap_num,
885  uint32_t address, uint32_t *value)
886 {
887  uint8_t *type_pntr = &xds110.write_payload[XDS_OUT_LEN + 0]; /* 8-bits */
888  uint8_t *ap_num_pntr = &xds110.write_payload[XDS_OUT_LEN + 1]; /* 8-bits */
889  uint8_t *address_pntr = &xds110.write_payload[XDS_OUT_LEN + 2]; /* 8-bits */
890  uint8_t *value_pntr = &xds110.read_payload[XDS_IN_LEN + 0]; /* 32-bits */
891 
892  bool success;
893 
895 
896  *type_pntr = (uint8_t)(type & 0xff);
897  *ap_num_pntr = (uint8_t)(ap_num & 0xff);
898  *address_pntr = (uint8_t)(address & 0xff);
899 
902 
903  if (success) {
904  if (value)
905  *value = xds110_get_u32(value_pntr);
906  }
907 
908  return success;
909 }
910 
911 static bool cmapi_write_dap_reg(uint32_t type, uint32_t ap_num,
912  uint32_t address, uint32_t *value)
913 {
914  uint8_t *type_pntr = &xds110.write_payload[XDS_OUT_LEN + 0]; /* 8-bits */
915  uint8_t *ap_num_pntr = &xds110.write_payload[XDS_OUT_LEN + 1]; /* 8-bits */
916  uint8_t *address_pntr = &xds110.write_payload[XDS_OUT_LEN + 2]; /* 8-bits */
917  uint8_t *value_pntr = &xds110.write_payload[XDS_OUT_LEN + 3]; /* 32-bits */
918 
919  bool success;
920 
921  if (!value)
922  return false;
923 
925 
926  *type_pntr = (uint8_t)(type & 0xff);
927  *ap_num_pntr = (uint8_t)(ap_num & 0xff);
928  *address_pntr = (uint8_t)(address & 0xff);
929  xds110_set_u32(value_pntr, *value);
930 
933 
934  return success;
935 }
936 
937 static bool swd_connect(void)
938 {
939  bool success;
940 
942 
945 
946  return success;
947 }
948 
949 static bool swd_disconnect(void)
950 {
951  bool success;
952 
954 
957 
958  return success;
959 }
960 
961 static bool cjtag_connect(uint32_t format)
962 {
963  uint8_t *format_pntr = &xds110.write_payload[XDS_OUT_LEN + 0]; /* 32-bits */
964 
965  bool success;
966 
968 
969  xds110_set_u32(format_pntr, format);
970 
973 
974  return success;
975 }
976 
977 static bool cjtag_disconnect(void)
978 {
979  bool success;
980 
982 
985 
986  return success;
987 }
988 
989 static bool xds_set_supply(uint32_t voltage)
990 {
991  uint8_t *volts_pntr = &xds110.write_payload[XDS_OUT_LEN + 0]; /* 32-bits */
992  uint8_t *source_pntr = &xds110.write_payload[XDS_OUT_LEN + 4]; /* 8-bits */
993 
994  bool success;
995 
997 
998  xds110_set_u32(volts_pntr, voltage);
999  *source_pntr = (uint8_t)(voltage != 0 ? 1 : 0);
1000 
1002  DEFAULT_TIMEOUT);
1003 
1004  return success;
1005 }
1006 
1007 static bool ocd_dap_request(uint8_t *dap_requests, uint32_t request_size,
1008  uint32_t *dap_results, uint32_t result_count)
1009 {
1010  uint8_t *request_pntr = &xds110.write_payload[XDS_OUT_LEN + 0];
1011  uint8_t *result_pntr = &xds110.read_payload[XDS_IN_LEN + 0];
1012 
1013  bool success;
1014 
1015  if (!dap_requests || !dap_results)
1016  return false;
1017 
1019 
1020  memcpy((void *)request_pntr, (void *)dap_requests, request_size);
1021 
1022  success = xds_execute(XDS_OUT_LEN + request_size,
1023  XDS_IN_LEN + (result_count * 4), DEFAULT_ATTEMPTS,
1024  DEFAULT_TIMEOUT);
1025 
1026  if (success && (result_count > 0))
1027  memcpy((void *)dap_results, (void *)result_pntr, result_count * 4);
1028 
1029  return success;
1030 }
1031 
1032 static bool ocd_scan_request(uint8_t *scan_requests, uint32_t request_size,
1033  uint8_t *scan_results, uint32_t result_size)
1034 {
1035  uint8_t *request_pntr = &xds110.write_payload[XDS_OUT_LEN + 0];
1036  uint8_t *result_pntr = &xds110.read_payload[XDS_IN_LEN + 0];
1037 
1038  bool success;
1039 
1040  if (!scan_requests || !scan_results)
1041  return false;
1042 
1044 
1045  memcpy((void *)request_pntr, (void *)scan_requests, request_size);
1046 
1047  success = xds_execute(XDS_OUT_LEN + request_size,
1048  XDS_IN_LEN + result_size, DEFAULT_ATTEMPTS,
1049  DEFAULT_TIMEOUT);
1050 
1051  if (success && (result_size > 0))
1052  memcpy((void *)scan_results, (void *)result_pntr, result_size);
1053 
1054  return success;
1055 }
1056 
1057 static bool ocd_pathmove(uint32_t num_states, uint8_t *path)
1058 {
1059  uint8_t *num_pntr = &xds110.write_payload[XDS_OUT_LEN + 0]; /* 32-bits */
1060  uint8_t *path_pntr = &xds110.write_payload[XDS_OUT_LEN + 4];
1061 
1062  bool success;
1063 
1064  if (!path)
1065  return false;
1066 
1068 
1069  xds110_set_u32(num_pntr, num_states);
1070 
1071  memcpy((void *)path_pntr, (void *)path, num_states);
1072 
1073  success = xds_execute(XDS_OUT_LEN + 4 + num_states, XDS_IN_LEN,
1075 
1076  return success;
1077 }
1078 
1079 /***************************************************************************
1080  * swd driver interface *
1081  * *
1082  * The following functions provide SWD support to OpenOCD. *
1083  ***************************************************************************/
1084 
1085 static int xds110_swd_init(void)
1086 {
1087  xds110.is_swd_mode = true;
1088  return ERROR_OK;
1089 }
1090 
1092 {
1093  uint32_t idcode;
1094  bool success;
1095 
1096  switch (seq) {
1097  case LINE_RESET:
1098  LOG_ERROR("Sequence SWD line reset (%d) not supported", seq);
1099  return ERROR_FAIL;
1100  case JTAG_TO_SWD:
1101  LOG_DEBUG("JTAG-to-SWD");
1102  xds110.is_swd_mode = false;
1103  xds110.is_cmapi_connected = false;
1104  xds110.is_cmapi_acquired = false;
1105  /* Run sequence to put target in SWD mode */
1106  success = swd_connect();
1107  /* Re-initialize CMAPI API for DAP access */
1108  if (success) {
1109  xds110.is_swd_mode = true;
1110  success = cmapi_connect(&idcode);
1111  if (success) {
1112  xds110.is_cmapi_connected = true;
1113  success = cmapi_acquire();
1114  }
1115  }
1116  break;
1117  case SWD_TO_JTAG:
1118  LOG_DEBUG("SWD-to-JTAG");
1119  xds110.is_swd_mode = false;
1120  xds110.is_cmapi_connected = false;
1121  xds110.is_cmapi_acquired = false;
1122  /* Run sequence to put target in JTAG mode */
1123  success = swd_disconnect();
1124  if (success) {
1125  /* Re-initialize JTAG interface */
1126  success = cjtag_connect(MODE_JTAG);
1127  }
1128  break;
1129  default:
1130  LOG_ERROR("Sequence %d not supported", seq);
1131  return ERROR_FAIL;
1132  }
1133 
1134  if (success)
1135  return ERROR_OK;
1136  else
1137  return ERROR_FAIL;
1138 }
1139 
1140 static bool xds110_legacy_read_reg(uint8_t cmd, uint32_t *value)
1141 {
1142  /* Make sure this is a read request */
1143  bool is_read_request = (0 != (SWD_CMD_RNW & cmd));
1144  /* Determine whether this is a DP or AP register access */
1145  uint32_t type = (0 != (SWD_CMD_APNDP & cmd)) ? DAP_AP : DAP_DP;
1146  /* Determine the AP number from cached SELECT value */
1147  uint32_t ap_num = (xds110.select & 0xff000000) >> 24;
1148  /* Extract register address from command */
1149  uint32_t address = ((cmd & SWD_CMD_A32) >> 1);
1150  /* Extract bank address from cached SELECT value */
1151  uint32_t bank = (xds110.select & 0x000000f0);
1152 
1153  uint32_t reg_value = 0;
1154  uint32_t temp_value = 0;
1155 
1156  bool success;
1157 
1158  if (!is_read_request)
1159  return false;
1160 
1161  if (type == DAP_AP) {
1162  /* Add bank address to register address for CMAPI call */
1163  address |= bank;
1164  }
1165 
1166  if (DAP_DP == type && DAP_DP_RDBUFF == address && xds110.use_rdbuff) {
1167  /* If RDBUFF is cached and this is a DP RDBUFF read, use the cache */
1168  reg_value = xds110.rdbuff;
1169  success = true;
1170  } else if (DAP_AP == type && DAP_AP_DRW == address && xds110.use_rdbuff) {
1171  /* If RDBUFF is cached and this is an AP DRW read, use the cache, */
1172  /* but still call into the firmware to get the next read. */
1173  reg_value = xds110.rdbuff;
1174  success = cmapi_read_dap_reg(type, ap_num, address, &temp_value);
1175  } else {
1176  success = cmapi_read_dap_reg(type, ap_num, address, &temp_value);
1177  if (success)
1178  reg_value = temp_value;
1179  }
1180 
1181  /* Mark that we have consumed or invalidated the RDBUFF cache */
1182  xds110.use_rdbuff = false;
1183 
1184  /* Handle result of read attempt */
1185  if (!success)
1186  LOG_ERROR("XDS110: failed to read DAP register");
1187  else if (value)
1188  *value = reg_value;
1189 
1190  if (success && DAP_AP == type) {
1191  /*
1192  * On a successful DAP AP read, we actually have the value from RDBUFF,
1193  * the firmware will have run the AP request and made the RDBUFF read
1194  */
1195  xds110.use_rdbuff = true;
1196  xds110.rdbuff = temp_value;
1197  }
1198 
1199  return success;
1200 }
1201 
1202 static bool xds110_legacy_write_reg(uint8_t cmd, uint32_t value)
1203 {
1204  /* Make sure this isn't a read request */
1205  bool is_read_request = (0 != (SWD_CMD_RNW & cmd));
1206  /* Determine whether this is a DP or AP register access */
1207  uint32_t type = (0 != (SWD_CMD_APNDP & cmd)) ? DAP_AP : DAP_DP;
1208  /* Determine the AP number from cached SELECT value */
1209  uint32_t ap_num = (xds110.select & 0xff000000) >> 24;
1210  /* Extract register address from command */
1211  uint32_t address = ((cmd & SWD_CMD_A32) >> 1);
1212  /* Extract bank address from cached SELECT value */
1213  uint32_t bank = (xds110.select & 0x000000f0);
1214 
1215  bool success;
1216 
1217  if (is_read_request)
1218  return false;
1219 
1220  /* Invalidate the RDBUFF cache */
1221  xds110.use_rdbuff = false;
1222 
1223  if (type == DAP_AP) {
1224  /* Add bank address to register address for CMAPI call */
1225  address |= bank;
1226  /* Any write to an AP register invalidates the firmware's cache */
1227  xds110.is_ap_dirty = true;
1228  } else if (address == DAP_DP_SELECT) {
1229  /* Any write to the SELECT register invalidates the firmware's cache */
1230  xds110.is_ap_dirty = true;
1231  }
1232 
1233  success = cmapi_write_dap_reg(type, ap_num, address, &value);
1234 
1235  if (!success) {
1236  LOG_ERROR("XDS110: failed to write DAP register");
1237  } else {
1238  /*
1239  * If the debugger wrote to SELECT, cache the value
1240  * to use to build the apNum and address values above
1241  */
1242  if ((type == DAP_DP) && (address == DAP_DP_SELECT))
1243  xds110.select = value;
1244  }
1245 
1246  return success;
1247 }
1248 
1249 static int xds110_swd_run_queue(void)
1250 {
1251  static uint32_t dap_results[MAX_RESULT_QUEUE];
1252  uint8_t cmd;
1253  uint32_t request;
1254  uint32_t result;
1255  uint32_t value;
1256  bool success = true;
1257 
1258  if (xds110.txn_request_size == 0)
1259  return ERROR_OK;
1260 
1261  /* Terminate request queue */
1263 
1265  /* XDS110 firmware has the API to directly handle the queue */
1268  } else {
1269  /* Legacy firmware needs to handle queue via discrete DAP calls */
1270  request = 0;
1271  result = 0;
1272  while (xds110.txn_requests[request] != 0) {
1273  cmd = xds110.txn_requests[request++];
1274  if (0 == (SWD_CMD_RNW & cmd)) {
1275  /* DAP register write command */
1276  value = (uint32_t)(xds110.txn_requests[request++]) << 0;
1277  value |= (uint32_t)(xds110.txn_requests[request++]) << 8;
1278  value |= (uint32_t)(xds110.txn_requests[request++]) << 16;
1279  value |= (uint32_t)(xds110.txn_requests[request++]) << 24;
1280  if (success)
1281  success = xds110_legacy_write_reg(cmd, value);
1282  } else {
1283  /* DAP register read command */
1284  value = 0;
1285  if (success)
1286  success = xds110_legacy_read_reg(cmd, &value);
1287  dap_results[result++] = value;
1288  }
1289  }
1290  }
1291 
1292  /* Transfer results into caller's buffers */
1293  for (result = 0; result < xds110.txn_result_count; result++)
1294  if (xds110.txn_dap_results[result])
1295  *xds110.txn_dap_results[result] = dap_results[result];
1296 
1298  xds110.txn_result_size = 0;
1300 
1301  return (success) ? ERROR_OK : ERROR_FAIL;
1302 }
1303 
1304 static void xds110_swd_queue_cmd(uint8_t cmd, uint32_t *value)
1305 {
1306  /* Check if this is a read or write request */
1307  bool is_read_request = (0 != (SWD_CMD_RNW & cmd));
1308  /* Determine whether this is a DP or AP register access */
1309  uint32_t type = (0 != (SWD_CMD_APNDP & cmd)) ? DAP_AP : DAP_DP;
1310  /* Extract register address from command */
1311  uint32_t address = ((cmd & SWD_CMD_A32) >> 1);
1312  uint32_t request_size = (is_read_request) ? 1 : 5;
1313 
1314  /* Check if new request would be too large to fit */
1315  if (((xds110.txn_request_size + request_size + 1) > MAX_DATA_BLOCK) ||
1318 
1319  /* Set the START bit in cmd to ensure cmd is not zero */
1320  /* (a value of zero is used to terminate the buffer) */
1321  cmd |= SWD_CMD_START;
1322 
1323  /* Add request to queue; queue is built marshalled for XDS110 call */
1324  if (is_read_request) {
1325  /* Queue read request, save pointer to pass back result */
1328  xds110.txn_result_size += 4;
1329  } else {
1330  /* Check for and prevent sticky overrun detection */
1331  if (DAP_DP == type && DAP_DP_CTRL == address &&
1332  (*value & CORUNDETECT)) {
1333  LOG_DEBUG("XDS110: refusing to enable sticky overrun detection");
1334  *value &= ~CORUNDETECT;
1335  }
1336  /* Queue write request, add value directly to queue buffer */
1338  xds110.txn_requests[xds110.txn_request_size++] = (*value >> 0) & 0xff;
1339  xds110.txn_requests[xds110.txn_request_size++] = (*value >> 8) & 0xff;
1340  xds110.txn_requests[xds110.txn_request_size++] = (*value >> 16) & 0xff;
1341  xds110.txn_requests[xds110.txn_request_size++] = (*value >> 24) & 0xff;
1342  }
1343 }
1344 
1345 static void xds110_swd_read_reg(uint8_t cmd, uint32_t *value,
1346  uint32_t ap_delay_clk)
1347 {
1348  assert(cmd & SWD_CMD_RNW);
1349  xds110_swd_queue_cmd(cmd, value);
1350 }
1351 static void xds110_swd_write_reg(uint8_t cmd, uint32_t value,
1352  uint32_t ap_delay_clk)
1353 {
1354  assert(!(cmd & SWD_CMD_RNW));
1355  xds110_swd_queue_cmd(cmd, &value);
1356 }
1357 
1358 /***************************************************************************
1359  * jtag interface *
1360  * *
1361  * The following functions provide XDS110 interface to OpenOCD. *
1362  ***************************************************************************/
1363 
1364 static void xds110_show_info(void)
1365 {
1366  uint32_t firmware = xds110.firmware;
1367 
1368  LOG_INFO("XDS110: vid/pid = %04x/%04x", xds110.vid, xds110.pid);
1369  LOG_INFO("XDS110: firmware version = %" PRIu32 ".%" PRIu32 ".%" PRIu32 ".%" PRIu32,
1370  (((firmware >> 28) & 0xf) * 10) + ((firmware >> 24) & 0xf),
1371  (((firmware >> 20) & 0xf) * 10) + ((firmware >> 16) & 0xf),
1372  (((firmware >> 12) & 0xf) * 10) + ((firmware >> 8) & 0xf),
1373  (((firmware >> 4) & 0xf) * 10) + ((firmware >> 0) & 0xf));
1374  LOG_INFO("XDS110: hardware version = 0x%04x", xds110.hardware);
1376  LOG_INFO("XDS110: serial number = %s", adapter_get_required_serial());
1377  if (xds110.is_swd_mode) {
1378  LOG_INFO("XDS110: connected to target via SWD");
1379  LOG_INFO("XDS110: SWCLK set to %" PRIu32 " kHz", xds110.speed);
1380  } else {
1381  LOG_INFO("XDS110: connected to target via JTAG");
1382  LOG_INFO("XDS110: TCK set to %" PRIu32 " kHz", xds110.speed);
1383  }
1384 
1385  /* Alert user that there's a better firmware to use */
1386  if (firmware < OCD_FIRMWARE_VERSION) {
1387  LOG_WARNING("XDS110: the firmware is not optimized for OpenOCD");
1389  }
1390 }
1391 
1392 static int xds110_quit(void)
1393 {
1394  if (xds110.is_cmapi_acquired) {
1395  (void)cmapi_release();
1396  xds110.is_cmapi_acquired = false;
1397  }
1398  if (xds110.is_cmapi_connected) {
1399  (void)cmapi_disconnect();
1400  xds110.is_cmapi_connected = false;
1401  }
1402  if (xds110.is_connected) {
1403  if (xds110.is_swd_mode) {
1404  /* Switch out of SWD mode */
1405  (void)swd_disconnect();
1406  } else {
1407  /* Switch out of cJTAG mode */
1408  (void)cjtag_disconnect();
1409  }
1410  /* Tell firmware we're disconnecting */
1411  (void)xds_disconnect();
1412  xds110.is_connected = false;
1413  }
1414  /* Close down the USB connection to the XDS110 debug probe */
1415  usb_disconnect();
1416 
1417  return ERROR_OK;
1418 }
1419 
1420 static int xds110_init(void)
1421 {
1422  bool success;
1423 
1424  /* Establish USB connection to the XDS110 debug probe */
1425  success = usb_connect();
1426 
1427  if (success) {
1428  /* Send connect message to XDS110 firmware */
1429  success = xds_connect();
1430  if (success)
1431  xds110.is_connected = true;
1432  }
1433 
1434  if (success) {
1435  uint32_t firmware;
1436  uint16_t hardware;
1437 
1438  /* Retrieve version IDs from firmware */
1439  /* Version numbers are stored in BCD format */
1440  success = xds_version(&firmware, &hardware);
1441  if (success) {
1442  /* Save the firmware and hardware version */
1443  xds110.firmware = firmware;
1444  xds110.hardware = hardware;
1445  }
1446  }
1447 
1448  if (success) {
1449  /* Set supply voltage for stand-alone probes */
1451  success = xds_set_supply(xds110.voltage);
1452  /* Allow time for target device to power up */
1453  /* (CC32xx takes up to 1300 ms before debug is enabled) */
1454  alive_sleep(1500);
1455  } else if (xds110.voltage != 0) {
1456  /* Voltage supply not a feature of embedded probes */
1457  LOG_WARNING(
1458  "XDS110: ignoring supply voltage, not supported on this probe");
1459  }
1460  }
1461 
1462  if (success) {
1463  success = xds_set_trst(0);
1464  if (success)
1465  success = xds_cycle_tck(50);
1466  if (success)
1467  success = xds_set_trst(1);
1468  if (success)
1469  success = xds_cycle_tck(50);
1470  }
1471 
1472  if (success) {
1473  if (xds110.is_swd_mode) {
1474  /* Switch to SWD if needed */
1475  success = swd_connect();
1476  } else {
1477  success = cjtag_connect(MODE_JTAG);
1478  }
1479  }
1480 
1481  if (success && xds110.is_swd_mode) {
1482  uint32_t idcode;
1483 
1484  /* Connect to CMAPI interface in XDS110 */
1485  success = cmapi_connect(&idcode);
1486 
1487  /* Acquire exclusive access to CMAPI interface */
1488  if (success) {
1489  xds110.is_cmapi_connected = true;
1490  success = cmapi_acquire();
1491  if (success)
1492  xds110.is_cmapi_acquired = true;
1493  }
1494  }
1495 
1496  if (!success)
1497  xds110_quit();
1498 
1499  if (success)
1500  xds110_show_info();
1501 
1502  return (success) ? ERROR_OK : ERROR_FAIL;
1503 }
1504 
1505 static void xds110_legacy_scan(uint32_t shift_state, uint32_t total_bits,
1506  uint32_t end_state, uint8_t *data_out, uint8_t *data_in)
1507 {
1508  (void)xds_jtag_scan(shift_state, total_bits, end_state, data_out, data_in);
1509 }
1510 
1511 static void xds110_legacy_runtest(uint32_t clocks, uint32_t end_state)
1512 {
1514  xds_cycle_tck(clocks);
1515  xds_goto_state(end_state);
1516 }
1517 
1518 static void xds110_legacy_stableclocks(uint32_t clocks)
1519 {
1520  xds_cycle_tck(clocks);
1521 }
1522 
1523 static void xds110_flush(void)
1524 {
1525  uint8_t command;
1526  uint32_t clocks;
1527  uint32_t shift_state;
1528  uint32_t end_state;
1529  uint32_t bits;
1530  uint32_t bytes;
1531  uint32_t request;
1532  uint32_t result;
1533  uint8_t *data_out;
1534  uint8_t data_in[MAX_DATA_BLOCK];
1535  uint8_t *data_pntr;
1536 
1537  if (xds110.txn_request_size == 0)
1538  return;
1539 
1540  /* Terminate request queue */
1542 
1544  /* Updated firmware has the API to directly handle the queue */
1546  data_in, xds110.txn_result_size);
1547  } else {
1548  /* Legacy firmware needs to handle queue via discrete JTAG calls */
1549  request = 0;
1550  result = 0;
1551  while (xds110.txn_requests[request] != 0) {
1552  command = xds110.txn_requests[request++];
1553  switch (command) {
1554  case CMD_IR_SCAN:
1555  case CMD_DR_SCAN:
1556  if (command == CMD_IR_SCAN)
1557  shift_state = XDS_JTAG_STATE_SHIFT_IR;
1558  else
1559  shift_state = XDS_JTAG_STATE_SHIFT_DR;
1560  end_state = (uint32_t)(xds110.txn_requests[request++]);
1561  bits = (uint32_t)(xds110.txn_requests[request++]) << 0;
1562  bits |= (uint32_t)(xds110.txn_requests[request++]) << 8;
1563  data_out = &xds110.txn_requests[request];
1564  bytes = DIV_ROUND_UP(bits, 8);
1565  xds110_legacy_scan(shift_state, bits, end_state, data_out,
1566  &data_in[result]);
1567  result += bytes;
1568  request += bytes;
1569  break;
1570  case CMD_RUNTEST:
1571  clocks = (uint32_t)(xds110.txn_requests[request++]) << 0;
1572  clocks |= (uint32_t)(xds110.txn_requests[request++]) << 8;
1573  clocks |= (uint32_t)(xds110.txn_requests[request++]) << 16;
1574  clocks |= (uint32_t)(xds110.txn_requests[request++]) << 24;
1575  end_state = (uint32_t)xds110.txn_requests[request++];
1576  xds110_legacy_runtest(clocks, end_state);
1577  break;
1578  case CMD_STABLECLOCKS:
1579  clocks = (uint32_t)(xds110.txn_requests[request++]) << 0;
1580  clocks |= (uint32_t)(xds110.txn_requests[request++]) << 8;
1581  clocks |= (uint32_t)(xds110.txn_requests[request++]) << 16;
1582  clocks |= (uint32_t)(xds110.txn_requests[request++]) << 24;
1584  break;
1585  default:
1586  LOG_ERROR("BUG: unknown JTAG command type 0x%x encountered",
1587  command);
1588  exit(-1);
1589  break;
1590  }
1591  }
1592  }
1593 
1594  /* Transfer results into caller's buffers from data_in buffer */
1595  bits = 0; /* Bit offset into current scan result */
1596  data_pntr = data_in;
1597  for (result = 0; result < xds110.txn_result_count; result++) {
1598  if (xds110.txn_scan_results[result].first) {
1599  if (bits != 0) {
1600  bytes = DIV_ROUND_UP(bits, 8);
1601  data_pntr += bytes;
1602  }
1603  bits = 0;
1604  }
1605  if (xds110.txn_scan_results[result].buffer)
1606  bit_copy(xds110.txn_scan_results[result].buffer, 0, data_pntr,
1608  bits += xds110.txn_scan_results[result].num_bits;
1609  }
1610 
1612  xds110.txn_result_size = 0;
1614 }
1615 
1616 static int xds110_reset(int trst, int srst)
1617 {
1618  uint8_t value;
1619  bool success;
1620  int retval = ERROR_OK;
1621 
1622  if (trst != -1) {
1623  if (trst == 0) {
1624  /* Deassert nTRST (active low) */
1625  value = 1;
1626  } else {
1627  /* Assert nTRST (active low) */
1628  value = 0;
1629  }
1630  success = xds_set_trst(value);
1631  if (!success)
1632  retval = ERROR_FAIL;
1633  }
1634 
1635  if (srst != -1) {
1636  if (srst == 0) {
1637  /* Deassert nSRST (active low) */
1638  value = 1;
1639  } else {
1640  /* Assert nSRST (active low) */
1641  value = 0;
1642  }
1643  success = xds_set_srst(value);
1644  if (!success)
1645  retval = ERROR_FAIL;
1646 
1647  /* Toggle TCK to trigger HIB on CC13x/CC26x devices */
1648  if (success && !xds110.is_swd_mode) {
1649  /* Toggle TCK for about 50 ms */
1650  success = xds_cycle_tck(xds110.speed * 50);
1651  }
1652 
1653  if (!success)
1654  retval = ERROR_FAIL;
1655  }
1656 
1657  return retval;
1658 }
1659 
1661 {
1662  jtag_sleep(cmd->cmd.sleep->us);
1663 }
1664 
1666 {
1668 }
1669 
1671 {
1672  uint32_t i;
1673  uint32_t num_states;
1674  uint8_t *path;
1675 
1676  num_states = (uint32_t)cmd->cmd.pathmove->num_states;
1677 
1678  if (num_states == 0)
1679  return;
1680 
1681  path = malloc(num_states * sizeof(uint8_t));
1682  if (!path) {
1683  LOG_ERROR("XDS110: unable to allocate memory");
1684  return;
1685  }
1686 
1687  /* Convert requested path states into XDS API states */
1688  for (i = 0; i < num_states; i++)
1689  path[i] = (uint8_t)xds_jtag_state[cmd->cmd.pathmove->path[i]];
1690 
1692  /* Updated firmware fully supports pathmove */
1693  (void)ocd_pathmove(num_states, path);
1694  } else {
1695  /* Notify user that legacy firmware simply cannot handle pathmove */
1696  LOG_ERROR("XDS110: the firmware does not support pathmove command");
1698  /* If pathmove is required, then debug is not possible */
1699  exit(-1);
1700  }
1701 
1702  free((void *)path);
1703 }
1704 
1705 static void xds110_queue_scan(struct jtag_command *cmd)
1706 {
1707  int i;
1708  uint32_t offset;
1709  uint32_t total_fields;
1710  uint32_t total_bits;
1711  uint32_t total_bytes;
1712  uint8_t end_state;
1713  uint8_t *buffer;
1714 
1715  /* Calculate the total number of bits to scan */
1716  total_bits = 0;
1717  total_fields = 0;
1718  for (i = 0; i < cmd->cmd.scan->num_fields; i++) {
1719  total_fields++;
1720  total_bits += (uint32_t)cmd->cmd.scan->fields[i].num_bits;
1721  }
1722 
1723  if (total_bits == 0)
1724  return;
1725 
1726  total_bytes = DIV_ROUND_UP(total_bits, 8);
1727 
1728  /* Check if new request would be too large to fit */
1729  if (((xds110.txn_request_size + 1 + total_bytes + sizeof(end_state) + 1)
1730  > MAX_DATA_BLOCK) || ((xds110.txn_result_count + total_fields) >
1732  xds110_flush();
1733 
1734  /* Check if this single request is too large to fit */
1735  if ((1 + total_bytes + sizeof(end_state) + 1) > MAX_DATA_BLOCK) {
1736  LOG_ERROR("BUG: JTAG scan request is too large to handle (%" PRIu32 " bits)",
1737  total_bits);
1738  /* Failing to run this scan mucks up debug on this target */
1739  exit(-1);
1740  }
1741 
1742  if (cmd->cmd.scan->ir_scan)
1744  else
1746 
1747  end_state = (uint8_t)xds_jtag_state[cmd->cmd.scan->end_state];
1748  xds110.txn_requests[xds110.txn_request_size++] = end_state;
1749 
1750  xds110.txn_requests[xds110.txn_request_size++] = (total_bits >> 0) & 0xff;
1751  xds110.txn_requests[xds110.txn_request_size++] = (total_bits >> 8) & 0xff;
1752 
1753  /* Build request data by flattening fields into single buffer */
1754  /* also populate the results array to return the results when run */
1755  offset = 0;
1757  /* Clear data out buffer to default value of all zeros */
1758  memset((void *)buffer, 0x00, total_bytes);
1759  for (i = 0; i < cmd->cmd.scan->num_fields; i++) {
1760  if (cmd->cmd.scan->fields[i].out_value) {
1761  /* Copy over data to scan out into request buffer */
1762  bit_copy(buffer, offset, cmd->cmd.scan->fields[i].out_value, 0,
1763  cmd->cmd.scan->fields[i].num_bits);
1764  }
1765  offset += cmd->cmd.scan->fields[i].num_bits;
1768  cmd->cmd.scan->fields[i].num_bits;
1770  cmd->cmd.scan->fields[i].in_value;
1771  }
1772  xds110.txn_request_size += total_bytes;
1773  xds110.txn_result_size += total_bytes;
1774 }
1775 
1777 {
1778  uint32_t clocks = (uint32_t)cmd->cmd.stableclocks->num_cycles;
1779  uint8_t end_state = (uint8_t)xds_jtag_state[cmd->cmd.runtest->end_state];
1780 
1781  /* Check if new request would be too large to fit */
1782  if ((xds110.txn_request_size + 1 + sizeof(clocks) + sizeof(end_state) + 1)
1783  > MAX_DATA_BLOCK)
1784  xds110_flush();
1785 
1786  /* Queue request and cycle count directly to queue buffer */
1788  xds110.txn_requests[xds110.txn_request_size++] = (clocks >> 0) & 0xff;
1789  xds110.txn_requests[xds110.txn_request_size++] = (clocks >> 8) & 0xff;
1790  xds110.txn_requests[xds110.txn_request_size++] = (clocks >> 16) & 0xff;
1791  xds110.txn_requests[xds110.txn_request_size++] = (clocks >> 24) & 0xff;
1792  xds110.txn_requests[xds110.txn_request_size++] = end_state;
1793 }
1794 
1796 {
1797  uint32_t clocks = (uint32_t)cmd->cmd.stableclocks->num_cycles;
1798 
1799  /* Check if new request would be too large to fit */
1800  if ((xds110.txn_request_size + 1 + sizeof(clocks) + 1) > MAX_DATA_BLOCK)
1801  xds110_flush();
1802 
1803  /* Queue request and cycle count directly to queue buffer */
1805  xds110.txn_requests[xds110.txn_request_size++] = (clocks >> 0) & 0xff;
1806  xds110.txn_requests[xds110.txn_request_size++] = (clocks >> 8) & 0xff;
1807  xds110.txn_requests[xds110.txn_request_size++] = (clocks >> 16) & 0xff;
1808  xds110.txn_requests[xds110.txn_request_size++] = (clocks >> 24) & 0xff;
1809 }
1810 
1812 {
1813  switch (cmd->type) {
1814  case JTAG_SLEEP:
1815  xds110_flush();
1817  break;
1818  case JTAG_TLR_RESET:
1819  xds110_flush();
1821  break;
1822  case JTAG_PATHMOVE:
1823  xds110_flush();
1825  break;
1826  case JTAG_SCAN:
1828  break;
1829  case JTAG_RUNTEST:
1831  break;
1832  case JTAG_STABLECLOCKS:
1834  break;
1835  case JTAG_TMS:
1836  default:
1837  LOG_ERROR("BUG: unknown JTAG command type 0x%x encountered",
1838  cmd->type);
1839  exit(-1);
1840  }
1841 }
1842 
1843 static int xds110_execute_queue(struct jtag_command *cmd_queue)
1844 {
1845  struct jtag_command *cmd = cmd_queue;
1846 
1847  while (cmd) {
1849  cmd = cmd->next;
1850  }
1851 
1852  xds110_flush();
1853 
1854  return ERROR_OK;
1855 }
1856 
1857 static int xds110_speed(int speed)
1858 {
1859  double freq_to_use;
1860  uint32_t delay_count;
1861  bool success;
1862 
1863  if (speed == 0) {
1864  LOG_INFO("XDS110: RTCK not supported");
1866  }
1867 
1868  if (speed < XDS110_MIN_TCK_SPEED) {
1869  LOG_INFO("XDS110: increase speed request: %d kHz to %d kHz minimum",
1870  speed, XDS110_MIN_TCK_SPEED);
1871  speed = XDS110_MIN_TCK_SPEED;
1872  }
1873 
1874  /* Older XDS110 firmware had inefficient scan routines and could only */
1875  /* achieve a peak TCK frequency of about 2500 kHz */
1877 
1878  /* Check for request for top speed or higher */
1879  if (speed >= XDS110_MAX_SLOW_TCK_SPEED) {
1880 
1881  /* Inform user that speed was adjusted down to max possible */
1882  if (speed > XDS110_MAX_SLOW_TCK_SPEED) {
1883  LOG_INFO(
1884  "XDS110: reduce speed request: %d kHz to %d kHz maximum",
1885  speed, XDS110_MAX_SLOW_TCK_SPEED);
1886  speed = XDS110_MAX_SLOW_TCK_SPEED;
1887  }
1888  delay_count = 0;
1889 
1890  } else {
1891 
1892  const double XDS110_TCK_PULSE_INCREMENT = 66.0;
1893  freq_to_use = speed * 1000; /* Hz */
1894  delay_count = 0;
1895 
1896  /* Calculate the delay count value */
1897  double one_giga = 1000000000;
1898  /* Get the pulse duration for the max frequency supported in ns */
1899  double max_freq_pulse_duration = one_giga /
1900  (XDS110_MAX_SLOW_TCK_SPEED * 1000);
1901 
1902  /* Convert frequency to pulse duration */
1903  double freq_to_pulse_width_in_ns = one_giga / freq_to_use;
1904 
1905  /*
1906  * Start with the pulse duration for the maximum frequency. Keep
1907  * decrementing time added by each count value till the requested
1908  * frequency pulse is less than the calculated value.
1909  */
1910  double current_value = max_freq_pulse_duration;
1911 
1912  while (current_value < freq_to_pulse_width_in_ns) {
1913  current_value += XDS110_TCK_PULSE_INCREMENT;
1914  ++delay_count;
1915  }
1916 
1917  /*
1918  * Determine which delay count yields the best match.
1919  * The one obtained above or one less.
1920  */
1921  if (delay_count) {
1922  double diff_freq_1 = freq_to_use -
1923  (one_giga / (max_freq_pulse_duration +
1924  (XDS110_TCK_PULSE_INCREMENT * delay_count)));
1925  double diff_freq_2 = (one_giga / (max_freq_pulse_duration +
1926  (XDS110_TCK_PULSE_INCREMENT * (delay_count - 1)))) -
1927  freq_to_use;
1928 
1929  /* One less count value yields a better match */
1930  if (diff_freq_1 > diff_freq_2)
1931  --delay_count;
1932  }
1933  }
1934 
1935  /* Newer firmware has reworked TCK routines that are much more efficient */
1936  /* and can now achieve a peak TCK frequency of 14000 kHz */
1937  } else {
1938 
1939  if (speed >= XDS110_MAX_FAST_TCK_SPEED) {
1940  if (speed > XDS110_MAX_FAST_TCK_SPEED) {
1941  LOG_INFO(
1942  "XDS110: reduce speed request: %d kHz to %d kHz maximum",
1943  speed, XDS110_MAX_FAST_TCK_SPEED);
1944  speed = XDS110_MAX_FAST_TCK_SPEED;
1945  }
1946  delay_count = 0;
1947  } else if (speed >= 12000 && xds110.firmware >=
1949  delay_count = FAST_TCK_DELAY_12000_KHZ;
1950  } else if (speed >= 10000 && xds110.firmware >=
1952  delay_count = FAST_TCK_DELAY_10000_KHZ;
1953  } else if (speed >= 8500) {
1954  delay_count = FAST_TCK_DELAY_8500_KHZ;
1955  } else if (speed >= 5500) {
1956  delay_count = FAST_TCK_DELAY_5500_KHZ;
1957  } else {
1958  /* Calculate the delay count to set the frequency */
1959  /* Formula determined by measuring the waveform on Saeleae logic */
1960  /* analyzer using known values for delay count */
1961  const double m = 17100000.0; /* slope */
1962  const double b = -1.02; /* y-intercept */
1963 
1964  freq_to_use = speed * 1000; /* Hz */
1965  double period = 1.0/freq_to_use;
1966  double delay = m * period + b;
1967 
1968  if (delay < 1.0)
1969  delay_count = 1;
1970  else
1971  delay_count = (uint32_t)delay;
1972  }
1973  }
1974 
1975  /* Send the delay count to the XDS110 firmware */
1976  success = xds_set_tck_delay(delay_count);
1977 
1978  if (success) {
1979  xds110.delay_count = delay_count;
1980  xds110.speed = speed;
1981  }
1982 
1983  return (success) ? ERROR_OK : ERROR_FAIL;
1984 }
1985 
1986 static int xds110_speed_div(int speed, int *khz)
1987 {
1988  *khz = speed;
1989  return ERROR_OK;
1990 }
1991 
1992 static int xds110_khz(int khz, int *jtag_speed)
1993 {
1994  *jtag_speed = khz;
1995  return ERROR_OK;
1996 }
1997 
1998 COMMAND_HANDLER(xds110_handle_info_command)
1999 {
2000  xds110_show_info();
2001  return ERROR_OK;
2002 }
2003 
2004 COMMAND_HANDLER(xds110_handle_supply_voltage_command)
2005 {
2006  uint32_t voltage = 0;
2007 
2008  if (CMD_ARGC == 1) {
2009  COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], voltage);
2010  if (voltage == 0 || (voltage >= XDS110_MIN_VOLTAGE && voltage
2011  <= XDS110_MAX_VOLTAGE)) {
2012  /* Requested voltage is in range */
2013  xds110.voltage = voltage;
2014  } else {
2015  LOG_ERROR("XDS110: voltage must be 0 or between %d and %d "
2016  "millivolts", XDS110_MIN_VOLTAGE, XDS110_MAX_VOLTAGE);
2017  return ERROR_FAIL;
2018  }
2019  xds110.voltage = voltage;
2020  } else
2022 
2023  return ERROR_OK;
2024 }
2025 
2026 static const struct command_registration xds110_subcommand_handlers[] = {
2027  {
2028  .name = "info",
2029  .handler = &xds110_handle_info_command,
2030  .mode = COMMAND_EXEC,
2031  .help = "show XDS110 info",
2032  .usage = "",
2033  },
2034  {
2035  .name = "supply",
2036  .handler = &xds110_handle_supply_voltage_command,
2037  .mode = COMMAND_CONFIG,
2038  .help = "set the XDS110 probe supply voltage",
2039  .usage = "voltage_in_millivolts",
2040  },
2042 };
2043 
2044 static const struct command_registration xds110_command_handlers[] = {
2045  {
2046  .name = "xds110",
2047  .mode = COMMAND_ANY,
2048  .help = "perform XDS110 management",
2049  .usage = "",
2050  .chain = xds110_subcommand_handlers,
2051  },
2053 };
2054 
2055 static const struct swd_driver xds110_swd_driver = {
2056  .init = xds110_swd_init,
2057  .switch_seq = xds110_swd_switch_seq,
2058  .read_reg = xds110_swd_read_reg,
2059  .write_reg = xds110_swd_write_reg,
2060  .run = xds110_swd_run_queue,
2061 };
2062 
2063 static const char * const xds110_transport[] = { "swd", "jtag", NULL };
2064 
2065 static struct jtag_interface xds110_interface = {
2067 };
2068 
2070  .name = "xds110",
2071  .transports = xds110_transport,
2072  .commands = xds110_command_handlers,
2073 
2074  .init = xds110_init,
2075  .quit = xds110_quit,
2076  .reset = xds110_reset,
2077  .speed = xds110_speed,
2078  .khz = xds110_khz,
2079  .speed_div = xds110_speed_div,
2080 
2081  .jtag_ops = &xds110_interface,
2082  .swd_ops = &xds110_swd_driver,
2083 };
const char * adapter_get_required_serial(void)
Retrieves the serial number set with command 'adapter serial'.
Definition: adapter.c:298
#define CORUNDETECT
Definition: arm_adi_v5.h:82
swd_special_seq
Definition: arm_adi_v5.h:236
@ JTAG_TO_SWD
Definition: arm_adi_v5.h:238
@ LINE_RESET
Definition: arm_adi_v5.h:237
@ SWD_TO_JTAG
Definition: arm_adi_v5.h:240
static const struct device_t * device
Definition: at91rm9200.c:94
static void bit_copy(uint8_t *dst, unsigned dst_offset, const uint8_t *src, unsigned src_offset, unsigned bit_count)
Definition: binarybuffer.h:202
#define CMD_ARGV
Use this macro to access the arguments for the command being handled, rather than accessing the varia...
Definition: command.h:156
#define ERROR_COMMAND_SYNTAX_ERROR
Definition: command.h:402
#define CMD_ARGC
Use this macro to access the number of arguments for the command being handled, rather than accessing...
Definition: command.h:151
#define COMMAND_PARSE_NUMBER(type, in, out)
parses the string in into out as a type, or prints a command error and passes the error code to the c...
Definition: command.h:442
#define COMMAND_REGISTRATION_DONE
Use this as the last entry in an array of command_registration records.
Definition: command.h:253
@ COMMAND_CONFIG
Definition: command.h:41
@ COMMAND_ANY
Definition: command.h:42
@ COMMAND_EXEC
Definition: command.h:40
@ JTAG_TLR_RESET
Definition: commands.h:137
@ JTAG_SCAN
Definition: commands.h:129
@ JTAG_PATHMOVE
Definition: commands.h:140
@ JTAG_STABLECLOCKS
Definition: commands.h:142
@ JTAG_RUNTEST
Definition: commands.h:138
@ JTAG_SLEEP
Definition: commands.h:141
@ JTAG_TMS
Definition: commands.h:143
uint8_t bank
Definition: esirisc.c:135
uint8_t type
Definition: esp_usb_jtag.c:0
void jtag_sleep(uint32_t us)
Definition: jtag/core.c:1062
#define ERROR_JTAG_NOT_IMPLEMENTED
Definition: jtag.h:555
void alive_sleep(uint64_t ms)
Definition: log.c:456
#define LOG_WARNING(expr ...)
Definition: log.h:129
#define ERROR_FAIL
Definition: log.h:170
#define LOG_ERROR(expr ...)
Definition: log.h:132
#define LOG_INFO(expr ...)
Definition: log.h:126
#define LOG_DEBUG(expr ...)
Definition: log.h:109
#define ERROR_OK
Definition: log.h:164
uint8_t bits[QN908X_FLASH_MAX_BLOCKS *QN908X_FLASH_PAGES_PER_BLOCK/8]
Definition: qn908x.c:0
size_t size
Size of the control block search area.
Definition: rtt/rtt.c:30
Represents a driver for a debugging interface.
Definition: interface.h:207
const char *const name
The name of the interface driver.
Definition: interface.h:209
const char * name
Definition: command.h:235
Represents a driver for a debugging interface.
Definition: interface.h:182
int(* execute_queue)(struct jtag_command *cmd_queue)
Execute commands in the supplied queue.
Definition: interface.h:195
uint8_t * buffer
Definition: xds110.c:197
uint32_t num_bits
Definition: xds110.c:198
bool first
Definition: xds110.c:196
int(* init)(void)
Initialize the debug link so it can perform SWD operations.
Definition: swd.h:255
Definition: psoc6.c:84
uint32_t firmware
Definition: xds110.c:231
bool is_cmapi_connected
Definition: xds110.c:217
bool is_connected
Definition: xds110.c:216
uint32_t speed
Definition: xds110.c:226
unsigned char txn_requests[MAX_DATA_BLOCK]
Definition: xds110.c:234
bool is_ap_dirty
Definition: xds110.c:220
uint32_t txn_result_count
Definition: xds110.c:239
unsigned char read_payload[USB_PAYLOAD_SIZE]
Definition: xds110.c:205
uint32_t txn_result_size
Definition: xds110.c:238
uint32_t select
Definition: xds110.c:222
bool is_cmapi_acquired
Definition: xds110.c:218
uint32_t txn_request_size
Definition: xds110.c:237
unsigned char write_payload[USB_PAYLOAD_SIZE]
Definition: xds110.c:207
struct libusb_device_handle * dev
Definition: xds110.c:204
struct libusb_context * ctx
Definition: xds110.c:203
struct scan_result txn_scan_results[MAX_DATA_BLOCK/4]
Definition: xds110.c:236
bool use_rdbuff
Definition: xds110.c:224
unsigned char write_packet[3]
Definition: xds110.c:206
bool is_swd_mode
Definition: xds110.c:219
uint8_t interface
Definition: xds110.c:212
uint16_t pid
Definition: xds110.c:210
uint16_t vid
Definition: xds110.c:209
uint32_t rdbuff
Definition: xds110.c:223
uint32_t delay_count
Definition: xds110.c:227
uint32_t * txn_dap_results[MAX_DATA_BLOCK/4]
Definition: xds110.c:235
uint16_t hardware
Definition: xds110.c:232
uint8_t endpoint_in
Definition: xds110.c:213
uint32_t voltage
Definition: xds110.c:229
uint8_t endpoint_out
Definition: xds110.c:214
#define SWD_CMD_A32
Definition: swd.h:19
#define SWD_CMD_APNDP
Definition: swd.h:17
#define SWD_CMD_START
Definition: swd.h:16
#define SWD_CMD_RNW
Definition: swd.h:18
#define true
Definition: system.h:66
#define ARRAY_SIZE(x)
Compute the number of elements of a variable length array.
Definition: types.h:57
#define DIV_ROUND_UP(m, n)
Rounds m up to the nearest multiple of n using division.
Definition: types.h:79
#define NULL
Definition: usb.h:16
uint8_t cmd
Definition: vdebug.c:1
uint8_t offset[4]
Definition: vdebug.c:9
uint8_t state[4]
Definition: vdebug.c:21
uint8_t count[4]
Definition: vdebug.c:22
static bool xds_set_srst(uint8_t srst)
Definition: xds110.c:813
#define XDS_JTAG_STATE_UPDATE_IR
Definition: xds110.c:107
#define OCD_FIRMWARE_UPGRADE
Definition: xds110.c:28
#define XDS_OUT_LEN
Definition: xds110.c:142
#define XDS_GOTO_STATE
Definition: xds110.c:152
#define XDS_JTAG_STATE_IDLE
Definition: xds110.c:95
static void xds110_flush(void)
Definition: xds110.c:1523
#define XDS_JTAG_TRANSIT_QUICKEST
Definition: xds110.c:112
static const struct command_registration xds110_subcommand_handlers[]
Definition: xds110.c:2026
#define OCD_DAP_REQUEST
Definition: xds110.c:166
#define DAP_DP_CTRL
Definition: xds110.c:124
COMMAND_HANDLER(xds110_handle_info_command)
Definition: xds110.c:1998
#define XDS110_MAX_SLOW_TCK_SPEED
Definition: xds110.c:78
#define XDS110_MIN_VOLTAGE
Definition: xds110.c:20
static void xds110_set_u16(uint8_t *buffer, uint16_t value)
Definition: xds110.c:273
static int xds110_quit(void)
Definition: xds110.c:1392
static bool cmapi_disconnect(void)
Definition: xds110.c:848
#define XDS_JTAG_STATE_EXIT1_IR
Definition: xds110.c:101
static bool cmapi_connect(uint32_t *idcode)
Definition: xds110.c:829
static bool usb_send_command(uint16_t size)
Definition: xds110.c:580
#define FAST_TCK_DELAY_10000_KHZ
Definition: xds110.c:84
static int xds110_reset(int trst, int srst)
Definition: xds110.c:1616
static bool cmapi_acquire(void)
Definition: xds110.c:860
static void xds110_execute_sleep(struct jtag_command *cmd)
Definition: xds110.c:1660
static bool xds_connect(void)
Definition: xds110.c:655
#define OCD_PATHMOVE
Definition: xds110.c:168
static void xds110_swd_queue_cmd(uint8_t cmd, uint32_t *value)
Definition: xds110.c:1304
static void xds110_queue_runtest(struct jtag_command *cmd)
Definition: xds110.c:1776
#define XDS110_MIN_TCK_SPEED
Definition: xds110.c:77
#define XDS_JTAG_STATE_SELECT_IR
Definition: xds110.c:105
#define CMAPI_REG_READ
Definition: xds110.c:159
static bool ocd_scan_request(uint8_t *scan_requests, uint32_t request_size, uint8_t *scan_results, uint32_t result_size)
Definition: xds110.c:1032
#define SWD_CONNECT
Definition: xds110.c:161
#define MAX_DATA_BLOCK
Definition: xds110.c:48
static void xds110_execute_command(struct jtag_command *cmd)
Definition: xds110.c:1811
static bool usb_connect(void)
Definition: xds110.c:302
#define FAST_TCK_DELAY_5500_KHZ
Definition: xds110.c:87
#define XDS110_STAND_ALONE_ID
Definition: xds110.c:24
static int xds110_swd_init(void)
Definition: xds110.c:1085
static bool xds_version(uint32_t *firmware_id, uint16_t *hardware_id)
Definition: xds110.c:679
#define XDS_JTAG_STATE_EXIT1_DR
Definition: xds110.c:100
#define XDS110_DEFAULT_TCK_SPEED
Definition: xds110.c:80
#define SC_ERR_NONE
Definition: xds110.c:68
static bool ocd_pathmove(uint32_t num_states, uint8_t *path)
Definition: xds110.c:1057
static const struct command_registration xds110_command_handlers[]
Definition: xds110.c:2044
#define FAST_TCK_DELAY_8500_KHZ
Definition: xds110.c:86
static void xds110_show_info(void)
Definition: xds110.c:1364
#define OCD_FIRMWARE_VERSION
Definition: xds110.c:27
static const uint32_t xds_jtag_state[]
Definition: xds110.c:176
#define XDS_CYCLE_TCK
Definition: xds110.c:151
#define XDS_JTAG_STATE_CAPTURE_IR
Definition: xds110.c:109
#define DAP_DP
Definition: xds110.c:119
static bool xds_execute(uint32_t out_length, uint32_t in_length, uint32_t attempts, uint32_t timeout)
Definition: xds110.c:606
#define XDS_VERSION
Definition: xds110.c:148
static bool swd_disconnect(void)
Definition: xds110.c:949
#define CMAPI_DISCONNECT
Definition: xds110.c:156
#define XDS110_MAX_FAST_TCK_SPEED
Definition: xds110.c:79
static bool swd_connect(void)
Definition: xds110.c:937
static bool xds_jtag_scan(uint32_t shift_state, uint16_t shift_bits, uint32_t end_state, uint8_t *data_out, uint8_t *data_in)
Definition: xds110.c:767
static bool ocd_dap_request(uint8_t *dap_requests, uint32_t request_size, uint32_t *dap_results, uint32_t result_count)
Definition: xds110.c:1007
#define XDS_JTAG_STATE_PAUSE_IR
Definition: xds110.c:99
static void xds110_execute_tlr_reset(struct jtag_command *cmd)
Definition: xds110.c:1665
static int xds110_init(void)
Definition: xds110.c:1420
#define XDS_JTAG_STATE_EXIT2_DR
Definition: xds110.c:102
#define CMD_STABLECLOCKS
Definition: xds110.c:173
static bool usb_get_response(uint32_t *total_bytes_read, uint32_t timeout)
Definition: xds110.c:498
#define MAX_RESULT_QUEUE
Definition: xds110.c:54
#define OCD_SCAN_REQUEST
Definition: xds110.c:167
static struct jtag_interface xds110_interface
Definition: xds110.c:2065
#define XDS_SET_TRST
Definition: xds110.c:150
#define DAP_DP_RDBUFF
Definition: xds110.c:128
#define XDS_JTAG_STATE_CAPTURE_DR
Definition: xds110.c:108
static void usb_disconnect(void)
Definition: xds110.c:438
#define DEFAULT_ATTEMPTS
Definition: xds110.c:64
#define XDS_JTAG_STATE_SELECT_DR
Definition: xds110.c:104
#define FAST_TCK_DELAY_12000_KHZ
Definition: xds110.c:85
#define XDS_JTAG_SCAN
Definition: xds110.c:153
static bool xds110_legacy_read_reg(uint8_t cmd, uint32_t *value)
Definition: xds110.c:1140
struct adapter_driver xds110_adapter_driver
Definition: xds110.c:2069
static void xds110_legacy_scan(uint32_t shift_state, uint32_t total_bits, uint32_t end_state, uint8_t *data_out, uint8_t *data_in)
Definition: xds110.c:1505
static void xds110_legacy_stableclocks(uint32_t clocks)
Definition: xds110.c:1518
#define USB_PAYLOAD_SIZE
Definition: xds110.c:52
static int xds110_speed(int speed)
Definition: xds110.c:1857
static int xds110_execute_queue(struct jtag_command *cmd_queue)
Definition: xds110.c:1843
#define XDS_JTAG_STATE_UPDATE_DR
Definition: xds110.c:106
#define XDS_DISCONNECT
Definition: xds110.c:147
static int xds110_speed_div(int speed, int *khz)
Definition: xds110.c:1986
static struct xds110_info xds110
Definition: xds110.c:242
static bool xds_disconnect(void)
Definition: xds110.c:667
static void xds110_execute_pathmove(struct jtag_command *cmd)
Definition: xds110.c:1670
#define CMD_IR_SCAN
Definition: xds110.c:170
#define XDS_SET_SUPPLY
Definition: xds110.c:165
static const char *const xds110_transport[]
Definition: xds110.c:2063
#define XDS_SET_SRST
Definition: xds110.c:154
#define CMAPI_ACQUIRE
Definition: xds110.c:157
static void xds110_swd_write_reg(uint8_t cmd, uint32_t value, uint32_t ap_delay_clk)
Definition: xds110.c:1351
#define SWD_DISCONNECT
Definition: xds110.c:162
static void xds110_set_u32(uint8_t *buffer, uint32_t value)
Definition: xds110.c:265
static bool xds110_legacy_write_reg(uint8_t cmd, uint32_t value)
Definition: xds110.c:1202
#define XDS_CONNECT
Definition: xds110.c:146
static bool xds_cycle_tck(uint32_t count)
Definition: xds110.c:733
#define DEFAULT_TIMEOUT
Definition: xds110.c:65
static void xds110_queue_stableclocks(struct jtag_command *cmd)
Definition: xds110.c:1795
#define CMD_RUNTEST
Definition: xds110.c:172
#define CJTAG_DISCONNECT
Definition: xds110.c:164
#define XDS_JTAG_STATE_RESET
Definition: xds110.c:94
#define XDS_JTAG_STATE_PAUSE_DR
Definition: xds110.c:98
static int xds110_swd_run_queue(void)
Definition: xds110.c:1249
static uint16_t xds110_get_u16(uint8_t *buffer)
Definition: xds110.c:288
static bool usb_write(unsigned char *buffer, int size, int *written)
Definition: xds110.c:472
static bool cjtag_connect(uint32_t format)
Definition: xds110.c:961
#define XDS_SET_TCK
Definition: xds110.c:149
static uint32_t xds110_get_u32(uint8_t *buffer)
Definition: xds110.c:279
#define MAX_PACKET
Definition: xds110.c:42
static bool usb_read(unsigned char *buffer, int size, int *bytes_read, int timeout)
Definition: xds110.c:454
static void xds110_legacy_runtest(uint32_t clocks, uint32_t end_state)
Definition: xds110.c:1511
#define XDS_JTAG_STATE_SHIFT_IR
Definition: xds110.c:97
static bool xds_set_trst(uint8_t trst)
Definition: xds110.c:717
static void xds110_queue_scan(struct jtag_command *cmd)
Definition: xds110.c:1705
static void xds110_swd_read_reg(uint8_t cmd, uint32_t *value, uint32_t ap_delay_clk)
Definition: xds110.c:1345
static bool cmapi_release(void)
Definition: xds110.c:872
#define DAP_AP
Definition: xds110.c:118
static int xds110_swd_switch_seq(enum swd_special_seq seq)
Definition: xds110.c:1091
static bool cmapi_read_dap_reg(uint32_t type, uint32_t ap_num, uint32_t address, uint32_t *value)
Definition: xds110.c:884
#define CJTAG_CONNECT
Definition: xds110.c:163
static const struct swd_driver xds110_swd_driver
Definition: xds110.c:2055
static bool xds_set_supply(uint32_t voltage)
Definition: xds110.c:989
#define CMAPI_REG_WRITE
Definition: xds110.c:160
#define XDS_IN_LEN
Definition: xds110.c:143
static bool xds_set_tck_delay(uint32_t delay)
Definition: xds110.c:701
#define XDS_JTAG_STATE_SHIFT_DR
Definition: xds110.c:96
#define SC_ERR_XDS110_FAIL
Definition: xds110.c:69
#define FAST_TCK_PLUS_FIRMWARE_VERSION
Definition: xds110.c:35
#define DAP_DP_SELECT
Definition: xds110.c:127
#define MODE_JTAG
Definition: xds110.c:91
static int xds110_khz(int khz, int *jtag_speed)
Definition: xds110.c:1992
#define CMD_DR_SCAN
Definition: xds110.c:171
#define XDS_JTAG_STATE_EXIT2_IR
Definition: xds110.c:103
static bool xds_goto_state(uint32_t state)
Definition: xds110.c:749
#define CMAPI_CONNECT
Definition: xds110.c:155
#define XDS110_MAX_VOLTAGE
Definition: xds110.c:21
static bool cmapi_write_dap_reg(uint32_t type, uint32_t ap_num, uint32_t address, uint32_t *value)
Definition: xds110.c:911
static bool cjtag_disconnect(void)
Definition: xds110.c:977
#define FAST_TCK_FIRMWARE_VERSION
Definition: xds110.c:32
#define CMAPI_RELEASE
Definition: xds110.c:158
#define DAP_AP_DRW
Definition: xds110.c:132