xref: /freebsd/sys/dev/uart/uart_cpu.h (revision 7660b554bc59a07be0431c17e0e33815818baa69)
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_i8251_ops;
45 extern struct uart_ops uart_ns8250_ops;
46 extern struct uart_ops uart_sab82532_ops;
47 extern struct uart_ops uart_z8530_ops;
48 
49 /*
50  * Console and debug port device info.
51  */
52 struct uart_softc;
53 struct uart_devinfo {
54 	SLIST_ENTRY(uart_devinfo) next;
55 	struct uart_ops ops;
56 	struct uart_bas bas;
57 	int	baudrate;
58 	int	databits;
59 	int	stopbits;
60 	int	parity;
61 	int	type;
62 #define	UART_DEV_CONSOLE	0
63 #define	UART_DEV_DBGPORT	1
64 #define	UART_DEV_KEYBOARD	2
65 	int	(*attach)(struct uart_softc*);
66 	int	(*detach)(struct uart_softc*);
67 	void	*cookie;		/* Type dependent use. */
68 };
69 
70 bus_addr_t uart_cpu_busaddr(struct uart_bas *);
71 int uart_cpu_eqres(struct uart_bas *, struct uart_bas *);
72 int uart_cpu_getdev(int, struct uart_devinfo *);
73 
74 void uart_add_sysdev(struct uart_devinfo*);
75 
76 /*
77  * Operations for low-level access to the UART. Primarily for use
78  * by console and debug port logic.
79  */
80 static __inline int
81 uart_probe(struct uart_devinfo *di)
82 {
83 	return (di->ops.probe(&di->bas));
84 }
85 
86 static __inline void
87 uart_init(struct uart_devinfo *di)
88 {
89 	di->ops.init(&di->bas, di->baudrate, di->databits, di->stopbits,
90 	    di->parity);
91 }
92 
93 static __inline void
94 uart_term(struct uart_devinfo *di)
95 {
96 	di->ops.term(&di->bas);
97 }
98 
99 static __inline void
100 uart_putc(struct uart_devinfo *di, int c)
101 {
102 	di->ops.putc(&di->bas, c);
103 }
104 
105 static __inline int
106 uart_poll(struct uart_devinfo *di)
107 {
108 	return (di->ops.poll(&di->bas));
109 }
110 
111 static __inline int
112 uart_getc(struct uart_devinfo *di)
113 {
114 	return (di->ops.getc(&di->bas));
115 }
116 
117 #endif /* _DEV_UART_CPU_H_ */
118