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