share/man/man9/devclass_get_maxunit.9

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 1998 Doug Rabson
   4 .\"
   5 .\" All rights reserved.
   6 .\"
   7 .\" This program is free software.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd September 10, 2010
  32 .Dt DEVCLASS_GET_MAXUNIT 9
  33 .Os
  34 .Sh NAME
  35 .Nm devclass_get_maxunit
  36 .Nd find the maximum unit number in the class
  37 .Sh SYNOPSIS
  38 .In sys/param.h
  39 .In sys/bus.h
  40 .Ft int
  41 .Fn devclass_get_maxunit "devclass_t dc"
  42 .Sh DESCRIPTION
  43 Returns the next unit number to be allocated to device instances in the
  44 .Dv devclass .
  45 This is one greater than the highest currently allocated unit.
  46 .Sh RETURN VALUES
  47 The
  48 .Fn devclass_get_maxunit
  49 function returns -1 if
  50 .Fa dc
  51 is
  52 .Dv NULL ,
  53 otherwise it returns the next unit
  54 number in
  55 .Fa dc's
  56 devclass.
  57 .Sh ERRORS
  58 None.
  59 .Sh SEE ALSO
  60 .Xr devclass 9 ,
  61 .Xr device 9
  62 .Sh AUTHORS
  63 This manual page was written by
  64 .An Doug Rabson .
  65 .Sh BUGS
  66 The name is confusing since it is one greater than the maximum unit.