Add header file for JTAG minidriver:
[fw/openocd] / 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 /* @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  * - interface_jtag_add_dr_out
41  *  
42  * The following core functions are declared in this file for use by
43  * the minidriver and do @b not need to be defined by an implementation:
44  * - default_interface_jtag_execute_queue()
45  */
46
47 #ifdef HAVE_JTAG_MINIDRIVER_H
48
49 #include "jtag_minidriver.h"
50
51 static inline void interface_jtag_alloc_in_value32(scan_field_t *field)
52 {
53         field->in_value = field->intmp;
54 }
55
56 static inline void interface_jtag_add_scan_check_alloc(scan_field_t *field)
57 {
58         /* We're executing this synchronously, so try to use local storage. */
59         if (field->num_bits > 32)
60         {
61                 unsigned num_bytes = TAP_SCAN_BYTES(field->num_bits);
62                 field->in_value = (u8 *)malloc(num_bytes);
63                 field->allocated = 1;
64         }
65         else
66                 field->in_value = field->intmp;
67 }
68
69 #else
70
71 static inline void interface_jtag_alloc_in_value32(scan_field_t *field)
72 {
73         field->in_value = (u8 *)cmd_queue_alloc(4);
74 }
75
76 static inline void interface_jtag_add_scan_check_alloc(scan_field_t *field)
77 {
78         unsigned num_bytes = TAP_SCAN_BYTES(field->num_bits);
79         field->in_value = (u8 *)cmd_queue_alloc(num_bytes);
80 }
81
82 extern void interface_jtag_add_dr_out(jtag_tap_t* tap,
83                 int num_fields, const int* num_bits, const u32* value,
84                 tap_state_t end_state);
85
86 #endif
87
88 extern int interface_jtag_add_ir_scan(
89                 int num_fields, const scan_field_t* fields,
90                 tap_state_t endstate);
91 extern int interface_jtag_add_plain_ir_scan(
92                 int num_fields, const scan_field_t* fields,
93                 tap_state_t endstate);
94
95 extern int interface_jtag_add_dr_scan(
96                 int num_fields, const scan_field_t* fields,
97                 tap_state_t endstate);
98 extern int interface_jtag_add_plain_dr_scan(
99                 int num_fields, const scan_field_t* fields,
100                 tap_state_t endstate);
101
102 extern int interface_jtag_add_tlr(void);
103 extern int interface_jtag_add_pathmove(int num_states, const tap_state_t* path);
104 extern int interface_jtag_add_runtest(int num_cycles, tap_state_t endstate);
105
106 /**
107  * This drives the actual srst and trst pins. srst will always be 0
108  * if jtag_reset_config & RESET_SRST_PULLS_TRST != 0 and ditto for
109  * trst.
110  *
111  * the higher level jtag_add_reset will invoke jtag_add_tlr() if
112  * approperiate
113  */
114 extern int interface_jtag_add_reset(int trst, int srst);
115 extern int interface_jtag_add_end_state(tap_state_t endstate);
116 extern int interface_jtag_add_sleep(u32 us);
117 extern int interface_jtag_add_clocks(int num_cycles);
118 extern int interface_jtag_execute_queue(void);
119
120 /**
121  * Calls the interface callback to execute the queue.  This routine
122  * is used by the JTAG driver layer and should not be called directly.
123  */
124 extern int default_interface_jtag_execute_queue(void);
125
126
127 #endif // MINIDRIVER_H