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 /* 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
 127                 /* Blocksize can be zero */
 128                 if (!fpga_fsinfo.interface || !fpga_fsinfo.dev_part ||
 129                     !fpga_fsinfo.filename) {
 130                         puts("ERR: Wrong interface, dev_part or filename\n");
 131                         return CMD_RET_USAGE;
 132                 }
 133
 134                 argc = 5;
 135                 break;
 136 #endif
 137 #if defined(CONFIG_CMD_FPGA_LOAD_SECURE)
 138         case FPGA_LOADS:
 139                 if (argc < 7)
 140                         return CMD_RET_USAGE;
 141                 if (argc == 8)
 142                         fpga_sec_info.userkey_addr = (u8 *)(uintptr_t)
 143                                                      simple_strtoull(argv[7],
 144                                                                      NULL, 16);
 145                 fpga_sec_info.encflag = (u8)simple_strtoul(argv[6], NULL, 16);
 146                 fpga_sec_info.authflag = (u8)simple_strtoul(argv[5], NULL, 16);
 147
 148                 if (fpga_sec_info.authflag >= FPGA_NO_ENC_OR_NO_AUTH &&
 149                     fpga_sec_info.encflag >= FPGA_NO_ENC_OR_NO_AUTH) {
 150                         puts("ERR: Use <fpga load> for NonSecure bitstream\n");
 151                         return CMD_RET_USAGE;
 152                 }
 153
 154                 if (fpga_sec_info.encflag == FPGA_ENC_USR_KEY &&
 155                     !fpga_sec_info.userkey_addr) {
 156                         puts("ERR: User key not provided\n");
 157                         return CMD_RET_USAGE;
 158                 }
 159
 160                 argc = 5;
 161                 break;
 162 #endif
 163         default:
 164                 break;
 165         }
 166
 167         switch (argc) {
 168         case 5:         /* fpga <op> <dev> <data> <datasize> */
 169                 data_size = simple_strtoul(argv[4], NULL, 16);
 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
 188         case 3:         /* fpga <op> <dev | data addr> */
 189                 dev = (int)simple_strtoul(argv[2], NULL, 16);
 190                 debug("%s: device = %d\n", __func__, dev);
 191         }
 192
 193         if (dev == FPGA_INVALID_DEVICE) {
 194                 puts("FPGA device not specified\n");
 195                 return CMD_RET_USAGE;
 196         }
 197
 198         switch (op) {
 199         case FPGA_INFO:
 200                 break;
 201         case FPGA_LOAD:
 202         case FPGA_LOADP:
 203         case FPGA_LOADB:
 204         case FPGA_LOADBP:
 205         case FPGA_DUMP:
 206                 if (!fpga_data || !data_size)
 207                         wrong_parms = 1;
 208                 break;
 209 #if defined(CONFIG_CMD_FPGA_LOADMK)
 210         case FPGA_LOADMK:
 211                 if (!fpga_data)
 212                         wrong_parms = 1;
 213                 break;
 214 #endif
 215         }
 216
 217         if (wrong_parms) {
 218                 puts("Wrong parameters for FPGA request\n");
 219                 return CMD_RET_USAGE;
 220         }
 221
 222         switch (op) {
 223         case FPGA_INFO:
 224                 rc = fpga_info(dev);
 225                 break;
 226
 227         case FPGA_LOAD:
 228                 rc = fpga_load(dev, fpga_data, data_size, BIT_FULL);
 229                 break;
 230
 231 #if defined(CONFIG_CMD_FPGA_LOADP)
 232         case FPGA_LOADP:
 233                 rc = fpga_load(dev, fpga_data, data_size, BIT_PARTIAL);
 234                 break;
 235 #endif
 236
 237         case FPGA_LOADB:
 238                 rc = fpga_loadbitstream(dev, fpga_data, data_size, BIT_FULL);
 239                 break;
 240
 241 #if defined(CONFIG_CMD_FPGA_LOADBP)
 242         case FPGA_LOADBP:
 243                 rc = fpga_loadbitstream(dev, fpga_data, data_size, BIT_PARTIAL);
 244                 break;
 245 #endif
 246
 247 #if defined(CONFIG_CMD_FPGA_LOADFS)
 248         case FPGA_LOADFS:
 249                 rc = fpga_fsload(dev, fpga_data, data_size, &fpga_fsinfo);
 250                 break;
 251 #endif
 252
 253 #if defined(CONFIG_CMD_FPGA_LOAD_SECURE)
 254         case FPGA_LOADS:
 255                 rc = fpga_loads(dev, fpga_data, data_size, &fpga_sec_info);
 256                 break;
 257 #endif
 258
 259 #if defined(CONFIG_CMD_FPGA_LOADMK)
 260         case FPGA_LOADMK:
 261                 switch (genimg_get_format(fpga_data)) {
 262 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
 263                 case IMAGE_FORMAT_LEGACY:
 264                         {
 265                                 image_header_t *hdr =
 266                                                 (image_header_t *)fpga_data;
 267                                 ulong data;
 268                                 uint8_t comp;
 269
 270                                 comp = image_get_comp(hdr);
 271                                 if (comp == IH_COMP_GZIP) {
 272 #if defined(CONFIG_GZIP)
 273                                         ulong image_buf = image_get_data(hdr);
 274                                         data = image_get_load(hdr);
 275                                         ulong image_size = ~0UL;
 276
 277                                         if (gunzip((void *)data, ~0UL,
 278                                                    (void *)image_buf,
 279                                                    &image_size) != 0) {
 280                                                 puts("GUNZIP: error\n");
 281                                                 return 1;
 282                                         }
 283                                         data_size = image_size;
 284 #else
 285                                         puts("Gunzip image is not supported\n");
 286                                         return 1;
 287 #endif
 288                                 } else {
 289                                         data = (ulong)image_get_data(hdr);
 290                                         data_size = image_get_data_size(hdr);
 291                                 }
 292                                 rc = fpga_load(dev, (void *)data, data_size,
 293                                                BIT_FULL);
 294                         }
 295                         break;
 296 #endif
 297 #if defined(CONFIG_FIT)
 298                 case IMAGE_FORMAT_FIT:
 299                         {
 300                                 const void *fit_hdr = (const void *)fpga_data;
 301                                 int noffset;
 302                                 const void *fit_data;
 303
 304                                 if (fit_uname == NULL) {
 305                                         puts("No FIT subimage unit name\n");
 306                                         return 1;
 307                                 }
 308
 309                                 if (!fit_check_format(fit_hdr)) {
 310                                         puts("Bad FIT image format\n");
 311                                         return 1;
 312                                 }
 313
 314                                 /* get fpga component image node offset */
 315                                 noffset = fit_image_get_node(fit_hdr,
 316                                                              fit_uname);
 317                                 if (noffset < 0) {
 318                                         printf("Can't find '%s' FIT subimage\n",
 319                                                fit_uname);
 320                                         return 1;
 321                                 }
 322
 323                                 /* verify integrity */
 324                                 if (!fit_image_verify(fit_hdr, noffset)) {
 325                                         puts ("Bad Data Hash\n");
 326                                         return 1;
 327                                 }
 328
 329                                 /* get fpga subimage data address and length */
 330                                 if (fit_image_get_data(fit_hdr, noffset,
 331                                                        &fit_data, &data_size)) {
 332                                         puts("Fpga subimage data not found\n");
 333                                         return 1;
 334                                 }
 335
 336                                 rc = fpga_load(dev, fit_data, data_size,
 337                                                BIT_FULL);
 338                         }
 339                         break;
 340 #endif
 341                 default:
 342                         puts("** Unknown image type\n");
 343                         rc = FPGA_FAIL;
 344                         break;
 345                 }
 346                 break;
 347 #endif
 348
 349         case FPGA_DUMP:
 350                 rc = fpga_dump(dev, fpga_data, data_size);
 351                 break;
 352
 353         default:
 354                 printf("Unknown operation\n");
 355                 return CMD_RET_USAGE;
 356         }
 357         return rc;
 358 }
 359
 360 #if defined(CONFIG_CMD_FPGA_LOADFS) || defined(CONFIG_CMD_FPGA_LOAD_SECURE)
 361 U_BOOT_CMD(fpga, 9, 1, do_fpga,
 362 #else
 363 U_BOOT_CMD(fpga, 6, 1, do_fpga,
 364 #endif
 365            "loadable FPGA image support",
 366            "[operation type] [device number] [image address] [image size]\n"
 367            "fpga operations:\n"
 368            "  dump\t[dev] [address] [size]\tLoad device to memory buffer\n"
 369            "  info\t[dev]\t\t\tlist known device information\n"
 370            "  load\t[dev] [address] [size]\tLoad device from memory buffer\n"
 371 #if defined(CONFIG_CMD_FPGA_LOADP)
 372            "  loadp\t[dev] [address] [size]\t"
 373            "Load device from memory buffer with partial bitstream\n"
 374 #endif
 375            "  loadb\t[dev] [address] [size]\t"
 376            "Load device from bitstream buffer (Xilinx only)\n"
 377 #if defined(CONFIG_CMD_FPGA_LOADBP)
 378            "  loadbp\t[dev] [address] [size]\t"
 379            "Load device from bitstream buffer with partial bitstream"
 380            "(Xilinx only)\n"
 381 #endif
 382 #if defined(CONFIG_CMD_FPGA_LOADFS)
 383            "Load device from filesystem (FAT by default) (Xilinx only)\n"
 384            "  loadfs [dev] [address] [image size] [blocksize] <interface>\n"
 385            "        [<dev[:part]>] <filename>\n"
 386 #endif
 387 #if defined(CONFIG_CMD_FPGA_LOADMK)
 388            "  loadmk [dev] [address]\tLoad device generated with mkimage"
 389 #if defined(CONFIG_FIT)
 390            "\n"
 391            "\tFor loadmk operating on FIT format uImage address must include\n"
 392            "\tsubimage unit name in the form of addr:<subimg_uname>"
 393 #endif
 394 #endif
 395 #if defined(CONFIG_CMD_FPGA_LOAD_SECURE)
 396            "Load encrypted bitstream (Xilinx only)\n"
 397            "  loads [dev] [address] [size] [auth-OCM-0/DDR-1/noauth-2]\n"
 398            "        [enc-devkey(0)/userkey(1)/nenc(2) [Userkey address]\n"
 399            "Loads the secure bistreams(authenticated/encrypted/both\n"
 400            "authenticated and encrypted) of [size] from [address].\n"
 401            "The auth-OCM/DDR flag specifies to perform authentication\n"
 402            "in OCM or in DDR. 0 for OCM, 1 for DDR, 2 for no authentication.\n"
 403            "The enc flag specifies which key to be used for decryption\n"
 404            "0-device key, 1-user key, 2-no encryption.\n"
 405            "The optional Userkey address specifies from which address key\n"
 406            "has to be used for decryption if user key is selected.\n"
 407            "NOTE: the sceure bitstream has to be created using xilinx\n"
 408            "bootgen tool only.\n"
 409 #endif
 410 );