share/man/man9/PCI_IOV_UNINIT.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_UNINIT 9
  30 .Os
  31 .Sh NAME
  32 .Nm PCI_IOV_UNINIT
  33 .Nd disable SR-IOV on a PF device
  34 .Sh SYNOPSIS
  35 .In sys/bus.h
  36 .In dev/pci/pci_iov.h
  37 .Ft void
  38 .Fn PCI_IOV_UNINIT "device_t dev"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn PCI_IOV_UNINIT
  42 method is called by the PCI Single-Root I/O Virtualization (SR-IOV)
  43 infrastructure when the user requests that SR-IOV be disabled on a Physical
  44 Function (PF).
  45 When this method is called, the PF driver must release any SR-IOV-related
  46 resources that it has allocated and disable any device-specific SR-IOV
  47 configuration in the device.
  48 .Pp
  49 This method will only be called following a successful call to
  50 .Xr PCI_IOV_INIT 9 .
  51 It is not guaranteed that
  52 .Xr PCI_IOV_ADD_VF 9
  53 will have been called for any Virtual Function (VF) after the call to
  54 .Xr PCI_IOV_INIT 9
  55 and before the call to
  56 .Nm .
  57 .Sh SEE ALSO
  58 .Xr pci 9 ,
  59 .Xr PCI_IOV_ADD_VF 9 ,
  60 .Xr PCI_IOV_INIT 9
  61 .Sh AUTHORS
  62 This manual page was written by
  63 .An Ryan Stone Aq Mt rstone@FreeBSD.org .