xref: /illumos-gate/usr/src/man/man9f/mac_private_minor.9f (revision 86e5bb7983583c7ce83d5235abc95df1fb570d5e)
1*86e5bb79SLuqman Aden.\"
2*86e5bb79SLuqman Aden.\" This file and its contents are supplied under the terms of the
3*86e5bb79SLuqman Aden.\" Common Development and Distribution License ("CDDL"), version 1.0.
4*86e5bb79SLuqman Aden.\" You may only use this file in accordance with the terms of version
5*86e5bb79SLuqman Aden.\" 1.0 of the CDDL.
6*86e5bb79SLuqman Aden.\"
7*86e5bb79SLuqman Aden.\" A full copy of the text of the CDDL should have accompanied this
8*86e5bb79SLuqman Aden.\" source.  A copy of the CDDL is also available via the Internet at
9*86e5bb79SLuqman Aden.\" http://www.illumos.org/license/CDDL.
10*86e5bb79SLuqman Aden.\"
11*86e5bb79SLuqman Aden.\"
12*86e5bb79SLuqman Aden.\" Copyright 2023 Oxide Computer Company
13*86e5bb79SLuqman Aden.\"
14*86e5bb79SLuqman Aden.Dd January 30, 2023
15*86e5bb79SLuqman Aden.Dt MAC_PRIVATE_MINOR 9F
16*86e5bb79SLuqman Aden.Os
17*86e5bb79SLuqman Aden.Sh NAME
18*86e5bb79SLuqman Aden.Nm mac_private_minor
19*86e5bb79SLuqman Aden.Nd return the first minor number that is available for driver private use
20*86e5bb79SLuqman Aden.Sh SYNOPSIS
21*86e5bb79SLuqman Aden.In sys/mac_provider.h
22*86e5bb79SLuqman Aden.Ft minor_t
23*86e5bb79SLuqman Aden.Fo mac_private_minor
24*86e5bb79SLuqman Aden.Fa "void"
25*86e5bb79SLuqman Aden.Fc
26*86e5bb79SLuqman Aden.Sh INTERFACE LEVEL
27*86e5bb79SLuqman Adenillumos DDI specific
28*86e5bb79SLuqman Aden.Sh PARAMETERS
29*86e5bb79SLuqman AdenNone.
30*86e5bb79SLuqman Aden.Sh DESCRIPTION
31*86e5bb79SLuqman AdenThe
32*86e5bb79SLuqman Aden.Fn mac_private_minor
33*86e5bb79SLuqman Adenfunction is used by MAC device drivers to determine the lower bound of the
34*86e5bb79SLuqman Adenminor number space that is available for driver private use.
35*86e5bb79SLuqman AdenThe driver is free to use any minor number greater than or equal to the
36*86e5bb79SLuqman Adenreturned value.
37*86e5bb79SLuqman AdenAll other
38*86e5bb79SLuqman Adenvalues are reserved for use by the
39*86e5bb79SLuqman Aden.Xr mac 9E
40*86e5bb79SLuqman Adenframework.
41*86e5bb79SLuqman Aden.Pp
42*86e5bb79SLuqman AdenThe
43*86e5bb79SLuqman Aden.Fn mac_private_minor
44*86e5bb79SLuqman Adenfunction may be called from a driver's
45*86e5bb79SLuqman Aden.Xr attach 9E
46*86e5bb79SLuqman Adenentry point, e.g., to create minor nodes for use by the driver.
47*86e5bb79SLuqman AdenSee the
48*86e5bb79SLuqman Aden.Sx Custom Device Nodes
49*86e5bb79SLuqman Adensection of
50*86e5bb79SLuqman Aden.Xr mac 9E
51*86e5bb79SLuqman Adenfor more details.
52*86e5bb79SLuqman Aden.Sh CONTEXT
53*86e5bb79SLuqman Aden.Fn mac_private_minor
54*86e5bb79SLuqman Adenfunction can be called from
55*86e5bb79SLuqman Aden.Sy user
56*86e5bb79SLuqman Adenor
57*86e5bb79SLuqman Aden.Sy kernel
58*86e5bb79SLuqman Adencontext.
59*86e5bb79SLuqman Aden.Sh RETURN VALUES
60*86e5bb79SLuqman AdenUpon successful completion, the
61*86e5bb79SLuqman Aden.Fn mac_private_minor
62*86e5bb79SLuqman Adenfunction returns a valid minor number.
63*86e5bb79SLuqman Aden.Sh SEE ALSO
64*86e5bb79SLuqman Aden.Xr mac 9E
65