.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH OPENFPGALOADER "1" "March 2025" "openFPGALoader v0.13.1" "User Commands"
.SH NAME
openFPGALoader \- manual page for openFPGALoader v0.13.1
.SH SYNOPSIS
.B openFPGALoader
[\fI\,OPTION\/\fR...] \fI\,BIT_FILE\/\fR
.SH DESCRIPTION
openFPGALoader \fB\-\-\fR a program to flash FPGA
.TP
\fB\-\-altsetting\fR arg
DFU interface altsetting (only for DFU mode)
.TP
\fB\-\-bitstream\fR arg
bitstream
.TP
\fB\-\-secondary\-bitstream\fR arg
secondary bitstream (some Xilinx UltraScale
boards)
.TP
\fB\-b\fR, \fB\-\-board\fR arg
board name, may be used instead of cable
.TP
\fB\-B\fR, \fB\-\-bridge\fR arg
disable spiOverJtag model detection by
providing bitstream(intel/xilinx)
.TP
\fB\-c\fR, \fB\-\-cable\fR arg
jtag interface
.TP
\fB\-\-status\-pin\fR arg
JTAG mode / FTDI: GPIO pin number to use as a
status indicator (active low)
.TP
\fB\-\-invert\-read\-edge\fR
JTAG mode / FTDI: read on negative edge
instead of positive
.TP
\fB\-\-vid\fR arg
probe Vendor ID
.TP
\fB\-\-pid\fR arg
probe Product ID
.TP
\fB\-\-cable\-index\fR arg
probe index (FTDI and cmsisDAP)
.TP
\fB\-\-busdev\-num\fR arg
select a probe by it bus and device number
(bus_num:device_addr)
.TP
\fB\-\-ftdi\-serial\fR arg
FTDI chip serial number
.TP
\fB\-\-ftdi\-channel\fR arg
FTDI chip channel number (channels 0\-3 map to
A\-D)
.TP
\fB\-d\fR, \fB\-\-device\fR arg
device to use (\fI\,/dev/ttyUSBx\/\fP)
.TP
\fB\-\-detect\fR
detect FPGA, add \fB\-f\fR to show connected flash
.TP
\fB\-\-dfu\fR
DFU mode
.TP
\fB\-\-dump\-flash\fR
Dump flash mode
.TP
\fB\-\-bulk\-erase\fR
Bulk erase flash
.TP
\fB\-\-enable\-quad\fR
Enable quad mode for SPI Flash
.TP
\fB\-\-disable\-quad\fR
Disable quad mode for SPI Flash
.TP
\fB\-\-target\-flash\fR arg
for boards with multiple flash chips (some
Xilinx UltraScale boards), select the target
flash: primary (default), secondary or both
.TP
\fB\-\-external\-flash\fR
select ext flash for device with internal and
external storage
.TP
\fB\-\-file\-size\fR arg
provides size in Byte to dump, must be used
with dump\-flash
.TP
\fB\-\-file\-type\fR arg
provides file type instead of let's deduced
by using extension
.TP
\fB\-\-flash\-sector\fR arg
flash sector (Lattice parts only)
.TP
\fB\-\-fpga\-part\fR arg
fpga model flavor + package
.TP
\fB\-\-freq\fR arg
jtag frequency (Hz)
.TP
\fB\-f\fR, \fB\-\-write\-flash\fR
write bitstream in flash (default: false)
.TP
\fB\-\-index\-chain\fR arg
device index in JTAG\-chain
.TP
\fB\-\-misc\-device\fR arg
add JTAG non\-FPGA devices <idcode,irlen,name>
.TP
\fB\-\-ip\fR arg
IP address (XVC and remote bitbang client)
.TP
\fB\-\-list\-boards\fR
list all supported boards
.TP
\fB\-\-list\-cables\fR
list all supported cables
.TP
\fB\-\-list\-fpga\fR
list all supported FPGA
.TP
\fB\-m\fR, \fB\-\-write\-sram\fR
write bitstream in SRAM (default: true)
.TP
\fB\-o\fR, \fB\-\-offset\fR arg
Start address (in bytes) for read/write into
non volatile memory (default: 0)
.TP
\fB\-\-pins\fR arg
pin config TDI:TDO:TCK:TMS
.TP
\fB\-\-probe\-firmware\fR arg
firmware for JTAG probe (usbBlasterII)
.TP
\fB\-\-protect\-flash\fR arg
protect SPI flash area
.TP
\fB\-\-quiet\fR
Produce quiet output (no progress bar)
.TP
\fB\-r\fR, \fB\-\-reset\fR
reset FPGA after operations
.TP
\fB\-\-scan\-usb\fR
scan USB to display connected probes
.TP
\fB\-\-skip\-load\-bridge\fR
skip writing bridge to SRAM when in
write\-flash mode
.TP
\fB\-\-skip\-reset\fR
skip resetting the device when in write\-flash
mode
.TP
\fB\-\-spi\fR
SPI mode (only for FTDI in serial mode)
.TP
\fB\-\-unprotect\-flash\fR
Unprotect flash blocks
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Produce verbose output
.TP
\fB\-\-verbose\-level\fR arg
verbose level \fB\-1\fR: quiet, 0: normal,
1:verbose, 2:debug
.TP
\fB\-h\fR, \fB\-\-help\fR
Give this help list
.TP
\fB\-\-verify\fR
Verify write operation (SPI Flash only)
.TP
\fB\-\-xvc\fR
Xilinx Virtual Cable Functions
.TP
\fB\-\-port\fR arg
Xilinx Virtual Cable and remote bitbang Port
(default 3721)
.TP
\fB\-\-mcufw\fR arg
Microcontroller firmware
.TP
\fB\-\-conmcu\fR
Connect JTAG to MCU
.TP
\fB\-D\fR, \fB\-\-read\-dna\fR
Read DNA (Xilinx FPGA only)
.TP
\fB\-X\fR, \fB\-\-read\-xadc\fR
Read XADC (Xilinx FPGA only)
.TP
\fB\-\-read\-register\fR arg
Read Status Register(Xilinx FPGA only)
.TP
\fB\-\-user\-flash\fR arg
User flash file (Gowin LittleBee FPGA only)
.TP
\fB\-V\fR, \fB\-\-Version\fR
Print program version
.PP
Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options.
.SH "REPORTING BUGS"
Report bugs to <gwenhael.goavec\-merou@trabucayre.com>.
.SH "SEE ALSO"
The full documentation for
.B openFPGALoader
is maintained as a Texinfo manual.  If the
.B info
and
.B openFPGALoader
programs are properly installed at your site, the command
.IP
.B info openFPGALoader
.PP
should give you access to the complete manual.