sys/sys/ttydisc.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$
  30  */
  31
  32 #ifndef _SYS_TTYDISC_H_
  33 #define _SYS_TTYDISC_H_
  34
  35 #ifndef _SYS_TTY_H_
  36 #error "can only be included through <sys/tty.h>"
  37 #endif /* !_SYS_TTY_H_ */
  38
  39 struct cv;
  40 struct thread;
  41 struct tty;
  42 struct uio;
  43
  44 /* Top half routines. */
  45 void    ttydisc_open(struct tty *);
  46 void    ttydisc_close(struct tty *);
  47 int     ttydisc_read(struct tty *, struct uio *, int);
  48 int     ttydisc_write(struct tty *, struct uio *, int);
  49 void    ttydisc_optimize(struct tty *);
  50
  51 /* Bottom half routines. */
  52 void    ttydisc_modem(struct tty *, int);
  53 #define ttydisc_can_bypass(tp) ((tp)->t_flags & TF_BYPASS)
  54 int     ttydisc_rint(struct tty *, char, int);
  55 size_t  ttydisc_rint_bypass(struct tty *, char *, size_t);
  56 void    ttydisc_rint_done(struct tty *);
  57 size_t  ttydisc_getc(struct tty *, void *, size_t);
  58 int     ttydisc_getc_uio(struct tty *, struct uio *);
  59
  60 /* Error codes for ttydisc_rint(). */
  61 #define TRE_FRAMING     0x01
  62 #define TRE_PARITY      0x02
  63 #define TRE_OVERRUN     0x04
  64 #define TRE_BREAK       0x08
  65
  66 static __inline size_t
  67 ttydisc_read_poll(struct tty *tp)
  68 {
  69
  70         tty_lock_assert(tp, MA_OWNED);
  71
  72         return ttyinq_bytescanonicalized(&tp->t_inq);
  73 }
  74
  75 static __inline size_t
  76 ttydisc_write_poll(struct tty *tp)
  77 {
  78
  79         tty_lock_assert(tp, MA_OWNED);
  80
  81         return ttyoutq_bytesleft(&tp->t_outq);
  82 }
  83
  84 static __inline size_t
  85 ttydisc_rint_poll(struct tty *tp)
  86 {
  87         size_t l;
  88
  89         tty_lock_assert(tp, MA_OWNED);
  90
  91         /*
  92          * XXX: Still allow character input when there's no space in the
  93          * buffers, but we haven't entered the high watermark. This is
  94          * to allow backspace characters to be inserted when in
  95          * canonical mode.
  96          */
  97         l = ttyinq_bytesleft(&tp->t_inq);
  98         if (l == 0 && (tp->t_flags & TF_HIWAT_IN) == 0)
  99                 return (1);
 100
 101         return (l);
 102 }
 103
 104 static __inline size_t
 105 ttydisc_getc_poll(struct tty *tp)
 106 {
 107
 108         tty_lock_assert(tp, MA_OWNED);
 109
 110         if (tp->t_flags & TF_STOPPED)
 111                 return (0);
 112
 113         return ttyoutq_bytesused(&tp->t_outq);
 114 }
 115
 116 #endif /* !_SYS_TTYDISC_H_ */