build: cleanup src/jtag/drivers directory
[fw/openocd] / src / jtag / drivers / vsllink.c
index e39a4d627902baa0bc71af4bd60bcd698e5f788f..1c0c3e1eeed5bfc5bb7de3bef7a319a4d4a9e3bb 100644 (file)
@@ -38,18 +38,18 @@ static int vsllink_tms_offset;
 struct pending_scan_result {
        int src_offset;
        int dest_offset;
-       int length; /* Number of bits to read */
-       struct scan_command *command; /* Corresponding scan command */
+       int length;     /* Number of bits to read */
+       struct scan_command *command;   /* Corresponding scan command */
        uint8_t *ack;
        uint8_t *buffer;
-       bool last; /* indicate the last scan pending */
+       bool last;      /* indicate the last scan pending */
 };
 
 #define MAX_PENDING_SCAN_RESULTS 256
 
 static int pending_scan_results_length;
 static struct pending_scan_result
-               pending_scan_results_buffer[MAX_PENDING_SCAN_RESULTS];
+       pending_scan_results_buffer[MAX_PENDING_SCAN_RESULTS];
 
 /* Queue command functions */
 static void vsllink_end_state(tap_state_t state);
@@ -59,7 +59,7 @@ static void vsllink_tms(int num_bits, const uint8_t *bits);
 static void vsllink_runtest(int num_cycles);
 static void vsllink_stableclocks(int num_cycles, int tms);
 static void vsllink_scan(bool ir_scan, enum scan_type type,
-       uint8_t *buffer, int scan_size, struct scan_command *command);
+               uint8_t *buffer, int scan_size, struct scan_command *command);
 static void vsllink_reset(int trst, int srst);
 
 /* VSLLink tap buffer functions */
@@ -105,9 +105,8 @@ static int vsllink_execute_queue(void)
                switch (cmd->type) {
                        case JTAG_RUNTEST:
                                DEBUG_JTAG_IO("runtest %i cycles, end in %s",
-                                       cmd->cmd.runtest->num_cycles,
-                                       tap_state_name(cmd->cmd.runtest
-                                                       ->end_state));
+                                               cmd->cmd.runtest->num_cycles,
+                                               tap_state_name(cmd->cmd.runtest->end_state));
 
                                vsllink_end_state(cmd->cmd.runtest->end_state);
                                vsllink_runtest(cmd->cmd.runtest->num_cycles);
@@ -115,24 +114,18 @@ static int vsllink_execute_queue(void)
 
                        case JTAG_TLR_RESET:
                                DEBUG_JTAG_IO("statemove end in %s",
-                                       tap_state_name(cmd->cmd.statemove
-                                                       ->end_state));
+                                               tap_state_name(cmd->cmd.statemove->end_state));
 
-                               vsllink_end_state(cmd->cmd.statemove
-                                                       ->end_state);
+                               vsllink_end_state(cmd->cmd.statemove->end_state);
                                vsllink_state_move();
                                break;
 
                        case JTAG_PATHMOVE:
                                DEBUG_JTAG_IO("pathmove: %i states, end in %s",
-                                       cmd->cmd.pathmove->num_states,
-                                       tap_state_name(cmd->cmd.pathmove
-                                               ->path[cmd->cmd.pathmove
-                                                       ->num_states - 1]));
-
-                               vsllink_path_move(
-                                       cmd->cmd.pathmove->num_states,
-                                       cmd->cmd.pathmove->path);
+                                               cmd->cmd.pathmove->num_states,
+                                               tap_state_name(cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]));
+
+                               vsllink_path_move(cmd->cmd.pathmove->num_states, cmd->cmd.pathmove->path);
                                break;
 
                        case JTAG_SCAN:
@@ -141,27 +134,25 @@ static int vsllink_execute_queue(void)
                                vsllink_end_state(cmd->cmd.scan->end_state);
 
                                scan_size = jtag_build_buffer(
-                                       cmd->cmd.scan, &buffer);
+                                               cmd->cmd.scan, &buffer);
 
                                if (cmd->cmd.scan->ir_scan)
                                        DEBUG_JTAG_IO(
-                                               "JTAG Scan write IR(%d bits), "
-                                               "end in %s:",
-                                               scan_size,
-                                               tap_state_name(cmd->cmd.scan
-                                                               ->end_state));
+                                                       "JTAG Scan write IR(%d bits), "
+                                                       "end in %s:",
+                                                       scan_size,
+                                                       tap_state_name(cmd->cmd.scan->end_state));
 
                                else
                                        DEBUG_JTAG_IO(
-                                               "JTAG Scan write DR(%d bits), "
-                                               "end in %s:",
-                                               scan_size,
-                                               tap_state_name(cmd->cmd.scan
-                                                       ->end_state));
+                                                       "JTAG Scan write DR(%d bits), "
+                                                       "end in %s:",
+                                                       scan_size,
+                                                       tap_state_name(cmd->cmd.scan->end_state));
 
 #ifdef _DEBUG_JTAG_IO_
                                vsllink_debug_buffer(buffer,
-                                       DIV_ROUND_UP(scan_size, 8));
+                                               DIV_ROUND_UP(scan_size, 8));
 #endif
 
                                type = jtag_scan_type(cmd->cmd.scan);
@@ -193,7 +184,7 @@ static int vsllink_execute_queue(void)
 
                        case JTAG_STABLECLOCKS:
                                DEBUG_JTAG_IO("add %d clocks",
-                                       cmd->cmd.stableclocks->num_cycles);
+                                               cmd->cmd.stableclocks->num_cycles);
 
                                switch (tap_get_state()) {
                                case TAP_RESET:
@@ -210,29 +201,28 @@ static int vsllink_execute_queue(void)
                                        /* else, tms should be '0' */
                                        scan_size = 0;
                                        break;
-                                       /* above stable states are OK */
+                               /* above stable states are OK */
                                default:
-                                        LOG_ERROR("jtag_add_clocks() "
-                                               "in non-stable state \"%s\"",
-                                               tap_state_name(tap_get_state())
-                                               );
-                                exit(-1);
+                                       LOG_ERROR("jtag_add_clocks() "
+                                                       "in non-stable state \"%s\"",
+                                                       tap_state_name(tap_get_state())
+                                       );
+                                       exit(-1);
                                }
-                               vsllink_stableclocks(cmd->cmd.stableclocks
-                                               ->num_cycles, scan_size);
+                               vsllink_stableclocks(cmd->cmd.stableclocks->num_cycles, scan_size);
                                break;
 
-                       case JTAG_TMS:
-                               DEBUG_JTAG_IO("add %d jtag tms",
-                                               cmd->cmd.tms->num_bits);
+                               case JTAG_TMS:
+                                       DEBUG_JTAG_IO("add %d jtag tms",
+                                                       cmd->cmd.tms->num_bits);
 
-                               vsllink_tms(cmd->cmd.tms->num_bits, cmd->cmd.tms->bits);
-                               break;
+                                       vsllink_tms(cmd->cmd.tms->num_bits, cmd->cmd.tms->bits);
+                                       break;
 
-                       default:
-                               LOG_ERROR("BUG: unknown JTAG command type "
-                                       "encountered: %d", cmd->type);
-                               exit(-1);
+                               default:
+                                       LOG_ERROR("BUG: unknown JTAG command type "
+                                                       "encountered: %d", cmd->type);
+                                       exit(-1);
                }
                cmd = cmd->next;
        }
@@ -262,18 +252,15 @@ static int vsllink_speed_div(int jtag_speed, int *khz)
 
 static void vsllink_free_buffer(void)
 {
-       if (tdi_buffer != NULL)
-       {
+       if (tdi_buffer != NULL) {
                free(tdi_buffer);
                tdi_buffer = NULL;
        }
-       if (tdo_buffer != NULL)
-       {
+       if (tdo_buffer != NULL) {
                free(tdo_buffer);
                tdo_buffer = NULL;
        }
-       if (tms_buffer != NULL)
-       {
+       if (tms_buffer != NULL) {
                free(tms_buffer);
                tms_buffer = NULL;
        }
@@ -298,33 +285,29 @@ static int vsllink_init(void)
 {
        vsllink_handle = vsllink_usb_open();
        if (vsllink_handle == 0) {
-               LOG_ERROR("Can't find USB JTAG Interface!"\
-                               "Please check connection and permissions.");
+               LOG_ERROR("Can't find USB JTAG Interface!" \
+                       "Please check connection and permissions.");
                return ERROR_JTAG_INIT_FAILED;
        }
        LOG_DEBUG("vsllink found on %04X:%04X",
-                       versaloon_interface.usb_setting.vid,
-                       versaloon_interface.usb_setting.pid);
+               versaloon_interface.usb_setting.vid,
+               versaloon_interface.usb_setting.pid);
        versaloon_usb_device_handle = vsllink_handle->usb_handle;
 
        if (ERROR_OK != versaloon_interface.init())
-       {
                return ERROR_FAIL;
-       }
-       if (versaloon_interface.usb_setting.buf_size < 32)
-       {
+       if (versaloon_interface.usb_setting.buf_size < 32) {
                versaloon_interface.fini();
                return ERROR_FAIL;
        }
 
-       // malloc buffer size for tap
+       /* malloc buffer size for tap */
        tap_buffer_size = versaloon_interface.usb_setting.buf_size - 32;
        vsllink_free_buffer();
        tdi_buffer = (uint8_t *)malloc(tap_buffer_size);
        tdo_buffer = (uint8_t *)malloc(tap_buffer_size);
        tms_buffer = (uint8_t *)malloc(tap_buffer_size);
-       if ((NULL == tdi_buffer) || (NULL == tdo_buffer) || (NULL == tms_buffer))
-       {
+       if ((NULL == tdi_buffer) || (NULL == tdo_buffer) || (NULL == tms_buffer)) {
                vsllink_quit();
                return ERROR_FAIL;
        }
@@ -333,19 +316,17 @@ static int vsllink_init(void)
        versaloon_interface.adaptors.jtag_raw.config(0, jtag_get_speed_khz());
        versaloon_interface.adaptors.gpio.init(0);
        versaloon_interface.adaptors.gpio.config(0, GPIO_SRST | GPIO_TRST,
-                               GPIO_TRST, GPIO_SRST, GPIO_SRST);
+               GPIO_TRST, GPIO_SRST, GPIO_SRST);
        if (ERROR_OK != versaloon_interface.adaptors.peripheral_commit())
-       {
                return ERROR_FAIL;
-       }
 
        vsllink_reset(0, 0);
        vsllink_tap_init();
        return ERROR_OK;
 }
 
-/***************************************************************************/
-/* Queue command implementations */
+/**************************************************************************
+ * Queue command implementations */
 
 static void vsllink_end_state(tap_state_t state)
 {
@@ -362,9 +343,9 @@ static void vsllink_state_move(void)
 {
        int i;
        uint8_t tms_scan = tap_get_tms_path(tap_get_state(),
-                                       tap_get_end_state());
+                       tap_get_end_state());
        uint8_t tms_scan_bits = tap_get_tms_path_len(tap_get_state(),
-                                       tap_get_end_state());
+                       tap_get_end_state());
 
        for (i = 0; i < tms_scan_bits; i++)
                vsllink_tap_append_step((tms_scan >> i) & 1, 0);
@@ -381,8 +362,8 @@ static void vsllink_path_move(int num_states, tap_state_t *path)
                        vsllink_tap_append_step(1, 0);
                else {
                        LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
-                                               tap_state_name(tap_get_state()),
-                                               tap_state_name(path[i]));
+                               tap_state_name(tap_get_state()),
+                               tap_state_name(path[i]));
                        exit(-1);
                }
 
@@ -394,9 +375,8 @@ static void vsllink_path_move(int num_states, tap_state_t *path)
 
 static void vsllink_tms(int num_bits, const uint8_t *bits)
 {
-       for (int i = 0; i < num_bits; i++) {
+       for (int i = 0; i < num_bits; i++)
                vsllink_tap_append_step((bits[i / 8] >> (i % 8)) & 1, 0);
-       }
 }
 
 static void vsllink_stableclocks(int num_cycles, int tms)
@@ -419,15 +399,15 @@ static void vsllink_runtest(int num_cycles)
 
        vsllink_stableclocks(num_cycles, 0);
 
-       // post-process
-       // set end_state
+       /* post-process */
+       /* set end_state */
        vsllink_end_state(saved_end_state);
        if (tap_get_end_state() != tap_get_end_state())
                vsllink_state_move();
 }
 
 static void vsllink_scan(bool ir_scan, enum scan_type type, uint8_t *buffer,
-                               int scan_size, struct scan_command *command)
+       int scan_size, struct scan_command *command)
 {
        tap_state_t saved_end_state;
 
@@ -471,11 +451,8 @@ static void vsllink_reset(int trst, int srst)
 
 COMMAND_HANDLER(vsllink_handle_usb_vid_command)
 {
-       if (CMD_ARGC != 1) {
-               LOG_ERROR("parameter error, "
-                                       "should be one parameter for VID");
-               return ERROR_OK;
-       }
+       if (CMD_ARGC != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
        COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0],
                versaloon_interface.usb_setting.vid);
@@ -484,11 +461,8 @@ COMMAND_HANDLER(vsllink_handle_usb_vid_command)
 
 COMMAND_HANDLER(vsllink_handle_usb_pid_command)
 {
-       if (CMD_ARGC != 1) {
-               LOG_ERROR("parameter error, "
-                                       "should be one parameter for PID");
-               return ERROR_OK;
-       }
+       if (CMD_ARGC != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
        COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0],
                versaloon_interface.usb_setting.pid);
        return ERROR_OK;
@@ -496,11 +470,8 @@ COMMAND_HANDLER(vsllink_handle_usb_pid_command)
 
 COMMAND_HANDLER(vsllink_handle_usb_bulkin_command)
 {
-       if (CMD_ARGC != 1) {
-               LOG_ERROR("parameter error, "
-                       "should be one parameter for BULKIN endpoint");
-               return ERROR_OK;
-       }
+       if (CMD_ARGC != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
        COMMAND_PARSE_NUMBER(u8, CMD_ARGV[0],
                versaloon_interface.usb_setting.ep_in);
@@ -512,11 +483,8 @@ COMMAND_HANDLER(vsllink_handle_usb_bulkin_command)
 
 COMMAND_HANDLER(vsllink_handle_usb_bulkout_command)
 {
-       if (CMD_ARGC != 1) {
-               LOG_ERROR("parameter error, "
-                       "should be one parameter for BULKOUT endpoint");
-               return ERROR_OK;
-       }
+       if (CMD_ARGC != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
        COMMAND_PARSE_NUMBER(u8, CMD_ARGV[0],
                versaloon_interface.usb_setting.ep_out);
@@ -528,19 +496,16 @@ COMMAND_HANDLER(vsllink_handle_usb_bulkout_command)
 
 COMMAND_HANDLER(vsllink_handle_usb_interface_command)
 {
-       if (CMD_ARGC != 1) {
-               LOG_ERROR("parameter error, "
-                       "should be one parameter for interface number");
-               return ERROR_OK;
-       }
+       if (CMD_ARGC != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
        COMMAND_PARSE_NUMBER(u8, CMD_ARGV[0],
                versaloon_interface.usb_setting.interface);
        return ERROR_OK;
 }
 
-/***************************************************************************/
-/* VSLLink tap functions */
+/**************************************************************************
+ * VSLLink tap functions */
 
 static void vsllink_tap_init(void)
 {
@@ -552,7 +517,7 @@ static void vsllink_tap_init(void)
 static void vsllink_tap_ensure_pending(int scans)
 {
        int available_scans =
-                       MAX_PENDING_SCAN_RESULTS - pending_scan_results_length;
+               MAX_PENDING_SCAN_RESULTS - pending_scan_results_length;
 
        if (scans > available_scans)
                vsllink_tap_execute();
@@ -582,7 +547,7 @@ static void vsllink_tap_append_step(int tms, int tdi)
 }
 
 static void vsllink_tap_append_scan(int length, uint8_t *buffer,
-               struct scan_command *command)
+       struct scan_command *command)
 {
        struct pending_scan_result *pending_scan_result;
        int len_tmp, len_all, i;
@@ -591,8 +556,8 @@ static void vsllink_tap_append_scan(int length, uint8_t *buffer,
        while (len_all < length) {
                vsllink_tap_ensure_pending(1);
                pending_scan_result =
-                               &pending_scan_results_buffer[
-                                       pending_scan_results_length];
+                       &pending_scan_results_buffer[
+                               pending_scan_results_length];
 
                if ((length - len_all) > (tap_buffer_size * 8 - tap_length)) {
                        /* Use all memory available
@@ -612,9 +577,9 @@ static void vsllink_tap_append_scan(int length, uint8_t *buffer,
 
                for (i = 0; i < len_tmp; i++) {
                        vsllink_tap_append_step(((len_all + i) < length-1
-                                               ? 0 : 1),
-                                       (buffer[(len_all + i)/8]
-                                               >> ((len_all + i)%8)) & 1);
+                                                ? 0 : 1),
+                               (buffer[(len_all + i)/8]
+                                >> ((len_all + i)%8)) & 1);
                }
 
                len_all += len_tmp;
@@ -629,7 +594,7 @@ static int vsllink_jtag_execute(void)
        if (tap_length <= 0)
                return ERROR_OK;
 
-       versaloon_interface.adaptors.jtag_raw.execute(0, tdi_buffer, tms_buffer, 
+       versaloon_interface.adaptors.jtag_raw.execute(0, tdi_buffer, tms_buffer,
                tdo_buffer, tap_length);
 
        result = versaloon_interface.adaptors.peripheral_commit();
@@ -654,12 +619,12 @@ static int vsllink_jtag_execute(void)
                                "JTAG scan read(%d bits, from src %d bits to dest %d bits):",
                                length, src_first, dest_first);
                        vsllink_debug_buffer(buffer + dest_first / 8,
-                                       DIV_ROUND_UP(length, 7));
+                               DIV_ROUND_UP(length, 7));
 #endif
 
                        if (last) {
                                if (jtag_read_buffer(buffer, command)
-                                               != ERROR_OK) {
+                                   != ERROR_OK) {
                                        vsllink_tap_init();
                                        return ERROR_JTAG_QUEUE_FAILED;
                                }
@@ -683,22 +648,20 @@ static int vsllink_tap_execute(void)
        return vsllink_jtag_execute();
 }
 
-/*****************************************************************************/
-/* VSLLink USB low-level functions */
+/****************************************************************************
+ * VSLLink USB low-level functions */
 
 static uint8_t usb_check_string(usb_dev_handle *usb, uint8_t stringidx,
-                                                               char * string, char * buff, uint16_t buf_size)
+       char *string, char *buff, uint16_t buf_size)
 {
        int len;
        uint8_t alloced = 0;
        uint8_t ret = 1;
 
-       if (NULL == buff)
-       {
+       if (NULL == buff) {
                buf_size = 256;
-               buff = (char*)malloc(buf_size);
-               if (NULL == buff)
-               {
+               buff = (char *)malloc(buf_size);
+               if (NULL == buff) {
                        ret = 0;
                        goto free_and_return;
                }
@@ -707,31 +670,28 @@ static uint8_t usb_check_string(usb_dev_handle *usb, uint8_t stringidx,
 
        strcpy(buff, "");
        len = usb_get_string_simple(usb, stringidx, (char *)buff, buf_size);
-       if ((len < 0) || (len != ((int)strlen((const char *)buff))))
-       {
+       if ((len < 0) || (len != ((int)strlen((const char *)buff)))) {
                ret = 0;
                goto free_and_return;
        }
 
        buff[len] = '\0';
-       if ((string != NULL) && strcmp((const char *)buff, string))
-       {
+       if ((string != NULL) && strcmp((const char *)buff, string)) {
                ret = 0;
                goto free_and_return;
        }
 
 free_and_return:
-       if (alloced && (buff != NULL))
-       {
+       if (alloced && (buff != NULL)) {
                free(buff);
                buff = NULL;
        }
        return ret;
 }
 
-static usb_dev_handlefind_usb_device(uint16_t VID, uint16_t PID,
-               uint8_t interface, int8_t serialindex, char *serialstring,
-               int8_t productindex, char *productstring)
+static usb_dev_handle *find_usb_device(uint16_t VID, uint16_t PID,
+       uint8_t interface, int8_t serialindex, char *serialstring,
+       int8_t productindex, char *productstring)
 {
        usb_dev_handle *dev_handle = NULL;
        struct usb_bus *busses;
@@ -743,47 +703,39 @@ static usb_dev_handle* find_usb_device(uint16_t VID, uint16_t PID,
        usb_find_devices();
        busses = usb_get_busses();
 
-       for (bus = busses; bus; bus = bus->next)
-       {
-               for (dev = bus->devices; dev; dev = dev->next)
-               {
+       for (bus = busses; bus; bus = bus->next) {
+               for (dev = bus->devices; dev; dev = dev->next) {
                        if ((dev->descriptor.idVendor == VID)
-                               && (dev->descriptor.idProduct == PID))
-                       {
+                           && (dev->descriptor.idProduct == PID)) {
                                dev_handle = usb_open(dev);
-                               if (NULL == dev_handle)
-                               {
+                               if (NULL == dev_handle) {
                                        LOG_ERROR("failed to open %04X:%04X, %s", VID, PID,
-                                                               usb_strerror());
+                                               usb_strerror());
                                        continue;
                                }
 
-                               // check description string
+                               /* check description string */
                                if (((productstring != NULL) && (productindex >= 0)
                                                && !usb_check_string(dev_handle, productindex,
-                                                                                               productstring, NULL, 0))
-                                       || ((serialstring != NULL) && (serialindex >= 0)
-                                               && !usb_check_string(dev_handle, serialindex,
-                                                                                               serialstring, NULL, 0)))
-                               {
+                                               productstring, NULL, 0))
+                                               || ((serialstring != NULL) && (serialindex >= 0)
+                                       && !usb_check_string(dev_handle, serialindex,
+                                               serialstring, NULL, 0))) {
                                        usb_close(dev_handle);
                                        dev_handle = NULL;
                                        continue;
                                }
 
-                               if (usb_claim_interface(dev_handle, interface) != 0)
-                               {
+                               if (usb_claim_interface(dev_handle, interface) != 0) {
                                        LOG_ERROR(ERRMSG_FAILURE_OPERATION_MESSAGE,
-                                                               "claim interface", usb_strerror());
+                                               "claim interface", usb_strerror());
                                        usb_close(dev_handle);
                                        dev_handle = NULL;
                                        continue;
                                }
 
                                if (dev_handle != NULL)
-                               {
                                        return dev_handle;
-                               }
                        }
                }
        }
@@ -798,9 +750,9 @@ static struct vsllink *vsllink_usb_open(void)
        struct usb_dev_handle *dev;
 
        dev = find_usb_device(versaloon_interface.usb_setting.vid,
-                                                       versaloon_interface.usb_setting.pid,
-                                                       versaloon_interface.usb_setting.interface,
-                                                       0, NULL, 2, "Versaloon");
+                       versaloon_interface.usb_setting.pid,
+                       versaloon_interface.usb_setting.interface,
+                       0, NULL, 2, "Versaloon");
        if (NULL == dev)
                return NULL;
 
@@ -817,7 +769,7 @@ static void vsllink_usb_close(struct vsllink *vsllink)
                        versaloon_interface.usb_setting.interface);
        if (ret != 0) {
                LOG_ERROR("fail to release interface %d, %d returned",
-                                       versaloon_interface.usb_setting.interface, ret);
+                       versaloon_interface.usb_setting.interface, ret);
                exit(-1);
        }
 
@@ -849,7 +801,7 @@ static void vsllink_debug_buffer(uint8_t *buffer, int length)
                LOG_DEBUG("%s", line);
        }
 }
-#endif /* _DEBUG_JTAG_IO_ */
+#endif /* _DEBUG_JTAG_IO_ */
 
 static const struct command_registration vsllink_command_handlers[] = {
        {