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 struct ucred; 52 struct devfs_bitmap; 53 54 /* 55 * This structure is at the base of every device args structure 56 */ 57 struct dev_generic_args { 58 struct syslink_desc *a_desc; 59 struct cdev *a_dev; 60 }; 61 62 typedef struct dev_generic_args dev_default_args; 63 64 /* 65 * int d_open(cdev_t dev, int oflags, int devtype, struct ucred *cred) 66 */ 67 struct dev_open_args { 68 struct dev_generic_args a_head; 69 int a_oflags; 70 int a_devtype; 71 struct ucred *a_cred; 72 }; 73 74 /* 75 * int d_close(cdev_t dev, int fflag, int devtype) 76 */ 77 struct dev_close_args { 78 struct dev_generic_args a_head; 79 int a_fflag; 80 int a_devtype; 81 }; 82 83 /* 84 * int d_read(cdev_t dev, struct uio *uio, int ioflag) 85 */ 86 struct dev_read_args { 87 struct dev_generic_args a_head; 88 struct uio *a_uio; 89 int a_ioflag; 90 }; 91 92 /* 93 * int d_write(cdev_t dev, struct uio *uio, int ioflag) 94 */ 95 struct dev_write_args { 96 struct dev_generic_args a_head; 97 struct uio *a_uio; 98 int a_ioflag; 99 }; 100 101 /* 102 * int d_ioctl(cdev_t dev, u_long cmd, caddr_t data, int fflag, 103 * struct ucred *cred, struct sysmsg *msg) 104 */ 105 struct dev_ioctl_args { 106 struct dev_generic_args a_head; 107 u_long a_cmd; 108 caddr_t a_data; 109 int a_fflag; 110 struct ucred *a_cred; 111 struct sysmsg *a_sysmsg; 112 }; 113 114 /* 115 * int d_poll(cdev_t dev, int events) 116 */ 117 struct dev_poll_args { 118 struct dev_generic_args a_head; 119 int a_events; 120 }; 121 122 /* 123 * int d_mmap(cdev_t dev, vm_offset_t offset, int nprot) 124 */ 125 struct dev_mmap_args { 126 struct dev_generic_args a_head; 127 vm_offset_t a_offset; 128 int a_nprot; 129 int a_result; /* page number */ 130 }; 131 132 /* 133 * void d_strategy(cdev_t dev, struct bio *bio) 134 */ 135 struct dev_strategy_args { 136 struct dev_generic_args a_head; 137 struct bio *a_bio; 138 }; 139 140 /* 141 * void d_dump(cdev_t dev) 142 */ 143 struct dev_dump_args { 144 struct dev_generic_args a_head; 145 u_int64_t a_count; 146 u_int64_t a_blkno; 147 u_int a_secsize; 148 }; 149 150 /* 151 * int d_psize(cdev_t dev) 152 */ 153 struct dev_psize_args { 154 struct dev_generic_args a_head; 155 int64_t a_result; 156 }; 157 158 /* 159 * int d_kqfilter(cdev_t dev, struct knote *kn) 160 */ 161 struct dev_kqfilter_args { 162 struct dev_generic_args a_head; 163 struct knote *a_kn; 164 int a_result; 165 }; 166 167 /* 168 * int d_clone(cdev_t dev); 169 */ 170 struct dev_clone_args { 171 struct dev_generic_args a_head; 172 173 struct cdev *a_dev; 174 const char *a_name; 175 size_t a_namelen; 176 struct ucred *a_cred; 177 int a_mode; 178 }; 179 180 /* 181 * int d_revoke(cdev_t dev) 182 */ 183 struct dev_revoke_args { 184 struct dev_generic_args a_head; 185 }; 186 187 /* 188 * Typedefs to help drivers declare the driver routines and such 189 */ 190 typedef int d_default_t (struct dev_generic_args *ap); 191 typedef int d_open_t (struct dev_open_args *ap); 192 typedef int d_close_t (struct dev_close_args *ap); 193 typedef int d_read_t (struct dev_read_args *ap); 194 typedef int d_write_t (struct dev_write_args *ap); 195 typedef int d_ioctl_t (struct dev_ioctl_args *ap); 196 typedef int d_poll_t (struct dev_poll_args *ap); 197 typedef int d_mmap_t (struct dev_mmap_args *ap); 198 typedef int d_strategy_t (struct dev_strategy_args *ap); 199 typedef int d_dump_t (struct dev_dump_args *ap); 200 typedef int d_psize_t (struct dev_psize_args *ap); 201 typedef int d_kqfilter_t (struct dev_kqfilter_args *ap); 202 typedef int d_clone_t (struct dev_clone_args *ap); 203 typedef int d_revoke_t (struct dev_revoke_args *ap); 204 205 /* 206 * Character device switch table. 207 * 208 * NOTE: positions are hard coded for static structure initialization. 209 */ 210 struct dev_ops { 211 struct { 212 const char *name; /* base name, e.g. 'da' */ 213 int maj; /* major device number */ 214 u_int flags; /* D_XXX flags */ 215 void *data; /* custom driver data */ 216 int refs; /* ref count */ 217 int id; 218 } head; 219 220 #define dev_ops_first_field d_default 221 d_default_t *d_default; 222 d_open_t *d_open; 223 d_close_t *d_close; 224 d_read_t *d_read; 225 d_write_t *d_write; 226 d_ioctl_t *d_ioctl; 227 d_poll_t *d_poll; 228 d_mmap_t *d_mmap; 229 d_strategy_t *d_strategy; 230 d_dump_t *d_dump; 231 d_psize_t *d_psize; 232 d_kqfilter_t *d_kqfilter; 233 d_clone_t *d_clone; /* clone from base dev_ops */ 234 d_revoke_t *d_revoke; 235 #define dev_ops_last_field d_revoke 236 }; 237 238 /* 239 * Types for d_flags. 240 */ 241 #define D_TAPE 0x0001 242 #define D_DISK 0x0002 243 #define D_TTY 0x0004 244 #define D_MEM 0x0008 245 246 #define D_TYPEMASK 0xffff 247 #define D_SEEKABLE (D_TAPE | D_DISK | D_MEM) 248 249 /* 250 * Flags for d_flags. 251 */ 252 #define D_MEMDISK 0x00010000 /* memory type disk */ 253 #define D_NAGGED 0x00020000 /* nagged about missing make_dev() */ 254 #define D_CANFREE 0x00040000 /* can free blocks */ 255 #define D_TRACKCLOSE 0x00080000 /* track all closes */ 256 #define D_MASTER 0x00100000 /* used by pty/tty code */ 257 #define D_KQFILTER 0x00200000 /* has kqfilter entry */ 258 259 /* 260 * A union of all possible argument structures. 261 */ 262 union dev_args_union { 263 struct dev_generic_args du_head; 264 struct dev_open_args du_open; 265 struct dev_close_args du_close; 266 struct dev_read_args du_read; 267 struct dev_write_args du_write; 268 struct dev_ioctl_args du_ioctl; 269 struct dev_poll_args du_poll; 270 struct dev_mmap_args du_mmap; 271 struct dev_strategy_args du_strategy; 272 struct dev_dump_args du_dump; 273 struct dev_psize_args du_psize; 274 struct dev_kqfilter_args du_kqfilter; 275 struct dev_clone_args du_clone; 276 }; 277 278 /* 279 * Linking structure for mask/match registration 280 */ 281 struct dev_ops_link { 282 struct dev_ops_link *next; 283 u_int mask; 284 u_int match; 285 struct dev_ops *ops; 286 }; 287 288 struct dev_ops_maj { 289 RB_ENTRY(dev_ops_maj) rbnode; /* red-black tree of major nums */ 290 struct dev_ops_link *link; 291 int maj; 292 }; 293 294 RB_HEAD(dev_ops_rb_tree, dev_ops_maj); 295 RB_PROTOTYPE2(dev_ops_rb_tree, dev_ops_maj, rbnode, rb_dev_ops_compare, int); 296 297 #ifdef _KERNEL 298 299 extern struct dev_ops dead_dev_ops; 300 301 struct disk; 302 struct sysmsg; 303 304 int dev_dopen(cdev_t dev, int oflags, int devtype, struct ucred *cred); 305 int dev_dclose(cdev_t dev, int fflag, int devtype); 306 void dev_dstrategy(cdev_t dev, struct bio *bio); 307 void dev_dstrategy_chain(cdev_t dev, struct bio *bio); 308 int dev_dioctl(cdev_t dev, u_long cmd, caddr_t data, int fflag, 309 struct ucred *cred, struct sysmsg *msg); 310 int dev_ddump(cdev_t dev); 311 int64_t dev_dpsize(cdev_t dev); 312 int dev_dread(cdev_t dev, struct uio *uio, int ioflag); 313 int dev_dwrite(cdev_t dev, struct uio *uio, int ioflag); 314 int dev_dpoll(cdev_t dev, int events); 315 int dev_dkqfilter(cdev_t dev, struct knote *kn); 316 int dev_dmmap(cdev_t dev, vm_offset_t offset, int nprot); 317 int dev_dclone(cdev_t dev); 318 int dev_drevoke(cdev_t dev); 319 320 int dev_drefs(cdev_t dev); 321 const char *dev_dname(cdev_t dev); 322 int dev_dmaj(cdev_t dev); 323 int dev_dflags(cdev_t dev); 324 int dev_doperate(struct dev_generic_args *ap); 325 int dev_doperate_ops(struct dev_ops *, struct dev_generic_args *ap); 326 327 d_default_t nodefault; 328 d_open_t noopen; 329 d_close_t noclose; 330 d_read_t noread; 331 d_write_t nowrite; 332 d_ioctl_t noioctl; 333 d_poll_t nopoll; 334 d_mmap_t nommap; 335 d_strategy_t nostrategy; 336 d_dump_t nodump; 337 d_psize_t nopsize; 338 d_kqfilter_t nokqfilter; 339 d_clone_t noclone; 340 d_revoke_t norevoke; 341 342 d_open_t nullopen; 343 d_close_t nullclose; 344 345 extern struct syslink_desc dev_default_desc; 346 extern struct syslink_desc dev_open_desc; 347 extern struct syslink_desc dev_close_desc; 348 extern struct syslink_desc dev_read_desc; 349 extern struct syslink_desc dev_write_desc; 350 extern struct syslink_desc dev_ioctl_desc; 351 extern struct syslink_desc dev_dump_desc; 352 extern struct syslink_desc dev_psize_desc; 353 extern struct syslink_desc dev_poll_desc; 354 extern struct syslink_desc dev_mmap_desc; 355 extern struct syslink_desc dev_strategu_desc; 356 extern struct syslink_desc dev_kqfilter_desc; 357 extern struct syslink_desc dev_clone_desc; 358 359 void compile_dev_ops(struct dev_ops *); 360 int dev_ops_remove_all(struct dev_ops *ops); 361 int dev_ops_remove_minor(struct dev_ops *ops, int minor); 362 struct dev_ops *dev_ops_intercept(cdev_t, struct dev_ops *); 363 void dev_ops_restore(cdev_t, struct dev_ops *); 364 365 cdev_t make_dev(struct dev_ops *ops, int minor, uid_t uid, gid_t gid, 366 int perms, const char *fmt, ...) __printflike(6, 7); 367 cdev_t make_dev_covering(struct dev_ops *ops, cdev_t rdev, int minor, uid_t uid, 368 gid_t gid, int perms, const char *fmt, ...) __printflike(7, 8); 369 cdev_t make_only_dev(struct dev_ops *ops, int minor, uid_t uid, gid_t gid, 370 int perms, const char *fmt, ...) __printflike(6, 7); 371 cdev_t make_only_devfs_dev(struct dev_ops *ops, int minor, uid_t uid, gid_t gid, 372 int perms, const char *fmt, ...) __printflike(6, 7); 373 void destroy_only_dev(cdev_t dev); 374 int make_dev_alias(cdev_t target, const char *fmt, ...); 375 cdev_t make_autoclone_dev(struct dev_ops *ops, struct devfs_bitmap *bitmap, 376 d_clone_t *nhandler, uid_t uid, gid_t gid, int perms, const char *fmt, ...); 377 void destroy_autoclone_dev(cdev_t dev, struct devfs_bitmap *bitmap); 378 void sync_devs(void); 379 380 #endif 381 382 #endif 383 384