cmd/fpga.c

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