common/cmd_fpga.c

   1 /*
   2  * (C) Copyright 2000, 2001
   3  * Rich Ireland, Enterasys Networks, rireland@enterasys.com.
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 /*
   9  *  FPGA support
  10  */
  11 #include <common.h>
  12 #include <command.h>
  13 #include <fpga.h>
  14 #include <malloc.h>
  15
  16 /* Local functions */
  17 static int fpga_get_op(char *opstr);
  18
  19 /* Local defines */
  20 #define FPGA_NONE   -1
  21 #define FPGA_INFO   0
  22 #define FPGA_LOAD   1
  23 #define FPGA_LOADB  2
  24 #define FPGA_DUMP   3
  25 #define FPGA_LOADMK 4
  26
  27 /* ------------------------------------------------------------------------- */
  28 /* command form:
  29  *   fpga <op> <device number> <data addr> <datasize>
  30  * where op is 'load', 'dump', or 'info'
  31  * If there is no device number field, the fpga environment variable is used.
  32  * If there is no data addr field, the fpgadata environment variable is used.
  33  * The info command requires no data address field.
  34  */
  35 int do_fpga(cmd_tbl_t *cmdtp, int flag, int argc, char *const argv[])
  36 {
  37         int op, dev = FPGA_INVALID_DEVICE;
  38         size_t data_size = 0;
  39         void *fpga_data = NULL;
  40         char *devstr = getenv("fpga");
  41         char *datastr = getenv("fpgadata");
  42         int rc = FPGA_FAIL;
  43         int wrong_parms = 0;
  44 #if defined(CONFIG_FIT)
  45         const char *fit_uname = NULL;
  46         ulong fit_addr;
  47 #endif
  48
  49         if (devstr)
  50                 dev = (int) simple_strtoul(devstr, NULL, 16);
  51         if (datastr)
  52                 fpga_data = (void *)simple_strtoul(datastr, NULL, 16);
  53
  54         switch (argc) {
  55         case 5:         /* fpga <op> <dev> <data> <datasize> */
  56                 data_size = simple_strtoul(argv[4], NULL, 16);
  57
  58         case 4:         /* fpga <op> <dev> <data> */
  59 #if defined(CONFIG_FIT)
  60                 if (fit_parse_subimage(argv[3], (ulong)fpga_data,
  61                                        &fit_addr, &fit_uname)) {
  62                         fpga_data = (void *)fit_addr;
  63                         debug("*  fpga: subimage '%s' from FIT image ",
  64                               fit_uname);
  65                         debug("at 0x%08lx\n", fit_addr);
  66                 } else
  67 #endif
  68                 {
  69                         fpga_data = (void *)simple_strtoul(argv[3], NULL, 16);
  70                         debug("*  fpga: cmdline image address = 0x%08lx\n",
  71                               (ulong)fpga_data);
  72                 }
  73                 debug("%s: fpga_data = 0x%x\n", __func__, (uint)fpga_data);
  74
  75         case 3:         /* fpga <op> <dev | data addr> */
  76                 dev = (int)simple_strtoul(argv[2], NULL, 16);
  77                 debug("%s: device = %d\n", __func__, dev);
  78                 /* FIXME - this is a really weak test */
  79                 if ((argc == 3) && (dev > fpga_count())) {
  80                         /* must be buffer ptr */
  81                         debug("%s: Assuming buffer pointer in arg 3\n",
  82                               __func__);
  83
  84 #if defined(CONFIG_FIT)
  85                         if (fit_parse_subimage(argv[2], (ulong)fpga_data,
  86                                                &fit_addr, &fit_uname)) {
  87                                 fpga_data = (void *)fit_addr;
  88                                 debug("*  fpga: subimage '%s' from FIT image ",
  89                                       fit_uname);
  90                                 debug("at 0x%08lx\n", fit_addr);
  91                         } else
  92 #endif
  93                         {
  94                                 fpga_data = (void *)dev;
  95                                 debug("*  fpga: cmdline image addr = 0x%08lx\n",
  96                                       (ulong)fpga_data);
  97                         }
  98
  99                         debug("%s: fpga_data = 0x%x\n",
 100                               __func__, (uint)fpga_data);
 101                         dev = FPGA_INVALID_DEVICE;      /* reset device num */
 102                 }
 103
 104         case 2:         /* fpga <op> */
 105                 op = (int)fpga_get_op(argv[1]);
 106                 break;
 107
 108         default:
 109                 debug("%s: Too many or too few args (%d)\n", __func__, argc);
 110                 op = FPGA_NONE; /* force usage display */
 111                 break;
 112         }
 113
 114         if (dev == FPGA_INVALID_DEVICE) {
 115                 puts("FPGA device not specified\n");
 116                 op = FPGA_NONE;
 117         }
 118
 119         switch (op) {
 120         case FPGA_NONE:
 121         case FPGA_INFO:
 122                 break;
 123         case FPGA_LOAD:
 124         case FPGA_LOADB:
 125         case FPGA_DUMP:
 126                 if (!fpga_data || !data_size)
 127                         wrong_parms = 1;
 128                 break;
 129 #if defined(CONFIG_CMD_FPGA_LOADMK)
 130         case FPGA_LOADMK:
 131                 if (!fpga_data)
 132                         wrong_parms = 1;
 133                 break;
 134 #endif
 135         }
 136
 137         if (wrong_parms) {
 138                 puts("Wrong parameters for FPGA request\n");
 139                 op = FPGA_NONE;
 140         }
 141
 142         switch (op) {
 143         case FPGA_NONE:
 144                 return CMD_RET_USAGE;
 145
 146         case FPGA_INFO:
 147                 rc = fpga_info(dev);
 148                 break;
 149
 150         case FPGA_LOAD:
 151                 rc = fpga_load(dev, fpga_data, data_size);
 152                 break;
 153
 154         case FPGA_LOADB:
 155                 rc = fpga_loadbitstream(dev, fpga_data, data_size);
 156                 break;
 157
 158 #if defined(CONFIG_CMD_FPGA_LOADMK)
 159         case FPGA_LOADMK:
 160                 switch (genimg_get_format(fpga_data)) {
 161                 case IMAGE_FORMAT_LEGACY:
 162                         {
 163                                 image_header_t *hdr =
 164                                                 (image_header_t *)fpga_data;
 165                                 ulong data;
 166                                 uint8_t comp;
 167
 168                                 comp = image_get_comp(hdr);
 169                                 if (comp == IH_COMP_GZIP) {
 170                                         ulong image_buf = image_get_data(hdr);
 171                                         data = image_get_load(hdr);
 172                                         ulong image_size = ~0UL;
 173
 174                                         if (gunzip((void *)data, ~0UL,
 175                                                    (void *)image_buf,
 176                                                    &image_size) != 0) {
 177                                                 puts("GUNZIP: error\n");
 178                                                 return 1;
 179                                         }
 180                                         data_size = image_size;
 181                                 } else {
 182                                         data = (ulong)image_get_data(hdr);
 183                                         data_size = image_get_data_size(hdr);
 184                                 }
 185                                 rc = fpga_load(dev, (void *)data, data_size);
 186                         }
 187                         break;
 188 #if defined(CONFIG_FIT)
 189                 case IMAGE_FORMAT_FIT:
 190                         {
 191                                 const void *fit_hdr = (const void *)fpga_data;
 192                                 int noffset;
 193                                 const void *fit_data;
 194
 195                                 if (fit_uname == NULL) {
 196                                         puts("No FIT subimage unit name\n");
 197                                         return 1;
 198                                 }
 199
 200                                 if (!fit_check_format(fit_hdr)) {
 201                                         puts("Bad FIT image format\n");
 202                                         return 1;
 203                                 }
 204
 205                                 /* get fpga component image node offset */
 206                                 noffset = fit_image_get_node(fit_hdr,
 207                                                              fit_uname);
 208                                 if (noffset < 0) {
 209                                         printf("Can't find '%s' FIT subimage\n",
 210                                                fit_uname);
 211                                         return 1;
 212                                 }
 213
 214                                 /* verify integrity */
 215                                 if (!fit_image_verify(fit_hdr, noffset)) {
 216                                         puts ("Bad Data Hash\n");
 217                                         return 1;
 218                                 }
 219
 220                                 /* get fpga subimage data address and length */
 221                                 if (fit_image_get_data(fit_hdr, noffset,
 222                                                        &fit_data, &data_size)) {
 223                                         puts("Fpga subimage data not found\n");
 224                                         return 1;
 225                                 }
 226
 227                                 rc = fpga_load(dev, fit_data, data_size);
 228                         }
 229                         break;
 230 #endif
 231                 default:
 232                         puts("** Unknown image type\n");
 233                         rc = FPGA_FAIL;
 234                         break;
 235                 }
 236                 break;
 237 #endif
 238
 239         case FPGA_DUMP:
 240                 rc = fpga_dump(dev, fpga_data, data_size);
 241                 break;
 242
 243         default:
 244                 printf("Unknown operation\n");
 245                 return CMD_RET_USAGE;
 246         }
 247         return rc;
 248 }
 249
 250 /*
 251  * Map op to supported operations.  We don't use a table since we
 252  * would just have to relocate it from flash anyway.
 253  */
 254 static int fpga_get_op(char *opstr)
 255 {
 256         int op = FPGA_NONE;
 257
 258         if (!strcmp("info", opstr))
 259                 op = FPGA_INFO;
 260         else if (!strcmp("loadb", opstr))
 261                 op = FPGA_LOADB;
 262         else if (!strcmp("load", opstr))
 263                 op = FPGA_LOAD;
 264 #if defined(CONFIG_CMD_FPGA_LOADMK)
 265         else if (!strcmp("loadmk", opstr))
 266                 op = FPGA_LOADMK;
 267 #endif
 268         else if (!strcmp("dump", opstr))
 269                 op = FPGA_DUMP;
 270
 271         if (op == FPGA_NONE)
 272                 printf("Unknown fpga operation \"%s\"\n", opstr);
 273
 274         return op;
 275 }
 276
 277 U_BOOT_CMD(fpga, 6, 1, do_fpga,
 278            "loadable FPGA image support",
 279            "[operation type] [device number] [image address] [image size]\n"
 280            "fpga operations:\n"
 281            "  dump\t[dev]\t\t\tLoad device to memory buffer\n"
 282            "  info\t[dev]\t\t\tlist known device information\n"
 283            "  load\t[dev] [address] [size]\tLoad device from memory buffer\n"
 284            "  loadb\t[dev] [address] [size]\t"
 285            "Load device from bitstream buffer (Xilinx only)\n"
 286 #if defined(CONFIG_CMD_FPGA_LOADMK)
 287            "  loadmk [dev] [address]\tLoad device generated with mkimage"
 288 #if defined(CONFIG_FIT)
 289            "\n"
 290            "\tFor loadmk operating on FIT format uImage address must include\n"
 291            "\tsubimage unit name in the form of addr:<subimg_uname>"
 292 #endif
 293 #endif
 294 );