Changeset View
Changeset View
Standalone View
Standalone View
share/man/man9/PCI_IOV_INIT.9
- This file was moved from share/man/man9/PCI_INIT_IOV.9.
Show All 20 Lines | |||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
.\" | .\" | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd May 24, 2014 | .Dd May 24, 2014 | ||||
.Dt PCI_INIT_IOV 9 | .Dt PCI_IOV_INIT 9 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm PCI_INIT_IOV | .Nm PCI_IOV_INIT | ||||
.Nd enable SR-IOV on a PF device | .Nd enable SR-IOV on a PF device | ||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||
.In sys/bus.h | .In sys/bus.h | ||||
.In machine/stdarg.h | .In machine/stdarg.h | ||||
.In sys/nv.h | .In sys/nv.h | ||||
.In dev/pci/pcireg.h | .In dev/pci/pci_iov.h | ||||
.In dev/pci/pcivar.h | |||||
.Ft int | .Ft int | ||||
.Fn PCI_INIT_IOV "device_t dev" "uint16_t num_vfs" "const nvlist_t *pf_config" | .Fn PCI_IOV_INIT "device_t dev" "uint16_t num_vfs" "const nvlist_t *pf_config" | ||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||
The | The | ||||
.Fn PCI_INIT_IOV | .Fn PCI_IOV_INIT | ||||
method is called by the PCI Single-Root I/O Virtualization (SR-IOV) | method is called by the PCI Single-Root I/O Virtualization (SR-IOV) | ||||
infrastucture when the user requests that SR-IOV be enabled on a Physical | infrastucture when the user requests that SR-IOV be enabled on a Physical | ||||
Function (PF). | Function (PF). | ||||
The number of Virtual Functions (VFs) that will be created is passed to this | The number of Virtual Functions (VFs) that will be created is passed to this | ||||
method in the | method in the | ||||
.Fa num_vfs | .Fa num_vfs | ||||
argument. | argument. | ||||
.Pp | .Pp | ||||
Show All 12 Lines | |||||
.Fa pf_config | .Fa pf_config | ||||
will not contain any configuration parameters that were not specified in the PF | will not contain any configuration parameters that were not specified in the PF | ||||
schema. | schema. | ||||
All configuration parameters will have the correct type and are in the range of | All configuration parameters will have the correct type and are in the range of | ||||
valid values specified in the schema. | valid values specified in the schema. | ||||
.Pp | .Pp | ||||
If this method returns successfully, then this method will not be called again | If this method returns successfully, then this method will not be called again | ||||
on the same device until after a call to | on the same device until after a call to | ||||
.Xr PCI_UNINIT_IOV . | .Xr PCI_IOV_UNINIT . | ||||
.Sh RETURN VALUES | .Sh RETURN VALUES | ||||
Returns 0 on success, otherwise an appropriate error is returned. | Returns 0 on success, otherwise an appropriate error is returned. | ||||
If this method returns an error then the SR-IOV configuration will be aborted | If this method returns an error then the SR-IOV configuration will be aborted | ||||
and no VFs will be created. | and no VFs will be created. | ||||
.Sh SEE ALSO | .Sh SEE ALSO | ||||
.Xr nv 9 , | .Xr nv 9 , | ||||
.Xr pci 9 , | .Xr pci 9 , | ||||
.Xr pci_iov_schema 9 , | .Xr pci_iov_schema 9 , | ||||
.Xr PCI_ADD_VF 9 , | .Xr PCI_IOV_ADD_VF 9 , | ||||
.Xr PCI_UNINIT_IOV 9 | .Xr PCI_IOV_UNINIT 9 | ||||
.Sh AUTHORS | .Sh AUTHORS | ||||
This manual page was written by | This manual page was written by | ||||
.An Ryan Stone Aq Mt rstone@FreeBSD.org . | .An Ryan Stone Aq Mt rstone@FreeBSD.org . |