xref: /freebsd/sys/dev/uart/uart_cpu_arm64.c (revision 3416500aef140042c64bc149cb1ec6620483bc44)
1 /*-
2  * Copyright (c) 2016 The FreeBSD Foundation
3  * All rights reserved.
4  *
5  * This software was developed by Andrew Turner under sponsorship from
6  * the FreeBSD Foundation.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #include "opt_acpi.h"
31 #include "opt_platform.h"
32 
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
35 
36 #include <sys/param.h>
37 #include <sys/bus.h>
38 #include <sys/kernel.h>
39 #include <sys/module.h>
40 #include <sys/systm.h>
41 
42 #include <vm/vm.h>
43 #include <vm/pmap.h>
44 
45 #include <machine/bus.h>
46 
47 #include <dev/uart/uart.h>
48 #include <dev/uart/uart_bus.h>
49 #include <dev/uart/uart_cpu.h>
50 
51 #ifdef DEV_ACPI
52 #include <contrib/dev/acpica/include/acpi.h>
53 #include <contrib/dev/acpica/include/accommon.h>
54 #include <contrib/dev/acpica/include/actables.h>
55 #include <dev/uart/uart_cpu_acpi.h>
56 #endif
57 
58 #ifdef FDT
59 #include <dev/fdt/fdt_common.h>
60 #include <dev/ofw/ofw_bus.h>
61 #include <dev/ofw/ofw_bus_subr.h>
62 #include <dev/uart/uart_cpu_fdt.h>
63 #endif
64 
65 /*
66  * UART console routines.
67  */
68 bus_space_tag_t uart_bus_space_io;
69 bus_space_tag_t uart_bus_space_mem;
70 
71 int
72 uart_cpu_eqres(struct uart_bas *b1, struct uart_bas *b2)
73 {
74 
75 	if (pmap_kextract(b1->bsh) == 0)
76 		return (0);
77 	if (pmap_kextract(b2->bsh) == 0)
78 		return (0);
79 	return ((pmap_kextract(b1->bsh) == pmap_kextract(b2->bsh)) ? 1 : 0);
80 }
81 
82 #ifdef DEV_ACPI
83 static struct acpi_uart_compat_data *
84 uart_cpu_acpi_scan(uint8_t interface_type)
85 {
86 	struct acpi_uart_compat_data **cd;
87 
88 	SET_FOREACH(cd, uart_acpi_class_and_device_set) {
89 		if ((*cd)->port_subtype == interface_type)
90 			return (*cd);
91 	}
92 
93 	SET_FOREACH(cd, uart_acpi_class_set) {
94 		if ((*cd)->port_subtype == interface_type)
95 			return (*cd);
96 	}
97 
98 	return (NULL);
99 }
100 
101 static int
102 uart_cpu_acpi_probe(struct uart_class **classp, bus_space_tag_t *bst,
103     bus_space_handle_t *bsh, int *baud, u_int *rclk, u_int *shiftp)
104 {
105 	struct acpi_uart_compat_data *cd;
106 	ACPI_TABLE_SPCR *spcr;
107 	vm_paddr_t spcr_physaddr;
108 	int err;
109 
110 	err = ENXIO;
111 	spcr_physaddr = acpi_find_table(ACPI_SIG_SPCR);
112 	if (spcr_physaddr == 0)
113 		return (ENXIO);
114 
115 	spcr = acpi_map_table(spcr_physaddr, ACPI_SIG_SPCR);
116 
117 	cd = uart_cpu_acpi_scan(spcr->InterfaceType);
118 	if (cd == NULL)
119 		goto out;
120 
121 	switch(spcr->BaudRate) {
122 	case 3:
123 		*baud = 9600;
124 		break;
125 	case 4:
126 		*baud = 19200;
127 		break;
128 	case 6:
129 		*baud = 57600;
130 		break;
131 	case 7:
132 		*baud = 115200;
133 		break;
134 	default:
135 		goto out;
136 	}
137 
138 	err = acpi_map_addr(&spcr->SerialPort, bst, bsh, PAGE_SIZE);
139 	if (err != 0)
140 		goto out;
141 
142 	*classp = cd->clas;
143 	*rclk = 0;
144 	*shiftp = 2;
145 
146 out:
147 	acpi_unmap_table(spcr);
148 	return (err);
149 }
150 #endif
151 
152 int
153 uart_cpu_getdev(int devtype, struct uart_devinfo *di)
154 {
155 	struct uart_class *class;
156 	bus_space_handle_t bsh;
157 	bus_space_tag_t bst;
158 	u_int rclk, shift, iowidth;
159 	int br, err;
160 
161 	/* Allow overriding the FDT using the environment. */
162 	class = &uart_ns8250_class;
163 	err = uart_getenv(devtype, di, class);
164 	if (err == 0)
165 		return (0);
166 
167 	if (devtype != UART_DEV_CONSOLE)
168 		return (ENXIO);
169 
170 	err = ENXIO;
171 #ifdef DEV_ACPI
172 	err = uart_cpu_acpi_probe(&class, &bst, &bsh, &br, &rclk, &shift);
173 #endif
174 #ifdef FDT
175 	if (err != 0) {
176 		err = uart_cpu_fdt_probe(&class, &bst, &bsh, &br, &rclk,
177 		    &shift, &iowidth);
178 	}
179 #endif
180 	if (err != 0)
181 		return (err);
182 
183 	/*
184 	 * Finalize configuration.
185 	 */
186 	di->bas.chan = 0;
187 	di->bas.regshft = shift;
188 	di->bas.regiowidth = iowidth;
189 	di->baudrate = br;
190 	di->bas.rclk = rclk;
191 	di->ops = uart_getops(class);
192 	di->databits = 8;
193 	di->stopbits = 1;
194 	di->parity = UART_PARITY_NONE;
195 	di->bas.bst = bst;
196 	di->bas.bsh = bsh;
197 	uart_bus_space_mem = di->bas.bst;
198 	uart_bus_space_io = NULL;
199 
200 	return (0);
201 }
202