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_ADD_VF 9 28.Os 29.Sh NAME 30.Nm PCI_IOV_ADD_VF 31.Nd inform a PF driver that a VF is being created 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_ADD_VF "device_t dev" "uint16_t vfnum" "const nvlist_t *vf_config" 39.Sh DESCRIPTION 40The 41.Fn PCI_IOV_ADD_VF 42method is called by the PCI Single-Root I/O Virtualization 43.Pq SR-IOV 44infrastructure when it is initializating a new Virtual Function (VF) as a child 45of the given Physical Function (PF) device. 46This method will not be called until a successful call to 47.Xr PCI_IOV_INIT 9 48has been made. 49It is not guaranteed that this method will be called following a successful call 50to 51.Xr PCI_IOV_INIT 9 . 52If the infrastructure encounters a failure to allocate resources following the 53call to 54.Xr PCI_IOV_INIT 9 , 55the VF creation will be aborted and 56.Xr PCI_IOV_UNINIT 9 57will be called immediately without any preceding calls to 58.Nm . 59.Pp 60The index of the VF being initialized is passed in the 61.Fa vfnum 62argument. 63VFs are always numbered sequentially starting at 0. 64.Pp 65If the driver requested device-specific configuration parameters via a VF schema 66in its call to 67.Xr pci_iov_attach 9 , 68those parameters will be contained in the 69.Pa vf_config 70argument. 71All configuration parameters that were either set as required parameters or that 72had a default value set in the VF schema are guaranteed to be present in 73.Fa vf_config . 74Configuration parameters that were neither set as required nor were given a 75default value are optional and may or may not be present in 76.Fa vf_config . 77.Fa vf_config 78will not contain any configuration parameters that were not specified in the VF 79schema. 80All configuration parameters will have the correct type and will be in the range 81of valid values specified in the schema. 82.Pp 83Note that it is possible for the user to set different configuration values on 84different VF devices that are children of the same PF. 85The PF driver must not cache configuration parameters passed in previous calls 86to 87.Fn PCI_IOV_ADD_VF 88for other VFs and apply those parameters to the current VF. 89.Pp 90This function will not be called twice for the same 91.Fa vf_num 92on the same PF device without 93.Xr PCI_IOV_UNINIT 9 94and 95.Xr PCI_IOV_INIT 9 96first being called, in that order. 97.Sh RETURN VALUES 98This method returns 0 on success, otherwise an appropriate error is returned. 99If this method returns an error then the current VF device will be destroyed 100but the rest of the VF devices will be created and SR-IOV will be enabled on 101the PF. 102.Sh SEE ALSO 103.Xr nv 9 , 104.Xr pci 9 , 105.Xr PCI_IOV_INIT 9 , 106.Xr pci_iov_schema 9 , 107.Xr PCI_IOV_UNINIT 9 108.Sh AUTHORS 109This manual page was written by 110.An Ryan Stone Aq Mt rstone@FreeBSD.org . 111