openFPGALoader

// SPDX-License-Identifier: Apache-2.0
/*
 * Copyright (C) 2019 Gwenhael Goavec-Merou <gwenhael.goavec-merou@trabucayre.com>
 */

#include <string.h>
#include <unistd.h>

#include <fstream>
#include <iomanip>
#include <iostream>
#include <map>
#include <sstream>
#include <vector>

#ifdef ENABLE_ALTERA_SUPPORT
#include "altera.hpp"
#endif
#ifdef ENABLE_ANLOGIC_SUPPORT
#include "anlogic.hpp"
#endif
#include "board.hpp"
#include "cable.hpp"
#ifdef ENABLE_COLOGNECHIP_SUPPORT
#include "colognechip.hpp"
#endif
#include "common.hpp"
#include "cxxopts.hpp"
#include "device.hpp"
#ifdef ENABLE_DFU
#include "dfu.hpp"
#endif
#include "display.hpp"
#ifdef ENABLE_EFINIX_SUPPORT
#include "efinix.hpp"
#endif
#ifdef USE_LIBFTDI
#include "ftdispi.hpp"
#endif
#ifdef ENABLE_GOWIN_SUPPORT
#include "gowin.hpp"
#endif
#ifdef ENABLE_LATTICE_SUPPORT
#include "lattice.hpp"
#endif
#ifdef ENABLE_ICE40_SUPPORT
#include "ice40.hpp"
#endif
#ifdef ENABLE_LATTICESSPI_SUPPORT
#include "latticeSSPI.hpp"
#endif
#ifdef ENABLE_USB_SCAN
#include "libusb_ll.hpp"
#endif
#include "jtag.hpp"
#include "part.hpp"
#include "progressBar.hpp"
#include "spiFlash.hpp"
#include "rawParser.hpp"
#ifdef ENABLE_USBBLASTER
#include "usbBlaster.hpp"
#endif
#ifdef ENABLE_XILINX_SUPPORT
#include "xilinx.hpp"
#endif
#ifdef ENABLE_SVF_JTAG
#include "svf_jtag.hpp"
#endif
#ifdef ENABLE_XVC_SERVER
#include "xvc_server.hpp"
#endif

#define DEFAULT_FREQ 	6000000


struct arguments {
	int8_t verbose;
	bool force_terminal_mode;
	bool reset, detect, detect_flash, verify, scan_usb;
	unsigned int offset;
	std::string bit_file;
	std::string secondary_bit_file;
	std::string device;
	std::string cable;
	std::string usb_serial_num;
	int ftdi_channel;
	int status_pin;
	uint32_t freq;
	bool invert_read_edge;
	std::string board;
	bool pin_config;
	bool list_cables;
	bool list_boards;
	bool list_fpga;
	Device::prog_type_t prg_type;
	bool is_list_command;
	bool spi;
	bool dfu;
	bool passive_serial;
	std::string file_type;
	std::string fpga_part;
	std::string bridge_path;
	std::string probe_firmware;
	int index_chain;
	unsigned int file_size;
	std::string target_flash;
	bool external_flash;
	bool spi_flash_type;
	int16_t altsetting;
	uint16_t vid;
	uint16_t pid;
	int16_t cable_index;
	uint8_t bus_addr;
	uint8_t device_addr;
	std::string ip_adr;
	uint32_t protect_flash;
	bool unprotect_flash;
	bool enable_quad;
	bool disable_quad;
	bool bulk_erase_flash;
	std::string flash_sector;
	bool skip_load_bridge;
	bool skip_reset;
	/* xvc server */
	bool xvc;
	int port;
	std::string interface;
	std::string mcufw;
	bool conmcu;
	std::map<uint32_t, misc_device> user_misc_devs;
	bool read_dna;
	bool read_xadc;
	std::string read_register;
	std::string user_flash;
};

int run_xvc_server(const struct arguments &args, const cable_t &cable,
	const jtag_pins_conf_t *pins_config);

#ifdef USE_LIBFTDI
int spi_comm(struct arguments args, const cable_t &cable,
	const jtag_pins_conf_t *pins_config, target_board_t *board);
#endif

int parse_opt(int argc, char **argv, struct arguments *args,
	jtag_pins_conf_t *pins_config);

void displaySupported(const struct arguments &args);

int main(int argc, char **argv)
{
	cable_t cable;
	target_board_t *board = NULL;
	jtag_pins_conf_t pins_config = {0, 0, 0, 0, 0, 0};

	/* command line args. */
	struct arguments args = {
			/* verbose, force_terminal_mode */
			0,          false,
			//reset, detect, detect_flash, verify, scan_usb
			false,   false,  false,        false,  false,
			0, "", "", "", "-", "", -1,
			-1, 0, false, "-", false, false, false, false, Device::PRG_NONE, false,
			/* spi dfu   passive_serial file_type fpga_part bridge_path probe_firmware */
			false, false, false,          "",       "",       "",         "",
			/* index_chain file_size target_flash external_flash spi_flash_type altsetting */
			-1,            0,        "primary",   false,         true,          -1,
			/* vid, pid, index bus_addr, device_addr */
				0,   0,   -1,     0,         0,
			"127.0.0.1", 0, false, false, false, false, "", false, false,
			/* xvc server */
			false, 3721, "-",
			"", false, {},  // mcufw conmcu, user_misc_dev_list
			false, false, "", // read_dna, read_xadc, read_register
			"" // user_flash
	};
	/* parse arguments */
	int ret = parse_opt(argc, argv, &args, &pins_config);
	if (ret != 0)
		return (ret == 1) ? EXIT_SUCCESS : EXIT_FAILURE;

	if (args.force_terminal_mode)
		ProgressBar::setForceTerminalMode();

	if (args.is_list_command) {
		displaySupported(args);
		return EXIT_SUCCESS;
	}

	if (args.prg_type == Device::WR_SRAM)
		std::cout << "write to ram" << std::endl;
	if (args.prg_type == Device::WR_FLASH)
		std::cout << "write to flash" << std::endl;

	if (args.board[0] != '-') {
		if (board_list.find(args.board) != board_list.end()) {
			board = &(board_list[args.board]);
		} else {
			printError("Error: cannot find board \'" +args.board + "\'");
			return EXIT_FAILURE;
		}
	}

	/* if a board name is specified try to use this to determine cable */
	if (board) {
		/* set pins config (only when user has not already provided
		 * configuration
		 */
		if (!args.pin_config) {
			pins_config.tdi_pin = board->jtag_pins_config.tdi_pin;
			pins_config.tdo_pin = board->jtag_pins_config.tdo_pin;
			pins_config.tms_pin = board->jtag_pins_config.tms_pin;
			pins_config.tck_pin = board->jtag_pins_config.tck_pin;
		}
		/* search for cable */
		auto t = cable_list.find(board->cable_name);
		if (t != cable_list.end()) {
			if (args.cable[0] == '-') {  // no user selection
				args.cable = (*t).first;  // use board default cable
			} else {
				std::cout << "Board default cable overridden with " << args.cable << std::endl;
			}
		}

		/* Xilinx only: to write flash exact fpga model must be provided */
		if (!board->fpga_part.empty() && !args.fpga_part.empty())
			printInfo("Board default fpga part overridden with " + args.fpga_part);
		else if (!board->fpga_part.empty() && args.fpga_part.empty())
			args.fpga_part = board->fpga_part;

		/* Some boards can override the default clock speed
		 * if args.freq == 0: the `--freq` arg has not been used
		 * => apply board->default_freq with a value of
		 * 0 (no default frequency) or > 0 (board has a default frequency)
		 */
		if (args.freq == 0)
			args.freq = board->default_freq;
		args.spi_flash_type = board->spi_bpi == SPI_FLASH;
	}

	if (args.cable[0] == '-') { /* if no board and no cable */
		printWarn("No cable or board specified: using direct ft2232 interface");
		args.cable = "ft2232";
	}

	/* if args.freq == 0: no user requirement nor board default
	 * clock speed => set default frequency
	 */
	if (args.freq == 0)
		args.freq = DEFAULT_FREQ;

	auto select_cable = cable_list.find(args.cable);
	if (select_cable == cable_list.end()) {
		printError("error : " + args.cable + " not found");
		return EXIT_FAILURE;
	}
	cable = select_cable->second;

#ifdef USE_LIBFTDI
	if (args.ftdi_channel != -1) {
		if (cable.type != MODE_FTDI_SERIAL && cable.type != MODE_FTDI_BITBANG){
			printError("Error: FTDI channel param is for FTDI cables.");
			return EXIT_FAILURE;
		}

		const int mapping[] = {INTERFACE_A, INTERFACE_B, INTERFACE_C,
			INTERFACE_D};
		cable.config.interface = mapping[args.ftdi_channel];
	}

	if (args.status_pin != -1) {
		if (cable.type != MODE_FTDI_SERIAL){
			printError("Error: FTDI status pin is for FTDI MPSSE cables.");
			return EXIT_FAILURE;
		}
	}
#endif

	if (!args.usb_serial_num.empty()) {
		if (cable.type != MODE_FTDI_SERIAL && cable.type != MODE_FTDI_BITBANG &&
			cable.type != MODE_ESP){
			printError("Error: usb-serial-num param is for FTDI and esp32s3 cables.");
			return EXIT_FAILURE;
		}
	}

	if (args.vid != 0) {
		printInfo("Cable VID overridden");
		cable.vid = args.vid;
	}
	if (args.pid != 0) {
		printInfo("Cable PID overridden");
		cable.pid = args.pid;
	}

	cable.bus_addr = args.bus_addr;
	cable.device_addr = args.device_addr;

	// always set these
	cable.config.index = args.cable_index;
	cable.config.status_pin = args.status_pin;

	/* ----------------------- */
	/* SPI FLASH direct access */
	/* ----------------------- */
	if (args.spi || (board && board->mode == COMM_SPI)) {
#ifdef USE_LIBFTDI
		return spi_comm(args, cable, &pins_config, board);
#else
		printError("SPI Flash Direct access: disabled at build time");
		return EXIT_FAILURE;
#endif
	}

	/* ------------------- */
	/* DFU access          */
	/* ------------------- */
	if (args.dfu || (board && board->mode == COMM_DFU)) {
#ifdef ENABLE_DFU
		/* try to init DFU probe */
		DFU *dfu = NULL;
		uint16_t vid = 0, pid = 0;
		int altsetting = -1;
		if (board) {
			vid = board->vid;
			pid = board->pid;
			altsetting = board->altsetting;
		}
		if (args.altsetting != -1) {
			if (altsetting != -1)
				printInfo("Board altsetting overridden");
			altsetting = args.altsetting;
		}

		if (args.vid != 0) {
			if (vid != 0)
				printInfo("Board VID overridden");
			vid = args.vid;
		}
		if (args.pid != 0) {
			if (pid != 0)
				printInfo("Board PID overridden");
			pid = args.pid;
		}

		try {
			dfu = new DFU(args.bit_file, args.detect, vid, pid, altsetting,
					args.verbose);
		} catch (std::exception &e) {
			printError("DFU init failed with: " + std::string(e.what()));
			return EXIT_FAILURE;
		}
		/* if verbose or detect: display device */
		if (args.verbose > 0 || args.detect)
			dfu->displayDFU();

		/* if detect: stop */
		if (args.detect)
			return EXIT_SUCCESS;

		try {
			dfu->download();
		} catch (std::exception &e) {
			printError("DFU download failed with: " + std::string(e.what()));
			return EXIT_FAILURE;
		}

		return EXIT_SUCCESS;
#else
		printError("DFU support: disabled at build time");
		return EXIT_FAILURE;
#endif
	}

#ifdef ENABLE_XVC_SERVER
	/* ------------------- */
	/*      XVC server     */
	/* ------------------- */
	if (args.xvc) {
		try {
			return run_xvc_server(args, cable, &pins_config);
		} catch (std::exception &e) {
			return EXIT_FAILURE;
		}
	}
#endif

	/* ------------------------------ */
	/* USB-Blaster passive serial mode */
	/* ------------------------------ */
	if (args.passive_serial) {
#ifdef ENABLE_USBBLASTER
		if (cable.type != MODE_USBBLASTER) {
			printError("Passive serial mode requires a USB-Blaster cable");
			return EXIT_FAILURE;
		}

		try {
			RawParser bit(args.bit_file, false);
			if (bit.parse() != EXIT_SUCCESS)
				throw std::runtime_error("Failed to parse raw RBF file");

			UsbBlaster blaster(cable, args.probe_firmware, args.verbose);
			blaster.programPassiveSerial(bit.getData(), bit.getLength() / 8);
		} catch (std::exception &e) {
			printError("Passive serial programming failed: " + std::string(e.what()));
			return EXIT_FAILURE;
		}

		printSuccess("Passive serial programming DONE");
		return EXIT_SUCCESS;
#else
		printError("USB-Blaster support was not enabled at compile time");
		return EXIT_FAILURE;
#endif
	}

	/* jtag base */


	/* if no instruction from user -> select load */
	if (args.prg_type == Device::PRG_NONE)
		args.prg_type = Device::WR_SRAM;

	Jtag *jtag;
	try {
		jtag = new Jtag(cable, &pins_config, args.device, args.usb_serial_num,
				args.freq, args.verbose, args.ip_adr, args.port,
				args.invert_read_edge, args.probe_firmware,
				args.user_misc_devs);
	} catch (std::exception &e) {
		printError("JTAG init failed with: " + std::string(e.what()));
		return EXIT_FAILURE;
	}

	/* chain detection */
	std::vector<uint32_t> listDev = jtag->get_devices_list();
	size_t found = listDev.size();
	int idcode = -1;
	size_t index = 0;

	if (args.verbose > 0)
		std::cout << "found " << std::to_string(found) << " devices" << std::endl;

	/* in verbose mode or when detect
	 * display full chain with details
	 */
	if (args.verbose > 0 || args.detect) {
		for (size_t i = 0; i < found; i++) {
			uint32_t t = listDev[i];
			printf("index %zu:\n", i);
			if (fpga_list.find(t) != fpga_list.end()) {
				printf("\tidcode 0x%x\n\tmanufacturer %s\n\tfamily %s\n\tmodel  %s\n",
				t,
				fpga_list[t].manufacturer.c_str(),
				fpga_list[t].family.c_str(),
				fpga_list[t].model.c_str());
				printf("\tirlength %d\n", fpga_list[t].irlength);
			} else if (misc_dev_list.find(t) != misc_dev_list.end()) {
				printf("\tidcode   0x%x\n\ttype     %s\n\tirlength %d\n",
				t,
				misc_dev_list[t].name.c_str(),
				misc_dev_list[t].irlength);
			} else if (args.user_misc_devs.find(t) != args.user_misc_devs.end()) {
				printf("\tidcode   0x%x\n\ttype     %s\n\tirlength %d\n",
				t,
				args.user_misc_devs[t].name.c_str(),
				args.user_misc_devs[t].irlength);
			}
		}
		if (args.detect == true) {
			delete jtag;
			return EXIT_SUCCESS;
		}
	}

	if (found != 0) {
		if (args.index_chain < 0) {
			for (size_t i = 0; i < found; i++) {
				if (fpga_list.find(listDev[i]) != fpga_list.end()) {
					index = i;
					if (idcode != -1) {
						printError("Error: more than one FPGA found");
						printError("Use --index-chain to force selection");
						for (size_t i = 0; i < found; i++)
							printf("0x%08x\n", listDev[i]);
						delete(jtag);
						return EXIT_FAILURE;
					} else {
						idcode = listDev[i];
					}
				}
			}
		} else {
			index = args.index_chain;
			if (index > found) {
				printError("wrong index for device in JTAG chain");
				delete(jtag);
				return EXIT_FAILURE;
			}
			idcode = listDev[index];
		}
	} else {
		printError("Error: no device found");
		delete(jtag);
		return EXIT_FAILURE;
	}

	jtag->device_select(index);

	/* detect svf file and program the device */
	if (!args.file_type.compare("svf") ||
			args.bit_file.find(".svf") != std::string::npos) {
#ifdef ENABLE_SVF_JTAG
		SVF_jtag *svf = new SVF_jtag(jtag, args.verbose);
		try {
			svf->parse(args.bit_file);
		} catch (std::exception &e) {
			return EXIT_FAILURE;
		}
		return EXIT_SUCCESS;
#else
		printError("Support for SVF Jtag was not enabled at compile time");
		delete(jtag);
		return EXIT_FAILURE;
#endif
	}

	/* check if selected device is supported
	 * mainly used in conjunction with --index-chain
	 */
	if (fpga_list.find(idcode) == fpga_list.end()) {
		std::cerr << "Error: device " << std::hex << idcode << " not supported" << std::endl;
		delete(jtag);
		return EXIT_FAILURE;
	}

	std::string fab = fpga_list[idcode].manufacturer;


	Device *fpga;
	try {
		if (fab == "xilinx") {
#ifdef ENABLE_XILINX_SUPPORT
			fpga = new Xilinx(jtag, args.bit_file, args.secondary_bit_file,
				args.file_type, args.prg_type, args.fpga_part, args.spi_flash_type, args.bridge_path,
				args.target_flash, args.verify, args.verbose, args.skip_load_bridge, args.skip_reset,
				args.read_dna, args.read_xadc);
#else
			printError("Support for Xilinx FPGAs was not enabled at compile time");
			delete(jtag);
			return EXIT_FAILURE;
#endif
		} else if (fab == "altera") {
#ifdef ENABLE_ALTERA_SUPPORT
			fpga = new Altera(jtag, args.bit_file, args.file_type,
				args.prg_type, args.fpga_part, args.bridge_path, args.verify,
				args.verbose, args.flash_sector, args.skip_load_bridge, args.skip_reset);
#else
			printError("Support for Altera FPGAs was not enabled at compile time");
			delete(jtag);
			return EXIT_FAILURE;
#endif
		} else if (fab == "anlogic") {
#ifdef ENABLE_ANLOGIC_SUPPORT
			fpga = new Anlogic(jtag, args.bit_file, args.file_type,
				args.prg_type, args.verify, args.verbose);
#else
			printError("Support for Anlogic FPGAs was not enabled at compile time");
			delete(jtag);
			return EXIT_FAILURE;
#endif
		} else if (fab == "efinix") {
#ifdef ENABLE_EFINIX_SUPPORT
			fpga = new Efinix(jtag, args.bit_file, args.file_type,
				args.prg_type, args.board, args.fpga_part, args.bridge_path,
				args.verify, args.verbose);
#else
			printError("Support for Efinix FPGAs was not enabled at compile time");
			delete(jtag);
			return EXIT_FAILURE;
#endif
		} else if (fab == "Gowin") {
#ifdef ENABLE_GOWIN_SUPPORT
			fpga = new Gowin(jtag, args.bit_file, args.file_type, args.mcufw,
				args.prg_type, args.external_flash, args.verify, args.verbose, args.user_flash);
#else
			printError("Support for Gowin FPGAs was not enabled at compile time");
			delete(jtag);
			return EXIT_FAILURE;
#endif
		} else if (fab == "lattice") {
#ifdef ENABLE_LATTICE_SUPPORT
			fpga = new Lattice(jtag, args.bit_file, args.file_type,
				args.prg_type, args.flash_sector, args.verify, args.verbose, args.skip_load_bridge, args.skip_reset);
#else
			printError("Support for Lattice FPGAs was not enabled at compile time");
			delete(jtag);
			return EXIT_FAILURE;
#endif
		} else if (fab == "colognechip") {
#ifdef ENABLE_COLOGNECHIP_SUPPORT
			fpga = new CologneChip(jtag, args.bit_file, args.file_type,
				args.prg_type, args.board, args.cable, args.verify, args.verbose);
#else
			printError("Support for Cologne Chip FPGAs was not enabled at compile time");
			delete(jtag);
			return EXIT_FAILURE;
#endif
		} else {
			printError("Error: manufacturer " + fab + " not supported");
			delete(jtag);
			return EXIT_FAILURE;
		}
	} catch (std::exception &e) {
		printError("Error: Failed to claim FPGA device: " + std::string(e.what()));
		delete(jtag);
		return EXIT_FAILURE;
	}

	if ((!args.bit_file.empty() ||
		 !args.secondary_bit_file.empty() ||
		 !args.file_type.empty() || !args.mcufw.empty())
			&& args.prg_type != Device::RD_FLASH) {
		try {
			fpga->program(args.offset, args.unprotect_flash);
		} catch (std::exception &e) {
			printError("Error: Failed to program FPGA: " + std::string(e.what()));
			delete(fpga);
			delete(jtag);
			return EXIT_FAILURE;
		}
	}

	if (args.conmcu == true) {
		fpga->connectJtagToMCU();
	}

	/* read internal register */
	if (!args.read_register.empty()) {
		fpga->read_register(args.read_register);
	}

	/* unprotect SPI flash */
	if (args.unprotect_flash && args.bit_file.empty()) {
		fpga->unprotect_flash();
	}

	/* bulk erase SPI flash */
	if (args.bulk_erase_flash && args.bit_file.empty()) {
		fpga->bulk_erase_flash();
	}

	/* protect SPI flash */
	if (args.protect_flash != 0) {
		fpga->protect_flash(args.protect_flash);
	}

	/* Enable/disable SPI Flash quad mode */
	if (args.enable_quad || args.disable_quad) {
		bool ret = true;
		if (args.enable_quad && args.disable_quad) {
			printError("Error: can't set enable and disable Quad mode at same time");
			ret = false;
		} else  if (!fpga->set_quad_bit(args.enable_quad)) {
			printError("Error: Failed to enable/disable Quad mode");
			ret = false;
		}

		if (!ret) {
			delete(fpga);
			delete(jtag);
			return EXIT_FAILURE;
		}
	}

	/* detect/display flash */
	if (args.detect_flash != 0) {
		fpga->detect_flash();
	}

	if (args.prg_type == Device::RD_FLASH) {
		if (args.file_size == 0) {
			printError("Error: 0 size for dump");
		} else {
			fpga->dumpFlash(args.offset, args.file_size);
		}
	}

	if (args.reset)
		fpga->reset();

	delete(fpga);
	delete(jtag);
}

#ifdef ENABLE_XVC_SERVER
int run_xvc_server(const struct arguments &args, const cable_t &cable,
	const jtag_pins_conf_t *pins_config)
{
	// create XVC instance
	try {
		XVC_server *xvc = NULL;
		xvc = new XVC_server(args.port, cable, pins_config, args.device,
				args.usb_serial_num, args.freq, args.verbose, args.ip_adr,
				args.invert_read_edge, args.probe_firmware);
		/* create connection */
		xvc->open_connection();
		/* start loop */
		xvc->listen_loop();
		/* close connection */
		xvc->close_connection();
		delete xvc;
	} catch (std::exception &e) {
		printError("XVC_server failed with " + std::string(e.what()));
		return EXIT_FAILURE;
	}
	printInfo("Xilinx Virtual Cable Stopped! ");
	return EXIT_SUCCESS;
}
#endif

#ifdef USE_LIBFTDI
int spi_comm(struct arguments args, const cable_t &cable,
	const jtag_pins_conf_t *pins_config, target_board_t *board)
{
	/* if no instruction from user -> select flash mode */
	if (args.prg_type == Device::PRG_NONE)
		args.prg_type = Device::WR_FLASH;

	FtdiSpi *spi = NULL;
	spi_pins_conf_t spi_pins_config;
	if (board && !args.pin_config)
		spi_pins_config = board->spi_pins_config;
	if (args.pin_config) {
		printInfo("Board default pins configuration overridden");
		spi_pins_config.cs_pin = (1 << pins_config->tms_pin);
		spi_pins_config.sck_pin = (1 << pins_config->tck_pin);
		spi_pins_config.mosi_pin = (1 << pins_config->tdi_pin);
		spi_pins_config.miso_pin = (1 << pins_config->tdo_pin);
		spi_pins_config.holdn_pin = (1 << pins_config->ext0_pin);
		spi_pins_config.wpn_pin = (1 << pins_config->ext1_pin);
	}

	try {
		spi = new FtdiSpi(cable, spi_pins_config, args.freq, args.verbose);
	} catch (std::exception &e) {
		printError("Error: Failed to claim cable");
		return EXIT_FAILURE;
	}

	int spi_ret = EXIT_SUCCESS;

	if (board && board->manufacturer != "none") {
		Device *target;
		if (board->manufacturer == "efinix") {
#ifdef ENABLE_EFINIX_SUPPORT
			target = new Efinix(spi, args.bit_file, args.file_type,
				board->reset_pin, board->done_pin, board->oe_pin,
				args.verify, args.verbose);
#else
			printError("Support for Efinix FPGAs was not enabled at compile time");
			return EXIT_FAILURE;
#endif
		} else if (board->manufacturer == "lattice") {
			if (board->fpga_part == "ice40") {
#ifdef ENABLE_ICE40_SUPPORT
				target = new Ice40(spi, args.bit_file, args.file_type,
					args.prg_type,
					board->reset_pin, board->done_pin, args.verify, args.verbose);
#else
				printError("Support for ICE40 FPGAs was not enabled at compile time");
				return EXIT_FAILURE;
#endif
			} else if (board->fpga_part == "ecp5") {
#ifdef ENABLE_LATTICESSPI_SUPPORT
				target = new LatticeSSPI(spi, args.bit_file, args.file_type, args.verbose);
#else
				printError("Support for Lattice FPGAs (SSPI mode) was not enabled at compile time");
				return EXIT_FAILURE;
#endif
			} else {
				printError("Error (SPI mode): " + board->fpga_part +
					" is an unsupported/unknown Lattice Model");
				return EXIT_FAILURE;
			}
		} else if (board->manufacturer == "colognechip") {
#ifdef ENABLE_COLOGNECHIP_SUPPORT
			target = new CologneChip(spi, args.bit_file, args.file_type, args.prg_type,
				board->reset_pin, board->done_pin, DBUS6, board->oe_pin,
				args.verify, args.verbose);
#else
			printError("Support for Cologne Chip FPGAs was not enabled at compile time");
			return EXIT_FAILURE;
#endif
		} else {
			printError("Error (SPI mode): " + board->manufacturer +
				" is an unsupported/unknown target");
			return EXIT_FAILURE;
		}
		if (args.prg_type == Device::RD_FLASH) {
			if (args.file_size == 0) {
				printError("Error: 0 size for dump");
			} else {
				target->dumpFlash(args.offset, args.file_size);
			}
		} else if ((args.prg_type == Device::WR_FLASH ||
					args.prg_type == Device::WR_SRAM) ||
					!args.bit_file.empty() || !args.file_type.empty()) {
			if (args.detect_flash)
				target->detect_flash();
			else
				target->program(args.offset, args.unprotect_flash);
		}
		if (args.unprotect_flash && args.bit_file.empty())
			if (!target->unprotect_flash())
				spi_ret = EXIT_FAILURE;
		if (args.bulk_erase_flash && args.bit_file.empty())
			if (!target->bulk_erase_flash())
				spi_ret = EXIT_FAILURE;
		if (args.protect_flash)
			if (!target->protect_flash(args.protect_flash))
				spi_ret = EXIT_FAILURE;
	} else {
		RawParser *bit = NULL;
		if (board && board->reset_pin) {
			spi->gpio_set_output(board->reset_pin, true);
			spi->gpio_clear(board->reset_pin, true);
		}

		SPIFlash flash((FlashInterface *)spi, args.unprotect_flash, args.verbose);
		flash.display_status_reg();

		if (args.prg_type != Device::RD_FLASH &&
				(!args.bit_file.empty() || !args.file_type.empty())) {
			printInfo("Open file " + args.bit_file + " ", false);
			try {
				bit = new RawParser(args.bit_file, false);
				printSuccess("DONE");
			} catch (std::exception &e) {
				printError("FAIL: unable to open '" + args.bit_file + "': " + std::string(e.what()));
				delete spi;
				return EXIT_FAILURE;
			}

			printInfo("Parse file ", false);
			if (bit->parse() == EXIT_FAILURE) {
				printError("FAIL: unable to parse '" + args.bit_file + "'");
				delete bit;
				delete spi;
				return EXIT_FAILURE;
			} else {
				printSuccess("DONE");
			}

			try {
				flash.erase_and_prog(args.offset, bit->getData(), bit->getLength()/8);
			} catch (std::exception &e) {
				printError("FAIL: " + std::string(e.what()));
			}

			if (args.verify)
				flash.verify(args.offset, bit->getData(), bit->getLength() / 8);

			delete bit;
		} else if (args.prg_type == Device::RD_FLASH) {
			if (args.file_size == 0)
				printError("Error: 0 size for dump");
			else
				flash.dump(args.bit_file, args.offset, args.file_size);
		}

		if (args.unprotect_flash && args.bit_file.empty())
			if (!flash.disable_protection())
				spi_ret = EXIT_FAILURE;
		if (args.bulk_erase_flash && args.bit_file.empty())
			if (!flash.bulk_erase())
				spi_ret = EXIT_FAILURE;
		if (args.protect_flash)
			if (!flash.enable_protection(args.protect_flash))
				spi_ret = EXIT_FAILURE;

		if (board && board->reset_pin)
			spi->gpio_set(board->reset_pin, true);
	}

	delete spi;

	return spi_ret;
}
#endif

// parse double from string in engineering notation
// can deal with postfixes k and m, add more when required
static int parse_eng(std::string arg, double *dst) {
	try {
		size_t end;
		double base = stod(arg, &end);
		if (end == arg.size()) {
			*dst = base;
			return 0;
		} else if (end == (arg.size() - 1)) {
			switch (arg.back()) {
			case 'k': case 'K':
				*dst = (uint32_t)(1e3 * base);
				return 0;
			case 'm': case 'M':
				*dst = (uint32_t)(1e6 * base);
				return 0;
			default:
				return EINVAL;
			}
		} else {
			return EINVAL;
		}
	} catch (...) {
		std::cerr << "error : speed: invalid format" << std::endl;
		return EINVAL;
	}
}

/* arguments parser */
int parse_opt(int argc, char **argv, struct arguments *args,
	jtag_pins_conf_t *pins_config)
{
	std::string freqo;
	std::string ftdi_serial;
	std::vector<std::string> pins, bus_dev_num;
	bool verbose = false, quiet = false;
	int8_t verbose_level = -2;
	try {
		cxxopts::Options options(argv[0], "openFPGALoader -- a program to flash FPGA",
			"<gwenhael.goavec-merou@trabucayre.com>");
		options
			.positional_help("BIT_FILE")
			.show_positional_help();

		options
			.add_options()
			("altsetting", "DFU interface altsetting (only for DFU mode)",
				cxxopts::value<int16_t>(args->altsetting))
			("bitstream", "bitstream",
				cxxopts::value<std::string>(args->bit_file))
			("secondary-bitstream", "secondary bitstream (some Xilinx"
				" UltraScale boards)",
				cxxopts::value<std::string>(args->secondary_bit_file))
			("b,board",     "board name, may be used instead of cable",
				cxxopts::value<std::string>(args->board))
			("B,bridge",    "disable spiOverJtag model detection by providing "
				"bitstream(intel/xilinx)",
				cxxopts::value<std::string>(args->bridge_path))
			("c,cable", "jtag interface", cxxopts::value<std::string>(args->cable))
			("status-pin",
				"JTAG mode / FTDI: GPIO pin number to use as a status indicator (active low)",
				cxxopts::value<int>(args->status_pin))
			("invert-read-edge",
				"JTAG mode / FTDI: read on negative edge instead of positive",
				cxxopts::value<bool>(args->invert_read_edge))
			("vid", "probe Vendor ID", cxxopts::value<uint16_t>(args->vid))
			("pid", "probe Product ID", cxxopts::value<uint16_t>(args->pid))
			("cable-index", "probe index (FTDI and cmsisDAP)",
				cxxopts::value<int16_t>(args->cable_index))
			("busdev-num",
				"select a probe by it bus and device number (bus_num:device_addr)",
				cxxopts::value<std::vector<std::string>>(bus_dev_num))
			("usb-serial-num", "USB iSerial (FTDI chip serial number or ESP32 iSerialNumber substring)",
				cxxopts::value<std::string>(args->usb_serial_num))
			("ftdi-serial", "FTDI chip serial number (Deprecated)",
				cxxopts::value<std::string>(ftdi_serial))
			("ftdi-channel",
				"FTDI chip channel number (channels 0-3 map to A-D)",
				cxxopts::value<int>(args->ftdi_channel))
			("d,device",  "device to use (/dev/ttyUSBx)",
				cxxopts::value<std::string>(args->device))
			("detect",      "detect FPGA, add -f to show connected flash",
				cxxopts::value<bool>(args->detect))
			("dfu",   "DFU mode", cxxopts::value<bool>(args->dfu))
			("passive-serial", "USB-Blaster passive serial mode",
				cxxopts::value<bool>(args->passive_serial))
			("dump-flash",  "Dump flash mode")
			("bulk-erase",   "Bulk erase flash",
				cxxopts::value<bool>(args->bulk_erase_flash))
			("enable-quad",   "Enable quad mode for SPI Flash",
				cxxopts::value<bool>(args->enable_quad))
			("disable-quad",   "Disable quad mode for SPI Flash",
				cxxopts::value<bool>(args->disable_quad))
			("target-flash",
				"for boards with multiple flash chips (some Xilinx UltraScale"
				" boards), select the target flash: primary (default), secondary or both",
				cxxopts::value<std::string>(args->target_flash))
			("external-flash",
				"select ext flash for device with internal and external storage",
				cxxopts::value<bool>(args->external_flash))
			("file-size",
				"provides size in Byte to dump, must be used with dump-flash",
				cxxopts::value<unsigned int>(args->file_size))
			("file-type",
				"provides file type instead of let's deduced by using extension",
				cxxopts::value<std::string>(args->file_type))
			("flash-sector", "flash sector (Lattice and Altera MAX10 parts only)",
				cxxopts::value<std::string>(args->flash_sector))
			("fpga-part",   "fpga model flavor + package",
				cxxopts::value<std::string>(args->fpga_part))
			("freq",        "jtag frequency (Hz)", cxxopts::value<std::string>(freqo))
			("f,write-flash",
				"write bitstream in flash (default: false)")
			("index-chain",  "device index in JTAG-chain",
				cxxopts::value<int>(args->index_chain))
			("misc-device",  "add JTAG non-FPGA devices <idcode,irlen,name>",
				cxxopts::value<std::vector<std::string>>())
			("ip", "IP address (XVC and remote bitbang client)",
				cxxopts::value<std::string>(args->ip_adr))
			("list-boards", "list all supported boards",
				cxxopts::value<bool>(args->list_boards))
			("list-cables", "list all supported cables",
				cxxopts::value<bool>(args->list_cables))
			("list-fpga", "list all supported FPGA",
				cxxopts::value<bool>(args->list_fpga))
			("m,write-sram",
				"write bitstream in SRAM (default: true)")
			("o,offset", "Start address (in bytes) for read/write into non volatile memory (default: 0)",
				cxxopts::value<unsigned int>(args->offset))
			("pins", "pin config TDI:TDO:TCK:TMS or MOSI:MISO:SCK:CS[:HOLDN:WPN]",
				cxxopts::value<std::vector<std::string>>(pins))
			("probe-firmware", "firmware for JTAG probe (usbBlasterII/xilinxPlatformCableUsb)",
				cxxopts::value<std::string>(args->probe_firmware))
			("protect-flash",   "protect SPI flash area",
				cxxopts::value<uint32_t>(args->protect_flash))
			("quiet", "Produce quiet output (no progress bar)",
				cxxopts::value<bool>(quiet))
			("r,reset",   "reset FPGA after operations",
				cxxopts::value<bool>(args->reset))
			("scan-usb",  "scan USB to display connected probes",
				cxxopts::value<bool>(args->scan_usb))
			("skip-load-bridge", "skip writing bridge to SRAM when in write-flash mode",
				cxxopts::value<bool>(args->skip_load_bridge))
			("skip-reset", "skip resetting the device when in write-flash mode",
				cxxopts::value<bool>(args->skip_reset))
			("spi",   "SPI mode (only for FTDI in serial mode)",
				cxxopts::value<bool>(args->spi))
			("unprotect-flash",   "Unprotect flash blocks",
				cxxopts::value<bool>(args->unprotect_flash))
			("v,verbose", "Produce verbose output", cxxopts::value<bool>(verbose))
			("verbose-level", "verbose level -1: quiet, 0: normal, 1:verbose, 2:debug",
				cxxopts::value<int8_t>(verbose_level))
			("force-terminal-mode",
				"force progress bar output as if connected to a terminal",
				cxxopts::value<bool>(args->force_terminal_mode))
			("h,help", "Give this help list")
			("verify", "Verify write operation (SPI Flash only)",
				cxxopts::value<bool>(args->verify))
#ifdef ENABLE_XVC_SERVER
			("xvc",   "Xilinx Virtual Cable Functions",
				cxxopts::value<bool>(args->xvc))
#endif
			("port", "Xilinx Virtual Cable and remote bitbang Port (default 3721)",
				cxxopts::value<int>(args->port))
			("mcufw", "Microcontroller firmware",
				cxxopts::value<std::string>(args->mcufw))
			("conmcu", "Connect JTAG to MCU",
				cxxopts::value<bool>(args->conmcu))
			("D,read-dna", "Read DNA (Xilinx FPGA only)",
				cxxopts::value<bool>(args->read_dna))
			("X,read-xadc", "Read XADC (Xilinx FPGA only)",
				cxxopts::value<bool>(args->read_xadc))
			("read-register", "Read Status Register(Xilinx FPGA only)",
				cxxopts::value<std::string>(args->read_register))
			("user-flash", "User flash file (Gowin LittleBee FPGA only)",
				cxxopts::value<std::string>(args->user_flash))
			("V,version", "Print program version")
			("Version", "Print program version (Deprecated)");

		options.parse_positional({"bitstream"});
		auto result = options.parse(argc, argv);

		if (result.count("help")) {
			std::cout << options.help() << std::endl;
			return 1;
		}

		if (verbose && quiet) {
			printError("Error: can't select quiet and verbose mode in same time");
			return -1;
		}
		if (verbose)
			args->verbose = 1;
		if (quiet)
			args->verbose = -1;
		if (verbose_level != -2) {
			if ((verbose && verbose_level != 1) ||
					(quiet && verbose_level != -1)) {
				printError("Error: mismatch quiet/verbose and verbose-level\n");
				return -1;
			}

			args->verbose = verbose_level;
		}

		if (result.count("Version") || result.count("version")) {
			std::cout << "openFPGALoader " << VERSION << std::endl;
			return 1;
		}

		if (result.count("misc-device")) {
			auto misc_devices = result["misc-device"].as<std::vector<std::string>>();
			for (auto &dev : misc_devices) {
				uint32_t idcode;
				int irlen;
				std::string name;
				std::stringstream ss(dev);
				std::string item;
				std::vector<std::string> tokens;

				while (std::getline(ss, item, ',')) {
					tokens.push_back(item);
				}

				if (tokens.size() != 3) {
					printError("Error: invalid format for misc-device.");
					return -1;
				}

				try {
					idcode = std::stoul(tokens[0], nullptr, 16);
					irlen = std::stoi(tokens[1]);
				} catch (const std::exception &) {
					printError("Error: invalid numeric format for misc-device, expected <hex_idcode,irlen,name>");
					return -1;
				}
				name = tokens[2];
				args->user_misc_devs[idcode] = {name, irlen};
			}
		}

		if (result.count("write-flash") + result.count("write-sram") +
				result.count("dump-flash") > 1) {
			printError("Error: --write-flash, --write-sram and --dump-flash are mutually exclusive");
			return -1;
		}

		if (result.count("write-flash"))
			args->prg_type = Device::WR_FLASH;
		else if (result.count("write-sram"))
			args->prg_type = Device::WR_SRAM;
		else if (result.count("dump-flash"))
			args->prg_type = Device::RD_FLASH;
		else if (result.count("external-flash"))
			args->prg_type = Device::WR_FLASH;

		if (args->passive_serial) {
			if (args->spi || args->dfu || args->xvc || args->detect) {
				printError("Error: --passive-serial cannot be combined with "
					"--spi, --dfu, --xvc or --detect");
				return -1;
			}
		}

		if (result.count("freq")) {
			double freq;
			if (parse_eng(freqo, &freq)) {
				printError("Error: invalid format for --freq");
				return -1;
			}
			if (freq < 1) {
				printError("Error: --freq must be positive");
				return -1;
			}
			args->freq = static_cast<uint32_t>(freq);
		}

		if (result.count("status-pin")) {
			if (args->status_pin < 4 || args->status_pin > 15) {
				printError("Error: valid status pin numbers are 4-15.");
				return -1;
			}
		}

		if (result.count("ftdi-channel")) {
			if (args->ftdi_channel < 0 || args->ftdi_channel > 3) {
				printError("Error: valid FTDI channels are 0-3.");
				return -1;
			}
		}

		if (result.count("ftdi-serial")) {
			if (result.count("usb-serial-num")) {
				printError("Error: ftdi-serial and usb-serial-num can't be used at the same time.");
				return -1;
			}
			args->usb_serial_num = ftdi_serial;
		}

		if (result.count("busdev-num")) {
			if (bus_dev_num.size() != 2) {
				printError("Error: busdev-num must be xx:yy");
				return -1;
			}
			try {
				args->bus_addr = static_cast<uint8_t>(std::stoi(bus_dev_num[0],
					nullptr, 10));
				args->device_addr = static_cast<uint8_t>(
					std::stoi(bus_dev_num[1], nullptr, 10));
			} catch (std::exception &e) {
				printError("Error: busdev-num invalid format: must be numeric values");
				return -1;
			}
		}

		if (result.count("pins")) {
			if (pins.size() < 4 || pins.size() > 6) {
				printError("Error: pin_config need 4 pins in JTAG mode or 6 pins in SPI Mode");
				return -1;
			}

			static std::map <std::string, int> pins_list = {
				{"TXD", FT232RL_TXD},
				{"RXD", FT232RL_RXD},
				{"RTS", FT232RL_RTS},
				{"CTS", FT232RL_CTS},
				{"DTR", FT232RL_DTR},
				{"DSR", FT232RL_DSR},
				{"DCD", FT232RL_DCD},
				{"RI" , FT232RL_RI}};

			uint8_t *pin_fields[] = {
				&pins_config->tdi_pin,
				&pins_config->tdo_pin,
				&pins_config->tck_pin,
				&pins_config->tms_pin,
				&pins_config->ext0_pin,
				&pins_config->ext1_pin
			};

			for (size_t i = 0; i < pins.size(); i++) {
				int pin_num;
				try {
					pin_num = std::stoi(pins[i], nullptr, 0);
				} catch (std::exception &e) {
					if (pins_list.find(pins[i]) == pins_list.end()) {
						printError("Invalid pin name");
						return -1;
					}
					pin_num = pins_list[pins[i]];
				}

				*pin_fields[i] = pin_num;
			}
			args->pin_config = true;
		}

		if (args->target_flash == "both" || args->target_flash == "secondary") {
			if ((args->prg_type == Device::WR_FLASH || args->prg_type == Device::RD_FLASH) &&
				 args->secondary_bit_file.empty() &&
				 !args->protect_flash &&
				 !args->unprotect_flash &&
				 !args->bulk_erase_flash &&
				 !args->detect
				) {
				printError("Error: secondary bitfile not specified");
				std::cout << options.help() << std::endl;
				return -1;
			}
		}

		if (args->list_cables || args->list_boards || args->list_fpga ||
			args->scan_usb)
			args->is_list_command = true;

		if (args->bit_file.empty() &&
			args->secondary_bit_file.empty() &&
			args->file_type.empty() &&
			args->mcufw.empty() &&
			!args->is_list_command &&
			!args->detect &&
			!args->protect_flash &&
			!args->unprotect_flash &&
			!args->enable_quad &&
			!args->disable_quad &&
			!args->bulk_erase_flash &&
			!args->xvc &&
			!args->reset &&
			!args->conmcu &&
			!args->read_dna &&
			!args->read_xadc &&
			args->read_register.empty()) {
			printError("Error: bitfile not specified");
			std::cout << options.help() << std::endl;
			return -1;
		}

		// user ask detect with flash set
		// detect/display flash CHIP informations instead
		// of FPGA details
		if (args->detect && args->prg_type == Device::WR_FLASH) {
			args->detect = false;
			args->detect_flash = true;
		}
	} catch (const cxxopts::OptionException& e) {
		printError("Error parsing options: " + std::string(e.what()));
		return -1;
	}

	return 0;
}

/* display list of cables, boards and devices supported */
void displaySupported(const struct arguments &args)
{
	if (args.list_cables == true) {
		std::stringstream t;
		t << std::setw(25) << std::left << "cable name" << "vid:pid";
		printSuccess(t.str());
		for (auto b = cable_list.begin(); b != cable_list.end(); b++) {
			cable_t c = (*b).second;
			std::stringstream ss;
			ss << std::setw(25) << std::left << (*b).first;
			ss << "0x" << std::hex << std::right << std::setw(4) << std::setfill('0') << c.vid
				<< ":" << std::setw(4) << c.pid;
			printInfo(ss.str());
		}
		std::cout << std::endl;
	}

	if (args.list_boards) {
		std::stringstream t;
		t << std::setw(27) << std::left << "board name" << std::setw(19) << "cable_name";
		t << std::setw(25) << "fpga_part";
		printSuccess(t.str());
		for (auto b = board_list.begin(); b != board_list.end(); b++) {
			std::stringstream ss;
			target_board_t c = (*b).second;
			std::string cable_name = c.cable_name;
			std::string fpga_part = c.fpga_part;
			if (cable_name.size() == 0)
				cable_name = "Undefined";
			if (fpga_part.size() == 0)
				fpga_part = "Undefined";
			ss << std::setw(27) << std::left << (*b).first << std::setw(19) << cable_name;
			ss << std::setw(25)<< fpga_part;
			printInfo(ss.str());
		}
		std::cout << std::endl;
	}

	if (args.list_fpga) {
		std::stringstream t;
		t << std::setw(12) << std::left << "IDCode" << std::setw(14) << "manufacturer";
		t << std::setw(16) << "family" << std::setw(20) << "model";
		printSuccess(t.str());
		for (auto b = fpga_list.begin(); b != fpga_list.end(); b++) {
			fpga_model fpga = (*b).second;
			std::stringstream ss, idCode;
			idCode << "0x" << std::hex << std::setw(8) << std::setfill('0') << (*b).first;
			ss << std::setw(12) << std::left << idCode.str();
			ss << std::setw(14) << fpga.manufacturer << std::setw(16) << fpga.family;
			ss << std::setw(20) << fpga.model;
			printInfo(ss.str());
		}
		std::cout << std::endl;
	}

#ifdef ENABLE_USB_SCAN
	if (args.scan_usb) {
		libusb_ll usb(0, 0, args.verbose);
		usb.scan();
	}
#endif
}