2 * Copyright (c) 1990, 1993
3 * The Regents of the University of California. All rights reserved.
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.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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 * 4. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * @(#)conf.h 8.5 (Berkeley) 1/9/95
44 #include <sys/eventhandler.h>
46 #include <sys/queue.h>
57 #define SI_ETERNAL 0x0001 /* never destroyed */
58 #define SI_ALIAS 0x0002 /* carrier of alias name */
59 #define SI_NAMED 0x0004 /* make_dev{_alias} has been called */
60 #define SI_CHEAPCLONE 0x0008 /* can be removed_dev'ed when vnode reclaims */
61 #define SI_CHILD 0x0010 /* child of another struct cdev **/
62 #define SI_DEVOPEN 0x0020 /* opened by device */
63 #define SI_CONSOPEN 0x0040 /* opened by console */
64 #define SI_DUMPDEV 0x0080 /* is kernel dumpdev */
65 #define SI_CANDELETE 0x0100 /* can do BIO_DELETE */
66 #define SI_CLONELIST 0x0200 /* on a clone list */
67 struct timespec si_atime;
68 struct timespec si_ctime;
69 struct timespec si_mtime;
73 struct ucred *si_cred; /* cached clone-time credential */
76 LIST_ENTRY(cdev) si_list;
77 LIST_ENTRY(cdev) si_clone;
78 LIST_HEAD(, cdev) si_children;
79 LIST_ENTRY(cdev) si_siblings;
80 struct cdev *si_parent;
82 void *si_drv1, *si_drv2;
83 struct cdevsw *si_devsw;
84 int si_iosize_max; /* maximum I/O size (for physio &al) */
86 u_long si_threadcount;
88 struct snapdata *__sid_snapdata;
90 char __si_namebuf[SPECNAMELEN + 1];
93 #define si_snapdata __si_u.__sid_snapdata
98 * Definitions of device driver entry switches
111 * Note: d_thread_t is provided as a transition aid for those drivers
112 * that treat struct proc/struct thread as an opaque data type and
113 * exist in substantially the same form in both 4.x and 5.x. Writers
114 * of drivers that dips into the d_thread_t structure should use
115 * struct thread or struct proc as appropriate for the version of the
116 * OS they are using. It is provided in lieu of each device driver
117 * inventing its own way of doing this. While it does violate style(9)
118 * in a number of ways, this violation is deemed to be less
119 * important than the benefits that a uniform API between releases
122 * Users of struct thread/struct proc that aren't device drivers should
123 * not use d_thread_t.
126 typedef struct thread d_thread_t;
128 typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td);
129 typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, struct file *fp);
130 typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td);
131 typedef void d_strategy_t(struct bio *bp);
132 typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data,
133 int fflag, struct thread *td);
135 typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag);
136 typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag);
137 typedef int d_poll_t(struct cdev *dev, int events, struct thread *td);
138 typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn);
139 typedef int d_mmap_t(struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr,
141 typedef int d_mmap2_t(struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr,
142 int nprot, vm_memattr_t *memattr);
143 typedef int d_mmap_single_t(struct cdev *cdev, vm_ooffset_t *offset,
144 vm_size_t size, struct vm_object **object, int nprot);
145 typedef void d_purge_t(struct cdev *dev);
147 typedef int dumper_t(
148 void *_priv, /* Private to the driver. */
149 void *_virtual, /* Virtual (mapped) address. */
150 vm_offset_t _physical, /* Physical address of virtual. */
151 off_t _offset, /* Byte-offset to write at. */
152 size_t _length); /* Number of bytes to dump. */
159 #define D_TAPE 0x0001
160 #define D_DISK 0x0002
166 #define D_TYPEMASK 0xffff
169 * Flags for d_flags which the drivers can set.
171 #define D_TRACKCLOSE 0x00080000 /* track all closes */
172 #define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */
173 #define D_PSEUDO 0x00200000 /* make_dev() can return NULL */
174 #define D_NEEDGIANT 0x00400000 /* driver want Giant */
175 #define D_NEEDMINOR 0x00800000 /* driver uses clone_create() */
176 #define D_MMAP2 0x01000000 /* driver uses d_mmap2() */
181 #define D_VERSION_00 0x20011966
182 #define D_VERSION_01 0x17032005 /* Add d_uid,gid,mode & kind */
183 #define D_VERSION_02 0x28042009 /* Add d_mmap_single */
184 #define D_VERSION D_VERSION_02
187 * Flags used for internal housekeeping
189 #define D_INIT 0x80000000 /* cdevsw initialized */
192 * Character device switch table
199 d_fdopen_t *d_fdopen;
209 d_strategy_t *d_strategy;
211 d_kqfilter_t *d_kqfilter;
213 d_mmap_single_t *d_mmap_single;
219 /* These fields should not be messed with by drivers */
220 LIST_ENTRY(cdevsw) d_list;
221 LIST_HEAD(, cdev) d_devs;
224 struct cdevsw *gianttrick;
225 SLIST_ENTRY(cdevsw) postfree_list;
228 #define d_mmap __d_mmap.old
229 #define d_mmap2 __d_mmap.new
230 #define d_gianttrick __d_giant.gianttrick
231 #define d_postfree_list __d_giant.postfree_list
235 struct devsw_module_data {
236 int (*chainevh)(struct module *, int, void *); /* next handler */
237 void *chainarg; /* arg for next event handler */
238 /* Do not initialize fields hereafter */
241 #define DEV_MODULE(name, evh, arg) \
242 static moduledata_t name##_mod = { \
247 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
250 void clone_setup(struct clonedevs **cdp);
251 void clone_cleanup(struct clonedevs **);
252 #define CLONE_UNITMASK 0xfffff
253 #define CLONE_FLAG0 (CLONE_UNITMASK + 1)
254 int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, int extra);
256 int count_dev(struct cdev *_dev);
257 void delist_dev(struct cdev *_dev);
258 void destroy_dev(struct cdev *_dev);
259 int destroy_dev_sched(struct cdev *dev);
260 int destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg);
261 void destroy_dev_drain(struct cdevsw *csw);
262 void drain_dev_clone_events(void);
263 struct cdevsw *dev_refthread(struct cdev *_dev, int *_ref);
264 struct cdevsw *devvn_refthread(struct vnode *vp, struct cdev **devp, int *_ref);
265 void dev_relthread(struct cdev *_dev, int _ref);
266 void dev_depends(struct cdev *_pdev, struct cdev *_cdev);
267 void dev_ref(struct cdev *dev);
268 void dev_refl(struct cdev *dev);
269 void dev_rel(struct cdev *dev);
270 void dev_strategy(struct cdev *dev, struct buf *bp);
271 struct cdev *make_dev(struct cdevsw *_devsw, int _unit, uid_t _uid, gid_t _gid,
272 int _perms, const char *_fmt, ...) __printflike(6, 7);
273 struct cdev *make_dev_cred(struct cdevsw *_devsw, int _unit,
274 struct ucred *_cr, uid_t _uid, gid_t _gid, int _perms,
275 const char *_fmt, ...) __printflike(7, 8);
276 #define MAKEDEV_REF 0x01
277 #define MAKEDEV_WHTOUT 0x02
278 #define MAKEDEV_NOWAIT 0x04
279 #define MAKEDEV_WAITOK 0x08
280 #define MAKEDEV_ETERNAL 0x10
281 struct cdev *make_dev_credf(int _flags,
282 struct cdevsw *_devsw, int _unit,
283 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode,
284 const char *_fmt, ...) __printflike(8, 9);
285 int make_dev_p(int _flags, struct cdev **_cdev, struct cdevsw *_devsw,
286 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode,
287 const char *_fmt, ...) __printflike(8, 9);
288 struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...)
291 void dev_unlock(void);
295 #define MAKEDEV_ETERNAL_KLD 0
297 #define MAKEDEV_ETERNAL_KLD MAKEDEV_ETERNAL
300 #define dev2unit(d) ((d)->si_drv0)
302 typedef void (*cdevpriv_dtr_t)(void *data);
303 int devfs_get_cdevpriv(void **datap);
304 int devfs_set_cdevpriv(void *priv, cdevpriv_dtr_t dtr);
305 void devfs_clear_cdevpriv(void);
306 void devfs_fpdrop(struct file *fp); /* XXX This is not public KPI */
308 ino_t devfs_alloc_cdp_inode(void);
309 void devfs_free_cdp_inode(ino_t ino);
314 #define UID_NOBODY 65534
319 #define GID_OPERATOR 5
322 #define GID_DIALER 68
323 #define GID_NOBODY 65534
325 typedef void (*dev_clone_fn)(void *arg, struct ucred *cred, char *name,
326 int namelen, struct cdev **result);
328 int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit);
329 EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
331 /* Stuff relating to kernel-dump */
334 dumper_t *dumper; /* Dumping function. */
335 void *priv; /* Private parts. */
336 u_int blocksize; /* Size of block in bytes. */
337 u_int maxiosize; /* Max size allowed for an individual I/O */
338 off_t mediaoffset; /* Initial offset in bytes. */
339 off_t mediasize; /* Space available in bytes. */
342 int set_dumper(struct dumperinfo *);
343 int dump_write(struct dumperinfo *, void *, vm_offset_t, off_t, size_t);
344 void dumpsys(struct dumperinfo *);
345 extern int dumping; /* system is dumping */
349 #endif /* !_SYS_CONF_H_ */