Make #include guard naming consistent
[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, see <http://www.gnu.org/licenses/>. *
23 ***************************************************************************/
24
25 #ifndef OPENOCD_JTAG_MINIDRIVER_H
26 #define OPENOCD_JTAG_MINIDRIVER_H
27
28 /**
29 * @page jtagminidriver JTAG Mini-Driver
30 *
31 * The JTAG minidriver interface allows the definition of alternate
32 * interface functions, instead of the built-in asynchronous driver
33 * module that is used by the standard JTAG interface drivers.
34 *
35 * In addtion to the functions defined in the @c minidriver.h file, the
36 * @c jtag_minidriver.h file must declare the following functions (or
37 * define static inline versions of them):
38 * - jtag_add_callback
39 * - jtag_add_callback4
40 *
41 * The following core functions are declared in this file for use by
42 * the minidriver and do @b not need to be defined by an implementation:
43 * - default_interface_jtag_execute_queue()
44 */
45
46 /* this header will be provided by the minidriver implementation, */
47 /* and it may provide additional declarations that must be defined. */
48 #include <jtag/minidriver_imp.h>
49
50 int interface_jtag_add_ir_scan(struct jtag_tap *active,
51 const struct scan_field *fields,
52 tap_state_t endstate);
53 int interface_jtag_add_plain_ir_scan(
54 int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
55 tap_state_t endstate);
56
57 int interface_jtag_add_dr_scan(struct jtag_tap *active,
58 int num_fields, const struct scan_field *fields,
59 tap_state_t endstate);
60 int interface_jtag_add_plain_dr_scan(
61 int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
62 tap_state_t endstate);
63
64 int interface_jtag_add_tlr(void);
65 int interface_jtag_add_pathmove(int num_states, const tap_state_t *path);
66 int interface_jtag_add_runtest(int num_cycles, tap_state_t endstate);
67
68 int interface_add_tms_seq(unsigned num_bits,
69 const uint8_t *bits, enum tap_state state);
70
71 /**
72 * This drives the actual srst and trst pins. srst will always be 0
73 * if jtag_reset_config & RESET_SRST_PULLS_TRST != 0 and ditto for
74 * trst.
75 *
76 * the higher level jtag_add_reset will invoke jtag_add_tlr() if
77 * approperiate
78 */
79 int interface_jtag_add_reset(int trst, int srst);
80 int interface_jtag_add_sleep(uint32_t us);
81 int interface_jtag_add_clocks(int num_cycles);
82 int interface_jtag_execute_queue(void);
83
84 /**
85 * Calls the interface callback to execute the queue. This routine
86 * is used by the JTAG driver layer and should not be called directly.
87 */
88 int default_interface_jtag_execute_queue(void);
89
90 #endif /* OPENOCD_JTAG_MINIDRIVER_H */