2 .\" Copyright (c) 2014 Sandvine Inc.
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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
33 .Nd enable SR-IOV on a PF device
40 .Fn PCI_IOV_INIT "device_t dev" "uint16_t num_vfs" "const nvlist_t *pf_config"
44 method is called by the PCI Single-Root I/O Virtualization (SR-IOV)
45 infrastucture when the user requests that SR-IOV be enabled on a Physical
47 The number of Virtual Functions (VFs) that will be created is passed to this
52 If the driver requested device-specific PF configuration parameters via a PF
54 .Xr pci_iov_attach 9 ,
55 those parameters will be available in the
58 All configuration parameters that were either set as required parameters or that
59 had a default value set in the PF schema are guaranteed to be present in
61 Configuration parameters that were neither set as required nor were given a
62 default value are optional and may or may not be present in
65 will not contain any configuration parameters that were not specified in the PF
67 All configuration parameters will have the correct type and are in the range of
68 valid values specified in the schema.
70 If this method returns successfully, then this method will not be called again
71 on the same device until after a call to
72 .Xr PCI_IOV_UNINIT 9 .
74 Returns 0 on success, otherwise an appropriate error is returned.
75 If this method returns an error then the SR-IOV configuration will be aborted
76 and no VFs will be created.
80 .Xr PCI_IOV_ADD_VF 9 ,
81 .Xr pci_iov_schema 9 ,
84 This manual page was written by
85 .An Ryan Stone Aq Mt rstone@FreeBSD.org .