share/man/man9/make_dev.9

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