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>
28 struct hl_interface_s;
29 struct hl_interface_param_s;
32 extern struct hl_layout_api_s stlink_usb_layout_api;
33 extern struct hl_layout_api_s icdi_usb_layout_api;
34 extern struct hl_layout_api_s nulink_usb_layout_api;
37 struct hl_layout_api_s {
39 int (*open)(struct hl_interface_param_s *param, void **handle);
41 int (*close)(void *handle);
43 int (*reset)(void *handle);
45 int (*assert_srst)(void *handle, int srst);
47 int (*run)(void *handle);
49 int (*halt)(void *handle);
51 int (*step)(void *handle);
53 int (*read_regs)(void *handle);
55 int (*read_reg)(void *handle, int num, uint32_t *val);
57 int (*write_reg)(void *handle, int num, uint32_t val);
59 int (*read_mem)(void *handle, uint32_t addr, uint32_t size,
60 uint32_t count, uint8_t *buffer);
62 int (*write_mem)(void *handle, uint32_t addr, uint32_t size,
63 uint32_t count, const uint8_t *buffer);
65 int (*write_debug_reg)(void *handle, uint32_t addr, uint32_t val);
67 * Read the idcode of the target connected to the adapter
69 * If the adapter doesn't support idcode retrieval, this callback should
70 * store 0 to indicate a wildcard match.
72 * @param handle A pointer to the device-specific handle
73 * @param idcode Storage for the detected idcode
74 * @returns ERROR_OK on success, or an error code on failure.
76 int (*idcode)(void *handle, uint32_t *idcode);
78 int (*override_target)(const char *targetname);
80 int (*custom_command)(void *handle, const char *command);
82 int (*speed)(void *handle, int khz, bool query);
84 * Configure trace parameters for the adapter
86 * @param handle A handle to adapter
87 * @param enabled Whether to enable trace
88 * @param pin_protocol Configured pin protocol
89 * @param port_size Trace port width for sync mode
90 * @param trace_freq A pointer to the configured trace
91 * frequency; if it points to 0, the adapter driver must write
92 * its maximum supported rate there
93 * @returns ERROR_OK on success, an error code on failure.
95 int (*config_trace)(void *handle, bool enabled,
96 enum tpiu_pin_protocol pin_protocol, uint32_t port_size,
97 unsigned int *trace_freq, unsigned int traceclkin_freq,
100 * Poll for new trace data
102 * @param handle A handle to adapter
103 * @param buf A pointer to buffer to store received data
104 * @param size A pointer to buffer size; must be filled with
105 * the actual amount of bytes written
107 * @returns ERROR_OK on success, an error code on failure.
109 int (*poll_trace)(void *handle, uint8_t *buf, size_t *size);
111 enum target_state (*state)(void *fd);
119 int (*open)(struct hl_interface_s *adapter);
121 int (*close)(struct hl_interface_s *adapter);
123 struct hl_layout_api_s *api;
127 const struct hl_layout *hl_layout_get_list(void);
129 int hl_layout_init(struct hl_interface_s *adapter);
131 #endif /* OPENOCD_JTAG_HLA_HLA_LAYOUT_H */