xref: /freebsd/sys/dev/uart/uart_cpu.h (revision 27d5dc189c8e2eaf1cbe7e47078bf065854ba210)
1 /*
2  * Copyright (c) 2003 Marcel Moolenaar
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
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  * $FreeBSD$
27  */
28 
29 #ifndef _DEV_UART_CPU_H_
30 #define _DEV_UART_CPU_H_
31 
32 /*
33  * Low-level operations for use by console and/or debug port support.
34  */
35 struct uart_ops {
36 	int (*probe)(struct uart_bas *);
37 	void (*init)(struct uart_bas *, int, int, int, int);
38 	void (*term)(struct uart_bas *);
39 	void (*putc)(struct uart_bas *, int);
40 	int (*poll)(struct uart_bas *);
41 	int (*getc)(struct uart_bas *);
42 };
43 
44 extern struct uart_ops uart_ns8250_ops;
45 extern struct uart_ops uart_sab82532_ops;
46 extern struct uart_ops uart_z8530_ops;
47 
48 /*
49  * Console and debug port device info.
50  */
51 struct uart_softc;
52 struct uart_devinfo {
53 	SLIST_ENTRY(uart_devinfo) next;
54 	struct uart_ops ops;
55 	struct uart_bas bas;
56 	int	baudrate;
57 	int	databits;
58 	int	stopbits;
59 	int	parity;
60 	int	type;
61 #define	UART_DEV_CONSOLE	0
62 #define	UART_DEV_DBGPORT	1
63 #define	UART_DEV_KEYBOARD	2
64 	int	(*attach)(struct uart_softc*);
65 	int	(*detach)(struct uart_softc*);
66 	void	*cookie;		/* Type dependent use. */
67 };
68 
69 int uart_cpu_getdev(int devtype, struct uart_devinfo *di);
70 int uart_cpu_eqres(struct uart_bas *b1, struct uart_bas *b2);
71 
72 void uart_add_sysdev(struct uart_devinfo*);
73 
74 /*
75  * Operations for low-level access to the UART. Primarily for use
76  * by console and debug port logic.
77  */
78 static __inline int
79 uart_probe(struct uart_devinfo *di)
80 {
81 	return (di->ops.probe(&di->bas));
82 }
83 
84 static __inline void
85 uart_init(struct uart_devinfo *di)
86 {
87 	di->ops.init(&di->bas, di->baudrate, di->databits, di->stopbits,
88 	    di->parity);
89 }
90 
91 static __inline void
92 uart_term(struct uart_devinfo *di)
93 {
94 	di->ops.term(&di->bas);
95 }
96 
97 static __inline void
98 uart_putc(struct uart_devinfo *di, int c)
99 {
100 	di->ops.putc(&di->bas, c);
101 }
102 
103 static __inline int
104 uart_poll(struct uart_devinfo *di)
105 {
106 	return (di->ops.poll(&di->bas));
107 }
108 
109 static __inline int
110 uart_getc(struct uart_devinfo *di)
111 {
112 	return (di->ops.getc(&di->bas));
113 }
114 
115 #endif /* _DEV_UART_CPU_H_ */
116