use COMMAND_REGISTER macro
[openocd.git] / src / jtag / arm-jtag-ew.c
index 3068a15f47c30feac528f101b54728e22b2a7e1c..f239371302cad6dc6a3007c3261b0fe4b0b21e44 100644 (file)
@@ -25,6 +25,7 @@
 #include "interface.h"
 #include "commands.h"
 #include <usb.h>
+#include "usb_common.h"
 
 
 #define USB_VID                                                0x15ba
 static uint8_t usb_in_buffer[ARMJTAGEW_IN_BUFFER_SIZE];
 static uint8_t usb_out_buffer[ARMJTAGEW_OUT_BUFFER_SIZE];
 
-/* External interface functions */
-static int armjtagew_execute_queue(void);
-static int armjtagew_speed(int speed);
-static int armjtagew_khz(int khz, int *jtag_speed);
-static int armjtagew_register_commands(struct command_context_s *cmd_ctx);
-static int armjtagew_init(void);
-static int armjtagew_quit(void);
-
-/* CLI command handler functions */
-static int armjtagew_handle_armjtagew_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-
 /* Queue command functions */
 static void armjtagew_end_state(tap_state_t state);
 static void armjtagew_state_move(void);
 static void armjtagew_path_move(int num_states, tap_state_t *path);
 static void armjtagew_runtest(int num_cycles);
-static void armjtagew_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size, scan_command_t *command);
+static void armjtagew_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size, struct scan_command *command);
 static void armjtagew_reset(int trst, int srst);
 //static void armjtagew_simple_command(uint8_t command);
 static int armjtagew_get_status(void);
@@ -81,19 +71,18 @@ static void armjtagew_tap_init(void);
 static int armjtagew_tap_execute(void);
 static void armjtagew_tap_ensure_space(int scans, int bits);
 static void armjtagew_tap_append_step(int tms, int tdi);
-static void armjtagew_tap_append_scan(int length, uint8_t *buffer, scan_command_t *command);
+static void armjtagew_tap_append_scan(int length, uint8_t *buffer, struct scan_command *command);
 
 /* ARM-JTAG-EW lowlevel functions */
-typedef struct armjtagew_jtag
-{
+struct armjtagew {
        struct usb_dev_handle* usb_handle;
-} armjtagew_jtag_t;
+};
 
-static armjtagew_jtag_t *armjtagew_usb_open(void);
-static void armjtagew_usb_close(armjtagew_jtag_t *armjtagew_jtag);
-static int armjtagew_usb_message(armjtagew_jtag_t *armjtagew_jtag, int out_length, int in_length);
-static int armjtagew_usb_write(armjtagew_jtag_t *armjtagew_jtag, int out_length);
-static int armjtagew_usb_read(armjtagew_jtag_t *armjtagew_jtag, int exp_in_length);
+static struct armjtagew *armjtagew_usb_open(void);
+static void armjtagew_usb_close(struct armjtagew *armjtagew);
+static int armjtagew_usb_message(struct armjtagew *armjtagew, int out_length, int in_length);
+static int armjtagew_usb_write(struct armjtagew *armjtagew, int out_length);
+static int armjtagew_usb_read(struct armjtagew *armjtagew, int exp_in_length);
 
 /* helper functions */
 static int armjtagew_get_version_info(void);
@@ -102,28 +91,16 @@ static int armjtagew_get_version_info(void);
 static void armjtagew_debug_buffer(uint8_t *buffer, int length);
 #endif
 
-static armjtagew_jtag_t* armjtagew_jtag_handle;
+static struct armjtagew* armjtagew_handle;
 
 
 
 /***************************************************************************/
 /* External interface implementation */
 
-jtag_interface_t armjtagew_interface =
-{
-       .name = "arm-jtag-ew",
-       .execute_queue = armjtagew_execute_queue,
-       .speed = armjtagew_speed,
-       .khz = armjtagew_khz,
-       .register_commands = armjtagew_register_commands,
-       .init = armjtagew_init,
-       .quit = armjtagew_quit
-};
-
-
 static int armjtagew_execute_queue(void)
 {
-       jtag_command_t *cmd = jtag_command_queue;
+       struct jtag_command *cmd = jtag_command_queue;
        int scan_size;
        enum scan_type type;
        uint8_t *buffer;
@@ -133,7 +110,7 @@ static int armjtagew_execute_queue(void)
                switch (cmd->type)
                {
                        case JTAG_RUNTEST:
-                               DEBUG_JTAG_IO( "runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, \
+                               DEBUG_JTAG_IO("runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, \
                                        cmd->cmd.runtest->end_state);
 
                                armjtagew_end_state(cmd->cmd.runtest->end_state);
@@ -209,7 +186,7 @@ static int armjtagew_speed(int speed)
     usb_out_buffer[0] = CMD_SET_TCK_FREQUENCY;
        buf_set_u32(usb_out_buffer + 1, 0, 32, speed);
 
-    result = armjtagew_usb_message(armjtagew_jtag_handle, 4, 4);
+    result = armjtagew_usb_message(armjtagew_handle, 4, 4);
 
     if (result < 0)
     {
@@ -218,7 +195,7 @@ static int armjtagew_speed(int speed)
     }
 
        usb_out_buffer[0] = CMD_GET_TCK_FREQUENCY;
-    result = armjtagew_usb_message(armjtagew_jtag_handle, 1, 4);
+    result = armjtagew_usb_message(armjtagew_handle, 1, 4);
        speed_real = (int)buf_get_u32(usb_in_buffer,0,32);
        if (result < 0)
        {
@@ -241,20 +218,13 @@ static int armjtagew_khz(int khz, int *jtag_speed)
        return ERROR_OK;
 }
 
-static int armjtagew_register_commands(struct command_context_s *cmd_ctx)
-{
-       register_command(cmd_ctx, NULL, "armjtagew_info", armjtagew_handle_armjtagew_info_command, COMMAND_EXEC,
-               "query armjtagew info");
-       return ERROR_OK;
-}
-
 static int armjtagew_init(void)
 {
        int check_cnt;
 
-       armjtagew_jtag_handle = armjtagew_usb_open();
+       armjtagew_handle = armjtagew_usb_open();
 
-       if (armjtagew_jtag_handle == 0)
+       if (armjtagew_handle == 0)
        {
                LOG_ERROR("Cannot find ARM-JTAG-EW Interface! Please check connection and permissions.");
                return ERROR_JTAG_INIT_FAILED;
@@ -288,7 +258,7 @@ static int armjtagew_init(void)
 
 static int armjtagew_quit(void)
 {
-       armjtagew_usb_close(armjtagew_jtag_handle);
+       armjtagew_usb_close(armjtagew_handle);
        return ERROR_OK;
 }
 
@@ -383,7 +353,7 @@ static void armjtagew_runtest(int num_cycles)
        }
 }
 
-static void armjtagew_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size, scan_command_t *command)
+static void armjtagew_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size, struct scan_command *command)
 {
        tap_state_t saved_end_state;
 
@@ -452,7 +422,7 @@ static void armjtagew_reset(int trst, int srst)
        usb_out_buffer[1] = val;
        usb_out_buffer[2] = outp_en;
        usb_out_buffer[3] = change_mask;
-       result = armjtagew_usb_write(armjtagew_jtag_handle, 4);
+       result = armjtagew_usb_write(armjtagew_handle, 4);
        if (result != 4)
        {
                LOG_ERROR("ARM-JTAG-EW TRST/SRST pin set failed failed (%d)", result);
@@ -465,18 +435,18 @@ static int armjtagew_get_status(void)
        int result;
 
        usb_out_buffer[0] = CMD_GET_TAPHW_STATE;
-       result = armjtagew_usb_message(armjtagew_jtag_handle, 1, 12);
+       result = armjtagew_usb_message(armjtagew_handle, 1, 12);
 
        if (result == 0)
        {
                unsigned int u_tg = buf_get_u32(usb_in_buffer, 0, 16);
-               LOG_INFO("U_tg = %d mV, U_aux = %d mV, U_tgpwr = %d mV, I_tgpwr = %d mA, D1 = %d, Target power %s %s\n", 
+               LOG_INFO("U_tg = %d mV, U_aux = %d mV, U_tgpwr = %d mV, I_tgpwr = %d mA, D1 = %d, Target power %s %s\n",
                         (int)(buf_get_u32(usb_in_buffer + 0, 0, 16)),
                         (int)(buf_get_u32(usb_in_buffer + 2, 0, 16)),
                         (int)(buf_get_u32(usb_in_buffer + 4, 0, 16)),
                         (int)(buf_get_u32(usb_in_buffer + 6, 0, 16)),
-                        usb_in_buffer[9], 
-                        usb_in_buffer[11] ? "OVERCURRENT" : "OK", 
+                        usb_in_buffer[9],
+                        usb_in_buffer[11] ? "OVERCURRENT" : "OK",
                         usb_in_buffer[10] ? "enabled" : "disabled");
 
                if (u_tg < 1500)
@@ -500,7 +470,7 @@ static int armjtagew_get_version_info(void)
 
        /* query hardware version */
        usb_out_buffer[0] = CMD_GET_VERSION;
-       result = armjtagew_usb_message(armjtagew_jtag_handle, 1, 4 + 15 + 256);
+       result = armjtagew_usb_message(armjtagew_handle, 1, 4 + 15 + 256);
 
        if (result != 0)
        {
@@ -521,7 +491,7 @@ static int armjtagew_get_version_info(void)
        return ERROR_OK;
 }
 
-static int armjtagew_handle_armjtagew_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(armjtagew_handle_armjtagew_info_command)
 {
        if (armjtagew_get_version_info() == ERROR_OK)
        {
@@ -532,6 +502,24 @@ static int armjtagew_handle_armjtagew_info_command(struct command_context_s *cmd
        return ERROR_OK;
 }
 
+static int armjtagew_register_commands(struct command_context *cmd_ctx)
+{
+       COMMAND_REGISTER(cmd_ctx, NULL, "armjtagew_info",
+                       &armjtagew_handle_armjtagew_info_command, COMMAND_EXEC,
+                       "query armjtagew info");
+       return ERROR_OK;
+}
+
+struct jtag_interface armjtagew_interface = {
+               .name = "arm-jtag-ew",
+               .execute_queue = &armjtagew_execute_queue,
+               .speed = &armjtagew_speed,
+               .khz = &armjtagew_khz,
+               .register_commands = &armjtagew_register_commands,
+               .init = &armjtagew_init,
+               .quit = &armjtagew_quit,
+       };
+
 /***************************************************************************/
 /* ARM-JTAG-EW tap functions */
 
@@ -543,18 +531,17 @@ static uint8_t tms_buffer[ARMJTAGEW_TAP_BUFFER_SIZE];
 static uint8_t tdi_buffer[ARMJTAGEW_TAP_BUFFER_SIZE];
 static uint8_t tdo_buffer[ARMJTAGEW_TAP_BUFFER_SIZE];
 
-typedef struct
-{
+struct pending_scan_result {
        int first;      /* First bit position in tdo_buffer to read */
        int length; /* Number of bits to read */
-       scan_command_t *command; /* Corresponding scan command */
+       struct scan_command *command; /* Corresponding scan command */
        uint8_t *buffer;
-} pending_scan_result_t;
+};
 
 #define MAX_PENDING_SCAN_RESULTS 256
 
 static int pending_scan_results_length;
-static pending_scan_result_t pending_scan_results_buffer[MAX_PENDING_SCAN_RESULTS];
+static struct pending_scan_result pending_scan_results_buffer[MAX_PENDING_SCAN_RESULTS];
 
 static int last_tms;
 
@@ -611,9 +598,9 @@ static void armjtagew_tap_append_step(int tms, int tdi)
        }
 }
 
-void armjtagew_tap_append_scan(int length, uint8_t *buffer, scan_command_t *command)
+void armjtagew_tap_append_scan(int length, uint8_t *buffer, struct scan_command *command)
 {
-       pending_scan_result_t *pending_scan_result = &pending_scan_results_buffer[pending_scan_results_length];
+       struct pending_scan_result *pending_scan_result = &pending_scan_results_buffer[pending_scan_results_length];
        int i;
 
        pending_scan_result->first = tap_length;
@@ -665,7 +652,7 @@ static int armjtagew_tap_execute(void)
                        usb_out_buffer[tdi_offset + i] = flip_u32(tdi_buffer[i],8);
                }
 
-               result = armjtagew_usb_message(armjtagew_jtag_handle, 3 + 2 * byte_length, byte_length + 4);
+               result = armjtagew_usb_message(armjtagew_handle, 3 + 2 * byte_length, byte_length + 4);
 
                if (result == 0)
                {
@@ -684,11 +671,11 @@ static int armjtagew_tap_execute(void)
 
                        for (i = 0; i < pending_scan_results_length; i++)
                        {
-                               pending_scan_result_t *pending_scan_result = &pending_scan_results_buffer[i];
+                               struct pending_scan_result *pending_scan_result = &pending_scan_results_buffer[i];
                                uint8_t *buffer = pending_scan_result->buffer;
                                int length = pending_scan_result->length;
                                int first = pending_scan_result->first;
-                               scan_command_t *command = pending_scan_result->command;
+                               struct scan_command *command = pending_scan_result->command;
 
                                /* Copy to buffer */
                                buf_set_buf(tdo_buffer, first, buffer, 0, length);
@@ -726,69 +713,49 @@ static int armjtagew_tap_execute(void)
 /*****************************************************************************/
 /* JLink USB low-level functions */
 
-static armjtagew_jtag_t* armjtagew_usb_open()
+static struct armjtagew* armjtagew_usb_open()
 {
-       struct usb_bus *busses;
-       struct usb_bus *bus;
-       struct usb_device *dev;
-
-       armjtagew_jtag_t *result;
-
-       result = (armjtagew_jtag_t*) malloc(sizeof(armjtagew_jtag_t));
-
        usb_init();
-       usb_find_busses();
-       usb_find_devices();
 
-       busses = usb_get_busses();
+       const uint16_t vids[] = { USB_VID, 0 };
+       const uint16_t pids[] = { USB_PID, 0 };
+       struct usb_dev_handle *dev;
+       if (jtag_usb_open(vids, pids, &dev) != ERROR_OK)
+               return NULL;
 
-       /* find armjtagew_jtag device in usb bus */
-
-       for (bus = busses; bus; bus = bus->next)
-       {
-               for (dev = bus->devices; dev; dev = dev->next)
-               {
-                       if ((dev->descriptor.idVendor == USB_VID) && (dev->descriptor.idProduct == USB_PID))
-                       {
-                               result->usb_handle = usb_open(dev);
+       struct armjtagew *result = malloc(sizeof(struct armjtagew));
+       result->usb_handle = dev;
 
 #if 0
-                               /* usb_set_configuration required under win32 */
-                               usb_set_configuration(result->usb_handle, dev->config[0].bConfigurationValue);
+       /* usb_set_configuration required under win32 */
+       usb_set_configuration(dev, dev->config[0].bConfigurationValue);
 #endif
-                               usb_claim_interface(result->usb_handle, 0);
-
+       usb_claim_interface(dev, 0);
 #if 0
-                               /*
-                                * This makes problems under Mac OS X. And is not needed
-                                * under Windows. Hopefully this will not break a linux build
-                                */
-                               usb_set_altinterface(result->usb_handle, 0);
+       /*
+        * This makes problems under Mac OS X. And is not needed
+        * under Windows. Hopefully this will not break a linux build
+        */
+       usb_set_altinterface(dev, 0);
 #endif
-                               return result;
-                       }
-               }
-       }
-
-       free(result);
-       return NULL;
+       return result;
 }
 
-static void armjtagew_usb_close(armjtagew_jtag_t *armjtagew_jtag)
+static void armjtagew_usb_close(struct armjtagew *armjtagew)
 {
-       usb_close(armjtagew_jtag->usb_handle);
-       free(armjtagew_jtag);
+       usb_close(armjtagew->usb_handle);
+       free(armjtagew);
 }
 
 /* Send a message and receive the reply. */
-static int armjtagew_usb_message(armjtagew_jtag_t *armjtagew_jtag, int out_length, int in_length)
+static int armjtagew_usb_message(struct armjtagew *armjtagew, int out_length, int in_length)
 {
        int result;
 
-       result = armjtagew_usb_write(armjtagew_jtag, out_length);
+       result = armjtagew_usb_write(armjtagew, out_length);
        if (result == out_length)
        {
-               result = armjtagew_usb_read(armjtagew_jtag, in_length);
+               result = armjtagew_usb_read(armjtagew, in_length);
                if (result != in_length)
                {
                        LOG_ERROR("usb_bulk_read failed (requested=%d, result=%d)", in_length, result);
@@ -804,17 +771,17 @@ static int armjtagew_usb_message(armjtagew_jtag_t *armjtagew_jtag, int out_lengt
 }
 
 /* Write data from out_buffer to USB. */
-static int armjtagew_usb_write(armjtagew_jtag_t *armjtagew_jtag, int out_length)
+static int armjtagew_usb_write(struct armjtagew *armjtagew, int out_length)
 {
        int result;
 
        if (out_length > ARMJTAGEW_OUT_BUFFER_SIZE)
        {
-               LOG_ERROR("armjtagew_jtag_write illegal out_length=%d (max=%d)", out_length, ARMJTAGEW_OUT_BUFFER_SIZE);
+               LOG_ERROR("armjtagew_write illegal out_length=%d (max=%d)", out_length, ARMJTAGEW_OUT_BUFFER_SIZE);
                return -1;
        }
 
-       result = usb_bulk_write(armjtagew_jtag->usb_handle, ARMJTAGEW_EPT_BULK_OUT, \
+       result = usb_bulk_write(armjtagew->usb_handle, ARMJTAGEW_EPT_BULK_OUT, \
                (char*)usb_out_buffer, out_length, ARMJTAGEW_USB_TIMEOUT);
 
        DEBUG_JTAG_IO("armjtagew_usb_write, out_length = %d, result = %d", out_length, result);
@@ -826,9 +793,9 @@ static int armjtagew_usb_write(armjtagew_jtag_t *armjtagew_jtag, int out_length)
 }
 
 /* Read data from USB into in_buffer. */
-static int armjtagew_usb_read(armjtagew_jtag_t *armjtagew_jtag, int exp_in_length)
+static int armjtagew_usb_read(struct armjtagew *armjtagew, int exp_in_length)
 {
-       int result = usb_bulk_read(armjtagew_jtag->usb_handle, ARMJTAGEW_EPT_BULK_IN, \
+       int result = usb_bulk_read(armjtagew->usb_handle, ARMJTAGEW_EPT_BULK_IN, \
                (char*)usb_in_buffer, exp_in_length, ARMJTAGEW_USB_TIMEOUT);
 
        DEBUG_JTAG_IO("armjtagew_usb_read, result = %d", result);

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)