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 * $FreeBSD$
31 */
32
33#ifndef _DEV_UART_CPU_ACPI_H_
34#define _DEV_UART_CPU_ACPI_H_
35
36#include <sys/linker_set.h>
37
38struct uart_class;
39
40struct acpi_uart_compat_data {
41	const char *cd_hid;
42	struct uart_class *cd_class;
43
44	uint16_t cd_port_subtype;
45	int cd_regshft;
46	int cd_regiowidth;
47	int cd_rclk;
48	int cd_quirks;
49	const char *cd_desc;
50};
51
52/*
53 * If your UART driver implements only uart_class and uses uart_cpu_acpi.c
54 * for device instantiation, then use UART_ACPI_CLASS_AND_DEVICE for its
55 * declaration
56 */
57SET_DECLARE(uart_acpi_class_and_device_set, struct acpi_uart_compat_data);
58#define UART_ACPI_CLASS_AND_DEVICE(data)				\
59	DATA_SET(uart_acpi_class_and_device_set, data)
60
61/*
62 * If your UART driver implements uart_class and custom device layer,
63 * then use UART_ACPI_CLASS for its declaration
64 */
65SET_DECLARE(uart_acpi_class_set, struct acpi_uart_compat_data);
66#define UART_ACPI_CLASS(data)				\
67	DATA_SET(uart_acpi_class_set, data)
68
69/* Try to initialize UART device from SPCR data. */
70int uart_cpu_acpi_spcr(int devtype, struct uart_devinfo *di);
71
72#endif /* _DEV_UART_CPU_ACPI_H_ */
73