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