// SPDX-License-Identifier: GPL-2.0+

  /*
   * (C) Copyright 2000, 2001
   * Rich Ireland, Enterasys Networks, rireland@enterasys.com.

   */
  
  /*
   *  FPGA support
   */
  #include <common.h>
  #include <command.h>

  #include <env.h>

  #include <fpga.h>

  #include <fs.h>

  #include <gzip.h>

  #include <malloc.h>

  static long do_fpga_get_device(char *arg)
  {
  	long dev = FPGA_INVALID_DEVICE;
  	char *devstr = env_get("fpga");
  
  	if (devstr)
  		/* Should be strtol to handle -1 cases */
  		dev = simple_strtol(devstr, NULL, 16);

  	if (dev == FPGA_INVALID_DEVICE && arg)

  		dev = simple_strtol(arg, NULL, 16);
  
  	debug("%s: device = %ld
  ", __func__, dev);
  
  	return dev;
  }

  static int do_fpga_check_params(long *dev, long *fpga_data, size_t *data_size,
  				cmd_tbl_t *cmdtp, int argc, char *const argv[])
  {
  	size_t local_data_size;
  	long local_fpga_data;
  
  	debug("%s %d, %d
  ", __func__, argc, cmdtp->maxargs);
  
  	if (argc != cmdtp->maxargs) {
  		debug("fpga: incorrect parameters passed
  ");
  		return CMD_RET_USAGE;
  	}
  
  	*dev = do_fpga_get_device(argv[0]);
  
  	local_fpga_data = simple_strtol(argv[1], NULL, 16);
  	if (!local_fpga_data) {
  		debug("fpga: zero fpga_data address
  ");
  		return CMD_RET_USAGE;
  	}
  	*fpga_data = local_fpga_data;
  
  	local_data_size = simple_strtoul(argv[2], NULL, 16);
  	if (!local_data_size) {
  		debug("fpga: zero size
  ");
  		return CMD_RET_USAGE;
  	}
  	*data_size = local_data_size;
  
  	return 0;
  }

  #if defined(CONFIG_CMD_FPGA_LOAD_SECURE)

  int do_fpga_loads(cmd_tbl_t *cmdtp, int flag, int argc, char *const argv[])

  {

  	size_t data_size = 0;

  	long fpga_data, dev;
  	int ret;

  	struct fpga_secure_info fpga_sec_info;
  
  	memset(&fpga_sec_info, 0, sizeof(fpga_sec_info));

  	if (argc < 5) {
  		debug("fpga: incorrect parameters passed
  ");

  		return CMD_RET_USAGE;
  	}

  	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
  ");

  		return CMD_RET_USAGE;

  	}

  	if (fpga_sec_info.encflag == FPGA_ENC_USR_KEY &&
  	    !fpga_sec_info.userkey_addr) {
  		debug("fpga: User key not provided
  ");

  		return CMD_RET_USAGE;

  	}

  	ret = do_fpga_check_params(&dev, &fpga_data, &data_size,
  				   cmdtp, argc, argv);
  	if (ret)
  		return ret;

  	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,
  			  char *const argv[])
  {
  	size_t data_size = 0;
  	long fpga_data, dev;
  	int ret;
  	fpga_fs_info fpga_fsinfo;
  
  	ret = do_fpga_check_params(&dev, &fpga_data, &data_size,
  				   cmdtp, argc, argv);
  	if (ret)
  		return ret;
  
  	fpga_fsinfo.fstype = FS_TYPE_ANY;
  	fpga_fsinfo.blocksize = (unsigned int)simple_strtoul(argv[3], NULL, 16);
  	fpga_fsinfo.interface = argv[4];
  	fpga_fsinfo.dev_part = argv[5];
  	fpga_fsinfo.filename = argv[6];
  
  	return fpga_fsload(dev, (void *)fpga_data, data_size, &fpga_fsinfo);
  }
  #endif

  static int do_fpga_info(cmd_tbl_t *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[])
  {
  	size_t data_size = 0;
  	long fpga_data, dev;
  	int ret;
  
  	ret = do_fpga_check_params(&dev, &fpga_data, &data_size,
  				   cmdtp, argc, argv);
  	if (ret)
  		return ret;
  
  	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[])
  {
  	size_t data_size = 0;
  	long fpga_data, dev;
  	int ret;
  
  	ret = do_fpga_check_params(&dev, &fpga_data, &data_size,
  				   cmdtp, argc, argv);
  	if (ret)
  		return ret;
  
  	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[])
  {
  	size_t data_size = 0;
  	long fpga_data, dev;
  	int ret;
  
  	ret = do_fpga_check_params(&dev, &fpga_data, &data_size,
  				   cmdtp, argc, argv);
  	if (ret)
  		return ret;
  
  	return fpga_loadbitstream(dev, (void *)fpga_data, data_size, BIT_FULL);
  }
  
  #if defined(CONFIG_CMD_FPGA_LOADP)
  static int do_fpga_loadp(cmd_tbl_t *cmdtp, int flag, int argc,
  			 char * const argv[])
  {
  	size_t data_size = 0;
  	long fpga_data, dev;
  	int ret;
  
  	ret = do_fpga_check_params(&dev, &fpga_data, &data_size,
  				   cmdtp, argc, argv);
  	if (ret)
  		return ret;
  
  	return fpga_load(dev, (void *)fpga_data, data_size, BIT_PARTIAL);
  }
  #endif
  
  #if defined(CONFIG_CMD_FPGA_LOADBP)
  static int do_fpga_loadbp(cmd_tbl_t *cmdtp, int flag, int argc,
  			  char * const argv[])
  {
  	size_t data_size = 0;
  	long fpga_data, dev;
  	int ret;
  
  	ret = do_fpga_check_params(&dev, &fpga_data, &data_size,
  				   cmdtp, argc, argv);
  	if (ret)
  		return ret;
  
  	return fpga_loadbitstream(dev, (void *)fpga_data, data_size,
  				  BIT_PARTIAL);
  }
  #endif

  #if defined(CONFIG_CMD_FPGA_LOADMK)
  static int do_fpga_loadmk(cmd_tbl_t *cmdtp, int flag, int argc,
  			  char * const argv[])
  {
  	size_t data_size = 0;
  	void *fpga_data = NULL;
  #if defined(CONFIG_FIT)
  	const char *fit_uname = NULL;
  	ulong fit_addr;
  #endif
  	ulong dev = do_fpga_get_device(argv[0]);
  	char *datastr = env_get("fpgadata");

  	debug("fpga: argc %x, dev %lx, datastr %s
  ", argc, dev, datastr);
  
  	if (dev == FPGA_INVALID_DEVICE) {
  		debug("fpga: Invalid fpga device
  ");
  		return CMD_RET_USAGE;
  	}
  
  	if (argc == 0 && !datastr) {
  		debug("fpga: No datastr passed
  ");
  		return CMD_RET_USAGE;
  	}

  
  	if (argc == 2) {

  		datastr = argv[1];
  		debug("fpga: Full command with two args
  ");
  	} else if (argc == 1 && !datastr) {
  		debug("fpga: Dev is setup - fpgadata passed
  ");
  		datastr = argv[0];
  	}

  #if defined(CONFIG_FIT)

  	if (fit_parse_subimage(datastr, (ulong)fpga_data,
  			       &fit_addr, &fit_uname)) {
  		fpga_data = (void *)fit_addr;
  		debug("*  fpga: subimage '%s' from FIT image ",
  		      fit_uname);
  		debug("at 0x%08lx
  ", fit_addr);
  	} else

  #endif

  	{
  		fpga_data = (void *)simple_strtoul(datastr, NULL, 16);
  		debug("*  fpga: cmdline image address = 0x%08lx
  ",
  		      (ulong)fpga_data);
  	}
  	debug("%s: fpga_data = 0x%lx
  ", __func__, (ulong)fpga_data);
  	if (!fpga_data) {
  		puts("Zero fpga_data address
  ");
  		return CMD_RET_USAGE;

  	}
  
  	switch (genimg_get_format(fpga_data)) {

  #if defined(CONFIG_LEGACY_IMAGE_FORMAT)

  	case IMAGE_FORMAT_LEGACY:
  	{
  		image_header_t *hdr = (image_header_t *)fpga_data;
  		ulong data;
  		u8 comp;
  
  		comp = image_get_comp(hdr);
  		if (comp == IH_COMP_GZIP) {
  #if defined(CONFIG_GZIP)
  			ulong image_buf = image_get_data(hdr);
  			ulong image_size = ~0UL;
  
  			data = image_get_load(hdr);
  
  			if (gunzip((void *)data, ~0UL, (void *)image_buf,
  				   &image_size) != 0) {
  				puts("GUNZIP: error
  ");

  				return CMD_RET_FAILURE;

  			}
  			data_size = image_size;
  #else
  			puts("Gunzip image is not supported
  ");
  			return 1;
  #endif
  		} else {
  			data = (ulong)image_get_data(hdr);
  			data_size = image_get_data_size(hdr);
  		}
  		return fpga_load(dev, (void *)data, data_size,
  				  BIT_FULL);
  	}
  #endif
  #if defined(CONFIG_FIT)
  	case IMAGE_FORMAT_FIT:
  	{
  		const void *fit_hdr = (const void *)fpga_data;
  		int noffset;
  		const void *fit_data;
  
  		if (!fit_uname) {
  			puts("No FIT subimage unit name
  ");

  			return CMD_RET_FAILURE;

  		}
  
  		if (!fit_check_format(fit_hdr)) {
  			puts("Bad FIT image format
  ");

  			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
  ", fit_uname);

  			return CMD_RET_FAILURE;

  		}
  
  		/* verify integrity */
  		if (!fit_image_verify(fit_hdr, noffset)) {
  			puts("Bad Data Hash
  ");

  			return CMD_RET_FAILURE;

  		}

  		/* 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
  ");

  			return CMD_RET_FAILURE;

  		}
  
  		return fpga_load(dev, fit_data, data_size, BIT_FULL);
  	}
  #endif
  	default:
  		puts("** Unknown image type
  ");

  		return CMD_RET_FAILURE;

  	}
  }
  #endif

  static cmd_tbl_t 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, "", ""),
  	U_BOOT_CMD_MKENT(loadb, 3, 1, do_fpga_loadb, "", ""),
  #if defined(CONFIG_CMD_FPGA_LOADP)
  	U_BOOT_CMD_MKENT(loadp, 3, 1, do_fpga_loadp, "", ""),
  #endif
  #if defined(CONFIG_CMD_FPGA_LOADBP)
  	U_BOOT_CMD_MKENT(loadbp, 3, 1, do_fpga_loadbp, "", ""),
  #endif

  #if defined(CONFIG_CMD_FPGA_LOADFS)
  	U_BOOT_CMD_MKENT(loadfs, 7, 1, do_fpga_loadfs, "", ""),
  #endif

  #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,
  			   char *const argv[])
  {
  	cmd_tbl_t *fpga_cmd;
  	int ret;
  
  	if (argc < 2)
  		return CMD_RET_USAGE;
  
  	fpga_cmd = find_cmd_tbl(argv[1], fpga_commands,
  				ARRAY_SIZE(fpga_commands));

  	if (!fpga_cmd) {
  		debug("fpga: non existing command
  ");
  		return CMD_RET_USAGE;
  	}
  
  	argc -= 2;
  	argv += 2;
  
  	if (argc > fpga_cmd->maxargs) {
  		debug("fpga: more parameters passed
  ");
  		return CMD_RET_USAGE;
  	}
  
  	ret = fpga_cmd->cmd(fpga_cmd, flag, argc, argv);
  
  	return cmd_process_error(fpga_cmd, ret);
  }

  #if defined(CONFIG_CMD_FPGA_LOADFS) || defined(CONFIG_CMD_FPGA_LOAD_SECURE)

  U_BOOT_CMD(fpga, 9, 1, do_fpga_wrapper,

  #else

  U_BOOT_CMD(fpga, 6, 1, do_fpga_wrapper,

  #endif

  	   "loadable FPGA image support",
  	   "[operation type] [device number] [image address] [image size]
  "
  	   "fpga operations:
  "

  	   "  dump\t[dev] [address] [size]\tLoad device to memory buffer
  "

  	   "  info\t[dev]\t\t\tlist known device information
  "
  	   "  load\t[dev] [address] [size]\tLoad device from memory buffer
  "

  #if defined(CONFIG_CMD_FPGA_LOADP)
  	   "  loadp\t[dev] [address] [size]\t"
  	   "Load device from memory buffer with partial bitstream
  "
  #endif

  	   "  loadb\t[dev] [address] [size]\t"
  	   "Load device from bitstream buffer (Xilinx only)
  "

  #if defined(CONFIG_CMD_FPGA_LOADBP)
  	   "  loadbp\t[dev] [address] [size]\t"
  	   "Load device from bitstream buffer with partial bitstream"
  	   "(Xilinx only)
  "
  #endif

  #if defined(CONFIG_CMD_FPGA_LOADFS)
  	   "Load device from filesystem (FAT by default) (Xilinx only)
  "
  	   "  loadfs [dev] [address] [image size] [blocksize] <interface>
  "
  	   "        [<dev[:part]>] <filename>
  "
  #endif

  #if defined(CONFIG_CMD_FPGA_LOADMK)

  	   "  loadmk [dev] [address]\tLoad device generated with mkimage"

  #if defined(CONFIG_FIT)

  	   "
  "
  	   "\tFor loadmk operating on FIT format uImage address must include
  "
  	   "\tsubimage unit name in the form of addr:<subimg_uname>"

  #endif

  #endif

  #if defined(CONFIG_CMD_FPGA_LOAD_SECURE)
  	   "Load encrypted bitstream (Xilinx only)
  "
  	   "  loads [dev] [address] [size] [auth-OCM-0/DDR-1/noauth-2]
  "
  	   "        [enc-devkey(0)/userkey(1)/nenc(2) [Userkey address]
  "
  	   "Loads the secure bistreams(authenticated/encrypted/both
  "
  	   "authenticated and encrypted) of [size] from [address].
  "
  	   "The auth-OCM/DDR flag specifies to perform authentication
  "
  	   "in OCM or in DDR. 0 for OCM, 1 for DDR, 2 for no authentication.
  "
  	   "The enc flag specifies which key to be used for decryption
  "
  	   "0-device key, 1-user key, 2-no encryption.
  "
  	   "The optional Userkey address specifies from which address key
  "
  	   "has to be used for decryption if user key is selected.
  "

  	   "NOTE: the secure bitstream has to be created using Xilinx
  "

  	   "bootgen tool only.
  "
  #endif

  );