X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fjtag%2Fhla%2Fhla_layout.h;h=a8088fe95ca823686d7e0cd38a1955dabe82f056;hb=be631eed16bd9ef2b735fd64650ca7283d2ca361;hp=982d71a8644efbc4729abd8a2b677a90f8bda697;hpb=549d9bc72cbca3ba352e6b4bcd6e31d9fd9a0bc7;p=openocd.git
diff --git a/src/jtag/hla/hla_layout.h b/src/jtag/hla/hla_layout.h
index 982d71a864..a8088fe95c 100644
--- a/src/jtag/hla/hla_layout.h
+++ b/src/jtag/hla/hla_layout.h
@@ -16,13 +16,13 @@
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the *
- * Free Software Foundation, Inc., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
+ * along with this program. If not, see . *
***************************************************************************/
-#ifndef _HL_LAYOUT_H
-#define _HL_LAYOUT_H
+#ifndef OPENOCD_JTAG_HLA_HLA_LAYOUT_H
+#define OPENOCD_JTAG_HLA_HLA_LAYOUT_H
+
+#include
/** */
struct hl_interface_s;
@@ -30,47 +30,100 @@ struct hl_interface_param_s;
/** */
extern struct hl_layout_api_s stlink_usb_layout_api;
+extern struct hl_layout_api_s icdi_usb_layout_api;
+extern struct hl_layout_api_s nulink_usb_layout_api;
/** */
struct hl_layout_api_s {
/** */
- int (*open) (struct hl_interface_param_s *param, void **fd);
- /** */
- int (*close) (void *fd);
- /** */
- int (*reset) (void *fd);
- /** */
- int (*assert_srst) (void *fd, int srst);
- /** */
- int (*run) (void *fd);
- /** */
- int (*halt) (void *fd);
- /** */
- int (*step) (void *fd);
- /** */
- int (*read_regs) (void *fd);
- /** */
- int (*read_reg) (void *fd, int num, uint32_t *val);
- /** */
- int (*write_reg) (void *fd, int num, uint32_t val);
- /** */
- int (*read_mem8) (void *handle, uint32_t addr, uint16_t len,
- uint8_t *buffer);
- /** */
- int (*write_mem8) (void *handle, uint32_t addr, uint16_t len,
- const uint8_t *buffer);
- /** */
- int (*read_mem32) (void *handle, uint32_t addr, uint16_t len,
- uint8_t *buffer);
- /** */
- int (*write_mem32) (void *handle, uint32_t addr, uint16_t len,
- const uint8_t *buffer);
- /** */
- int (*write_debug_reg) (void *handle, uint32_t addr, uint32_t val);
- /** */
- int (*idcode) (void *fd, uint32_t *idcode);
- /** */
- enum target_state (*state) (void *fd);
+ int (*open)(struct hl_interface_param_s *param, void **handle);
+ /** */
+ int (*close)(void *handle);
+ /** */
+ int (*reset)(void *handle);
+ /** */
+ int (*assert_srst)(void *handle, int srst);
+ /** */
+ int (*run)(void *handle);
+ /** */
+ int (*halt)(void *handle);
+ /** */
+ int (*step)(void *handle);
+ /** */
+ int (*read_regs)(void *handle);
+ /**
+ * Read one register from the target
+ *
+ * @param handle A pointer to the device-specific handle
+ * @param regsel Register selection index compatible with all the
+ * values allowed by armv7m DCRSR.REGSEL
+ * @param val A pointer to retrieve the register value
+ * @returns ERROR_OK on success, or an error code on failure.
+ */
+ int (*read_reg)(void *handle, unsigned int regsel, uint32_t *val);
+ /**
+ * Write one register to the target
+ * @param handle A pointer to the device-specific handle
+ * @param regsel Register selection index compatible with all the
+ * values allowed by armv7m DCRSR.REGSEL
+ * @param val The value to be written in the register
+ * @returns ERROR_OK on success, or an error code on failure.
+ */
+ int (*write_reg)(void *handle, unsigned int regsel, uint32_t val);
+ /** */
+ int (*read_mem)(void *handle, uint32_t addr, uint32_t size,
+ uint32_t count, uint8_t *buffer);
+ /** */
+ int (*write_mem)(void *handle, uint32_t addr, uint32_t size,
+ uint32_t count, const uint8_t *buffer);
+ /** */
+ int (*write_debug_reg)(void *handle, uint32_t addr, uint32_t val);
+ /**
+ * Read the idcode of the target connected to the adapter
+ *
+ * If the adapter doesn't support idcode retrieval, this callback should
+ * store 0 to indicate a wildcard match.
+ *
+ * @param handle A pointer to the device-specific handle
+ * @param idcode Storage for the detected idcode
+ * @returns ERROR_OK on success, or an error code on failure.
+ */
+ int (*idcode)(void *handle, uint32_t *idcode);
+ /** */
+ int (*override_target)(const char *targetname);
+ /** */
+ int (*custom_command)(void *handle, const char *command);
+ /** */
+ int (*speed)(void *handle, int khz, bool query);
+ /**
+ * Configure trace parameters for the adapter
+ *
+ * @param handle A handle to adapter
+ * @param enabled Whether to enable trace
+ * @param pin_protocol Configured pin protocol
+ * @param port_size Trace port width for sync mode
+ * @param trace_freq A pointer to the configured trace
+ * frequency; if it points to 0, the adapter driver must write
+ * its maximum supported rate there
+ * @returns ERROR_OK on success, an error code on failure.
+ */
+ int (*config_trace)(void *handle, bool enabled,
+ enum tpiu_pin_protocol pin_protocol, uint32_t port_size,
+ unsigned int *trace_freq, unsigned int traceclkin_freq,
+ uint16_t *prescaler);
+ /**
+ * Poll for new trace data
+ *
+ * @param handle A handle to adapter
+ * @param buf A pointer to buffer to store received data
+ * @param size A pointer to buffer size; must be filled with
+ * the actual amount of bytes written
+ *
+ * @returns ERROR_OK on success, an error code on failure.
+ */
+ int (*poll_trace)(void *handle, uint8_t *buf, size_t *size);
+ /** */
+ enum target_state (*state)(void *fd);
};
/** */
@@ -78,9 +131,9 @@ struct hl_layout {
/** */
char *name;
/** */
- int (*open) (struct hl_interface_s *adapter);
+ int (*open)(struct hl_interface_s *adapter);
/** */
- int (*close) (struct hl_interface_s *adapter);
+ int (*close)(struct hl_interface_s *adapter);
/** */
struct hl_layout_api_s *api;
};
@@ -90,4 +143,4 @@ const struct hl_layout *hl_layout_get_list(void);
/** */
int hl_layout_init(struct hl_interface_s *adapter);
-#endif /* _HL_LAYOUT_H */
+#endif /* OPENOCD_JTAG_HLA_HLA_LAYOUT_H */