1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 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 * $FreeBSD$ 32 */ 33 34 #ifndef _SYS_TTYDISC_H_ 35 #define _SYS_TTYDISC_H_ 36 37 #ifndef _SYS_TTY_H_ 38 #error "can only be included through <sys/tty.h>" 39 #endif /* !_SYS_TTY_H_ */ 40 41 struct cv; 42 struct thread; 43 struct tty; 44 struct uio; 45 46 /* Top half routines. */ 47 void ttydisc_open(struct tty *tp); 48 void ttydisc_close(struct tty *tp); 49 int ttydisc_read(struct tty *tp, struct uio *uio, int ioflag); 50 int ttydisc_write(struct tty *tp, struct uio *uio, int ioflag); 51 void ttydisc_optimize(struct tty *tp); 52 53 /* Bottom half routines. */ 54 void ttydisc_modem(struct tty *tp, int open); 55 #define ttydisc_can_bypass(tp) ((tp)->t_flags & TF_BYPASS) 56 int ttydisc_rint(struct tty *tp, char c, int flags); 57 size_t ttydisc_rint_simple(struct tty *tp, const void *buf, size_t len); 58 size_t ttydisc_rint_bypass(struct tty *tp, const void *buf, size_t len); 59 void ttydisc_rint_done(struct tty *tp); 60 size_t ttydisc_rint_poll(struct tty *tp); 61 size_t ttydisc_getc(struct tty *tp, void *buf, size_t len); 62 int ttydisc_getc_uio(struct tty *tp, struct uio *uio); 63 size_t ttydisc_getc_poll(struct tty *tp); 64 65 /* Error codes for ttydisc_rint(). */ 66 #define TRE_FRAMING 0x01 67 #define TRE_PARITY 0x02 68 #define TRE_OVERRUN 0x04 69 #define TRE_BREAK 0x08 70 71 static __inline size_t 72 ttydisc_read_poll(struct tty *tp) 73 { 74 75 tty_assert_locked(tp); 76 77 return ttyinq_bytescanonicalized(&tp->t_inq); 78 } 79 80 static __inline size_t 81 ttydisc_write_poll(struct tty *tp) 82 { 83 84 tty_assert_locked(tp); 85 86 return ttyoutq_bytesleft(&tp->t_outq); 87 } 88 89 #endif /* !_SYS_TTYDISC_H_ */ 90