]> git.sur5r.net Git - openocd/blobdiff - src/target/oocd_trace.c
Remove FSF address from GPL notices
[openocd] / src / target / oocd_trace.c
index f2fdaa39700c85fb5e1e8d6ecd83e46a7b6799a4..627366d5d409413671e719ff0ee1a406574adb10 100644 (file)
  *   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.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
+#include "arm.h"
+#include "etm.h"
 #include "oocd_trace.h"
-#include "arm7_9_common.h"
 
 /*
  * This is "proof of concept" code, for prototype hardware:
  * https://lists.berlios.de/pipermail/openocd-development/2007-September/000336.html
  */
 
-
-static int oocd_trace_register_commands(struct command_context_s *cmd_ctx);
-
-static int oocd_trace_read_reg(oocd_trace_t *oocd_trace, int reg, uint32_t *value)
+static int oocd_trace_read_reg(struct oocd_trace *oocd_trace, int reg, uint32_t *value)
 {
        size_t bytes_written, bytes_read, bytes_to_read;
        uint8_t cmd;
 
        cmd = 0x10 | (reg & 0x7);
        bytes_written = write(oocd_trace->tty_fd, &cmd, 1);
+       if (bytes_written < 1)
+               return ERROR_FAIL;
 
        bytes_to_read = 4;
-       while (bytes_to_read > 0)
-       {
-               bytes_read = read(oocd_trace->tty_fd, ((uint8_t*)value) + 4 - bytes_to_read, bytes_to_read);
+       while (bytes_to_read > 0) {
+               bytes_read = read(oocd_trace->tty_fd, ((uint8_t *)value) + 4 - bytes_to_read, bytes_to_read);
                bytes_to_read -= bytes_read;
        }
 
-       LOG_DEBUG("reg #%i: 0x%8.8x\n", reg, *value);
+       LOG_DEBUG("reg #%i: 0x%8.8x", reg, *value);
 
        return ERROR_OK;
 }
 
-static int oocd_trace_write_reg(oocd_trace_t *oocd_trace, int reg, uint32_t value)
+static int oocd_trace_write_reg(struct oocd_trace *oocd_trace, int reg, uint32_t value)
 {
        size_t bytes_written;
        uint8_t data[5];
@@ -64,12 +62,15 @@ static int oocd_trace_write_reg(oocd_trace_t *oocd_trace, int reg, uint32_t valu
        data[4] = (value & 0xff000000) >> 24;
 
        bytes_written = write(oocd_trace->tty_fd, data, 5);
-       LOG_DEBUG("reg #%i: 0x%8.8x\n", reg, value);
+       if (bytes_written < 5)
+               return ERROR_FAIL;
+
+       LOG_DEBUG("reg #%i: 0x%8.8x", reg, value);
 
        return ERROR_OK;
 }
 
-static int oocd_trace_read_memory(oocd_trace_t *oocd_trace, uint8_t *data, uint32_t address, uint32_t size)
+static int oocd_trace_read_memory(struct oocd_trace *oocd_trace, uint8_t *data, uint32_t address, uint32_t size)
 {
        size_t bytes_written, bytes_to_read;
        ssize_t bytes_read;
@@ -80,15 +81,15 @@ static int oocd_trace_read_memory(oocd_trace_t *oocd_trace, uint8_t *data, uint3
 
        cmd = 0x20;
        bytes_written = write(oocd_trace->tty_fd, &cmd, 1);
+       if (bytes_written < 1)
+               return ERROR_FAIL;
 
        bytes_to_read = size * 16;
-       while (bytes_to_read > 0)
-       {
-               if ((bytes_read = read(oocd_trace->tty_fd,
-                               ((uint8_t*)data) + (size * 16) - bytes_to_read, bytes_to_read)) < 0)
-               {
+       while (bytes_to_read > 0) {
+               bytes_read = read(oocd_trace->tty_fd,
+                               ((uint8_t *)data) + (size * 16) - bytes_to_read, bytes_to_read);
+               if (bytes_read < 0)
                        LOG_DEBUG("read() returned %zi (%s)", bytes_read, strerror(errno));
-               }
                else
                        bytes_to_read -= bytes_read;
        }
@@ -96,16 +97,15 @@ static int oocd_trace_read_memory(oocd_trace_t *oocd_trace, uint8_t *data, uint3
        return ERROR_OK;
 }
 
-static int oocd_trace_init(etm_context_t *etm_ctx)
+static int oocd_trace_init(struct etm_context *etm_ctx)
 {
        uint8_t trash[256];
-       oocd_trace_t *oocd_trace = etm_ctx->capture_driver_priv;
+       struct oocd_trace *oocd_trace = etm_ctx->capture_driver_priv;
        size_t bytes_read;
 
        oocd_trace->tty_fd = open(oocd_trace->tty, O_RDWR | O_NOCTTY | O_NONBLOCK);
 
-       if (oocd_trace->tty_fd < 0)
-       {
+       if (oocd_trace->tty_fd < 0) {
                LOG_ERROR("can't open tty");
                return ERROR_ETM_CAPTURE_INIT_FAILED;
        }
@@ -135,28 +135,26 @@ static int oocd_trace_init(etm_context_t *etm_ctx)
 
        /* occasionally one bogus character is left in the input buffer
         * read up any leftover characters to ensure communication is in sync */
-       while ((bytes_read = read(oocd_trace->tty_fd, trash, sizeof(trash))) > 0)
-       {
-               LOG_DEBUG("%zi bytes read\n", bytes_read);
-       };
+       do {
+               bytes_read = read(oocd_trace->tty_fd, trash, sizeof(trash));
+               if (bytes_read)
+                       LOG_DEBUG("%zi bytes read", bytes_read);
+       } while (bytes_read > 0);
 
        return ERROR_OK;
 }
 
-static trace_status_t oocd_trace_status(etm_context_t *etm_ctx)
+static trace_status_t oocd_trace_status(struct etm_context *etm_ctx)
 {
-       oocd_trace_t *oocd_trace = etm_ctx->capture_driver_priv;
+       struct oocd_trace *oocd_trace = etm_ctx->capture_driver_priv;
        uint32_t status;
 
        oocd_trace_read_reg(oocd_trace, OOCD_TRACE_STATUS, &status);
 
        /* if tracing is currently idle, return this information */
        if (etm_ctx->capture_status == TRACE_IDLE)
-       {
                return etm_ctx->capture_status;
-       }
-       else if (etm_ctx->capture_status & TRACE_RUNNING)
-       {
+       else if (etm_ctx->capture_status & TRACE_RUNNING) {
                /* check Full bit to identify an overflow */
                if (status & 0x4)
                        etm_ctx->capture_status |= TRACE_OVERFLOWED;
@@ -165,8 +163,7 @@ static trace_status_t oocd_trace_status(etm_context_t *etm_ctx)
                if (status & 0x2)
                        etm_ctx->capture_status |= TRACE_TRIGGERED;
 
-               if (status & 0x1)
-               {
+               if (status & 0x1) {
                        etm_ctx->capture_status &= ~TRACE_RUNNING;
                        etm_ctx->capture_status |= TRACE_COMPLETED;
                }
@@ -175,9 +172,9 @@ static trace_status_t oocd_trace_status(etm_context_t *etm_ctx)
        return etm_ctx->capture_status;
 }
 
-static int oocd_trace_read_trace(etm_context_t *etm_ctx)
+static int oocd_trace_read_trace(struct etm_context *etm_ctx)
 {
-       oocd_trace_t *oocd_trace = etm_ctx->capture_driver_priv;
+       struct oocd_trace *oocd_trace = etm_ctx->capture_driver_priv;
        uint32_t status, address;
        uint32_t first_frame = 0x0;
        uint32_t num_frames = 1048576;
@@ -203,26 +200,20 @@ static int oocd_trace_read_trace(etm_context_t *etm_ctx)
        oocd_trace_read_memory(oocd_trace, trace_data, first_frame, num_frames);
 
        if (etm_ctx->trace_depth > 0)
-       {
                free(etm_ctx->trace_data);
-       }
 
        etm_ctx->trace_depth = num_frames * 16;
-       etm_ctx->trace_data = malloc(sizeof(etmv1_trace_data_t) * etm_ctx->trace_depth);
+       etm_ctx->trace_data = malloc(sizeof(struct etmv1_trace_data) * etm_ctx->trace_depth);
 
-       for (i = 0; i < num_frames * 16; i++)
-       {
+       for (i = 0; i < num_frames * 16; i++) {
                etm_ctx->trace_data[i].pipestat = (trace_data[i] & 0x7);
                etm_ctx->trace_data[i].packet = (trace_data[i] & 0x78) >> 3;
                etm_ctx->trace_data[i].flags = 0;
 
                if ((trace_data[i] & 0x80) >> 7)
-               {
                        etm_ctx->trace_data[i].flags |= ETMV1_TRACESYNC_CYCLE;
-               }
 
-               if (etm_ctx->trace_data[i].pipestat == STAT_TR)
-               {
+               if (etm_ctx->trace_data[i].pipestat == STAT_TR) {
                        etm_ctx->trace_data[i].pipestat = etm_ctx->trace_data[i].packet & 0x7;
                        etm_ctx->trace_data[i].flags |= ETMV1_TRIGGER_CYCLE;
                }
@@ -233,27 +224,24 @@ static int oocd_trace_read_trace(etm_context_t *etm_ctx)
        return ERROR_OK;
 }
 
-static int oocd_trace_start_capture(etm_context_t *etm_ctx)
+static int oocd_trace_start_capture(struct etm_context *etm_ctx)
 {
-       oocd_trace_t *oocd_trace = etm_ctx->capture_driver_priv;
+       struct oocd_trace *oocd_trace = etm_ctx->capture_driver_priv;
        uint32_t control = 0x1; /* 0x1: enabled */
        uint32_t trigger_count;
 
-       if (((etm_ctx->portmode & ETM_PORT_MODE_MASK) != ETM_PORT_NORMAL)
-               || ((etm_ctx->portmode & ETM_PORT_WIDTH_MASK) != ETM_PORT_4BIT))
-       {
+       if (((etm_ctx->control & ETM_PORT_MODE_MASK) != ETM_PORT_NORMAL)
+               || ((etm_ctx->control & ETM_PORT_WIDTH_MASK) != ETM_PORT_4BIT)) {
                LOG_DEBUG("OpenOCD + trace only supports normal 4-bit ETM mode");
                return ERROR_ETM_PORTMODE_NOT_SUPPORTED;
        }
 
-       if ((etm_ctx->portmode & ETM_PORT_CLOCK_MASK) == ETM_PORT_HALF_CLOCK)
-       {
+       if ((etm_ctx->control & ETM_PORT_CLOCK_MASK) == ETM_PORT_HALF_CLOCK)
                control |= 0x2; /* half rate clock, capture at twice the clock rate */
-       }
 
        /* OpenOCD + trace holds up to 16 million samples,
         * but trigger counts is set in multiples of 16 */
-       trigger_count = (1048576 * etm_ctx->trigger_percent) / 100;
+       trigger_count = (1048576 * /* trigger_percent */ 50) / 100;
 
        /* capturing always starts at address zero */
        oocd_trace_write_reg(oocd_trace, OOCD_TRACE_ADDRESS, 0x0);
@@ -266,9 +254,9 @@ static int oocd_trace_start_capture(etm_context_t *etm_ctx)
        return ERROR_OK;
 }
 
-static int oocd_trace_stop_capture(etm_context_t *etm_ctx)
+static int oocd_trace_stop_capture(struct etm_context *etm_ctx)
 {
-       oocd_trace_t *oocd_trace = etm_ctx->capture_driver_priv;
+       struct oocd_trace *oocd_trace = etm_ctx->capture_driver_priv;
 
        /* trace stopped, just clear running flag, but preserve others */
        etm_ctx->capture_status &= ~TRACE_RUNNING;
@@ -278,146 +266,152 @@ static int oocd_trace_stop_capture(etm_context_t *etm_ctx)
        return ERROR_OK;
 }
 
-etm_capture_driver_t oocd_trace_capture_driver =
+COMMAND_HANDLER(handle_oocd_trace_config_command)
 {
-       .name = "oocd_trace",
-       .register_commands = oocd_trace_register_commands,
-       .init = oocd_trace_init,
-       .status = oocd_trace_status,
-       .start_capture = oocd_trace_start_capture,
-       .stop_capture = oocd_trace_stop_capture,
-       .read_trace = oocd_trace_read_trace,
-};
-
-static int handle_oocd_trace_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
-{
-       target_t *target;
-       armv4_5_common_t *armv4_5;
-       arm7_9_common_t *arm7_9;
-
-       if (argc != 2)
-       {
-               LOG_ERROR("incomplete 'oocd_trace config <target> <tty>' command");
-               exit(-1);
-       }
+       struct target *target;
+       struct arm *arm;
 
-       target = get_current_target(cmd_ctx);
+       if (CMD_ARGC != 2)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
-       if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
-       {
-               command_print(cmd_ctx, "current target isn't an ARM7/ARM9 target");
-               return ERROR_OK;
+       target = get_current_target(CMD_CTX);
+       arm = target_to_arm(target);
+       if (!is_arm(arm)) {
+               command_print(CMD_CTX, "current target isn't an ARM");
+               return ERROR_FAIL;
        }
 
-       if (arm7_9->etm_ctx)
-       {
-               oocd_trace_t *oocd_trace = malloc(sizeof(oocd_trace_t));
+       if (arm->etm) {
+               struct oocd_trace *oocd_trace = malloc(sizeof(struct oocd_trace));
 
-               arm7_9->etm_ctx->capture_driver_priv = oocd_trace;
-               oocd_trace->etm_ctx = arm7_9->etm_ctx;
+               arm->etm->capture_driver_priv = oocd_trace;
+               oocd_trace->etm_ctx = arm->etm;
 
                /* copy name of TTY device used to communicate with OpenOCD + trace */
-               oocd_trace->tty = strndup(args[1], 256);
-       }
-       else
-       {
+               oocd_trace->tty = strndup(CMD_ARGV[1], 256);
+       } else
                LOG_ERROR("target has no ETM defined, OpenOCD + trace left unconfigured");
-       }
 
        return ERROR_OK;
 }
 
-static int handle_oocd_trace_status_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_oocd_trace_status_command)
 {
-       target_t *target;
-       armv4_5_common_t *armv4_5;
-       arm7_9_common_t *arm7_9;
-       oocd_trace_t *oocd_trace;
+       struct target *target;
+       struct arm *arm;
+       struct oocd_trace *oocd_trace;
        uint32_t status;
 
-       target = get_current_target(cmd_ctx);
+       target = get_current_target(CMD_CTX);
 
-       if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
-       {
-               command_print(cmd_ctx, "current target isn't an ARM7/ARM9 target");
-               return ERROR_OK;
+       arm = target_to_arm(target);
+       if (!is_arm(arm)) {
+               command_print(CMD_CTX, "current target isn't an ARM");
+               return ERROR_FAIL;
        }
 
-       if (!arm7_9->etm_ctx)
-       {
-               command_print(cmd_ctx, "current target doesn't have an ETM configured");
-               return ERROR_OK;
+       if (!arm->etm) {
+               command_print(CMD_CTX, "current target doesn't have an ETM configured");
+               return ERROR_FAIL;
        }
 
-       if (strcmp(arm7_9->etm_ctx->capture_driver->name, "oocd_trace") != 0)
-       {
-               command_print(cmd_ctx, "current target's ETM capture driver isn't 'oocd_trace'");
-               return ERROR_OK;
+       if (strcmp(arm->etm->capture_driver->name, "oocd_trace") != 0) {
+               command_print(CMD_CTX, "current target's ETM capture driver isn't 'oocd_trace'");
+               return ERROR_FAIL;
        }
 
-       oocd_trace = (oocd_trace_t*)arm7_9->etm_ctx->capture_driver_priv;
+       oocd_trace = (struct oocd_trace *)arm->etm->capture_driver_priv;
 
        oocd_trace_read_reg(oocd_trace, OOCD_TRACE_STATUS, &status);
 
        if (status & 0x8)
-               command_print(cmd_ctx, "trace clock locked");
+               command_print(CMD_CTX, "trace clock locked");
        else
-               command_print(cmd_ctx, "no trace clock");
+               command_print(CMD_CTX, "no trace clock");
 
        return ERROR_OK;
 }
 
-static int handle_oocd_trace_resync_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_oocd_trace_resync_command)
 {
-       target_t *target;
-       armv4_5_common_t *armv4_5;
-       arm7_9_common_t *arm7_9;
-       oocd_trace_t *oocd_trace;
+       struct target *target;
+       struct arm *arm;
+       struct oocd_trace *oocd_trace;
        size_t bytes_written;
        uint8_t cmd_array[1];
 
-       target = get_current_target(cmd_ctx);
+       target = get_current_target(CMD_CTX);
 
-       if (arm7_9_get_arch_pointers(target, &armv4_5, &arm7_9) != ERROR_OK)
-       {
-               command_print(cmd_ctx, "current target isn't an ARM7/ARM9 target");
-               return ERROR_OK;
+       arm = target_to_arm(target);
+       if (!is_arm(arm)) {
+               command_print(CMD_CTX, "current target isn't an ARM");
+               return ERROR_FAIL;
        }
 
-       if (!arm7_9->etm_ctx)
-       {
-               command_print(cmd_ctx, "current target doesn't have an ETM configured");
-               return ERROR_OK;
+       if (!arm->etm) {
+               command_print(CMD_CTX, "current target doesn't have an ETM configured");
+               return ERROR_FAIL;
        }
 
-       if (strcmp(arm7_9->etm_ctx->capture_driver->name, "oocd_trace") != 0)
-       {
-               command_print(cmd_ctx, "current target's ETM capture driver isn't 'oocd_trace'");
-               return ERROR_OK;
+       if (strcmp(arm->etm->capture_driver->name, "oocd_trace") != 0) {
+               command_print(CMD_CTX, "current target's ETM capture driver isn't 'oocd_trace'");
+               return ERROR_FAIL;
        }
 
-       oocd_trace = (oocd_trace_t*)arm7_9->etm_ctx->capture_driver_priv;
+       oocd_trace = (struct oocd_trace *)arm->etm->capture_driver_priv;
 
        cmd_array[0] = 0xf0;
 
        bytes_written = write(oocd_trace->tty_fd, cmd_array, 1);
+       if (bytes_written < 1)
+               return ERROR_FAIL;
 
-       command_print(cmd_ctx, "requesting traceclock resync");
+       command_print(CMD_CTX, "requesting traceclock resync");
        LOG_DEBUG("resyncing traceclk pll");
 
        return ERROR_OK;
 }
 
-int oocd_trace_register_commands(struct command_context_s *cmd_ctx)
-{
-       command_t *oocd_trace_cmd;
-
-       oocd_trace_cmd = register_command(cmd_ctx, NULL, "oocd_trace", NULL, COMMAND_ANY, "OpenOCD + trace");
-
-       register_command(cmd_ctx, oocd_trace_cmd, "config", handle_oocd_trace_config_command, COMMAND_CONFIG, NULL);
-
-       register_command(cmd_ctx, oocd_trace_cmd, "status", handle_oocd_trace_status_command, COMMAND_EXEC, "display OpenOCD + trace status");
-       register_command(cmd_ctx, oocd_trace_cmd, "resync", handle_oocd_trace_resync_command, COMMAND_EXEC, "resync OpenOCD + trace capture clock");
+static const struct command_registration oocd_trace_all_command_handlers[] = {
+       {
+               .name = "config",
+               .handler = handle_oocd_trace_config_command,
+               .mode = COMMAND_CONFIG,
+               .usage = "<target> <tty>",
+       },
+       {
+               .name = "status",
+               .handler = handle_oocd_trace_status_command,
+               .mode = COMMAND_EXEC,
+               .usage = "",
+               .help = "display OpenOCD + trace status",
+       },
+       {
+               .name = "resync",
+               .handler = handle_oocd_trace_resync_command,
+               .mode = COMMAND_EXEC,
+               .usage = "",
+               .help = "resync OpenOCD + trace capture clock",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+static const struct command_registration oocd_trace_command_handlers[] = {
+       {
+               .name = "oocd_trace",
+               .mode = COMMAND_ANY,
+               .help = "OpenOCD trace capture driver command group",
+               .usage = "",
+               .chain = oocd_trace_all_command_handlers,
+       },
+       COMMAND_REGISTRATION_DONE
+};
 
-       return ERROR_OK;
-}
+struct etm_capture_driver oocd_trace_capture_driver = {
+       .name = "oocd_trace",
+       .commands = oocd_trace_command_handlers,
+       .init = oocd_trace_init,
+       .status = oocd_trace_status,
+       .start_capture = oocd_trace_start_capture,
+       .stop_capture = oocd_trace_stop_capture,
+       .read_trace = oocd_trace_read_trace,
+};