Blame doc/src/fpga_tools/fpgaport/fpgaport.md

Packit 534379
# fpgaport #
Packit 534379
Packit 534379
## SYNOPSIS ##
Packit 534379
```console
Packit 534379
fpgaport [-h] {assign,release} device port
Packit 534379
```
Packit 534379
Packit 534379
## DESCRIPTION ##
Packit 534379
The ```fpgaport``` enables and disables virtualization. It assigns
Packit 534379
and releases control of the port to the virtual function (VF). By default, the driver
Packit 534379
assigns the port to the physical function (PF) in the non-virtualization use case.
Packit 534379
Packit 534379
Packit 534379
## POSITIONAL ARGUMENTS ##
Packit 534379
`{assign, release}`
Packit 534379
Packit 534379
   Action to perform.
Packit 534379
Packit 534379
`device`
Packit 534379
Packit 534379
The FPGA device being targeted with this action.
Packit 534379
Packit 534379
`port`
Packit 534379
Packit 534379
The number of the port.
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
`fpgaport release /dev/intel-fpga-fme.0 0`
Packit 534379
Packit 534379
Release port 0 from physical function control.
Packit 534379
Packit 534379
`fpgaport assign /dev/intel-fpga-fme.0 0`
Packit 534379
Packit 534379
Assign port 0 to physical function control.
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.) | No changes from previous release. |