Blame doc/src/fpga_tools/fpgaconf/fpgaconf.md

Packit 534379
# fpgaconf #
Packit 534379

Packit 534379
## SYNOPSIS ##
Packit 534379

Packit 534379
`fpgaconf [-hvVn] [-b <bus>] [-d <device>] [-f <function>] [-s <socket>] <gbs>`
Packit 534379

Packit 534379
## DESCRIPTION ##
Packit 534379

Packit 534379
```fpgaconf``` configures the FPGA with the accelerator function (AF). It also checks the AF for compatibility with 
Packit 534379
the targeted FPGA and the FPGA Interface Manager (FIM). ```fpgaconf``` takes the following arguments: 
Packit 534379

Packit 534379
`-h, --help`
Packit 534379

Packit 534379
	Prints usage information.
Packit 534379

Packit 534379
`-v, --version`
Packit 534379

Packit 534379
	Prints version information and exits.
Packit 534379

Packit 534379
`-V, --verbose`
Packit 534379

Packit 534379
	Prints more verbose messages while enumerating and configuring. Can be
Packit 534379
	requested more than once.
Packit 534379

Packit 534379
`-n, --dry-run`
Packit 534379

Packit 534379
	Performs enumeration. Skips any operations with side-effects such as the
Packit 534379
	actual AF configuration. 
Packit 534379

Packit 534379
`-B, --bus`
Packit 534379

Packit 534379
	PCIe bus number of the target FPGA.
Packit 534379

Packit 534379
`-D, --device`
Packit 534379

Packit 534379
	PCIe device number of the target FPGA. 
Packit 534379

Packit 534379
`-F, --function`
Packit 534379

Packit 534379
	PCIe function number of the target FPGA.
Packit 534379

Packit 534379
`-S, --socket`
Packit 534379

Packit 534379
	Socket number of the target FPGA.
Packit 534379

Packit 534379
```fpgaconf``` enumerates available FPGA devices in the system and selects
Packit 534379
compatible FPGAs for configuration. If more than one FPGA is
Packit 534379
compatible with the AF, ```fpgaconf``` exits and asks you to be
Packit 534379
more specific in selecting the target FPGAs by specifying a
Packit 534379
socket number or a PCIe BDF.
Packit 534379

Packit 534379
## EXAMPLES ##
Packit 534379

Packit 534379
`fpgaconf my_af.gbs`
Packit 534379

Packit 534379
	Program "my_af.gbs" to a compatible FPGA.
Packit 534379

Packit 534379
`fpgaconf -v -s 0 my_af.gbs`
Packit 534379

Packit 534379
	Program "my_af.gbs" to the FPGA in socket 0, if compatible,
Packit 534379
	while printing out slightly more verbose information.
Packit 534379
	
Packit 534379
	## Revision History ##
Packit 534379

Packit 534379
 | Document Version |  Intel Acceleration Stack Version  | Changes  |
Packit 534379
 | ---------------- |------------------------------------|----------|
Packit 534379
 |2018.05.21 | 1.1 Beta. 
(Supported with Intel Quartus Prime Pro Edition 17.1.1.) | Corrected typos. |