/*-
 * Copyright (c) 1982, 1986, 1993
 *      The Regents of the University of California.  All rights reserved.
 * (c) UNIX System Laboratories, Inc.
 * All or some portions of this file are derived from material licensed
 * to the University of California by American Telephone and Telegraph
 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
 * the permission of UNIX System Laboratories, Inc.
 *
 * 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. 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.
 *
 *      @(#)tty.h       8.6 (Berkeley) 1/21/94
 * $FreeBSD: src/sys/sys/tty.h,v 1.53.2.1 2001/02/26 04:23:21 jlemon Exp $
 */

#ifndef _SYS_TTY_H_
#define _SYS_TTY_H_

/*
 * Clists are character lists, which is a variable length linked list
 * of cblocks, with a count of the number of characters in the list.
 */
struct clist {
        int     c_cc;           /* Number of characters in the clist. */
        int     c_ccmax;        /* Max # chars for this clist. */
        int     c_cchead;       /* First char */
        int     c_unused01;
        short   *c_data;        /* linear data buffer (no longer chained) */
};

#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)

#include <sys/_termios.h>
#include <sys/event.h>
#include <sys/queue.h>
#include <sys/ttycom.h>
#ifdef _KERNEL
#include <sys/device.h>
#endif
#ifndef _SYS_THREAD_H_
#include <sys/thread.h>
#endif

/*
 * 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 {
        struct lwkt_token t_token;
        struct  clist t_rawq;           /* Device raw input queue. */
        long    t_rawcc;                /* Raw input queue statistics. */
        struct  clist t_canq;           /* Device canonical queue. */
        long    t_cancc;                /* Canonical queue statistics. */
        struct  clist t_outq;           /* Device output queue. */
        long    t_outcc;                /* Output queue statistics. */
        int     t_line;                 /* Interface to device drivers. */
        struct cdev *t_dev;             /* Device. */
        int     t_state;                /* Device and driver (TS*) state. */
        int     t_flags;                /* Tty flags. */
        int     t_timeout;              /* Timeout for ttywait() */
        struct  pgrp *t_pgrp;           /* Foreground process group. */
        struct  session *t_session;     /* Enclosing session. */
        struct  sigio *t_sigio;         /* Information for async I/O. */
        struct  kqinfo t_rkq;           /* Tty read/oob kq. */
        struct  kqinfo t_wkq;           /* Tty write kq. */
        struct  termios t_termios;      /* Termios state. */
        struct  winsize t_winsize;      /* Window size. */
                                        /* Start output. */
        void    (*t_oproc) (struct tty *);
                                        /* Stop output. */
        void    (*t_stop) (struct tty *, int);
                                        /* Set hardware state. */
        int     (*t_param) (struct tty *, struct termios *);
        void    (*t_unhold) (struct tty *); /* callback to pty after unhold */
        void    *t_sc;                  /* generic driver (u4b com) */
        void    *t_slsc;                /* if_sl.c, ppp_tty.c (disc) */
        int     t_column;               /* Tty output column. */
        int     t_rocount, t_rocol;     /* Tty. */
        int     t_ififosize;            /* Total size of upstream fifos. */
        int     t_ihiwat;               /* High water mark for input. */
        int     t_ilowat;               /* Low water mark for input. */
        speed_t t_ispeedwat;            /* t_ispeed override for watermarks. */
        int     t_ohiwat;               /* High water mark for output. */
        int     t_olowat;               /* Low water mark for output. */
        speed_t t_ospeedwat;            /* t_ospeed override for watermarks. */
        int     t_gen;                  /* Generation number. */
        TAILQ_ENTRY(tty) t_list;        /* Global chain of ttys for pstat(8) */
        int     t_refs;                 /* Reference count. */
};

#define t_cc            t_termios.c_cc
#define t_cflag         t_termios.c_cflag
#define t_iflag         t_termios.c_iflag
#define t_ispeed        t_termios.c_ispeed
#define t_lflag         t_termios.c_lflag
#define t_min           t_termios.c_min
#define t_oflag         t_termios.c_oflag
#define t_ospeed        t_termios.c_ospeed
#define t_time          t_termios.c_time

#endif

/*
 * User data unfortunately has to be copied through buffers on the way to
 * and from clists.  The buffers are on the stack so their sizes must be
 * fairly small.
 */
#define IBUFSIZ         384             /* Should be >= max value of MIN. */
#define OBUFSIZ         100

#ifndef TTYHOG
#define TTYHOG          1024
#endif

#ifdef _KERNEL
#define TTMAXHIWAT      2048
#define TTMINHIWAT      100
#define TTMAXLOWAT      256
#define TTMINLOWAT      32
#endif

/* These flags are kept in t_state. */
#define TS_SO_OLOWAT    0x00001         /* Wake up when output <= low water. */
#define TS_ASYNC        0x00002         /* Tty in async I/O mode. */
#define TS_BUSY         0x00004         /* Draining output. */
#define TS_CARR_ON      0x00008         /* Carrier is present. */
#define TS_FLUSH        0x00010         /* Outq has been flushed during DMA. */
#define TS_ISOPEN       0x00020         /* Open has completed. */
#define TS_TBLOCK       0x00040         /* Further input blocked. */
#define TS_TIMEOUT      0x00080         /* Wait for output char processing. */
#define TS_TTSTOP       0x00100         /* Output paused. */
#ifdef notyet
#define TS_WOPEN        0x00200         /* Open in progress. */
#endif
#define TS_XCLUDE       0x00400         /* Tty requires exclusivity. */

/* State for intra-line fancy editing work. */
#define TS_BKSL         0x00800         /* State for lowercase \ work. */
#define TS_CNTTB        0x01000         /* Counting tab width, ignore FLUSHO. */
#define TS_ERASE        0x02000         /* Within a \.../ for PRTRUB. */
#define TS_LNCH         0x04000         /* Next character is literal. */
#define TS_TYPEN        0x08000         /* Retyping suspended input (PENDIN). */
#define TS_LOCAL        (TS_BKSL | TS_CNTTB | TS_ERASE | TS_LNCH | TS_TYPEN)

/* Extras. */
#define TS_CAN_BYPASS_L_RINT 0x010000   /* Device in "raw" mode. */
#define TS_CONNECTED    0x020000        /* Connection open. */
#define TS_SNOOP        0x040000        /* Device is being snooped on. */
#define TS_SO_OCOMPLETE 0x080000        /* Wake up when output completes. */
#define TS_ZOMBIE       0x100000        /* Connection lost. */

/* Hardware flow-control-invoked bits. */
#define TS_CAR_OFLOW    0x200000        /* For MDMBUF (XXX handle in driver). */
#ifdef notyet
#define TS_CTS_OFLOW    0x400000        /* For CCTS_OFLOW. */
#define TS_DSR_OFLOW    0x800000        /* For CDSR_OFLOW. */
#endif
#define TS_REGISTERED   0x1000000       /* ttyregister sanity check */
#define TS_MARKER       0x2000000       /* sysctl iteration marker */

/* Character type information. */
#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;                   /* Speed. */
        int sp_code;                    /* Code. */
};

/* Modem control commands (driver). */
#define DMSET           0
#define DMBIS           1
#define DMBIC           2
#define DMGET           3

/* Flags on a character passed to ttyinput. */
#define TTY_CHARMASK    0x00ff          /* Character mask */
#define TTY_QUOTE       0x0100          /* Character quoted */
#define TTY_ERRORMASK   0xff000000      /* Error mask */
#define TTY_FE          0x01000000      /* Framing error */
#define TTY_PE          0x02000000      /* Parity error */
#define TTY_OE          0x04000000      /* Overrun error */
#define TTY_BI          0x08000000      /* Break condition */

/* Is tp controlling terminal for p? */
#define isctty(p, tp)                                                   \
        ((p)->p_session == (tp)->t_session && ((p)->p_flags & P_CONTROLT))

/* Is p in background of tp? */
#define isbackground(p, tp)                                             \
        (isctty((p), (tp)) && (p)->p_pgrp != (tp)->t_pgrp)

/* Unique sleep addresses. */
#define TSA_CARR_ON(tp)         ((void *)&(tp)->t_rawq)
#define TSA_HUP_OR_INPUT(tp)    ((void *)&(tp)->t_rawq.c_cchead)
#define TSA_OCOMPLETE(tp)       ((void *)&(tp)->t_outq.c_ccmax)
#define TSA_OLOWAT(tp)          ((void *)&(tp)->t_outq)
#define TSA_PTC_READ(tp)        ((void *)&(tp)->t_outq.c_cchead)
#define TSA_PTC_WRITE(tp)       ((void *)&(tp)->t_rawq.c_ccmax)
#define TSA_PTS_READ(tp)        ((void *)&(tp)->t_canq)

#ifdef _KERNEL

#ifdef MALLOC_DECLARE
MALLOC_DECLARE(M_TTYS);
#endif

extern  struct tty *constty;    /* Temporary virtual console. */

int      clist_btoq (char *cp, int cc, struct clist *q);
void     clist_catq (struct clist *from, struct clist *to);
void     clist_alloc_cblocks (struct clist *q, int ccmax);
void     clist_free_cblocks (struct clist *q);
int      clist_getc (struct clist *q);
int      clist_unputc (struct clist *q);
void     ndflush (struct clist *q, int cc);
void    *clist_nextc (struct clist *q, void *cp, int *c);
void     nottystop (struct tty *tp, int rw);
int      clist_putc (int c, struct clist *q);
int      clist_qtob (struct clist *q, char *cp, int cc);
void     termioschars (struct termios *t);
int      tputchar (int c, struct tty *tp);
int      ttcompat (struct tty *tp, u_long com, caddr_t data, int flag);
int      ttioctl (struct tty *tp, u_long com, void *data, int flag);
int      ttread (struct tty *tp, struct uio *uio, int flag);
int      ttsetcompat (struct tty *tp, u_long *com, caddr_t data,
            struct termios *term);
void     ttsetwater (struct tty *tp);
int      ttspeedtab (int speed, struct speedtab *table);
int      ttstart (struct tty *tp);
void     ttwakeup (struct tty *tp);
int      ttwrite (struct tty *tp, struct uio *uio, int flag);
void     ttwwakeup (struct tty *tp);
void     ttyblock (struct tty *tp);
void     ttychars (struct tty *tp);
int      ttycheckoutq (struct tty *tp, int wait);
int      ttyclose (struct tty *tp);
void     ttyclearsession (struct tty *tp);
void     ttyclosesession (struct session *, int);
void     ttyflush (struct tty *tp, int rw);
void     ttyhold (struct tty *tp);
void     ttyunhold (struct tty *tp);
void     ttyinfo (struct tty *tp);
int      ttyinput (int c, struct tty *tp);
int      ttylclose (struct tty *tp, int flag);
struct tty *ttymalloc (struct tty **tpp);
int      ttymodem (struct tty *tp, int flag);
int      ttyopen (cdev_t device, struct tty *tp);
int      ttykqfilter (struct dev_kqfilter_args *);
int      ttyread (struct dev_read_args *);
void     ttyregister (struct tty *tp);
void     ttyinit (struct tty *tp);
void     ttyunregister (struct tty *tp);
int      ttysleep (struct tty *tp, void *chan, int slpflags, char *wmesg,
            int timeout);
int      ttyrevoke (struct dev_revoke_args *);
int      ttywait (struct tty *tp);
int      ttywrite (struct dev_write_args *);

#endif /* _KERNEL */

#endif /* !_SYS_TTY_H_ */