1 .\" Copyright (c) 1999 Chris Costello
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" $FreeBSD: src/share/man/man9/make_dev.9,v 1.2.2.3 2001/12/17 11:30:18 ru Exp $
26 .\" $DragonFly: src/share/man/man9/make_dev.9,v 1.3 2006/05/26 19:39:40 swildner Exp $
28 .Dd September 11, 2009
33 .Nm destroy_only_dev ,
34 .Nm devfs_scan_callback ,
35 .Nm dev_ops_intercept ,
36 .Nm dev_ops_remove_all ,
37 .Nm dev_ops_remove_minor ,
44 .Nd "device entry manipulation functions"
49 .Fn destroy_dev "cdev_t dev"
51 .Fn destroy_only_dev "cdev_t dev"
53 .Fn devfs_scan_callback "devfs_scan_t *callback"
55 .Fn dev_ops_intercept "cdev_t dev" "struct dev_ops *iops"
57 .Fn dev_ops_remove_all "struct dev_ops *ops"
59 .Fn dev_ops_restore "cdev_t dev" "struct dev_ops *oops"
61 .Fn dev_ops_remove_minor "struct dev_ops *ops" "int minor"
63 .Fn make_dev "struct dev_ops *ops" "int minor" "uid_t uid" "gid_t gid" "int perms" "char *fmt" ...
65 .Fn make_dev_alias "cdev_t target" "const char *fmt" ...
67 .Fn make_dev_covering "struct dev_ops *ops" "cdev_t rdev" "int minor" "uid_t uid" "gid_t gid" "int perms" "char *fmt" ...
69 .Fn make_only_dev "struct dev_ops *ops" "int minor" "uid_t uid" "gid_t gid" "int perms" "const char *fmt" ...
71 .Fn reference_dev "cdev_t dev"
73 .Fn release_dev "cdev_t dev"
79 structure for a new device and makes the device name visible in the
82 The device's name must be unique.
83 The name is the expansion of
85 and following arguments as
88 The name determines its path under
90 The permissions of the file specified in
95 .Bd -literal -offset indent -compact
96 #define S_IRWXU 0000700 /* RWX mask for owner */
97 #define S_IRUSR 0000400 /* R for owner */
98 #define S_IWUSR 0000200 /* W for owner */
99 #define S_IXUSR 0000100 /* X for owner */
101 #define S_IRWXG 0000070 /* RWX mask for group */
102 #define S_IRGRP 0000040 /* R for group */
103 #define S_IWGRP 0000020 /* W for group */
104 #define S_IXGRP 0000010 /* X for group */
106 #define S_IRWXO 0000007 /* RWX mask for other */
107 #define S_IROTH 0000004 /* R for other */
108 #define S_IWOTH 0000002 /* W for other */
109 #define S_IXOTH 0000001 /* X for other */
111 #define S_ISUID 0004000 /* set user id on execution */
112 #define S_ISGID 0002000 /* set group id on execution */
113 #define S_ISVTX 0001000 /* sticky bit */
114 #ifndef _POSIX_SOURCE
115 #define S_ISTXT 0001000
121 argument is a pointer to a
123 data structure, which is defined as follows:
127 const char *name; /* base name, e.g. 'da' */
128 int maj; /* major device number */
129 u_int flags; /* D_XXX flags */
130 void *data; /* custom driver data */
131 int refs; /* ref count */
135 #define dev_ops_first_field d_default
136 d_default_t *d_default;
144 d_strategy_t *d_strategy;
147 d_kqfilter_t *d_kqfilter;
148 d_clone_t *d_clone; /* clone from base dev_ops */
149 d_revoke_t *d_revoke;
150 #define dev_ops_last_field d_revoke
154 While one can and should initialize the
158 fields, they are effectively ignored.
159 Device major numbers are assigned automatically out of an internal pool of
160 major numbers, so there is no need to specify a unique major number in the
166 family is defined as:
168 typedef int d_xxx_t (struct dev_xxx_args *ap);
171 Therefore, if one wants to implement a
173 function, this is the way:
178 mydev_open(struct dev_open_args *ap)
183 .Fn make_dev_covering
184 is equivalent to make_dev, except that it also takes an argument
186 which is set as the backing device for the newly created device.
187 This function should be used whenever a device is created covering
188 another raw device, as the disk subsystem does.
193 structure and initializes it the same way
195 would, but the device will not appear in the
204 and destroys the registration for that device.
205 It should not be used to destroy a
215 and destroys the registration for that device.
216 It should not be used to destroy a
224 link (alias) with the given name to the
230 must have been created either by
232 or bt a clone handler.
233 Aliases are alternative names for devices in the
236 The lifetime of an alias is that of its associated
240 is removed or destroyed, the alias is also destroyed and its name is
248 Callers generally add their own references when they are going to store a device
249 node in a variable for long periods of time, to prevent a disassociation from
253 releases a reference on
255 The device will be terminated when the last reference has been released.
257 .Fn dev_ops_intercept
258 intercepts the device operations vector of
264 is returned which may be used in a subsequent
267 The function sets the
273 restores the device operations vector of
282 .Fn dev_ops_remove_all
287 and removes the devices from the
290 This function is useful when uninitializing a driver.
292 .Fn dev_ops_remove_minor
299 and removes the devices from the
303 .Fn devfs_scan_callback
306 function for every device registered in
310 function has the following form:
312 devfs_scan_t mydev_scan_callback;
315 mydev_scan_callback(cdev_t dev)
324 functions first appeared in
327 A major overhaul of these functions occurred in