xref: /freebsd/sys/dev/agp/agp_ati.c (revision 4f29da19bd44f0e99f021510460a81bf754c21d2)
1 /*-
2  * Copyright (c) 2005 Eric Anholt
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  * Based on reading the Linux 2.6.8.1 driver by Dave Jones.
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include "opt_bus.h"
33 
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/malloc.h>
37 #include <sys/kernel.h>
38 #include <sys/module.h>
39 #include <sys/bus.h>
40 #include <sys/lock.h>
41 #include <sys/mutex.h>
42 #include <sys/proc.h>
43 
44 #include <dev/pci/pcivar.h>
45 #include <dev/pci/pcireg.h>
46 #include <pci/agppriv.h>
47 #include <pci/agpreg.h>
48 
49 #include <vm/vm.h>
50 #include <vm/vm_object.h>
51 #include <vm/pmap.h>
52 #include <machine/bus.h>
53 #include <machine/resource.h>
54 #include <sys/rman.h>
55 
56 MALLOC_DECLARE(M_AGP);
57 
58 #define READ4(off)	bus_space_read_4(sc->bst, sc->bsh, off)
59 #define WRITE4(off,v)	bus_space_write_4(sc->bst, sc->bsh, off, v)
60 
61 struct agp_ati_softc {
62 	struct agp_softc agp;
63 	struct resource *regs;	/* memory mapped control registers */
64 	bus_space_tag_t bst;	/* bus_space tag */
65 	bus_space_handle_t bsh;	/* bus_space handle */
66 	u_int32_t	initial_aperture; /* aperture size at startup */
67 	char		is_rs300;
68 
69 	/* The GATT */
70 	u_int32_t	ag_entries;
71 	u_int32_t      *ag_virtual;	/* virtual address of gatt */
72 	u_int32_t      *ag_vdir;	/* virtual address of page dir */
73 	vm_offset_t	ag_pdir;	/* physical address of page dir */
74 };
75 
76 
77 static const char*
78 agp_ati_match(device_t dev)
79 {
80 	if (pci_get_class(dev) != PCIC_BRIDGE ||
81 	    pci_get_subclass(dev) != PCIS_BRIDGE_HOST)
82 		return NULL;
83 
84 	if (agp_find_caps(dev) == 0)
85 		return NULL;
86 
87 	switch (pci_get_devid(dev)) {
88 	case 0xcab01002:
89 		return ("ATI RS100 AGP bridge");
90 	case 0xcab21002:
91 		return ("ATI RS200 AGP bridge");
92 	case 0xcab31002:
93 		return ("ATI RS250 AGP bridge");
94 	case 0x58301002:
95 		return ("ATI RS300_100 AGP bridge");
96 	case 0x58311002:
97 		return ("ATI RS300_133 AGP bridge");
98 	case 0x58321002:
99 		return ("ATI RS300_166 AGP bridge");
100 	case 0x58331002:
101 		return ("ATI RS300_200 AGP bridge");
102 	};
103 
104 	return NULL;
105 }
106 
107 static int
108 agp_ati_probe(device_t dev)
109 {
110 	const char *desc;
111 
112 	desc = agp_ati_match(dev);
113 	if (desc) {
114 		device_set_desc(dev, desc);
115 		return 0;
116 	}
117 
118 	return ENXIO;
119 }
120 
121 static int
122 agp_ati_alloc_gatt(device_t dev)
123 {
124 	struct agp_ati_softc *sc = device_get_softc(dev);
125 	u_int32_t apsize = AGP_GET_APERTURE(dev);
126 	u_int32_t entries = apsize >> AGP_PAGE_SHIFT;
127 	u_int32_t apbase_offset;
128 	int i;
129 
130 	/* Alloc the GATT -- pointers to pages of AGP memory */
131 	sc->ag_entries = entries;
132 	sc->ag_virtual = malloc(entries * sizeof(u_int32_t), M_AGP,
133 	    M_NOWAIT | M_ZERO);
134 	if (sc->ag_virtual == NULL) {
135 		if (bootverbose)
136 			device_printf(dev, "aperture allocation failed\n");
137 		return ENOMEM;
138 	}
139 
140 	/* Alloc the page directory -- pointers to each page of the GATT */
141 	sc->ag_vdir = malloc(AGP_PAGE_SIZE, M_AGP, M_NOWAIT | M_ZERO);
142 	if (sc->ag_vdir == NULL) {
143 		if (bootverbose)
144 			device_printf(dev, "pagedir allocation failed\n");
145 		free(sc->ag_virtual, M_AGP);
146 		return ENOMEM;
147 	}
148 	sc->ag_pdir = vtophys((vm_offset_t)sc->ag_vdir);
149 
150 	apbase_offset = pci_read_config(dev, AGP_APBASE, 4) >> 22;
151 	/* Fill in the pagedir's pointers to GATT pages */
152 	for (i = 0; i < sc->ag_entries / 1024; i++) {
153 		vm_offset_t va;
154 		vm_offset_t pa;
155 
156 		va = ((vm_offset_t)sc->ag_virtual) + i * AGP_PAGE_SIZE;
157 		pa = vtophys(va);
158 		sc->ag_vdir[apbase_offset + i] = pa | 1;
159 	}
160 
161 	/*
162 	 * Make sure the chipset can see everything.
163 	 */
164 	agp_flush_cache();
165 
166 	return 0;
167 }
168 
169 
170 static int
171 agp_ati_attach(device_t dev)
172 {
173 	struct agp_ati_softc *sc = device_get_softc(dev);
174 	int error, rid;
175 	u_int32_t temp;
176 	u_int32_t apsize_reg, agpmode_reg;
177 
178 	error = agp_generic_attach(dev);
179 	if (error)
180 		return error;
181 
182 	switch (pci_get_devid(dev)) {
183 	case 0xcab01002: /* ATI RS100 AGP bridge */
184 	case 0xcab21002: /*ATI RS200 AGP bridge  */
185 	case 0xcab31002: /* ATI RS250 AGP bridge */
186 		sc->is_rs300 = 0;
187 		apsize_reg = ATI_RS100_APSIZE;
188 		agpmode_reg = ATI_RS100_IG_AGPMODE;
189 		break;
190 	case 0x58301002: /* ATI RS300_100 AGP bridge */
191 	case 0x58311002: /* ATI RS300_133 AGP bridge */
192 	case 0x58321002: /* ATI RS300_166 AGP bridge */
193 	case 0x58331002: /* ATI RS300_200 AGP bridge */
194 		sc->is_rs300 = 1;
195 		apsize_reg = ATI_RS300_APSIZE;
196 		agpmode_reg = ATI_RS300_IG_AGPMODE;
197 		break;
198 	default:
199 		/* Unknown chipset */
200 		return EINVAL;
201 	};
202 
203 	rid = ATI_GART_MMADDR;
204 	sc->regs = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
205 	if (!sc->regs) {
206 		agp_generic_detach(dev);
207 		return ENOMEM;
208 	}
209 
210 	sc->bst = rman_get_bustag(sc->regs);
211 	sc->bsh = rman_get_bushandle(sc->regs);
212 
213 	sc->initial_aperture = AGP_GET_APERTURE(dev);
214 
215 	for (;;) {
216 		if (agp_ati_alloc_gatt(dev) == 0)
217 			break;
218 
219 		/*
220 		 * Probably contigmalloc failure. Try reducing the
221 		 * aperture so that the gatt size reduces.
222 		 */
223 		if (AGP_SET_APERTURE(dev, AGP_GET_APERTURE(dev) / 2))
224 			return ENOMEM;
225 	}
226 
227 	temp = pci_read_config(dev, apsize_reg, 4);
228 	pci_write_config(dev, apsize_reg, temp | 1, 4);
229 
230 	pci_write_config(dev, agpmode_reg, 0x20000, 4);
231 
232 	WRITE4(ATI_GART_FEATURE_ID, 0x00060000);
233 
234 	temp = pci_read_config(dev, 4, 4);	/* XXX: Magic reg# */
235 	pci_write_config(dev, 4, temp | (1 << 14), 4);
236 
237 	WRITE4(ATI_GART_BASE, sc->ag_pdir);
238 
239 	AGP_FLUSH_TLB(dev);
240 
241 	return 0;
242 }
243 
244 static int
245 agp_ati_detach(device_t dev)
246 {
247 	struct agp_ati_softc *sc = device_get_softc(dev);
248 	int error;
249 	u_int32_t apsize_reg, temp;
250 
251 	if (sc->is_rs300)
252 		apsize_reg = ATI_RS300_APSIZE;
253 	else
254 		apsize_reg = ATI_RS100_APSIZE;
255 
256 	error = agp_generic_detach(dev);
257 	if (error)
258 		return error;
259 
260 	/* Clear the GATT base */
261 	WRITE4(ATI_GART_BASE, 0);
262 
263 	/* Put the aperture back the way it started. */
264 	AGP_SET_APERTURE(dev, sc->initial_aperture);
265 
266 	temp = pci_read_config(dev, apsize_reg, 4);
267 	pci_write_config(dev, apsize_reg, temp & ~1, 4);
268 
269 	free(sc->ag_vdir, M_AGP);
270 	free(sc->ag_virtual, M_AGP);
271 
272 	bus_release_resource(dev, SYS_RES_MEMORY, ATI_GART_MMADDR, sc->regs);
273 
274 	return 0;
275 }
276 
277 static u_int32_t
278 agp_ati_get_aperture(device_t dev)
279 {
280 	struct agp_ati_softc *sc = device_get_softc(dev);
281 	int size_value;
282 
283 	if (sc->is_rs300)
284 		size_value = pci_read_config(dev, ATI_RS300_APSIZE, 4);
285 	else
286 		size_value = pci_read_config(dev, ATI_RS100_APSIZE, 4);
287 
288 	size_value = (size_value & 0x0000000e) >> 1;
289 	size_value = (32 * 1024 * 1024) << size_value;
290 
291 	return size_value;
292 }
293 
294 static int
295 agp_ati_set_aperture(device_t dev, u_int32_t aperture)
296 {
297 	struct agp_ati_softc *sc = device_get_softc(dev);
298 	int size_value;
299 	u_int32_t apsize_reg;
300 
301 	if (sc->is_rs300)
302 		apsize_reg = ATI_RS300_APSIZE;
303 	else
304 		apsize_reg = ATI_RS100_APSIZE;
305 
306 	size_value = pci_read_config(dev, apsize_reg, 4);
307 
308 	size_value &= ~0x0000000e;
309 	size_value |= (ffs(aperture / (32 * 1024 * 1024)) - 1) << 1;
310 
311 	pci_write_config(dev, apsize_reg, size_value, 4);
312 
313 	return 0;
314 }
315 
316 static int
317 agp_ati_bind_page(device_t dev, int offset, vm_offset_t physical)
318 {
319 	struct agp_ati_softc *sc = device_get_softc(dev);
320 
321 	if (offset < 0 || offset >= (sc->ag_entries << AGP_PAGE_SHIFT))
322 		return EINVAL;
323 
324 	sc->ag_virtual[offset >> AGP_PAGE_SHIFT] = physical | 1;
325 
326 	return 0;
327 }
328 
329 static int
330 agp_ati_unbind_page(device_t dev, int offset)
331 {
332 	struct agp_ati_softc *sc = device_get_softc(dev);
333 
334 	if (offset < 0 || offset >= (sc->ag_entries << AGP_PAGE_SHIFT))
335 		return EINVAL;
336 
337 	sc->ag_virtual[offset >> AGP_PAGE_SHIFT] = 0;
338 	return 0;
339 }
340 
341 static void
342 agp_ati_flush_tlb(device_t dev)
343 {
344 	struct agp_ati_softc *sc = device_get_softc(dev);
345 
346 	/* Set the cache invalidate bit and wait for the chipset to clear */
347 	WRITE4(ATI_GART_CACHE_CNTRL, 1);
348 	(void)READ4(ATI_GART_CACHE_CNTRL);
349 }
350 
351 static device_method_t agp_ati_methods[] = {
352 	/* Device interface */
353 	DEVMETHOD(device_probe,		agp_ati_probe),
354 	DEVMETHOD(device_attach,	agp_ati_attach),
355 	DEVMETHOD(device_detach,	agp_ati_detach),
356 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
357 	DEVMETHOD(device_suspend,	bus_generic_suspend),
358 	DEVMETHOD(device_resume,	bus_generic_resume),
359 
360 	/* AGP interface */
361 	DEVMETHOD(agp_get_aperture,	agp_ati_get_aperture),
362 	DEVMETHOD(agp_set_aperture,	agp_ati_set_aperture),
363 	DEVMETHOD(agp_bind_page,	agp_ati_bind_page),
364 	DEVMETHOD(agp_unbind_page,	agp_ati_unbind_page),
365 	DEVMETHOD(agp_flush_tlb,	agp_ati_flush_tlb),
366 	DEVMETHOD(agp_enable,		agp_generic_enable),
367 	DEVMETHOD(agp_alloc_memory,	agp_generic_alloc_memory),
368 	DEVMETHOD(agp_free_memory,	agp_generic_free_memory),
369 	DEVMETHOD(agp_bind_memory,	agp_generic_bind_memory),
370 	DEVMETHOD(agp_unbind_memory,	agp_generic_unbind_memory),
371 
372 	{ 0, 0 }
373 };
374 
375 static driver_t agp_ati_driver = {
376 	"agp",
377 	agp_ati_methods,
378 	sizeof(struct agp_ati_softc),
379 };
380 
381 static devclass_t agp_devclass;
382 
383 DRIVER_MODULE(agp_ati, hostb, agp_ati_driver, agp_devclass, 0, 0);
384 MODULE_DEPEND(agp_ati, agp, 1, 1, 1);
385 MODULE_DEPEND(agp_ati, pci, 1, 1, 1);
386