Blame doc/src/fpga_tools/fpgaflash/fpgaflash.md

Packit 534379
# fpgaflash #
Packit 534379

Packit 534379
## SYNOPSIS ##
Packit 534379
```console
Packit 534379
fpgaflash [-h] {user,factory} file [bdf]
Packit 534379
```
Packit 534379

Packit 534379
## DESCRIPTION ##
Packit 534379
fpgaflash updates the static FIM image loaded from flash at power-on.
Packit 534379

Packit 534379
If there are multiple devices in the system, fpgaflash must specify a BDF to select the correct device. If no BDF is specified, fpgaflash prints out the BDFs of any compatible devices.
Packit 534379

Packit 534379
## POSITIONAL ARGUMENTS ##
Packit 534379
`{user, factory}`
Packit 534379

Packit 534379
 Specifies the type of flash programming.
Packit 534379
   
Packit 534379
 `user` 
Packit 534379
 
Packit 534379
 Only reprograms the user image in flash.  
Packit 534379
   
Packit 534379
 `factory` 
Packit 534379
 
Packit 534379
 Reprograms the entire flash.  A catastrophic failure during a factory update such as a power outage
Packit 534379
 requires a USB cable and `quartus_pgm` to recover.
Packit 534379

Packit 534379
`file`
Packit 534379

Packit 534379
Specifies the Raw Programming Data File (rpd) to program into flash.
Packit 534379

Packit 534379
`bdf`
Packit 534379

Packit 534379
Specifies the bus, device and function (BDF) of device to program such as 04:00.0 or 0000:04:00.0. This flag
Packit 534379
is optional when there is a single device in the system.
Packit 534379

Packit 534379

Packit 534379
## OPTIONAL ARGUMENTS ##
Packit 534379
`-h, --help`
Packit 534379

Packit 534379
   Print usage information.
Packit 534379

Packit 534379
## EXAMPLE ##
Packit 534379

Packit 534379
`fpgaflash user new_image.rpd 0000:04:00.0`
Packit 534379

Packit 534379
Programs new_image.rpd to flash of device with BDF 0000:04:00.0.
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.) | No changes from previous release. |