pld: fix sparser warnings
[openocd.git] / src / pld / virtex2.c
index 77eb8669974f5a36f34f2c87d15820b2a2a11ea3..9b4a0979f3dad8b15d615fdf9ff1f470b1e56b7d 100644 (file)
@@ -1,22 +1,10 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
 /***************************************************************************
  *   Copyright (C) 2006 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   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.             *
  ***************************************************************************/
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 #include "xilinx_bit.h"
 #include "pld.h"
 
+static const struct virtex2_command_set virtex2_default_commands = {
+       .cfg_out   = 0x04,
+       .cfg_in    = 0x05,
+       .jprog_b   = 0x0b,
+       .jstart    = 0x0c,
+       .jshutdown = 0x0d,
+       .bypass    = 0x3f,
+       .user      = {0x02, 0x03},
+       .num_user  = 2, /* virtex II has only 2 user instructions */
+};
 
-static int virtex2_set_instr(struct jtag_tap *tap, uint32_t new_instr)
+static int virtex2_set_instr(struct jtag_tap *tap, uint64_t new_instr)
 {
-       if (tap == NULL)
+       if (!tap)
                return ERROR_FAIL;
 
-       if (buf_get_u32(tap->cur_instr, 0, tap->ir_length) != new_instr)
-       {
+       if (buf_get_u64(tap->cur_instr, 0, tap->ir_length) != new_instr) {
                struct scan_field field;
 
-               field.tap = tap;
                field.num_bits = tap->ir_length;
-               field.out_value = calloc(DIV_ROUND_UP(field.num_bits, 8), 1);
-               buf_set_u32(field.out_value, 0, field.num_bits, new_instr);
+               void *t = calloc(DIV_ROUND_UP(field.num_bits, 8), 1);
+               if (!t) {
+                       LOG_ERROR("Out of memory");
+                       return ERROR_FAIL;
+               }
+               field.out_value = t;
+               buf_set_u64(t, 0, field.num_bits, new_instr);
                field.in_value = NULL;
 
-               jtag_add_ir_scan(1, &field, jtag_set_end_state(TAP_IDLE));
+               jtag_add_ir_scan(tap, &field, TAP_IDLE);
 
-               free(field.out_value);
+               free(t);
        }
 
        return ERROR_OK;
 }
 
 static int virtex2_send_32(struct pld_device *pld_device,
-               int num_words, uint32_t *words)
+       int num_words, uint32_t *words)
 {
        struct virtex2_pld_device *virtex2_info = pld_device->driver_priv;
        struct scan_field scan_field;
@@ -58,8 +59,11 @@ static int virtex2_send_32(struct pld_device *pld_device,
        int i;
 
        values = malloc(num_words * 4);
+       if (!values) {
+               LOG_ERROR("Out of memory");
+               return ERROR_FAIL;
+       }
 
-       scan_field.tap = virtex2_info->tap;
        scan_field.num_bits = num_words * 32;
        scan_field.out_value = values;
        scan_field.in_value = NULL;
@@ -67,43 +71,47 @@ static int virtex2_send_32(struct pld_device *pld_device,
        for (i = 0; i < num_words; i++)
                buf_set_u32(values + 4 * i, 0, 32, flip_u32(*words++, 32));
 
-       virtex2_set_instr(virtex2_info->tap, 0x5); /* CFG_IN */
+       int retval = virtex2_set_instr(virtex2_info->tap, virtex2_info->command_set.cfg_in);
+       if (retval != ERROR_OK) {
+               free(values);
+               return retval;
+       }
 
-       jtag_add_dr_scan(1, &scan_field, jtag_set_end_state(TAP_DRPAUSE));
+       jtag_add_dr_scan(virtex2_info->tap, 1, &scan_field, TAP_DRPAUSE);
 
        free(values);
 
        return ERROR_OK;
 }
 
-static __inline__ void virtexflip32(jtag_callback_data_t arg)
+static inline void virtexflip32(jtag_callback_data_t arg)
 {
-  uint8_t *in = (uint8_t *)arg;
-       *((uint32_t *)in) = flip_u32(le_to_h_u32(in), 32);
+       uint8_t *in = (uint8_t *)arg;
+       *((uint32_t *)arg) = flip_u32(le_to_h_u32(in), 32);
 }
 
 static int virtex2_receive_32(struct pld_device *pld_device,
-               int num_words, uint32_t *words)
+       int num_words, uint32_t *words)
 {
        struct virtex2_pld_device *virtex2_info = pld_device->driver_priv;
        struct scan_field scan_field;
 
-       scan_field.tap = virtex2_info->tap;
        scan_field.num_bits = 32;
        scan_field.out_value = NULL;
        scan_field.in_value = NULL;
 
-       virtex2_set_instr(virtex2_info->tap, 0x4); /* CFG_OUT */
+       int retval = virtex2_set_instr(virtex2_info->tap, virtex2_info->command_set.cfg_out);
+       if (retval != ERROR_OK)
+               return retval;
 
-       while (num_words--)
-       {
+       while (num_words--) {
                scan_field.in_value = (uint8_t *)words;
 
-               jtag_add_dr_scan(1, &scan_field, jtag_set_end_state(TAP_DRPAUSE));
+               jtag_add_dr_scan(virtex2_info->tap, 1, &scan_field, TAP_DRPAUSE);
 
                jtag_add_callback(virtexflip32, (jtag_callback_data_t)words);
 
-               words++;;
+               words++;
        }
 
        return ERROR_OK;
@@ -115,20 +123,106 @@ static int virtex2_read_stat(struct pld_device *pld_device, uint32_t *status)
 
        jtag_add_tlr();
 
-       data[0] = 0xaa995566; /* synch word */
-       data[1] = 0x2800E001; /* Type 1, read, address 7, 1 word */
-       data[2] = 0x20000000; /* NOOP (Type 1, read, address 0, 0 words */
-       data[3] = 0x20000000; /* NOOP */
-       data[4] = 0x20000000; /* NOOP */
-       virtex2_send_32(pld_device, 5, data);
+       data[0] = 0xaa995566;   /* synch word */
+       data[1] = 0x2800E001;   /* Type 1, read, address 7, 1 word */
+       data[2] = 0x20000000;   /* NOOP (Type 1, read, address 0, 0 words */
+       data[3] = 0x20000000;   /* NOOP */
+       data[4] = 0x20000000;   /* NOOP */
+       int retval = virtex2_send_32(pld_device, 5, data);
+       if (retval != ERROR_OK)
+               return retval;
 
-       virtex2_receive_32(pld_device, 1, status);
+       retval = virtex2_receive_32(pld_device, 1, status);
+       if (retval != ERROR_OK)
+               return retval;
 
-       jtag_execute_queue();
+       retval = jtag_execute_queue();
+       if (retval == ERROR_OK)
+               LOG_DEBUG("status: 0x%8.8" PRIx32, *status);
 
-       LOG_DEBUG("status: 0x%8.8" PRIx32 "", *status);
+       return retval;
+}
 
-       return ERROR_OK;
+static int virtex2_program(struct pld_device *pld_device)
+{
+       struct virtex2_pld_device *virtex2_info = pld_device->driver_priv;
+       if (!virtex2_info)
+               return ERROR_FAIL;
+
+       int retval = virtex2_set_instr(virtex2_info->tap, virtex2_info->command_set.jshutdown);
+       if (retval != ERROR_OK)
+               return retval;
+
+       retval = virtex2_set_instr(virtex2_info->tap, virtex2_info->command_set.jprog_b);
+       if (retval != ERROR_OK)
+               return retval;
+
+       jtag_add_runtest(62000, TAP_IDLE);
+       if (!(virtex2_info->no_jstart)) {
+               retval = virtex2_set_instr(virtex2_info->tap, virtex2_info->command_set.jstart);
+               if (retval != ERROR_OK)
+                       return retval;
+       }
+
+       retval = virtex2_set_instr(virtex2_info->tap, virtex2_info->command_set.bypass);
+       if (retval != ERROR_OK)
+               return retval;
+       jtag_add_runtest(2000, TAP_IDLE);
+
+       return jtag_execute_queue();
+}
+
+static int virtex2_load_prepare(struct pld_device *pld_device)
+{
+       struct virtex2_pld_device *virtex2_info = pld_device->driver_priv;
+       int retval;
+
+       retval = virtex2_set_instr(virtex2_info->tap, virtex2_info->command_set.jprog_b);
+       if (retval != ERROR_OK)
+               return retval;
+
+       retval = jtag_execute_queue();
+       if (retval != ERROR_OK)
+               return retval;
+       jtag_add_sleep(1000);
+
+       retval = virtex2_set_instr(virtex2_info->tap, virtex2_info->command_set.cfg_in);
+       if (retval != ERROR_OK)
+               return retval;
+
+       return jtag_execute_queue();
+}
+
+static int virtex2_load_cleanup(struct pld_device *pld_device)
+{
+       struct virtex2_pld_device *virtex2_info = pld_device->driver_priv;
+       int retval;
+
+       jtag_add_tlr();
+
+       if (!(virtex2_info->no_jstart)) {
+               retval = virtex2_set_instr(virtex2_info->tap, virtex2_info->command_set.jstart);
+               if (retval != ERROR_OK)
+                       return retval;
+       }
+       jtag_add_runtest(13, TAP_IDLE);
+       retval = virtex2_set_instr(virtex2_info->tap, virtex2_info->command_set.bypass);
+       if (retval != ERROR_OK)
+               return retval;
+       retval = virtex2_set_instr(virtex2_info->tap, virtex2_info->command_set.bypass);
+       if (retval != ERROR_OK)
+               return retval;
+       if (!(virtex2_info->no_jstart)) {
+               retval = virtex2_set_instr(virtex2_info->tap, virtex2_info->command_set.jstart);
+               if (retval != ERROR_OK)
+                       return retval;
+       }
+       jtag_add_runtest(13, TAP_IDLE);
+       retval = virtex2_set_instr(virtex2_info->tap, virtex2_info->command_set.bypass);
+       if (retval != ERROR_OK)
+               return retval;
+
+       return jtag_execute_queue();
 }
 
 static int virtex2_load(struct pld_device *pld_device, const char *filename)
@@ -139,19 +233,17 @@ static int virtex2_load(struct pld_device *pld_device, const char *filename)
        unsigned int i;
        struct scan_field field;
 
-       field.tap = virtex2_info->tap;
        field.in_value = NULL;
 
-       if ((retval = xilinx_read_bit_file(&bit_file, filename)) != ERROR_OK)
+       retval = xilinx_read_bit_file(&bit_file, filename);
+       if (retval != ERROR_OK)
                return retval;
 
-       jtag_set_end_state(TAP_IDLE);
-       virtex2_set_instr(virtex2_info->tap, 0xb); /* JPROG_B */
-       jtag_execute_queue();
-       jtag_add_sleep(1000);
-
-       virtex2_set_instr(virtex2_info->tap, 0x5); /* CFG_IN */
-       jtag_execute_queue();
+       retval = virtex2_load_prepare(pld_device);
+       if (retval != ERROR_OK) {
+               xilinx_free_bit_file(&bit_file);
+               return retval;
+       }
 
        for (i = 0; i < bit_file.length; i++)
                bit_file.data[i] = flip_u32(bit_file.data[i], 8);
@@ -159,74 +251,162 @@ static int virtex2_load(struct pld_device *pld_device, const char *filename)
        field.num_bits = bit_file.length * 8;
        field.out_value = bit_file.data;
 
-       jtag_add_dr_scan(1, &field, jtag_set_end_state(TAP_DRPAUSE));
-       jtag_execute_queue();
+       jtag_add_dr_scan(virtex2_info->tap, 1, &field, TAP_DRPAUSE);
+       retval = jtag_execute_queue();
+       if (retval != ERROR_OK) {
+               xilinx_free_bit_file(&bit_file);
+               return retval;
+       }
+
+       retval = virtex2_load_cleanup(pld_device);
 
-       jtag_add_tlr();
+       xilinx_free_bit_file(&bit_file);
+
+       return retval;
+}
 
-       jtag_set_end_state(TAP_IDLE);
-       virtex2_set_instr(virtex2_info->tap, 0xc); /* JSTART */
-       jtag_add_runtest(13, jtag_set_end_state(TAP_IDLE));
-       virtex2_set_instr(virtex2_info->tap, 0x3f); /* BYPASS */
-       virtex2_set_instr(virtex2_info->tap, 0x3f); /* BYPASS */
-       virtex2_set_instr(virtex2_info->tap, 0xc); /* JSTART */
-       jtag_add_runtest(13, jtag_set_end_state(TAP_IDLE));
-       virtex2_set_instr(virtex2_info->tap, 0x3f); /* BYPASS */
-       jtag_execute_queue();
+COMMAND_HANDLER(virtex2_handle_program_command)
+{
+       struct pld_device *device;
 
-       return ERROR_OK;
+       if (CMD_ARGC != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       device = get_pld_device_by_name_or_numstr(CMD_ARGV[0]);
+       if (!device) {
+               command_print(CMD, "pld device '#%s' is out of bounds or unknown", CMD_ARGV[0]);
+               return ERROR_FAIL;
+       }
+
+       return virtex2_program(device);
 }
 
 COMMAND_HANDLER(virtex2_handle_read_stat_command)
 {
        struct pld_device *device;
-       struct virtex2_pld_device *virtex2_info;
        uint32_t status;
 
        if (CMD_ARGC < 1)
-       {
-               command_print(CMD_CTX, "usage: virtex2 read_stat <num>");
-               return ERROR_OK;
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       device = get_pld_device_by_name_or_numstr(CMD_ARGV[0]);
+       if (!device) {
+               command_print(CMD, "pld device '#%s' is out of bounds or unknown", CMD_ARGV[0]);
+               return ERROR_FAIL;
        }
 
-       unsigned dev_id;
-       COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], dev_id);
-       device = get_pld_device_by_num(dev_id);
-       if (!device)
-       {
-               command_print(CMD_CTX, "pld device '#%s' is out of bounds", CMD_ARGV[0]);
-               return ERROR_OK;
+       int retval = virtex2_read_stat(device, &status);
+       if (retval != ERROR_OK) {
+               command_print(CMD, "cannot read virtex2 status register");
+               return retval;
        }
 
-       virtex2_info = device->driver_priv;
+       command_print(CMD, "virtex2 status register: 0x%8.8" PRIx32, status);
+
+       return ERROR_OK;
+}
+
+static int xilinx_get_ipdbg_hub(int user_num, struct pld_device *pld_device, struct pld_ipdbg_hub *hub)
+{
+       if (!pld_device)
+               return ERROR_FAIL;
+
+       struct virtex2_pld_device *pld_device_info = pld_device->driver_priv;
 
-       virtex2_read_stat(device, &status);
+       if (!pld_device_info || !pld_device_info->tap)
+               return ERROR_FAIL;
 
-       command_print(CMD_CTX, "virtex2 status register: 0x%8.8" PRIx32 "", status);
+       hub->tap = pld_device_info->tap;
+       if (user_num < 1 || (unsigned int)user_num > pld_device_info->command_set.num_user) {
+               LOG_ERROR("device has only user register 1 to %d", pld_device_info->command_set.num_user);
+               return ERROR_FAIL;
+       }
 
+       hub->user_ir_code = pld_device_info->command_set.user[user_num - 1];
        return ERROR_OK;
 }
 
-PLD_DEVICE_COMMAND_HANDLER(virtex2_pld_device_command)
+COMMAND_HANDLER(virtex2_handle_set_instuction_codes_command)
 {
-       struct jtag_tap *tap;
+       if (CMD_ARGC < 6 || CMD_ARGC > (6 + VIRTEX2_MAX_USER_INSTRUCTIONS))
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       struct pld_device *device = get_pld_device_by_name(CMD_ARGV[0]);
+       if (!device) {
+               command_print(CMD, "pld device '#%s' is unknown", CMD_ARGV[0]);
+               return ERROR_FAIL;
+       }
+
+       struct virtex2_pld_device *virtex2_info = device->driver_priv;
+       if (!virtex2_info)
+               return ERROR_FAIL;
 
-       struct virtex2_pld_device *virtex2_info;
+       struct virtex2_command_set instr_codes;
+       COMMAND_PARSE_NUMBER(u64, CMD_ARGV[1], instr_codes.cfg_out);
+       COMMAND_PARSE_NUMBER(u64, CMD_ARGV[2], instr_codes.cfg_in);
+       COMMAND_PARSE_NUMBER(u64, CMD_ARGV[3], instr_codes.jprog_b);
+       COMMAND_PARSE_NUMBER(u64, CMD_ARGV[4], instr_codes.jstart);
+       COMMAND_PARSE_NUMBER(u64, CMD_ARGV[5], instr_codes.jshutdown);
+       instr_codes.bypass = 0xffffffffffffffffULL;
 
-       if (CMD_ARGC < 2)
-       {
-               LOG_WARNING("incomplete pld device 'virtex2' configuration");
-               return ERROR_PLD_DEVICE_INVALID;
+       unsigned int num_user = CMD_ARGC - 6;
+       for (unsigned int i = 0; i < num_user; ++i)
+               COMMAND_PARSE_NUMBER(u64, CMD_ARGV[6 + i], instr_codes.user[i]);
+       instr_codes.num_user = num_user;
+
+       virtex2_info->command_set = instr_codes;
+       return ERROR_OK;
+}
+
+COMMAND_HANDLER(virtex2_handle_set_user_codes_command)
+{
+       if (CMD_ARGC < 2 || CMD_ARGC > (1 + VIRTEX2_MAX_USER_INSTRUCTIONS))
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       struct pld_device *device = get_pld_device_by_name(CMD_ARGV[0]);
+       if (!device) {
+               command_print(CMD, "pld device '#%s' is unknown", CMD_ARGV[0]);
+               return ERROR_FAIL;
        }
 
-       tap = jtag_tap_by_string(CMD_ARGV[1]);
-       if (tap == NULL) {
-               command_print(CMD_CTX, "Tap: %s does not exist", CMD_ARGV[1]);
-               return ERROR_OK;
+       struct virtex2_pld_device *virtex2_info = device->driver_priv;
+       if (!virtex2_info)
+               return ERROR_FAIL;
+
+       uint64_t user[VIRTEX2_MAX_USER_INSTRUCTIONS];
+       unsigned int num_user = CMD_ARGC - 1;
+       for (unsigned int i = 0; i < num_user; ++i)
+               COMMAND_PARSE_NUMBER(u64, CMD_ARGV[1 + i], user[i]);
+       virtex2_info->command_set.num_user = num_user;
+       memcpy(virtex2_info->command_set.user, user, num_user * sizeof(uint64_t));
+       return ERROR_OK;
+}
+
+PLD_CREATE_COMMAND_HANDLER(virtex2_pld_create_command)
+{
+       if (CMD_ARGC < 4)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       if (strcmp(CMD_ARGV[2], "-chain-position") != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       struct jtag_tap *tap = jtag_tap_by_string(CMD_ARGV[3]);
+       if (!tap) {
+               command_print(CMD, "Tap: %s does not exist", CMD_ARGV[3]);
+               return ERROR_FAIL;
        }
 
-       virtex2_info = malloc(sizeof(struct virtex2_pld_device));
+       struct virtex2_pld_device *virtex2_info = malloc(sizeof(struct virtex2_pld_device));
+       if (!virtex2_info) {
+               LOG_ERROR("Out of memory");
+               return ERROR_FAIL;
+       }
        virtex2_info->tap = tap;
+       virtex2_info->command_set = virtex2_default_commands;
+
+       virtex2_info->no_jstart = 0;
+       if (CMD_ARGC >= 5 && strcmp(CMD_ARGV[4], "-no_jstart") == 0)
+               virtex2_info->no_jstart = 1;
 
        pld->driver_priv = virtex2_info;
 
@@ -237,25 +417,47 @@ static const struct command_registration virtex2_exec_command_handlers[] = {
        {
                .name = "read_stat",
                .mode = COMMAND_EXEC,
-               .handler = &virtex2_handle_read_stat_command,
+               .handler = virtex2_handle_read_stat_command,
                .help = "read status register",
-               .usage = "<device_id>",
+               .usage = "pld_name",
+       }, {
+               .name = "set_instr_codes",
+               .mode = COMMAND_ANY,
+               .handler = virtex2_handle_set_instuction_codes_command,
+               .help = "set instructions codes used for loading the bitstream/refreshing/jtag-hub",
+               .usage = "pld_name cfg_out cfg_in jprogb jstart jshutdown"
+                                " [user1 [user2 [user3 [user4]]]]",
+       }, {
+               .name = "set_user_codes",
+               .mode = COMMAND_ANY,
+               .handler = virtex2_handle_set_user_codes_command,
+               .help = "set instructions codes used for jtag-hub",
+               .usage = "pld_name user1 [user2 [user3 [user4]]]",
+       }, {
+               .name = "program",
+               .mode = COMMAND_EXEC,
+               .handler = virtex2_handle_program_command,
+               .help = "start loading of configuration (refresh)",
+               .usage = "pld_name",
        },
        COMMAND_REGISTRATION_DONE
 };
+
 static const struct command_registration virtex2_command_handler[] = {
        {
                .name = "virtex2",
                .mode = COMMAND_ANY,
                .help = "Virtex-II specific commands",
+               .usage = "",
                .chain = virtex2_exec_command_handlers,
        },
        COMMAND_REGISTRATION_DONE
 };
 
 struct pld_driver virtex2_pld = {
-               .name = "virtex2",
-               .commands = virtex2_command_handler,
-               .pld_device_command = &virtex2_pld_device_command,
-               .load = &virtex2_load,
-       };
+       .name = "virtex2",
+       .commands = virtex2_command_handler,
+       .pld_create_command = &virtex2_pld_create_command,
+       .load = &virtex2_load,
+       .get_ipdbg_hub = xilinx_get_ipdbg_hub,
+};

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)