xref: /freebsd/share/man/man9/devclass_get_softc.9 (revision e5b786625f7f82a1fa91e41823332459ea5550f9)
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.Dd June 16, 1998
30.Dt DEVCLASS_GET_SOFTC 9
31.Os
32.Sh NAME
33.Nm devclass_get_softc
34.Nd translate unit number to driver private structure
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/bus.h
38.Ft void *
39.Fn devclass_get_softc "devclass_t dc" "int unit"
40.Sh DESCRIPTION
41This function retrieves the driver private instance variables for the
42device with the given unit number and returns it.
43.Sh RETURN VALUES
44If the device exists, its driver-private variables are returned,
45otherwise NULL is returned.
46.Sh SEE ALSO
47.Xr device 9
48.Sh AUTHORS
49This manual page was written by
50.An Doug Rabson .
51