xref: /freebsd/sys/dev/uart/uart_cpu_arm64.c (revision 52c2bb75163559a6e2866ad374a7de67a4ea1273)
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 extern struct bus_space memmap_bus;
69 bus_space_tag_t uart_bus_space_io;
70 bus_space_tag_t uart_bus_space_mem = &memmap_bus;
71 
72 int
73 uart_cpu_eqres(struct uart_bas *b1, struct uart_bas *b2)
74 {
75 
76 	if (pmap_kextract(b1->bsh) == 0)
77 		return (0);
78 	if (pmap_kextract(b2->bsh) == 0)
79 		return (0);
80 	return ((pmap_kextract(b1->bsh) == pmap_kextract(b2->bsh)) ? 1 : 0);
81 }
82 
83 #ifdef DEV_ACPI
84 static struct acpi_uart_compat_data *
85 uart_cpu_acpi_scan(uint8_t interface_type)
86 {
87 	struct acpi_uart_compat_data **cd, *curcd;
88 	int i;
89 
90 	SET_FOREACH(cd, uart_acpi_class_and_device_set) {
91 		curcd = *cd;
92 		for (i = 0; curcd[i].cd_hid != NULL; i++) {
93 			if (curcd[i].cd_port_subtype == interface_type)
94 				return (&curcd[i]);
95 		}
96 	}
97 
98 	SET_FOREACH(cd, uart_acpi_class_set) {
99 		curcd = *cd;
100 		for (i = 0; curcd[i].cd_hid != NULL; i++) {
101 			if (curcd[i].cd_port_subtype == interface_type)
102 				return (&curcd[i]);
103 		}
104 	}
105 
106 	return (NULL);
107 }
108 
109 static int
110 uart_cpu_acpi_probe(struct uart_class **classp, bus_space_tag_t *bst,
111     bus_space_handle_t *bsh, int *baud, u_int *rclk, u_int *shiftp,
112     u_int *iowidthp)
113 {
114 	struct acpi_uart_compat_data *cd;
115 	ACPI_TABLE_SPCR *spcr;
116 	vm_paddr_t spcr_physaddr;
117 	int err;
118 
119 	err = ENXIO;
120 	spcr_physaddr = acpi_find_table(ACPI_SIG_SPCR);
121 	if (spcr_physaddr == 0)
122 		return (ENXIO);
123 
124 	spcr = acpi_map_table(spcr_physaddr, ACPI_SIG_SPCR);
125 
126 	cd = uart_cpu_acpi_scan(spcr->InterfaceType);
127 	if (cd == NULL)
128 		goto out;
129 
130 	switch(spcr->BaudRate) {
131 	case 0:
132 		/*
133 		 * A BaudRate of 0 is a special value which means not to
134 		 * change the rate that's already programmed.
135 		 */
136 		*baud = 0;
137 		break;
138 	case 3:
139 		*baud = 9600;
140 		break;
141 	case 4:
142 		*baud = 19200;
143 		break;
144 	case 6:
145 		*baud = 57600;
146 		break;
147 	case 7:
148 		*baud = 115200;
149 		break;
150 	default:
151 		goto out;
152 	}
153 
154 	err = acpi_map_addr(&spcr->SerialPort, bst, bsh, PAGE_SIZE);
155 	if (err != 0)
156 		goto out;
157 
158 	*classp = cd->cd_class;
159 	*rclk = 0;
160 	*shiftp = spcr->SerialPort.AccessWidth - 1;
161 	*iowidthp = spcr->SerialPort.BitWidth / 8;
162 
163 	if ((cd->cd_quirks & UART_F_IGNORE_SPCR_REGSHFT) ==
164 	    UART_F_IGNORE_SPCR_REGSHFT) {
165 		*shiftp = cd->cd_regshft;
166 	}
167 
168 out:
169 	acpi_unmap_table(spcr);
170 	return (err);
171 }
172 #endif
173 
174 int
175 uart_cpu_getdev(int devtype, struct uart_devinfo *di)
176 {
177 	struct uart_class *class;
178 	bus_space_handle_t bsh;
179 	bus_space_tag_t bst;
180 	u_int rclk, shift, iowidth;
181 	int br, err;
182 
183 	/* Allow overriding the FDT using the environment. */
184 	class = &uart_ns8250_class;
185 	err = uart_getenv(devtype, di, class);
186 	if (err == 0)
187 		return (0);
188 
189 	if (devtype != UART_DEV_CONSOLE)
190 		return (ENXIO);
191 
192 	err = ENXIO;
193 #ifdef DEV_ACPI
194 	err = uart_cpu_acpi_probe(&class, &bst, &bsh, &br, &rclk, &shift,
195 	    &iowidth);
196 #endif
197 #ifdef FDT
198 	if (err != 0) {
199 		err = uart_cpu_fdt_probe(&class, &bst, &bsh, &br, &rclk,
200 		    &shift, &iowidth);
201 	}
202 #endif
203 	if (err != 0)
204 		return (err);
205 
206 	/*
207 	 * Finalize configuration.
208 	 */
209 	di->bas.chan = 0;
210 	di->bas.regshft = shift;
211 	di->bas.regiowidth = iowidth;
212 	di->baudrate = br;
213 	di->bas.rclk = rclk;
214 	di->ops = uart_getops(class);
215 	di->databits = 8;
216 	di->stopbits = 1;
217 	di->parity = UART_PARITY_NONE;
218 	di->bas.bst = bst;
219 	di->bas.bsh = bsh;
220 	uart_bus_space_mem = di->bas.bst;
221 	uart_bus_space_io = NULL;
222 
223 	return (0);
224 }
225