FreeBSD/Linux Kernel Cross Reference
sys/sys/ttydevsw.h
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: releng/8.3/sys/sys/ttydevsw.h 199583 2009-11-20 15:27:52Z jhb $
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 */
43 typedef int tsw_open_t(struct tty *tp);
44 typedef void tsw_close_t(struct tty *tp);
45 typedef void tsw_outwakeup_t(struct tty *tp);
46 typedef void tsw_inwakeup_t(struct tty *tp);
47 typedef int tsw_ioctl_t(struct tty *tp, u_long cmd, caddr_t data,
48 struct thread *td);
49 typedef int tsw_param_t(struct tty *tp, struct termios *t);
50 typedef int tsw_modem_t(struct tty *tp, int sigon, int sigoff);
51 typedef int tsw_mmap_t(struct tty *tp, vm_offset_t offset,
52 vm_paddr_t * paddr, int nprot);
53 typedef void tsw_pktnotify_t(struct tty *tp, char event);
54 typedef void tsw_free_t(void *softc);
55
56 struct ttydevsw {
57 unsigned int tsw_flags; /* Default TTY flags. */
58
59 tsw_open_t *tsw_open; /* Device opening. */
60 tsw_close_t *tsw_close; /* Device closure. */
61
62 tsw_outwakeup_t *tsw_outwakeup; /* Output available. */
63 tsw_inwakeup_t *tsw_inwakeup; /* Input can be stored again. */
64
65 tsw_ioctl_t *tsw_ioctl; /* ioctl() hooks. */
66 tsw_param_t *tsw_param; /* TIOCSETA device parameter setting. */
67 tsw_modem_t *tsw_modem; /* Modem sigon/sigoff. */
68
69 tsw_mmap_t *tsw_mmap; /* mmap() hooks. */
70 tsw_pktnotify_t *tsw_pktnotify; /* TIOCPKT events. */
71
72 tsw_free_t *tsw_free; /* Destructor. */
73 };
74
75 static __inline int
76 ttydevsw_open(struct tty *tp)
77 {
78 tty_lock_assert(tp, MA_OWNED);
79 MPASS(!tty_gone(tp));
80
81 return tp->t_devsw->tsw_open(tp);
82 }
83
84 static __inline void
85 ttydevsw_close(struct tty *tp)
86 {
87 tty_lock_assert(tp, MA_OWNED);
88 MPASS(!tty_gone(tp));
89
90 tp->t_devsw->tsw_close(tp);
91 }
92
93 static __inline void
94 ttydevsw_outwakeup(struct tty *tp)
95 {
96 tty_lock_assert(tp, MA_OWNED);
97 MPASS(!tty_gone(tp));
98
99 /* Prevent spurious wakeups. */
100 if (ttydisc_getc_poll(tp) == 0)
101 return;
102
103 tp->t_devsw->tsw_outwakeup(tp);
104 }
105
106 static __inline void
107 ttydevsw_inwakeup(struct tty *tp)
108 {
109 tty_lock_assert(tp, MA_OWNED);
110 MPASS(!tty_gone(tp));
111
112 /* Prevent spurious wakeups. */
113 if (tp->t_flags & TF_HIWAT_IN)
114 return;
115
116 tp->t_devsw->tsw_inwakeup(tp);
117 }
118
119 static __inline int
120 ttydevsw_ioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td)
121 {
122 tty_lock_assert(tp, MA_OWNED);
123 MPASS(!tty_gone(tp));
124
125 return tp->t_devsw->tsw_ioctl(tp, cmd, data, td);
126 }
127
128 static __inline int
129 ttydevsw_param(struct tty *tp, struct termios *t)
130 {
131 MPASS(!tty_gone(tp));
132
133 return tp->t_devsw->tsw_param(tp, t);
134 }
135
136 static __inline int
137 ttydevsw_modem(struct tty *tp, int sigon, int sigoff)
138 {
139 MPASS(!tty_gone(tp));
140
141 return tp->t_devsw->tsw_modem(tp, sigon, sigoff);
142 }
143
144 static __inline int
145 ttydevsw_mmap(struct tty *tp, vm_offset_t offset, vm_paddr_t *paddr, int nprot)
146 {
147 MPASS(!tty_gone(tp));
148
149 return tp->t_devsw->tsw_mmap(tp, offset, paddr, nprot);
150 }
151
152 static __inline void
153 ttydevsw_pktnotify(struct tty *tp, char event)
154 {
155 tty_lock_assert(tp, MA_OWNED);
156 MPASS(!tty_gone(tp));
157
158 tp->t_devsw->tsw_pktnotify(tp, event);
159 }
160
161 static __inline void
162 ttydevsw_free(struct tty *tp)
163 {
164 MPASS(tty_gone(tp));
165
166 tp->t_devsw->tsw_free(tty_softc(tp));
167 }
168
169 #endif /* !_SYS_TTYDEVSW_H_ */
Cache object: b3981e355d0b139b94bbc8f07d74f7fe
|