- added myself to copyright on files i remember adding large contributions for over...

[fw/openocd] / src / jtag / jtag.h

diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h
index f5818b988f07e55abc4b0f83b953b51333c749b4..d70ec2c894b3ced75e78a13aa080c5e7d2eda814 100644 (file)
--- a/src/jtag/jtag.h
+++ b/src/jtag/jtag.h
@@ -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     *
@@ -196,11 +199,17 @@ typedef struct jtag_interface_s
        int (*init)(void);
        int (*quit)(void);
        /* returns JTAG maxium speed for KHz. 0=RTCK. The function returns
-       a failure if it can't support the KHz/RTCK. */
+       a failure if it can't support the KHz/RTCK. 
+       
+       WARNING!!!! if RTCK is *slow* then think carefully about
+       whether you actually want to support this in the driver.
+       Many target scripts are written to handle the absence of RTCK
+       and use a fallback kHz TCK.
+       */
        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 (*speedDiv)(int speed, int *khz);
+       int (*speed_div)(int speed, int *khz);
        
 } jtag_interface_t;
 
@@ -279,8 +288,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_tlr();
-extern int interface_jtag_add_tlr();
+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. 
  *
@@ -316,6 +325,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);
@@ -432,8 +444,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
 
@@ -442,8 +454,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)