target_request: add target_got_message() that can be used to improve DCC performance
[fw/openocd] / src / target / target_request.c
index 5618405d5ffb35e43b1dc8c9c133f0e60ec0f0fc..3cdca5e189c4a93159d8691cb25b4e057cc6522a 100644 (file)
@@ -2,7 +2,7 @@
  *   Copyright (C) 2007 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
 #include "config.h"
 #endif
 
+#include <helper/log.h>
+#include <helper/binarybuffer.h>
+
+#include "target.h"
 #include "target_request.h"
-#include "binarybuffer.h"
+#include "target_type.h"
 #include "trace.h"
-#include "log.h"
 
 
-static command_t *target_request_cmd = NULL;
+static bool got_message = false;
+
+bool target_got_message(void)
+{
+       bool t = got_message;
+       got_message = false;
+       return t;
+}
+
 static int charmsg_mode = 0;
 
-static int target_asciimsg(target_t *target, u32 length)
+static int target_asciimsg(struct target *target, uint32_t length)
 {
-       char *msg = malloc(CEIL(length + 1, 4) * 4);
-       debug_msg_receiver_t *c = target->dbgmsg;
-       
-       target->type->target_request_data(target, CEIL(length, 4), (u8*)msg);
+       char *msg = malloc(DIV_ROUND_UP(length + 1, 4) * 4);
+       struct debug_msg_receiver *c = target->dbgmsg;
+
+       target->type->target_request_data(target, DIV_ROUND_UP(length, 4), (uint8_t*)msg);
        msg[length] = 0;
-       
+
        LOG_DEBUG("%s", msg);
-       
+
        while (c)
        {
                command_print(c->cmd_ctx, "%s", msg);
                c = c->next;
        }
-       
+
        return ERROR_OK;
 }
 
-static int target_charmsg(target_t *target, u8 msg)
+static int target_charmsg(struct target *target, uint8_t msg)
 {
        LOG_USER_N("%c", msg);
-       
+
        return ERROR_OK;
 }
 
-static int target_hexmsg(target_t *target, int size, u32 length)
+static int target_hexmsg(struct target *target, int size, uint32_t length)
 {
-       u8 *data = malloc(CEIL(length * size, 4) * 4);
+       uint8_t *data = malloc(DIV_ROUND_UP(length * size, 4) * 4);
        char line[128];
        int line_len;
-       debug_msg_receiver_t *c = target->dbgmsg;
-       u32 i;
-       
-       LOG_DEBUG("size: %i, length: %i", size, length);
+       struct debug_msg_receiver *c = target->dbgmsg;
+       uint32_t i;
+
+       LOG_DEBUG("size: %i, length: %i", (int)size, (int)length);
 
-       target->type->target_request_data(target, CEIL(length * size, 4), (u8*)data);
+       target->type->target_request_data(target, DIV_ROUND_UP(length * size, 4), (uint8_t*)data);
 
        line_len = 0;
        for (i = 0; i < length; i++)
@@ -80,7 +91,7 @@ static int target_hexmsg(target_t *target, int size, u32 length)
                switch (size)
                {
                        case 4:
-                               line_len += snprintf(line + line_len, 128 - line_len, "%8.8x ", le_to_h_u32(data + (4*i)));
+                               line_len += snprintf(line + line_len, 128 - line_len, "%8.8" PRIx32 " ", le_to_h_u32(data + (4*i)));
                                break;
                        case 2:
                                line_len += snprintf(line + line_len, 128 - line_len, "%4.4x ", le_to_h_u16(data + (2*i)));
@@ -89,11 +100,11 @@ static int target_hexmsg(target_t *target, int size, u32 length)
                                line_len += snprintf(line + line_len, 128 - line_len, "%2.2x ", data[i]);
                                break;
                }
-               
+
                if ((i%8 == 7) || (i == length - 1))
                {
                        LOG_DEBUG("%s", line);
-                       
+
                        while (c)
                        {
                                command_print(c->cmd_ctx, "%s", line);
@@ -103,7 +114,7 @@ static int target_hexmsg(target_t *target, int size, u32 length)
                        line_len = 0;
                }
        }
-       
+
        free(data);
 
        return ERROR_OK;
@@ -112,12 +123,15 @@ static int target_hexmsg(target_t *target, int size, u32 length)
 /* handle requests from the target received by a target specific
  * side-band channel (e.g. ARM7/9 DCC)
  */
-int target_request(target_t *target, u32 request)
+int target_request(struct target *target, uint32_t request)
 {
        target_req_cmd_t target_req_cmd = request & 0xff;
 
-       if ( charmsg_mode ) {
-               target_charmsg(target, target_req_cmd );
+       /* Record that we got a target message for back-off algorithm */
+       got_message = true;
+
+       if (charmsg_mode) {
+               target_charmsg(target, target_req_cmd);
                return ERROR_OK;
        }
        switch (target_req_cmd)
@@ -145,14 +159,14 @@ int target_request(target_t *target, u32 request)
                        LOG_ERROR("unknown target request: %2.2x", target_req_cmd);
                        break;
        }
-       
+
        return ERROR_OK;
 }
 
-static int add_debug_msg_receiver(struct command_context_s *cmd_ctx, target_t *target)
+static int add_debug_msg_receiver(struct command_context *cmd_ctx, struct target *target)
 {
-       debug_msg_receiver_t **p = &target->dbgmsg;
-       
+       struct debug_msg_receiver **p = &target->dbgmsg;
+
        if (target == NULL)
                return ERROR_INVALID_ARGUMENTS;
 
@@ -167,21 +181,21 @@ static int add_debug_msg_receiver(struct command_context_s *cmd_ctx, target_t *t
        }
 
        /* add new debug message receiver */
-       (*p) = malloc(sizeof(debug_msg_receiver_t));
+       (*p) = malloc(sizeof(struct debug_msg_receiver));
        (*p)->cmd_ctx = cmd_ctx;
        (*p)->next = NULL;
-       
+
        /* enable callback */
        target->dbg_msg_enabled = 1;
-       
+
        return ERROR_OK;
 }
 
-static debug_msg_receiver_t* find_debug_msg_receiver(struct command_context_s *cmd_ctx, target_t *target)
+static struct debug_msg_receiver* find_debug_msg_receiver(struct command_context *cmd_ctx, struct target *target)
 {
        int do_all_targets = 0;
-       debug_msg_receiver_t **p = &target->dbgmsg;
-       
+       struct debug_msg_receiver **p = &target->dbgmsg;
+
        /* if no target has been specified search all of them */
        if (target == NULL)
        {
@@ -192,7 +206,7 @@ static debug_msg_receiver_t* find_debug_msg_receiver(struct command_context_s *c
                target = all_targets;
                do_all_targets = 1;
        }
-       
+
        do
        {
                while (*p)
@@ -203,26 +217,26 @@ static debug_msg_receiver_t* find_debug_msg_receiver(struct command_context_s *c
                        }
                        p = &((*p)->next);
                }
-               
+
                target = target->next;
        } while (target && do_all_targets);
-       
+
        return NULL;
 }
 
-int delete_debug_msg_receiver(struct command_context_s *cmd_ctx, target_t *target)
+int delete_debug_msg_receiver(struct command_context *cmd_ctx, struct target *target)
 {
-       debug_msg_receiver_t **p;
-       debug_msg_receiver_t *c;
+       struct debug_msg_receiver **p;
+       struct debug_msg_receiver *c;
        int do_all_targets = 0;
-       
+
        /* if no target has been specified search all of them */
        if (target == NULL)
        {
                /* if no targets haven been specified */
                if (all_targets == NULL)
                        return ERROR_OK;
-               
+
                target = all_targets;
                do_all_targets = 1;
        }
@@ -233,7 +247,7 @@ int delete_debug_msg_receiver(struct command_context_s *cmd_ctx, target_t *targe
                c = *p;
                while (c)
                {
-                       debug_msg_receiver_t *next = c->next;
+                       struct debug_msg_receiver *next = c->next;
                        if (c->cmd_ctx == cmd_ctx)
                        {
                                *p = next;
@@ -249,62 +263,76 @@ int delete_debug_msg_receiver(struct command_context_s *cmd_ctx, target_t *targe
                                p = &(c->next);
                        c = next;
                }
-       
+
                target = target->next;
        } while (target && do_all_targets);
-       
+
        return ERROR_OK;
 }
 
-static int handle_target_request_debugmsgs_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_target_request_debugmsgs_command)
 {
-       target_t *target = get_current_target(cmd_ctx);
+       struct target *target = get_current_target(CMD_CTX);
 
        int receiving = 0;
-       
+
        /* see if reciever is already registered */
-       if (find_debug_msg_receiver(cmd_ctx, target) != NULL)
+       if (find_debug_msg_receiver(CMD_CTX, target) != NULL)
                receiving = 1;
 
-       if (argc > 0)
+       if (CMD_ARGC > 0)
        {
-               if (!strcmp(args[0], "enable") || !strcmp(args[0], "charmsg"))
+               if (!strcmp(CMD_ARGV[0], "enable") || !strcmp(CMD_ARGV[0], "charmsg"))
                {
                        /* don't register if this command context is already receiving */
                        if (!receiving)
                        {
                                receiving = 1;
-                               add_debug_msg_receiver(cmd_ctx, target);
+                               add_debug_msg_receiver(CMD_CTX, target);
                        }
-                       charmsg_mode = !strcmp(args[0], "charmsg");
+                       charmsg_mode = !strcmp(CMD_ARGV[0], "charmsg");
                }
-               else if (!strcmp(args[0], "disable"))
+               else if (!strcmp(CMD_ARGV[0], "disable"))
                {
                        /* no need to delete a receiver if none is registered */
                        if (receiving)
                        {
                                receiving = 0;
-                               delete_debug_msg_receiver(cmd_ctx, target);
+                               delete_debug_msg_receiver(CMD_CTX, target);
                        }
                }
                else
                {
-                       command_print(cmd_ctx, "usage: target_request debugmsgs ['enable'|'disable'|'charmsg']");
+                       command_print(CMD_CTX, "usage: target_request debugmsgs ['enable'|'disable'|'charmsg']");
                }
        }
-       
-       command_print(cmd_ctx, "receiving debug messages from current target %s",
-                     (receiving) ? (charmsg_mode?"charmsg":"enabled") : "disabled" );
+
+       command_print(CMD_CTX, "receiving debug messages from current target %s",
+                     (receiving) ? (charmsg_mode?"charmsg":"enabled") : "disabled");
        return ERROR_OK;
 }
 
-int target_request_register_commands(struct command_context_s *cmd_ctx)
-{
-       target_request_cmd =
-               register_command(cmd_ctx, NULL, "target_request", NULL, COMMAND_ANY, "target_request commands");
-       
-       register_command(cmd_ctx, target_request_cmd, "debugmsgs", handle_target_request_debugmsgs_command,
-               COMMAND_EXEC, "enable/disable reception of debug messages from target");
+static const struct command_registration target_req_exec_command_handlers[] = {
+       {
+               .name = "debugmsgs",
+               .handler = handle_target_request_debugmsgs_command,
+               .mode = COMMAND_EXEC,
+               .help = "display and/or modify reception of debug messages from target",
+               .usage = "['enable'|'charmsg'|'disable']",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+static const struct command_registration target_req_command_handlers[] = {
+       {
+               .name = "target_request",
+               .mode = COMMAND_ANY,
+               .help = "target request command group",
+               .chain = target_req_exec_command_handlers,
+       },
+       COMMAND_REGISTRATION_DONE
+};
 
-       return ERROR_OK;
+int target_request_register_commands(struct command_context *cmd_ctx)
+{
+       return register_commands(cmd_ctx, NULL, target_req_command_handlers);
 }