1 /***************************************************************************
2 * Copyright (C) 2011 by Mathias Kuester *
3 * Mathias Kuester <kesmtp@freenet.de> *
5 * Copyright (C) 2012 by Spencer Oliver *
6 * spen@spen-soft.co.uk *
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. *
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. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
20 ***************************************************************************/
22 #ifndef OPENOCD_JTAG_HLA_HLA_LAYOUT_H
23 #define OPENOCD_JTAG_HLA_HLA_LAYOUT_H
25 #include <target/armv7m_trace.h>
26 #include <target/arm_tpiu_swo.h>
29 struct hl_interface_s;
30 struct hl_interface_param_s;
33 extern struct hl_layout_api_s stlink_usb_layout_api;
34 extern struct hl_layout_api_s icdi_usb_layout_api;
35 extern struct hl_layout_api_s nulink_usb_layout_api;
38 struct hl_layout_api_s {
40 int (*open)(struct hl_interface_param_s *param, void **handle);
42 int (*close)(void *handle);
44 int (*reset)(void *handle);
46 int (*assert_srst)(void *handle, int srst);
48 int (*run)(void *handle);
50 int (*halt)(void *handle);
52 int (*step)(void *handle);
54 int (*read_regs)(void *handle);
56 * Read one register from the target
58 * @param handle A pointer to the device-specific handle
59 * @param regsel Register selection index compatible with all the
60 * values allowed by armv7m DCRSR.REGSEL
61 * @param val A pointer to retrieve the register value
62 * @returns ERROR_OK on success, or an error code on failure.
64 int (*read_reg)(void *handle, unsigned int regsel, uint32_t *val);
66 * Write one register to the target
67 * @param handle A pointer to the device-specific handle
68 * @param regsel Register selection index compatible with all the
69 * values allowed by armv7m DCRSR.REGSEL
70 * @param val The value to be written in the register
71 * @returns ERROR_OK on success, or an error code on failure.
73 int (*write_reg)(void *handle, unsigned int regsel, uint32_t val);
75 int (*read_mem)(void *handle, uint32_t addr, uint32_t size,
76 uint32_t count, uint8_t *buffer);
78 int (*write_mem)(void *handle, uint32_t addr, uint32_t size,
79 uint32_t count, const uint8_t *buffer);
81 int (*write_debug_reg)(void *handle, uint32_t addr, uint32_t val);
83 * Read the idcode of the target connected to the adapter
85 * If the adapter doesn't support idcode retrieval, this callback should
86 * store 0 to indicate a wildcard match.
88 * @param handle A pointer to the device-specific handle
89 * @param idcode Storage for the detected idcode
90 * @returns ERROR_OK on success, or an error code on failure.
92 int (*idcode)(void *handle, uint32_t *idcode);
94 int (*override_target)(const char *targetname);
96 int (*custom_command)(void *handle, const char *command);
98 int (*speed)(void *handle, int khz, bool query);
100 * Configure trace parameters for the adapter
102 * @param handle A handle to adapter
103 * @param enabled Whether to enable trace
104 * @param pin_protocol Configured pin protocol
105 * @param port_size Trace port width for sync mode
106 * @param trace_freq A pointer to the configured trace
107 * frequency; if it points to 0, the adapter driver must write
108 * its maximum supported rate there
109 * @returns ERROR_OK on success, an error code on failure.
111 int (*config_trace)(void *handle, bool enabled,
112 enum tpiu_pin_protocol pin_protocol, uint32_t port_size,
113 unsigned int *trace_freq, unsigned int traceclkin_freq,
114 uint16_t *prescaler);
116 * Poll for new trace data
118 * @param handle A handle to adapter
119 * @param buf A pointer to buffer to store received data
120 * @param size A pointer to buffer size; must be filled with
121 * the actual amount of bytes written
123 * @returns ERROR_OK on success, an error code on failure.
125 int (*poll_trace)(void *handle, uint8_t *buf, size_t *size);
127 enum target_state (*state)(void *fd);
135 int (*open)(struct hl_interface_s *adapter);
137 int (*close)(struct hl_interface_s *adapter);
139 struct hl_layout_api_s *api;
143 const struct hl_layout *hl_layout_get_list(void);
145 int hl_layout_init(struct hl_interface_s *adapter);
147 #endif /* OPENOCD_JTAG_HLA_HLA_LAYOUT_H */