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 35 #ifndef _SYS_DEVICE_H_ 36 #define _SYS_DEVICE_H_ 37 38 #ifndef _SYS_TYPES_H_ 39 #include <sys/types.h> 40 #endif 41 #ifndef _SYS_TREE_H_ 42 #include <sys/tree.h> 43 #endif 44 #ifndef _SYS_SYSLINK_RPC_H_ 45 #include <sys/syslink_rpc.h> 46 #endif 47 48 struct cdev; 49 struct ucred; 50 struct devfs_bitmap; 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, struct sysmsg *msg) 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 struct sysmsg *a_sysmsg; 110 }; 111 112 /* 113 * int d_mmap(cdev_t dev, vm_offset_t offset, int nprot) 114 */ 115 struct dev_mmap_args { 116 struct dev_generic_args a_head; 117 vm_offset_t a_offset; 118 int a_nprot; 119 int a_result; /* page number */ 120 }; 121 122 /* 123 * int d_mmap_single(cdev_t dev, vm_ooffset_t *offset, vm_size_t size, 124 * struct vm_object **object, int nprot) 125 */ 126 struct dev_mmap_single_args { 127 struct dev_generic_args a_head; 128 vm_ooffset_t *a_offset; 129 vm_size_t a_size; 130 struct vm_object **a_object; 131 int a_nprot; 132 }; 133 134 /* 135 * void d_strategy(cdev_t dev, struct bio *bio) 136 */ 137 struct dev_strategy_args { 138 struct dev_generic_args a_head; 139 struct bio *a_bio; 140 }; 141 142 /* 143 * void d_dump(cdev_t dev, void *virtual, vm_offset_t physical, 144 off_t offset, size_t length) 145 */ 146 struct dev_dump_args { 147 struct dev_generic_args a_head; 148 u_int64_t a_count; 149 u_int64_t a_blkno; 150 u_int a_secsize; 151 void *a_virtual; 152 vm_offset_t a_physical; 153 off_t a_offset; 154 size_t a_length; 155 }; 156 157 /* 158 * int d_psize(cdev_t dev) 159 */ 160 struct dev_psize_args { 161 struct dev_generic_args a_head; 162 int64_t a_result; 163 }; 164 165 /* 166 * int d_kqfilter(cdev_t dev, struct knote *kn) 167 */ 168 struct dev_kqfilter_args { 169 struct dev_generic_args a_head; 170 struct knote *a_kn; 171 int a_result; 172 }; 173 174 /* 175 * int d_clone(cdev_t dev); 176 */ 177 struct dev_clone_args { 178 struct dev_generic_args a_head; 179 180 struct cdev *a_dev; 181 const char *a_name; 182 size_t a_namelen; 183 struct ucred *a_cred; 184 int a_mode; 185 }; 186 187 /* 188 * int d_revoke(cdev_t dev) 189 */ 190 struct dev_revoke_args { 191 struct dev_generic_args a_head; 192 }; 193 194 /* 195 * Typedefs to help drivers declare the driver routines and such 196 */ 197 typedef int d_default_t (struct dev_generic_args *ap); 198 typedef int d_open_t (struct dev_open_args *ap); 199 typedef int d_close_t (struct dev_close_args *ap); 200 typedef int d_read_t (struct dev_read_args *ap); 201 typedef int d_write_t (struct dev_write_args *ap); 202 typedef int d_ioctl_t (struct dev_ioctl_args *ap); 203 typedef int d_mmap_t (struct dev_mmap_args *ap); 204 typedef int d_mmap_single_t (struct dev_mmap_single_args *ap); 205 typedef int d_strategy_t (struct dev_strategy_args *ap); 206 typedef int d_dump_t (struct dev_dump_args *ap); 207 typedef int d_psize_t (struct dev_psize_args *ap); 208 typedef int d_kqfilter_t (struct dev_kqfilter_args *ap); 209 typedef int d_clone_t (struct dev_clone_args *ap); 210 typedef int d_revoke_t (struct dev_revoke_args *ap); 211 212 /* 213 * Character device switch table. 214 * 215 * NOTE: positions are hard coded for static structure initialization. 216 */ 217 struct dev_ops { 218 struct { 219 const char *name; /* base name, e.g. 'da' */ 220 int maj; /* major device number */ 221 u_int flags; /* D_XXX flags */ 222 void *data; /* custom driver data */ 223 int refs; /* ref count */ 224 int id; 225 } head; 226 227 #define dev_ops_first_field d_default 228 d_default_t *d_default; 229 d_open_t *d_open; 230 d_close_t *d_close; 231 d_read_t *d_read; 232 d_write_t *d_write; 233 d_ioctl_t *d_ioctl; 234 d_mmap_t *d_mmap; 235 d_mmap_single_t *d_mmap_single; 236 d_strategy_t *d_strategy; 237 d_dump_t *d_dump; 238 d_psize_t *d_psize; 239 d_kqfilter_t *d_kqfilter; 240 d_clone_t *d_clone; /* clone from base dev_ops */ 241 d_revoke_t *d_revoke; 242 #define dev_ops_last_field d_revoke 243 }; 244 245 /* 246 * Types for d_flags. 247 */ 248 #define D_TAPE 0x0001 249 #define D_DISK 0x0002 250 #define D_TTY 0x0004 251 #define D_MEM 0x0008 252 253 #define D_TYPEMASK 0xffff 254 #define D_SEEKABLE (D_TAPE | D_DISK | D_MEM) 255 256 /* 257 * Flags for d_flags. 258 */ 259 #define D_MEMDISK 0x00010000 /* memory type disk */ 260 #define D_NAGGED 0x00020000 /* nagged about missing make_dev() */ 261 #define D_CANFREE 0x00040000 /* can free blocks */ 262 #define D_TRACKCLOSE 0x00080000 /* track all closes */ 263 #define D_MASTER 0x00100000 /* used by pty/tty code */ 264 #define D_UNUSED200000 0x00200000 265 #define D_MPSAFE 0x00400000 /* all dev_d*() calls are MPSAFE */ 266 267 /* 268 * A union of all possible argument structures. 269 */ 270 union dev_args_union { 271 struct dev_generic_args du_head; 272 struct dev_open_args du_open; 273 struct dev_close_args du_close; 274 struct dev_read_args du_read; 275 struct dev_write_args du_write; 276 struct dev_ioctl_args du_ioctl; 277 struct dev_mmap_args du_mmap; 278 struct dev_strategy_args du_strategy; 279 struct dev_dump_args du_dump; 280 struct dev_psize_args du_psize; 281 struct dev_kqfilter_args du_kqfilter; 282 struct dev_clone_args du_clone; 283 }; 284 285 /* 286 * Linking structure for mask/match registration 287 */ 288 struct dev_ops_link { 289 struct dev_ops_link *next; 290 u_int mask; 291 u_int match; 292 struct dev_ops *ops; 293 }; 294 295 struct dev_ops_maj { 296 RB_ENTRY(dev_ops_maj) rbnode; /* red-black tree of major nums */ 297 struct dev_ops_link *link; 298 int maj; 299 }; 300 301 RB_HEAD(dev_ops_rb_tree, dev_ops_maj); 302 RB_PROTOTYPE2(dev_ops_rb_tree, dev_ops_maj, rbnode, rb_dev_ops_compare, int); 303 304 #ifdef _KERNEL 305 306 extern struct dev_ops dead_dev_ops; 307 308 struct disk; 309 struct sysmsg; 310 311 int dev_dopen(cdev_t dev, int oflags, int devtype, struct ucred *cred); 312 int dev_dclose(cdev_t dev, int fflag, int devtype); 313 void dev_dstrategy(cdev_t dev, struct bio *bio); 314 void dev_dstrategy_chain(cdev_t dev, struct bio *bio); 315 int dev_dioctl(cdev_t dev, u_long cmd, caddr_t data, int fflag, 316 struct ucred *cred, struct sysmsg *msg); 317 int dev_ddump(cdev_t dev, void *virtual, vm_offset_t physical, off_t offset, 318 size_t length); 319 int64_t dev_dpsize(cdev_t dev); 320 int dev_dread(cdev_t dev, struct uio *uio, int ioflag); 321 int dev_dwrite(cdev_t dev, struct uio *uio, int ioflag); 322 int dev_dkqfilter(cdev_t dev, struct knote *kn); 323 int dev_dmmap(cdev_t dev, vm_offset_t offset, int nprot); 324 int dev_dmmap_single(cdev_t dev, vm_ooffset_t *offset, vm_size_t size, 325 struct vm_object **object, int nprot); 326 int dev_dclone(cdev_t dev); 327 int dev_drevoke(cdev_t dev); 328 329 int dev_drefs(cdev_t dev); 330 const char *dev_dname(cdev_t dev); 331 int dev_dmaj(cdev_t dev); 332 int dev_dflags(cdev_t dev); 333 int dev_doperate(struct dev_generic_args *ap); 334 int dev_doperate_ops(struct dev_ops *, struct dev_generic_args *ap); 335 336 d_default_t nodefault; 337 d_open_t noopen; 338 d_close_t noclose; 339 d_read_t noread; 340 d_write_t nowrite; 341 d_ioctl_t noioctl; 342 d_mmap_t nommap; 343 d_mmap_single_t nommap_single; 344 d_strategy_t nostrategy; 345 d_dump_t nodump; 346 d_psize_t nopsize; 347 d_kqfilter_t nokqfilter; 348 d_clone_t noclone; 349 d_revoke_t norevoke; 350 351 d_open_t nullopen; 352 d_close_t nullclose; 353 354 extern struct syslink_desc dev_default_desc; 355 extern struct syslink_desc dev_open_desc; 356 extern struct syslink_desc dev_close_desc; 357 extern struct syslink_desc dev_read_desc; 358 extern struct syslink_desc dev_write_desc; 359 extern struct syslink_desc dev_ioctl_desc; 360 extern struct syslink_desc dev_dump_desc; 361 extern struct syslink_desc dev_psize_desc; 362 extern struct syslink_desc dev_mmap_desc; 363 extern struct syslink_desc dev_mmap_single_desc; 364 extern struct syslink_desc dev_strategy_desc; 365 extern struct syslink_desc dev_kqfilter_desc; 366 extern struct syslink_desc dev_clone_desc; 367 368 void compile_dev_ops(struct dev_ops *); 369 int dev_ops_remove_all(struct dev_ops *ops); 370 int dev_ops_remove_minor(struct dev_ops *ops, int minor); 371 struct dev_ops *dev_ops_intercept(cdev_t, struct dev_ops *); 372 void dev_ops_restore(cdev_t, struct dev_ops *); 373 374 cdev_t make_dev(struct dev_ops *ops, int minor, uid_t uid, gid_t gid, 375 int perms, const char *fmt, ...) __printflike(6, 7); 376 cdev_t make_dev_covering(struct dev_ops *ops, struct dev_ops *bops, int minor, 377 uid_t uid, gid_t gid, int perms, const char *fmt, ...) __printflike(7, 8); 378 cdev_t make_only_dev(struct dev_ops *ops, int minor, uid_t uid, gid_t gid, 379 int perms, const char *fmt, ...) __printflike(6, 7); 380 cdev_t make_only_dev_covering(struct dev_ops *ops, struct dev_ops *bops, int minor, 381 uid_t uid, gid_t gid, int perms, const char *fmt, ...) __printflike(7,8); 382 cdev_t make_only_devfs_dev(struct dev_ops *ops, int minor, uid_t uid, gid_t gid, 383 int perms, const char *fmt, ...) __printflike(6, 7); 384 void destroy_only_dev(cdev_t dev); 385 int make_dev_alias(cdev_t target, const char *fmt, ...) __printflike(2, 3); 386 int destroy_dev_alias(cdev_t target, const char *fmt, ...) __printflike(2, 3); 387 cdev_t make_autoclone_dev(struct dev_ops *ops, struct devfs_bitmap *bitmap, 388 d_clone_t *nhandler, uid_t uid, gid_t gid, int perms, 389 const char *fmt, ...) __printflike(7, 8); 390 void destroy_autoclone_dev(cdev_t dev, struct devfs_bitmap *bitmap); 391 void sync_devs(void); 392 393 #endif 394 395 #endif 396 397