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