sys/dev/cxgbe/t4_if.m

   1 #-
   2 # Copyright (c) 2015-2016 Chelsio Communications, Inc.
   3 # All rights reserved.
   4 # Written by: John Baldwin <jhb@FreeBSD.org>
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions
   8 # are met:
   9 # 1. Redistributions of source code must retain the above copyright
  10 #    notice, this list of conditions and the following disclaimer.
  11 # 2. Redistributions in binary form must reproduce the above copyright
  12 #    notice, this list of conditions and the following disclaimer in the
  13 #    documentation and/or other materials provided with the distribution.
  14 #
  15 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 # SUCH DAMAGE.
  26 #
  27 #
  28
  29 #include <sys/bus.h>
  30
  31 INTERFACE t4;
  32
  33 # The "main" device of a T4/T5 NIC is the PF4 device.  Drivers for other
  34 # functions on the NIC need to wait for the main device to be initialized
  35 # before finishing attach.  These routines allow drivers for other devices
  36 # to coordinate with the main driver for the PF4.
  37
  38 # Called by a driver during attach to determine if the PF4 driver is
  39 # initialized.  If the main driver is not ready, the driver should defer
  40 # further initialization until 'attach_child'.
  41 METHOD int is_main_ready {
  42         device_t        dev;
  43 };
  44
  45 # Called by the PF4 driver on each sibling device when the PF4 driver is
  46 # initialized.
  47 METHOD int attach_child {
  48         device_t        dev;
  49 };
  50
  51 # Called by the PF4 driver on each sibling device when the PF4 driver is
  52 # preparing to detach.
  53 METHOD int detach_child {
  54         device_t        dev;
  55 };
  56
  57 # Called by a driver to query the PF4 driver for the child device
  58 # associated with a given port.  If the port is not enabled on the adapter,
  59 # this will fail.
  60 METHOD int read_port_device {
  61         device_t        dev;
  62         int             port;
  63         device_t        *child;
  64 };