Remove FSF address from GPL notices

[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 d7b5d9353f5d77c24f962e4fa24df3a604af496a..986667fff3253f45cdaaa46ae1433a9aca144dd0 100644 (file)
--- a/src/jtag/hla/hla_layout.h
+++ b/src/jtag/hla/hla_layout.h
@@ -16,14 +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
 
+#include <target/armv7m_trace.h>
+
 /** */
 struct hl_interface_s;
 struct hl_interface_param_s;
@@ -35,25 +35,25 @@ extern struct hl_layout_api_s icdi_usb_layout_api;
 /** */
 struct hl_layout_api_s {
        /** */
-       int (*open) (struct hl_interface_param_s *param, void **fd);
+       int (*open) (struct hl_interface_param_s *param, void **handle);
        /** */
-       int (*close) (void *fd);
+       int (*close) (void *handle);
        /** */
-       int (*reset) (void *fd);
+       int (*reset) (void *handle);
        /** */
-       int (*assert_srst) (void *fd, int srst);
+       int (*assert_srst) (void *handle, int srst);
        /** */
-       int (*run) (void *fd);
+       int (*run) (void *handle);
        /** */
-       int (*halt) (void *fd);
+       int (*halt) (void *handle);
        /** */
-       int (*step) (void *fd);
+       int (*step) (void *handle);
        /** */
-       int (*read_regs) (void *fd);
+       int (*read_regs) (void *handle);
        /** */
-       int (*read_reg) (void *fd, int num, uint32_t *val);
+       int (*read_reg) (void *handle, int num, uint32_t *val);
        /** */
-       int (*write_reg) (void *fd, 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,
                        uint32_t count, uint8_t *buffer);
@@ -62,8 +62,48 @@ struct hl_layout_api_s {
                        uint32_t count, const uint8_t *buffer);
        /** */
        int (*write_debug_reg) (void *handle, uint32_t addr, uint32_t val);
-       /** */
-       int (*idcode) (void *fd, uint32_t *idcode);
+       /**
+        * 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 tpio_pin_protocol pin_protocol,
+                           uint32_t port_size, unsigned int *trace_freq);
+       /**
+        * 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);
 };