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