pld: add support for cologne chip gatemate fpgas
[openocd.git] / src / pld / pld.c
index 7325a209a815c1056356928e2665ef2d9f333886..dd8f8263fe7de0d94a75137bb82692af74e26649 100644 (file)
+// 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 "replacements.h"
-
 #include "pld.h"
-
-#include "jtag.h"
-#include "command.h"
-#include "log.h"
-#include "time_support.h"
-
-#include <stdlib.h>
-#include <unistd.h>
-#include <sys/types.h>
 #include <sys/stat.h>
-#include <fcntl.h>
-#include <string.h>
+#include <helper/log.h>
+#include <helper/replacements.h>
+#include <helper/time_support.h>
 
-#include <sys/time.h>
-#include <time.h>
 
 /* pld drivers
  */
-extern pld_driver_t virtex2_pld;
-
-pld_driver_t *pld_drivers[] =
-{
+extern struct pld_driver efinix_pld;
+extern struct pld_driver gatemate_pld;
+extern struct pld_driver gowin_pld;
+extern struct pld_driver intel_pld;
+extern struct pld_driver lattice_pld;
+extern struct pld_driver virtex2_pld;
+
+static struct pld_driver *pld_drivers[] = {
+       &efinix_pld,
+       &gatemate_pld,
+       &gowin_pld,
+       &intel_pld,
+       &lattice_pld,
        &virtex2_pld,
        NULL,
 };
 
-pld_device_t *pld_devices;
-static command_t *pld_cmd;
-
-int handle_pld_devices_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int handle_pld_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int handle_pld_load_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static struct pld_device *pld_devices;
 
-int pld_init(struct command_context_s *cmd_ctx)
+struct pld_device *get_pld_device_by_num(int num)
 {
-       if (pld_devices)
-       {
-               register_command(cmd_ctx, pld_cmd, "devices", handle_pld_devices_command, COMMAND_EXEC,
-                                               "list configured pld devices");
-               register_command(cmd_ctx, pld_cmd, "load", handle_pld_load_command, COMMAND_EXEC,
-                                               "load configuration <file> into programmable logic device");
-       }
-       
-       return ERROR_OK;
-}
-
-pld_device_t *get_pld_device_by_num(int num)
-{
-       pld_device_t *p;
+       struct pld_device *p;
        int i = 0;
 
-       for (p = pld_devices; p; p = p->next)
-       {
+       for (p = pld_devices; p; p = p->next) {
                if (i++ == num)
-               {
                        return p;
-               }
        }
-       
+
        return NULL;
 }
 
 /* pld device <driver> [driver_options ...]
  */
-int handle_pld_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_pld_device_command)
 {
        int i;
        int found = 0;
-               
-       if (argc < 1)
-       {
-               LOG_WARNING("incomplete 'pld bank' configuration");
-               return ERROR_OK;
-       }
-       
-       for (i = 0; pld_drivers[i]; i++)
-       {
-               if (strcmp(args[0], pld_drivers[i]->name) == 0)
-               {
-                       pld_device_t *p, *c;
-                       
+
+       if (CMD_ARGC < 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       for (i = 0; pld_drivers[i]; i++) {
+               if (strcmp(CMD_ARGV[0], pld_drivers[i]->name) == 0) {
+                       struct pld_device *p, *c;
+
                        /* register pld specific commands */
-                       if (pld_drivers[i]->register_commands(cmd_ctx) != ERROR_OK)
-                       {
-                               LOG_ERROR("couldn't register '%s' commands", args[0]);
-                               exit(-1);
+                       int retval;
+                       if (pld_drivers[i]->commands) {
+                               retval = register_commands(CMD_CTX, NULL, pld_drivers[i]->commands);
+                               if (retval != ERROR_OK) {
+                                       LOG_ERROR("couldn't register '%s' commands", CMD_ARGV[0]);
+                                       return ERROR_FAIL;
+                               }
                        }
-                       
-                       c = malloc(sizeof(pld_device_t));
+
+                       c = malloc(sizeof(struct pld_device));
                        c->driver = pld_drivers[i];
                        c->next = NULL;
-                       
-                       if (pld_drivers[i]->pld_device_command(cmd_ctx, cmd, args, argc, c) != ERROR_OK)
-                       {
-                               LOG_ERROR("'%s' driver rejected pld device", args[0]);
+
+                       retval = CALL_COMMAND_HANDLER(
+                                       pld_drivers[i]->pld_device_command, c);
+                       if (retval != ERROR_OK) {
+                               LOG_ERROR("'%s' driver rejected pld device",
+                                       CMD_ARGV[0]);
                                free(c);
                                return ERROR_OK;
                        }
-                       
+
                        /* put pld device in linked list */
-                       if (pld_devices)
-                       {
+                       if (pld_devices) {
                                /* find last pld device */
-                               for (p = pld_devices; p && p->next; p = p->next);
+                               for (p = pld_devices; p && p->next; p = p->next)
+                                       ;
                                if (p)
                                        p->next = c;
-                       }
-                       else
-                       {
+                       } else
                                pld_devices = c;
-                       }
-                       
+
                        found = 1;
                }
        }
-               
+
        /* no matching pld driver found */
-       if (!found)
-       {
-               LOG_ERROR("pld driver '%s' not found", args[0]);
+       if (!found) {
+               LOG_ERROR("pld driver '%s' not found", CMD_ARGV[0]);
                exit(-1);
        }
-       
+
        return ERROR_OK;
 }
 
-int handle_pld_devices_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_pld_devices_command)
 {
-       pld_device_t *p;
+       struct pld_device *p;
        int i = 0;
-       
-       if (!pld_devices)
-       {
-               command_print(cmd_ctx, "no pld devices configured");
+
+       if (!pld_devices) {
+               command_print(CMD, "no pld devices configured");
                return ERROR_OK;
        }
-       
+
        for (p = pld_devices; p; p = p->next)
-       {
-               command_print(cmd_ctx, "#%i: %s", i++, p->driver->name);
-       }
-       
+               command_print(CMD, "#%i: %s", i++, p->driver->name);
+
        return ERROR_OK;
 }
 
-int handle_pld_load_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_pld_load_command)
 {
        int retval;
        struct timeval start, end, duration;
-       pld_device_t *p;
-       
+       struct pld_device *p;
+
        gettimeofday(&start, NULL);
-               
-       if (argc < 2)
-       {
-               command_print(cmd_ctx, "usage: pld load <device#> <file>");
+
+       if (CMD_ARGC < 2)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       unsigned dev_id;
+       COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], dev_id);
+       p = get_pld_device_by_num(dev_id);
+       if (!p) {
+               command_print(CMD, "pld device '#%s' is out of bounds", CMD_ARGV[0]);
                return ERROR_OK;
        }
-       
-       p = get_pld_device_by_num(strtoul(args[0], NULL, 0));
-       if (!p)
-       {
-               command_print(cmd_ctx, "pld device '#%s' is out of bounds", args[0]);
-               return ERROR_OK;
+
+       struct stat input_stat;
+       if (stat(CMD_ARGV[1], &input_stat) == -1) {
+               LOG_ERROR("couldn't stat() %s: %s", CMD_ARGV[1], strerror(errno));
+               return ERROR_PLD_FILE_LOAD_FAILED;
        }
-       
-       if ((retval = p->driver->load(p, args[1])) != ERROR_OK)
-       {
-               command_print(cmd_ctx, "failed loading file %s to pld device %i",
-                       args[1], strtoul(args[0], NULL, 0));
-               switch (retval)
-               {
-               }
+
+       if (S_ISDIR(input_stat.st_mode)) {
+               LOG_ERROR("%s is a directory", CMD_ARGV[1]);
+               return ERROR_PLD_FILE_LOAD_FAILED;
        }
-       else
-       {
-               gettimeofday(&end, NULL);       
+
+       if (input_stat.st_size == 0) {
+               LOG_ERROR("Empty file %s", CMD_ARGV[1]);
+               return ERROR_PLD_FILE_LOAD_FAILED;
+       }
+
+       retval = p->driver->load(p, CMD_ARGV[1]);
+       if (retval != ERROR_OK) {
+               command_print(CMD, "failed loading file %s to pld device %u",
+                       CMD_ARGV[1], dev_id);
+               switch (retval) {
+               }
+               return retval;
+       } else {
+               gettimeofday(&end, NULL);
                timeval_subtract(&duration, &end, &start);
-               
-               command_print(cmd_ctx, "loaded file %s to pld device %i in %is %ius", 
-                       args[1], strtoul(args[0], NULL, 0), duration.tv_sec, duration.tv_usec);
+
+               command_print(CMD, "loaded file %s to pld device %u in %jis %jius",
+                       CMD_ARGV[1], dev_id,
+                       (intmax_t)duration.tv_sec, (intmax_t)duration.tv_usec);
        }
-       
+
        return ERROR_OK;
 }
 
-int pld_register_commands(struct command_context_s *cmd_ctx)
+static const struct command_registration pld_exec_command_handlers[] = {
+       {
+               .name = "devices",
+               .handler = handle_pld_devices_command,
+               .mode = COMMAND_EXEC,
+               .help = "list configured pld devices",
+               .usage = "",
+       },
+       {
+               .name = "load",
+               .handler = handle_pld_load_command,
+               .mode = COMMAND_EXEC,
+               .help = "load configuration file into PLD",
+               .usage = "pld_num filename",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+static int pld_init(struct command_context *cmd_ctx)
+{
+       if (!pld_devices)
+               return ERROR_OK;
+
+       return register_commands(cmd_ctx, "pld", pld_exec_command_handlers);
+}
+
+COMMAND_HANDLER(handle_pld_init_command)
 {
-       pld_cmd = register_command(cmd_ctx, NULL, "pld", NULL, COMMAND_ANY, "programmable logic device commands");
-       
-       register_command(cmd_ctx, pld_cmd, "device", handle_pld_device_command, COMMAND_CONFIG, NULL);
-       
-       return ERROR_OK;
+       if (CMD_ARGC != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       static bool pld_initialized;
+       if (pld_initialized) {
+               LOG_INFO("'pld init' has already been called");
+               return ERROR_OK;
+       }
+       pld_initialized = true;
+
+       LOG_DEBUG("Initializing PLDs...");
+       return pld_init(CMD_CTX);
+}
+
+static const struct command_registration pld_config_command_handlers[] = {
+       {
+               .name = "device",
+               .mode = COMMAND_CONFIG,
+               .handler = handle_pld_device_command,
+               .help = "configure a PLD device",
+               .usage = "driver_name [driver_args ... ]",
+       },
+       {
+               .name = "init",
+               .mode = COMMAND_CONFIG,
+               .handler = handle_pld_init_command,
+               .help = "initialize PLD devices",
+               .usage = ""
+       },
+       COMMAND_REGISTRATION_DONE
+};
+static const struct command_registration pld_command_handler[] = {
+       {
+               .name = "pld",
+               .mode = COMMAND_ANY,
+               .help = "programmable logic device commands",
+               .usage = "",
+               .chain = pld_config_command_handlers,
+       },
+       COMMAND_REGISTRATION_DONE
+};
+int pld_register_commands(struct command_context *cmd_ctx)
+{
+       return register_commands(cmd_ctx, NULL, pld_command_handler);
 }

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)