d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
99ba792d73
freebsd-skq/share/man/man3/makedev.3

103 lines
3.0 KiB
Groff
Raw Normal View History

Several documentation fixups related to device minor/major numbers: - Document the minor(3), major(3) and makedev(3) macro's. They also apply to umajor() and uminor() in the kernel, but hopefully we'll sort that out one day. - Briefly dev2unit() inside the make_dev(9) manual page, since this is now the preferred macro to obtain character device unit numbers inside the kernel. - Remove the device_ids(9) manual page. It contains highly inaccurate information, such as a description of the nonexistent major().
2008-09-28 20:15:45 +00:00
.\" Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
Provide more detailed specification for major(), minor() and makedev(). Remove some statements which are no longer correct after ino64, and clarify other. The rewording is not in fact specific to ino64 and improvements are useful on the stable branches. Noted and reviewed by: bde Sponsored by: The FreeBSD Foundation MFC after: 1 week
2017-08-05 07:52:15 +00:00
.Dd August 3, 2017
Several documentation fixups related to device minor/major numbers: - Document the minor(3), major(3) and makedev(3) macro's. They also apply to umajor() and uminor() in the kernel, but hopefully we'll sort that out one day. - Briefly dev2unit() inside the make_dev(9) manual page, since this is now the preferred macro to obtain character device unit numbers inside the kernel. - Remove the device_ids(9) manual page. It contains highly inaccurate information, such as a description of the nonexistent major().
2008-09-28 20:15:45 +00:00
.Dt MAKEDEV 3
.Os
.Sh NAME
.Nm makedev ,
.Nm major ,
.Nm minor
.Nd device number conversion
.Sh SYNOPSIS
.In sys/types.h
.Ft dev_t
.Fn makedev "int major" "int minor"
.Ft int
.Fn major "dev_t dev"
.Ft int
.Fn minor "dev_t dev"
.Sh DESCRIPTION
The
.Fn makedev
Provide more detailed specification for major(), minor() and makedev(). Remove some statements which are no longer correct after ino64, and clarify other. The rewording is not in fact specific to ino64 and improvements are useful on the stable branches. Noted and reviewed by: bde Sponsored by: The FreeBSD Foundation MFC after: 1 week
2017-08-05 07:52:15 +00:00
macro returns a device number created from the provided
Several documentation fixups related to device minor/major numbers: - Document the minor(3), major(3) and makedev(3) macro's. They also apply to umajor() and uminor() in the kernel, but hopefully we'll sort that out one day. - Briefly dev2unit() inside the make_dev(9) manual page, since this is now the preferred macro to obtain character device unit numbers inside the kernel. - Remove the device_ids(9) manual page. It contains highly inaccurate information, such as a description of the nonexistent major().
2008-09-28 20:15:45 +00:00
.Fa major
and
.Fa minor
number.
The
.Fn major
and
.Fn minor
Provide more detailed specification for major(), minor() and makedev(). Remove some statements which are no longer correct after ino64, and clarify other. The rewording is not in fact specific to ino64 and improvements are useful on the stable branches. Noted and reviewed by: bde Sponsored by: The FreeBSD Foundation MFC after: 1 week
2017-08-05 07:52:15 +00:00
macros return the original numbers from the device number
Several documentation fixups related to device minor/major numbers: - Document the minor(3), major(3) and makedev(3) macro's. They also apply to umajor() and uminor() in the kernel, but hopefully we'll sort that out one day. - Briefly dev2unit() inside the make_dev(9) manual page, since this is now the preferred macro to obtain character device unit numbers inside the kernel. - Remove the device_ids(9) manual page. It contains highly inaccurate information, such as a description of the nonexistent major().
2008-09-28 20:15:45 +00:00
.Fa dev .
Provide more detailed specification for major(), minor() and makedev(). Remove some statements which are no longer correct after ino64, and clarify other. The rewording is not in fact specific to ino64 and improvements are useful on the stable branches. Noted and reviewed by: bde Sponsored by: The FreeBSD Foundation MFC after: 1 week
2017-08-05 07:52:15 +00:00
In other words, for a value
.Va dev
of the type
.Vt dev_t ,
and values
.Va ma , mi
of the type
.Vt int ,
the assertions
.Dl dev == makedev(major(dev), minor(dev))
.Dl ma == major(makedev(ma, mi))
.Dl mi == minor(makedev(ma, mi))
are valid.
Several documentation fixups related to device minor/major numbers: - Document the minor(3), major(3) and makedev(3) macro's. They also apply to umajor() and uminor() in the kernel, but hopefully we'll sort that out one day. - Briefly dev2unit() inside the make_dev(9) manual page, since this is now the preferred macro to obtain character device unit numbers inside the kernel. - Remove the device_ids(9) manual page. It contains highly inaccurate information, such as a description of the nonexistent major().
2008-09-28 20:15:45 +00:00
.Pp
In previous implementations of
.Fx
all block and character devices were uniquely identified by a pair of
Provide more detailed specification for major(), minor() and makedev(). Remove some statements which are no longer correct after ino64, and clarify other. The rewording is not in fact specific to ino64 and improvements are useful on the stable branches. Noted and reviewed by: bde Sponsored by: The FreeBSD Foundation MFC after: 1 week
2017-08-05 07:52:15 +00:00
stable major and minor numbers.
Several documentation fixups related to device minor/major numbers: - Document the minor(3), major(3) and makedev(3) macro's. They also apply to umajor() and uminor() in the kernel, but hopefully we'll sort that out one day. - Briefly dev2unit() inside the make_dev(9) manual page, since this is now the preferred macro to obtain character device unit numbers inside the kernel. - Remove the device_ids(9) manual page. It contains highly inaccurate information, such as a description of the nonexistent major().
2008-09-28 20:15:45 +00:00
The major number referred to a certain device class (e.g. disks, TTYs)
while the minor number identified an instance within the device class.
Later versions of
.Fx
automatically generate a unique device number for each character device
visible in
.Pa /dev/ .
Provide more detailed specification for major(), minor() and makedev(). Remove some statements which are no longer correct after ino64, and clarify other. The rewording is not in fact specific to ino64 and improvements are useful on the stable branches. Noted and reviewed by: bde Sponsored by: The FreeBSD Foundation MFC after: 1 week
2017-08-05 07:52:15 +00:00
These numbers are not divided in device classes and are not guaranteed
to be stable upon reboot or driver reload.
Several documentation fixups related to device minor/major numbers: - Document the minor(3), major(3) and makedev(3) macro's. They also apply to umajor() and uminor() in the kernel, but hopefully we'll sort that out one day. - Briefly dev2unit() inside the make_dev(9) manual page, since this is now the preferred macro to obtain character device unit numbers inside the kernel. - Remove the device_ids(9) manual page. It contains highly inaccurate information, such as a description of the nonexistent major().
2008-09-28 20:15:45 +00:00
.Pp
On
.Fx
these macros are only used by utilities that need to exchange numbers
with other operating systems that may use different encodings for
.Vt dev_t ,
but also applications that present these numbers to the user in a more
conventional way.
.Sh RETURN VALUES
The
.Fn major
Provide more detailed specification for major(), minor() and makedev(). Remove some statements which are no longer correct after ino64, and clarify other. The rewording is not in fact specific to ino64 and improvements are useful on the stable branches. Noted and reviewed by: bde Sponsored by: The FreeBSD Foundation MFC after: 1 week
2017-08-05 07:52:15 +00:00
and
Several documentation fixups related to device minor/major numbers: - Document the minor(3), major(3) and makedev(3) macro's. They also apply to umajor() and uminor() in the kernel, but hopefully we'll sort that out one day. - Briefly dev2unit() inside the make_dev(9) manual page, since this is now the preferred macro to obtain character device unit numbers inside the kernel. - Remove the device_ids(9) manual page. It contains highly inaccurate information, such as a description of the nonexistent major().
2008-09-28 20:15:45 +00:00
.Fn minor
Provide more detailed specification for major(), minor() and makedev(). Remove some statements which are no longer correct after ino64, and clarify other. The rewording is not in fact specific to ino64 and improvements are useful on the stable branches. Noted and reviewed by: bde Sponsored by: The FreeBSD Foundation MFC after: 1 week
2017-08-05 07:52:15 +00:00
macros return numbers whose value can span the complete range of an
Several documentation fixups related to device minor/major numbers: - Document the minor(3), major(3) and makedev(3) macro's. They also apply to umajor() and uminor() in the kernel, but hopefully we'll sort that out one day. - Briefly dev2unit() inside the make_dev(9) manual page, since this is now the preferred macro to obtain character device unit numbers inside the kernel. - Remove the device_ids(9) manual page. It contains highly inaccurate information, such as a description of the nonexistent major().
2008-09-28 20:15:45 +00:00
.Vt int .
.Sh SEE ALSO
sort SEE ALSO
2014-12-26 22:41:10 +00:00
.Xr mknod 2 ,
Small typo in the makedev(3) manpage. devtoname(3) is a nonexistent function. We do have devtoname(9), but that's entirely different. The correct function is devname(3).
2008-09-28 20:26:16 +00:00
.Xr devname 3 ,
sort SEE ALSO
2014-12-26 22:41:10 +00:00
.Xr devfs 5
Reference in New Issue Copy Permalink