xref: /netbsd-src/sys/dev/pci/pci_calls (revision dcda59c6dc829026a44d75d80d75c1bac286675e)
1*dcda59c6Sthorpej$NetBSD: pci_calls,v 1.1 2021/09/15 17:26:07 thorpej Exp $
2*dcda59c6Sthorpej
3*dcda59c6Sthorpej/*-
4*dcda59c6Sthorpej * Copyright (c) 2021 The NetBSD Foundation, Inc.
5*dcda59c6Sthorpej * All rights reserved.
6*dcda59c6Sthorpej *
7*dcda59c6Sthorpej * This code is derived from software contributed to The NetBSD Foundation
8*dcda59c6Sthorpej * by Jason R. Thorpe.
9*dcda59c6Sthorpej *
10*dcda59c6Sthorpej * Redistribution and use in source and binary forms, with or without
11*dcda59c6Sthorpej * modification, are permitted provided that the following conditions
12*dcda59c6Sthorpej * are met:
13*dcda59c6Sthorpej * 1. Redistributions of source code must retain the above copyright
14*dcda59c6Sthorpej *    notice, this list of conditions and the following disclaimer.
15*dcda59c6Sthorpej * 2. Redistributions in binary form must reproduce the above copyright
16*dcda59c6Sthorpej *    notice, this list of conditions and the following disclaimer in the
17*dcda59c6Sthorpej *    documentation and/or other materials provided with the distribution.
18*dcda59c6Sthorpej *
19*dcda59c6Sthorpej * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20*dcda59c6Sthorpej * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21*dcda59c6Sthorpej * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22*dcda59c6Sthorpej * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23*dcda59c6Sthorpej * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24*dcda59c6Sthorpej * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25*dcda59c6Sthorpej * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26*dcda59c6Sthorpej * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27*dcda59c6Sthorpej * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28*dcda59c6Sthorpej * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29*dcda59c6Sthorpej * POSSIBILITY OF SUCH DAMAGE.
30*dcda59c6Sthorpej */
31*dcda59c6Sthorpej
32*dcda59c6Sthorpej/*
33*dcda59c6Sthorpej * Device calls used by the PCI subsystem.
34*dcda59c6Sthorpej */
35*dcda59c6Sthorpej
36*dcda59c6Sthorpejsubsystem pci;
37*dcda59c6Sthorpej
38*dcda59c6Sthorpej#include <dev/pci/pcivar.h>
39*dcda59c6Sthorpej
40*dcda59c6Sthorpej/*
41*dcda59c6Sthorpej * pci-bus-get-child-devhandle
42*dcda59c6Sthorpej *
43*dcda59c6Sthorpej * Retrieve the devhandle for the PCI device represented by 'tag'
44*dcda59c6Sthorpej * in the PCI segment represented by 'pc'.  The PCI bus's device_t
45*dcda59c6Sthorpej * is the one that's passed in the call, and the device whose handle
46*dcda59c6Sthorpej * is being requested must be a direct child of that bus, otherwise
47*dcda59c6Sthorpej * behavior is undefined.
48*dcda59c6Sthorpej *
49*dcda59c6Sthorpej * Call returns 0 if successful, or an error code upon failure:
50*dcda59c6Sthorpej *
51*dcda59c6Sthorpej * ENOTSUP	The device handle implementation for the
52*dcda59c6Sthorpej *		PCI bus does not support this device call.
53*dcda59c6Sthorpej *
54*dcda59c6Sthorpej * ENODEV	The PCI device represented by the pcitag_t
55*dcda59c6Sthorpej *		was not found in a bus-scoped search of the
56*dcda59c6Sthorpej *		platform device tree.
57*dcda59c6Sthorpej */
58*dcda59c6Sthorpejpci-bus-get-child-devhandle {
59*dcda59c6Sthorpej	pci_chipset_tag_t pc;		/* IN */
60*dcda59c6Sthorpej	pcitag_t tag;			/* IN */
61*dcda59c6Sthorpej	devhandle_t devhandle;		/* OUT */
62*dcda59c6Sthorpej};
63