xref: /freebsd/sys/kern/msi_if.m (revision 8aac90f18aef7c9eea906c3ff9a001ca7b94f375)
1#-
2# Copyright (c) 2016 The FreeBSD Foundation
3#
4# This software was developed by Andrew Turner under
5# sponsorship from the FreeBSD Foundation.
6#
7# Redistribution and use in source and binary forms, with or without
8# modification, are permitted provided that the following conditions
9# are met:
10# 1. Redistributions of source code must retain the above copyright
11#    notice, this list of conditions and the following disclaimer.
12# 2. Redistributions in binary form must reproduce the above copyright
13#    notice, this list of conditions and the following disclaimer in the
14#    documentation and/or other materials provided with the distribution.
15#
16# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26# SUCH DAMAGE.
27#
28#
29
30INTERFACE msi;
31
32HEADER {
33	#include <machine/bus.h>
34	#include <dev/iommu/iommu_msi.h>
35
36	struct intr_irqsrc;
37};
38
39#
40# Default implementations of some methods.
41#
42CODE {
43	static int
44	iommu_init(device_t dev, device_t child, struct iommu_domain **domain)
45	{
46		*domain = NULL;
47		return (0);
48	}
49	static void
50	iommu_deinit(device_t dev, device_t child)
51	{
52	}
53};
54
55METHOD int alloc_msi {
56	device_t	dev;
57	device_t	child;
58	int		count;
59	int		maxcount;
60	device_t	*pic;
61	struct intr_irqsrc **srcs;
62};
63
64METHOD int release_msi {
65	device_t	dev;
66	device_t	child;
67	int		count;
68	struct intr_irqsrc **srcs;
69};
70
71METHOD int alloc_msix {
72	device_t	dev;
73	device_t	child;
74	device_t	*pic;
75	struct intr_irqsrc **src;
76};
77
78METHOD int release_msix {
79	device_t	dev;
80	device_t	child;
81	struct intr_irqsrc *src;
82};
83
84METHOD int map_msi {
85	device_t	dev;
86	device_t	child;
87	struct intr_irqsrc *src;
88	uint64_t	*addr;
89	uint32_t	*data;
90};
91
92METHOD int iommu_init {
93	device_t	dev;
94	device_t	child;
95	struct iommu_domain **domain;
96} DEFAULT iommu_init;
97
98METHOD void iommu_deinit {
99	device_t	dev;
100	device_t	child;
101} DEFAULT iommu_deinit;
102