xref: /freebsd/sys/dev/agp/agp_if.m (revision 0957b409)
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
31#
32# The AGP interface is used internally to the agp driver to isolate the
33# differences between various AGP chipsets into chipset mini drivers. It
34# should not be used outside the AGP driver. The kernel api for accessing
35# AGP functionality is described in <dev/agp/agpvar.h>
36#
37INTERFACE agp;
38
39CODE {
40	static int
41	null_agp_chipset_flush(device_t dev)
42	{
43		return (ENXIO);
44	}
45};
46
47#
48# Return the current aperture size.
49#
50METHOD u_int32_t get_aperture {
51	device_t	dev;
52};
53
54#
55# Set the size of the aperture. Return EINVAL on error or 0 on success.
56#
57METHOD int set_aperture {
58	device_t	dev;
59	u_int32_t	aperture;
60};
61
62#
63# Bind a single page in the AGP aperture to a given physical address.
64# The offset is a byte offset within the aperture which must be
65# aligned to an AGP page boundary.
66#
67METHOD int bind_page {
68	device_t	dev;
69	vm_offset_t	offset;
70	vm_offset_t	physical;
71};
72
73#
74# Unbind a single page in the AGP aperture.
75#
76METHOD int unbind_page {
77	device_t	dev;
78	vm_offset_t	offset;
79};
80
81#
82# Flush the GATT TLB. This is used after a call to bind_page to
83# ensure that any mappings cached in the chipset are discarded.
84#
85METHOD void flush_tlb {
86	device_t	dev;
87};
88
89#
90# Enable the agp hardware with the relavent mode. The mode bits are
91# defined in <dev/agp/agpreg.h>
92#
93METHOD int enable {
94	device_t	dev;
95	u_int32_t	mode;
96};
97
98#
99# Allocate memory of a given type. The type is a chipset-specific
100# code which is used by certain integrated agp graphics chips
101# (basically just the i810 for now) to access special features of
102# the chipset. An opaque handle representing the memory region is
103# returned and can be used as an argument to free_memory, bind_memory
104# and unbind_memory.
105#
106# The size is specified in bytes but must be a multiple of the AGP
107# page size.
108#
109METHOD struct agp_memory * alloc_memory {
110	device_t	dev;
111	int		type;
112	vm_size_t	size;
113};
114
115#
116# Free a memory region previously allocated with alloc_memory. Return
117# EBUSY if the memory is bound.
118#
119METHOD int free_memory {
120	device_t	dev;
121	struct agp_memory *mem;
122};
123
124#
125# Bind a memory region to a specific byte offset within the chipset's
126# AGP aperture. This effectively defines a range of contiguous
127# physical address which alias the (possibly uncontiguous) pages in
128# the memory region.
129#
130METHOD int bind_memory {
131	device_t	dev;
132	struct agp_memory *mem;
133	vm_offset_t	offset;
134};
135
136#
137# Unbind a memory region bound with bind_memory.
138#
139METHOD int unbind_memory {
140	device_t	dev;
141	struct agp_memory *handle;
142};
143
144METHOD int chipset_flush {
145	device_t	dev;
146} DEFAULT null_agp_chipset_flush;
147