8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man9s / modldrv.9s
blob375c594deb1a5ff722fea54e985e806277698500
1 '\" te
2 .\"  Copyright (C) 2001, Sun Microsystems, Inc., All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH MODLDRV 9S "Mar 5, 2001"
7 .SH NAME
8 modldrv \- linkage structure for loadable drivers
9 .SH SYNOPSIS
10 .LP
11 .nf
12 #include <sys/modctl.h>
13 .fi
15 .SH INTERFACE LEVEL
16 .sp
17 .LP
18 Solaris DDI specific (Solaris DDI)
19 .SH DESCRIPTION
20 .sp
21 .LP
22 The \fBmodldrv\fR structure is used by device drivers to export driver specific
23 information to the kernel.
24 .SH STRUCTURE MEMBERS
25 .sp
26 .in +2
27 .nf
28 struct mod_ops    *drv_modops;
29 char              *drv_linkinfo;
30 struct dev_ops    *drv_dev_ops;
31 .fi
32 .in -2
34 .sp
35 .ne 2
36 .na
37 \fB\fBdrv_modops\fR \fR
38 .ad
39 .RS 17n
40 Must always be initialized to the address of \fBmod_driverops\fR. This member
41 identifies the module as a loadable driver.
42 .RE
44 .sp
45 .ne 2
46 .na
47 \fB\fBdrv_linkinfo\fR \fR
48 .ad
49 .RS 17n
50 Can be any string up to \fBMODMAXNAMELEN\fR characters (including the
51 terminating NULL character), and is used to describe the module and its version
52 number. This is usually the name of the driver and module version information,
53 but can contain other information as well.
54 .RE
56 .sp
57 .ne 2
58 .na
59 \fB\fBdrv_dev_ops\fR \fR
60 .ad
61 .RS 17n
62 Pointer to the driver's \fBdev_ops\fR(9S) structure.
63 .RE
65 .SH SEE ALSO
66 .sp
67 .LP
68 \fBadd_drv\fR(1M), \fBdev_ops\fR(9S), \fBmodlinkage\fR(9S)
69 .sp
70 .LP
71 \fIWriting Device Drivers\fR