2 * Copyright (c) 2003,2004,2007 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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
35 #ifndef _SYS_DEVICE_H_
36 #define _SYS_DEVICE_H_
40 #include <sys/types.h>
45 #ifndef _SYS_SYSLINK_RPC_H_
46 #include <sys/syslink_rpc.h>
55 * This structure is at the base of every device args structure
57 struct dev_generic_args {
58 struct syslink_desc *a_desc;
62 typedef struct dev_generic_args dev_default_args;
65 * int d_open(cdev_t dev, int oflags, int devtype, struct ucred *cred)
67 struct dev_open_args {
68 struct dev_generic_args a_head;
76 * int d_close(cdev_t dev, int fflag, int devtype)
78 struct dev_close_args {
79 struct dev_generic_args a_head;
86 * int d_read(cdev_t dev, struct uio *uio, int ioflag)
88 struct dev_read_args {
89 struct dev_generic_args a_head;
96 * int d_write(cdev_t dev, struct uio *uio, int ioflag)
98 struct dev_write_args {
99 struct dev_generic_args a_head;
106 * int d_ioctl(cdev_t dev, u_long cmd, caddr_t data, int fflag,
107 * struct ucred *cred, struct sysmsg *msg)
109 struct dev_ioctl_args {
110 struct dev_generic_args a_head;
114 struct ucred *a_cred;
115 struct sysmsg *a_sysmsg;
120 * int d_mmap(cdev_t dev, vm_offset_t offset, int nprot)
122 struct dev_mmap_args {
123 struct dev_generic_args a_head;
124 vm_offset_t a_offset;
126 int64_t a_result; /* page number */
131 * int d_mmap_single(cdev_t dev, vm_ooffset_t *offset, vm_size_t size,
132 * struct vm_object **object, int nprot)
134 struct dev_mmap_single_args {
135 struct dev_generic_args a_head;
136 vm_ooffset_t *a_offset;
138 struct vm_object **a_object;
144 * void d_strategy(cdev_t dev, struct bio *bio)
146 struct dev_strategy_args {
147 struct dev_generic_args a_head;
152 * void d_dump(cdev_t dev, void *virtual, vm_offset_t physical,
153 off_t offset, size_t length)
155 struct dev_dump_args {
156 struct dev_generic_args a_head;
161 vm_offset_t a_physical;
167 * int d_psize(cdev_t dev)
169 struct dev_psize_args {
170 struct dev_generic_args a_head;
175 * int d_kqfilter(cdev_t dev, struct knote *kn)
177 struct dev_kqfilter_args {
178 struct dev_generic_args a_head;
185 * int d_clone(cdev_t dev);
187 struct dev_clone_args {
188 struct dev_generic_args a_head;
193 struct ucred *a_cred;
198 * int d_revoke(cdev_t dev)
200 struct dev_revoke_args {
201 struct dev_generic_args a_head;
205 * Typedefs to help drivers declare the driver routines and such
207 typedef int d_default_t (struct dev_generic_args *ap);
208 typedef int d_open_t (struct dev_open_args *ap);
209 typedef int d_close_t (struct dev_close_args *ap);
210 typedef int d_read_t (struct dev_read_args *ap);
211 typedef int d_write_t (struct dev_write_args *ap);
212 typedef int d_ioctl_t (struct dev_ioctl_args *ap);
213 typedef int d_mmap_t (struct dev_mmap_args *ap);
214 typedef int d_mmap_single_t (struct dev_mmap_single_args *ap);
215 typedef int d_strategy_t (struct dev_strategy_args *ap);
216 typedef int d_dump_t (struct dev_dump_args *ap);
217 typedef int d_psize_t (struct dev_psize_args *ap);
218 typedef int d_kqfilter_t (struct dev_kqfilter_args *ap);
219 typedef int d_clone_t (struct dev_clone_args *ap);
220 typedef int d_revoke_t (struct dev_revoke_args *ap);
223 * Character device switch table.
225 * NOTE: positions are hard coded for static structure initialization.
229 const char *name; /* base name, e.g. 'da' */
230 int maj; /* major device number */
231 u_int flags; /* D_XXX flags */
232 void *data; /* custom driver data */
233 int refs; /* ref count */
237 #define dev_ops_first_field d_default
238 d_default_t *d_default;
245 d_mmap_single_t *d_mmap_single;
246 d_strategy_t *d_strategy;
249 d_kqfilter_t *d_kqfilter;
250 d_clone_t *d_clone; /* clone from base dev_ops */
251 d_revoke_t *d_revoke;
252 int (*d_uksmap)(struct cdev *dev, struct vm_page *fake);
253 #define dev_ops_last_field d_uksmap
260 #define D_TAPE 0x0001
261 #define D_DISK 0x0002
265 #define D_TYPEMASK 0xffff
266 #define D_SEEKABLE (D_TAPE | D_DISK | D_MEM)
271 * D_NOEMERGPGR Indicates complex layering, the emergency pager
272 * should skip buffers related to such devices.
275 #define D_MEMDISK 0x00010000 /* memory type disk */
276 #define D_UNUSED17 0x00020000 /* was: nagged about missing make_dev() */
277 #define D_CANFREE 0x00040000 /* can free blocks */
278 #define D_TRACKCLOSE 0x00080000 /* track all closes */
279 #define D_MASTER 0x00100000 /* used by pty/tty code */
280 #define D_NOEMERGPGR 0x00200000 /* too complex for emergency pager */
281 #define D_MPSAFE 0x00400000 /* all dev_d*() calls are MPSAFE */
282 #define D_KVABIO 0x00800000 /* device support KVABIO API */
283 #define D_QUICK 0x01000000 /* no fancy open/close support needed*/
287 * A union of all possible argument structures.
290 union dev_args_union {
291 struct dev_generic_args du_head;
292 struct dev_open_args du_open;
293 struct dev_close_args du_close;
294 struct dev_read_args du_read;
295 struct dev_write_args du_write;
296 struct dev_ioctl_args du_ioctl;
297 struct dev_mmap_args du_mmap;
298 struct dev_strategy_args du_strategy;
299 struct dev_dump_args du_dump;
300 struct dev_psize_args du_psize;
301 struct dev_kqfilter_args du_kqfilter;
302 struct dev_clone_args du_clone;
308 * Linking structure for mask/match registration
310 struct dev_ops_link {
311 struct dev_ops_link *next;
318 RB_ENTRY(dev_ops_maj) rbnode; /* red-black tree of major nums */
319 struct dev_ops_link *link;
323 RB_HEAD(dev_ops_rb_tree, dev_ops_maj);
324 RB_PROTOTYPE2(dev_ops_rb_tree, dev_ops_maj, rbnode, rb_dev_ops_compare, int);
329 extern struct dev_ops dead_dev_ops;
334 int dev_dopen(cdev_t dev, int oflags, int devtype, struct ucred *cred, struct file *fp);
335 int dev_dclose(cdev_t dev, int fflag, int devtype, struct file *fp);
336 void dev_dstrategy(cdev_t dev, struct bio *bio);
337 void dev_dstrategy_chain(cdev_t dev, struct bio *bio);
338 int dev_dioctl(cdev_t dev, u_long cmd, caddr_t data,
339 int fflag, struct ucred *cred, struct sysmsg *msg, struct file *fp);
340 int dev_ddump(cdev_t dev, void *virtual, vm_offset_t physical, off_t offset,
342 int64_t dev_dpsize(cdev_t dev);
343 int dev_dread(cdev_t dev, struct uio *uio, int ioflag, struct file *fp);
344 int dev_dwrite(cdev_t dev, struct uio *uio, int ioflag, struct file *fp);
345 int dev_dkqfilter(cdev_t dev, struct knote *kn, struct file *fp);
346 int64_t dev_dmmap(cdev_t dev, vm_offset_t offset, int nprot, struct file *fp);
347 int dev_dmmap_single(cdev_t dev, vm_ooffset_t *offset, vm_size_t size,
348 struct vm_object **object, int nprot, struct file *fp);
349 int dev_dclone(cdev_t dev);
350 int dev_drevoke(cdev_t dev);
352 int dev_drefs(cdev_t dev);
353 const char *dev_dname(cdev_t dev);
354 int dev_dmaj(cdev_t dev);
355 int dev_dflags(cdev_t dev);
356 int dev_doperate(struct dev_generic_args *ap);
357 int dev_doperate_ops(struct dev_ops *, struct dev_generic_args *ap);
362 extern struct syslink_desc dev_default_desc;
363 extern struct syslink_desc dev_open_desc;
364 extern struct syslink_desc dev_close_desc;
365 extern struct syslink_desc dev_read_desc;
366 extern struct syslink_desc dev_write_desc;
367 extern struct syslink_desc dev_ioctl_desc;
368 extern struct syslink_desc dev_dump_desc;
369 extern struct syslink_desc dev_psize_desc;
370 extern struct syslink_desc dev_mmap_desc;
371 extern struct syslink_desc dev_mmap_single_desc;
372 extern struct syslink_desc dev_strategy_desc;
373 extern struct syslink_desc dev_kqfilter_desc;
374 extern struct syslink_desc dev_clone_desc;
376 void compile_dev_ops(struct dev_ops *);
377 int dev_ops_remove_all(struct dev_ops *ops);
378 int dev_ops_remove_minor(struct dev_ops *ops, int minor);
379 struct dev_ops *dev_ops_intercept(cdev_t, struct dev_ops *);
380 void dev_ops_restore(cdev_t, struct dev_ops *);
382 #define MAKEDEV_MINNBUF 14
383 char *makedev_unit_b32(char *nbuf, uintmax_t num);
384 cdev_t make_dev(struct dev_ops *ops, int minor, uid_t uid, gid_t gid,
385 int perms, const char *fmt, ...) __printflike(6, 7);
386 cdev_t make_dev_covering(struct dev_ops *ops, struct dev_ops *bops, int minor,
387 uid_t uid, gid_t gid, int perms, const char *fmt, ...) __printflike(7, 8);
388 cdev_t make_only_dev(struct dev_ops *ops, int minor, uid_t uid, gid_t gid,
389 int perms, const char *fmt, ...) __printflike(6, 7);
390 cdev_t make_only_dev_covering(struct dev_ops *ops, struct dev_ops *bops, int minor,
391 uid_t uid, gid_t gid, int perms, const char *fmt, ...) __printflike(7,8);
392 cdev_t make_only_devfs_dev(struct dev_ops *ops, int minor, uid_t uid, gid_t gid,
393 int perms, const char *fmt, ...) __printflike(6, 7);
394 void destroy_only_dev(cdev_t dev);
395 int make_dev_alias(cdev_t target, const char *fmt, ...) __printflike(2, 3);
396 int destroy_dev_alias(cdev_t target, const char *fmt, ...) __printflike(2, 3);
397 cdev_t make_autoclone_dev(struct dev_ops *ops, struct devfs_bitmap *bitmap,
398 d_clone_t *nhandler, uid_t uid, gid_t gid, int perms,
399 const char *fmt, ...) __printflike(7, 8);
400 void destroy_autoclone_dev(cdev_t dev, struct devfs_bitmap *bitmap);
401 void sync_devs(void);