sys/sys/linedisc.h

   1 /*-
   2  * Copyright (c) 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * Copyright (c) 2000
   5  *      Poul-Henning Kamp.  All rights reserved.
   6  * (c) UNIX System Laboratories, Inc.
   7  * All or some portions of this file are derived from material licensed
   8  * to the University of California by American Telephone and Telegraph
   9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  10  * the permission of UNIX System Laboratories, Inc.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. All advertising materials mentioning features or use of this software
  21  *    must display the following acknowledgement:
  22  *      This product includes software developed by the University of
  23  *      California, Berkeley and its contributors.
  24  * 4. Neither the name of the University nor the names of its contributors
  25  *    may be used to endorse or promote products derived from this software
  26  *    without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  38  * SUCH DAMAGE.
  39  *
  40  *      @(#)conf.h      8.5 (Berkeley) 1/9/95
  41  * $FreeBSD$
  42  */
  43
  44 #ifndef _SYS_CONF_H_
  45 #define _SYS_CONF_H_
  46
  47 #include <sys/queue.h>
  48 #include <sys/eventhandler.h>
  49
  50 struct tty;
  51 struct disk;
  52 struct vnode;
  53
  54 struct specinfo {
  55         u_int           si_flags;
  56 #define SI_STASHED      0x0001  /* created in stashed storage */
  57 #define SI_ALIAS        0x0002  /* carrier of alias name */
  58 #define SI_NAMED        0x0004  /* make_dev{_alias} has been called */
  59 #define SI_CHEAPCLONE   0x0008  /* can be removed_dev'ed when vnode reclaims */
  60         struct timespec si_atime;
  61         struct timespec si_ctime;
  62         struct timespec si_mtime;
  63         udev_t          si_udev;
  64         LIST_ENTRY(specinfo)    si_hash;
  65         SLIST_HEAD(, vnode)     si_hlist;
  66         LIST_HEAD(, specinfo)   si_names;
  67         u_int           si_inode;
  68         char            si_name[SPECNAMELEN + 1];
  69         void            *si_drv1, *si_drv2;
  70         struct cdevsw   *si_devsw;
  71         int             si_iosize_max;  /* maximum I/O size (for physio &al) */
  72         uid_t           si_uid;
  73         gid_t           si_gid;
  74         mode_t          si_mode;
  75         union {
  76                 struct {
  77                         struct tty *__sit_tty;
  78                 } __si_tty;
  79                 struct {
  80                         struct disk *__sid_disk;
  81                         struct mount *__sid_mountpoint;
  82                         int __sid_bsize_phys; /* min physical block size */
  83                         int __sid_bsize_best; /* optimal block size */
  84                 } __si_disk;
  85         } __si_u;
  86 };
  87
  88 #define si_tty          __si_u.__si_tty.__sit_tty
  89 #define si_disk         __si_u.__si_disk.__sid_disk
  90 #define si_mountpoint   __si_u.__si_disk.__sid_mountpoint
  91 #define si_bsize_phys   __si_u.__si_disk.__sid_bsize_phys
  92 #define si_bsize_best   __si_u.__si_disk.__sid_bsize_best
  93
  94 /*
  95  * Special device management
  96  */
  97 #define SPECHSZ 64
  98 #define SPECHASH(rdev)  (((unsigned)(minor(rdev)))%SPECHSZ)
  99
 100 /*
 101  * Definitions of device driver entry switches
 102  */
 103
 104 struct bio;
 105 struct buf;
 106 struct proc;
 107 struct uio;
 108
 109 typedef int d_open_t __P((dev_t dev, int oflags, int devtype, struct proc *p));
 110 typedef int d_close_t __P((dev_t dev, int fflag, int devtype, struct proc *p));
 111 typedef void d_strategy_t __P((struct bio *bp));
 112 typedef int d_parms_t __P((dev_t dev, struct specinfo *sinfo, int ctl));
 113 typedef int d_ioctl_t __P((dev_t dev, u_long cmd, caddr_t data,
 114                            int fflag, struct proc *p));
 115 typedef int d_dump_t __P((dev_t dev));
 116 typedef int d_psize_t __P((dev_t dev));
 117
 118 typedef int d_read_t __P((dev_t dev, struct uio *uio, int ioflag));
 119 typedef int d_write_t __P((dev_t dev, struct uio *uio, int ioflag));
 120 typedef int d_poll_t __P((dev_t dev, int events, struct proc *p));
 121 typedef int d_mmap_t __P((dev_t dev, vm_offset_t offset, int nprot));
 122
 123 typedef int l_open_t __P((dev_t dev, struct tty *tp));
 124 typedef int l_close_t __P((struct tty *tp, int flag));
 125 typedef int l_read_t __P((struct tty *tp, struct uio *uio, int flag));
 126 typedef int l_write_t __P((struct tty *tp, struct uio *uio, int flag));
 127 typedef int l_ioctl_t __P((struct tty *tp, u_long cmd, caddr_t data,
 128                            int flag, struct proc *p));
 129 typedef int l_rint_t __P((int c, struct tty *tp));
 130 typedef int l_start_t __P((struct tty *tp));
 131 typedef int l_modem_t __P((struct tty *tp, int flag));
 132
 133 /*
 134  * XXX: The dummy argument can be used to do what strategy1() never
 135  * did anywhere:  Create a per device flag to lock the device during
 136  * label/slice surgery, all calls with a dummy == 0 gets stalled on
 137  * a queue somewhere, whereas dummy == 1 are let through.  Once out
 138  * of surgery, reset the flag and restart all the stuff on the stall
 139  * queue.
 140  */
 141 #define BIO_STRATEGY(bp, dummy)                                         \
 142         do {                                                            \
 143         if ((!(bp)->bio_cmd) || ((bp)->bio_cmd & ((bp)->bio_cmd - 1)))  \
 144                 Debugger("bio_cmd botch");                              \
 145         (*devsw((bp)->bio_dev)->d_strategy)(bp);                        \
 146         } while (0)
 147
 148 #define DEV_STRATEGY(bp, dummy)                                         \
 149         do {                                                            \
 150         if ((bp)->b_flags & B_PHYS)                                     \
 151                 (bp)->b_io.bio_offset = (bp)->b_offset;                 \
 152         else                                                            \
 153                 (bp)->b_io.bio_offset = dbtob((bp)->b_blkno);           \
 154         (bp)->b_io.bio_done = bufdonebio;                               \
 155         (bp)->b_io.bio_caller2 = (bp);                                  \
 156         BIO_STRATEGY(&(bp)->b_io, dummy);                               \
 157         } while (0)
 158
 159 /*
 160  * Types for d_flags.
 161  */
 162 #define D_TAPE  0x0001
 163 #define D_DISK  0x0002
 164 #define D_TTY   0x0004
 165 #define D_MEM   0x0008
 166
 167 #define D_TYPEMASK      0xffff
 168
 169 /*
 170  * Flags for d_flags.
 171  */
 172 #define D_MEMDISK       0x10000         /* memory type disk */
 173 #define D_NAGGED        0x20000         /* nagged about missing make_dev() */
 174 #define D_CANFREE       0x40000         /* can free blocks */
 175 #define D_TRACKCLOSE    0x80000         /* track all closes */
 176 #define D_MMAP_ANON     0x100000        /* special treatment in vm_mmap.c */
 177
 178 /*
 179  * Character device switch table
 180  */
 181 struct cdevsw {
 182         d_open_t        *d_open;
 183         d_close_t       *d_close;
 184         d_read_t        *d_read;
 185         d_write_t       *d_write;
 186         d_ioctl_t       *d_ioctl;
 187         d_poll_t        *d_poll;
 188         d_mmap_t        *d_mmap;
 189         d_strategy_t    *d_strategy;
 190         const char      *d_name;        /* base device name, e.g. 'vn' */
 191         int             d_maj;
 192         d_dump_t        *d_dump;
 193         d_psize_t       *d_psize;
 194         u_int           d_flags;
 195         /* This following field is deprecated.  Please don't initialize */
 196         int             d_XXXbmaj;
 197 };
 198
 199 /*
 200  * Line discipline switch table
 201  */
 202 struct linesw {
 203         l_open_t        *l_open;
 204         l_close_t       *l_close;
 205         l_read_t        *l_read;
 206         l_write_t       *l_write;
 207         l_ioctl_t       *l_ioctl;
 208         l_rint_t        *l_rint;
 209         l_start_t       *l_start;
 210         l_modem_t       *l_modem;
 211         u_char          l_hotchar;
 212 };
 213
 214 #ifdef _KERNEL
 215 extern struct linesw linesw[];
 216 extern int nlinesw;
 217
 218 int ldisc_register __P((int , struct linesw *));
 219 void ldisc_deregister __P((int));
 220 #define LDISC_LOAD      -1              /* Loadable line discipline */
 221 #endif
 222
 223 /*
 224  * Swap device table
 225  */
 226 struct swdevt {
 227         udev_t  sw_dev;                 /* For quasibogus swapdev reporting */
 228         int     sw_flags;
 229         int     sw_nblks;
 230         struct  vnode *sw_vp;
 231         dev_t   sw_device;
 232 };
 233 #define SW_FREED        0x01
 234 #define SW_SEQUENTIAL   0x02
 235 #define sw_freed        sw_flags        /* XXX compat */
 236
 237 #ifdef _KERNEL
 238 d_open_t        noopen;
 239 d_close_t       noclose;
 240 d_read_t        noread;
 241 d_write_t       nowrite;
 242 d_ioctl_t       noioctl;
 243 d_mmap_t        nommap;
 244 #define nostrategy      ((d_strategy_t *)NULL)
 245 #define nopoll  seltrue
 246
 247 d_dump_t        nodump;
 248
 249 #define NUMCDEVSW 256
 250
 251 /*
 252  * nopsize is little used, so not worth having dummy functions for.
 253  */
 254 #define nopsize ((d_psize_t *)NULL)
 255
 256 d_open_t        nullopen;
 257 d_close_t       nullclose;
 258
 259 l_read_t        l_noread;
 260 l_write_t       l_nowrite;
 261
 262 struct module;
 263
 264 struct devsw_module_data {
 265         int     (*chainevh)(struct module *, int, void *); /* next handler */
 266         void    *chainarg;      /* arg for next event handler */
 267         /* Do not initialize fields hereafter */
 268 };
 269
 270 #define DEV_MODULE(name, evh, arg)                                      \
 271 static moduledata_t name##_mod = {                                      \
 272     #name,                                                              \
 273     evh,                                                                \
 274     arg                                                                 \
 275 };                                                                      \
 276 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
 277
 278
 279 int     cdevsw_add __P((struct cdevsw *new));
 280 int     cdevsw_remove __P((struct cdevsw *old));
 281 int     count_dev __P((dev_t dev));
 282 void    destroy_dev __P((dev_t dev));
 283 struct cdevsw *devsw __P((dev_t dev));
 284 const char *devtoname __P((dev_t dev));
 285 void    freedev __P((dev_t dev));
 286 int     iszerodev __P((dev_t dev));
 287 dev_t   makebdev __P((int maj, int min));
 288 dev_t   make_dev __P((struct cdevsw *devsw, int minor, uid_t uid, gid_t gid, int perms, char *fmt, ...)) __printflike(6, 7);
 289 dev_t   make_dev_alias __P((dev_t pdev, char *fmt, ...)) __printflike(2, 3);
 290 int     dev2unit __P((dev_t dev));
 291 int     unit2minor __P((int unit));
 292 void    setconf __P((void));
 293 dev_t   getdiskbyname(char *name);
 294
 295 /* This is type of the function DEVFS uses to hook into the kernel with */
 296 typedef void devfs_create_t __P((dev_t dev));
 297 typedef void devfs_destroy_t __P((dev_t dev));
 298
 299 extern devfs_create_t *devfs_create_hook;
 300 extern devfs_destroy_t *devfs_destroy_hook;
 301 extern int devfs_present;
 302
 303 /*
 304  * XXX: This included for when DEVFS resurfaces
 305  */
 306
 307 #define         UID_ROOT        0
 308 #define         UID_BIN         3
 309 #define         UID_UUCP        66
 310
 311 #define         GID_WHEEL       0
 312 #define         GID_KMEM        2
 313 #define         GID_OPERATOR    5
 314 #define         GID_BIN         7
 315 #define         GID_GAMES       13
 316 #define         GID_DIALER      68
 317
 318 typedef void (*dev_clone_fn) __P((void *arg, char *name, int namelen, dev_t *result));
 319
 320 int dev_stdclone __P((char *name, char **namep, char *stem, int *unit));
 321 EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
 322 #endif /* _KERNEL */
 323
 324 #endif /* !_SYS_CONF_H_ */