xref: /freebsd/sys/dev/uart/uart_bus_acpi.c (revision d5b0e70f7e04d971691517ce1304d86a1e367e2e)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2001 M. Warner Losh <imp@FreeBSD.org>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/bus.h>
33 #include <sys/conf.h>
34 #include <sys/kernel.h>
35 #include <sys/module.h>
36 #include <machine/bus.h>
37 #include <sys/rman.h>
38 #include <machine/resource.h>
39 
40 #include <dev/uart/uart.h>
41 #include <dev/uart/uart_bus.h>
42 #include <dev/uart/uart_cpu_acpi.h>
43 #include <contrib/dev/acpica/include/acpi.h>
44 #include <contrib/dev/acpica/include/accommon.h>
45 #include <dev/acpica/acpivar.h>
46 
47 static int uart_acpi_probe(device_t dev);
48 
49 static device_method_t uart_acpi_methods[] = {
50 	/* Device interface */
51 	DEVMETHOD(device_probe,		uart_acpi_probe),
52 	DEVMETHOD(device_attach,	uart_bus_attach),
53 	DEVMETHOD(device_detach,	uart_bus_detach),
54 	DEVMETHOD(device_resume,	uart_bus_resume),
55 	{ 0, 0 }
56 };
57 
58 static driver_t uart_acpi_driver = {
59 	uart_driver_name,
60 	uart_acpi_methods,
61 	sizeof(struct uart_softc),
62 };
63 
64 static struct acpi_uart_compat_data *
65 uart_acpi_find_device(device_t dev)
66 {
67 	struct acpi_uart_compat_data **cd, *cd_it;
68 	ACPI_HANDLE h;
69 
70 	if ((h = acpi_get_handle(dev)) == NULL)
71 		return (NULL);
72 
73 	SET_FOREACH(cd, uart_acpi_class_and_device_set) {
74 		for (cd_it = *cd; cd_it->cd_hid != NULL; cd_it++) {
75 			if (acpi_MatchHid(h, cd_it->cd_hid))
76 				return (cd_it);
77 		}
78 	}
79 
80 	return (NULL);
81 }
82 
83 static int
84 uart_acpi_probe(device_t dev)
85 {
86 	struct acpi_uart_compat_data *cd;
87 	struct uart_softc *sc;
88 	uint32_t rclk;
89 	ssize_t size;
90 
91 	sc = device_get_softc(dev);
92 	rclk = 0;
93 
94 	cd = uart_acpi_find_device(dev);
95 	if (cd == NULL)
96 		return (ENXIO);
97 
98 	sc->sc_class = cd->cd_class;
99 	if (cd->cd_desc != NULL)
100 		device_set_desc(dev, cd->cd_desc);
101 
102 	size = device_get_property(dev, "clock-frequency", &rclk,
103 	    sizeof(rclk), DEVICE_PROP_UINT32);
104 	if (size < 0 || rclk == 0)
105 		rclk = cd->cd_rclk;
106 
107 	return (uart_bus_probe(dev, cd->cd_regshft, cd->cd_regiowidth,
108 	    rclk, 0, 0, cd->cd_quirks));
109 }
110 
111 DRIVER_MODULE(uart, acpi, uart_acpi_driver, 0, 0);
112