conf.h revision 143622
1/*- 2 * Copyright (c) 1990, 1993 3 * The Regents of the University of California. All rights reserved. 4 * Copyright (c) 2000 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. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 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. 23 * 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 34 * SUCH DAMAGE. 35 * 36 * @(#)conf.h 8.5 (Berkeley) 1/9/95 37 * $FreeBSD: head/sys/sys/conf.h 143622 2005-03-15 09:30:17Z phk $ 38 */ 39 40#ifndef _SYS_CONF_H_ 41#define _SYS_CONF_H_ 42 43#ifdef _KERNEL 44#include <sys/eventhandler.h> 45#else 46#include <sys/queue.h> 47#endif 48 49struct tty; 50struct disk; 51struct vnode; 52struct buf; 53struct snapdata; 54struct devfs_dirent; 55 56struct cdev { 57 u_int si_flags; 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; 70 dev_t si_udev; 71 int si_refcount; 72 LIST_ENTRY(cdev) si_list; 73 LIST_ENTRY(cdev) si_clone; 74 LIST_ENTRY(cdev) si_hash; 75 LIST_HEAD(,devfs_dirent)si_alist; 76 LIST_HEAD(, cdev) si_children; 77 LIST_ENTRY(cdev) si_siblings; 78 struct cdev *si_parent; 79 u_int si_inode; 80 char *si_name; 81 void *si_drv1, *si_drv2; 82 struct cdevsw *si_devsw; 83 int si_iosize_max; /* maximum I/O size (for physio &al) */ 84 uid_t si_uid; 85 gid_t si_gid; 86 mode_t si_mode; 87 u_long si_usecount; 88 u_long si_threadcount; 89 union { 90 struct tty *__sit_tty; 91 struct snapdata *__sid_snapdata; 92 } __si_u; 93 char __si_namebuf[SPECNAMELEN + 1]; 94}; 95 96#define si_tty __si_u.__sit_tty 97#define si_snapdata __si_u.__sid_snapdata 98 99#ifdef _KERNEL 100 101/* 102 * Definitions of device driver entry switches 103 */ 104 105struct bio; 106struct buf; 107struct thread; 108struct uio; 109struct knote; 110struct clonedevs; 111 112/* 113 * Note: d_thread_t is provided as a transition aid for those drivers 114 * that treat struct proc/struct thread as an opaque data type and 115 * exist in substantially the same form in both 4.x and 5.x. Writers 116 * of drivers that dips into the d_thread_t structure should use 117 * struct thread or struct proc as appropriate for the version of the 118 * OS they are using. It is provided in lieu of each device driver 119 * inventing its own way of doing this. While it does violate style(9) 120 * in a number of ways, this violation is deemed to be less 121 * important than the benefits that a uniform API between releases 122 * gives. 123 * 124 * Users of struct thread/struct proc that aren't device drivers should 125 * not use d_thread_t. 126 */ 127 128typedef struct thread d_thread_t; 129 130typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td); 131typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, int fdidx); 132typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td); 133typedef void d_strategy_t(struct bio *bp); 134typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data, 135 int fflag, struct thread *td); 136 137typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag); 138typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag); 139typedef int d_poll_t(struct cdev *dev, int events, struct thread *td); 140typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn); 141typedef int d_mmap_t(struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr, 142 int nprot); 143typedef void d_purge_t(struct cdev *dev); 144 145typedef int d_spare2_t(struct cdev *dev); 146 147typedef 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. */ 153 154#endif /* _KERNEL */ 155 156/* 157 * Types for d_flags. 158 */ 159#define D_TAPE 0x0001 160#define D_DISK 0x0002 161#define D_TTY 0x0004 162#define D_MEM 0x0008 163 164#ifdef _KERNEL 165 166#define D_TYPEMASK 0xffff 167 168/* 169 * Flags for d_flags which the drivers can set. 170 */ 171#define D_MEMDISK 0x00010000 /* memory type disk */ 172#define D_TRACKCLOSE 0x00080000 /* track all closes */ 173#define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */ 174#define D_PSEUDO 0x00200000 /* make_dev() can return NULL */ 175#define D_NEEDGIANT 0x00400000 /* driver want Giant */ 176 177/* 178 * Version numbers. 179 */ 180#define D_VERSION_00 0x20011966 181#define D_VERSION D_VERSION_00 182 183/* 184 * Flags used for internal housekeeping 185 */ 186#define D_INIT 0x80000000 /* cdevsw initialized */ 187#define D_ALLOCMAJ 0x40000000 /* major# is allocated */ 188 189/* 190 * Character device switch table 191 */ 192struct cdevsw { 193 int d_version; 194 int d_maj; 195 u_int d_flags; 196 const char *d_name; 197 d_open_t *d_open; 198 d_fdopen_t *d_fdopen; 199 d_close_t *d_close; 200 d_read_t *d_read; 201 d_write_t *d_write; 202 d_ioctl_t *d_ioctl; 203 d_poll_t *d_poll; 204 d_mmap_t *d_mmap; 205 d_strategy_t *d_strategy; 206 dumper_t *d_dump; 207 d_kqfilter_t *d_kqfilter; 208 d_purge_t *d_purge; 209 d_spare2_t *d_spare2; 210 211 /* These fields should not be messed with by drivers */ 212 LIST_ENTRY(cdevsw) d_list; 213 LIST_HEAD(, cdev) d_devs; 214 int d_spare3; 215}; 216 217#endif /* _KERNEL */ 218 219#ifdef _KERNEL 220 221#define NUMCDEVSW 256 222 223#define MAXMINOR 0xffff00ffU 224 225/* 226 * XXX: do not use MAJOR_AUTO unless you have no choice. In general drivers 227 * should just not initialize .d_maj and that will DTRT. 228 */ 229#define MAJOR_AUTO 0 /* XXX: Not GM */ 230 231struct module; 232 233struct devsw_module_data { 234 int (*chainevh)(struct module *, int, void *); /* next handler */ 235 void *chainarg; /* arg for next event handler */ 236 /* Do not initialize fields hereafter */ 237}; 238 239#define DEV_MODULE(name, evh, arg) \ 240static moduledata_t name##_mod = { \ 241 #name, \ 242 evh, \ 243 arg \ 244}; \ 245DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE) 246 247 248void clone_setup(struct clonedevs **cdp); 249void clone_cleanup(struct clonedevs **); 250#define CLONE_UNITMASK 0xfffff 251#define CLONE_FLAG0 (CLONE_UNITMASK + 1) 252int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, u_int extra); 253 254int count_dev(struct cdev *_dev); 255void destroy_dev(struct cdev *_dev); 256struct cdevsw *dev_refthread(struct cdev *_dev); 257void dev_relthread(struct cdev *_dev); 258int dev_named(struct cdev *_pdev, const char *_name); 259void dev_depends(struct cdev *_pdev, struct cdev *_cdev); 260void dev_ref(struct cdev *dev); 261void dev_rel(struct cdev *dev); 262void dev_strategy(struct cdev *dev, struct buf *bp); 263struct cdev *makebdev(int _maj, int _min); 264struct cdev *make_dev(struct cdevsw *_devsw, int _minor, uid_t _uid, gid_t _gid, 265 int _perms, const char *_fmt, ...) __printflike(6, 7); 266struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...) __printflike(2, 3); 267int dev2unit(struct cdev *_dev); 268void dev_lock(void); 269void dev_unlock(void); 270int unit2minor(int _unit); 271u_int minor2unit(u_int _minor); 272void setconf(void); 273 274void devfs_create(struct cdev *dev); 275void devfs_destroy(struct cdev *dev); 276 277#define UID_ROOT 0 278#define UID_BIN 3 279#define UID_UUCP 66 280 281#define GID_WHEEL 0 282#define GID_KMEM 2 283#define GID_OPERATOR 5 284#define GID_BIN 7 285#define GID_GAMES 13 286#define GID_DIALER 68 287 288typedef void (*dev_clone_fn)(void *arg, char *name, int namelen, struct cdev **result); 289 290int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit); 291EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn); 292 293/* Stuff relating to kernel-dump */ 294 295struct dumperinfo { 296 dumper_t *dumper; /* Dumping function. */ 297 void *priv; /* Private parts. */ 298 u_int blocksize; /* Size of block in bytes. */ 299 off_t mediaoffset; /* Initial offset in bytes. */ 300 off_t mediasize; /* Space available in bytes. */ 301}; 302 303int set_dumper(struct dumperinfo *); 304void dumpsys(struct dumperinfo *); 305extern int dumping; /* system is dumping */ 306 307/* D_TTY related functions */ 308d_close_t ttyclose; 309d_ioctl_t ttyioctl; 310d_kqfilter_t ttykqfilter; 311d_open_t ttyopen; 312d_poll_t ttypoll; 313d_read_t ttyread; 314d_write_t ttywrite; 315 316#endif /* _KERNEL */ 317 318#endif /* !_SYS_CONF_H_ */ 319