hla: Make consistent parameter naming
[fw/openocd] / src / jtag / hla / hla_interface.h
1 /***************************************************************************
2  *   Copyright (C) 2011 by Mathias Kuester                                 *
3  *   Mathias Kuester <kesmtp@freenet.de>                                   *
4  *                                                                         *
5  *   Copyright (C) 2012 by Spencer Oliver                                  *
6  *   spen@spen-soft.co.uk                                                  *
7  *                                                                         *
8  *   This program is free software; you can redistribute it and/or modify  *
9  *   it under the terms of the GNU General Public License as published by  *
10  *   the Free Software Foundation; either version 2 of the License, or     *
11  *   (at your option) any later version.                                   *
12  *                                                                         *
13  *   This program is distributed in the hope that it will be useful,       *
14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
16  *   GNU General Public License for more details.                          *
17  *                                                                         *
18  *   You should have received a copy of the GNU General Public License     *
19  *   along with this program; if not, write to the                         *
20  *   Free Software Foundation, Inc.,                                       *
21  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
22  ***************************************************************************/
23
24 #ifndef _HL_INTERFACE
25 #define _HL_INTERFACE
26
27 /** */
28 struct target;
29 /** */
30 enum e_hl_transports;
31 /** */
32 extern const char *hl_transports[];
33
34 struct hl_interface_param_s {
35         /** */
36         char *device_desc;
37         /** */
38         char *serial;
39         /** */
40         uint16_t vid;
41         /** */
42         uint16_t pid;
43         /** */
44         unsigned api;
45         /** */
46         enum hl_transports transport;
47         /** */
48         bool connect_under_reset;
49         /** Output file for trace data (if any) */
50         FILE *trace_f;
51         /** Trace module source clock rate */
52         uint32_t trace_source_hz;
53 };
54
55 struct hl_interface_s {
56         /** */
57         struct hl_interface_param_s param;
58         /** */
59         const struct hl_layout *layout;
60         /** */
61         void *handle;
62 };
63
64 /** */
65 int hl_interface_open(enum hl_transports tr);
66 /** */
67
68 int hl_interface_init_target(struct target *t);
69 int hl_interface_init_reset(void);
70
71 #endif /* _HL_INTERFACE */