jtag/hla_layout: add #include <target/arm_tpiu_swo.h>

[openocd.git] / src / jtag / hla / hla_layout.h

diff --git a/src/jtag/hla/hla_layout.h b/src/jtag/hla/hla_layout.h
index 6d79d58102df3ba3560657cee5fe8895add6d9b7..732fe1e6ae1aca6e572445a43ba4b9e1f89370d4 100644 (file)
--- a/src/jtag/hla/hla_layout.h
+++ b/src/jtag/hla/hla_layout.h
@@ -16,13 +16,14 @@
  *   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.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
-#ifndef _HL_LAYOUT_H
-#define _HL_LAYOUT_H
+#ifndef OPENOCD_JTAG_HLA_HLA_LAYOUT_H
+#define OPENOCD_JTAG_HLA_HLA_LAYOUT_H
+
+#include <target/armv7m_trace.h>
+#include <target/arm_tpiu_swo.h>
 
 /** */
 struct hl_interface_s;
@@ -31,37 +32,53 @@ 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 **handle);
-       /** */
-       int (*close) (void *handle);
-       /** */
-       int (*reset) (void *handle);
+       int (*open)(struct hl_interface_param_s *param, void **handle);
        /** */
-       int (*assert_srst) (void *handle, int srst);
+       int (*close)(void *handle);
        /** */
-       int (*run) (void *handle);
+       int (*reset)(void *handle);
        /** */
-       int (*halt) (void *handle);
+       int (*assert_srst)(void *handle, int srst);
        /** */
-       int (*step) (void *handle);
+       int (*run)(void *handle);
        /** */
-       int (*read_regs) (void *handle);
+       int (*halt)(void *handle);
        /** */
-       int (*read_reg) (void *handle, int num, uint32_t *val);
+       int (*step)(void *handle);
        /** */
-       int (*write_reg) (void *handle, int num, uint32_t val);
+       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,
+       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,
+       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);
+       int (*write_debug_reg)(void *handle, uint32_t addr, uint32_t val);
        /**
         * Read the idcode of the target connected to the adapter
         *
@@ -72,11 +89,42 @@ struct hl_layout_api_s {
         * @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 (*idcode)(void *handle, uint32_t *idcode);
+       /** */
+       int (*override_target)(const char *targetname);
+       /** */
+       int (*custom_command)(void *handle, const char *command);
        /** */
-       int (*override_target) (const char *targetname);
+       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);
+       enum target_state (*state)(void *fd);
 };
 
 /** */
@@ -84,9 +132,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;
 };
@@ -96,4 +144,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 */