sys/sys/linedisc.h

   1 /*-
   2  * Copyright (c) 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * (c) UNIX System Laboratories, Inc.
   5  * All or some portions of this file are derived from material licensed
   6  * to the University of California by American Telephone and Telegraph
   7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
   8  * the permission of UNIX System Laboratories, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      @(#)conf.h      8.5 (Berkeley) 1/9/95
  39  * $Id: conf.h,v 1.49 1999/01/21 16:15:53 peter Exp $
  40  */
  41
  42 #ifndef _SYS_CONF_H_
  43 #define _SYS_CONF_H_
  44
  45 /*
  46  * Definitions of device driver entry switches
  47  */
  48
  49 struct buf;
  50 struct proc;
  51 struct specinfo;
  52 struct tty;
  53 struct uio;
  54 struct vnode;
  55
  56 typedef int d_open_t __P((dev_t dev, int oflags, int devtype, struct proc *p));
  57 typedef int d_close_t __P((dev_t dev, int fflag, int devtype, struct proc *p));
  58 typedef void d_strategy_t __P((struct buf *bp));
  59 typedef int d_parms_t __P((dev_t dev, struct specinfo *sinfo, int ctl));
  60 typedef int d_ioctl_t __P((dev_t dev, u_long cmd, caddr_t data,
  61                            int fflag, struct proc *p));
  62 typedef int d_dump_t __P((dev_t dev));
  63 typedef int d_psize_t __P((dev_t dev));
  64
  65 typedef int d_read_t __P((dev_t dev, struct uio *uio, int ioflag));
  66 typedef int d_write_t __P((dev_t dev, struct uio *uio, int ioflag));
  67 typedef void d_stop_t __P((struct tty *tp, int rw));
  68 typedef int d_reset_t __P((dev_t dev));
  69 typedef struct tty *d_devtotty_t __P((dev_t dev));
  70 typedef int d_poll_t __P((dev_t dev, int events, struct proc *p));
  71 typedef int d_mmap_t __P((dev_t dev, vm_offset_t offset, int nprot));
  72
  73 typedef int l_open_t __P((dev_t dev, struct tty *tp));
  74 typedef int l_close_t __P((struct tty *tp, int flag));
  75 typedef int l_read_t __P((struct tty *tp, struct uio *uio, int flag));
  76 typedef int l_write_t __P((struct tty *tp, struct uio *uio, int flag));
  77 typedef int l_ioctl_t __P((struct tty *tp, u_long cmd, caddr_t data,
  78                            int flag, struct proc *p));
  79 typedef int l_rint_t __P((int c, struct tty *tp));
  80 typedef int l_start_t __P((struct tty *tp));
  81 typedef int l_modem_t __P((struct tty *tp, int flag));
  82
  83 /*
  84  * Types for d_type.
  85  */
  86 #define D_TAPE  1
  87 #define D_DISK  2
  88 #define D_TTY   3
  89
  90 #define D_TYPEMASK      0xffff
  91
  92 /*
  93  * Flags for d_flags.
  94  */
  95 #define D_NOCLUSTERR    0x10000         /* disables cluter read */
  96 #define D_NOCLUSTERW    0x20000         /* disables cluster write */
  97 #define D_NOCLUSTERRW   (D_NOCLUSTERR | D_NOCLUSTERW)
  98 #define D_CANFREE       0x40000         /* can free blocks */
  99
 100 /*
 101  * Control type for d_parms() call.
 102  */
 103 #define DPARM_GET       0               /* ask device to load parms in  */
 104
 105 /*
 106  * Character device switch table
 107  */
 108 struct cdevsw {
 109         d_open_t        *d_open;
 110         d_close_t       *d_close;
 111         d_read_t        *d_read;
 112         d_write_t       *d_write;
 113         d_ioctl_t       *d_ioctl;
 114         d_stop_t        *d_stop;
 115         d_reset_t       *d_reset;       /* XXX not used */
 116         d_devtotty_t    *d_devtotty;
 117         d_poll_t        *d_poll;
 118         d_mmap_t        *d_mmap;
 119         d_strategy_t    *d_strategy;
 120         char            *d_name;        /* base device name, e.g. 'vn' */
 121         d_parms_t       *d_parms;       /* populate/override specinfo */
 122         int             d_maj;
 123         d_dump_t        *d_dump;
 124         d_psize_t       *d_psize;
 125         u_int           d_flags;
 126         int             d_maxio;
 127         int             d_bmaj;
 128 };
 129
 130 #ifdef KERNEL
 131 extern struct cdevsw *bdevsw[];
 132 extern struct cdevsw *cdevsw[];
 133 #endif
 134
 135 /*
 136  * Line discipline switch table
 137  */
 138 struct linesw {
 139         l_open_t        *l_open;
 140         l_close_t       *l_close;
 141         l_read_t        *l_read;
 142         l_write_t       *l_write;
 143         l_ioctl_t       *l_ioctl;
 144         l_rint_t        *l_rint;
 145         l_start_t       *l_start;
 146         l_modem_t       *l_modem;
 147         u_char          l_hotchar;
 148 };
 149
 150 #ifdef KERNEL
 151 extern struct linesw linesw[];
 152 extern int nlinesw;
 153
 154 int ldisc_register __P((int , struct linesw *));
 155 void ldisc_deregister __P((int));
 156 #define LDISC_LOAD      -1              /* Loadable line discipline */
 157 #endif
 158
 159 /*
 160  * Swap device table
 161  */
 162 struct swdevt {
 163         dev_t   sw_dev;
 164         int     sw_flags;
 165         int     sw_nblks;
 166         struct  vnode *sw_vp;
 167 };
 168 #define SW_FREED        0x01
 169 #define SW_SEQUENTIAL   0x02
 170 #define sw_freed        sw_flags        /* XXX compat */
 171
 172 #ifdef KERNEL
 173 d_open_t        noopen;
 174 d_close_t       noclose;
 175 d_read_t        noread;
 176 d_write_t       nowrite;
 177 d_ioctl_t       noioctl;
 178 d_stop_t        nostop;
 179 d_reset_t       noreset;
 180 d_devtotty_t    nodevtotty;
 181 d_mmap_t        nommap;
 182
 183 /* Bogus defines for compatibility. */
 184 #define noioc           noioctl
 185 #define nostrat         nostrategy
 186 #define zerosize        nopsize
 187 /*
 188  * XXX d_strategy seems to be unused for cdevs that aren't associated with
 189  * bdevs and called without checking for it being non-NULL for bdevs.
 190  */
 191 #define nostrategy      ((d_strategy_t *)NULL)
 192
 193 d_dump_t        nodump;
 194
 195 /*
 196  * nopsize is little used, so not worth having dummy functions for.
 197  */
 198 #define nopsize ((d_psize_t *)NULL)
 199
 200 d_open_t        nullopen;
 201 d_close_t       nullclose;
 202 #define nullstop nostop         /* one void return is as good as another */
 203 #define nullreset noreset       /* one unused function is as good as another */
 204
 205 l_read_t        l_noread;
 206 l_write_t       l_nowrite;
 207
 208 struct module;
 209
 210 struct cdevsw_module_data {
 211         int     (*chainevh)(struct module *, int, void *); /* next handler */
 212         void    *chainarg;      /* arg for next event handler */
 213         dev_t   dev;            /* device major to use */
 214         struct  cdevsw *cdevsw; /* device functions */
 215 };
 216
 217 struct bdevsw_module_data {
 218         int     (*chainevh)(struct module *, int, void *); /* next handler */
 219         void    *chainarg;      /* arg for next event handler */
 220         int     bdev;           /* device major to use */
 221         int     cdev;           /* device major to use */
 222         struct  cdevsw *cdevsw; /* device functions */
 223 };
 224
 225 #define CDEV_MODULE(name, major, devsw, evh, arg)                       \
 226 static struct cdevsw_module_data name##_cdevsw_mod = {                  \
 227     evh, arg, major == NODEV ? NODEV : makedev(major, 0), &devsw        \
 228 };                                                                      \
 229                                                                         \
 230 static moduledata_t name##_mod = {                                      \
 231     #name,                                                              \
 232     cdevsw_module_handler,                                              \
 233     &name##_cdevsw_mod                                                  \
 234 };                                                                      \
 235 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE+major)
 236
 237 #define BDEV_MODULE(name, bdev, cdev, devsw, evh, arg)                  \
 238 static struct bdevsw_module_data name##_bdevsw_mod = {                  \
 239     evh, arg, bdev == NODEV ? NODEV : makedev(bdev, 0),                 \
 240     cdev == NODEV ? NODEV :  makedev(cdev, 0), &devsw                   \
 241 };                                                                      \
 242                                                                         \
 243 static moduledata_t name##_mod = {                                      \
 244     #name,                                                              \
 245     bdevsw_module_handler,                                              \
 246     &name##_bdevsw_mod                                                  \
 247 };                                                                      \
 248 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE+cdev)
 249
 250 int     cdevsw_module_handler __P((struct module *mod, int what, void *arg));
 251 int     bdevsw_module_handler __P((struct module *mod, int what, void *arg));
 252
 253 int     cdevsw_add __P((dev_t *descrip,struct cdevsw *new,struct cdevsw **old));
 254 void    cdevsw_add_generic __P((int bdev, int cdev, struct cdevsw *cdevsw));
 255 dev_t   chrtoblk __P((dev_t dev));
 256 int     iskmemdev __P((dev_t dev));
 257 int     iszerodev __P((dev_t dev));
 258 void    setconf __P((void));
 259 #endif /* KERNEL */
 260
 261 #endif /* !_SYS_CONF_H_ */