sys/sys/tty.h

/*-
 * Copyright (c) 1982, 1986 The Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by the University of
 *      California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      from: @(#)tty.h 7.10 (Berkeley) 6/26/91
 *      $Id: tty.h,v 1.7 1993/12/19 00:55:28 wollman Exp $
 */

#ifndef _SYS_TTY_H_
#define _SYS_TTY_H_

#include <sys/termios.h>

/*
 * Ring buffers provide a contiguous, dense storage for
 * character data used by the tty driver.
 */
#define RBSZ 1024

struct ringb {
        char    *rb_hd;   /* head of buffer segment to be read */
        char    *rb_tl;   /* tail of buffer segment to be written */
        char    rb_buf[RBSZ];   /* segment contents */
};

#define RB_SUCC(rbp, p) \
                ((p) >= (rbp)->rb_buf + RBSZ - 1 ? (rbp)->rb_buf : (p) + 1)

#define RB_ROLLOVER(rbp, p) \
                ((p) > (rbp)->rb_buf + RBSZ - 1 ? (rbp)->rb_buf : (p))

#define RB_PRED(rbp, p) \
                ((p) <= (rbp)->rb_buf ? (rbp)->rb_buf + RBSZ - 1 : (p) - 1)

#define RB_LEN(rp) \
                ((rp)->rb_hd <= (rp)->rb_tl ? (rp)->rb_tl - (rp)->rb_hd : \
                RBSZ - ((rp)->rb_hd - (rp)->rb_tl))

#define RB_CONTIGPUT(rp) \
                (RB_PRED(rp, (rp)->rb_hd) < (rp)->rb_tl ?  \
                        (rp)->rb_buf + RBSZ - (rp)->rb_tl : \
                        RB_PRED(rp, (rp)->rb_hd) - (rp)->rb_tl)

#define RB_CONTIGGET(rp) \
                ((rp)->rb_hd <= (rp)->rb_tl ? (rp)->rb_tl - (rp)->rb_hd : \
                (rp)->rb_buf + RBSZ - (rp)->rb_hd)

/*
 * Per-tty structure.
 *
 * Should be split in two, into device and tty drivers.
 * Glue could be masks of what to echo and circular buffer
 * (low, high, timeout).
 */
struct tty {
        void    (*t_oproc)(struct tty *); /* device */
        int     (*t_param)(struct tty *, struct termios *); /* device */
        pid_t   t_rsel;                 /* tty */
        pid_t   t_wsel;
        caddr_t T_LINEP;                /* XXX */
#if 0
        caddr_t t_addr;                 /* ??? */
#endif
        dev_t   t_dev;                  /* device */
        int     t_flags;                /* (compat) some of both */
        int     t_state;                /* some of both */
        struct  session *t_session;     /* tty */
        struct  pgrp *t_pgrp;           /* foreground process group */
        int     t_line;                 /* glue */
        int     t_col;                  /* tty */
        int     t_rocount, t_rocol;     /* tty */
        int     t_hiwat;                /* hi water mark */
        int     t_lowat;                /* low water mark */
        struct  winsize t_winsize;      /* window size */
        struct  termios t_termios;      /* termios state */
#define t_iflag         t_termios.c_iflag
#define t_oflag         t_termios.c_oflag
#define t_cflag         t_termios.c_cflag
#define t_lflag         t_termios.c_lflag
#define t_min           t_termios.c_min
#define t_time          t_termios.c_time
#define t_cc            t_termios.c_cc
#define t_ispeed        t_termios.c_ispeed
#define t_ospeed        t_termios.c_ospeed
        long    t_cancc;                /* stats */
        long    t_rawcc;
        long    t_outcc;
        int     t_gen;                  /* generation number */
#if 0
        int     t_mask;                 /* interrupt mask */
#endif
        struct  ringb t_raw;            /* ring buffers */
        struct  ringb t_can;
        struct  ringb t_out;
};

#define TTIPRI  25                      /* sleep priority for tty reads */
#define TTOPRI  26                      /* sleep priority for tty writes */

#define TTMASK  15
#define OBUFSIZ 100
#define TTYHOG  1024

#ifdef KERNEL
#define TTMAXHIWAT      (RBSZ/2)        /* XXX */
#define TTMINHIWAT      128
#define TTMAXLOWAT      256
#define TTMINLOWAT      32
extern  struct ttychars ttydefaults;
#endif /* KERNEL */

/* internal state bits */
#define TS_TIMEOUT      0x000001UL      /* delay timeout in progress */
#define TS_WOPEN        0x000002UL      /* waiting for open to complete */
#define TS_ISOPEN       0x000004UL      /* device is open */
#define TS_FLUSH        0x000008UL      /* outq has been flushed during DMA */
#define TS_CARR_ON      0x000010UL      /* software copy of carrier-present */
#define TS_BUSY         0x000020UL      /* output in progress */
#define TS_ASLEEP       0x000040UL      /* wakeup when output done */
#define TS_XCLUDE       0x000080UL      /* exclusive-use flag against open */
#define TS_TTSTOP       0x000100UL      /* output stopped by ctl-s */
/* was  TS_HUPCLS       0x000200UL       * hang up upon last close */
#define TS_TBLOCK       0x000400UL      /* tandem queue blocked */
#define TS_RCOLL        0x000800UL      /* collision in read select */
#define TS_WCOLL        0x001000UL      /* collision in write select */
#define TS_ASYNC        0x004000UL      /* tty in async i/o mode */
/* state for intra-line fancy editing work */
#define TS_BKSL         0x010000UL      /* state for lowercase \ work */
#define TS_ERASE        0x040000UL      /* within a \.../ for PRTRUB */
#define TS_LNCH         0x080000UL      /* next character is literal */
#define TS_TYPEN        0x100000UL      /* retyping suspended input (PENDIN) */
#define TS_CNTTB        0x200000UL      /* counting tab width, ignore FLUSHO */
/* flow-control-invoked bits */
#define TS_CAR_OFLOW    0x0400000UL     /* for MDMBUF (XXX handle in driver) */
#define TS_DTR_IFLOW    0x2000000UL     /* not implemented */
#define TS_RTS_IFLOW    0x4000000UL     /* for CRTS_IFLOW */

#define TS_HW_IFLOW     (TS_DTR_IFLOW | TS_RTS_IFLOW)
#define TS_LOCAL        (TS_BKSL|TS_ERASE|TS_LNCH|TS_TYPEN|TS_CNTTB)

/* define partab character types */
#define ORDINARY        0
#define CONTROL         1
#define BACKSPACE       2
#define NEWLINE         3
#define TAB             4
#define VTAB            5
#define RETURN          6

struct speedtab {
        int sp_speed;
        int sp_code;
};
/*
 * Flags on character passed to ttyinput
 */
#define TTY_CHARMASK    0x000000ffUL /* Character mask */
#define TTY_QUOTE       0x00000100UL /* Character quoted */
#define TTY_ERRORMASK   0xff000000UL /* Error mask */
#define TTY_FE          0x01000000UL /* Framing error or BREAK condition */
#define TTY_PE          0x02000000UL /* Parity error */

/*
 * Is tp controlling terminal for p
 */
#define isctty(p, tp)   ((p)->p_session == (tp)->t_session && \
                         (p)->p_flag&SCTTY)
/*
 * Is p in background of tp
 */
#define isbackground(p, tp)     (isctty((p), (tp)) && \
                                (p)->p_pgrp != (tp)->t_pgrp)
/*
 * Modem control commands (driver).
 */
#define DMSET           0
#define DMBIS           1
#define DMBIC           2
#define DMGET           3

#ifdef KERNEL
/* symbolic sleep message strings */
extern const char ttyin[], ttyout[], ttopen[], ttclos[], ttybg[], ttybuf[];

struct uio;

/* From tty.c: */
extern void ttychars(struct tty *);
extern int ttwflush(struct tty *);
extern int ttywait(struct tty *);
extern void ttyflush(struct tty *, int);
extern void ttstart(struct tty *);
extern void ttrstrt(struct tty *);
extern int ttioctl(struct tty *, int, caddr_t, int);
extern int ttnread(struct tty *);
extern int ttselect(int /*dev_t*/, int, struct proc *);
extern int ttyopen(int /*dev_t*/, struct tty *, int);
extern void ttylclose(struct tty *, int);
extern int ttyclose(struct tty *);
extern int ttymodem(struct tty *, int);
extern int nullmodem(struct tty *, int);
extern void ttyinput(int, struct tty *);
extern int ttread(struct tty *, struct uio *, int);
extern int ttycheckoutq(struct tty *, int);
extern int ttwrite(struct tty *, struct uio *, int);
extern void ttwakeup(struct tty *);
extern int ttspeedtab(int, struct speedtab *);
extern void ttsetwater(struct tty *);
extern void ttyinfo(struct tty *);
extern int tputchar(int, struct tty *);
extern int ttysleep(struct tty *, caddr_t, int, const char *, int);

/* From tty_ring.c: */
extern int putc(int, struct ringb *);
extern int getc(struct ringb *);
extern int nextc(char **, struct ringb *);
extern int ungetc(int, struct ringb *);
extern int unputc(struct ringb *);
extern void initrb(struct ringb *);
extern void catb(struct ringb *, struct ringb *);
extern size_t rb_write(struct ringb *, char *, size_t);

/* From tty_compat.c: */
extern int ttcompat(struct tty *, int, caddr_t, int);

#endif /* KERNEL */
#endif  /* _SYS_TTY_H_ */