Duane Ellis: fix warnings
[fw/openocd] / src / jtag / jtag.h
index 114e6aa360b3edd59a1b52d28dd28f212c8b119b..347777e496829aaf50a7a039377ae1420161f8f0 100644 (file)
@@ -2,6 +2,9 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
+ *   Copyright (C) 2007,2008 Ã˜yvind Harboe                                      *
+ *   oyvind.harboe@zylin.com                                               *
+ *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
@@ -198,6 +201,9 @@ typedef struct jtag_interface_s
        /* returns JTAG maxium speed for KHz. 0=RTCK. The function returns
        a failure if it can't support the KHz/RTCK. */
        int (*khz)(int khz, int *jtag_speed);
+       /* returns the KHz for the provided JTAG speed. 0=RTCK. The function returns
+       a failure if it can't support the KHz/RTCK. */
+       int (*speed_div)(int speed, int *khz);
        
 } jtag_interface_t;
 
@@ -241,8 +247,16 @@ enum reset_types
 
 extern enum reset_types jtag_reset_config;
 
-/* JTAG subsystem */
+/* initialize interface upon startup. A successful no-op 
+ * upon subsequent invocations
+ */
+extern int jtag_interface_init(struct command_context_s *cmd_ctx);
+/* initialize JTAG chain using only a TLR reset. If init fails,
+ * try reset + init.
+ */
 extern int jtag_init(struct command_context_s *cmd_ctx);
+/* reset, then initialize JTAG chain */
+extern int jtag_init_reset(struct command_context_s *cmd_ctx);
 extern int jtag_register_commands(struct command_context_s *cmd_ctx);
 
 /* JTAG interface, can be implemented with a software or hardware fifo
@@ -268,8 +282,8 @@ extern int interface_jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields
 /* run a TAP_TLR reset. End state is TAP_TLR, regardless
  * of start state.
  */
-extern void jtag_add_tms();
-extern int interface_jtag_add_tms();
+extern void jtag_add_tlr(void);
+extern int interface_jtag_add_tlr(void);
 /* Do not use jtag_add_pathmove() unless you need to, but do use it
  * if you have to. 
  *
@@ -305,6 +319,9 @@ extern int interface_jtag_add_pathmove(int num_states, enum tap_state *path);
 /* go to TAP_RTI, if we're not already there and cycle
  * precisely num_cycles in the TAP_RTI after which move
  * to the end state, if it is != TAP_RTI
+ * 
+ * nb! num_cycles can be 0, in which case the fn will navigate
+ * to endstate via TAP_RTI
  */
 extern void jtag_add_runtest(int num_cycles, enum tap_state endstate);
 extern int interface_jtag_add_runtest(int num_cycles, enum tap_state endstate);
@@ -325,13 +342,17 @@ extern int interface_jtag_add_runtest(int num_cycles, enum tap_state endstate);
  * This is why combinations such as "reset_config srst_only srst_pulls_trst"
  * are supported. 
  *
+ * only req_tlr_or_trst and srst can have a transition for a
+ * call as the effects of transitioning both at the "same time" 
+ * are undefined, but when srst_pulls_trst or vice versa,
+ * then trst & srst *must* be asserted together.
  */
-extern void jtag_add_reset(int req_tms_or_trst, int srst);
+extern void jtag_add_reset(int req_tlr_or_trst, int srst);
 /* this drives the actual srst and trst pins. srst will always be 0
  * if jtag_reset_config & RESET_SRST_PULLS_TRST != 0 and ditto for
  * trst.
  * 
- * the higher level jtag_add_reset will invoke jtag_add_tms() if 
+ * the higher level jtag_add_reset will invoke jtag_add_tlr() if 
  * approperiate
  */
 extern int interface_jtag_add_reset(int trst, int srst);
@@ -417,8 +438,8 @@ extern int jtag_verify_capture_ir;
  */
 extern void interface_jtag_add_dr_out(int device, 
                int num_fields,
-               int *num_bits,
-               u32 *value,
+               const int *num_bits,
+               const u32 *value,
                enum tap_state end_state);
 #endif
 
@@ -427,8 +448,8 @@ extern void interface_jtag_add_dr_out(int device,
 
 static __inline__ void jtag_add_dr_out(int device, 
                int num_fields,
-               int *num_bits,
-               u32 *value,
+               const int *num_bits,
+               const u32 *value,
                enum tap_state end_state)
 {
        if (end_state != -1)