cmd/fpga.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2000, 2001
   4  * Rich Ireland, Enterasys Networks, rireland@enterasys.com.
   5  */
   6
   7 /*
   8  *  FPGA support
   9  */
  10 #include <common.h>
  11 #include <command.h>
  12 #include <fpga.h>
  13 #include <fs.h>
  14 #include <malloc.h>
  15
  16 static long do_fpga_get_device(char *arg)
  17 {
  18         long dev = FPGA_INVALID_DEVICE;
  19         char *devstr = env_get("fpga");
  20
  21         if (devstr)
  22                 /* Should be strtol to handle -1 cases */
  23                 dev = simple_strtol(devstr, NULL, 16);
  24
  25         if (arg)
  26                 dev = simple_strtol(arg, NULL, 16);
  27
  28         debug("%s: device = %ld\n", __func__, dev);
  29
  30         return dev;
  31 }
  32
  33 static int do_fpga_check_params(long *dev, long *fpga_data, size_t *data_size,
  34                                 cmd_tbl_t *cmdtp, int argc, char *const argv[])
  35 {
  36         size_t local_data_size;
  37         long local_fpga_data;
  38
  39         debug("%s %d, %d\n", __func__, argc, cmdtp->maxargs);
  40
  41         if (argc != cmdtp->maxargs) {
  42                 debug("fpga: incorrect parameters passed\n");
  43                 return CMD_RET_USAGE;
  44         }
  45
  46         *dev = do_fpga_get_device(argv[0]);
  47
  48         local_fpga_data = simple_strtol(argv[1], NULL, 16);
  49         if (!local_fpga_data) {
  50                 debug("fpga: zero fpga_data address\n");
  51                 return CMD_RET_USAGE;
  52         }
  53         *fpga_data = local_fpga_data;
  54
  55         local_data_size = simple_strtoul(argv[2], NULL, 16);
  56         if (!local_data_size) {
  57                 debug("fpga: zero size\n");
  58                 return CMD_RET_USAGE;
  59         }
  60         *data_size = local_data_size;
  61
  62         return 0;
  63 }
  64
  65 /* Local defines */
  66 enum {
  67         FPGA_NONE = -1,
  68         FPGA_LOADMK,
  69         FPGA_LOADS,
  70 };
  71
  72 /*
  73  * Map op to supported operations.  We don't use a table since we
  74  * would just have to relocate it from flash anyway.
  75  */
  76 static int fpga_get_op(char *opstr)
  77 {
  78         int op = FPGA_NONE;
  79
  80 #if defined(CONFIG_CMD_FPGA_LOADMK)
  81         if (!strcmp("loadmk", opstr))
  82                 op = FPGA_LOADMK;
  83 #endif
  84 #if defined(CONFIG_CMD_FPGA_LOAD_SECURE)
  85         else if (!strcmp("loads", opstr))
  86                 op = FPGA_LOADS;
  87 #endif
  88
  89         return op;
  90 }
  91
  92 /* ------------------------------------------------------------------------- */
  93 /* command form:
  94  *   fpga <op> <device number> <data addr> <datasize>
  95  * where op is 'load', 'dump', or 'info'
  96  * If there is no device number field, the fpga environment variable is used.
  97  * If there is no data addr field, the fpgadata environment variable is used.
  98  * The info command requires no data address field.
  99  */
 100 int do_fpga(cmd_tbl_t *cmdtp, int flag, int argc, char *const argv[])
 101 {
 102         int op, dev = FPGA_INVALID_DEVICE;
 103         size_t data_size = 0;
 104         void *fpga_data = NULL;
 105         char *devstr = env_get("fpga");
 106         char *datastr = env_get("fpgadata");
 107         int rc = FPGA_FAIL;
 108 #if defined(CONFIG_FIT)
 109         const char *fit_uname = NULL;
 110         ulong fit_addr;
 111 #endif
 112 #if defined(CONFIG_CMD_FPGA_LOAD_SECURE)
 113         struct fpga_secure_info fpga_sec_info;
 114
 115         memset(&fpga_sec_info, 0, sizeof(fpga_sec_info));
 116 #endif
 117
 118         if (devstr)
 119                 dev = (int) simple_strtoul(devstr, NULL, 16);
 120         if (datastr)
 121                 fpga_data = (void *)simple_strtoul(datastr, NULL, 16);
 122
 123         if (argc > 9 || argc < 2) {
 124                 debug("%s: Too many or too few args (%d)\n", __func__, argc);
 125                 return CMD_RET_USAGE;
 126         }
 127
 128         op = fpga_get_op(argv[1]);
 129
 130         switch (op) {
 131         case FPGA_NONE:
 132                 printf("Unknown fpga operation \"%s\"\n", argv[1]);
 133                 return CMD_RET_USAGE;
 134 #if defined(CONFIG_CMD_FPGA_LOAD_SECURE)
 135         case FPGA_LOADS:
 136                 if (argc < 7)
 137                         return CMD_RET_USAGE;
 138                 if (argc == 8)
 139                         fpga_sec_info.userkey_addr = (u8 *)(uintptr_t)
 140                                                      simple_strtoull(argv[7],
 141                                                                      NULL, 16);
 142                 fpga_sec_info.encflag = (u8)simple_strtoul(argv[6], NULL, 16);
 143                 fpga_sec_info.authflag = (u8)simple_strtoul(argv[5], NULL, 16);
 144
 145                 if (fpga_sec_info.authflag >= FPGA_NO_ENC_OR_NO_AUTH &&
 146                     fpga_sec_info.encflag >= FPGA_NO_ENC_OR_NO_AUTH) {
 147                         puts("ERR: Use <fpga load> for NonSecure bitstream\n");
 148                         return CMD_RET_USAGE;
 149                 }
 150
 151                 if (fpga_sec_info.encflag == FPGA_ENC_USR_KEY &&
 152                     !fpga_sec_info.userkey_addr) {
 153                         puts("ERR: User key not provided\n");
 154                         return CMD_RET_USAGE;
 155                 }
 156
 157                 argc = 5;
 158                 break;
 159 #endif
 160         default:
 161                 break;
 162         }
 163
 164         switch (argc) {
 165         case 5:         /* fpga <op> <dev> <data> <datasize> */
 166                 data_size = simple_strtoul(argv[4], NULL, 16);
 167                 if (!data_size) {
 168                         puts("Zero data_size\n");
 169                         return CMD_RET_USAGE;
 170                 }
 171         case 4:         /* fpga <op> <dev> <data> */
 172 #if defined(CONFIG_FIT)
 173                 if (fit_parse_subimage(argv[3], (ulong)fpga_data,
 174                                        &fit_addr, &fit_uname)) {
 175                         fpga_data = (void *)fit_addr;
 176                         debug("*  fpga: subimage '%s' from FIT image ",
 177                               fit_uname);
 178                         debug("at 0x%08lx\n", fit_addr);
 179                 } else
 180 #endif
 181                 {
 182                         fpga_data = (void *)simple_strtoul(argv[3], NULL, 16);
 183                         debug("*  fpga: cmdline image address = 0x%08lx\n",
 184                               (ulong)fpga_data);
 185                 }
 186                 debug("%s: fpga_data = 0x%lx\n", __func__, (ulong)fpga_data);
 187                 if (!fpga_data) {
 188                         puts("Zero fpga_data address\n");
 189                         return CMD_RET_USAGE;
 190                 }
 191         case 3:         /* fpga <op> <dev | data addr> */
 192                 dev = (int)simple_strtoul(argv[2], NULL, 16);
 193                 debug("%s: device = %d\n", __func__, dev);
 194         }
 195
 196         if (dev == FPGA_INVALID_DEVICE) {
 197                 puts("FPGA device not specified\n");
 198                 return CMD_RET_USAGE;
 199         }
 200
 201         switch (op) {
 202 #if defined(CONFIG_CMD_FPGA_LOAD_SECURE)
 203         case FPGA_LOADS:
 204                 rc = fpga_loads(dev, fpga_data, data_size, &fpga_sec_info);
 205                 break;
 206 #endif
 207 #if defined(CONFIG_CMD_FPGA_LOADMK)
 208         case FPGA_LOADMK:
 209                 switch (genimg_get_format(fpga_data)) {
 210 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
 211                 case IMAGE_FORMAT_LEGACY:
 212                         {
 213                                 image_header_t *hdr =
 214                                                 (image_header_t *)fpga_data;
 215                                 ulong data;
 216                                 uint8_t comp;
 217
 218                                 comp = image_get_comp(hdr);
 219                                 if (comp == IH_COMP_GZIP) {
 220 #if defined(CONFIG_GZIP)
 221                                         ulong image_buf = image_get_data(hdr);
 222                                         data = image_get_load(hdr);
 223                                         ulong image_size = ~0UL;
 224
 225                                         if (gunzip((void *)data, ~0UL,
 226                                                    (void *)image_buf,
 227                                                    &image_size) != 0) {
 228                                                 puts("GUNZIP: error\n");
 229                                                 return 1;
 230                                         }
 231                                         data_size = image_size;
 232 #else
 233                                         puts("Gunzip image is not supported\n");
 234                                         return 1;
 235 #endif
 236                                 } else {
 237                                         data = (ulong)image_get_data(hdr);
 238                                         data_size = image_get_data_size(hdr);
 239                                 }
 240                                 rc = fpga_load(dev, (void *)data, data_size,
 241                                                BIT_FULL);
 242                         }
 243                         break;
 244 #endif
 245 #if defined(CONFIG_FIT)
 246                 case IMAGE_FORMAT_FIT:
 247                         {
 248                                 const void *fit_hdr = (const void *)fpga_data;
 249                                 int noffset;
 250                                 const void *fit_data;
 251
 252                                 if (fit_uname == NULL) {
 253                                         puts("No FIT subimage unit name\n");
 254                                         return 1;
 255                                 }
 256
 257                                 if (!fit_check_format(fit_hdr)) {
 258                                         puts("Bad FIT image format\n");
 259                                         return 1;
 260                                 }
 261
 262                                 /* get fpga component image node offset */
 263                                 noffset = fit_image_get_node(fit_hdr,
 264                                                              fit_uname);
 265                                 if (noffset < 0) {
 266                                         printf("Can't find '%s' FIT subimage\n",
 267                                                fit_uname);
 268                                         return 1;
 269                                 }
 270
 271                                 /* verify integrity */
 272                                 if (!fit_image_verify(fit_hdr, noffset)) {
 273                                         puts ("Bad Data Hash\n");
 274                                         return 1;
 275                                 }
 276
 277                                 /* get fpga subimage data address and length */
 278                                 if (fit_image_get_data(fit_hdr, noffset,
 279                                                        &fit_data, &data_size)) {
 280                                         puts("Fpga subimage data not found\n");
 281                                         return 1;
 282                                 }
 283
 284                                 rc = fpga_load(dev, fit_data, data_size,
 285                                                BIT_FULL);
 286                         }
 287                         break;
 288 #endif
 289                 default:
 290                         puts("** Unknown image type\n");
 291                         rc = FPGA_FAIL;
 292                         break;
 293                 }
 294                 break;
 295 #endif
 296
 297         default:
 298                 printf("Unknown operation\n");
 299                 return CMD_RET_USAGE;
 300         }
 301         return rc;
 302 }
 303
 304 #if defined(CONFIG_CMD_FPGA_LOADFS)
 305 static int do_fpga_loadfs(cmd_tbl_t *cmdtp, int flag, int argc,
 306                           char *const argv[])
 307 {
 308         size_t data_size = 0;
 309         long fpga_data, dev;
 310         int ret;
 311         fpga_fs_info fpga_fsinfo;
 312
 313         ret = do_fpga_check_params(&dev, &fpga_data, &data_size,
 314                                    cmdtp, argc, argv);
 315         if (ret)
 316                 return ret;
 317
 318         fpga_fsinfo.fstype = FS_TYPE_ANY;
 319         fpga_fsinfo.blocksize = (unsigned int)simple_strtoul(argv[3], NULL, 16);
 320         fpga_fsinfo.interface = argv[4];
 321         fpga_fsinfo.dev_part = argv[5];
 322         fpga_fsinfo.filename = argv[6];
 323
 324         return fpga_fsload(dev, (void *)fpga_data, data_size, &fpga_fsinfo);
 325 }
 326 #endif
 327
 328 static int do_fpga_info(cmd_tbl_t *cmdtp, int flag, int argc,
 329                         char * const argv[])
 330 {
 331         long dev = do_fpga_get_device(argv[0]);
 332
 333         return fpga_info(dev);
 334 }
 335
 336 static int do_fpga_dump(cmd_tbl_t *cmdtp, int flag, int argc,
 337                         char * const argv[])
 338 {
 339         size_t data_size = 0;
 340         long fpga_data, dev;
 341         int ret;
 342
 343         ret = do_fpga_check_params(&dev, &fpga_data, &data_size,
 344                                    cmdtp, argc, argv);
 345         if (ret)
 346                 return ret;
 347
 348         return fpga_dump(dev, (void *)fpga_data, data_size);
 349 }
 350
 351 static int do_fpga_load(cmd_tbl_t *cmdtp, int flag, int argc,
 352                         char * const argv[])
 353 {
 354         size_t data_size = 0;
 355         long fpga_data, dev;
 356         int ret;
 357
 358         ret = do_fpga_check_params(&dev, &fpga_data, &data_size,
 359                                    cmdtp, argc, argv);
 360         if (ret)
 361                 return ret;
 362
 363         return fpga_load(dev, (void *)fpga_data, data_size, BIT_FULL);
 364 }
 365
 366 static int do_fpga_loadb(cmd_tbl_t *cmdtp, int flag, int argc,
 367                          char * const argv[])
 368 {
 369         size_t data_size = 0;
 370         long fpga_data, dev;
 371         int ret;
 372
 373         ret = do_fpga_check_params(&dev, &fpga_data, &data_size,
 374                                    cmdtp, argc, argv);
 375         if (ret)
 376                 return ret;
 377
 378         return fpga_loadbitstream(dev, (void *)fpga_data, data_size, BIT_FULL);
 379 }
 380
 381 #if defined(CONFIG_CMD_FPGA_LOADP)
 382 static int do_fpga_loadp(cmd_tbl_t *cmdtp, int flag, int argc,
 383                          char * const argv[])
 384 {
 385         size_t data_size = 0;
 386         long fpga_data, dev;
 387         int ret;
 388
 389         ret = do_fpga_check_params(&dev, &fpga_data, &data_size,
 390                                    cmdtp, argc, argv);
 391         if (ret)
 392                 return ret;
 393
 394         return fpga_load(dev, (void *)fpga_data, data_size, BIT_PARTIAL);
 395 }
 396 #endif
 397
 398 #if defined(CONFIG_CMD_FPGA_LOADBP)
 399 static int do_fpga_loadbp(cmd_tbl_t *cmdtp, int flag, int argc,
 400                           char * const argv[])
 401 {
 402         size_t data_size = 0;
 403         long fpga_data, dev;
 404         int ret;
 405
 406         ret = do_fpga_check_params(&dev, &fpga_data, &data_size,
 407                                    cmdtp, argc, argv);
 408         if (ret)
 409                 return ret;
 410
 411         return fpga_loadbitstream(dev, (void *)fpga_data, data_size,
 412                                   BIT_PARTIAL);
 413 }
 414 #endif
 415
 416 static cmd_tbl_t fpga_commands[] = {
 417         U_BOOT_CMD_MKENT(info, 1, 1, do_fpga_info, "", ""),
 418         U_BOOT_CMD_MKENT(dump, 3, 1, do_fpga_dump, "", ""),
 419         U_BOOT_CMD_MKENT(load, 3, 1, do_fpga_load, "", ""),
 420         U_BOOT_CMD_MKENT(loadb, 3, 1, do_fpga_loadb, "", ""),
 421 #if defined(CONFIG_CMD_FPGA_LOADP)
 422         U_BOOT_CMD_MKENT(loadp, 3, 1, do_fpga_loadp, "", ""),
 423 #endif
 424 #if defined(CONFIG_CMD_FPGA_LOADBP)
 425         U_BOOT_CMD_MKENT(loadbp, 3, 1, do_fpga_loadbp, "", ""),
 426 #endif
 427 #if defined(CONFIG_CMD_FPGA_LOADFS)
 428         U_BOOT_CMD_MKENT(loadfs, 7, 1, do_fpga_loadfs, "", ""),
 429 #endif
 430 };
 431
 432 static int do_fpga_wrapper(cmd_tbl_t *cmdtp, int flag, int argc,
 433                            char *const argv[])
 434 {
 435         cmd_tbl_t *fpga_cmd;
 436         int ret;
 437
 438         if (argc < 2)
 439                 return CMD_RET_USAGE;
 440
 441         fpga_cmd = find_cmd_tbl(argv[1], fpga_commands,
 442                                 ARRAY_SIZE(fpga_commands));
 443
 444         /* This should be removed when all functions are converted */
 445         if (!fpga_cmd)
 446                 return do_fpga(cmdtp, flag, argc, argv);
 447
 448         /* FIXME This can't be reached till all functions are converted */
 449         if (!fpga_cmd) {
 450                 debug("fpga: non existing command\n");
 451                 return CMD_RET_USAGE;
 452         }
 453
 454         argc -= 2;
 455         argv += 2;
 456
 457         if (argc > fpga_cmd->maxargs) {
 458                 debug("fpga: more parameters passed\n");
 459                 return CMD_RET_USAGE;
 460         }
 461
 462         ret = fpga_cmd->cmd(fpga_cmd, flag, argc, argv);
 463
 464         return cmd_process_error(fpga_cmd, ret);
 465 }
 466
 467 #if defined(CONFIG_CMD_FPGA_LOADFS) || defined(CONFIG_CMD_FPGA_LOAD_SECURE)
 468 U_BOOT_CMD(fpga, 9, 1, do_fpga_wrapper,
 469 #else
 470 U_BOOT_CMD(fpga, 6, 1, do_fpga_wrapper,
 471 #endif
 472            "loadable FPGA image support",
 473            "[operation type] [device number] [image address] [image size]\n"
 474            "fpga operations:\n"
 475            "  dump\t[dev] [address] [size]\tLoad device to memory buffer\n"
 476            "  info\t[dev]\t\t\tlist known device information\n"
 477            "  load\t[dev] [address] [size]\tLoad device from memory buffer\n"
 478 #if defined(CONFIG_CMD_FPGA_LOADP)
 479            "  loadp\t[dev] [address] [size]\t"
 480            "Load device from memory buffer with partial bitstream\n"
 481 #endif
 482            "  loadb\t[dev] [address] [size]\t"
 483            "Load device from bitstream buffer (Xilinx only)\n"
 484 #if defined(CONFIG_CMD_FPGA_LOADBP)
 485            "  loadbp\t[dev] [address] [size]\t"
 486            "Load device from bitstream buffer with partial bitstream"
 487            "(Xilinx only)\n"
 488 #endif
 489 #if defined(CONFIG_CMD_FPGA_LOADFS)
 490            "Load device from filesystem (FAT by default) (Xilinx only)\n"
 491            "  loadfs [dev] [address] [image size] [blocksize] <interface>\n"
 492            "        [<dev[:part]>] <filename>\n"
 493 #endif
 494 #if defined(CONFIG_CMD_FPGA_LOADMK)
 495            "  loadmk [dev] [address]\tLoad device generated with mkimage"
 496 #if defined(CONFIG_FIT)
 497            "\n"
 498            "\tFor loadmk operating on FIT format uImage address must include\n"
 499            "\tsubimage unit name in the form of addr:<subimg_uname>"
 500 #endif
 501 #endif
 502 #if defined(CONFIG_CMD_FPGA_LOAD_SECURE)
 503            "Load encrypted bitstream (Xilinx only)\n"
 504            "  loads [dev] [address] [size] [auth-OCM-0/DDR-1/noauth-2]\n"
 505            "        [enc-devkey(0)/userkey(1)/nenc(2) [Userkey address]\n"
 506            "Loads the secure bistreams(authenticated/encrypted/both\n"
 507            "authenticated and encrypted) of [size] from [address].\n"
 508            "The auth-OCM/DDR flag specifies to perform authentication\n"
 509            "in OCM or in DDR. 0 for OCM, 1 for DDR, 2 for no authentication.\n"
 510            "The enc flag specifies which key to be used for decryption\n"
 511            "0-device key, 1-user key, 2-no encryption.\n"
 512            "The optional Userkey address specifies from which address key\n"
 513            "has to be used for decryption if user key is selected.\n"
 514            "NOTE: the sceure bitstream has to be created using xilinx\n"
 515            "bootgen tool only.\n"
 516 #endif
 517 );