src/pld/pld.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2
   3 /***************************************************************************
   4  *   Copyright (C) 2006 by Dominic Rath                                    *
   5  *   Dominic.Rath@gmx.de                                                   *
   6  ***************************************************************************/
   7
   8 #ifdef HAVE_CONFIG_H
   9 #include "config.h"
  10 #endif
  11
  12 #include "pld.h"
  13 #include <sys/stat.h>
  14 #include <helper/log.h>
  15 #include <helper/replacements.h>
  16 #include <helper/time_support.h>
  17
  18
  19 /* pld drivers
  20  */
  21 extern struct pld_driver efinix_pld;
  22 extern struct pld_driver gatemate_pld;
  23 extern struct pld_driver gowin_pld;
  24 extern struct pld_driver intel_pld;
  25 extern struct pld_driver lattice_pld;
  26 extern struct pld_driver virtex2_pld;
  27
  28 static struct pld_driver *pld_drivers[] = {
  29         &efinix_pld,
  30         &gatemate_pld,
  31         &gowin_pld,
  32         &intel_pld,
  33         &lattice_pld,
  34         &virtex2_pld,
  35         NULL,
  36 };
  37
  38 static struct pld_device *pld_devices;
  39
  40 struct pld_device *get_pld_device_by_num(int num)
  41 {
  42         struct pld_device *p;
  43         int i = 0;
  44
  45         for (p = pld_devices; p; p = p->next) {
  46                 if (i++ == num)
  47                         return p;
  48         }
  49
  50         return NULL;
  51 }
  52
  53 /* pld device <driver> [driver_options ...]
  54  */
  55 COMMAND_HANDLER(handle_pld_device_command)
  56 {
  57         int i;
  58         int found = 0;
  59
  60         if (CMD_ARGC < 1)
  61                 return ERROR_COMMAND_SYNTAX_ERROR;
  62
  63         for (i = 0; pld_drivers[i]; i++) {
  64                 if (strcmp(CMD_ARGV[0], pld_drivers[i]->name) == 0) {
  65                         struct pld_device *p, *c;
  66
  67                         /* register pld specific commands */
  68                         int retval;
  69                         if (pld_drivers[i]->commands) {
  70                                 retval = register_commands(CMD_CTX, NULL, pld_drivers[i]->commands);
  71                                 if (retval != ERROR_OK) {
  72                                         LOG_ERROR("couldn't register '%s' commands", CMD_ARGV[0]);
  73                                         return ERROR_FAIL;
  74                                 }
  75                         }
  76
  77                         c = malloc(sizeof(struct pld_device));
  78                         c->driver = pld_drivers[i];
  79                         c->next = NULL;
  80
  81                         retval = CALL_COMMAND_HANDLER(
  82                                         pld_drivers[i]->pld_device_command, c);
  83                         if (retval != ERROR_OK) {
  84                                 LOG_ERROR("'%s' driver rejected pld device",
  85                                         CMD_ARGV[0]);
  86                                 free(c);
  87                                 return ERROR_OK;
  88                         }
  89
  90                         /* put pld device in linked list */
  91                         if (pld_devices) {
  92                                 /* find last pld device */
  93                                 for (p = pld_devices; p && p->next; p = p->next)
  94                                         ;
  95                                 if (p)
  96                                         p->next = c;
  97                         } else
  98                                 pld_devices = c;
  99
 100                         found = 1;
 101                 }
 102         }
 103
 104         /* no matching pld driver found */
 105         if (!found) {
 106                 LOG_ERROR("pld driver '%s' not found", CMD_ARGV[0]);
 107                 exit(-1);
 108         }
 109
 110         return ERROR_OK;
 111 }
 112
 113 COMMAND_HANDLER(handle_pld_devices_command)
 114 {
 115         struct pld_device *p;
 116         int i = 0;
 117
 118         if (!pld_devices) {
 119                 command_print(CMD, "no pld devices configured");
 120                 return ERROR_OK;
 121         }
 122
 123         for (p = pld_devices; p; p = p->next)
 124                 command_print(CMD, "#%i: %s", i++, p->driver->name);
 125
 126         return ERROR_OK;
 127 }
 128
 129 COMMAND_HANDLER(handle_pld_load_command)
 130 {
 131         int retval;
 132         struct timeval start, end, duration;
 133         struct pld_device *p;
 134
 135         gettimeofday(&start, NULL);
 136
 137         if (CMD_ARGC < 2)
 138                 return ERROR_COMMAND_SYNTAX_ERROR;
 139
 140         unsigned dev_id;
 141         COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], dev_id);
 142         p = get_pld_device_by_num(dev_id);
 143         if (!p) {
 144                 command_print(CMD, "pld device '#%s' is out of bounds", CMD_ARGV[0]);
 145                 return ERROR_OK;
 146         }
 147
 148         struct stat input_stat;
 149         if (stat(CMD_ARGV[1], &input_stat) == -1) {
 150                 LOG_ERROR("couldn't stat() %s: %s", CMD_ARGV[1], strerror(errno));
 151                 return ERROR_PLD_FILE_LOAD_FAILED;
 152         }
 153
 154         if (S_ISDIR(input_stat.st_mode)) {
 155                 LOG_ERROR("%s is a directory", CMD_ARGV[1]);
 156                 return ERROR_PLD_FILE_LOAD_FAILED;
 157         }
 158
 159         if (input_stat.st_size == 0) {
 160                 LOG_ERROR("Empty file %s", CMD_ARGV[1]);
 161                 return ERROR_PLD_FILE_LOAD_FAILED;
 162         }
 163
 164         retval = p->driver->load(p, CMD_ARGV[1]);
 165         if (retval != ERROR_OK) {
 166                 command_print(CMD, "failed loading file %s to pld device %u",
 167                         CMD_ARGV[1], dev_id);
 168                 switch (retval) {
 169                 }
 170                 return retval;
 171         } else {
 172                 gettimeofday(&end, NULL);
 173                 timeval_subtract(&duration, &end, &start);
 174
 175                 command_print(CMD, "loaded file %s to pld device %u in %jis %jius",
 176                         CMD_ARGV[1], dev_id,
 177                         (intmax_t)duration.tv_sec, (intmax_t)duration.tv_usec);
 178         }
 179
 180         return ERROR_OK;
 181 }
 182
 183 static const struct command_registration pld_exec_command_handlers[] = {
 184         {
 185                 .name = "devices",
 186                 .handler = handle_pld_devices_command,
 187                 .mode = COMMAND_EXEC,
 188                 .help = "list configured pld devices",
 189                 .usage = "",
 190         },
 191         {
 192                 .name = "load",
 193                 .handler = handle_pld_load_command,
 194                 .mode = COMMAND_EXEC,
 195                 .help = "load configuration file into PLD",
 196                 .usage = "pld_num filename",
 197         },
 198         COMMAND_REGISTRATION_DONE
 199 };
 200
 201 static int pld_init(struct command_context *cmd_ctx)
 202 {
 203         if (!pld_devices)
 204                 return ERROR_OK;
 205
 206         return register_commands(cmd_ctx, "pld", pld_exec_command_handlers);
 207 }
 208
 209 COMMAND_HANDLER(handle_pld_init_command)
 210 {
 211         if (CMD_ARGC != 0)
 212                 return ERROR_COMMAND_SYNTAX_ERROR;
 213
 214         static bool pld_initialized;
 215         if (pld_initialized) {
 216                 LOG_INFO("'pld init' has already been called");
 217                 return ERROR_OK;
 218         }
 219         pld_initialized = true;
 220
 221         LOG_DEBUG("Initializing PLDs...");
 222         return pld_init(CMD_CTX);
 223 }
 224
 225 static const struct command_registration pld_config_command_handlers[] = {
 226         {
 227                 .name = "device",
 228                 .mode = COMMAND_CONFIG,
 229                 .handler = handle_pld_device_command,
 230                 .help = "configure a PLD device",
 231                 .usage = "driver_name [driver_args ... ]",
 232         },
 233         {
 234                 .name = "init",
 235                 .mode = COMMAND_CONFIG,
 236                 .handler = handle_pld_init_command,
 237                 .help = "initialize PLD devices",
 238                 .usage = ""
 239         },
 240         COMMAND_REGISTRATION_DONE
 241 };
 242 static const struct command_registration pld_command_handler[] = {
 243         {
 244                 .name = "pld",
 245                 .mode = COMMAND_ANY,
 246                 .help = "programmable logic device commands",
 247                 .usage = "",
 248                 .chain = pld_config_command_handlers,
 249         },
 250         COMMAND_REGISTRATION_DONE
 251 };
 252 int pld_register_commands(struct command_context *cmd_ctx)
 253 {
 254         return register_commands(cmd_ctx, NULL, pld_command_handler);
 255 }