jtag/drivers: add support for Nu-Link (Nuvoton ICE) over usb
[fw/openocd] / src / jtag / hla / hla_layout.h
index 8833d6c80ba41cbf292a38576a2a8003b86da005..e0bbd0fed6feac1bd2242b197f23cf3ae6a69f22 100644 (file)
  *   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>
 
@@ -33,37 +31,38 @@ 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 (*open)(struct hl_interface_param_s *param, void **handle);
        /** */
-       int (*close) (void *handle);
+       int (*close)(void *handle);
        /** */
-       int (*reset) (void *handle);
+       int (*reset)(void *handle);
        /** */
-       int (*assert_srst) (void *handle, int srst);
+       int (*assert_srst)(void *handle, int srst);
        /** */
-       int (*run) (void *handle);
+       int (*run)(void *handle);
        /** */
-       int (*halt) (void *handle);
+       int (*halt)(void *handle);
        /** */
-       int (*step) (void *handle);
+       int (*step)(void *handle);
        /** */
-       int (*read_regs) (void *handle);
+       int (*read_regs)(void *handle);
        /** */
-       int (*read_reg) (void *handle, int num, uint32_t *val);
+       int (*read_reg)(void *handle, int num, uint32_t *val);
        /** */
-       int (*write_reg) (void *handle, int num, uint32_t val);
+       int (*write_reg)(void *handle, int num, 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
         *
@@ -74,11 +73,11 @@ 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 (*override_target)(const char *targetname);
        /** */
-       int (*custom_command) (void *handle, const char *command);
+       int (*custom_command)(void *handle, const char *command);
        /** */
        int (*speed)(void *handle, int khz, bool query);
        /**
@@ -93,8 +92,10 @@ struct hl_layout_api_s {
         * its maximum supported rate there
         * @returns ERROR_OK on success, an error code on failure.
         */
-       int (*config_trace)(void *handle, bool enabled, enum tpio_pin_protocol pin_protocol,
-                           uint32_t port_size, unsigned int *trace_freq);
+       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
         *
@@ -107,7 +108,7 @@ struct hl_layout_api_s {
         */
        int (*poll_trace)(void *handle, uint8_t *buf, size_t *size);
        /** */
-       enum target_state (*state) (void *fd);
+       enum target_state (*state)(void *fd);
 };
 
 /** */
@@ -115,9 +116,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;
 };
@@ -127,4 +128,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 */