share/man/man9/PCI_IOV_INIT.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 28, 2015
  29 .Dt PCI_IOV_INIT 9
  30 .Os
  31 .Sh NAME
  32 .Nm PCI_IOV_INIT
  33 .Nd enable SR-IOV on a PF device
  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_INIT "device_t dev" "uint16_t num_vfs" "const nvlist_t *pf_config"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn PCI_IOV_INIT
  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
  46 Function (PF).
  47 The number of Virtual Functions (VFs) that will be created is passed to this
  48 method in the
  49 .Fa num_vfs
  50 argument.
  51 .Pp
  52 If the driver requested device-specific PF configuration parameters via a PF
  53 schema in its call to
  54 .Xr pci_iov_attach 9 ,
  55 those parameters will be available in the
  56 .Fa pf_config
  57 argument.
  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
  60 .Fa pf_config .
  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
  63 .Fa pf_config .
  64 .Fa pf_config
  65 will not contain any configuration parameters that were not specified in the PF
  66 schema.
  67 All configuration parameters will have the correct type and are in the range of
  68 valid values specified in the schema.
  69 .Pp
  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 .
  73 .Sh RETURN VALUES
  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.
  77 .Sh SEE ALSO
  78 .Xr nv 9 ,
  79 .Xr pci 9 ,
  80 .Xr PCI_IOV_ADD_VF 9 ,
  81 .Xr pci_iov_schema 9 ,
  82 .Xr PCI_IOV_UNINIT 9
  83 .Sh AUTHORS
  84 This manual page was written by
  85 .An Ryan Stone Aq Mt rstone@FreeBSD.org .