share/man/man9/device_ids.9

   1 .\"
   2 .\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. 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(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  16 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  17 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18 .\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
  19 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  20 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  22 .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  25 .\" DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd June 22, 2004
  30 .Dt DEVICE_IDS 9
  31 .Os
  32 .Sh NAME
  33 .Nm device_ids ,
  34 .Nm major ,
  35 .Nm minor ,
  36 .Nm umajor ,
  37 .Nm uminor
  38 .Nd "calculate device ids"
  39 .Sh SYNOPSIS
  40 .In sys/types.h
  41 .In sys/systm.h
  42 .Ft int
  43 .Fn major "struct cdev *dev"
  44 .Ft int
  45 .Fn minor "struct cdev *dev"
  46 .Ft int
  47 .Fn umajor "dev_t id"
  48 .Ft int
  49 .Fn uminor "dev_t id"
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 family of functions take either the raw device ID,
  54 .Fa id ,
  55 or a pointer to the device structure,
  56 .Fa dev ,
  57 and return the integer
  58 value that is the major or minor device ID as requested.
  59 .Pp
  60 The actual major and minor device IDs are values masked from of the raw device ID.
  61 For details on the actual calculations used to determine the major or minor IDs see
  62 the actual source in
  63 .Pa kern_conf.c .
  64 .Sh RETURN VALUES
  65 An integer greater than zero and less than
  66 .Dv NUMCDEVSW .
  67 .Fn major
  68 and
  69 .Fn minor
  70 will return
  71 .Dv NODEV
  72 if the device is invalid.
  73 .Sh AUTHORS
  74 This manual page was written by
  75 .An Chad David Aq davidc@acns.ab.ca .