src/jtag/hla/hla_layout.h

   1 /***************************************************************************
   2  *   Copyright (C) 2011 by Mathias Kuester                                 *
   3  *   Mathias Kuester <kesmtp@freenet.de>                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2012 by Spencer Oliver                                  *
   6  *   spen@spen-soft.co.uk                                                  *
   7  *                                                                         *
   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.                                   *
  12  *                                                                         *
  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.                          *
  17  *                                                                         *
  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  ***************************************************************************/
  21
  22 #ifndef OPENOCD_JTAG_HLA_HLA_LAYOUT_H
  23 #define OPENOCD_JTAG_HLA_HLA_LAYOUT_H
  24
  25 #include <target/armv7m_trace.h>
  26
  27 /** */
  28 struct hl_interface_s;
  29 struct hl_interface_param_s;
  30
  31 /** */
  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;
  35
  36 /** */
  37 struct hl_layout_api_s {
  38         /** */
  39         int (*open)(struct hl_interface_param_s *param, void **handle);
  40         /** */
  41         int (*close)(void *handle);
  42         /** */
  43         int (*reset)(void *handle);
  44         /** */
  45         int (*assert_srst)(void *handle, int srst);
  46         /** */
  47         int (*run)(void *handle);
  48         /** */
  49         int (*halt)(void *handle);
  50         /** */
  51         int (*step)(void *handle);
  52         /** */
  53         int (*read_regs)(void *handle);
  54         /**
  55          * Read one register from the target
  56          *
  57          * @param handle A pointer to the device-specific handle
  58          * @param regsel Register selection index compatible with all the
  59          * values allowed by armv7m DCRSR.REGSEL
  60          * @param val A pointer to retrieve the register value
  61          * @returns ERROR_OK on success, or an error code on failure.
  62          */
  63         int (*read_reg)(void *handle, unsigned int regsel, uint32_t *val);
  64         /**
  65          * Write one register to the target
  66          * @param handle A pointer to the device-specific handle
  67          * @param regsel Register selection index compatible with all the
  68          * values allowed by armv7m DCRSR.REGSEL
  69          * @param val The value to be written in the register
  70          * @returns ERROR_OK on success, or an error code on failure.
  71          */
  72         int (*write_reg)(void *handle, unsigned int regsel, uint32_t val);
  73         /** */
  74         int (*read_mem)(void *handle, uint32_t addr, uint32_t size,
  75                         uint32_t count, uint8_t *buffer);
  76         /** */
  77         int (*write_mem)(void *handle, uint32_t addr, uint32_t size,
  78                         uint32_t count, const uint8_t *buffer);
  79         /** */
  80         int (*write_debug_reg)(void *handle, uint32_t addr, uint32_t val);
  81         /**
  82          * Read the idcode of the target connected to the adapter
  83          *
  84          * If the adapter doesn't support idcode retrieval, this callback should
  85          * store 0 to indicate a wildcard match.
  86          *
  87          * @param handle A pointer to the device-specific handle
  88          * @param idcode Storage for the detected idcode
  89          * @returns ERROR_OK on success, or an error code on failure.
  90          */
  91         int (*idcode)(void *handle, uint32_t *idcode);
  92         /** */
  93         int (*override_target)(const char *targetname);
  94         /** */
  95         int (*custom_command)(void *handle, const char *command);
  96         /** */
  97         int (*speed)(void *handle, int khz, bool query);
  98         /**
  99          * Configure trace parameters for the adapter
 100          *
 101          * @param handle A handle to adapter
 102          * @param enabled Whether to enable trace
 103          * @param pin_protocol Configured pin protocol
 104          * @param port_size Trace port width for sync mode
 105          * @param trace_freq A pointer to the configured trace
 106          * frequency; if it points to 0, the adapter driver must write
 107          * its maximum supported rate there
 108          * @returns ERROR_OK on success, an error code on failure.
 109          */
 110         int (*config_trace)(void *handle, bool enabled,
 111                                 enum tpiu_pin_protocol pin_protocol, uint32_t port_size,
 112                                 unsigned int *trace_freq, unsigned int traceclkin_freq,
 113                                 uint16_t *prescaler);
 114         /**
 115          * Poll for new trace data
 116          *
 117          * @param handle A handle to adapter
 118          * @param buf A pointer to buffer to store received data
 119          * @param size A pointer to buffer size; must be filled with
 120          * the actual amount of bytes written
 121          *
 122          * @returns ERROR_OK on success, an error code on failure.
 123          */
 124         int (*poll_trace)(void *handle, uint8_t *buf, size_t *size);
 125         /** */
 126         enum target_state (*state)(void *fd);
 127 };
 128
 129 /** */
 130 struct hl_layout {
 131         /** */
 132         char *name;
 133         /** */
 134         int (*open)(struct hl_interface_s *adapter);
 135         /** */
 136         int (*close)(struct hl_interface_s *adapter);
 137         /** */
 138         struct hl_layout_api_s *api;
 139 };
 140
 141 /** */
 142 const struct hl_layout *hl_layout_get_list(void);
 143 /** */
 144 int hl_layout_init(struct hl_interface_s *adapter);
 145
 146 #endif /* OPENOCD_JTAG_HLA_HLA_LAYOUT_H */