sys/sys/device.h

   1 /*
   2  * Copyright (c) 2003,2004,2007 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@backplane.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $DragonFly: src/sys/sys/device.h,v 1.11 2007/05/17 03:02:00 dillon Exp $
  35  */
  36
  37 #ifndef _SYS_DEVICE_H_
  38 #define _SYS_DEVICE_H_
  39
  40 #ifndef _SYS_TYPES_H_
  41 #include <sys/types.h>
  42 #endif
  43 #ifndef _SYS_TREE_H_
  44 #include <sys/tree.h>
  45 #endif
  46 #ifndef _SYS_SYSLINK_RPC_H_
  47 #include <sys/syslink_rpc.h>
  48 #endif
  49
  50 struct cdev;
  51
  52 /*
  53  * This structure is at the base of every device args structure
  54  */
  55 struct dev_generic_args {
  56         struct syslink_desc *a_desc;
  57         struct cdev *a_dev;
  58 };
  59
  60 typedef struct dev_generic_args dev_default_args;
  61
  62 /*
  63  * int d_open(cdev_t dev, int oflags, int devtype, struct ucred *cred)
  64  */
  65 struct dev_open_args {
  66         struct dev_generic_args a_head;
  67         int             a_oflags;
  68         int             a_devtype;
  69         struct ucred    *a_cred;
  70 };
  71
  72 /*
  73  * int d_close(cdev_t dev, int fflag, int devtype)
  74  */
  75 struct dev_close_args {
  76         struct dev_generic_args a_head;
  77         int             a_fflag;
  78         int             a_devtype;
  79 };
  80
  81 /*
  82  * int d_read(cdev_t dev, struct uio *uio, int ioflag)
  83  */
  84 struct dev_read_args {
  85         struct dev_generic_args a_head;
  86         struct uio      *a_uio;
  87         int             a_ioflag;
  88 };
  89
  90 /*
  91  * int d_write(cdev_t dev, struct uio *uio, int ioflag)
  92  */
  93 struct dev_write_args {
  94         struct dev_generic_args a_head;
  95         struct uio      *a_uio;
  96         int             a_ioflag;
  97 };
  98
  99 /*
 100  * int d_ioctl(cdev_t dev, u_long cmd, caddr_t data, int fflag,
 101  *             struct ucred *cred)
 102  */
 103 struct dev_ioctl_args {
 104         struct dev_generic_args a_head;
 105         u_long          a_cmd;
 106         caddr_t         a_data;
 107         int             a_fflag;
 108         struct ucred    *a_cred;
 109 };
 110
 111 /*
 112  * int d_poll(cdev_t dev, int events)
 113  */
 114 struct dev_poll_args {
 115         struct dev_generic_args a_head;
 116         int             a_events;
 117 };
 118
 119 /*
 120  * int d_mmap(cdev_t dev, vm_offset_t offset, int nprot)
 121  */
 122 struct dev_mmap_args {
 123         struct dev_generic_args a_head;
 124         vm_offset_t     a_offset;
 125         int             a_nprot;
 126         int             a_result;       /* page number */
 127 };
 128
 129 /*
 130  * void d_strategy(cdev_t dev, struct bio *bio)
 131  */
 132 struct dev_strategy_args {
 133         struct dev_generic_args a_head;
 134         struct bio      *a_bio;
 135 };
 136
 137 /*
 138  * void d_dump(cdev_t dev)
 139  */
 140 struct dev_dump_args {
 141         struct dev_generic_args a_head;
 142         u_int64_t       a_count;
 143         u_int64_t       a_blkno;
 144         u_int           a_secsize;
 145 };
 146
 147 /*
 148  * int d_psize(cdev_t dev)
 149  */
 150 struct dev_psize_args {
 151         struct dev_generic_args a_head;
 152         int64_t         a_result;
 153 };
 154
 155 /*
 156  * int d_kqfilter(cdev_t dev, struct knote *kn)
 157  */
 158 struct dev_kqfilter_args {
 159         struct dev_generic_args a_head;
 160         struct knote    *a_kn;
 161         int             a_result;
 162 };
 163
 164 /*
 165  * int d_clone(cdev_t dev);
 166  */
 167 struct dev_clone_args {
 168         struct dev_generic_args a_head;
 169 };
 170
 171 /*
 172  * int d_revoke(cdev_t dev)
 173  */
 174 struct dev_revoke_args {
 175         struct dev_generic_args a_head;
 176 };
 177
 178 /*
 179  * Typedefs to help drivers declare the driver routines and such
 180  */
 181 typedef int d_default_t (struct dev_generic_args *ap);
 182 typedef int d_open_t (struct dev_open_args *ap);
 183 typedef int d_close_t (struct dev_close_args *ap);
 184 typedef int d_read_t (struct dev_read_args *ap);
 185 typedef int d_write_t (struct dev_write_args *ap);
 186 typedef int d_ioctl_t (struct dev_ioctl_args *ap);
 187 typedef int d_poll_t (struct dev_poll_args *ap);
 188 typedef int d_mmap_t (struct dev_mmap_args *ap);
 189 typedef int d_strategy_t (struct dev_strategy_args *ap);
 190 typedef int d_dump_t (struct dev_dump_args *ap);
 191 typedef int d_psize_t (struct dev_psize_args *ap);
 192 typedef int d_kqfilter_t (struct dev_kqfilter_args *ap);
 193 typedef int d_clone_t (struct dev_clone_args *ap);
 194 typedef int d_revoke_t (struct dev_revoke_args *ap);
 195
 196 /*
 197  * Character device switch table.
 198  *
 199  * NOTE: positions are hard coded for static structure initialization.
 200  */
 201 struct dev_ops {
 202         struct {
 203                 const char      *name;  /* base name, e.g. 'da' */
 204                 int             maj;    /* major device number */
 205                 u_int           flags;  /* D_XXX flags */
 206                 void            *data;  /* custom driver data */
 207                 int             refs;   /* ref count */
 208         } head;
 209
 210 #define dev_ops_first_field     d_default
 211         d_default_t     *d_default;
 212         d_open_t        *d_open;
 213         d_close_t       *d_close;
 214         d_read_t        *d_read;
 215         d_write_t       *d_write;
 216         d_ioctl_t       *d_ioctl;
 217         d_poll_t        *d_poll;
 218         d_mmap_t        *d_mmap;
 219         d_strategy_t    *d_strategy;
 220         d_dump_t        *d_dump;
 221         d_psize_t       *d_psize;
 222         d_kqfilter_t    *d_kqfilter;
 223         d_clone_t       *d_clone;       /* clone from base dev_ops */
 224         d_revoke_t      *d_revoke;
 225 #define dev_ops_last_field      d_revoke
 226 };
 227
 228 /*
 229  * Types for d_flags.
 230  */
 231 #define D_TAPE          0x0001
 232 #define D_DISK          0x0002
 233 #define D_TTY           0x0004
 234 #define D_MEM           0x0008
 235
 236 #define D_TYPEMASK      0xffff
 237
 238 /*
 239  * Flags for d_flags.
 240  */
 241 #define D_MEMDISK       0x00010000      /* memory type disk */
 242 #define D_NAGGED        0x00020000      /* nagged about missing make_dev() */
 243 #define D_CANFREE       0x00040000      /* can free blocks */
 244 #define D_TRACKCLOSE    0x00080000      /* track all closes */
 245 #define D_MASTER        0x00100000      /* used by pty/tty code */
 246 #define D_KQFILTER      0x00200000      /* has kqfilter entry */
 247
 248 /*
 249  * A union of all possible argument structures.
 250  */
 251 union dev_args_union {
 252         struct dev_generic_args du_head;
 253         struct dev_open_args    du_open;
 254         struct dev_close_args   du_close;
 255         struct dev_read_args    du_read;
 256         struct dev_write_args   du_write;
 257         struct dev_ioctl_args   du_ioctl;
 258         struct dev_poll_args    du_poll;
 259         struct dev_mmap_args    du_mmap;
 260         struct dev_strategy_args du_strategy;
 261         struct dev_dump_args    du_dump;
 262         struct dev_psize_args   du_psize;
 263         struct dev_kqfilter_args du_kqfilter;
 264         struct dev_clone_args   du_clone;
 265 };
 266
 267 /*
 268  * Linking structure for mask/match registration
 269  */
 270 struct dev_ops_link {
 271         struct dev_ops_link *next;
 272         u_int           mask;
 273         u_int           match;
 274         struct dev_ops  *ops;
 275 };
 276
 277 struct dev_ops_maj {
 278         RB_ENTRY(dev_ops_maj) rbnode; /* red-black tree of major nums */
 279         struct dev_ops_link *link;
 280         int             maj;
 281 };
 282
 283 RB_HEAD(dev_ops_rb_tree, dev_ops_maj);
 284 RB_PROTOTYPE2(dev_ops_rb_tree, dev_ops_maj, rbnode, rb_dev_ops_compare, int);
 285
 286 #ifdef _KERNEL
 287
 288 extern struct dev_ops dead_dev_ops;
 289
 290 struct disk;
 291
 292 int dev_dopen(cdev_t dev, int oflags, int devtype, struct ucred *cred);
 293 int dev_dclose(cdev_t dev, int fflag, int devtype);
 294 void dev_dstrategy(cdev_t dev, struct bio *bio);
 295 void dev_dstrategy_chain(cdev_t dev, struct bio *bio);
 296 int dev_dioctl(cdev_t dev, u_long cmd, caddr_t data, int fflag,
 297                 struct ucred *cred);
 298 int dev_ddump(cdev_t dev);
 299 int64_t dev_dpsize(cdev_t dev);
 300 int dev_dread(cdev_t dev, struct uio *uio, int ioflag);
 301 int dev_dwrite(cdev_t dev, struct uio *uio, int ioflag);
 302 int dev_dpoll(cdev_t dev, int events);
 303 int dev_dkqfilter(cdev_t dev, struct knote *kn);
 304 int dev_dmmap(cdev_t dev, vm_offset_t offset, int nprot);
 305 int dev_dclone(cdev_t dev);
 306 int dev_drevoke(cdev_t dev);
 307
 308 int dev_drefs(cdev_t dev);
 309 const char *dev_dname(cdev_t dev);
 310 int dev_dmaj(cdev_t dev);
 311 int dev_dflags(cdev_t dev);
 312 int dev_doperate(struct dev_generic_args *ap);
 313 int dev_doperate_ops(struct dev_ops *, struct dev_generic_args *ap);
 314
 315 d_default_t     nodefault;
 316 d_open_t        noopen;
 317 d_close_t       noclose;
 318 d_read_t        noread;
 319 d_write_t       nowrite;
 320 d_ioctl_t       noioctl;
 321 d_poll_t        nopoll;
 322 d_mmap_t        nommap;
 323 d_strategy_t    nostrategy;
 324 d_dump_t        nodump;
 325 d_psize_t       nopsize;
 326 d_kqfilter_t    nokqfilter;
 327 d_clone_t       noclone;
 328 d_revoke_t      norevoke;
 329
 330 d_open_t        nullopen;
 331 d_close_t       nullclose;
 332
 333 extern struct syslink_desc dev_default_desc;
 334 extern struct syslink_desc dev_open_desc;
 335 extern struct syslink_desc dev_close_desc;
 336 extern struct syslink_desc dev_read_desc;
 337 extern struct syslink_desc dev_write_desc;
 338 extern struct syslink_desc dev_ioctl_desc;
 339 extern struct syslink_desc dev_dump_desc;
 340 extern struct syslink_desc dev_psize_desc;
 341 extern struct syslink_desc dev_poll_desc;
 342 extern struct syslink_desc dev_mmap_desc;
 343 extern struct syslink_desc dev_strategu_desc;
 344 extern struct syslink_desc dev_kqfilter_desc;
 345 extern struct syslink_desc dev_clone_desc;
 346
 347 void compile_dev_ops(struct dev_ops *);
 348 int dev_ops_scan(int (*callback)(struct dev_ops *, void *), void *arg);
 349 int dev_ops_add(struct dev_ops *, u_int mask, u_int match);
 350 int dev_ops_remove(struct dev_ops *, u_int mask, u_int match);
 351 void dev_ops_release(struct dev_ops *);
 352 struct dev_ops *dev_ops_add_override(cdev_t, struct dev_ops *, u_int, u_int);
 353 void dev_ops_remove_override(struct dev_ops *ops, u_int mask, u_int match);
 354
 355 struct dev_ops *dev_ops_intercept(cdev_t, struct dev_ops *);
 356 void dev_ops_restore(cdev_t, struct dev_ops *);
 357 struct dev_ops *dev_ops_get(int x, int y);
 358
 359 void destroy_all_devs(struct dev_ops *, u_int mask, u_int match);
 360 cdev_t make_dev(struct dev_ops *ops, int minor, uid_t uid, gid_t gid,
 361                 int perms, const char *fmt, ...) __printflike(6, 7);
 362 cdev_t make_adhoc_dev (struct dev_ops *ops, int minor);
 363
 364 #endif
 365
 366 #endif
 367