summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man9/Makefile6
-rw-r--r--share/man/man9/PCI_IOV_ADD_VF.9 (renamed from share/man/man9/PCI_ADD_VF.9)31
-rw-r--r--share/man/man9/PCI_IOV_INIT.9 (renamed from share/man/man9/PCI_INIT_IOV.9)19
-rw-r--r--share/man/man9/PCI_IOV_UNINIT.9 (renamed from share/man/man9/PCI_UNINIT_IOV.9)23
-rw-r--r--share/man/man9/pci.917
-rw-r--r--share/man/man9/pci_iov_schema.96
6 files changed, 50 insertions, 52 deletions
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 11dcb01..d0e204f 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -195,10 +195,10 @@ MAN= accept_filter.9 \
p_candebug.9 \
p_cansee.9 \
pci.9 \
- PCI_ADD_VF.9 \
- PCI_INIT_IOV.9 \
+ PCI_IOV_ADD_VF.9 \
+ PCI_IOV_INIT.9 \
pci_iov_schema.9 \
- PCI_UNINIT_IOV.9 \
+ PCI_IOV_UNINIT.9 \
pfil.9 \
pfind.9 \
pget.9 \
diff --git a/share/man/man9/PCI_ADD_VF.9 b/share/man/man9/PCI_IOV_ADD_VF.9
index 72a3a97..d99a106 100644
--- a/share/man/man9/PCI_ADD_VF.9
+++ b/share/man/man9/PCI_IOV_ADD_VF.9
@@ -25,38 +25,37 @@
.\"
.\" $FreeBSD$
.\"
-.Dd May 24, 2014
-.Dt PCI_ADD_VF 9
+.Dd May 28, 2015
+.Dt PCI_IOV_ADD_VF 9
.Os
.Sh NAME
-.Nm PCI_ADD_VF
+.Nm PCI_IOV_ADD_VF
.Nd inform a PF driver that a VF is being created
.Sh SYNOPSIS
.In sys/bus.h
.In machine/stdarg.h
.In sys/nv.h
-.In dev/pci/pcireg.h
-.In dev/pci/pcivar.h
+.In dev/pci/pci_iov.h
.Ft int
-.Fn PCI_ADD_VF "device_t dev" "uint16_t vfnum" "const nvlist_t *vf_config"
+.Fn PCI_IOV_ADD_VF "device_t dev" "uint16_t vfnum" "const nvlist_t *vf_config"
.Sh DESCRIPTION
The
-.Fn PCI_ADD_VF
+.Fn PCI_IOV_ADD_VF
method is called by the PCI Single-Root I/O Virtualization
.Pq SR-IOV
infrastructure when it is initializating a new Virtual Function (VF) as a child
of the given Physical Function (PF) device.
This method will not be called until a successful call to
-.Xr PCI_INIT_IOV 9
+.Xr PCI_IOV_INIT 9
has been made.
It is not guaranteed that this method will be called following a successful call
to
-.Xr PCI_INIT_IOV 9 .
+.Xr PCI_IOV_INIT 9 .
If the infrastructure encounters a failure to allocate resources following the
call to
-.Xr PCI_INIT_IOV 9 ,
+.Xr PCI_IOV_INIT 9 ,
the VF creation will be aborted and
-.Xr PCI_UNINIT_IOV 9
+.Xr PCI_IOV_UNINIT 9
will be called immediately without any preceding calls to
.Nm .
.Pp
@@ -87,15 +86,15 @@ Note that it is possible for the user to set different configuration values on
different VF devices that are children of the same PF.
The PF driver must not cache configuration parameters passed in previous calls
to
-.Fn PCI_ADD_VF
+.Fn PCI_IOV_ADD_VF
for other VFs and apply those parameters to the current VF.
.Pp
This function will not be called twice for the same
.Fa vf_num
on the same PF device without
-.Xr PCI_UNINIT_IOV 9
+.Xr PCI_IOV_UNINIT 9
and
-.Xr PCI_INIT_IOV 9
+.Xr PCI_IOV_INIT 9
first being called, in that order.
.Sh RETURN VALUES
This method returns 0 on success, otherwise an appropriate error is returned.
@@ -106,8 +105,8 @@ the PF.
.Xr nv 9 ,
.Xr pci 9 ,
.Xr pci_iov_schema 9 ,
-.Xr PCI_INIT_IOV 9 ,
-.Xr PCI_UNINIT_IOV 9
+.Xr PCI_IOV_INIT 9 ,
+.Xr PCI_IOV_UNINIT 9
.Sh AUTHORS
This manual page was written by
.An Ryan Stone Aq Mt rstone@FreeBSD.org .
diff --git a/share/man/man9/PCI_INIT_IOV.9 b/share/man/man9/PCI_IOV_INIT.9
index 1c8c64e..f9daa24 100644
--- a/share/man/man9/PCI_INIT_IOV.9
+++ b/share/man/man9/PCI_IOV_INIT.9
@@ -25,23 +25,22 @@
.\"
.\" $FreeBSD$
.\"
-.Dd May 24, 2014
-.Dt PCI_INIT_IOV 9
+.Dd May 28, 2015
+.Dt PCI_IOV_INIT 9
.Os
.Sh NAME
-.Nm PCI_INIT_IOV
+.Nm PCI_IOV_INIT
.Nd enable SR-IOV on a PF device
.Sh SYNOPSIS
.In sys/bus.h
.In machine/stdarg.h
.In sys/nv.h
-.In dev/pci/pcireg.h
-.In dev/pci/pcivar.h
+.In dev/pci/pci_iov.h
.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
The
-.Fn PCI_INIT_IOV
+.Fn PCI_IOV_INIT
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
Function (PF).
@@ -70,7 +69,7 @@ valid values specified in the schema.
.Pp
If this method returns successfully, then this method will not be called again
on the same device until after a call to
-.Xr PCI_UNINIT_IOV .
+.Xr PCI_IOV_UNINIT .
.Sh RETURN VALUES
Returns 0 on success, otherwise an appropriate error is returned.
If this method returns an error then the SR-IOV configuration will be aborted
@@ -79,8 +78,8 @@ and no VFs will be created.
.Xr nv 9 ,
.Xr pci 9 ,
.Xr pci_iov_schema 9 ,
-.Xr PCI_ADD_VF 9 ,
-.Xr PCI_UNINIT_IOV 9
+.Xr PCI_IOV_ADD_VF 9 ,
+.Xr PCI_IOV_UNINIT 9
.Sh AUTHORS
This manual page was written by
.An Ryan Stone Aq Mt rstone@FreeBSD.org .
diff --git a/share/man/man9/PCI_UNINIT_IOV.9 b/share/man/man9/PCI_IOV_UNINIT.9
index fc4cc85..b95914e 100644
--- a/share/man/man9/PCI_UNINIT_IOV.9
+++ b/share/man/man9/PCI_IOV_UNINIT.9
@@ -25,21 +25,20 @@
.\"
.\" $FreeBSD$
.\"
-.Dd May 24, 2014
-.Dt PCI_UNINIT_IOV 9
+.Dd May 28, 2015
+.Dt PCI_IOV_UNINIT 9
.Os
.Sh NAME
-.Nm PCI_UNINIT_IOV
+.Nm PCI_IOV_UNINIT
.Nd disable SR-IOV on a PF device
.Sh SYNOPSIS
.In sys/bus.h
-.In dev/pci/pcireg.h
-.In dev/pci/pcivar.h
+.In dev/pci/pci_iov.h
.Ft void
-.Fn PCI_UNINIT_IOV "device_t dev"
+.Fn PCI_IOV_UNINIT "device_t dev"
.Sh DESCRIPTION
The
-.Fn PCI_UNINIT_IOV
+.Fn PCI_IOV_UNINIT
method is called by the PCI Single-Root I/O Virtualization (SR-IOV)
infrastructure when the user requests that SR-IOV be disabled on a Physical
Function (PF).
@@ -48,17 +47,17 @@ resources that it has allocated and disable any device-specific SR-IOV
configuration in the device.
.Pp
This method will only be called following a successful call to
-.Xr PCI_INIT_IOV .
+.Xr PCI_IOV_INIT .
It is not guaranteed that
-.Xr PCI_ADD_VF
+.Xr PCI_IOV_ADD_VF
will have been called for any Virtual Function (VF) after the call to
-.Xr PCI_INIT_IOV
+.Xr PCI_IOV_INIT
and before the call to
.Nm .
.Sh SEE ALSO
.Xr pci 9 ,
-.Xr PCI_ADD_VF 9 ,
-.Xr PCI_INIT_IOV 9
+.Xr PCI_IOV_ADD_VF 9 ,
+.Xr PCI_IOV_INIT 9
.Sh AUTHORS
This manual page was written by
.An Ryan Stone Aq Mt rstone@FreeBSD.org .
diff --git a/share/man/man9/pci.9 b/share/man/man9/pci.9
index a33d2ed..14500b5 100644
--- a/share/man/man9/pci.9
+++ b/share/man/man9/pci.9
@@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd May 24, 2014
+.Dd May 28, 2015
.Dt PCI 9
.Os
.Sh NAME
@@ -97,10 +97,6 @@
.Ft int
.Fn pci_get_vpd_readonly "device_t dev" "const char *kw" "const char **vptr"
.Ft int
-.Fn pci_iov_attach "device_t dev" "nvlist_t *pf_schema" "nvlist_t *vf_schema"
-.Ft int
-.Fn pci_iov_detach "device_t dev"
-.Ft int
.Fn pci_msi_count "device_t dev"
.Ft int
.Fn pci_msix_count "device_t dev"
@@ -122,6 +118,11 @@
.Fn pci_set_powerstate "device_t dev" "int state"
.Ft void
.Fn pci_write_config "device_t dev" "int reg" "uint32_t val" "int width"
+.In dev/pci/pci_iov.h
+.Ft int
+.Fn pci_iov_attach "device_t dev" "nvlist_t *pf_schema" "nvlist_t *vf_schema"
+.Ft int
+.Fn pci_iov_detach "device_t dev"
.Sh DESCRIPTION
The
.Nm
@@ -446,10 +447,10 @@ function is used to advertise that the given device
supports PCI Single-Root I/O Virtualization
.Po SR-IOV Pc .
A driver that supports SR-IOV must implement the
-.Xr PCI_INIT_IOV 9 ,
-.Xr PCI_ADD_VF 9
+.Xr PCI_IOV_INIT 9 ,
+.Xr PCI_IOV_ADD_VF 9
and
-.Xr PCI_UNIT_IOV 9
+.Xr PCI_IOV_UNINIT 9
methods.
This function should be called during the
.Xr DEVICE_ATTACH 9
diff --git a/share/man/man9/pci_iov_schema.9 b/share/man/man9/pci_iov_schema.9
index f2f1f30..36c0189 100644
--- a/share/man/man9/pci_iov_schema.9
+++ b/share/man/man9/pci_iov_schema.9
@@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd May 25, 2014
+.Dd May 28, 2015
.Dt pci_iov_schema 9
.Os
.Sh NAME
@@ -258,8 +258,8 @@ The
function returns a pointer to the allocated schema, or NULL if a failure occurs.
.Sh SEE ALSO
.Xr pci 9 ,
-.Xr PCI_ADD_VF 9 ,
-.Xr PCI_INIT_IOV 9
+.Xr PCI_IOV_ADD_VF 9 ,
+.Xr PCI_IOV_INIT 9
.Sh AUTHORS
This manual page was written by
.An Ryan Stone Aq rstone@FreeBSD.org .
OpenPOWER on IntegriCloud