share/man/man9/PCI_ADD_VF.9

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