You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

652 lines
23 KiB

  1. /***************************************************************************
  2. * Copyright (C) 2005 by Dominic Rath *
  3. * Dominic.Rath@gmx.de *
  4. * *
  5. * Copyright (C) 2007-2010 Øyvind Harboe *
  6. * oyvind.harboe@zylin.com *
  7. * *
  8. * This program is free software; you can redistribute it and/or modify *
  9. * it under the terms of the GNU General Public License as published by *
  10. * the Free Software Foundation; either version 2 of the License, or *
  11. * (at your option) any later version. *
  12. * *
  13. * This program is distributed in the hope that it will be useful, *
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of *
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
  16. * GNU General Public License for more details. *
  17. * *
  18. * You should have received a copy of the GNU General Public License *
  19. * along with this program; if not, write to the *
  20. * Free Software Foundation, Inc., *
  21. * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
  22. ***************************************************************************/
  23. #ifndef JTAG_H
  24. #define JTAG_H
  25. #include <helper/binarybuffer.h>
  26. #include <helper/log.h>
  27. #ifdef _DEBUG_JTAG_IO_
  28. #define DEBUG_JTAG_IO(expr ...) \
  29. do { if (1) LOG_DEBUG(expr); } while (0)
  30. #else
  31. #define DEBUG_JTAG_IO(expr ...) \
  32. do { if (0) LOG_DEBUG(expr); } while (0)
  33. #endif
  34. #ifndef DEBUG_JTAG_IOZ
  35. #define DEBUG_JTAG_IOZ 64
  36. #endif
  37. /*-----</Macros>-------------------------------------------------*/
  38. /**
  39. * Defines JTAG Test Access Port states.
  40. *
  41. * These definitions were gleaned from the ARM7TDMI-S Technical
  42. * Reference Manual and validated against several other ARM core
  43. * technical manuals.
  44. *
  45. * FIXME some interfaces require specific numbers be used, as they
  46. * are handed-off directly to their hardware implementations.
  47. * Fix those drivers to map as appropriate ... then pick some
  48. * sane set of numbers here (where 0/uninitialized == INVALID).
  49. */
  50. typedef enum tap_state {
  51. TAP_INVALID = -1,
  52. #if BUILD_ZY1000
  53. /* These are the old numbers. Leave as-is for now... */
  54. TAP_RESET = 0, TAP_IDLE = 8,
  55. TAP_DRSELECT = 1, TAP_DRCAPTURE = 2, TAP_DRSHIFT = 3, TAP_DREXIT1 = 4,
  56. TAP_DRPAUSE = 5, TAP_DREXIT2 = 6, TAP_DRUPDATE = 7,
  57. TAP_IRSELECT = 9, TAP_IRCAPTURE = 10, TAP_IRSHIFT = 11, TAP_IREXIT1 = 12,
  58. TAP_IRPAUSE = 13, TAP_IREXIT2 = 14, TAP_IRUPDATE = 15,
  59. #else
  60. /* Proper ARM recommended numbers */
  61. TAP_DREXIT2 = 0x0,
  62. TAP_DREXIT1 = 0x1,
  63. TAP_DRSHIFT = 0x2,
  64. TAP_DRPAUSE = 0x3,
  65. TAP_IRSELECT = 0x4,
  66. TAP_DRUPDATE = 0x5,
  67. TAP_DRCAPTURE = 0x6,
  68. TAP_DRSELECT = 0x7,
  69. TAP_IREXIT2 = 0x8,
  70. TAP_IREXIT1 = 0x9,
  71. TAP_IRSHIFT = 0xa,
  72. TAP_IRPAUSE = 0xb,
  73. TAP_IDLE = 0xc,
  74. TAP_IRUPDATE = 0xd,
  75. TAP_IRCAPTURE = 0xe,
  76. TAP_RESET = 0x0f,
  77. #endif
  78. } tap_state_t;
  79. /**
  80. * Function tap_state_name
  81. * Returns a string suitable for display representing the JTAG tap_state
  82. */
  83. const char *tap_state_name(tap_state_t state);
  84. /** Provides user-friendly name lookup of TAP states. */
  85. tap_state_t tap_state_by_name(const char *name);
  86. /** The current TAP state of the pending JTAG command queue. */
  87. extern tap_state_t cmd_queue_cur_state;
  88. /**
  89. * This structure defines a single scan field in the scan. It provides
  90. * fields for the field's width and pointers to scan input and output
  91. * values.
  92. *
  93. * In addition, this structure includes a value and mask that is used by
  94. * jtag_add_dr_scan_check() to validate the value that was scanned out.
  95. */
  96. struct scan_field {
  97. /** The number of bits this field specifies (up to 32) */
  98. int num_bits;
  99. /** A pointer to value to be scanned into the device */
  100. const uint8_t *out_value;
  101. /** A pointer to a 32-bit memory location for data scanned out */
  102. uint8_t *in_value;
  103. /** The value used to check the data scanned out. */
  104. uint8_t *check_value;
  105. /** The mask to go with check_value */
  106. uint8_t *check_mask;
  107. };
  108. struct jtag_tap {
  109. char *chip;
  110. char *tapname;
  111. char *dotted_name;
  112. int abs_chain_position;
  113. /** Is this TAP disabled after JTAG reset? */
  114. bool disabled_after_reset;
  115. /** Is this TAP currently enabled? */
  116. bool enabled;
  117. int ir_length; /**< size of instruction register */
  118. uint32_t ir_capture_value;
  119. uint8_t *expected; /**< Capture-IR expected value */
  120. uint32_t ir_capture_mask;
  121. uint8_t *expected_mask; /**< Capture-IR expected mask */
  122. uint32_t idcode; /**< device identification code */
  123. /** not all devices have idcode,
  124. * we'll discover this during chain examination */
  125. bool hasidcode;
  126. /** Array of expected identification codes */
  127. uint32_t *expected_ids;
  128. /** Number of expected identification codes */
  129. uint8_t expected_ids_cnt;
  130. /** Flag saying whether to ignore version field in expected_ids[] */
  131. bool ignore_version;
  132. /** current instruction */
  133. uint8_t *cur_instr;
  134. /** Bypass register selected */
  135. int bypass;
  136. struct jtag_tap_event_action *event_action;
  137. struct jtag_tap *next_tap;
  138. /* dap instance if some null if no instance , initialized to 0 by calloc*/
  139. struct adiv5_dap *dap;
  140. /* private pointer to support none-jtag specific functions */
  141. void *priv;
  142. };
  143. void jtag_tap_init(struct jtag_tap *tap);
  144. void jtag_tap_free(struct jtag_tap *tap);
  145. struct jtag_tap *jtag_all_taps(void);
  146. const char *jtag_tap_name(const struct jtag_tap *tap);
  147. struct jtag_tap *jtag_tap_by_string(const char* dotted_name);
  148. struct jtag_tap *jtag_tap_by_jim_obj(Jim_Interp* interp, Jim_Obj *obj);
  149. struct jtag_tap *jtag_tap_by_position(unsigned abs_position);
  150. struct jtag_tap *jtag_tap_next_enabled(struct jtag_tap *p);
  151. unsigned jtag_tap_count_enabled(void);
  152. unsigned jtag_tap_count(void);
  153. /*
  154. * - TRST_ASSERTED triggers two sets of callbacks, after operations to
  155. * reset the scan chain -- via TMS+TCK signaling, or deasserting the
  156. * nTRST signal -- are queued:
  157. *
  158. * + Callbacks in C code fire first, patching internal state
  159. * + Then post-reset event scripts fire ... activating JTAG circuits
  160. * via TCK cycles, exiting SWD mode via TMS sequences, etc
  161. *
  162. * During those callbacks, scan chain contents have not been validated.
  163. * JTAG operations that address a specific TAP (primarily DR/IR scans)
  164. * must *not* be queued.
  165. *
  166. * - TAP_EVENT_SETUP is reported after TRST_ASSERTED, and after the scan
  167. * chain has been validated. JTAG operations including scans that
  168. * target specific TAPs may be performed.
  169. *
  170. * - TAP_EVENT_ENABLE and TAP_EVENT_DISABLE implement TAP activation and
  171. * deactivation outside the core using scripted code that understands
  172. * the specific JTAG router type. They might be triggered indirectly
  173. * from EVENT_SETUP operations.
  174. */
  175. enum jtag_event {
  176. JTAG_TRST_ASSERTED,
  177. JTAG_TAP_EVENT_SETUP,
  178. JTAG_TAP_EVENT_ENABLE,
  179. JTAG_TAP_EVENT_DISABLE,
  180. };
  181. struct jtag_tap_event_action {
  182. /** The event for which this action will be triggered. */
  183. enum jtag_event event;
  184. /** The interpreter to use for evaluating the @c body. */
  185. Jim_Interp *interp;
  186. /** Contains a script to 'eval' when the @c event is triggered. */
  187. Jim_Obj *body;
  188. /* next action in linked list */
  189. struct jtag_tap_event_action *next;
  190. };
  191. /**
  192. * Defines the function signature requide for JTAG event callback
  193. * functions, which are added with jtag_register_event_callback()
  194. * and removed jtag_unregister_event_callback().
  195. * @param event The event to handle.
  196. * @param prive A pointer to data that was passed to
  197. * jtag_register_event_callback().
  198. * @returns Must return ERROR_OK on success, or an error code on failure.
  199. *
  200. * @todo Change to return void or define a use for its return code.
  201. */
  202. typedef int (*jtag_event_handler_t)(enum jtag_event event, void *priv);
  203. int jtag_register_event_callback(jtag_event_handler_t f, void *x);
  204. int jtag_unregister_event_callback(jtag_event_handler_t f, void *x);
  205. int jtag_call_event_callbacks(enum jtag_event event);
  206. /** @returns The current JTAG speed setting. */
  207. int jtag_get_speed(int *speed);
  208. /**
  209. * Given a @a speed setting, use the interface @c speed_div callback to
  210. * adjust the setting.
  211. * @param speed The speed setting to convert back to readable KHz.
  212. * @returns ERROR_OK if the interface has not been initialized or on success;
  213. * otherwise, the error code produced by the @c speed_div callback.
  214. */
  215. int jtag_get_speed_readable(int *speed);
  216. /** Attempt to configure the interface for the specified KHz. */
  217. int jtag_config_khz(unsigned khz);
  218. /**
  219. * Attempt to enable RTCK/RCLK. If that fails, fallback to the
  220. * specified frequency.
  221. */
  222. int jtag_config_rclk(unsigned fallback_speed_khz);
  223. /** Retreives the clock speed of the JTAG interface in KHz. */
  224. unsigned jtag_get_speed_khz(void);
  225. enum reset_types {
  226. RESET_NONE = 0x0,
  227. RESET_HAS_TRST = 0x1,
  228. RESET_HAS_SRST = 0x2,
  229. RESET_TRST_AND_SRST = 0x3,
  230. RESET_SRST_PULLS_TRST = 0x4,
  231. RESET_TRST_PULLS_SRST = 0x8,
  232. RESET_TRST_OPEN_DRAIN = 0x10,
  233. RESET_SRST_PUSH_PULL = 0x20,
  234. RESET_SRST_NO_GATING = 0x40,
  235. RESET_CNCT_UNDER_SRST = 0x80
  236. };
  237. enum reset_types jtag_get_reset_config(void);
  238. void jtag_set_reset_config(enum reset_types type);
  239. void jtag_set_nsrst_delay(unsigned delay);
  240. unsigned jtag_get_nsrst_delay(void);
  241. void jtag_set_ntrst_delay(unsigned delay);
  242. unsigned jtag_get_ntrst_delay(void);
  243. void jtag_set_nsrst_assert_width(unsigned delay);
  244. unsigned jtag_get_nsrst_assert_width(void);
  245. void jtag_set_ntrst_assert_width(unsigned delay);
  246. unsigned jtag_get_ntrst_assert_width(void);
  247. /** @returns The current state of TRST. */
  248. int jtag_get_trst(void);
  249. /** @returns The current state of SRST. */
  250. int jtag_get_srst(void);
  251. /** Enable or disable data scan verification checking. */
  252. void jtag_set_verify(bool enable);
  253. /** @returns True if data scan verification will be performed. */
  254. bool jtag_will_verify(void);
  255. /** Enable or disable verification of IR scan checking. */
  256. void jtag_set_verify_capture_ir(bool enable);
  257. /** @returns True if IR scan verification will be performed. */
  258. bool jtag_will_verify_capture_ir(void);
  259. /** Initialize debug adapter upon startup. */
  260. int adapter_init(struct command_context *cmd_ctx);
  261. /** Shutdown the debug adapter upon program exit. */
  262. int adapter_quit(void);
  263. /** Set ms to sleep after jtag_execute_queue() flushes queue. Debug purposes. */
  264. void jtag_set_flush_queue_sleep(int ms);
  265. /**
  266. * Initialize JTAG chain using only a RESET reset. If init fails,
  267. * try reset + init.
  268. */
  269. int jtag_init(struct command_context *cmd_ctx);
  270. /** reset, then initialize JTAG chain */
  271. int jtag_init_reset(struct command_context *cmd_ctx);
  272. int jtag_register_commands(struct command_context *cmd_ctx);
  273. int jtag_init_inner(struct command_context *cmd_ctx);
  274. /**
  275. * @file
  276. * The JTAG interface can be implemented with a software or hardware fifo.
  277. *
  278. * TAP_DRSHIFT and TAP_IRSHIFT are illegal end states; however,
  279. * TAP_DRSHIFT/IRSHIFT can be emulated as end states, by using longer
  280. * scans.
  281. *
  282. * Code that is relatively insensitive to the path taken through state
  283. * machine (as long as it is JTAG compliant) can use @a endstate for
  284. * jtag_add_xxx_scan(). Otherwise, the pause state must be specified as
  285. * end state and a subsequent jtag_add_pathmove() must be issued.
  286. */
  287. /**
  288. * Generate an IR SCAN with a list of scan fields with one entry for
  289. * each enabled TAP.
  290. *
  291. * If the input field list contains an instruction value for a TAP then
  292. * that is used otherwise the TAP is set to bypass.
  293. *
  294. * TAPs for which no fields are passed are marked as bypassed for
  295. * subsequent DR SCANs.
  296. *
  297. */
  298. void jtag_add_ir_scan(struct jtag_tap *tap,
  299. struct scan_field *fields, tap_state_t endstate);
  300. /**
  301. * The same as jtag_add_ir_scan except no verification is performed out
  302. * the output values.
  303. */
  304. void jtag_add_ir_scan_noverify(struct jtag_tap *tap,
  305. const struct scan_field *fields, tap_state_t state);
  306. /**
  307. * Scan out the bits in ir scan mode.
  308. *
  309. * If in_bits == NULL, discard incoming bits.
  310. */
  311. void jtag_add_plain_ir_scan(int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
  312. tap_state_t endstate);
  313. /**
  314. * Generate a DR SCAN using the fields passed to the function.
  315. * For connected TAPs, the function checks in_fields and uses fields
  316. * specified there. For bypassed TAPs, the function generates a dummy
  317. * 1-bit field. The bypass status of TAPs is set by jtag_add_ir_scan().
  318. */
  319. void jtag_add_dr_scan(struct jtag_tap *tap, int num_fields,
  320. const struct scan_field *fields, tap_state_t endstate);
  321. /** A version of jtag_add_dr_scan() that uses the check_value/mask fields */
  322. void jtag_add_dr_scan_check(struct jtag_tap *tap, int num_fields,
  323. struct scan_field *fields, tap_state_t endstate);
  324. /**
  325. * Scan out the bits in ir scan mode.
  326. *
  327. * If in_bits == NULL, discard incoming bits.
  328. */
  329. void jtag_add_plain_dr_scan(int num_bits,
  330. const uint8_t *out_bits, uint8_t *in_bits, tap_state_t endstate);
  331. /**
  332. * Defines the type of data passed to the jtag_callback_t interface.
  333. * The underlying type must allow storing an @c int or pointer type.
  334. */
  335. typedef intptr_t jtag_callback_data_t;
  336. /**
  337. * Defines a simple JTAG callback that can allow conversions on data
  338. * scanned in from an interface.
  339. *
  340. * This callback should only be used for conversion that cannot fail.
  341. * For conversion types or checks that can fail, use the more complete
  342. * variant: jtag_callback_t.
  343. */
  344. typedef void (*jtag_callback1_t)(jtag_callback_data_t data0);
  345. /** A simpler version of jtag_add_callback4(). */
  346. void jtag_add_callback(jtag_callback1_t, jtag_callback_data_t data0);
  347. /**
  348. * Defines the interface of the JTAG callback mechanism. Such
  349. * callbacks can be executed once the queue has been flushed.
  350. *
  351. * The JTAG queue can be executed synchronously or asynchronously.
  352. * Typically for USB, the queue is executed asynchronously. For
  353. * low-latency interfaces, the queue may be executed synchronously.
  354. *
  355. * The callback mechanism is very general and does not make many
  356. * assumptions about what the callback does or what its arguments are.
  357. * These callbacks are typically executed *after* the *entire* JTAG
  358. * queue has been executed for e.g. USB interfaces, and they are
  359. * guaranteeed to be invoked in the order that they were queued.
  360. *
  361. * If the execution of the queue fails before the callbacks, then --
  362. * depending on driver implementation -- the callbacks may or may not be
  363. * invoked.
  364. *
  365. * @todo Make that behavior consistent.
  366. *
  367. * @param data0 Typically used to point to the data to operate on.
  368. * Frequently this will be the data clocked in during a shift operation.
  369. * @param data1 An integer big enough to use as an @c int or a pointer.
  370. * @param data2 An integer big enough to use as an @c int or a pointer.
  371. * @param data3 An integer big enough to use as an @c int or a pointer.
  372. * @returns an error code
  373. */
  374. typedef int (*jtag_callback_t)(jtag_callback_data_t data0,
  375. jtag_callback_data_t data1,
  376. jtag_callback_data_t data2,
  377. jtag_callback_data_t data3);
  378. /**
  379. * Run a TAP_RESET reset where the end state is TAP_RESET,
  380. * regardless of the start state.
  381. */
  382. void jtag_add_tlr(void);
  383. /**
  384. * Application code *must* assume that interfaces will
  385. * implement transitions between states with different
  386. * paths and path lengths through the state diagram. The
  387. * path will vary across interface and also across versions
  388. * of the same interface over time. Even if the OpenOCD code
  389. * is unchanged, the actual path taken may vary over time
  390. * and versions of interface firmware or PCB revisions.
  391. *
  392. * Use jtag_add_pathmove() when specific transition sequences
  393. * are required.
  394. *
  395. * Do not use jtag_add_pathmove() unless you need to, but do use it
  396. * if you have to.
  397. *
  398. * DANGER! If the target is dependent upon a particular sequence
  399. * of transitions for things to work correctly(e.g. as a workaround
  400. * for an errata that contradicts the JTAG standard), then pathmove
  401. * must be used, even if some jtag interfaces happen to use the
  402. * desired path. Worse, the jtag interface used for testing a
  403. * particular implementation, could happen to use the "desired"
  404. * path when transitioning to/from end
  405. * state.
  406. *
  407. * A list of unambigious single clock state transitions, not
  408. * all drivers can support this, but it is required for e.g.
  409. * XScale and Xilinx support
  410. *
  411. * Note! TAP_RESET must not be used in the path!
  412. *
  413. * Note that the first on the list must be reachable
  414. * via a single transition from the current state.
  415. *
  416. * All drivers are required to implement jtag_add_pathmove().
  417. * However, if the pathmove sequence can not be precisely
  418. * executed, an interface_jtag_add_pathmove() or jtag_execute_queue()
  419. * must return an error. It is legal, but not recommended, that
  420. * a driver returns an error in all cases for a pathmove if it
  421. * can only implement a few transitions and therefore
  422. * a partial implementation of pathmove would have little practical
  423. * application.
  424. *
  425. * If an error occurs, jtag_error will contain one of these error codes:
  426. * - ERROR_JTAG_NOT_STABLE_STATE -- The final state was not stable.
  427. * - ERROR_JTAG_STATE_INVALID -- The path passed through TAP_RESET.
  428. * - ERROR_JTAG_TRANSITION_INVALID -- The path includes invalid
  429. * state transitions.
  430. */
  431. void jtag_add_pathmove(int num_states, const tap_state_t *path);
  432. /**
  433. * jtag_add_statemove() moves from the current state to @a goal_state.
  434. *
  435. * @param goal_state The final TAP state.
  436. * @return ERROR_OK on success, or an error code on failure.
  437. *
  438. * Moves from the current state to the goal \a state.
  439. * Both states must be stable.
  440. */
  441. int jtag_add_statemove(tap_state_t goal_state);
  442. /**
  443. * Goes to TAP_IDLE (if we're not already there), cycle
  444. * precisely num_cycles in the TAP_IDLE state, after which move
  445. * to @a endstate (unless it is also TAP_IDLE).
  446. *
  447. * @param num_cycles Number of cycles in TAP_IDLE state. This argument
  448. * may be 0, in which case this routine will navigate to @a endstate
  449. * via TAP_IDLE.
  450. * @param endstate The final state.
  451. */
  452. void jtag_add_runtest(int num_cycles, tap_state_t endstate);
  453. /**
  454. * A reset of the TAP state machine can be requested.
  455. *
  456. * Whether tms or trst reset is used depends on the capabilities of
  457. * the target and jtag interface(reset_config command configures this).
  458. *
  459. * srst can driver a reset of the TAP state machine and vice
  460. * versa
  461. *
  462. * Application code may need to examine value of jtag_reset_config
  463. * to determine the proper codepath
  464. *
  465. * DANGER! Even though srst drives trst, trst might not be connected to
  466. * the interface, and it might actually be *harmful* to assert trst in this case.
  467. *
  468. * This is why combinations such as "reset_config srst_only srst_pulls_trst"
  469. * are supported.
  470. *
  471. * only req_tlr_or_trst and srst can have a transition for a
  472. * call as the effects of transitioning both at the "same time"
  473. * are undefined, but when srst_pulls_trst or vice versa,
  474. * then trst & srst *must* be asserted together.
  475. */
  476. void jtag_add_reset(int req_tlr_or_trst, int srst);
  477. void jtag_add_sleep(uint32_t us);
  478. int jtag_add_tms_seq(unsigned nbits, const uint8_t *seq, enum tap_state t);
  479. /**
  480. * Function jtag_add_clocks
  481. * first checks that the state in which the clocks are to be issued is
  482. * stable, then queues up num_cycles clocks for transmission.
  483. */
  484. void jtag_add_clocks(int num_cycles);
  485. /**
  486. * For software FIFO implementations, the queued commands can be executed
  487. * during this call or earlier. A sw queue might decide to push out
  488. * some of the jtag_add_xxx() operations once the queue is "big enough".
  489. *
  490. * This fn will return an error code if any of the prior jtag_add_xxx()
  491. * calls caused a failure, e.g. check failure. Note that it does not
  492. * matter if the operation was executed *before* jtag_execute_queue(),
  493. * jtag_execute_queue() will still return an error code.
  494. *
  495. * All jtag_add_xxx() calls that have in_handler != NULL will have been
  496. * executed when this fn returns, but if what has been queued only
  497. * clocks data out, without reading anything back, then JTAG could
  498. * be running *after* jtag_execute_queue() returns. The API does
  499. * not define a way to flush a hw FIFO that runs *after*
  500. * jtag_execute_queue() returns.
  501. *
  502. * jtag_add_xxx() commands can either be executed immediately or
  503. * at some time between the jtag_add_xxx() fn call and jtag_execute_queue().
  504. */
  505. int jtag_execute_queue(void);
  506. /** same as jtag_execute_queue() but does not clear the error flag */
  507. void jtag_execute_queue_noclear(void);
  508. /** @returns the number of times the scan queue has been flushed */
  509. int jtag_get_flush_queue_count(void);
  510. /** Report Tcl event to all TAPs */
  511. void jtag_notify_event(enum jtag_event);
  512. /* can be implemented by hw + sw */
  513. int jtag_power_dropout(int *dropout);
  514. int jtag_srst_asserted(int *srst_asserted);
  515. /* JTAG support functions */
  516. /**
  517. * Execute jtag queue and check value with an optional mask.
  518. * @param field Pointer to scan field.
  519. * @param value Pointer to scan value.
  520. * @param mask Pointer to scan mask; may be NULL.
  521. * @returns Nothing, but calls jtag_set_error() on any error.
  522. */
  523. void jtag_check_value_mask(struct scan_field *field, uint8_t *value, uint8_t *mask);
  524. void jtag_sleep(uint32_t us);
  525. /*
  526. * The JTAG subsystem defines a number of error codes,
  527. * using codes between -100 and -199.
  528. */
  529. #define ERROR_JTAG_INIT_FAILED (-100)
  530. #define ERROR_JTAG_INVALID_INTERFACE (-101)
  531. #define ERROR_JTAG_NOT_IMPLEMENTED (-102)
  532. #define ERROR_JTAG_TRST_ASSERTED (-103)
  533. #define ERROR_JTAG_QUEUE_FAILED (-104)
  534. #define ERROR_JTAG_NOT_STABLE_STATE (-105)
  535. #define ERROR_JTAG_DEVICE_ERROR (-107)
  536. #define ERROR_JTAG_STATE_INVALID (-108)
  537. #define ERROR_JTAG_TRANSITION_INVALID (-109)
  538. #define ERROR_JTAG_INIT_SOFT_FAIL (-110)
  539. /**
  540. * Set the current JTAG core execution error, unless one was set
  541. * by a previous call previously. Driver or application code must
  542. * use jtag_error_clear to reset jtag_error once this routine has been
  543. * called with a non-zero error code.
  544. */
  545. void jtag_set_error(int error);
  546. /**
  547. * Resets jtag_error to ERROR_OK, returning its previous value.
  548. * @returns The previous value of @c jtag_error.
  549. */
  550. int jtag_error_clear(void);
  551. /**
  552. * Return true if it's safe for a background polling task to access the
  553. * JTAG scan chain. Polling may be explicitly disallowed, and is also
  554. * unsafe while nTRST is active or the JTAG clock is gated off.
  555. */
  556. bool is_jtag_poll_safe(void);
  557. /**
  558. * Return flag reporting whether JTAG polling is disallowed.
  559. */
  560. bool jtag_poll_get_enabled(void);
  561. /**
  562. * Assign flag reporting whether JTAG polling is disallowed.
  563. */
  564. void jtag_poll_set_enabled(bool value);
  565. /* The minidriver may have inline versions of some of the low
  566. * level APIs that are used in inner loops. */
  567. #include <jtag/minidriver.h>
  568. bool transport_is_jtag(void);
  569. int jim_jtag_newtap(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
  570. #endif /* JTAG_H */