cfg: ftdi icdi enable srst open drain config
[fw/openocd] / src / jtag / minidriver.h
index 8bd801264f2b67501563885a1434e9359b6a7236..b13ef7284ec2620e8dbe9e25f310cfb0ed2bf829 100644 (file)
  *   Free Software Foundation, Inc.,                                       *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
+
 #ifndef MINIDRIVER_H
 #define MINIDRIVER_H
 
-/* @page jtagminidriver JTAG Mini-Driver
+/**
+ * @page jtagminidriver JTAG Mini-Driver
  *
  * The JTAG minidriver interface allows the definition of alternate
  * interface functions, instead of the built-in asynchronous driver
  * module that is used by the standard JTAG interface drivers.
  *
- * In addtion to the functions defined in the c minidriver.h file, the
+ * In addtion to the functions defined in the @c minidriver.h file, the
  * @c jtag_minidriver.h file must declare the following functions (or
  * define static inline versions of them):
  * - jtag_add_callback
  * - jtag_add_callback4
  * - interface_jtag_add_dr_out
- *  
+ *
  * The following core functions are declared in this file for use by
  * the minidriver and do @b not need to be defined by an implementation:
  * - default_interface_jtag_execute_queue()
  */
 
-#ifdef HAVE_JTAG_MINIDRIVER_H
-
-#include "jtag_minidriver.h"
-
-static inline void interface_jtag_alloc_in_value32(scan_field_t *field)
-{
-       field->in_value = field->intmp;
-}
-
-static inline void interface_jtag_add_scan_check_alloc(scan_field_t *field)
-{
-       /* We're executing this synchronously, so try to use local storage. */
-       if (field->num_bits > 32)
-       {
-               unsigned num_bytes = TAP_SCAN_BYTES(field->num_bits);
-               field->in_value = (u8 *)malloc(num_bytes);
-               field->allocated = 1;
-       }
-       else
-               field->in_value = field->intmp;
-}
-
-#else
-
-#include "commands.h"
+/* this header will be provided by the minidriver implementation, */
+/* and it may provide additional declarations that must be defined. */
+#include <jtag/minidriver_imp.h>
 
-static inline void interface_jtag_alloc_in_value32(scan_field_t *field)
-{
-       field->in_value = (u8 *)cmd_queue_alloc(4);
-}
-
-static inline void interface_jtag_add_scan_check_alloc(scan_field_t *field)
-{
-       unsigned num_bytes = TAP_SCAN_BYTES(field->num_bits);
-       field->in_value = (u8 *)cmd_queue_alloc(num_bytes);
-}
-
-extern void interface_jtag_add_dr_out(jtag_tap_t* tap,
-               int num_fields, const int* num_bits, const u32* value,
-               tap_state_t end_state);
-
-extern void interface_jtag_add_callback(jtag_callback1_t f, u8 *in);
-
-extern void interface_jtag_add_callback4(jtag_callback_t f, u8 *in,
-               jtag_callback_data_t data1, jtag_callback_data_t data2,
-               jtag_callback_data_t data3);
-
-#endif
-
-extern int interface_jtag_add_ir_scan(
-               int num_fields, const scan_field_t* fields,
+int interface_jtag_add_ir_scan(struct jtag_tap *active,
+               const struct scan_field *fields,
                tap_state_t endstate);
-extern int interface_jtag_add_plain_ir_scan(
-               int num_fields, const scan_field_t* fields,
+int interface_jtag_add_plain_ir_scan(
+               int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
                tap_state_t endstate);
 
-extern int interface_jtag_add_dr_scan(
-               int num_fields, const scan_field_t* fields,
+int interface_jtag_add_dr_scan(struct jtag_tap *active,
+               int num_fields, const struct scan_field *fields,
                tap_state_t endstate);
-extern int interface_jtag_add_plain_dr_scan(
-               int num_fields, const scan_field_t* fields,
+int interface_jtag_add_plain_dr_scan(
+               int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
                tap_state_t endstate);
 
-extern int interface_jtag_add_tlr(void);
-extern int interface_jtag_add_pathmove(int num_states, const tap_state_t* path);
-extern int interface_jtag_add_runtest(int num_cycles, tap_state_t endstate);
+int interface_jtag_add_tlr(void);
+int interface_jtag_add_pathmove(int num_states, const tap_state_t *path);
+int interface_jtag_add_runtest(int num_cycles, tap_state_t endstate);
+
+int interface_add_tms_seq(unsigned num_bits,
+               const uint8_t *bits, enum tap_state state);
 
 /**
  * This drives the actual srst and trst pins. srst will always be 0
@@ -119,17 +79,15 @@ extern int interface_jtag_add_runtest(int num_cycles, tap_state_t endstate);
  * the higher level jtag_add_reset will invoke jtag_add_tlr() if
  * approperiate
  */
-extern int interface_jtag_add_reset(int trst, int srst);
-extern int interface_jtag_set_end_state(tap_state_t endstate);
-extern int interface_jtag_add_sleep(u32 us);
-extern int interface_jtag_add_clocks(int num_cycles);
-extern int interface_jtag_execute_queue(void);
+int interface_jtag_add_reset(int trst, int srst);
+int interface_jtag_add_sleep(uint32_t us);
+int interface_jtag_add_clocks(int num_cycles);
+int interface_jtag_execute_queue(void);
 
 /**
  * Calls the interface callback to execute the queue.  This routine
  * is used by the JTAG driver layer and should not be called directly.
  */
-extern int default_interface_jtag_execute_queue(void);
-
+int default_interface_jtag_execute_queue(void);
 
-#endif // MINIDRIVER_H
+#endif /* MINIDRIVER_H */