xref: /freebsd/sys/dev/uart/uart_cpu_acpi.h (revision b3e7694832e81d7a904a10f525f8797b753bf0d3)
1 /*-
2  * Copyright (c) 2015 Michal Meloun
3  * Copyright (c) 2016 The FreeBSD Foundation
4  * All rights reserved.
5  *
6  * This software was developed by Andrew Turner under
7  * sponsorship from the FreeBSD Foundation.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 #ifndef _DEV_UART_CPU_ACPI_H_
32 #define _DEV_UART_CPU_ACPI_H_
33 
34 #include <sys/linker_set.h>
35 
36 struct uart_class;
37 
38 struct acpi_uart_compat_data {
39 	const char *cd_hid;
40 	struct uart_class *cd_class;
41 
42 	uint16_t cd_port_subtype;
43 	int cd_regshft;
44 	int cd_regiowidth;
45 	int cd_rclk;
46 	int cd_quirks;
47 	const char *cd_desc;
48 };
49 
50 /*
51  * If your UART driver implements only uart_class and uses uart_cpu_acpi.c
52  * for device instantiation, then use UART_ACPI_CLASS_AND_DEVICE for its
53  * declaration
54  */
55 SET_DECLARE(uart_acpi_class_and_device_set, struct acpi_uart_compat_data);
56 #define UART_ACPI_CLASS_AND_DEVICE(data)				\
57 	DATA_SET(uart_acpi_class_and_device_set, data)
58 
59 /*
60  * If your UART driver implements uart_class and custom device layer,
61  * then use UART_ACPI_CLASS for its declaration
62  */
63 SET_DECLARE(uart_acpi_class_set, struct acpi_uart_compat_data);
64 #define UART_ACPI_CLASS(data)				\
65 	DATA_SET(uart_acpi_class_set, data)
66 
67 /* Try to initialize UART device from SPCR data. */
68 int uart_cpu_acpi_spcr(int devtype, struct uart_devinfo *di);
69 
70 #endif /* _DEV_UART_CPU_ACPI_H_ */
71