~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/tty_ldisc.h

Version: ~ [ linux-5.3-rc5 ] ~ [ linux-5.2.9 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.67 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.139 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.189 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.189 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.72 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-3.9.11 ] ~ [ linux-3.8.13 ] ~ [ linux-3.7.10 ] ~ [ linux-3.6.11 ] ~ [ linux-3.5.7 ] ~ [ linux-3.4.113 ] ~ [ linux-3.3.8 ] ~ [ linux-3.2.102 ] ~ [ linux-3.1.10 ] ~ [ linux-3.0.101 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 #ifndef _LINUX_TTY_LDISC_H
  2 #define _LINUX_TTY_LDISC_H
  3 
  4 /*
  5  * This structure defines the interface between the tty line discipline
  6  * implementation and the tty routines.  The following routines can be
  7  * defined; unless noted otherwise, they are optional, and can be
  8  * filled in with a null pointer.
  9  *
 10  * int  (*open)(struct tty_struct *);
 11  *
 12  *      This function is called when the line discipline is associated
 13  *      with the tty.  The line discipline can use this as an
 14  *      opportunity to initialize any state needed by the ldisc routines.
 15  * 
 16  * void (*close)(struct tty_struct *);
 17  *
 18  *      This function is called when the line discipline is being
 19  *      shutdown, either because the tty is being closed or because
 20  *      the tty is being changed to use a new line discipline
 21  * 
 22  * void (*flush_buffer)(struct tty_struct *tty);
 23  *
 24  *      This function instructs the line discipline to clear its
 25  *      buffers of any input characters it may have queued to be
 26  *      delivered to the user mode process.
 27  * 
 28  * ssize_t (*chars_in_buffer)(struct tty_struct *tty);
 29  *
 30  *      This function returns the number of input characters the line
 31  *      discipline may have queued up to be delivered to the user mode
 32  *      process.
 33  * 
 34  * ssize_t (*read)(struct tty_struct * tty, struct file * file,
 35  *                 unsigned char * buf, size_t nr);
 36  *
 37  *      This function is called when the user requests to read from
 38  *      the tty.  The line discipline will return whatever characters
 39  *      it has buffered up for the user.  If this function is not
 40  *      defined, the user will receive an EIO error.
 41  * 
 42  * ssize_t (*write)(struct tty_struct * tty, struct file * file,
 43  *                  const unsigned char * buf, size_t nr);
 44  *
 45  *      This function is called when the user requests to write to the
 46  *      tty.  The line discipline will deliver the characters to the
 47  *      low-level tty device for transmission, optionally performing
 48  *      some processing on the characters first.  If this function is
 49  *      not defined, the user will receive an EIO error.
 50  * 
 51  * int  (*ioctl)(struct tty_struct * tty, struct file * file,
 52  *               unsigned int cmd, unsigned long arg);
 53  *
 54  *      This function is called when the user requests an ioctl which
 55  *      is not handled by the tty layer or the low-level tty driver.
 56  *      It is intended for ioctls which affect line discpline
 57  *      operation.  Note that the search order for ioctls is (1) tty
 58  *      layer, (2) tty low-level driver, (3) line discpline.  So a
 59  *      low-level driver can "grab" an ioctl request before the line
 60  *      discpline has a chance to see it.
 61  * 
 62  * long (*compat_ioctl)(struct tty_struct * tty, struct file * file,
 63  *                      unsigned int cmd, unsigned long arg);
 64  *
 65  *      Process ioctl calls from 32-bit process on 64-bit system
 66  *
 67  * void (*set_termios)(struct tty_struct *tty, struct ktermios * old);
 68  *
 69  *      This function notifies the line discpline that a change has
 70  *      been made to the termios structure.
 71  * 
 72  * int  (*poll)(struct tty_struct * tty, struct file * file,
 73  *                poll_table *wait);
 74  *
 75  *      This function is called when a user attempts to select/poll on a
 76  *      tty device.  It is solely the responsibility of the line
 77  *      discipline to handle poll requests.
 78  *
 79  * void (*receive_buf)(struct tty_struct *, const unsigned char *cp,
 80  *                     char *fp, int count);
 81  *
 82  *      This function is called by the low-level tty driver to send
 83  *      characters received by the hardware to the line discpline for
 84  *      processing.  <cp> is a pointer to the buffer of input
 85  *      character received by the device.  <fp> is a pointer to a
 86  *      pointer of flag bytes which indicate whether a character was
 87  *      received with a parity error, etc.
 88  * 
 89  * void (*write_wakeup)(struct tty_struct *);
 90  *
 91  *      This function is called by the low-level tty driver to signal
 92  *      that line discpline should try to send more characters to the
 93  *      low-level driver for transmission.  If the line discpline does
 94  *      not have any more data to send, it can just return.
 95  *
 96  * int (*hangup)(struct tty_struct *)
 97  *
 98  *      Called on a hangup. Tells the discipline that it should
 99  *      cease I/O to the tty driver. Can sleep. The driver should
100  *      seek to perform this action quickly but should wait until
101  *      any pending driver I/O is completed.
102  *
103  * void (*dcd_change)(struct tty_struct *tty, unsigned int status,
104  *                      struct pps_event_time *ts)
105  *
106  *      Tells the discipline that the DCD pin has changed its status and
107  *      the relative timestamp. Pointer ts cannot be NULL.
108  */
109 
110 #include <linux/fs.h>
111 #include <linux/wait.h>
112 #include <linux/pps_kernel.h>
113 
114 struct tty_ldisc_ops {
115         int     magic;
116         char    *name;
117         int     num;
118         int     flags;
119         
120         /*
121          * The following routines are called from above.
122          */
123         int     (*open)(struct tty_struct *);
124         void    (*close)(struct tty_struct *);
125         void    (*flush_buffer)(struct tty_struct *tty);
126         ssize_t (*chars_in_buffer)(struct tty_struct *tty);
127         ssize_t (*read)(struct tty_struct * tty, struct file * file,
128                         unsigned char __user * buf, size_t nr);
129         ssize_t (*write)(struct tty_struct * tty, struct file * file,
130                          const unsigned char * buf, size_t nr); 
131         int     (*ioctl)(struct tty_struct * tty, struct file * file,
132                          unsigned int cmd, unsigned long arg);
133         long    (*compat_ioctl)(struct tty_struct * tty, struct file * file,
134                                 unsigned int cmd, unsigned long arg);
135         void    (*set_termios)(struct tty_struct *tty, struct ktermios * old);
136         unsigned int (*poll)(struct tty_struct *, struct file *,
137                              struct poll_table_struct *);
138         int     (*hangup)(struct tty_struct *tty);
139         
140         /*
141          * The following routines are called from below.
142          */
143         void    (*receive_buf)(struct tty_struct *, const unsigned char *cp,
144                                char *fp, int count);
145         void    (*write_wakeup)(struct tty_struct *);
146         void    (*dcd_change)(struct tty_struct *, unsigned int,
147                                 struct pps_event_time *);
148 
149         struct  module *owner;
150         
151         int refcount;
152 };
153 
154 struct tty_ldisc {
155         struct tty_ldisc_ops *ops;
156         atomic_t users;
157 };
158 
159 #define TTY_LDISC_MAGIC 0x5403
160 
161 #define LDISC_FLAG_DEFINED      0x00000001
162 
163 #define MODULE_ALIAS_LDISC(ldisc) \
164         MODULE_ALIAS("tty-ldisc-" __stringify(ldisc))
165 
166 #endif /* _LINUX_TTY_LDISC_H */
167 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp