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