46517a7896bd2bffd793a1fd8b03c32376ec4b43
[fw/openocd] / src / jtag / stlink / stlink_layout.h
1 /***************************************************************************
2  *   Copyright (C) 2011 by Mathias Kuester                                 *
3  *   Mathias Kuester <kesmtp@freenet.de>                                   *
4  *                                                                         *
5  *   This program is free software; you can redistribute it and/or modify  *
6  *   it under the terms of the GNU General Public License as published by  *
7  *   the Free Software Foundation; either version 2 of the License, or     *
8  *   (at your option) any later version.                                   *
9  *                                                                         *
10  *   This program is distributed in the hope that it will be useful,       *
11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
13  *   GNU General Public License for more details.                          *
14  *                                                                         *
15  *   You should have received a copy of the GNU General Public License     *
16  *   along with this program; if not, write to the                         *
17  *   Free Software Foundation, Inc.,                                       *
18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
19  ***************************************************************************/
20 #ifndef _STLINK_LAYOUT_H_
21 #define _STLINK_LAYOUT_H_
22
23 /** */
24 struct stlink_interface_s;
25 struct stlink_interface_param_s;
26
27 /** */
28 extern struct stlink_layout_api_s stlink_layout_api;
29
30 /** */
31 struct stlink_layout_api_s {
32         /** */
33         int (*open) (struct stlink_interface_param_s *param, void **fd);
34         /** */
35         int (*close) (void *fd);
36         /** */
37         int (*reset) (void *fd);
38         /** */
39         int (*run) (void *fd);
40         /** */
41         int (*halt) (void *fd);
42         /** */
43         int (*step) (void *fd);
44         /** */
45         int (*read_regs) (void *fd);
46         /** */
47         int (*read_reg) (void *fd, int num, uint32_t *val);
48         /** */
49         int (*write_reg) (void *fd, int num, uint32_t val);
50         /** */
51         int (*read_mem32) (void *handle, uint32_t addr, uint16_t len,
52                            uint32_t *buffer);
53         /** */
54         int (*write_mem32) (void *handle, uint32_t addr, uint16_t len,
55                             uint32_t *buffer);
56         /** */
57         int (*idcode) (void *fd, uint32_t *idcode);
58         /** */
59         enum target_state (*state) (void *fd);
60 };
61
62 /** */
63 struct stlink_layout {
64         /** */
65         char *name;
66         /** */
67         int type;
68         /** */
69         int (*open) (struct stlink_interface_s *stlink_if);
70         /** */
71         int (*close) (struct stlink_interface_s *stlink_if);
72         /** */
73         struct stlink_layout_api_s *api;
74 };
75
76 /** */
77 const struct stlink_layout *stlink_layout_get_list(void);
78 /** */
79 int stlink_layout_init(struct stlink_interface_s *stlink_if);
80
81 #endif