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.
 
 
 
 
 
 

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