xref: /freebsd/sys/amd64/acpica/acpi_machdep.c (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2001 Mitsuru IWASAKI
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 #include <sys/param.h>
31 #include <sys/bus.h>
32 #include <sys/kernel.h>
33 #include <sys/module.h>
34 #include <sys/sysctl.h>
35 
36 #include <vm/vm.h>
37 #include <vm/pmap.h>
38 
39 #include <contrib/dev/acpica/include/acpi.h>
40 #include <contrib/dev/acpica/include/accommon.h>
41 #include <contrib/dev/acpica/include/actables.h>
42 
43 #include <dev/acpica/acpivar.h>
44 
45 #include <machine/nexusvar.h>
46 
47 int acpi_resume_beep;
48 SYSCTL_INT(_debug_acpi, OID_AUTO, resume_beep, CTLFLAG_RWTUN,
49     &acpi_resume_beep, 0, "Beep the PC speaker when resuming");
50 
51 int acpi_reset_video;
52 TUNABLE_INT("hw.acpi.reset_video", &acpi_reset_video);
53 
54 static int intr_model = ACPI_INTR_PIC;
55 
56 int
57 acpi_machdep_init(device_t dev)
58 {
59 	struct acpi_softc *sc;
60 
61 	sc = device_get_softc(dev);
62 
63 	acpi_apm_init(sc);
64 	acpi_install_wakeup_handler(sc);
65 
66 	if (intr_model != ACPI_INTR_PIC)
67 		acpi_SetIntrModel(intr_model);
68 
69 	SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx,
70 	    SYSCTL_CHILDREN(sc->acpi_sysctl_tree), OID_AUTO,
71 	    "reset_video", CTLFLAG_RW, &acpi_reset_video, 0,
72 	    "Call the VESA reset BIOS vector on the resume path");
73 
74 	return (0);
75 }
76 
77 void
78 acpi_SetDefaultIntrModel(int model)
79 {
80 
81 	intr_model = model;
82 }
83 
84 int
85 acpi_machdep_quirks(int *quirks)
86 {
87 
88 	return (0);
89 }
90 
91 /*
92  * Map a table.  First map the header to determine the table length and then map
93  * the entire table.
94  */
95 static void *
96 map_table(vm_paddr_t pa, const char *sig)
97 {
98 	ACPI_TABLE_HEADER *header;
99 	vm_size_t length;
100 	void *table;
101 
102 	header = pmap_mapbios(pa, sizeof(ACPI_TABLE_HEADER));
103 	if (strncmp(header->Signature, sig, ACPI_NAMESEG_SIZE) != 0) {
104 		pmap_unmapbios(header, sizeof(ACPI_TABLE_HEADER));
105 		return (NULL);
106 	}
107 	length = header->Length;
108 	pmap_unmapbios(header, sizeof(ACPI_TABLE_HEADER));
109 	table = pmap_mapbios(pa, length);
110 	if (ACPI_FAILURE(AcpiUtChecksum(table, length))) {
111 		if (bootverbose)
112 			printf("ACPI: Failed checksum for table %s\n", sig);
113 #if (ACPI_CHECKSUM_ABORT)
114 		pmap_unmapbios(table, length);
115 		return (NULL);
116 #endif
117 	}
118 	return (table);
119 }
120 
121 /*
122  * See if a given ACPI table is the requested table.  Returns the
123  * length of the table if it matches or zero on failure.
124  */
125 static int
126 probe_table(vm_paddr_t address, const char *sig)
127 {
128 	ACPI_TABLE_HEADER *table;
129 	int ret;
130 
131 	table = pmap_mapbios(address, sizeof(ACPI_TABLE_HEADER));
132 	ret = strncmp(table->Signature, sig, ACPI_NAMESEG_SIZE) == 0;
133 	pmap_unmapbios(table, sizeof(ACPI_TABLE_HEADER));
134 	return (ret);
135 }
136 
137 /*
138  * Try to map a table at a given physical address previously returned
139  * by acpi_find_table().
140  */
141 void *
142 acpi_map_table(vm_paddr_t pa, const char *sig)
143 {
144 
145 	return (map_table(pa, sig));
146 }
147 
148 /* Unmap a table previously mapped via acpi_map_table(). */
149 void
150 acpi_unmap_table(void *table)
151 {
152 	ACPI_TABLE_HEADER *header;
153 
154 	header = (ACPI_TABLE_HEADER *)table;
155 	pmap_unmapbios(table, header->Length);
156 }
157 
158 /*
159  * Return the physical address of the requested table or zero if one
160  * is not found.
161  */
162 vm_paddr_t
163 acpi_find_table(const char *sig)
164 {
165 	ACPI_PHYSICAL_ADDRESS rsdp_ptr;
166 	ACPI_TABLE_RSDP *rsdp;
167 	ACPI_TABLE_RSDT *rsdt;
168 	ACPI_TABLE_XSDT *xsdt;
169 	ACPI_TABLE_HEADER *table;
170 	vm_paddr_t addr;
171 	int i, count;
172 
173 	if (resource_disabled("acpi", 0))
174 		return (0);
175 
176 	/*
177 	 * Map in the RSDP.  Since ACPI uses AcpiOsMapMemory() which in turn
178 	 * calls pmap_mapbios() to find the RSDP, we assume that we can use
179 	 * pmap_mapbios() to map the RSDP.
180 	 */
181 	if ((rsdp_ptr = AcpiOsGetRootPointer()) == 0)
182 		return (0);
183 	rsdp = pmap_mapbios(rsdp_ptr, sizeof(ACPI_TABLE_RSDP));
184 	if (rsdp == NULL) {
185 		printf("ACPI: Failed to map RSDP\n");
186 		return (0);
187 	}
188 
189 	/*
190 	 * For ACPI >= 2.0, use the XSDT if it is available.
191 	 * Otherwise, use the RSDT.
192 	 */
193 	addr = 0;
194 	if (rsdp->Revision >= 2 && rsdp->XsdtPhysicalAddress != 0) {
195 		/*
196 		 * AcpiOsGetRootPointer only verifies the checksum for
197 		 * the version 1.0 portion of the RSDP.  Version 2.0 has
198 		 * an additional checksum that we verify first.
199 		 */
200 		if (AcpiUtChecksum((UINT8 *)rsdp, ACPI_RSDP_XCHECKSUM_LENGTH)) {
201 			printf("ACPI: RSDP failed extended checksum\n");
202 			pmap_unmapbios(rsdp, sizeof(ACPI_TABLE_RSDP));
203 			return (0);
204 		}
205 		xsdt = map_table(rsdp->XsdtPhysicalAddress, ACPI_SIG_XSDT);
206 		if (xsdt == NULL) {
207 			printf("ACPI: Failed to map XSDT\n");
208 			pmap_unmapbios(rsdp, sizeof(ACPI_TABLE_RSDP));
209 			return (0);
210 		}
211 		count = (xsdt->Header.Length - sizeof(ACPI_TABLE_HEADER)) /
212 		    sizeof(UINT64);
213 		for (i = 0; i < count; i++)
214 			if (probe_table(xsdt->TableOffsetEntry[i], sig)) {
215 				addr = xsdt->TableOffsetEntry[i];
216 				break;
217 			}
218 		acpi_unmap_table(xsdt);
219 	} else {
220 		rsdt = map_table(rsdp->RsdtPhysicalAddress, ACPI_SIG_RSDT);
221 		if (rsdt == NULL) {
222 			printf("ACPI: Failed to map RSDT\n");
223 			pmap_unmapbios(rsdp, sizeof(ACPI_TABLE_RSDP));
224 			return (0);
225 		}
226 		count = (rsdt->Header.Length - sizeof(ACPI_TABLE_HEADER)) /
227 		    sizeof(UINT32);
228 		for (i = 0; i < count; i++)
229 			if (probe_table(rsdt->TableOffsetEntry[i], sig)) {
230 				addr = rsdt->TableOffsetEntry[i];
231 				break;
232 			}
233 		acpi_unmap_table(rsdt);
234 	}
235 	pmap_unmapbios(rsdp, sizeof(ACPI_TABLE_RSDP));
236 	if (addr == 0)
237 		return (0);
238 
239 	/*
240 	 * Verify that we can map the full table and that its checksum is
241 	 * correct, etc.
242 	 */
243 	table = map_table(addr, sig);
244 	if (table == NULL)
245 		return (0);
246 	acpi_unmap_table(table);
247 
248 	return (addr);
249 }
250 
251 /*
252  * ACPI nexus(4) driver.
253  */
254 static int
255 nexus_acpi_probe(device_t dev)
256 {
257 	int error;
258 
259 	error = acpi_identify();
260 	if (error)
261 		return (error);
262 	device_quiet(dev);
263 	return (BUS_PROBE_DEFAULT);
264 }
265 
266 static int
267 nexus_acpi_attach(device_t dev)
268 {
269 
270 	nexus_init_resources();
271 	bus_generic_probe(dev);
272 	if (BUS_ADD_CHILD(dev, 10, "acpi", 0) == NULL)
273 		panic("failed to add acpi0 device");
274 
275 	return (bus_generic_attach(dev));
276 }
277 
278 static device_method_t nexus_acpi_methods[] = {
279 	/* Device interface */
280 	DEVMETHOD(device_probe,		nexus_acpi_probe),
281 	DEVMETHOD(device_attach,	nexus_acpi_attach),
282 	{ 0, 0 }
283 };
284 
285 DEFINE_CLASS_1(nexus, nexus_acpi_driver, nexus_acpi_methods, 1, nexus_driver);
286 
287 DRIVER_MODULE(nexus_acpi, root, nexus_acpi_driver, 0, 0);
288