xref: /freebsd/sys/dev/pci/pcib_if.m (revision ea906c4152774dff300bb26fbfc1e4188351c89a)
1#-
2# Copyright (c) 2000 Doug Rabson
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
29#include <sys/bus.h>
30#include <dev/pci/pcivar.h>
31
32INTERFACE pcib;
33
34CODE {
35	static int
36	null_route_interrupt(device_t pcib, device_t dev, int pin)
37	{
38		return (PCI_INVALID_IRQ);
39	}
40};
41
42#
43# Return the number of slots on the attached PCI bus.
44#
45METHOD int maxslots {
46	device_t	dev;
47};
48
49#
50# Read configuration space on the PCI bus. The bus, slot and func
51# arguments determine the device which is being read and the reg
52# argument is a byte offset into configuration space for that
53# device. The width argument (which should be 1, 2 or 4) specifies how
54# many byte of configuration space to read from that offset.
55#
56METHOD u_int32_t read_config {
57	device_t	dev;
58	u_int		bus;
59	u_int		slot;
60	u_int		func;
61	u_int		reg;
62	int		width;
63};
64
65#
66# Write configuration space on the PCI bus. The bus, slot and func
67# arguments determine the device which is being written and the reg
68# argument is a byte offset into configuration space for that
69# device. The value field is written to the configuration space, with
70# the number of bytes written depending on the width argument.
71#
72METHOD void write_config {
73	device_t	dev;
74	u_int		bus;
75	u_int		slot;
76	u_int		func;
77	u_int		reg;
78	u_int32_t	value;
79	int		width;
80};
81
82#
83# Route an interrupt.  Returns a value suitable for stuffing into
84# a device's interrupt register.
85#
86METHOD int route_interrupt {
87	device_t	pcib;
88	device_t	dev;
89	int		pin;
90} DEFAULT null_route_interrupt;
91
92#
93# Allocate 'count' MSI messsages mapped onto 'count' IRQs.  'irq' points
94# to an array of at least 'count' ints.  The max number of messages this
95# device supports is included so that the MD code can take that into
96# account when assigning resources so that the proper number of low bits
97# are clear in the resulting message data value.
98#
99METHOD int alloc_msi {
100	device_t	pcib;
101	device_t	dev;
102	int		count;
103	int		maxcount;
104	int		*irqs;
105};
106
107#
108# Release 'count' MSI messages mapped onto 'count' IRQs stored in the
109# array pointed to by 'irqs'.
110#
111METHOD int release_msi {
112	device_t	pcib;
113	device_t	dev;
114	int		count;
115	int		*irqs;
116};
117
118#
119# Allocate a single MSI-X message mapped onto '*irq'.
120#
121METHOD int alloc_msix {
122	device_t	pcib;
123	device_t	dev;
124	int		*irq;
125};
126
127#
128# Release a single MSI-X message mapped onto 'irq'.
129#
130METHOD int release_msix {
131	device_t	pcib;
132	device_t	dev;
133	int		irq;
134};
135
136#
137# Determine the MSI/MSI-X message address and data for 'irq'.  The address
138# is returned in '*addr', and the data in '*data'.
139#
140METHOD int map_msi {
141	device_t	pcib;
142	device_t	dev;
143	int		irq;
144	uint64_t	*addr;
145	uint32_t	*data;
146};
147