xref: /freebsd/share/man/man9/make_dev.9 (revision edf0984dae67812c48363d8b51bb6e1aed275672)
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 September 25, 1999
28.Os
29.Dt MAKE_DEV 9
30.Sh NAME
31.Nm make_dev ,
32.Nm destroy_dev
33.Nd "Create or destroy dev_t and devfs registration for a new device"
34.Sh SYNOPSIS
35.Fd #include <sys/types.h>
36.Fd #include <sys/conf.h>
37.Ft dev_t
38.Fn make_dev "struct cdevsw *cdevsw" "int minor" "uid_t uid" "gid_t gid" "int perms" "char *fmt" ...
39.Ft dev_t
40.Fn make_dev_alias "dev_t pdev" "char *fmt" ...
41.Ft void
42.Fn destroy_dev "dev_t dev"
43.Sh DESCRIPTION
44The
45.Fn make_dev
46function creates a
47.Fa dev_t
48structure for a new device.  If DEVFS is available, it is also notified of
49the presence of the new device.  The device will be owned by
50.Va uid ,
51with the group ownership as
52.Va gid ,
53and with the name as specified in
54.Va name .
55The permissions of the file specified in
56.Va perms
57are defined in
58.Aq Pa sys/stat.h :
59.Pp
60.Bd -literal -offset indent -compact
61#define S_IRWXU 0000700    /* RWX mask for owner */
62#define S_IRUSR 0000400    /* R for owner */
63#define S_IWUSR 0000200    /* W for owner */
64#define S_IXUSR 0000100    /* X for owner */
65
66#define S_IRWXG 0000070    /* RWX mask for group */
67#define S_IRGRP 0000040    /* R for group */
68#define S_IWGRP 0000020    /* W for group */
69#define S_IXGRP 0000010    /* X for group */
70
71#define S_IRWXO 0000007    /* RWX mask for other */
72#define S_IROTH 0000004    /* R for other */
73#define S_IWOTH 0000002    /* W for other */
74#define S_IXOTH 0000001    /* X for other */
75
76#define S_ISUID 0004000    /* set user id on execution */
77#define S_ISGID 0002000    /* set group id on execution */
78#define S_ISVTX 0001000    /* sticky bit */
79#ifndef _POSIX_SOURCE
80#define S_ISTXT 0001000
81#endif
82.Ed
83.Pp
84The
85.Fn make_dev_alias
86function takes the returned
87.Ft dev_t
88from
89.Fn make_dev
90and makes another (aliased) name for this device.
91It is an error to call
92.Fn make_dev_alias
93prior to calling
94.Fn make_dev .
95.Pp
96The
97.Fn destroy_dev
98function takes the returned
99.Fa dev_t
100from
101.Fn make_dev
102and destroys the registration for that device.
103Do not call
104.Fn destroy_dev
105on devices that were created with
106.Fn make_dev_alias .
107.Sh HISTORY
108The
109.Fn make_dev
110and
111.Fn destroy_dev
112functions first appeared in
113.Fx 4.0 .
114The function
115.Fn make_dev_alias
116first appeared in
117.Fx 4.1 .
118