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.
 
 
 
 
 
 

736 lines
26 KiB

  1. /***************************************************************************
  2. * Copyright (C) 2005 by Dominic Rath *
  3. * Dominic.Rath@gmx.de *
  4. * *
  5. * Copyright (C) 2007,2008 √ė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. * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
  22. ***************************************************************************/
  23. #ifndef JTAG_H
  24. #define JTAG_H
  25. #include "binarybuffer.h"
  26. #include "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. * When given an array, compute its DIMension; in other words, the
  40. * number of elements in the array
  41. */
  42. #define DIM(x) (sizeof(x)/sizeof((x)[0]))
  43. /** Calculate the number of bytes required to hold @a n TAP scan bits */
  44. #define TAP_SCAN_BYTES(n) CEIL(n, 8)
  45. /*-----</Macros>-------------------------------------------------*/
  46. /**
  47. * Defines JTAG Test Access Port states.
  48. *
  49. * These definitions were gleaned from the ARM7TDMI-S Technical
  50. * Reference Manual and validated against several other ARM core
  51. * technical manuals. tap_get_tms_path() is sensitive to this numbering
  52. * and ordering of the TAP states; furthermore, some interfaces require
  53. * specific numbers be used, as they are handed-off directly to their
  54. * hardware implementations.
  55. */
  56. typedef enum tap_state
  57. {
  58. #if BUILD_ZY1000
  59. /* These are the old numbers. Leave as-is for now... */
  60. TAP_RESET = 0, TAP_IDLE = 8,
  61. TAP_DRSELECT = 1, TAP_DRCAPTURE = 2, TAP_DRSHIFT = 3, TAP_DREXIT1 = 4,
  62. TAP_DRPAUSE = 5, TAP_DREXIT2 = 6, TAP_DRUPDATE = 7,
  63. TAP_IRSELECT = 9, TAP_IRCAPTURE = 10, TAP_IRSHIFT = 11, TAP_IREXIT1 = 12,
  64. TAP_IRPAUSE = 13, TAP_IREXIT2 = 14, TAP_IRUPDATE = 15,
  65. TAP_NUM_STATES = 16, TAP_INVALID = -1,
  66. #else
  67. /* Proper ARM recommended numbers */
  68. TAP_DREXIT2 = 0x0,
  69. TAP_DREXIT1 = 0x1,
  70. TAP_DRSHIFT = 0x2,
  71. TAP_DRPAUSE = 0x3,
  72. TAP_IRSELECT = 0x4,
  73. TAP_DRUPDATE = 0x5,
  74. TAP_DRCAPTURE = 0x6,
  75. TAP_DRSELECT = 0x7,
  76. TAP_IREXIT2 = 0x8,
  77. TAP_IREXIT1 = 0x9,
  78. TAP_IRSHIFT = 0xa,
  79. TAP_IRPAUSE = 0xb,
  80. TAP_IDLE = 0xc,
  81. TAP_IRUPDATE = 0xd,
  82. TAP_IRCAPTURE = 0xe,
  83. TAP_RESET = 0x0f,
  84. TAP_NUM_STATES = 0x10,
  85. TAP_INVALID = -1,
  86. #endif
  87. } tap_state_t;
  88. /**
  89. * Function tap_state_name
  90. * Returns a string suitable for display representing the JTAG tap_state
  91. */
  92. const char* tap_state_name(tap_state_t state);
  93. /// The current TAP state of the pending JTAG command queue.
  94. extern tap_state_t cmd_queue_cur_state;
  95. /**
  96. * This structure defines a single scan field in the scan. It provides
  97. * fields for the field's width and pointers to scan input and output
  98. * values.
  99. *
  100. * In addition, this structure includes a value and mask that is used by
  101. * jtag_add_dr_scan_check() to validate the value that was scanned out.
  102. *
  103. * The allocated, modified, and intmp fields are internal work space.
  104. */
  105. typedef struct scan_field_s
  106. {
  107. /// A pointer to the tap structure to which this field refers.
  108. jtag_tap_t* tap;
  109. /// The number of bits this field specifies (up to 32)
  110. int num_bits;
  111. /// A pointer to value to be scanned into the device
  112. uint8_t* out_value;
  113. /// A pointer to a 32-bit memory location for data scanned out
  114. uint8_t* in_value;
  115. /// The value used to check the data scanned out.
  116. uint8_t* check_value;
  117. /// The mask to go with check_value
  118. uint8_t* check_mask;
  119. /// in_value has been allocated for the queue
  120. int allocated;
  121. /// Indicates we modified the in_value.
  122. int modified;
  123. /// temporary storage for performing value checks synchronously
  124. uint8_t intmp[4];
  125. } scan_field_t;
  126. typedef struct jtag_tap_event_action_s jtag_tap_event_action_t;
  127. /* this is really: typedef jtag_tap_t */
  128. /* But - the typedef is done in "types.h" */
  129. /* due to "forward declaration reasons" */
  130. struct jtag_tap_s
  131. {
  132. const char* chip;
  133. const char* tapname;
  134. const char* dotted_name;
  135. int abs_chain_position;
  136. /// Is this TAP disabled after JTAG reset?
  137. bool disabled_after_reset;
  138. /// Is this TAP currently enabled?
  139. bool enabled;
  140. int ir_length; /**< size of instruction register */
  141. uint32_t ir_capture_value;
  142. uint8_t* expected; /**< Capture-IR expected value */
  143. uint32_t ir_capture_mask;
  144. uint8_t* expected_mask; /**< Capture-IR expected mask */
  145. uint32_t idcode;
  146. bool hasidcode; /* not all devices have idcode, we'll discover this during chain examination */
  147. /**< device identification code */
  148. /// Array of expected identification codes */
  149. uint32_t* expected_ids;
  150. /// Number of expected identification codes
  151. uint8_t expected_ids_cnt;
  152. /// current instruction
  153. uint8_t* cur_instr;
  154. /// Bypass register selected
  155. int bypass;
  156. jtag_tap_event_action_t *event_action;
  157. jtag_tap_t* next_tap;
  158. };
  159. void jtag_tap_init(jtag_tap_t *tap);
  160. void jtag_tap_free(jtag_tap_t *tap);
  161. extern jtag_tap_t* jtag_all_taps(void);
  162. extern const char *jtag_tap_name(const jtag_tap_t *tap);
  163. extern jtag_tap_t* jtag_tap_by_string(const char* dotted_name);
  164. extern jtag_tap_t* jtag_tap_by_jim_obj(Jim_Interp* interp, Jim_Obj* obj);
  165. extern jtag_tap_t* jtag_tap_next_enabled(jtag_tap_t* p);
  166. extern unsigned jtag_tap_count_enabled(void);
  167. extern unsigned jtag_tap_count(void);
  168. /*
  169. * - TRST_ASSERTED triggers two sets of callbacks, after operations to
  170. * reset the scan chain -- via TMS+TCK signaling, or deasserting the
  171. * nTRST signal -- are queued:
  172. *
  173. * + Callbacks in C code fire first, patching internal state
  174. * + Then post-reset event scripts fire ... activating JTAG circuits
  175. * via TCK cycles, exiting SWD mode via TMS sequences, etc
  176. *
  177. * During those callbacks, scan chain contents have not been validated.
  178. * JTAG operations that address a specific TAP (primarily DR/IR scans)
  179. * must *not* be queued.
  180. *
  181. * - TAP_EVENT_SETUP is reported after TRST_ASSERTED, and after the scan
  182. * chain has been validated. JTAG operations including scans that
  183. * target specific TAPs may be performed.
  184. *
  185. * - TAP_EVENT_ENABLE and TAP_EVENT_DISABLE implement TAP activation and
  186. * deactivation outside the core using scripted code that understands
  187. * the specific JTAG router type. They might be triggered indirectly
  188. * from EVENT_SETUP operations.
  189. */
  190. enum jtag_event {
  191. JTAG_TRST_ASSERTED,
  192. JTAG_TAP_EVENT_SETUP,
  193. JTAG_TAP_EVENT_ENABLE,
  194. JTAG_TAP_EVENT_DISABLE,
  195. };
  196. struct jtag_tap_event_action_s
  197. {
  198. enum jtag_event event;
  199. Jim_Obj* body;
  200. jtag_tap_event_action_t* next;
  201. };
  202. /**
  203. * Defines the function signature requide for JTAG event callback
  204. * functions, which are added with jtag_register_event_callback()
  205. * and removed jtag_unregister_event_callback().
  206. * @param event The event to handle.
  207. * @param prive A pointer to data that was passed to
  208. * jtag_register_event_callback().
  209. * @returns Must return ERROR_OK on success, or an error code on failure.
  210. *
  211. * @todo Change to return void or define a use for its return code.
  212. */
  213. typedef int (*jtag_event_handler_t)(enum jtag_event event, void* priv);
  214. extern int jtag_register_event_callback(jtag_event_handler_t f, void *x);
  215. extern int jtag_unregister_event_callback(jtag_event_handler_t f, void *x);
  216. extern int jtag_call_event_callbacks(enum jtag_event event);
  217. /// @returns The current JTAG speed setting.
  218. int jtag_get_speed(void);
  219. /**
  220. * Given a @a speed setting, use the interface @c speed_div callback to
  221. * adjust the setting.
  222. * @param speed The speed setting to convert back to readable KHz.
  223. * @returns ERROR_OK if the interface has not been initialized or on success;
  224. * otherwise, the error code produced by the @c speed_div callback.
  225. */
  226. int jtag_get_speed_readable(int *speed);
  227. /**
  228. * Set the JTAG speed. This routine will call the underlying
  229. * interface @c speed callback, if the interface has been initialized.
  230. * @param speed The new speed setting.
  231. * @returns ERROR_OK during configuration or on success, or an error
  232. * code returned from the interface @c speed callback.
  233. */
  234. int jtag_config_speed(int speed);
  235. /// Attempt to configure the interface for the specified KHz.
  236. int jtag_config_khz(unsigned khz);
  237. /**
  238. * Attempt to enable RTCK/RCLK. If that fails, fallback to the
  239. * specified frequency.
  240. */
  241. int jtag_config_rclk(unsigned fallback_speed_khz);
  242. /// Retreives the clock speed of the JTAG interface in KHz.
  243. unsigned jtag_get_speed_khz(void);
  244. enum reset_types {
  245. RESET_NONE = 0x0,
  246. RESET_HAS_TRST = 0x1,
  247. RESET_HAS_SRST = 0x2,
  248. RESET_TRST_AND_SRST = 0x3,
  249. RESET_SRST_PULLS_TRST = 0x4,
  250. RESET_TRST_PULLS_SRST = 0x8,
  251. RESET_TRST_OPEN_DRAIN = 0x10,
  252. RESET_SRST_PUSH_PULL = 0x20,
  253. RESET_SRST_NO_GATING = 0x40,
  254. };
  255. enum reset_types jtag_get_reset_config(void);
  256. void jtag_set_reset_config(enum reset_types type);
  257. void jtag_set_nsrst_delay(unsigned delay);
  258. unsigned jtag_get_nsrst_delay(void);
  259. void jtag_set_ntrst_delay(unsigned delay);
  260. unsigned jtag_get_ntrst_delay(void);
  261. void jtag_set_nsrst_assert_width(unsigned delay);
  262. unsigned jtag_get_nsrst_assert_width(void);
  263. void jtag_set_ntrst_assert_width(unsigned delay);
  264. unsigned jtag_get_ntrst_assert_width(void);
  265. /// @returns The current state of TRST.
  266. int jtag_get_trst(void);
  267. /// @returns The current state of SRST.
  268. int jtag_get_srst(void);
  269. /// Enable or disable data scan verification checking.
  270. void jtag_set_verify(bool enable);
  271. /// @returns True if data scan verification will be performed.
  272. bool jtag_will_verify(void);
  273. /// Enable or disable verification of IR scan checking.
  274. void jtag_set_verify_capture_ir(bool enable);
  275. /// @returns True if IR scan verification will be performed.
  276. bool jtag_will_verify_capture_ir(void);
  277. /**
  278. * Initialize interface upon startup. Return a successful no-op upon
  279. * subsequent invocations.
  280. */
  281. extern int jtag_interface_init(struct command_context_s* cmd_ctx);
  282. /// Shutdown the JTAG interface upon program exit.
  283. extern int jtag_interface_quit(void);
  284. /**
  285. * Initialize JTAG chain using only a RESET reset. If init fails,
  286. * try reset + init.
  287. */
  288. extern int jtag_init(struct command_context_s* cmd_ctx);
  289. /// reset, then initialize JTAG chain
  290. extern int jtag_init_reset(struct command_context_s* cmd_ctx);
  291. extern int jtag_register_commands(struct command_context_s* cmd_ctx);
  292. extern int jtag_init_inner(struct command_context_s *cmd_ctx);
  293. /**
  294. * @file
  295. * The JTAG interface can be implemented with a software or hardware fifo.
  296. *
  297. * TAP_DRSHIFT and TAP_IRSHIFT are illegal end states; however,
  298. * TAP_DRSHIFT/IRSHIFT can be emulated as end states, by using longer
  299. * scans.
  300. *
  301. * Code that is relatively insensitive to the path taken through state
  302. * machine (as long as it is JTAG compliant) can use @a endstate for
  303. * jtag_add_xxx_scan(). Otherwise, the pause state must be specified as
  304. * end state and a subsequent jtag_add_pathmove() must be issued.
  305. */
  306. /**
  307. * Generate an IR SCAN with a list of scan fields with one entry for
  308. * each enabled TAP.
  309. *
  310. * If the input field list contains an instruction value for a TAP then
  311. * that is used otherwise the TAP is set to bypass.
  312. *
  313. * TAPs for which no fields are passed are marked as bypassed for
  314. * subsequent DR SCANs.
  315. *
  316. */
  317. extern void jtag_add_ir_scan(int num_fields, scan_field_t* fields, tap_state_t endstate);
  318. /**
  319. * The same as jtag_add_ir_scan except no verification is performed out
  320. * the output values.
  321. */
  322. extern void jtag_add_ir_scan_noverify(int num_fields, const scan_field_t *fields, tap_state_t state);
  323. /**
  324. * Duplicate the scan fields passed into the function into an IR SCAN
  325. * command. This function assumes that the caller handles extra fields
  326. * for bypassed TAPs.
  327. */
  328. extern void jtag_add_plain_ir_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
  329. /**
  330. * Set in_value to point to 32 bits of memory to scan into. This
  331. * function is a way to handle the case of synchronous and asynchronous
  332. * JTAG queues.
  333. *
  334. * In the event of an asynchronous queue execution the queue buffer
  335. * allocation method is used, for the synchronous case the temporary 32
  336. * bits come from the input field itself.
  337. */
  338. extern void jtag_alloc_in_value32(scan_field_t *field);
  339. /**
  340. * Generate a DR SCAN using the fields passed to the function.
  341. * For connected TAPs, the function checks in_fields and uses fields
  342. * specified there. For bypassed TAPs, the function generates a dummy
  343. * 1-bit field. The bypass status of TAPs is set by jtag_add_ir_scan().
  344. */
  345. extern void jtag_add_dr_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
  346. /// A version of jtag_add_dr_scan() that uses the check_value/mask fields
  347. extern void jtag_add_dr_scan_check(int num_fields, scan_field_t* fields, tap_state_t endstate);
  348. /**
  349. * Duplicate the scan fields passed into the function into a DR SCAN
  350. * command. Unlike jtag_add_dr_scan(), this function assumes that the
  351. * caller handles extra fields for bypassed TAPs.
  352. */
  353. extern void jtag_add_plain_dr_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
  354. /**
  355. * Defines the type of data passed to the jtag_callback_t interface.
  356. * The underlying type must allow storing an @c int or pointer type.
  357. */
  358. typedef intptr_t jtag_callback_data_t;
  359. /**
  360. * Defines a simple JTAG callback that can allow conversions on data
  361. * scanned in from an interface.
  362. *
  363. * This callback should only be used for conversion that cannot fail.
  364. * For conversion types or checks that can fail, use the more complete
  365. * variant: jtag_callback_t.
  366. */
  367. typedef void (*jtag_callback1_t)(jtag_callback_data_t data0);
  368. /// A simpler version of jtag_add_callback4().
  369. extern void jtag_add_callback(jtag_callback1_t, jtag_callback_data_t data0);
  370. /**
  371. * Defines the interface of the JTAG callback mechanism.
  372. *
  373. * @param in the pointer to the data clocked in
  374. * @param data1 An integer big enough to use as an @c int or a pointer.
  375. * @param data2 An integer big enough to use as an @c int or a pointer.
  376. * @param data3 An integer big enough to use as an @c int or a pointer.
  377. * @returns an error code
  378. */
  379. typedef int (*jtag_callback_t)(jtag_callback_data_t data0, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3);
  380. /**
  381. * This callback can be executed immediately the queue has been flushed.
  382. *
  383. * The JTAG queue can be executed synchronously or asynchronously.
  384. * Typically for USB, the queue is executed asynchronously. For
  385. * low-latency interfaces, the queue may be executed synchronously.
  386. *
  387. * The callback mechanism is very general and does not make many
  388. * assumptions about what the callback does or what its arguments are.
  389. * These callbacks are typically executed *after* the *entire* JTAG
  390. * queue has been executed for e.g. USB interfaces, and they are
  391. * guaranteeed to be invoked in the order that they were queued.
  392. *
  393. * If the execution of the queue fails before the callbacks, then --
  394. * depending on driver implementation -- the callbacks may or may not be
  395. * invoked. @todo Can we make this behavior consistent?
  396. *
  397. * The strange name is due to C's lack of overloading using function
  398. * arguments.
  399. *
  400. * @param f The callback function to add.
  401. * @param data0 Typically used to point to the data to operate on.
  402. * Frequently this will be the data clocked in during a shift operation.
  403. * @param data1 An integer big enough to use as an @c int or a pointer.
  404. * @param data2 An integer big enough to use as an @c int or a pointer.
  405. * @param data3 An integer big enough to use as an @c int or a pointer.
  406. *
  407. */
  408. extern void jtag_add_callback4(jtag_callback_t f, jtag_callback_data_t data0,
  409. jtag_callback_data_t data1, jtag_callback_data_t data2,
  410. jtag_callback_data_t data3);
  411. /**
  412. * Run a TAP_RESET reset where the end state is TAP_RESET,
  413. * regardless of the start state.
  414. */
  415. extern void jtag_add_tlr(void);
  416. /**
  417. * Application code *must* assume that interfaces will
  418. * implement transitions between states with different
  419. * paths and path lengths through the state diagram. The
  420. * path will vary across interface and also across versions
  421. * of the same interface over time. Even if the OpenOCD code
  422. * is unchanged, the actual path taken may vary over time
  423. * and versions of interface firmware or PCB revisions.
  424. *
  425. * Use jtag_add_pathmove() when specific transition sequences
  426. * are required.
  427. *
  428. * Do not use jtag_add_pathmove() unless you need to, but do use it
  429. * if you have to.
  430. *
  431. * DANGER! If the target is dependent upon a particular sequence
  432. * of transitions for things to work correctly(e.g. as a workaround
  433. * for an errata that contradicts the JTAG standard), then pathmove
  434. * must be used, even if some jtag interfaces happen to use the
  435. * desired path. Worse, the jtag interface used for testing a
  436. * particular implementation, could happen to use the "desired"
  437. * path when transitioning to/from end
  438. * state.
  439. *
  440. * A list of unambigious single clock state transitions, not
  441. * all drivers can support this, but it is required for e.g.
  442. * XScale and Xilinx support
  443. *
  444. * Note! TAP_RESET must not be used in the path!
  445. *
  446. * Note that the first on the list must be reachable
  447. * via a single transition from the current state.
  448. *
  449. * All drivers are required to implement jtag_add_pathmove().
  450. * However, if the pathmove sequence can not be precisely
  451. * executed, an interface_jtag_add_pathmove() or jtag_execute_queue()
  452. * must return an error. It is legal, but not recommended, that
  453. * a driver returns an error in all cases for a pathmove if it
  454. * can only implement a few transitions and therefore
  455. * a partial implementation of pathmove would have little practical
  456. * application.
  457. *
  458. * If an error occurs, jtag_error will contain one of these error codes:
  459. * - ERROR_JTAG_NOT_STABLE_STATE -- The final state was not stable.
  460. * - ERROR_JTAG_STATE_INVALID -- The path passed through TAP_RESET.
  461. * - ERROR_JTAG_TRANSITION_INVALID -- The path includes invalid
  462. * state transitions.
  463. */
  464. extern void jtag_add_pathmove(int num_states, const tap_state_t* path);
  465. /**
  466. * jtag_add_statemove() moves from the current state to @a goal_state.
  467. *
  468. * @param goal_state The final TAP state.
  469. * @return ERROR_OK on success, or an error code on failure.
  470. *
  471. * Moves from the current state to the goal \a state.
  472. * Both states must be stable.
  473. */
  474. extern int jtag_add_statemove(tap_state_t goal_state);
  475. /**
  476. * Goes to TAP_IDLE (if we're not already there), cycle
  477. * precisely num_cycles in the TAP_IDLE state, after which move
  478. * to @a endstate (unless it is also TAP_IDLE).
  479. *
  480. * @param num_cycles Number of cycles in TAP_IDLE state. This argument
  481. * may be 0, in which case this routine will navigate to @a endstate
  482. * via TAP_IDLE.
  483. * @param endstate The final state.
  484. */
  485. extern void jtag_add_runtest(int num_cycles, tap_state_t endstate);
  486. /**
  487. * A reset of the TAP state machine can be requested.
  488. *
  489. * Whether tms or trst reset is used depends on the capabilities of
  490. * the target and jtag interface(reset_config command configures this).
  491. *
  492. * srst can driver a reset of the TAP state machine and vice
  493. * versa
  494. *
  495. * Application code may need to examine value of jtag_reset_config
  496. * to determine the proper codepath
  497. *
  498. * DANGER! Even though srst drives trst, trst might not be connected to
  499. * the interface, and it might actually be *harmful* to assert trst in this case.
  500. *
  501. * This is why combinations such as "reset_config srst_only srst_pulls_trst"
  502. * are supported.
  503. *
  504. * only req_tlr_or_trst and srst can have a transition for a
  505. * call as the effects of transitioning both at the "same time"
  506. * are undefined, but when srst_pulls_trst or vice versa,
  507. * then trst & srst *must* be asserted together.
  508. */
  509. extern void jtag_add_reset(int req_tlr_or_trst, int srst);
  510. /**
  511. * Function jtag_set_end_state
  512. *
  513. * Set a global variable to \a state if \a state != TAP_INVALID.
  514. *
  515. * Return the value of the global variable.
  516. *
  517. **/
  518. extern tap_state_t jtag_set_end_state(tap_state_t state);
  519. /**
  520. * Function jtag_get_end_state
  521. *
  522. * Return the value of the global variable for end state
  523. *
  524. **/
  525. extern tap_state_t jtag_get_end_state(void);
  526. extern void jtag_add_sleep(uint32_t us);
  527. /**
  528. * Function jtag_add_stable_clocks
  529. * first checks that the state in which the clocks are to be issued is
  530. * stable, then queues up clock_count clocks for transmission.
  531. */
  532. void jtag_add_clocks(int num_cycles);
  533. /**
  534. * For software FIFO implementations, the queued commands can be executed
  535. * during this call or earlier. A sw queue might decide to push out
  536. * some of the jtag_add_xxx() operations once the queue is "big enough".
  537. *
  538. * This fn will return an error code if any of the prior jtag_add_xxx()
  539. * calls caused a failure, e.g. check failure. Note that it does not
  540. * matter if the operation was executed *before* jtag_execute_queue(),
  541. * jtag_execute_queue() will still return an error code.
  542. *
  543. * All jtag_add_xxx() calls that have in_handler != NULL will have been
  544. * executed when this fn returns, but if what has been queued only
  545. * clocks data out, without reading anything back, then JTAG could
  546. * be running *after* jtag_execute_queue() returns. The API does
  547. * not define a way to flush a hw FIFO that runs *after*
  548. * jtag_execute_queue() returns.
  549. *
  550. * jtag_add_xxx() commands can either be executed immediately or
  551. * at some time between the jtag_add_xxx() fn call and jtag_execute_queue().
  552. */
  553. extern int jtag_execute_queue(void);
  554. /// same as jtag_execute_queue() but does not clear the error flag
  555. extern void jtag_execute_queue_noclear(void);
  556. /// @returns the number of times the scan queue has been flushed
  557. int jtag_get_flush_queue_count(void);
  558. /// Report Tcl event to all TAPs
  559. void jtag_notify_event(enum jtag_event);
  560. /* can be implemented by hw + sw */
  561. extern int jtag_power_dropout(int* dropout);
  562. extern int jtag_srst_asserted(int* srst_asserted);
  563. /* JTAG support functions */
  564. /**
  565. * Execute jtag queue and check value with an optional mask.
  566. * @param field Pointer to scan field.
  567. * @param value Pointer to scan value.
  568. * @param mask Pointer to scan mask; may be NULL.
  569. * @returns Nothing, but calls jtag_set_error() on any error.
  570. */
  571. extern void jtag_check_value_mask(scan_field_t *field, uint8_t *value, uint8_t *mask);
  572. extern void jtag_sleep(uint32_t us);
  573. /*
  574. * The JTAG subsystem defines a number of error codes,
  575. * using codes between -100 and -199.
  576. */
  577. #define ERROR_JTAG_INIT_FAILED (-100)
  578. #define ERROR_JTAG_INVALID_INTERFACE (-101)
  579. #define ERROR_JTAG_NOT_IMPLEMENTED (-102)
  580. #define ERROR_JTAG_TRST_ASSERTED (-103)
  581. #define ERROR_JTAG_QUEUE_FAILED (-104)
  582. #define ERROR_JTAG_NOT_STABLE_STATE (-105)
  583. #define ERROR_JTAG_DEVICE_ERROR (-107)
  584. #define ERROR_JTAG_STATE_INVALID (-108)
  585. #define ERROR_JTAG_TRANSITION_INVALID (-109)
  586. #define ERROR_JTAG_INIT_SOFT_FAIL (-110)
  587. /**
  588. * jtag_add_dr_out() is a version of jtag_add_dr_scan() which
  589. * only scans data out. It operates on 32 bit integers instead
  590. * of 8 bit, which makes it a better impedance match with
  591. * the calling code which often operate on 32 bit integers.
  592. *
  593. * Current or end_state can not be TAP_RESET. end_state can be TAP_INVALID
  594. *
  595. * num_bits[i] is the number of bits to clock out from value[i] LSB first.
  596. *
  597. * If the device is in bypass, then that is an error condition in
  598. * the caller code that is not detected by this fn, whereas
  599. * jtag_add_dr_scan() does detect it. Similarly if the device is not in
  600. * bypass, data must be passed to it.
  601. *
  602. * If anything fails, then jtag_error will be set and jtag_execute() will
  603. * return an error. There is no way to determine if there was a failure
  604. * during this function call.
  605. *
  606. * This is an inline fn to speed up embedded hosts. Also note that
  607. * interface_jtag_add_dr_out() can be a *small* inline function for
  608. * embedded hosts.
  609. *
  610. * There is no jtag_add_dr_outin() version of this fn that also allows
  611. * clocking data back in. Patches gladly accepted!
  612. */
  613. extern void jtag_add_dr_out(jtag_tap_t* tap,
  614. int num_fields, const int* num_bits, const uint32_t* value,
  615. tap_state_t end_state);
  616. /**
  617. * Set the current JTAG core execution error, unless one was set
  618. * by a previous call previously. Driver or application code must
  619. * use jtag_error_clear to reset jtag_error once this routine has been
  620. * called with a non-zero error code.
  621. */
  622. void jtag_set_error(int error);
  623. /// @returns The current value of jtag_error
  624. int jtag_get_error(void);
  625. /**
  626. * Resets jtag_error to ERROR_OK, returning its previous value.
  627. * @returns The previous value of @c jtag_error.
  628. */
  629. int jtag_error_clear(void);
  630. /**
  631. * Return true if it's safe for a background polling task to access the
  632. * JTAG scan chain. Polling may be explicitly disallowed, and is also
  633. * unsafe while nTRST is active or the JTAG clock is gated off.,
  634. */
  635. bool is_jtag_poll_safe(void);
  636. /**
  637. * Return flag reporting whether JTAG polling is disallowed.
  638. */
  639. bool jtag_poll_get_enabled(void);
  640. /**
  641. * Assign flag reporting whether JTAG polling is disallowed.
  642. */
  643. void jtag_poll_set_enabled(bool value);
  644. #endif /* JTAG_H */