agpvar.h revision 1.3.2.3 1 1.3.2.3 nathanw /* $NetBSD: agpvar.h,v 1.3.2.3 2001/10/08 20:11:10 nathanw Exp $ */
2 1.3.2.2 nathanw
3 1.3.2.2 nathanw /*-
4 1.3.2.2 nathanw * Copyright (c) 2000 Doug Rabson
5 1.3.2.2 nathanw * All rights reserved.
6 1.3.2.2 nathanw *
7 1.3.2.2 nathanw * Redistribution and use in source and binary forms, with or without
8 1.3.2.2 nathanw * modification, are permitted provided that the following conditions
9 1.3.2.2 nathanw * are met:
10 1.3.2.2 nathanw * 1. Redistributions of source code must retain the above copyright
11 1.3.2.2 nathanw * notice, this list of conditions and the following disclaimer.
12 1.3.2.2 nathanw * 2. Redistributions in binary form must reproduce the above copyright
13 1.3.2.2 nathanw * notice, this list of conditions and the following disclaimer in the
14 1.3.2.2 nathanw * documentation and/or other materials provided with the distribution.
15 1.3.2.2 nathanw *
16 1.3.2.2 nathanw * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 1.3.2.2 nathanw * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 1.3.2.2 nathanw * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 1.3.2.2 nathanw * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 1.3.2.2 nathanw * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 1.3.2.2 nathanw * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 1.3.2.2 nathanw * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 1.3.2.2 nathanw * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 1.3.2.2 nathanw * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 1.3.2.2 nathanw * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 1.3.2.2 nathanw * SUCH DAMAGE.
27 1.3.2.2 nathanw *
28 1.3.2.2 nathanw * $FreeBSD: src/sys/pci/agppriv.h,v 1.3 2000/07/12 10:13:04 dfr Exp $
29 1.3.2.2 nathanw */
30 1.3.2.2 nathanw
31 1.3.2.2 nathanw #ifndef _PCI_AGPVAR_H_
32 1.3.2.2 nathanw #define _PCI_AGPVAR_H_
33 1.3.2.2 nathanw
34 1.3.2.2 nathanw #include <sys/lock.h>
35 1.3.2.2 nathanw
36 1.3.2.2 nathanw struct agpbus_attach_args {
37 1.3.2.2 nathanw char *apa_busname;
38 1.3.2.2 nathanw struct pci_attach_args apa_pci_args;
39 1.3.2.2 nathanw };
40 1.3.2.2 nathanw
41 1.3.2.2 nathanw /*
42 1.3.2.2 nathanw * The AGP chipset can be acquired by user or kernel code. If the
43 1.3.2.2 nathanw * chipset has already been acquired, it cannot be acquired by another
44 1.3.2.2 nathanw * user until the previous user has released it.
45 1.3.2.2 nathanw */
46 1.3.2.2 nathanw enum agp_acquire_state {
47 1.3.2.2 nathanw AGP_ACQUIRE_FREE,
48 1.3.2.2 nathanw AGP_ACQUIRE_USER,
49 1.3.2.2 nathanw AGP_ACQUIRE_KERNEL
50 1.3.2.2 nathanw };
51 1.3.2.2 nathanw
52 1.3.2.2 nathanw /*
53 1.3.2.2 nathanw * This structure is used to query the state of the AGP system.
54 1.3.2.2 nathanw */
55 1.3.2.2 nathanw struct agp_info {
56 1.3.2.2 nathanw u_int32_t ai_mode;
57 1.3.2.2 nathanw bus_addr_t ai_aperture_base;
58 1.3.2.2 nathanw bus_size_t ai_aperture_size;
59 1.3.2.2 nathanw vsize_t ai_memory_allowed;
60 1.3.2.2 nathanw vsize_t ai_memory_used;
61 1.3.2.2 nathanw u_int32_t ai_devid;
62 1.3.2.2 nathanw };
63 1.3.2.2 nathanw
64 1.3.2.2 nathanw struct agp_memory_info {
65 1.3.2.2 nathanw vsize_t ami_size; /* size in bytes */
66 1.3.2.2 nathanw bus_addr_t ami_physical; /* bogus hack for i810 */
67 1.3.2.2 nathanw off_t ami_offset; /* page offset if bound */
68 1.3.2.2 nathanw int ami_is_bound; /* non-zero if bound */
69 1.3.2.2 nathanw };
70 1.3.2.2 nathanw
71 1.3.2.2 nathanw #define AGP_DEBUGxx
72 1.3.2.2 nathanw
73 1.3.2.2 nathanw #ifdef AGP_DEBUG
74 1.3.2.2 nathanw #define AGP_DPF(x...) do { \
75 1.3.2.2 nathanw printf("agp: "); \
76 1.3.2.2 nathanw printf(##x); \
77 1.3.2.2 nathanw } while (0)
78 1.3.2.2 nathanw #else
79 1.3.2.2 nathanw #define AGP_DPF(x...) do {} while (0)
80 1.3.2.2 nathanw #endif
81 1.3.2.2 nathanw
82 1.3.2.2 nathanw #define AGPUNIT(x) minor(x)
83 1.3.2.2 nathanw
84 1.3.2.2 nathanw /*
85 1.3.2.2 nathanw * Data structure to describe an AGP memory allocation.
86 1.3.2.2 nathanw */
87 1.3.2.2 nathanw TAILQ_HEAD(agp_memory_list, agp_memory);
88 1.3.2.2 nathanw struct agp_memory {
89 1.3.2.2 nathanw TAILQ_ENTRY(agp_memory) am_link; /* wiring for the tailq */
90 1.3.2.2 nathanw int am_id; /* unique id for block */
91 1.3.2.2 nathanw vsize_t am_size; /* number of bytes allocated */
92 1.3.2.2 nathanw int am_type; /* chipset specific type */
93 1.3.2.2 nathanw off_t am_offset; /* page offset if bound */
94 1.3.2.2 nathanw int am_is_bound; /* non-zero if bound */
95 1.3.2.2 nathanw bus_addr_t am_physical;
96 1.3.2.2 nathanw caddr_t am_virtual;
97 1.3.2.2 nathanw bus_dmamap_t am_dmamap;
98 1.3.2.2 nathanw bus_dma_segment_t *am_dmaseg;
99 1.3.2.2 nathanw int am_nseg;
100 1.3.2.2 nathanw };
101 1.3.2.2 nathanw
102 1.3.2.2 nathanw struct agp_softc;
103 1.3.2.2 nathanw
104 1.3.2.2 nathanw struct agp_methods {
105 1.3.2.2 nathanw u_int32_t (*get_aperture)(struct agp_softc *);
106 1.3.2.2 nathanw int (*set_aperture)(struct agp_softc *, u_int32_t);
107 1.3.2.2 nathanw int (*bind_page)(struct agp_softc *, off_t, bus_addr_t);
108 1.3.2.2 nathanw int (*unbind_page)(struct agp_softc *, off_t);
109 1.3.2.2 nathanw void (*flush_tlb)(struct agp_softc *);
110 1.3.2.2 nathanw int (*enable)(struct agp_softc *, u_int32_t mode);
111 1.3.2.2 nathanw struct agp_memory *(*alloc_memory)(struct agp_softc *, int, vsize_t);
112 1.3.2.2 nathanw int (*free_memory)(struct agp_softc *, struct agp_memory *);
113 1.3.2.2 nathanw int (*bind_memory)(struct agp_softc *, struct agp_memory *, off_t);
114 1.3.2.2 nathanw int (*unbind_memory)(struct agp_softc *, struct agp_memory *);
115 1.3.2.2 nathanw };
116 1.3.2.2 nathanw
117 1.3.2.2 nathanw #define AGP_GET_APERTURE(sc) ((sc)->as_methods->get_aperture(sc))
118 1.3.2.2 nathanw #define AGP_SET_APERTURE(sc,a) ((sc)->as_methods->set_aperture((sc),(a)))
119 1.3.2.2 nathanw #define AGP_BIND_PAGE(sc,o,p) ((sc)->as_methods->bind_page((sc),(o),(p)))
120 1.3.2.2 nathanw #define AGP_UNBIND_PAGE(sc,o) ((sc)->as_methods->unbind_page((sc), (o)))
121 1.3.2.2 nathanw #define AGP_FLUSH_TLB(sc) ((sc)->as_methods->flush_tlb(sc))
122 1.3.2.2 nathanw #define AGP_ENABLE(sc,m) ((sc)->as_methods->enable((sc),(m)))
123 1.3.2.2 nathanw #define AGP_ALLOC_MEMORY(sc,t,s) ((sc)->as_methods->alloc_memory((sc),(t),(s)))
124 1.3.2.2 nathanw #define AGP_FREE_MEMORY(sc,m) ((sc)->as_methods->free_memory((sc),(m)))
125 1.3.2.2 nathanw #define AGP_BIND_MEMORY(sc,m,o) ((sc)->as_methods->bind_memory((sc),(m),(o)))
126 1.3.2.2 nathanw #define AGP_UNBIND_MEMORY(sc,m) ((sc)->as_methods->unbind_memory((sc),(m)))
127 1.3.2.2 nathanw
128 1.3.2.2 nathanw /*
129 1.3.2.2 nathanw * All chipset drivers must have this at the start of their softc.
130 1.3.2.2 nathanw */
131 1.3.2.2 nathanw struct agp_softc {
132 1.3.2.2 nathanw struct device as_dev;
133 1.3.2.2 nathanw bus_space_tag_t as_apt;
134 1.3.2.2 nathanw int as_capoff;
135 1.3.2.2 nathanw bus_addr_t as_apaddr;
136 1.3.2.2 nathanw bus_size_t as_apsize;
137 1.3.2.3 nathanw int as_apflags;
138 1.3.2.2 nathanw bus_dma_tag_t as_dmat;
139 1.3.2.2 nathanw u_int32_t as_maxmem; /* allocation upper bound */
140 1.3.2.2 nathanw u_int32_t as_allocated; /* amount allocated */
141 1.3.2.2 nathanw enum agp_acquire_state as_state;
142 1.3.2.2 nathanw struct agp_memory_list as_memory; /* list of allocated memory */
143 1.3.2.2 nathanw int as_nextid; /* next memory block id */
144 1.3.2.2 nathanw int as_isopen; /* user device is open */
145 1.3.2.2 nathanw #if 0
146 1.3.2.2 nathanw dev_t as_devnode; /* from make_dev */
147 1.3.2.2 nathanw #endif
148 1.3.2.2 nathanw struct lock as_lock; /* lock for access to GATT */
149 1.3.2.2 nathanw struct agp_methods *as_methods; /* chipset-dependent API */
150 1.3.2.2 nathanw void *as_chipc; /* chipset-dependent state */
151 1.3.2.2 nathanw pci_chipset_tag_t as_pc;
152 1.3.2.2 nathanw pcitag_t as_tag;
153 1.3.2.2 nathanw pcireg_t as_id;
154 1.3.2.2 nathanw };
155 1.3.2.2 nathanw
156 1.3.2.2 nathanw struct agp_gatt {
157 1.3.2.2 nathanw u_int32_t ag_entries;
158 1.3.2.2 nathanw u_int32_t *ag_virtual;
159 1.3.2.2 nathanw bus_addr_t ag_physical;
160 1.3.2.2 nathanw bus_dmamap_t ag_dmamap;
161 1.3.2.2 nathanw bus_dma_segment_t ag_dmaseg;
162 1.3.2.2 nathanw size_t ag_size;
163 1.3.2.2 nathanw };
164 1.3.2.2 nathanw
165 1.3.2.2 nathanw /*
166 1.3.2.2 nathanw * Functions private to the AGP code.
167 1.3.2.2 nathanw */
168 1.3.2.2 nathanw void agp_flush_cache(void);
169 1.3.2.2 nathanw int agp_find_caps(pci_chipset_tag_t pct, pcitag_t pt);
170 1.3.2.2 nathanw int agp_map_aperture(struct pci_attach_args *pa, struct agp_softc *sc);
171 1.3.2.2 nathanw struct agp_gatt *agp_alloc_gatt(struct agp_softc *sc);
172 1.3.2.2 nathanw void agp_free_gatt(struct agp_softc *sc, struct agp_gatt *gatt);
173 1.3.2.2 nathanw int agp_generic_attach(struct agp_softc *sc);
174 1.3.2.2 nathanw int agp_generic_detach(struct agp_softc *sc);
175 1.3.2.2 nathanw int agp_generic_enable(struct agp_softc *sc, u_int32_t mode);
176 1.3.2.2 nathanw struct agp_memory *agp_generic_alloc_memory(struct agp_softc *sc, int type,
177 1.3.2.2 nathanw vsize_t size);
178 1.3.2.2 nathanw int agp_generic_free_memory(struct agp_softc *sc, struct agp_memory *mem);
179 1.3.2.2 nathanw int agp_generic_bind_memory(struct agp_softc *sc, struct agp_memory *mem,
180 1.3.2.2 nathanw off_t offset);
181 1.3.2.2 nathanw int agp_generic_unbind_memory(struct agp_softc *sc, struct agp_memory *mem);
182 1.3.2.2 nathanw
183 1.3.2.2 nathanw /* The vendor has already been matched when these functions are called */
184 1.3.2.2 nathanw int agp_amd_match(const struct pci_attach_args *);
185 1.3.2.2 nathanw
186 1.3.2.2 nathanw int agp_ali_attach(struct device *parent, struct device *self, void *aux);
187 1.3.2.2 nathanw int agp_amd_attach(struct device *parent, struct device *self, void *aux);
188 1.3.2.2 nathanw int agp_i810_attach(struct device *parent, struct device *self, void *aux);
189 1.3.2.2 nathanw int agp_intel_attach(struct device *parent, struct device *self, void *aux);
190 1.3.2.2 nathanw int agp_via_attach(struct device *parent, struct device *self, void *aux);
191 1.3.2.2 nathanw int agp_sis_attach(struct device *parent, struct device *self, void *aux);
192 1.3.2.2 nathanw
193 1.3.2.2 nathanw int agp_alloc_dmamem(bus_dma_tag_t, size_t, int, bus_dmamap_t *, caddr_t *,
194 1.3.2.2 nathanw bus_addr_t *, bus_dma_segment_t *, int, int *);
195 1.3.2.2 nathanw void agp_free_dmamem(bus_dma_tag_t tag, size_t size, bus_dmamap_t map,
196 1.3.2.2 nathanw caddr_t vaddr, bus_dma_segment_t *seg, int nseg) ;
197 1.3.2.2 nathanw
198 1.3.2.2 nathanw /*
199 1.3.2.2 nathanw * Kernel API
200 1.3.2.2 nathanw */
201 1.3.2.2 nathanw /*
202 1.3.2.2 nathanw * Find the AGP device and return it.
203 1.3.2.2 nathanw */
204 1.3.2.2 nathanw void *agp_find_device(int);
205 1.3.2.2 nathanw
206 1.3.2.2 nathanw /*
207 1.3.2.2 nathanw * Return the current owner of the AGP chipset.
208 1.3.2.2 nathanw */
209 1.3.2.2 nathanw enum agp_acquire_state agp_state(void *devcookie);
210 1.3.2.2 nathanw
211 1.3.2.2 nathanw /*
212 1.3.2.2 nathanw * Query the state of the AGP system.
213 1.3.2.2 nathanw */
214 1.3.2.2 nathanw void agp_get_info(void *devhandle, struct agp_info *info);
215 1.3.2.2 nathanw
216 1.3.2.2 nathanw /*
217 1.3.2.2 nathanw * Acquire the AGP chipset for use by the kernel. Returns EBUSY if the
218 1.3.2.2 nathanw * AGP chipset is already acquired by another user.
219 1.3.2.2 nathanw */
220 1.3.2.2 nathanw int agp_acquire(void *devhandle);
221 1.3.2.2 nathanw
222 1.3.2.2 nathanw /*
223 1.3.2.2 nathanw * Release the AGP chipset.
224 1.3.2.2 nathanw */
225 1.3.2.2 nathanw int agp_release(void *devhandle);
226 1.3.2.2 nathanw
227 1.3.2.2 nathanw /*
228 1.3.2.2 nathanw * Enable the agp hardware with the relavent mode. The mode bits are
229 1.3.2.2 nathanw * defined in <dev/pci/agpreg.h>
230 1.3.2.2 nathanw */
231 1.3.2.2 nathanw int agp_enable(void *devhandle, u_int32_t mode);
232 1.3.2.2 nathanw
233 1.3.2.2 nathanw /*
234 1.3.2.2 nathanw * Allocate physical memory suitable for mapping into the AGP
235 1.3.2.2 nathanw * aperture. The value returned is an opaque handle which can be
236 1.3.2.2 nathanw * passed to agp_bind(), agp_unbind() or agp_deallocate().
237 1.3.2.2 nathanw */
238 1.3.2.2 nathanw void *agp_alloc_memory(void *devhandle, int type, vsize_t bytes);
239 1.3.2.2 nathanw
240 1.3.2.2 nathanw /*
241 1.3.2.2 nathanw * Free memory which was allocated with agp_allocate().
242 1.3.2.2 nathanw */
243 1.3.2.2 nathanw void agp_free_memory(void *devhandle, void *handle);
244 1.3.2.2 nathanw
245 1.3.2.2 nathanw /*
246 1.3.2.2 nathanw * Bind memory allocated with agp_allocate() at a given offset within
247 1.3.2.2 nathanw * the AGP aperture. Returns EINVAL if the memory is already bound or
248 1.3.2.2 nathanw * the offset is not at an AGP page boundary.
249 1.3.2.2 nathanw */
250 1.3.2.2 nathanw int agp_bind_memory(void *devhandle, void *handle, off_t offset);
251 1.3.2.2 nathanw
252 1.3.2.2 nathanw /*
253 1.3.2.2 nathanw * Unbind memory from the AGP aperture. Returns EINVAL if the memory
254 1.3.2.2 nathanw * is not bound.
255 1.3.2.2 nathanw */
256 1.3.2.2 nathanw int agp_unbind_memory(void *devhandle, void *handle);
257 1.3.2.2 nathanw
258 1.3.2.2 nathanw /*
259 1.3.2.2 nathanw * Retrieve information about a memory block allocated with
260 1.3.2.2 nathanw * agp_alloc_memory().
261 1.3.2.2 nathanw */
262 1.3.2.2 nathanw void agp_memory_info(void *devhandle, void *handle, struct agp_memory_info *mi);
263 1.3.2.2 nathanw
264 1.3.2.2 nathanw #endif /* !_PCI_AGPPRIV_H_ */
265