target: add async algorithm entries to the target type
[openocd.git] / src / target / target_type.h
index aa87a74495a2d2fa5eb3a872a3f4c43461bf676a..10b6f33aa1c74132cc71f9eac59279159b7800fd 100644 (file)
@@ -2,7 +2,7 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008,2009 Øyvind Harboe                            *
+ *   Copyright (C) 2007-2010 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
@@ -26,7 +26,8 @@
 #ifndef TARGET_TYPE_H
 #define TARGET_TYPE_H
 
-#include "types.h"
+#include <helper/types.h>
+#include <jim-nvp.h>
 
 struct target;
 
@@ -39,9 +40,9 @@ struct target_type
 {
        /**
         * Name of this type of target.  Do @b not access this
-        * field directly, use target_get_name() instead.
+        * field directly, use target_type_name() instead.
         */
-       char *name;
+       const char *name;
 
        /* poll current target status */
        int (*poll)(struct target *target);
@@ -73,6 +74,17 @@ struct target_type
         *
         */
        int (*assert_reset)(struct target *target);
+       /**
+        * The implementation is responsible for polling the
+        * target such that target->state reflects the
+        * state correctly.
+        *
+        * Otherwise the following would fail, as there will not
+        * be any "poll" invoked inbetween the "reset run" and
+        * "halt".
+        *
+        * reset run; halt
+     */
        int (*deassert_reset)(struct target *target);
        int (*soft_reset_halt_imp)(struct target *target);
        int (*soft_reset_halt)(struct target *target);
@@ -100,19 +112,25 @@ struct target_type
         * directly, use target_read_memory() instead.
         */
        int (*read_memory)(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
-       int (*write_memory_imp)(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
+       int (*write_memory_imp)(struct target *target, uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
        /**
         * Target memory write callback.  Do @b not call this function
         * directly, use target_write_memory() instead.
         */
-       int (*write_memory)(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
+       int (*write_memory)(struct target *target, uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
+
+       /* Default implementation will do some fancy alignment to improve performance, target can override */
+       int (*read_buffer)(struct target *target, uint32_t address, uint32_t size, uint8_t *buffer);
+
+       /* Default implementation will do some fancy alignment to improve performance, target can override */
+       int (*write_buffer)(struct target *target, uint32_t address, uint32_t size, const uint8_t *buffer);
 
        /**
         * Write target memory in multiples of 4 bytes, optimized for
         * writing large quantities of data.  Do @b not call this
         * function directly, use target_bulk_write_memory() instead.
         */
-       int (*bulk_write_memory)(struct target *target, uint32_t address, uint32_t count, uint8_t *buffer);
+       int (*bulk_write_memory)(struct target *target, uint32_t address, uint32_t count, const uint8_t *buffer);
 
        int (*checksum_memory)(struct target *target, uint32_t address, uint32_t count, uint32_t* checksum);
        int (*blank_check_memory)(struct target *target, uint32_t address, uint32_t count, uint32_t* blank);
@@ -124,31 +142,39 @@ struct target_type
         * Target must be halted while this is invoked as this
         * will actually set up breakpoints on target.
         *
-        * The breakpoint hardware will be set up upon adding the first breakpoint.
+        * The breakpoint hardware will be set up upon adding the
+        * first breakpoint.
         *
         * Upon GDB connection all breakpoints/watchpoints are cleared.
         */
        int (*add_breakpoint)(struct target *target, struct breakpoint *breakpoint);
+       int (*add_context_breakpoint)(struct target *target, struct breakpoint *breakpoint);
+       int (*add_hybrid_breakpoint)(struct target *target, struct breakpoint *breakpoint);
 
-       /* remove breakpoint. hw will only be updated if the target is currently halted.
+       /* remove breakpoint. hw will only be updated if the target
+        * is currently halted.
         * However, this method can be invoked on unresponsive targets.
         */
        int (*remove_breakpoint)(struct target *target, struct breakpoint *breakpoint);
+
+       /* add watchpoint ... see add_breakpoint() comment above. */
        int (*add_watchpoint)(struct target *target, struct watchpoint *watchpoint);
-       /* remove watchpoint. hw will only be updated if the target is currently halted.
+
+       /* remove watchpoint. hw will only be updated if the target
+        * is currently halted.
         * However, this method can be invoked on unresponsive targets.
         */
        int (*remove_watchpoint)(struct target *target, struct watchpoint *watchpoint);
 
-       /* target algorithm support */
-       int (*run_algorithm_imp)(struct target *target, int num_mem_params, struct mem_param *mem_params, int num_reg_params, struct reg_param *reg_param, uint32_t entry_point, uint32_t exit_point, int timeout_ms, void *arch_info);
        /**
         * Target algorithm support.  Do @b not call this method directly,
         * use target_run_algorithm() instead.
         */
        int (*run_algorithm)(struct target *target, int num_mem_params, struct mem_param *mem_params, int num_reg_params, struct reg_param *reg_param, uint32_t entry_point, uint32_t exit_point, int timeout_ms, void *arch_info);
+       int (*start_algorithm)(struct target *target, int num_mem_params, struct mem_param *mem_params, int num_reg_params, struct reg_param *reg_param, uint32_t entry_point, uint32_t exit_point, void *arch_info);
+       int (*wait_algorithm)(struct target *target, int num_mem_params, struct mem_param *mem_params, int num_reg_params, struct reg_param *reg_param, uint32_t exit_point, int timeout_ms, void *arch_info);
 
-       int (*register_commands)(struct command_context *cmd_ctx);
+       const struct command_registration *commands;
 
        /* called when target is created */
        int (*target_create)(struct target *target, Jim_Interp *interp);
@@ -203,15 +229,17 @@ struct target_type
        /*
         * same as read_phys_memory, except that it writes...
         */
-       int (*write_phys_memory)(struct target *target, uint32_t phys_address, uint32_t size, uint32_t count, uint8_t *buffer);
+       int (*write_phys_memory)(struct target *target, uint32_t phys_address, uint32_t size, uint32_t count, const uint8_t *buffer);
 
        int (*mmu)(struct target *target, int *enabled);
 
-       /* Read coprocessor - arm specific. Default implementation returns error. */
-       int (*mrc)(struct target *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t *value);
-
-       /* Write coprocessor. Default implementation returns error.  */
-       int (*mcr)(struct target *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t value);
+       /* after reset is complete, the target can check if things are properly set up.
+        *
+        * This can be used to check if e.g. DCC memory writes have been enabled for
+        * arm7/9 targets, which they really should except in the most contrived
+        * circumstances.
+        */
+       int (*check_reset)(struct target *target);
 };
 
 #endif // TARGET_TYPE_H

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)