xref: /freebsd/sys/dev/cxgbe/t4_if.m (revision 63a938566d524836885917d95bd491aa4400b181)
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# $FreeBSD$
28#
29
30#include <sys/bus.h>
31
32INTERFACE t4;
33
34# The "main" device of a T4/T5 NIC is the PF4 device.  Drivers for other
35# functions on the NIC need to wait for the main device to be initialized
36# before finishing attach.  These routines allow drivers for other devices
37# to coordinate with the main driver for the PF4.
38
39# Called by a driver during attach to determine if the PF4 driver is
40# initialized.  If the main driver is not ready, the driver should defer
41# further initialization until 'attach_child'.
42METHOD int is_main_ready {
43	device_t	dev;
44};
45
46# Called by the PF4 driver on each sibling device when the PF4 driver is
47# initialized.
48METHOD int attach_child {
49	device_t	dev;
50};
51
52# Called by the PF4 driver on each sibling device when the PF4 driver is
53# preparing to detach.
54METHOD int detach_child {
55	device_t	dev;
56};
57
58# Called by a driver to query the PF4 driver for the child device
59# associated with a given port.  If the port is not enabled on the adapter,
60# this will fail.
61METHOD int read_port_device {
62	device_t	dev;
63	int		port;
64	device_t	*child;
65};
66