xref: /freebsd/sys/sys/ttydisc.h (revision aa0a1e58)
1 /*-
2  * Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Portions of this software were developed under sponsorship from Snow
6  * B.V., the Netherlands.
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  * $FreeBSD$
30  */
31 
32 #ifndef _SYS_TTYDISC_H_
33 #define	_SYS_TTYDISC_H_
34 
35 #ifndef _SYS_TTY_H_
36 #error "can only be included through <sys/tty.h>"
37 #endif /* !_SYS_TTY_H_ */
38 
39 struct cv;
40 struct thread;
41 struct tty;
42 struct uio;
43 
44 /* Top half routines. */
45 void	ttydisc_open(struct tty *tp);
46 void	ttydisc_close(struct tty *tp);
47 int	ttydisc_read(struct tty *tp, struct uio *uio, int ioflag);
48 int	ttydisc_write(struct tty *tp, struct uio *uio, int ioflag);
49 void	ttydisc_optimize(struct tty *tp);
50 
51 /* Bottom half routines. */
52 void	ttydisc_modem(struct tty *tp, int open);
53 #define ttydisc_can_bypass(tp) ((tp)->t_flags & TF_BYPASS)
54 int	ttydisc_rint(struct tty *tp, char c, int flags);
55 size_t	ttydisc_rint_simple(struct tty *tp, const void *buf, size_t len);
56 size_t	ttydisc_rint_bypass(struct tty *tp, const void *buf, size_t len);
57 void	ttydisc_rint_done(struct tty *tp);
58 size_t	ttydisc_rint_poll(struct tty *tp);
59 size_t	ttydisc_getc(struct tty *tp, void *buf, size_t len);
60 int	ttydisc_getc_uio(struct tty *tp, struct uio *uio);
61 size_t	ttydisc_getc_poll(struct tty *tp);
62 
63 /* Error codes for ttydisc_rint(). */
64 #define	TRE_FRAMING	0x01
65 #define	TRE_PARITY	0x02
66 #define	TRE_OVERRUN	0x04
67 #define	TRE_BREAK	0x08
68 
69 static __inline size_t
70 ttydisc_read_poll(struct tty *tp)
71 {
72 
73 	tty_lock_assert(tp, MA_OWNED);
74 
75 	return ttyinq_bytescanonicalized(&tp->t_inq);
76 }
77 
78 static __inline size_t
79 ttydisc_write_poll(struct tty *tp)
80 {
81 
82 	tty_lock_assert(tp, MA_OWNED);
83 
84 	return ttyoutq_bytesleft(&tp->t_outq);
85 }
86 
87 #endif /* !_SYS_TTYDISC_H_ */
88