zy1000: some background info on the zy1000 file.
[openocd.git] / src / jtag / zy1000 / zy1000.c
index 8f4d5e5fdf711c1996d8cda443997cc842dea2e4..5ddc7c5ce0768000f7a5a2024bd939310449229a 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2007-2008 by Øyvind Harboe                              *
+ *   Copyright (C) 2007-2009 by Øyvind Harboe                              *
  *                                                                         *
  *   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  *
  *   Free Software Foundation, Inc.,                                       *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
+
+/* This file supports the zy1000 debugger: http://www.zylin.com/zy1000.html
+ *
+ * The zy1000 is a standalone debugger that has a web interface and
+ * requires no drivers on the developer host as all communication
+ * is via TCP/IP. The zy1000 gets it performance(~400-700kBytes/s
+ * DCC downloads @ 16MHz target) as it has an FPGA to hardware
+ * accelerate the JTAG commands, while offering *very* low latency
+ * between OpenOCD and the FPGA registers.
+ *
+ * The disadvantage of the zy1000 is that it has a feeble CPU compared to
+ * a PC(ca. 50-500 DMIPS depending on how one counts it), whereas a PC
+ * is on the order of 10000 DMIPS(i.e. at a factor of 20-200).
+ *
+ * The zy1000 revc hardware is using an Altera Nios CPU, whereas the
+ * revb is using ARM7 + Xilinx.
+ *
+ * See Zylin web pages or contact Zylin for more information.
+ *
+ * The reason this code is in OpenOCD rather than OpenOCD linked with the
+ * ZY1000 code is that OpenOCD is the long road towards getting
+ * libopenocd into place. libopenocd will support both low performance,
+ * low latency systems(embedded) and high performance high latency
+ * systems(PCs).
+ */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
-#include "embeddedice.h"
-#include "minidriver.h"
-#include "interface.h"
+#include <target/embeddedice.h>
+#include <jtag/minidriver.h>
+#include <jtag/interface.h>
 #include "zy1000_version.h"
 
 #include <cyg/hal/hal_io.h>             // low level i/o
 #include <cyg/hal/hal_diag.h>
 
+#include <time.h>
+
 #define ZYLIN_VERSION GIT_ZY1000_VERSION
 #define ZYLIN_DATE __DATE__
 #define ZYLIN_TIME __TIME__
 #define ZYLIN_OPENOCD GIT_OPENOCD_VERSION
 #define ZYLIN_OPENOCD_VERSION "ZY1000 " ZYLIN_VERSION " " ZYLIN_DATE
 
-/* low level command set
- */
-void zy1000_reset(int trst, int srst);
-
-
-int zy1000_speed(int speed);
-int zy1000_register_commands(struct command_context_s *cmd_ctx);
-int zy1000_init(void);
-int zy1000_quit(void);
-
-/* interface commands */
-int zy1000_handle_zy1000_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 
 static int zy1000_khz(int khz, int *jtag_speed)
 {
@@ -109,21 +124,6 @@ static int zy1000_power_dropout(int *dropout)
        return ERROR_OK;
 }
 
-
-struct jtag_interface zy1000_interface =
-{
-       .name = "ZY1000",
-       .execute_queue = NULL,
-       .speed = zy1000_speed,
-       .register_commands = zy1000_register_commands,
-       .init = zy1000_init,
-       .quit = zy1000_quit,
-       .khz = zy1000_khz,
-       .speed_div = zy1000_speed_div,
-       .power_dropout = zy1000_power_dropout,
-       .srst_asserted = zy1000_srst_asserted,
-};
-
 void zy1000_reset(int trst, int srst)
 {
        LOG_DEBUG("zy1000 trst=%d, srst=%d", trst, srst);
@@ -225,31 +225,23 @@ static void setPower(bool power)
        }
 }
 
-int handle_power_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_power_command)
 {
-       if (argc > 1)
+       switch (CMD_ARGC)
        {
-               return ERROR_INVALID_ARGUMENTS;
+       case 1: {
+               bool enable;
+               COMMAND_PARSE_ON_OFF(CMD_ARGV[0], enable);
+               setPower(enable);
+               // fall through
        }
-
-       if (argc == 1)
-       {
-               if (strcmp(args[0], "on") == 0)
-               {
-                       setPower(1);
-               }
-               else if (strcmp(args[0], "off") == 0)
-               {
-                       setPower(0);
-               } else
-               {
-                       command_print(cmd_ctx, "arg is \"on\" or \"off\"");
-                       return ERROR_INVALID_ARGUMENTS;
-               }
+       case 0:
+               LOG_INFO("Target power %s", savePower ? "on" : "off");
+               break;
+       default:
+               return ERROR_INVALID_ARGUMENTS;
        }
 
-       command_print(cmd_ctx, "Target power %s", savePower ? "on" : "off");
-
        return ERROR_OK;
 }
 
@@ -257,9 +249,8 @@ int handle_power_command(struct command_context_s *cmd_ctx, char *cmd, char **ar
 /* Give TELNET a way to find out what version this is */
 static int jim_zy1000_version(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
-       if ((argc < 1) || (argc > 2))
+       if ((argc < 1) || (argc > 3))
                return JIM_ERR;
-       char buff[128];
        const char *version_str = NULL;
 
        if (argc == 1)
@@ -268,6 +259,9 @@ static int jim_zy1000_version(Jim_Interp *interp, int argc, Jim_Obj *const *argv
        } else
        {
                const char *str = Jim_GetString(argv[1], NULL);
+               const char *str2 = NULL;
+               if (argc > 2)
+                       str2 = Jim_GetString(argv[2], NULL);
                if (strcmp("openocd", str) == 0)
                {
                        version_str = ZYLIN_OPENOCD;
@@ -292,6 +286,29 @@ static int jim_zy1000_version(Jim_Interp *interp, int argc, Jim_Obj *const *argv
                        version_str="b";
 #endif
                }
+#ifdef CYGPKG_HAL_NIOS2
+               else if (strcmp("fpga", str) == 0)
+               {
+
+                       /* return a list of 32 bit integers to describe the expected
+                        * and actual FPGA
+                        */
+                       static char *fpga_id = "0x12345678 0x12345678 0x12345678 0x12345678";
+                       cyg_uint32 id, timestamp;
+                       HAL_READ_UINT32(SYSID_BASE, id);
+                       HAL_READ_UINT32(SYSID_BASE+4, timestamp);
+                       sprintf(fpga_id, "0x%08x 0x%08x 0x%08x 0x%08x", id, timestamp, SYSID_ID, SYSID_TIMESTAMP);
+                       version_str = fpga_id;
+                       if ((argc>2) && (strcmp("time", str2) == 0))
+                       {
+                           time_t last_mod = timestamp;
+                           char * t = ctime (&last_mod) ;
+                           t[strlen(t)-1] = 0;
+                           version_str = t;
+                       }
+               }
+#endif
+
                else
                {
                        return JIM_ERR;
@@ -354,24 +371,6 @@ zylinjtag_Jim_Command_powerstatus(Jim_Interp *interp,
        return JIM_OK;
 }
 
-int zy1000_register_commands(struct command_context_s *cmd_ctx)
-{
-       register_command(cmd_ctx, NULL, "power", handle_power_command, COMMAND_ANY,
-                       "power <on/off> - turn power switch to target on/off. No arguments - print status.");
-
-       Jim_CreateCommand(interp, "zy1000_version", jim_zy1000_version, NULL, NULL);
-
-
-       Jim_CreateCommand(interp, "powerstatus", zylinjtag_Jim_Command_powerstatus, NULL, NULL);
-
-#ifdef CYGPKG_HAL_NIOS2
-       Jim_CreateCommand(interp, "updatezy1000firmware", jim_zy1000_writefirmware, NULL, NULL);
-#endif
-
-
-       return ERROR_OK;
-}
-
 
 
 
@@ -455,8 +454,6 @@ static void shiftValueInnerFlip(const tap_state_t state, const tap_state_t endSt
 }
 #endif
 
-extern int jtag_check_value(uint8_t *captured, void *priv);
-
 static void gotoEndState(tap_state_t end_state)
 {
        setCurrentState(end_state);
@@ -511,7 +508,14 @@ static __inline void scanFields(int num_fields, const struct scan_field *fields,
                                }
                        }
                        /* mask away unused bits for easier debugging */
-                       value&=~(((uint32_t)0xffffffff) << k);
+                       if (k < 32)
+                       {
+                               value&=~(((uint32_t)0xffffffff) << k);
+                       } else
+                       {
+                               /* Shifting by >= 32 is not defined by the C standard
+                                * and will in fact shift by &0x1f bits on nios */
+                       }
 
                        shiftValueInner(shiftState, pause_state, k, value);
 
@@ -595,8 +599,6 @@ int interface_jtag_add_plain_ir_scan(int num_fields, const struct scan_field *fi
        return ERROR_OK;
 }
 
-/*extern jtag_command_t **jtag_get_last_command_p(void);*/
-
 int interface_jtag_add_dr_scan(int num_fields, const struct scan_field *fields, tap_state_t state)
 {
 
@@ -798,3 +800,50 @@ void embeddedice_write_dcc(struct jtag_tap *tap, int reg_addr, uint8_t *buffer,
 }
 
 
+static const struct command_registration zy1000_commands[] = {
+       {
+               .name = "power",
+               .handler = &handle_power_command,
+               .mode = COMMAND_ANY,
+               .help = "turn power switch to target on/off. No arguments - print status.",
+               .usage = "power <on/off>",
+       },
+       {
+               .name = "zy1000_version",
+               .mode = COMMAND_ANY,
+               .jim_handler = &jim_zy1000_version,
+               .help = "print version info for zy1000",
+       },
+       {
+               .name = "powerstatus",
+               .mode = COMMAND_ANY,
+               .jim_handler = & zylinjtag_Jim_Command_powerstatus,
+               .help = "print power status of target",
+       },
+#ifdef CYGPKG_HAL_NIOS2
+       {
+               .name = "updatezy1000firmware",
+               .mode = COMMAND_ANY,
+               .jim_handler = &jim_zy1000_writefirmware,
+               .help = "writes firmware to flash",
+       },
+#endif
+       COMMAND_REGISTRATION_DONE
+};
+
+
+
+struct jtag_interface zy1000_interface =
+{
+       .name = "ZY1000",
+       .execute_queue = NULL,
+       .speed = zy1000_speed,
+       .commands = zy1000_commands,
+       .init = zy1000_init,
+       .quit = zy1000_quit,
+       .khz = zy1000_khz,
+       .speed_div = zy1000_speed_div,
+       .power_dropout = zy1000_power_dropout,
+       .srst_asserted = zy1000_srst_asserted,
+};
+

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)