tty.h

Go to the documentation of this file.

#ifndef _DEV_TTY_H
#define _DEV_TTY_H
 
#include <core/system.h>
 
struct tty;
 
#include <aquila/termios.h>
#include <aquila/ioctl.h>
#include <sys/proc.h>
#include <fs/iobuf.h>
 
/*
 * Terminals (dev/tty/generic.c): the line discipline that every terminal
 * shares, the virtual terminals, the serial ports and the
 * pseudo-terminals. A terminal has two sides: the master, the device
 * (keyboard and screen, a serial port, a pty's master), and the slave,
 * what programs read and write. See docs/kernel/devices.md.
 */
 
/* A terminal's write function, for one of its sides. */
typedef ssize_t (*ttyio)(struct tty *tty, size_t size, void *buf);

struct tty {
    char *cook;

    size_t size;

    size_t pos;

    int eof;

    size_t col;
    int nl_owed;
 
    struct termios tios;
    struct winsize ws;

    int stopped;
    struct waitq start_wait;
    int start_waiters;
    int gone;

    struct dev *dev;

    struct session *session;

    struct pgroup *fg;

    struct vnode *vnode;
 
    /* the device's side */

    void *p;

    ttyio   master_write;

    ttyio   slave_write;

    void    (*input_flush)(struct tty *tty);
};
 
/* The size of a terminal's line buffer. */
#define TTY_BUF_SIZE 512
 
/* The line discipline's operations (dev/tty/generic.c). */
int     tty_new(struct proc *proc, size_t buf_size, ttyio master, ttyio slave, void *p, struct tty **ref);
int     tty_free(struct tty *tty);
ssize_t tty_master_write(struct tty *tty, size_t size, void *buf);
ssize_t tty_slave_write(struct tty *tty, size_t size, void *buf);
ssize_t tty_write_iobuf(struct tty *tty, struct iobuf *io, ttyio write);
int     tty_ioctl(struct tty *tty, int request, void *argp);
void    tty_open(struct tty *tty, struct file *file);
void    tty_hangup(struct tty *tty);
void    tty_flush(struct tty *tty, int which);
int     tty_eof(struct tty *tty);
uint64_t tty_read_timeout(struct tty *tty);
int     tty_can_read(struct tty *tty, size_t buffered);
int     tty_background(struct tty *tty, int sig);
 
#endif /* ! _DEV_TTY_H */