ttydevsw.h revision 181905 
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: head/sys/sys/ttydevsw.h 181905 2008-08-20 08:31:58Z ed $
30 */
31
32#ifndef _SYS_TTYDEVSW_H_
33#define	_SYS_TTYDEVSW_H_
34
35#ifndef _SYS_TTY_H_
36#error "can only be included through <sys/tty.h>"
37#endif /* !_SYS_TTY_H_ */
38
39/*
40 * Driver routines that are called from the line discipline to adjust
41 * hardware parameters and such.
42 */
43typedef int tsw_open_t(struct tty *);
44typedef void tsw_close_t(struct tty *);
45typedef void tsw_outwakeup_t(struct tty *);
46typedef void tsw_inwakeup_t(struct tty *);
47typedef int tsw_ioctl_t(struct tty *, u_long, caddr_t, struct thread *);
48typedef int tsw_param_t(struct tty *, struct termios *);
49typedef int tsw_modem_t(struct tty *, int, int);
50typedef int tsw_mmap_t(struct tty *, vm_offset_t, vm_paddr_t *, int);
51typedef void tsw_free_t(void *);
52
53struct ttydevsw {
54	unsigned int	tsw_flags;	/* Default TTY flags. */
55
56	tsw_open_t	*tsw_open;	/* Device opening. */
57	tsw_close_t	*tsw_close;	/* Device closure. */
58
59	tsw_outwakeup_t	*tsw_outwakeup;	/* Output available. */
60	tsw_inwakeup_t	*tsw_inwakeup;	/* Input can be stored again. */
61
62	tsw_ioctl_t	*tsw_ioctl;	/* ioctl() hooks. */
63	tsw_param_t	*tsw_param;	/* TIOCSETA device parameter setting. */
64	tsw_modem_t	*tsw_modem;	/* Modem sigon/sigoff. */
65
66	tsw_mmap_t	*tsw_mmap;	/* mmap() hooks. */
67
68	tsw_free_t	*tsw_free;	/* Destructor. */
69};
70
71static __inline int
72ttydevsw_open(struct tty *tp)
73{
74	tty_lock_assert(tp, MA_OWNED);
75	MPASS(!tty_gone(tp));
76
77	return tp->t_devsw->tsw_open(tp);
78}
79
80static __inline void
81ttydevsw_close(struct tty *tp)
82{
83	tty_lock_assert(tp, MA_OWNED);
84	MPASS(!tty_gone(tp));
85
86	tp->t_devsw->tsw_close(tp);
87}
88
89static __inline void
90ttydevsw_outwakeup(struct tty *tp)
91{
92	tty_lock_assert(tp, MA_OWNED);
93	MPASS(!tty_gone(tp));
94
95	/* Prevent spurious wakeups. */
96	if (tp->t_flags & TF_STOPPED)
97		return;
98	if (ttyoutq_bytesused(&tp->t_outq) == 0)
99		return;
100
101	tp->t_devsw->tsw_outwakeup(tp);
102}
103
104static __inline void
105ttydevsw_inwakeup(struct tty *tp)
106{
107	tty_lock_assert(tp, MA_OWNED);
108	MPASS(!tty_gone(tp));
109
110	/* Prevent spurious wakeups. */
111	if (tp->t_flags & TF_HIWAT_IN)
112		return;
113
114	tp->t_devsw->tsw_inwakeup(tp);
115}
116
117static __inline int
118ttydevsw_ioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td)
119{
120	tty_lock_assert(tp, MA_OWNED);
121	MPASS(!tty_gone(tp));
122
123	return tp->t_devsw->tsw_ioctl(tp, cmd, data, td);
124}
125
126static __inline int
127ttydevsw_param(struct tty *tp, struct termios *t)
128{
129	MPASS(!tty_gone(tp));
130
131	return tp->t_devsw->tsw_param(tp, t);
132}
133
134static __inline int
135ttydevsw_modem(struct tty *tp, int sigon, int sigoff)
136{
137	MPASS(!tty_gone(tp));
138
139	return tp->t_devsw->tsw_modem(tp, sigon, sigoff);
140}
141
142static __inline int
143ttydevsw_mmap(struct tty *tp, vm_offset_t offset, vm_paddr_t *paddr, int nprot)
144{
145	MPASS(!tty_gone(tp));
146
147	return tp->t_devsw->tsw_mmap(tp, offset, paddr, nprot);
148}
149
150static __inline void
151ttydevsw_free(struct tty *tp)
152{
153	MPASS(tty_gone(tp));
154
155	tp->t_devsw->tsw_free(tty_softc(tp));
156}
157
158#endif /* !_SYS_TTYDEVSW_H_ */
159