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_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_cioctl_t(struct tty *tp, int unit, u_long cmd, caddr_t data, 50 struct thread *td); 51 typedef int tsw_param_t(struct tty *tp, struct termios *t); 52 typedef int tsw_modem_t(struct tty *tp, int sigon, int sigoff); 53 typedef int tsw_mmap_t(struct tty *tp, vm_ooffset_t offset, 54 vm_paddr_t * paddr, int nprot, vm_memattr_t *memattr); 55 typedef void tsw_pktnotify_t(struct tty *tp, char event); 56 typedef void tsw_free_t(void *softc); 57 typedef bool tsw_busy_t(struct tty *tp); 58 59 struct 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 83 static __inline int 84 ttydevsw_open(struct tty *tp) 85 { 86 tty_lock_assert(tp, MA_OWNED); 87 MPASS(!tty_gone(tp)); 88 89 return tp->t_devsw->tsw_open(tp); 90 } 91 92 static __inline void 93 ttydevsw_close(struct tty *tp) 94 { 95 tty_lock_assert(tp, MA_OWNED); 96 MPASS(!tty_gone(tp)); 97 98 tp->t_devsw->tsw_close(tp); 99 } 100 101 static __inline void 102 ttydevsw_outwakeup(struct tty *tp) 103 { 104 tty_lock_assert(tp, MA_OWNED); 105 MPASS(!tty_gone(tp)); 106 107 /* Prevent spurious wakeups. */ 108 if (ttydisc_getc_poll(tp) == 0) 109 return; 110 111 tp->t_devsw->tsw_outwakeup(tp); 112 } 113 114 static __inline void 115 ttydevsw_inwakeup(struct tty *tp) 116 { 117 tty_lock_assert(tp, MA_OWNED); 118 MPASS(!tty_gone(tp)); 119 120 /* Prevent spurious wakeups. */ 121 if (tp->t_flags & TF_HIWAT_IN) 122 return; 123 124 tp->t_devsw->tsw_inwakeup(tp); 125 } 126 127 static __inline int 128 ttydevsw_ioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td) 129 { 130 tty_lock_assert(tp, MA_OWNED); 131 MPASS(!tty_gone(tp)); 132 133 return tp->t_devsw->tsw_ioctl(tp, cmd, data, td); 134 } 135 136 static __inline int 137 ttydevsw_cioctl(struct tty *tp, int unit, u_long cmd, caddr_t data, struct thread *td) 138 { 139 tty_lock_assert(tp, MA_OWNED); 140 MPASS(!tty_gone(tp)); 141 142 return tp->t_devsw->tsw_cioctl(tp, unit, cmd, data, td); 143 } 144 145 static __inline int 146 ttydevsw_param(struct tty *tp, struct termios *t) 147 { 148 MPASS(!tty_gone(tp)); 149 150 return tp->t_devsw->tsw_param(tp, t); 151 } 152 153 static __inline int 154 ttydevsw_modem(struct tty *tp, int sigon, int sigoff) 155 { 156 MPASS(!tty_gone(tp)); 157 158 return tp->t_devsw->tsw_modem(tp, sigon, sigoff); 159 } 160 161 static __inline int 162 ttydevsw_mmap(struct tty *tp, vm_ooffset_t offset, vm_paddr_t *paddr, 163 int nprot, vm_memattr_t *memattr) 164 { 165 MPASS(!tty_gone(tp)); 166 167 return tp->t_devsw->tsw_mmap(tp, offset, paddr, nprot, memattr); 168 } 169 170 static __inline void 171 ttydevsw_pktnotify(struct tty *tp, char event) 172 { 173 tty_lock_assert(tp, MA_OWNED); 174 MPASS(!tty_gone(tp)); 175 176 tp->t_devsw->tsw_pktnotify(tp, event); 177 } 178 179 static __inline void 180 ttydevsw_free(struct tty *tp) 181 { 182 MPASS(tty_gone(tp)); 183 184 tp->t_devsw->tsw_free(tty_softc(tp)); 185 } 186 187 static __inline bool 188 ttydevsw_busy(struct tty *tp) 189 { 190 191 tty_lock_assert(tp, MA_OWNED); 192 MPASS(!tty_gone(tp)); 193 194 return (tp->t_devsw->tsw_busy(tp)); 195 } 196 197 #endif /* !_SYS_TTYDEVSW_H_ */ 198