Merge tag 'efi-2020-07-rc6' of https://gitlab.denx.de/u-boot/custodians/u-boot-efi
[oweals/u-boot.git] / cmd / fpga.c
index de9d19dd8e91743c2858c04aeff976f4108b8dc2..8ae1c936fbb5bc7b1161cecbc36e4edc13869c32 100644 (file)
@@ -9,8 +9,12 @@
  */
 #include <common.h>
 #include <command.h>
+#include <env.h>
 #include <fpga.h>
 #include <fs.h>
+#include <gzip.h>
+#include <image.h>
+#include <log.h>
 #include <malloc.h>
 
 static long do_fpga_get_device(char *arg)
@@ -31,7 +35,8 @@ static long do_fpga_get_device(char *arg)
 }
 
 static int do_fpga_check_params(long *dev, long *fpga_data, size_t *data_size,
-                               cmd_tbl_t *cmdtp, int argc, char *const argv[])
+                               struct cmd_tbl *cmdtp, int argc,
+                               char *const argv[])
 {
        size_t local_data_size;
        long local_fpga_data;
@@ -62,133 +67,60 @@ static int do_fpga_check_params(long *dev, long *fpga_data, size_t *data_size,
        return 0;
 }
 
-/* Local defines */
-enum {
-       FPGA_NONE = -1,
-       FPGA_LOADS,
-};
-
-/*
- * Map op to supported operations.  We don't use a table since we
- * would just have to relocate it from flash anyway.
- */
-static int fpga_get_op(char *opstr)
-{
-       int op = FPGA_NONE;
-
 #if defined(CONFIG_CMD_FPGA_LOAD_SECURE)
-       if (!strcmp("loads", opstr))
-               op = FPGA_LOADS;
-#endif
-
-       return op;
-}
-
-/* ------------------------------------------------------------------------- */
-/* command form:
- *   fpga <op> <device number> <data addr> <datasize>
- * where op is 'load', 'dump', or 'info'
- * If there is no device number field, the fpga environment variable is used.
- * If there is no data addr field, the fpgadata environment variable is used.
- * The info command requires no data address field.
- */
-int do_fpga(cmd_tbl_t *cmdtp, int flag, int argc, char *const argv[])
+int do_fpga_loads(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 {
-       int op, dev = FPGA_INVALID_DEVICE;
        size_t data_size = 0;
-       void *fpga_data = NULL;
-       int rc = FPGA_FAIL;
-#if defined(CONFIG_CMD_FPGA_LOAD_SECURE)
+       long fpga_data, dev;
+       int ret;
        struct fpga_secure_info fpga_sec_info;
 
        memset(&fpga_sec_info, 0, sizeof(fpga_sec_info));
-#endif
 
-       if (argc > 9 || argc < 2) {
-               debug("%s: Too many or too few args (%d)\n", __func__, argc);
+       if (argc < 5) {
+               debug("fpga: incorrect parameters passed\n");
                return CMD_RET_USAGE;
        }
 
-       op = fpga_get_op(argv[1]);
-
-       switch (op) {
-       case FPGA_NONE:
-               printf("Unknown fpga operation \"%s\"\n", argv[1]);
+       if (argc == 6)
+               fpga_sec_info.userkey_addr = (u8 *)(uintptr_t)
+                                             simple_strtoull(argv[5],
+                                                             NULL, 16);
+       else
+               /*
+                * If 6th parameter is not passed then do_fpga_check_params
+                * will get 5 instead of expected 6 which means that function
+                * return CMD_RET_USAGE. Increase number of params +1 to pass
+                * this.
+                */
+               argc++;
+
+       fpga_sec_info.encflag = (u8)simple_strtoul(argv[4], NULL, 16);
+       fpga_sec_info.authflag = (u8)simple_strtoul(argv[3], NULL, 16);
+
+       if (fpga_sec_info.authflag >= FPGA_NO_ENC_OR_NO_AUTH &&
+           fpga_sec_info.encflag >= FPGA_NO_ENC_OR_NO_AUTH) {
+               debug("fpga: Use <fpga load> for NonSecure bitstream\n");
                return CMD_RET_USAGE;
-#if defined(CONFIG_CMD_FPGA_LOAD_SECURE)
-       case FPGA_LOADS:
-               if (argc < 7)
-                       return CMD_RET_USAGE;
-               if (argc == 8)
-                       fpga_sec_info.userkey_addr = (u8 *)(uintptr_t)
-                                                    simple_strtoull(argv[7],
-                                                                    NULL, 16);
-               fpga_sec_info.encflag = (u8)simple_strtoul(argv[6], NULL, 16);
-               fpga_sec_info.authflag = (u8)simple_strtoul(argv[5], NULL, 16);
-
-               if (fpga_sec_info.authflag >= FPGA_NO_ENC_OR_NO_AUTH &&
-                   fpga_sec_info.encflag >= FPGA_NO_ENC_OR_NO_AUTH) {
-                       puts("ERR: Use <fpga load> for NonSecure bitstream\n");
-                       return CMD_RET_USAGE;
-               }
-
-               if (fpga_sec_info.encflag == FPGA_ENC_USR_KEY &&
-                   !fpga_sec_info.userkey_addr) {
-                       puts("ERR: User key not provided\n");
-                       return CMD_RET_USAGE;
-               }
-
-               argc = 5;
-               break;
-#endif
-       default:
-               break;
-       }
-
-       switch (argc) {
-       case 5:         /* fpga <op> <dev> <data> <datasize> */
-               data_size = simple_strtoul(argv[4], NULL, 16);
-               if (!data_size) {
-                       puts("Zero data_size\n");
-                       return CMD_RET_USAGE;
-               }
-       case 4:         /* fpga <op> <dev> <data> */
-               {
-                       fpga_data = (void *)simple_strtoul(argv[3], NULL, 16);
-                       debug("*  fpga: cmdline image address = 0x%08lx\n",
-                             (ulong)fpga_data);
-               }
-               debug("%s: fpga_data = 0x%lx\n", __func__, (ulong)fpga_data);
-               if (!fpga_data) {
-                       puts("Zero fpga_data address\n");
-                       return CMD_RET_USAGE;
-               }
-       case 3:         /* fpga <op> <dev | data addr> */
-               dev = (int)simple_strtoul(argv[2], NULL, 16);
-               debug("%s: device = %d\n", __func__, dev);
        }
 
-       if (dev == FPGA_INVALID_DEVICE) {
-               puts("FPGA device not specified\n");
+       if (fpga_sec_info.encflag == FPGA_ENC_USR_KEY &&
+           !fpga_sec_info.userkey_addr) {
+               debug("fpga: User key not provided\n");
                return CMD_RET_USAGE;
        }
 
-       switch (op) {
-#if defined(CONFIG_CMD_FPGA_LOAD_SECURE)
-       case FPGA_LOADS:
-               rc = fpga_loads(dev, fpga_data, data_size, &fpga_sec_info);
-               break;
-#endif
+       ret = do_fpga_check_params(&dev, &fpga_data, &data_size,
+                                  cmdtp, argc, argv);
+       if (ret)
+               return ret;
 
-       default:
-               printf("Unknown operation\n");
-               return CMD_RET_USAGE;
-       }
-       return rc;
+       return fpga_loads(dev, (void *)fpga_data, data_size, &fpga_sec_info);
 }
+#endif
 
 #if defined(CONFIG_CMD_FPGA_LOADFS)
-static int do_fpga_loadfs(cmd_tbl_t *cmdtp, int flag, int argc,
+static int do_fpga_loadfs(struct cmd_tbl *cmdtp, int flag, int argc,
                          char *const argv[])
 {
        size_t data_size = 0;
@@ -211,16 +143,16 @@ static int do_fpga_loadfs(cmd_tbl_t *cmdtp, int flag, int argc,
 }
 #endif
 
-static int do_fpga_info(cmd_tbl_t *cmdtp, int flag, int argc,
-                       char * const argv[])
+static int do_fpga_info(struct cmd_tbl *cmdtp, int flag, int argc,
+                       char *const argv[])
 {
        long dev = do_fpga_get_device(argv[0]);
 
        return fpga_info(dev);
 }
 
-static int do_fpga_dump(cmd_tbl_t *cmdtp, int flag, int argc,
-                       char * const argv[])
+static int do_fpga_dump(struct cmd_tbl *cmdtp, int flag, int argc,
+                       char *const argv[])
 {
        size_t data_size = 0;
        long fpga_data, dev;
@@ -234,8 +166,8 @@ static int do_fpga_dump(cmd_tbl_t *cmdtp, int flag, int argc,
        return fpga_dump(dev, (void *)fpga_data, data_size);
 }
 
-static int do_fpga_load(cmd_tbl_t *cmdtp, int flag, int argc,
-                       char * const argv[])
+static int do_fpga_load(struct cmd_tbl *cmdtp, int flag, int argc,
+                       char *const argv[])
 {
        size_t data_size = 0;
        long fpga_data, dev;
@@ -249,8 +181,8 @@ static int do_fpga_load(cmd_tbl_t *cmdtp, int flag, int argc,
        return fpga_load(dev, (void *)fpga_data, data_size, BIT_FULL);
 }
 
-static int do_fpga_loadb(cmd_tbl_t *cmdtp, int flag, int argc,
-                        char * const argv[])
+static int do_fpga_loadb(struct cmd_tbl *cmdtp, int flag, int argc,
+                        char *const argv[])
 {
        size_t data_size = 0;
        long fpga_data, dev;
@@ -265,8 +197,8 @@ static int do_fpga_loadb(cmd_tbl_t *cmdtp, int flag, int argc,
 }
 
 #if defined(CONFIG_CMD_FPGA_LOADP)
-static int do_fpga_loadp(cmd_tbl_t *cmdtp, int flag, int argc,
-                        char * const argv[])
+static int do_fpga_loadp(struct cmd_tbl *cmdtp, int flag, int argc,
+                        char *const argv[])
 {
        size_t data_size = 0;
        long fpga_data, dev;
@@ -282,8 +214,8 @@ static int do_fpga_loadp(cmd_tbl_t *cmdtp, int flag, int argc,
 #endif
 
 #if defined(CONFIG_CMD_FPGA_LOADBP)
-static int do_fpga_loadbp(cmd_tbl_t *cmdtp, int flag, int argc,
-                         char * const argv[])
+static int do_fpga_loadbp(struct cmd_tbl *cmdtp, int flag, int argc,
+                         char *const argv[])
 {
        size_t data_size = 0;
        long fpga_data, dev;
@@ -300,8 +232,8 @@ static int do_fpga_loadbp(cmd_tbl_t *cmdtp, int flag, int argc,
 #endif
 
 #if defined(CONFIG_CMD_FPGA_LOADMK)
-static int do_fpga_loadmk(cmd_tbl_t *cmdtp, int flag, int argc,
-                         char * const argv[])
+static int do_fpga_loadmk(struct cmd_tbl *cmdtp, int flag, int argc,
+                         char *const argv[])
 {
        size_t data_size = 0;
        void *fpga_data = NULL;
@@ -353,7 +285,7 @@ static int do_fpga_loadmk(cmd_tbl_t *cmdtp, int flag, int argc,
        }
 
        switch (genimg_get_format(fpga_data)) {
-#if defined(CONFIG_IMAGE_FORMAT_LEGACY)
+#if defined(CONFIG_LEGACY_IMAGE_FORMAT)
        case IMAGE_FORMAT_LEGACY:
        {
                image_header_t *hdr = (image_header_t *)fpga_data;
@@ -371,7 +303,7 @@ static int do_fpga_loadmk(cmd_tbl_t *cmdtp, int flag, int argc,
                        if (gunzip((void *)data, ~0UL, (void *)image_buf,
                                   &image_size) != 0) {
                                puts("GUNZIP: error\n");
-                               return 1;
+                               return CMD_RET_FAILURE;
                        }
                        data_size = image_size;
 #else
@@ -395,32 +327,32 @@ static int do_fpga_loadmk(cmd_tbl_t *cmdtp, int flag, int argc,
 
                if (!fit_uname) {
                        puts("No FIT subimage unit name\n");
-                       return 1;
+                       return CMD_RET_FAILURE;
                }
 
                if (!fit_check_format(fit_hdr)) {
                        puts("Bad FIT image format\n");
-                       return 1;
+                       return CMD_RET_FAILURE;
                }
 
                /* get fpga component image node offset */
                noffset = fit_image_get_node(fit_hdr, fit_uname);
                if (noffset < 0) {
                        printf("Can't find '%s' FIT subimage\n", fit_uname);
-                       return 1;
+                       return CMD_RET_FAILURE;
                }
 
                /* verify integrity */
                if (!fit_image_verify(fit_hdr, noffset)) {
                        puts("Bad Data Hash\n");
-                       return 1;
+                       return CMD_RET_FAILURE;
                }
 
-               /* get fpga subimage data address and length */
-               if (fit_image_get_data(fit_hdr, noffset, &fit_data,
-                                      &data_size)) {
+               /* get fpga subimage/external data address and length */
+               if (fit_image_get_data_and_size(fit_hdr, noffset,
+                                              &fit_data, &data_size)) {
                        puts("Fpga subimage data not found\n");
-                       return 1;
+                       return CMD_RET_FAILURE;
                }
 
                return fpga_load(dev, fit_data, data_size, BIT_FULL);
@@ -428,12 +360,12 @@ static int do_fpga_loadmk(cmd_tbl_t *cmdtp, int flag, int argc,
 #endif
        default:
                puts("** Unknown image type\n");
-               return FPGA_FAIL;
+               return CMD_RET_FAILURE;
        }
 }
 #endif
 
-static cmd_tbl_t fpga_commands[] = {
+static struct cmd_tbl fpga_commands[] = {
        U_BOOT_CMD_MKENT(info, 1, 1, do_fpga_info, "", ""),
        U_BOOT_CMD_MKENT(dump, 3, 1, do_fpga_dump, "", ""),
        U_BOOT_CMD_MKENT(load, 3, 1, do_fpga_load, "", ""),
@@ -450,12 +382,15 @@ static cmd_tbl_t fpga_commands[] = {
 #if defined(CONFIG_CMD_FPGA_LOADMK)
        U_BOOT_CMD_MKENT(loadmk, 2, 1, do_fpga_loadmk, "", ""),
 #endif
+#if defined(CONFIG_CMD_FPGA_LOAD_SECURE)
+       U_BOOT_CMD_MKENT(loads, 6, 1, do_fpga_loads, "", ""),
+#endif
 };
 
-static int do_fpga_wrapper(cmd_tbl_t *cmdtp, int flag, int argc,
+static int do_fpga_wrapper(struct cmd_tbl *cmdtp, int flag, int argc,
                           char *const argv[])
 {
-       cmd_tbl_t *fpga_cmd;
+       struct cmd_tbl *fpga_cmd;
        int ret;
 
        if (argc < 2)
@@ -463,12 +398,6 @@ static int do_fpga_wrapper(cmd_tbl_t *cmdtp, int flag, int argc,
 
        fpga_cmd = find_cmd_tbl(argv[1], fpga_commands,
                                ARRAY_SIZE(fpga_commands));
-
-       /* This should be removed when all functions are converted */
-       if (!fpga_cmd)
-               return do_fpga(cmdtp, flag, argc, argv);
-
-       /* FIXME This can't be reached till all functions are converted */
        if (!fpga_cmd) {
                debug("fpga: non existing command\n");
                return CMD_RET_USAGE;
@@ -534,7 +463,7 @@ U_BOOT_CMD(fpga, 6, 1, do_fpga_wrapper,
           "0-device key, 1-user key, 2-no encryption.\n"
           "The optional Userkey address specifies from which address key\n"
           "has to be used for decryption if user key is selected.\n"
-          "NOTE: the sceure bitstream has to be created using xilinx\n"
+          "NOTE: the secure bitstream has to be created using Xilinx\n"
           "bootgen tool only.\n"
 #endif
 );