xref: /freebsd/share/man/man9/PCI_IOV_INIT.9 (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
1.\"
2.\" Copyright (c) 2014 Sandvine Inc.
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd May 28, 2015
27.Dt PCI_IOV_INIT 9
28.Os
29.Sh NAME
30.Nm PCI_IOV_INIT
31.Nd enable SR-IOV on a PF device
32.Sh SYNOPSIS
33.In sys/bus.h
34.In machine/stdarg.h
35.In sys/nv.h
36.In dev/pci/pci_iov.h
37.Ft int
38.Fn PCI_IOV_INIT "device_t dev" "uint16_t num_vfs" "const nvlist_t *pf_config"
39.Sh DESCRIPTION
40The
41.Fn PCI_IOV_INIT
42method is called by the PCI Single-Root I/O Virtualization (SR-IOV)
43infrastructure when the user requests that SR-IOV be enabled on a Physical
44Function (PF).
45The number of Virtual Functions (VFs) that will be created is passed to this
46method in the
47.Fa num_vfs
48argument.
49.Pp
50If the driver requested device-specific PF configuration parameters via a PF
51schema in its call to
52.Xr pci_iov_attach 9 ,
53those parameters will be available in the
54.Fa pf_config
55argument.
56All configuration parameters that were either set as required parameters or that
57had a default value set in the PF schema are guaranteed to be present in
58.Fa pf_config .
59Configuration parameters that were neither set as required nor were given a
60default value are optional and may or may not be present in
61.Fa pf_config .
62.Fa pf_config
63will not contain any configuration parameters that were not specified in the PF
64schema.
65All configuration parameters will have the correct type and are in the range of
66valid values specified in the schema.
67.Pp
68If this method returns successfully, then this method will not be called again
69on the same device until after a call to
70.Xr PCI_IOV_UNINIT 9 .
71.Sh RETURN VALUES
72Returns 0 on success, otherwise an appropriate error is returned.
73If this method returns an error then the SR-IOV configuration will be aborted
74and no VFs will be created.
75.Sh SEE ALSO
76.Xr nv 9 ,
77.Xr pci 9 ,
78.Xr PCI_IOV_ADD_VF 9 ,
79.Xr pci_iov_schema 9 ,
80.Xr PCI_IOV_UNINIT 9
81.Sh AUTHORS
82This manual page was written by
83.An Ryan Stone Aq Mt rstone@FreeBSD.org .
84