xref: /freebsd/share/man/man9/make_dev.9 (revision 6990ffd8a95caaba6858ad44ff1b3157d1efba8f)
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 May 27, 2001
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 depends_dev
35.Nd manage
36.Vt dev_t Ns 's
37and DEVFS registration for devices
38.Sh SYNOPSIS
39.Fd #include <sys/types.h>
40.Fd #include <sys/conf.h>
41.Ft dev_t
42.Fn make_dev "struct cdevsw *cdevsw" "int minor" "uid_t uid" "gid_t gid" "int perms" "char *fmt" ...
43.Ft dev_t
44.Fn make_dev_alias "dev_t pdev" "char *fmt" ...
45.Ft void
46.Fn destroy_dev "dev_t dev"
47.Ft void
48.Fn dev_depends "dev_t pdev" "dev_t cdev"
49.Sh DESCRIPTION
50The
51.Fn make_dev
52function creates a
53.Fa dev_t
54structure for a new device.  If DEVFS is available, it is also notified of
55the presence of the new device.  The device will be owned by
56.Va uid ,
57with the group ownership as
58.Va gid ,
59and with the name as specified in
60.Va name .
61The permissions of the file specified in
62.Va perms
63are defined in
64.Aq Pa sys/stat.h :
65.Pp
66.Bd -literal -offset indent -compact
67#define S_IRWXU 0000700    /* RWX mask for owner */
68#define S_IRUSR 0000400    /* R for owner */
69#define S_IWUSR 0000200    /* W for owner */
70#define S_IXUSR 0000100    /* X for owner */
71
72#define S_IRWXG 0000070    /* RWX mask for group */
73#define S_IRGRP 0000040    /* R for group */
74#define S_IWGRP 0000020    /* W for group */
75#define S_IXGRP 0000010    /* X for group */
76
77#define S_IRWXO 0000007    /* RWX mask for other */
78#define S_IROTH 0000004    /* R for other */
79#define S_IWOTH 0000002    /* W for other */
80#define S_IXOTH 0000001    /* X for other */
81
82#define S_ISUID 0004000    /* set user id on execution */
83#define S_ISGID 0002000    /* set group id on execution */
84#define S_ISVTX 0001000    /* sticky bit */
85#ifndef _POSIX_SOURCE
86#define S_ISTXT 0001000
87#endif
88.Ed
89.Pp
90The
91.Fn make_dev_alias
92function takes the returned
93.Ft dev_t
94from
95.Fn make_dev
96and makes another (aliased) name for this device.
97It is an error to call
98.Fn make_dev_alias
99prior to calling
100.Fn make_dev .
101.Pp
102The
103.Fn destroy_dev
104function takes the returned
105.Fa dev_t
106from
107.Fn make_dev
108and destroys the registration for that device.
109Do not call
110.Fn destroy_dev
111on devices that were created with
112.Fn make_dev_alias .
113.Pp
114The
115.Fn depends_dev
116function establishes a parent-child relationship between two devices.
117The net effect is that a
118.Fn destroy_dev
119of the parent device will also result in the destruction of the
120child device(s),
121if any exist.
122A device may simultaneously be a parent and a child,
123so it is possible to build a complete hierachy.
124.Sh HISTORY
125The
126.Fn make_dev
127and
128.Fn destroy_dev
129functions first appeared in
130.Fx 4.0 .
131The function
132.Fn make_dev_alias
133first appeared in
134.Fx 4.1 .
135The function
136.Fn depends_dev
137first appeared in
138.Fx 5.0 .
139