remove #if HAVE_JTAG_INTERFACE_H from minidriver.h
[openocd.git] / src / jtag / minidriver.h
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 * Copyright (C) 2009 Zachary T Welch *
9 * zw@superlucidity.net *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
26 #ifndef MINIDRIVER_H
27 #define MINIDRIVER_H
28
29 /**
30 * @page jtagminidriver JTAG Mini-Driver
31 *
32 * The JTAG minidriver interface allows the definition of alternate
33 * interface functions, instead of the built-in asynchronous driver
34 * module that is used by the standard JTAG interface drivers.
35 *
36 * In addtion to the functions defined in the @c minidriver.h file, the
37 * @c jtag_minidriver.h file must declare the following functions (or
38 * define static inline versions of them):
39 * - jtag_add_callback
40 * - jtag_add_callback4
41 * - interface_jtag_add_dr_out
42 *
43 * The following core functions are declared in this file for use by
44 * the minidriver and do @b not need to be defined by an implementation:
45 * - default_interface_jtag_execute_queue()
46 */
47
48 // this header will be provided by the minidriver implementation,
49 // and it may provide additional declarations that must be defined.
50 #include "minidriver_imp.h"
51
52 int interface_jtag_add_ir_scan(
53 int num_fields, const struct scan_field* fields,
54 tap_state_t endstate);
55 int interface_jtag_add_plain_ir_scan(
56 int num_fields, const struct scan_field* fields,
57 tap_state_t endstate);
58
59 int interface_jtag_add_dr_scan(
60 int num_fields, const struct scan_field* fields,
61 tap_state_t endstate);
62 int interface_jtag_add_plain_dr_scan(
63 int num_fields, const struct scan_field* fields,
64 tap_state_t endstate);
65
66 int interface_jtag_add_tlr(void);
67 int interface_jtag_add_pathmove(int num_states, const tap_state_t* path);
68 int interface_jtag_add_runtest(int num_cycles, tap_state_t endstate);
69
70 /**
71 * This drives the actual srst and trst pins. srst will always be 0
72 * if jtag_reset_config & RESET_SRST_PULLS_TRST != 0 and ditto for
73 * trst.
74 *
75 * the higher level jtag_add_reset will invoke jtag_add_tlr() if
76 * approperiate
77 */
78 int interface_jtag_add_reset(int trst, int srst);
79 int interface_jtag_add_sleep(uint32_t us);
80 int interface_jtag_add_clocks(int num_cycles);
81 int interface_jtag_execute_queue(void);
82
83 /**
84 * Calls the interface callback to execute the queue. This routine
85 * is used by the JTAG driver layer and should not be called directly.
86 */
87 int default_interface_jtag_execute_queue(void);
88
89 #endif // MINIDRIVER_H