1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2004, 2005 Jung-uk Kim <jkim@FreeBSD.org>
5 * All rights reserved.
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#include <sys/cdefs.h>
30__FBSDID("$FreeBSD$");
31
32#include <sys/param.h>
33#include <sys/systm.h>
34#include <sys/malloc.h>
35#include <sys/kernel.h>
36#include <sys/module.h>
37#include <sys/bus.h>
38#include <sys/lock.h>
39#include <sys/mutex.h>
40#include <sys/proc.h>
41
42#include <dev/agp/agppriv.h>
43#include <dev/agp/agpreg.h>
44#include <dev/pci/pcivar.h>
45#include <dev/pci/pcireg.h>
46
47#include <vm/vm.h>
48#include <vm/vm_object.h>
49#include <vm/pmap.h>
50#include <machine/bus.h>
51#include <machine/resource.h>
52#include <sys/rman.h>
53
54/* XXX */
55extern void pci_cfgregwrite(int, int, int, int, uint32_t, int);
56extern uint32_t pci_cfgregread(int, int, int, int, int);
57
58static void agp_amd64_apbase_fixup(device_t);
59
60static void agp_amd64_uli_init(device_t);
61static int agp_amd64_uli_set_aperture(device_t, uint32_t);
62
63static int agp_amd64_nvidia_match(uint16_t);
64static void agp_amd64_nvidia_init(device_t);
65static int agp_amd64_nvidia_set_aperture(device_t, uint32_t);
66
67static int agp_amd64_via_match(void);
68static void agp_amd64_via_init(device_t);
69static int agp_amd64_via_set_aperture(device_t, uint32_t);
70
71MALLOC_DECLARE(M_AGP);
72
73#define	AMD64_MAX_MCTRL		8
74
75struct agp_amd64_softc {
76	struct agp_softc	agp;
77	uint32_t		initial_aperture;
78	struct agp_gatt		*gatt;
79	uint32_t		apbase;
80	int			mctrl[AMD64_MAX_MCTRL];
81	int			n_mctrl;
82	int			via_agp;
83};
84
85static const char*
86agp_amd64_match(device_t dev)
87{
88	if (pci_get_class(dev) != PCIC_BRIDGE ||
89	    pci_get_subclass(dev) != PCIS_BRIDGE_HOST ||
90	    agp_find_caps(dev) == 0)
91		return (NULL);
92
93	switch (pci_get_devid(dev)) {
94	case 0x74541022:
95		return ("AMD 8151 AGP graphics tunnel");
96	case 0x07551039:
97		return ("SiS 755 host to AGP bridge");
98	case 0x07601039:
99		return ("SiS 760 host to AGP bridge");
100	case 0x168910b9:
101		return ("ULi M1689 AGP Controller");
102	case 0x00d110de:
103		if (agp_amd64_nvidia_match(0x00d2))
104			return (NULL);
105		return ("NVIDIA nForce3 AGP Controller");
106	case 0x00e110de:
107		if (agp_amd64_nvidia_match(0x00e2))
108			return (NULL);
109		return ("NVIDIA nForce3-250 AGP Controller");
110	case 0x02041106:
111		return ("VIA 8380 host to PCI bridge");
112	case 0x02381106:
113		return ("VIA 3238 host to PCI bridge");
114	case 0x02821106:
115		return ("VIA K8T800Pro host to PCI bridge");
116	case 0x31881106:
117		return ("VIA 8385 host to PCI bridge");
118	}
119
120	return (NULL);
121}
122
123static int
124agp_amd64_nvidia_match(uint16_t devid)
125{
126	/* XXX nForce3 requires secondary AGP bridge at 0:11:0. */
127	if (pci_cfgregread(0, 11, 0, PCIR_CLASS, 1) != PCIC_BRIDGE ||
128	    pci_cfgregread(0, 11, 0, PCIR_SUBCLASS, 1) != PCIS_BRIDGE_PCI ||
129	    pci_cfgregread(0, 11, 0, PCIR_VENDOR, 2) != 0x10de ||
130	    pci_cfgregread(0, 11, 0, PCIR_DEVICE, 2) != devid)
131		return (ENXIO);
132
133	return (0);
134}
135
136static int
137agp_amd64_via_match(void)
138{
139	/* XXX Some VIA bridge requires secondary AGP bridge at 0:1:0. */
140	if (pci_cfgregread(0, 1, 0, PCIR_CLASS, 1) != PCIC_BRIDGE ||
141	    pci_cfgregread(0, 1, 0, PCIR_SUBCLASS, 1) != PCIS_BRIDGE_PCI ||
142	    pci_cfgregread(0, 1, 0, PCIR_VENDOR, 2) != 0x1106 ||
143	    pci_cfgregread(0, 1, 0, PCIR_DEVICE, 2) != 0xb188 ||
144	    (pci_cfgregread(0, 1, 0, AGP_VIA_AGPSEL, 1) & 2))
145		return (0);
146
147	return (1);
148}
149
150static int
151agp_amd64_probe(device_t dev)
152{
153	const char *desc;
154
155	if (resource_disabled("agp", device_get_unit(dev)))
156		return (ENXIO);
157	if ((desc = agp_amd64_match(dev))) {
158		device_set_desc(dev, desc);
159		return (BUS_PROBE_DEFAULT);
160	}
161
162	return (ENXIO);
163}
164
165static int
166agp_amd64_attach(device_t dev)
167{
168	struct agp_amd64_softc *sc = device_get_softc(dev);
169	struct agp_gatt *gatt;
170	uint32_t devid;
171	int i, n, error;
172
173	for (i = 0, n = 0; i < PCI_SLOTMAX && n < AMD64_MAX_MCTRL; i++) {
174		devid = pci_cfgregread(0, i, 3, 0, 4);
175		if (devid == 0x11031022 || devid == 0x12031022) {
176			sc->mctrl[n] = i;
177			n++;
178		}
179	}
180	if (n == 0)
181		return (ENXIO);
182
183	sc->n_mctrl = n;
184
185	if (bootverbose)
186		device_printf(dev, "%d Miscellaneous Control unit(s) found.\n",
187		    sc->n_mctrl);
188
189	if ((error = agp_generic_attach(dev)))
190		return (error);
191
192	sc->initial_aperture = AGP_GET_APERTURE(dev);
193
194	for (;;) {
195		gatt = agp_alloc_gatt(dev);
196		if (gatt)
197			break;
198
199		/*
200		 * Probably contigmalloc failure. Try reducing the
201		 * aperture so that the gatt size reduces.
202		 */
203		if (AGP_SET_APERTURE(dev, AGP_GET_APERTURE(dev) / 2)) {
204			agp_generic_detach(dev);
205			return (ENOMEM);
206		}
207	}
208	sc->gatt = gatt;
209
210	switch (pci_get_vendor(dev)) {
211	case 0x10b9:	/* ULi */
212		agp_amd64_uli_init(dev);
213		if (agp_amd64_uli_set_aperture(dev, sc->initial_aperture))
214			return (ENXIO);
215		break;
216
217	case 0x10de:	/* nVidia */
218		agp_amd64_nvidia_init(dev);
219		if (agp_amd64_nvidia_set_aperture(dev, sc->initial_aperture))
220			return (ENXIO);
221		break;
222
223	case 0x1106:	/* VIA */
224		sc->via_agp = agp_amd64_via_match();
225		if (sc->via_agp) {
226			agp_amd64_via_init(dev);
227			if (agp_amd64_via_set_aperture(dev,
228			    sc->initial_aperture))
229				return (ENXIO);
230		}
231		break;
232	}
233
234	/* Install the gatt and enable aperture. */
235	for (i = 0; i < sc->n_mctrl; i++) {
236		pci_cfgregwrite(0, sc->mctrl[i], 3, AGP_AMD64_ATTBASE,
237		    (uint32_t)(gatt->ag_physical >> 8) & AGP_AMD64_ATTBASE_MASK,
238		    4);
239		pci_cfgregwrite(0, sc->mctrl[i], 3, AGP_AMD64_APCTRL,
240		    (pci_cfgregread(0, sc->mctrl[i], 3, AGP_AMD64_APCTRL, 4) |
241		    AGP_AMD64_APCTRL_GARTEN) &
242		    ~(AGP_AMD64_APCTRL_DISGARTCPU | AGP_AMD64_APCTRL_DISGARTIO),
243		    4);
244	}
245
246	return (0);
247}
248
249static int
250agp_amd64_detach(device_t dev)
251{
252	struct agp_amd64_softc *sc = device_get_softc(dev);
253	int i;
254
255	agp_free_cdev(dev);
256
257	for (i = 0; i < sc->n_mctrl; i++)
258		pci_cfgregwrite(0, sc->mctrl[i], 3, AGP_AMD64_APCTRL,
259		    pci_cfgregread(0, sc->mctrl[i], 3, AGP_AMD64_APCTRL, 4) &
260		    ~AGP_AMD64_APCTRL_GARTEN, 4);
261
262	AGP_SET_APERTURE(dev, sc->initial_aperture);
263	agp_free_gatt(sc->gatt);
264	agp_free_res(dev);
265
266	return (0);
267}
268
269static uint32_t agp_amd64_table[] = {
270	0x02000000,	/*   32 MB */
271	0x04000000,	/*   64 MB */
272	0x08000000,	/*  128 MB */
273	0x10000000,	/*  256 MB */
274	0x20000000,	/*  512 MB */
275	0x40000000,	/* 1024 MB */
276	0x80000000,	/* 2048 MB */
277};
278
279#define AGP_AMD64_TABLE_SIZE nitems(agp_amd64_table)
280
281static uint32_t
282agp_amd64_get_aperture(device_t dev)
283{
284	struct agp_amd64_softc *sc = device_get_softc(dev);
285	uint32_t i;
286
287	i = (pci_cfgregread(0, sc->mctrl[0], 3, AGP_AMD64_APCTRL, 4) &
288		AGP_AMD64_APCTRL_SIZE_MASK) >> 1;
289
290	if (i >= AGP_AMD64_TABLE_SIZE)
291		return (0);
292
293	return (agp_amd64_table[i]);
294}
295
296static int
297agp_amd64_set_aperture(device_t dev, uint32_t aperture)
298{
299	struct agp_amd64_softc *sc = device_get_softc(dev);
300	uint32_t i;
301	int j;
302
303	for (i = 0; i < AGP_AMD64_TABLE_SIZE; i++)
304		if (agp_amd64_table[i] == aperture)
305			break;
306	if (i >= AGP_AMD64_TABLE_SIZE)
307		return (EINVAL);
308
309	for (j = 0; j < sc->n_mctrl; j++)
310		pci_cfgregwrite(0, sc->mctrl[j], 3, AGP_AMD64_APCTRL,
311		    (pci_cfgregread(0, sc->mctrl[j], 3, AGP_AMD64_APCTRL, 4) &
312		    ~(AGP_AMD64_APCTRL_SIZE_MASK)) | (i << 1), 4);
313
314	switch (pci_get_vendor(dev)) {
315	case 0x10b9:	/* ULi */
316		return (agp_amd64_uli_set_aperture(dev, aperture));
317		break;
318
319	case 0x10de:	/* nVidia */
320		return (agp_amd64_nvidia_set_aperture(dev, aperture));
321		break;
322
323	case 0x1106:	/* VIA */
324		if (sc->via_agp)
325			return (agp_amd64_via_set_aperture(dev, aperture));
326		break;
327	}
328
329	return (0);
330}
331
332static int
333agp_amd64_bind_page(device_t dev, vm_offset_t offset, vm_offset_t physical)
334{
335	struct agp_amd64_softc *sc = device_get_softc(dev);
336
337	if (offset >= (sc->gatt->ag_entries << AGP_PAGE_SHIFT))
338		return (EINVAL);
339
340	sc->gatt->ag_virtual[offset >> AGP_PAGE_SHIFT] =
341	    (physical & 0xfffff000) | ((physical >> 28) & 0x00000ff0) | 3;
342
343	return (0);
344}
345
346static int
347agp_amd64_unbind_page(device_t dev, vm_offset_t offset)
348{
349	struct agp_amd64_softc *sc = device_get_softc(dev);
350
351	if (offset >= (sc->gatt->ag_entries << AGP_PAGE_SHIFT))
352		return (EINVAL);
353
354	sc->gatt->ag_virtual[offset >> AGP_PAGE_SHIFT] = 0;
355
356	return (0);
357}
358
359static void
360agp_amd64_flush_tlb(device_t dev)
361{
362	struct agp_amd64_softc *sc = device_get_softc(dev);
363	int i;
364
365	for (i = 0; i < sc->n_mctrl; i++)
366		pci_cfgregwrite(0, sc->mctrl[i], 3, AGP_AMD64_CACHECTRL,
367		    pci_cfgregread(0, sc->mctrl[i], 3, AGP_AMD64_CACHECTRL, 4) |
368		    AGP_AMD64_CACHECTRL_INVGART, 4);
369}
370
371static void
372agp_amd64_apbase_fixup(device_t dev)
373{
374	struct agp_amd64_softc *sc = device_get_softc(dev);
375	uint32_t apbase;
376	int i;
377
378	sc->apbase = rman_get_start(sc->agp.as_aperture);
379	apbase = (sc->apbase >> 25) & AGP_AMD64_APBASE_MASK;
380	for (i = 0; i < sc->n_mctrl; i++)
381		pci_cfgregwrite(0, sc->mctrl[i], 3,
382		    AGP_AMD64_APBASE, apbase, 4);
383}
384
385static void
386agp_amd64_uli_init(device_t dev)
387{
388	struct agp_amd64_softc *sc = device_get_softc(dev);
389
390	agp_amd64_apbase_fixup(dev);
391	pci_write_config(dev, AGP_AMD64_ULI_APBASE,
392	    (pci_read_config(dev, AGP_AMD64_ULI_APBASE, 4) & 0x0000000f) |
393	    sc->apbase, 4);
394	pci_write_config(dev, AGP_AMD64_ULI_HTT_FEATURE, sc->apbase, 4);
395}
396
397static int
398agp_amd64_uli_set_aperture(device_t dev, uint32_t aperture)
399{
400	struct agp_amd64_softc *sc = device_get_softc(dev);
401
402	switch (aperture) {
403	case 0x02000000:	/*  32 MB */
404	case 0x04000000:	/*  64 MB */
405	case 0x08000000:	/* 128 MB */
406	case 0x10000000:	/* 256 MB */
407		break;
408	default:
409		return (EINVAL);
410	}
411
412	pci_write_config(dev, AGP_AMD64_ULI_ENU_SCR,
413	    sc->apbase + aperture - 1, 4);
414
415	return (0);
416}
417
418static void
419agp_amd64_nvidia_init(device_t dev)
420{
421	struct agp_amd64_softc *sc = device_get_softc(dev);
422
423	agp_amd64_apbase_fixup(dev);
424	pci_write_config(dev, AGP_AMD64_NVIDIA_0_APBASE,
425	    (pci_read_config(dev, AGP_AMD64_NVIDIA_0_APBASE, 4) & 0x0000000f) |
426	    sc->apbase, 4);
427	pci_cfgregwrite(0, 11, 0, AGP_AMD64_NVIDIA_1_APBASE1, sc->apbase, 4);
428	pci_cfgregwrite(0, 11, 0, AGP_AMD64_NVIDIA_1_APBASE2, sc->apbase, 4);
429}
430
431static int
432agp_amd64_nvidia_set_aperture(device_t dev, uint32_t aperture)
433{
434	struct agp_amd64_softc *sc = device_get_softc(dev);
435	uint32_t apsize;
436
437	switch (aperture) {
438	case 0x02000000:	apsize = 0x0f;	break;	/*  32 MB */
439	case 0x04000000:	apsize = 0x0e;	break;	/*  64 MB */
440	case 0x08000000:	apsize = 0x0c;	break;	/* 128 MB */
441	case 0x10000000:	apsize = 0x08;	break;	/* 256 MB */
442	case 0x20000000:	apsize = 0x00;	break;	/* 512 MB */
443	default:
444		return (EINVAL);
445	}
446
447	pci_cfgregwrite(0, 11, 0, AGP_AMD64_NVIDIA_1_APSIZE,
448	    (pci_cfgregread(0, 11, 0, AGP_AMD64_NVIDIA_1_APSIZE, 4) &
449	    0xfffffff0) | apsize, 4);
450	pci_cfgregwrite(0, 11, 0, AGP_AMD64_NVIDIA_1_APLIMIT1,
451	    sc->apbase + aperture - 1, 4);
452	pci_cfgregwrite(0, 11, 0, AGP_AMD64_NVIDIA_1_APLIMIT2,
453	    sc->apbase + aperture - 1, 4);
454
455	return (0);
456}
457
458static void
459agp_amd64_via_init(device_t dev)
460{
461	struct agp_amd64_softc *sc = device_get_softc(dev);
462
463	agp_amd64_apbase_fixup(dev);
464	pci_cfgregwrite(0, 1, 0, AGP3_VIA_ATTBASE, sc->gatt->ag_physical, 4);
465	pci_cfgregwrite(0, 1, 0, AGP3_VIA_GARTCTRL,
466	    pci_cfgregread(0, 1, 0, AGP3_VIA_ATTBASE, 4) | 0x180, 4);
467}
468
469static int
470agp_amd64_via_set_aperture(device_t dev, uint32_t aperture)
471{
472	uint32_t apsize;
473
474	apsize = ((aperture - 1) >> 20) ^ 0xff;
475	if ((((apsize ^ 0xff) << 20) | ((1 << 20) - 1)) + 1 != aperture)
476		return (EINVAL);
477	pci_cfgregwrite(0, 1, 0, AGP3_VIA_APSIZE, apsize, 1);
478
479	return (0);
480}
481
482static device_method_t agp_amd64_methods[] = {
483	/* Device interface */
484	DEVMETHOD(device_probe,		agp_amd64_probe),
485	DEVMETHOD(device_attach,	agp_amd64_attach),
486	DEVMETHOD(device_detach,	agp_amd64_detach),
487	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
488	DEVMETHOD(device_suspend,	bus_generic_suspend),
489	DEVMETHOD(device_resume,	bus_generic_resume),
490
491	/* AGP interface */
492	DEVMETHOD(agp_get_aperture,	agp_amd64_get_aperture),
493	DEVMETHOD(agp_set_aperture,	agp_amd64_set_aperture),
494	DEVMETHOD(agp_bind_page,	agp_amd64_bind_page),
495	DEVMETHOD(agp_unbind_page,	agp_amd64_unbind_page),
496	DEVMETHOD(agp_flush_tlb,	agp_amd64_flush_tlb),
497	DEVMETHOD(agp_enable,		agp_generic_enable),
498	DEVMETHOD(agp_alloc_memory,	agp_generic_alloc_memory),
499	DEVMETHOD(agp_free_memory,	agp_generic_free_memory),
500	DEVMETHOD(agp_bind_memory,	agp_generic_bind_memory),
501	DEVMETHOD(agp_unbind_memory,	agp_generic_unbind_memory),
502
503	{ 0, 0 }
504};
505
506static driver_t agp_amd64_driver = {
507	"agp",
508	agp_amd64_methods,
509	sizeof(struct agp_amd64_softc),
510};
511
512static devclass_t agp_devclass;
513
514DRIVER_MODULE(agp_amd64, hostb, agp_amd64_driver, agp_devclass, 0, 0);
515MODULE_DEPEND(agp_amd64, agp, 1, 1, 1);
516MODULE_DEPEND(agp_amd64, pci, 1, 1, 1);
517