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