Fix a bunch of typos.

[openocd.git] / src / target / target.h

diff --git a/src/target/target.h b/src/target/target.h
index 0292945d2c6e34a802f1889b7b64294fa54d97f8..d6e7431e803cbb7daab66dcc70380219e87a8996 100644 (file)
--- a/src/target/target.h
+++ b/src/target/target.h
@@ -84,7 +84,7 @@ enum target_debug_reason
        DBG_REASON_UNDEFINED = 6
 };
 
-enum target_endianess
+enum target_endianness
 {
        TARGET_ENDIAN_UNKNOWN = 0,
        TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
@@ -94,7 +94,7 @@ struct working_area
 {
        uint32_t address;
        uint32_t size;
-       int free;
+       bool free;
        uint8_t *backup;
        struct working_area **user;
        struct working_area *next;
@@ -107,6 +107,7 @@ struct target
        const char *cmd_name;                           /* tcl Name of target */
        int target_number;                                      /* DO NOT USE!  field to be removed in 2010 */
        struct jtag_tap *tap;                                   /* where on the jtag chain is this */
+       int coreid;                                                     /* which device on the TAP? */
        const char *variant;                            /* what variant of this chip is it? */
 
        /**
@@ -138,7 +139,7 @@ struct target
        uint32_t backup_working_area;                   /* whether the content of the working area has to be preserved */
        struct working_area *working_areas;/* list of allocated working areas */
        enum target_debug_reason debug_reason;/* reason why the target entered debug state */
-       enum target_endianess endianness;       /* target endianess */
+       enum target_endianness endianness;      /* target endianness */
        // also see: target_state_name()
        enum target_state state;                        /* the current backend-state (running, halted, ...) */
        struct reg_cache *reg_cache;            /* the first register cache of the target (core regs) */
@@ -257,6 +258,18 @@ int target_unregister_event_callback(
                int (*callback)(struct target *target,
                                enum target_event event, void *priv),
                void *priv);
+/* Poll the status of the target, detect any error conditions and report them.
+ *
+ * Also note that this fn will clear such error conditions, so a subsequent
+ * invocation will then succeed.
+ *
+ * These error conditions can be "sticky" error conditions. E.g. writing
+ * to memory could be implemented as an open loop and if memory writes
+ * fails, then a note is made of it, the error is sticky, but the memory
+ * write loop still runs to completion. This improves performance in the
+ * normal case as there is no need to verify that every single write succeed,
+ * yet it is possible to detect error condtions.
+ */
 int target_poll(struct target *target);
 int target_resume(struct target *target, int current, uint32_t address,
                int handle_breakpoints, int debug_execution);
@@ -452,14 +465,24 @@ const char *target_state_name( struct target *target );
  */
 int target_alloc_working_area(struct target *target,
                uint32_t size, struct working_area **area);
+/* Same as target_alloc_working_area, except that no error is logged
+ * when ERROR_TARGET_RESOURCE_NOT_AVAILABLE is returned.
+ *
+ * This allows the calling code to *try* to allocate target memory
+ * and have a fallback to another behavior(slower?).
+ */
+int target_alloc_working_area_try(struct target *target,
+               uint32_t size, struct working_area **area);
 int target_free_working_area(struct target *target, struct working_area *area);
 void target_free_all_working_areas(struct target *target);
 
 extern struct target *all_targets;
 
 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
+uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer);
 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
+void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value);
 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
 
 int target_read_u32(struct target *target, uint32_t address, uint32_t *value);