xref: /freebsd/share/man/man9/make_dev.9 (revision 1dfbd9c2f9e3e5fc6504f0e3c0ceb8b5e1be9499)
1.\" Copyright (c) 1999 Chris Costello
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
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.
12.\"
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
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd November 24, 2006
28.Os
29.Dt MAKE_DEV 9
30.Sh NAME
31.Nm make_dev ,
32.Nm make_dev_alias ,
33.Nm destroy_dev ,
34.Nm dev_depends
35.Nd manage
36.Vt cdev Ns 's
37and DEVFS registration for devices
38.Sh SYNOPSIS
39.In sys/param.h
40.In sys/conf.h
41.Ft struct cdev *
42.Fn make_dev "struct cdevsw *cdevsw" "int minor" "uid_t uid" "gid_t gid" "int perms" "const char *fmt" ...
43.Ft struct cdev *
44.Fn make_dev_alias "struct cdev *pdev" "const char *fmt" ...
45.Ft void
46.Fn destroy_dev "struct cdev *dev"
47.Ft void
48.Fn dev_depends "struct cdev *pdev" "struct cdev *cdev"
49.Sh DESCRIPTION
50The
51.Fn make_dev
52function creates a
53.Fa cdev
54structure for a new device.
55If DEVFS is available, it is also notified of
56the presence of the new device.
57The device will be owned by
58.Va uid ,
59with the group ownership as
60.Va gid .
61The name is the expansion of
62.Va fmt
63and following arguments as
64.Xr printf 9
65would print it.
66The name determines its path under
67.Pa /dev
68or other
69.Xr devfs 5
70mount point and may contain slash
71.Ql /
72characters to denote subdirectories.
73The permissions of the file specified in
74.Va perms
75are defined in
76.In sys/stat.h :
77.Pp
78.Bd -literal -offset indent -compact
79#define S_IRWXU 0000700    /* RWX mask for owner */
80#define S_IRUSR 0000400    /* R for owner */
81#define S_IWUSR 0000200    /* W for owner */
82#define S_IXUSR 0000100    /* X for owner */
83
84#define S_IRWXG 0000070    /* RWX mask for group */
85#define S_IRGRP 0000040    /* R for group */
86#define S_IWGRP 0000020    /* W for group */
87#define S_IXGRP 0000010    /* X for group */
88
89#define S_IRWXO 0000007    /* RWX mask for other */
90#define S_IROTH 0000004    /* R for other */
91#define S_IWOTH 0000002    /* W for other */
92#define S_IXOTH 0000001    /* X for other */
93
94#define S_ISUID 0004000    /* set user id on execution */
95#define S_ISGID 0002000    /* set group id on execution */
96#define S_ISVTX 0001000    /* sticky bit */
97#ifndef _POSIX_SOURCE
98#define S_ISTXT 0001000
99#endif
100.Ed
101.Pp
102The
103.Fn make_dev_alias
104function takes the returned
105.Ft cdev
106from
107.Fn make_dev
108and makes another (aliased) name for this device.
109It is an error to call
110.Fn make_dev_alias
111prior to calling
112.Fn make_dev .
113.Pp
114The
115.Fn destroy_dev
116function takes the returned
117.Fa cdev
118from
119.Fn make_dev
120and destroys the registration for that device.
121Do not call
122.Fn destroy_dev
123on devices that were created with
124.Fn make_dev_alias .
125.Pp
126The
127.Fn dev_depends
128function establishes a parent-child relationship between two devices.
129The net effect is that a
130.Fn destroy_dev
131of the parent device will also result in the destruction of the
132child device(s),
133if any exist.
134A device may simultaneously be a parent and a child,
135so it is possible to build a complete hierarchy.
136.Sh SEE ALSO
137.Xr devfs 5
138.Sh HISTORY
139The
140.Fn make_dev
141and
142.Fn destroy_dev
143functions first appeared in
144.Fx 4.0 .
145The function
146.Fn make_dev_alias
147first appeared in
148.Fx 4.1 .
149The function
150.Fn dev_depends
151first appeared in
152.Fx 5.0 .
153