905105a0a11a0b9b409487272f9368172cb7f7bc
[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
21 #ifndef _STLINK_LAYOUT_H_
22 #define _STLINK_LAYOUT_H_
23
24 /** */
25 struct stlink_interface_s;
26 struct stlink_interface_param_s;
27
28 /** */
29 extern struct stlink_layout_api_s stlink_usb_layout_api;
30
31 /** */
32 struct stlink_layout_api_s {
33         /** */
34         int (*open) (struct stlink_interface_param_s *param, void **fd);
35         /** */
36         int (*close) (void *fd);
37         /** */
38         int (*reset) (void *fd);
39         /** */
40         int (*assert_srst) (void *fd, int srst);
41         /** */
42         int (*run) (void *fd);
43         /** */
44         int (*halt) (void *fd);
45         /** */
46         int (*step) (void *fd);
47         /** */
48         int (*read_regs) (void *fd);
49         /** */
50         int (*read_reg) (void *fd, int num, uint32_t *val);
51         /** */
52         int (*write_reg) (void *fd, int num, uint32_t val);
53         /** */
54         int (*read_mem8) (void *handle, uint32_t addr, uint16_t len,
55                            uint8_t *buffer);
56         /** */
57         int (*write_mem8) (void *handle, uint32_t addr, uint16_t len,
58                             const uint8_t *buffer);
59         /** */
60         int (*read_mem32) (void *handle, uint32_t addr, uint16_t len,
61                            uint8_t *buffer);
62         /** */
63         int (*write_mem32) (void *handle, uint32_t addr, uint16_t len,
64                             const uint8_t *buffer);
65         /** */
66         int (*write_debug_reg) (void *handle, uint32_t addr, uint32_t val);
67         /** */
68         int (*idcode) (void *fd, uint32_t *idcode);
69         /** */
70         enum target_state (*state) (void *fd);
71 };
72
73 /** */
74 struct stlink_layout {
75         /** */
76         char *name;
77         /** */
78         int type;
79         /** */
80         int (*open) (struct stlink_interface_s *stlink_if);
81         /** */
82         int (*close) (struct stlink_interface_s *stlink_if);
83         /** */
84         struct stlink_layout_api_s *api;
85 };
86
87 /** */
88 const struct stlink_layout *stlink_layout_get_list(void);
89 /** */
90 int stlink_layout_init(struct stlink_interface_s *stlink_if);
91
92 #endif