1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
5 * All rights reserved.
6 *
7 * Portions of this software were developed under sponsorship from Snow
8 * B.V., the Netherlands.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
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 *tp);
44typedef void tsw_close_t(struct tty *tp);
45typedef void tsw_outwakeup_t(struct tty *tp);
46typedef void tsw_inwakeup_t(struct tty *tp);
47typedef int tsw_ioctl_t(struct tty *tp, u_long cmd, caddr_t data,
48 struct thread *td);
49typedef int tsw_cioctl_t(struct tty *tp, int unit, u_long cmd, caddr_t data,
50 struct thread *td);
51typedef int tsw_param_t(struct tty *tp, struct termios *t);
52typedef int tsw_modem_t(struct tty *tp, int sigon, int sigoff);
53typedef int tsw_mmap_t(struct tty *tp, vm_ooffset_t offset,
54 vm_paddr_t * paddr, int nprot, vm_memattr_t *memattr);
55typedef void tsw_pktnotify_t(struct tty *tp, char event);
56typedef void tsw_free_t(void *softc);
57typedef bool tsw_busy_t(struct tty *tp);
58
59struct ttydevsw {
60 unsigned int tsw_flags; /* Default TTY flags. */
61
62 tsw_open_t *tsw_open; /* Device opening. */
63 tsw_close_t *tsw_close; /* Device closure. */
64
65 tsw_outwakeup_t *tsw_outwakeup; /* Output available. */
66 tsw_inwakeup_t *tsw_inwakeup; /* Input can be stored again. */
67
68 tsw_ioctl_t *tsw_ioctl; /* ioctl() hooks. */
69 tsw_cioctl_t *tsw_cioctl; /* ioctl() on control devices. */
70 tsw_param_t *tsw_param; /* TIOCSETA device parameter setting. */
71 tsw_modem_t *tsw_modem; /* Modem sigon/sigoff. */
72
73 tsw_mmap_t *tsw_mmap; /* mmap() hooks. */
74 tsw_pktnotify_t *tsw_pktnotify; /* TIOCPKT events. */
75
76 tsw_free_t *tsw_free; /* Destructor. */
77
78 tsw_busy_t *tsw_busy; /* Draining output. */
79
80 void *tsw_spare[3]; /* For future use. */
81};
82
83static __inline int
84ttydevsw_open(struct tty *tp)
85{
86
87 tty_assert_locked(tp);
88 MPASS(!tty_gone(tp));
89
90 return (tp->t_devsw->tsw_open(tp));
91}
92
93static __inline void
94ttydevsw_close(struct tty *tp)
95{
96
97 tty_assert_locked(tp);
98 MPASS(!tty_gone(tp));
99
100 tp->t_devsw->tsw_close(tp);
101}
102
103static __inline void
104ttydevsw_outwakeup(struct tty *tp)
105{
106
107 tty_assert_locked(tp);
108 MPASS(!tty_gone(tp));
109
110 /* Prevent spurious wakeups. */
111 if (ttydisc_getc_poll(tp) == 0)
112 return;
113
114 tp->t_devsw->tsw_outwakeup(tp);
115}
116
117static __inline void
118ttydevsw_inwakeup(struct tty *tp)
119{
120
121 tty_assert_locked(tp);
122 MPASS(!tty_gone(tp));
123
124 /* Prevent spurious wakeups. */
125 if (tp->t_flags & TF_HIWAT_IN)
126 return;
127
128 tp->t_devsw->tsw_inwakeup(tp);
129}
130
131static __inline int
132ttydevsw_ioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td)
133{
134
135 tty_assert_locked(tp);
136 MPASS(!tty_gone(tp));
137
138 return (tp->t_devsw->tsw_ioctl(tp, cmd, data, td));
139}
140
141static __inline int
142ttydevsw_cioctl(struct tty *tp, int unit, u_long cmd, caddr_t data,
143 struct thread *td)
144{
145
146 tty_assert_locked(tp);
147 MPASS(!tty_gone(tp));
148
149 return (tp->t_devsw->tsw_cioctl(tp, unit, cmd, data, td));
150}
151
152static __inline int
153ttydevsw_param(struct tty *tp, struct termios *t)
154{
155
156 MPASS(!tty_gone(tp));
157
158 return (tp->t_devsw->tsw_param(tp, t));
159}
160
161static __inline int
162ttydevsw_modem(struct tty *tp, int sigon, int sigoff)
163{
164
165 MPASS(!tty_gone(tp));
166
167 return (tp->t_devsw->tsw_modem(tp, sigon, sigoff));
168}
169
170static __inline int
171ttydevsw_mmap(struct tty *tp, vm_ooffset_t offset, vm_paddr_t *paddr,
172 int nprot, vm_memattr_t *memattr)
173{
174
175 MPASS(!tty_gone(tp));
176
177 return (tp->t_devsw->tsw_mmap(tp, offset, paddr, nprot, memattr));
178}
179
180static __inline void
181ttydevsw_pktnotify(struct tty *tp, char event)
182{
183
184 tty_assert_locked(tp);
185 MPASS(!tty_gone(tp));
186
187 tp->t_devsw->tsw_pktnotify(tp, event);
188}
189
190static __inline void
191ttydevsw_free(struct tty *tp)
192{
193
194 MPASS(tty_gone(tp));
195
196 tp->t_devsw->tsw_free(tty_softc(tp));
197}
198
199static __inline bool
200ttydevsw_busy(struct tty *tp)
201{
202
203 tty_assert_locked(tp);
204 MPASS(!tty_gone(tp));
205
206 return (tp->t_devsw->tsw_busy(tp));
207}
208
209#endif /* !_SYS_TTYDEVSW_H_ */