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.
 
 
 
 
 
 

525 lines
18 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 "types.h"
  26. #include "binarybuffer.h"
  27. #include "log.h"
  28. #include "command.h"
  29. #if 0
  30. #define _DEBUG_JTAG_IO_
  31. #endif
  32. /* 16 Tap States, from page 21 of ASSET InterTech, Inc.'s svf.pdf
  33. */
  34. enum tap_state
  35. {
  36. TAP_RESET = 0x0, TAP_IDLE = 0x8,
  37. TAP_DRSELECT = 0x1, TAP_DRCAPTURE = 0x2, TAP_DRSHIFT = 0x3, TAP_DREXIT1 = 0x4,
  38. TAP_DRPAUSE = 0x5, TAP_DREXIT2 = 0x6, TAP_DRUPDATE = 0x7,
  39. TAP_IRSELECT = 0x9, TAP_IRCAPTURE = 0xa, TAP_IRSHIFT = 0xb, TAP_IREXIT1 = 0xc,
  40. TAP_IRPAUSE = 0xd, TAP_IREXIT2 = 0xe, TAP_IRUPDATE = 0xf
  41. };
  42. typedef struct tap_transition_s
  43. {
  44. enum tap_state high;
  45. enum tap_state low;
  46. } tap_transition_t;
  47. extern char* tap_state_strings[16];
  48. extern int tap_move_map[16]; /* map 16 TAP states to 6 stable states */
  49. extern u8 tap_move[6][6]; /* value scanned to TMS to move from one of six stable states to another */
  50. extern tap_transition_t tap_transitions[16]; /* describe the TAP state diagram */
  51. extern enum tap_state end_state; /* finish DR scans in dr_end_state */
  52. extern enum tap_state cur_state; /* current TAP state */
  53. extern enum tap_state cmd_queue_end_state; /* finish DR scans in dr_end_state */
  54. extern enum tap_state cmd_queue_cur_state; /* current TAP state */
  55. #define TAP_MOVE(from, to) tap_move[tap_move_map[from]][tap_move_map[to]]
  56. typedef void * error_handler_t; /* Later on we can delete error_handler_t, but keep it for now to make patches more readable */
  57. struct scan_field_s;
  58. typedef int (*in_handler_t)(u8 *in_value, void *priv, struct scan_field_s *field);
  59. typedef struct scan_field_s
  60. {
  61. jtag_tap_t *tap; /* tap pointer this instruction refers to */
  62. int num_bits; /* number of bits this field specifies (up to 32) */
  63. u8 *out_value; /* value to be scanned into the device */
  64. u8 *out_mask; /* only masked bits care */
  65. u8 *in_value; /* pointer to a 32-bit memory location to take data scanned out */
  66. /* in_check_value/mask, in_handler_error_handler, in_handler_priv can be used by the in handler, otherwise they contain garbage */
  67. u8 *in_check_value; /* used to validate scan results */
  68. u8 *in_check_mask; /* check specified bits against check_value */
  69. in_handler_t in_handler; /* process received buffer using this handler */
  70. void *in_handler_priv; /* additional information for the in_handler */
  71. } scan_field_t;
  72. enum scan_type
  73. {
  74. /* IN: from device to host, OUT: from host to device */
  75. SCAN_IN = 1, SCAN_OUT = 2, SCAN_IO = 3
  76. };
  77. typedef struct scan_command_s
  78. {
  79. int ir_scan; /* instruction/not data scan */
  80. int num_fields; /* number of fields in *fields array */
  81. scan_field_t *fields; /* pointer to an array of data scan fields */
  82. enum tap_state end_state; /* TAP state in which JTAG commands should finish */
  83. } scan_command_t;
  84. typedef struct statemove_command_s
  85. {
  86. enum tap_state end_state; /* TAP state in which JTAG commands should finish */
  87. } statemove_command_t;
  88. typedef struct pathmove_command_s
  89. {
  90. int num_states; /* number of states in *path */
  91. enum tap_state *path; /* states that have to be passed */
  92. } pathmove_command_t;
  93. typedef struct runtest_command_s
  94. {
  95. int num_cycles; /* number of cycles that should be spent in Run-Test/Idle */
  96. enum tap_state end_state; /* TAP state in which JTAG commands should finish */
  97. } runtest_command_t;
  98. typedef struct reset_command_s
  99. {
  100. int trst; /* trst/srst 0: deassert, 1: assert, -1: don't change */
  101. int srst;
  102. } reset_command_t;
  103. typedef struct end_state_command_s
  104. {
  105. enum tap_state end_state; /* TAP state in which JTAG commands should finish */
  106. } end_state_command_t;
  107. typedef struct sleep_command_s
  108. {
  109. u32 us; /* number of microseconds to sleep */
  110. } sleep_command_t;
  111. typedef union jtag_command_container_u
  112. {
  113. scan_command_t *scan;
  114. statemove_command_t *statemove;
  115. pathmove_command_t *pathmove;
  116. runtest_command_t *runtest;
  117. reset_command_t *reset;
  118. end_state_command_t *end_state;
  119. sleep_command_t *sleep;
  120. } jtag_command_container_t;
  121. enum jtag_command_type
  122. {
  123. JTAG_SCAN = 1,
  124. JTAG_STATEMOVE = 2, JTAG_RUNTEST = 3,
  125. JTAG_RESET = 4, JTAG_END_STATE = 5,
  126. JTAG_PATHMOVE = 6, JTAG_SLEEP = 7
  127. };
  128. typedef struct jtag_command_s
  129. {
  130. jtag_command_container_t cmd;
  131. enum jtag_command_type type;
  132. struct jtag_command_s *next;
  133. } jtag_command_t;
  134. extern jtag_command_t *jtag_command_queue;
  135. // this is really: typedef jtag_tap_t
  136. // But - the typedef is done in "types.h"
  137. // due to "forward decloration reasons"
  138. struct jtag_tap_s
  139. {
  140. const char *chip;
  141. const char *tapname;
  142. const char *dotted_name;
  143. int abs_chain_position;
  144. int enabled;
  145. int ir_length; /* size of instruction register */
  146. u32 ir_capture_value;
  147. u8 *expected; /* Capture-IR expected value */
  148. u32 ir_capture_mask;
  149. u8 *expected_mask; /* Capture-IR expected mask */
  150. u32 idcode; /* device identification code */
  151. u32 *expected_ids; /* Array of expected identification codes */
  152. u8 expected_ids_cnt;/* Number of expected identification codes */
  153. u8 *cur_instr; /* current instruction */
  154. int bypass; /* bypass register selected */
  155. jtag_tap_t *next_tap;
  156. };
  157. extern jtag_tap_t *jtag_AllTaps(void);
  158. extern jtag_tap_t *jtag_TapByPosition(int n);
  159. extern jtag_tap_t *jtag_TapByPosition( int n );
  160. extern jtag_tap_t *jtag_TapByString( const char *dotted_name );
  161. extern jtag_tap_t *jtag_TapByJimObj( Jim_Interp *interp, Jim_Obj *obj );
  162. extern jtag_tap_t *jtag_TapByAbsPosition( int abs_position );
  163. extern int jtag_NumEnabledTaps(void);
  164. extern int jtag_NumTotalTaps(void);
  165. static __inline__ jtag_tap_t *
  166. jtag_NextEnabledTap( jtag_tap_t *p )
  167. {
  168. if( p == NULL ){
  169. // start at the head of list
  170. p = jtag_AllTaps();
  171. } else {
  172. // start *after* this one
  173. p = p->next_tap;
  174. }
  175. while( p ){
  176. if( p->enabled ){
  177. break;
  178. } else {
  179. p = p->next_tap;
  180. }
  181. }
  182. return p;
  183. }
  184. enum reset_line_mode
  185. {
  186. LINE_OPEN_DRAIN = 0x0,
  187. LINE_PUSH_PULL = 0x1,
  188. };
  189. typedef struct jtag_interface_s
  190. {
  191. char* name;
  192. /* queued command execution
  193. */
  194. int (*execute_queue)(void);
  195. /* interface initalization
  196. */
  197. int (*speed)(int speed);
  198. int (*register_commands)(struct command_context_s *cmd_ctx);
  199. int (*init)(void);
  200. int (*quit)(void);
  201. /* returns JTAG maxium speed for KHz. 0=RTCK. The function returns
  202. a failure if it can't support the KHz/RTCK.
  203. WARNING!!!! if RTCK is *slow* then think carefully about
  204. whether you actually want to support this in the driver.
  205. Many target scripts are written to handle the absence of RTCK
  206. and use a fallback kHz TCK.
  207. */
  208. int (*khz)(int khz, int *jtag_speed);
  209. /* returns the KHz for the provided JTAG speed. 0=RTCK. The function returns
  210. a failure if it can't support the KHz/RTCK. */
  211. int (*speed_div)(int speed, int *khz);
  212. /* Read and clear the power dropout flag. Note that a power dropout
  213. can be transitionary, easily much less than a ms.
  214. So to find out if the power is *currently* on, you must invoke
  215. this method twice. Once to clear the power dropout flag and a
  216. second time to read the current state.
  217. Currently the default implementation is never to detect power dropout.
  218. */
  219. int (*power_dropout)(int *power_dropout);
  220. /* Read and clear the srst asserted detection flag.
  221. *
  222. * NB!!!! like power_dropout this does *not* read the current
  223. * state. srst assertion is transitionary and *can* be much
  224. * less than 1ms.
  225. */
  226. int (*srst_asserted)(int *srst_asserted);
  227. } jtag_interface_t;
  228. enum jtag_event
  229. {
  230. JTAG_TRST_ASSERTED
  231. };
  232. extern char* jtag_event_strings[];
  233. extern int jtag_trst;
  234. extern int jtag_srst;
  235. typedef struct jtag_event_callback_s
  236. {
  237. int (*callback)(enum jtag_event event, void *priv);
  238. void *priv;
  239. struct jtag_event_callback_s *next;
  240. } jtag_event_callback_t;
  241. extern jtag_event_callback_t *jtag_event_callbacks;
  242. extern jtag_interface_t *jtag; /* global pointer to configured JTAG interface */
  243. extern enum tap_state end_state;
  244. extern enum tap_state cur_state;
  245. extern int jtag_speed;
  246. extern int jtag_speed_post_reset;
  247. enum reset_types
  248. {
  249. RESET_NONE = 0x0,
  250. RESET_HAS_TRST = 0x1,
  251. RESET_HAS_SRST = 0x2,
  252. RESET_TRST_AND_SRST = 0x3,
  253. RESET_SRST_PULLS_TRST = 0x4,
  254. RESET_TRST_PULLS_SRST = 0x8,
  255. RESET_TRST_OPEN_DRAIN = 0x10,
  256. RESET_SRST_PUSH_PULL = 0x20,
  257. };
  258. extern enum reset_types jtag_reset_config;
  259. /* initialize interface upon startup. A successful no-op
  260. * upon subsequent invocations
  261. */
  262. extern int jtag_interface_init(struct command_context_s *cmd_ctx);
  263. /* initialize JTAG chain using only a RESET reset. If init fails,
  264. * try reset + init.
  265. */
  266. extern int jtag_init(struct command_context_s *cmd_ctx);
  267. /* reset, then initialize JTAG chain */
  268. extern int jtag_init_reset(struct command_context_s *cmd_ctx);
  269. extern int jtag_register_commands(struct command_context_s *cmd_ctx);
  270. /* JTAG interface, can be implemented with a software or hardware fifo
  271. *
  272. * TAP_DRSHIFT and TAP_IRSHIFT are illegal end states. TAP_DRSHIFT/IRSHIFT as end states
  273. * can be emulated by using a larger scan.
  274. *
  275. * Code that is relatively insensitive to the path(as long
  276. * as it is JTAG compliant) taken through state machine can use
  277. * endstate for jtag_add_xxx_scan(). Otherwise the pause state must be
  278. * specified as end state and a subsequent jtag_add_pathmove() must
  279. * be issued.
  280. *
  281. */
  282. extern void jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
  283. extern int interface_jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
  284. extern void jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
  285. extern int interface_jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
  286. extern void jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
  287. extern int interface_jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
  288. extern void jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
  289. extern int interface_jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
  290. /* run a TAP_RESET reset. End state is TAP_RESET, regardless
  291. * of start state.
  292. */
  293. extern void jtag_add_tlr(void);
  294. extern int interface_jtag_add_tlr(void);
  295. /* Do not use jtag_add_pathmove() unless you need to, but do use it
  296. * if you have to.
  297. *
  298. * DANGER! If the target is dependent upon a particular sequence
  299. * of transitions for things to work correctly(e.g. as a workaround
  300. * for an errata that contradicts the JTAG standard), then pathmove
  301. * must be used, even if some jtag interfaces happen to use the
  302. * desired path. Worse, the jtag interface used for testing a
  303. * particular implementation, could happen to use the "desired"
  304. * path when transitioning to/from end
  305. * state.
  306. *
  307. * A list of unambigious single clock state transitions, not
  308. * all drivers can support this, but it is required for e.g.
  309. * XScale and Xilinx support
  310. *
  311. * Note! TAP_RESET must not be used in the path!
  312. *
  313. * Note that the first on the list must be reachable
  314. * via a single transition from the current state.
  315. *
  316. * All drivers are required to implement jtag_add_pathmove().
  317. * However, if the pathmove sequence can not be precisely
  318. * executed, an interface_jtag_add_pathmove() or jtag_execute_queue()
  319. * must return an error. It is legal, but not recommended, that
  320. * a driver returns an error in all cases for a pathmove if it
  321. * can only implement a few transitions and therefore
  322. * a partial implementation of pathmove would have little practical
  323. * application.
  324. */
  325. extern void jtag_add_pathmove(int num_states, enum tap_state *path);
  326. extern int interface_jtag_add_pathmove(int num_states, enum tap_state *path);
  327. /* go to TAP_IDLE, if we're not already there and cycle
  328. * precisely num_cycles in the TAP_IDLE after which move
  329. * to the end state, if it is != TAP_IDLE
  330. *
  331. * nb! num_cycles can be 0, in which case the fn will navigate
  332. * to endstate via TAP_IDLE
  333. */
  334. extern void jtag_add_runtest(int num_cycles, enum tap_state endstate);
  335. extern int interface_jtag_add_runtest(int num_cycles, enum tap_state endstate);
  336. /* A reset of the TAP state machine can be requested.
  337. *
  338. * Whether tms or trst reset is used depends on the capabilities of
  339. * the target and jtag interface(reset_config command configures this).
  340. *
  341. * srst can driver a reset of the TAP state machine and vice
  342. * versa
  343. *
  344. * Application code may need to examine value of jtag_reset_config
  345. * to determine the proper codepath
  346. *
  347. * DANGER! Even though srst drives trst, trst might not be connected to
  348. * the interface, and it might actually be *harmful* to assert trst in this case.
  349. *
  350. * This is why combinations such as "reset_config srst_only srst_pulls_trst"
  351. * are supported.
  352. *
  353. * only req_tlr_or_trst and srst can have a transition for a
  354. * call as the effects of transitioning both at the "same time"
  355. * are undefined, but when srst_pulls_trst or vice versa,
  356. * then trst & srst *must* be asserted together.
  357. */
  358. extern void jtag_add_reset(int req_tlr_or_trst, int srst);
  359. /* this drives the actual srst and trst pins. srst will always be 0
  360. * if jtag_reset_config & RESET_SRST_PULLS_TRST != 0 and ditto for
  361. * trst.
  362. *
  363. * the higher level jtag_add_reset will invoke jtag_add_tlr() if
  364. * approperiate
  365. */
  366. extern int interface_jtag_add_reset(int trst, int srst);
  367. extern void jtag_add_end_state(enum tap_state endstate);
  368. extern int interface_jtag_add_end_state(enum tap_state endstate);
  369. extern void jtag_add_sleep(u32 us);
  370. extern int interface_jtag_add_sleep(u32 us);
  371. /*
  372. * For software FIFO implementations, the queued commands can be executed
  373. * during this call or earlier. A sw queue might decide to push out
  374. * some of the jtag_add_xxx() operations once the queue is "big enough".
  375. *
  376. * This fn will return an error code if any of the prior jtag_add_xxx()
  377. * calls caused a failure, e.g. check failure. Note that it does not
  378. * matter if the operation was executed *before* jtag_execute_queue(),
  379. * jtag_execute_queue() will still return an error code.
  380. *
  381. * All jtag_add_xxx() calls that have in_handler!=NULL will have been
  382. * executed when this fn returns, but if what has been queued only
  383. * clocks data out, without reading anything back, then JTAG could
  384. * be running *after* jtag_execute_queue() returns. The API does
  385. * not define a way to flush a hw FIFO that runs *after*
  386. * jtag_execute_queue() returns.
  387. *
  388. * jtag_add_xxx() commands can either be executed immediately or
  389. * at some time between the jtag_add_xxx() fn call and jtag_execute_queue().
  390. */
  391. extern int jtag_execute_queue(void);
  392. /* can be implemented by hw+sw */
  393. extern int interface_jtag_execute_queue(void);
  394. extern int jtag_power_dropout(int *dropout);
  395. extern int jtag_srst_asserted(int *srst_asserted);
  396. /* JTAG support functions */
  397. extern void jtag_set_check_value(scan_field_t *field, u8 *value, u8 *mask, error_handler_t *in_error_handler);
  398. extern enum scan_type jtag_scan_type(scan_command_t *cmd);
  399. extern int jtag_scan_size(scan_command_t *cmd);
  400. extern int jtag_read_buffer(u8 *buffer, scan_command_t *cmd);
  401. extern int jtag_build_buffer(scan_command_t *cmd, u8 **buffer);
  402. extern void jtag_sleep(u32 us);
  403. extern int jtag_call_event_callbacks(enum jtag_event event);
  404. extern int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv);
  405. extern int jtag_verify_capture_ir;
  406. /* error codes
  407. * JTAG subsystem uses codes between -100 and -199 */
  408. #define ERROR_JTAG_INIT_FAILED (-100)
  409. #define ERROR_JTAG_INVALID_INTERFACE (-101)
  410. #define ERROR_JTAG_NOT_IMPLEMENTED (-102)
  411. #define ERROR_JTAG_TRST_ASSERTED (-103)
  412. #define ERROR_JTAG_QUEUE_FAILED (-104)
  413. #define ERROR_JTAG_DEVICE_ERROR (-107)
  414. /* this allows JTAG devices to implement the entire jtag_xxx() layer in hw/sw */
  415. #ifdef HAVE_JTAG_MINIDRIVER_H
  416. /* Here a #define MINIDRIVER() and an inline version of hw fifo interface_jtag_add_dr_out can be defined */
  417. #include "jtag_minidriver.h"
  418. #define MINIDRIVER(a) notused ## a
  419. #else
  420. #define MINIDRIVER(a) a
  421. /* jtag_add_dr_out() is a faster version of jtag_add_dr_scan()
  422. *
  423. * Current or end_state can not be TAP_RESET. end_state can be -1
  424. *
  425. * num_bits[i] is the number of bits to clock out from value[i] LSB first.
  426. *
  427. * If the device is in bypass, then that is an error condition in
  428. * the caller code that is not detected by this fn, whereas jtag_add_dr_scan()
  429. * does detect it. Similarly if the device is not in bypass, data must
  430. * be passed to it.
  431. *
  432. * If anything fails, then jtag_error will be set and jtag_execute() will
  433. * return an error. There is no way to determine if there was a failure
  434. * during this function call.
  435. *
  436. * Note that this jtag_add_dr_out can be defined as an inline function.
  437. */
  438. extern void interface_jtag_add_dr_out(jtag_tap_t *tap,
  439. int num_fields,
  440. const int *num_bits,
  441. const u32 *value,
  442. enum tap_state end_state);
  443. #endif
  444. static __inline__ void jtag_add_dr_out(jtag_tap_t *tap,
  445. int num_fields,
  446. const int *num_bits,
  447. const u32 *value,
  448. enum tap_state end_state)
  449. {
  450. if (end_state != -1)
  451. cmd_queue_end_state=end_state;
  452. cmd_queue_cur_state=cmd_queue_end_state;
  453. interface_jtag_add_dr_out(tap, num_fields, num_bits, value, cmd_queue_end_state);
  454. }
  455. #endif /* JTAG_H */