Deleted Added
full compact
DRIVER_MODULE.9 (79366) DRIVER_MODULE.9 (79676)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 2000 Alexander Langer
4.\"
5.\" All rights reserved.
6.\"
7.\" This program is free software.
8.\"

--- 12 unchanged lines hidden (view full) ---

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.\"
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 2000 Alexander Langer
4.\"
5.\" All rights reserved.
6.\"
7.\" This program is free software.
8.\"

--- 12 unchanged lines hidden (view full) ---

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: head/share/man/man9/DRIVER_MODULE.9 79366 2001-07-06 16:46:48Z ru $
29.\" $FreeBSD: head/share/man/man9/DRIVER_MODULE.9 79676 2001-07-13 16:10:39Z alex $
30.\"
31.Dd May 16, 2000
32.Dt DRIVER_MODULE 9
33.Os
34.Sh NAME
35.Nm DRIVER_MODULE
36.Nd kernel driver declaration macro
37.Sh SYNOPSIS

--- 4 unchanged lines hidden (view full) ---

42.Sh DESCRIPTION
43The
44.Fn DRIVER_MODULE
45macro declares a kernel driver.
46.Fn DRIVER_MODULE
47expands to the real driver declaration, where the phrase
48.Fa name
49is used as the naming prefix for the driver and its functions.
30.\"
31.Dd May 16, 2000
32.Dt DRIVER_MODULE 9
33.Os
34.Sh NAME
35.Nm DRIVER_MODULE
36.Nd kernel driver declaration macro
37.Sh SYNOPSIS

--- 4 unchanged lines hidden (view full) ---

42.Sh DESCRIPTION
43The
44.Fn DRIVER_MODULE
45macro declares a kernel driver.
46.Fn DRIVER_MODULE
47expands to the real driver declaration, where the phrase
48.Fa name
49is used as the naming prefix for the driver and its functions.
50Note that it supplied as plain text, and not a
50Note that it is supplied as plain text, and not a
51.Li char
52or
53.Li char * .
54.Pp
55.Fa busname
56is the parent bus of the driver (PCI, ISA, PPBUS and others), e.g.
57.Ql pci ,
58.Ql isa ,
59or
60.Ql ppbus .
61.Pp
62The identifier used in
63.Fn DRIVER_MODULE
64can be different from the driver name.
65Also, the same driver identifier can exist on different busses,
66which is a pretty clean way of making front ends for different cards
67using the same driver on the same or different busses.
68For example, the following is allowed:
69.Pp
51.Li char
52or
53.Li char * .
54.Pp
55.Fa busname
56is the parent bus of the driver (PCI, ISA, PPBUS and others), e.g.
57.Ql pci ,
58.Ql isa ,
59or
60.Ql ppbus .
61.Pp
62The identifier used in
63.Fn DRIVER_MODULE
64can be different from the driver name.
65Also, the same driver identifier can exist on different busses,
66which is a pretty clean way of making front ends for different cards
67using the same driver on the same or different busses.
68For example, the following is allowed:
69.Pp
70.Fn DRIVER_MODULE foo isa foo_driver foo_devclass 0 0 ;
70.Fn DRIVER_MODULE foo isa foo_driver foo_devclass NULL NULL ;
71.Pp
71.Pp
72.Fn DRIVER_MODULE foo pci foo_driver foo_devclass 0 0 ;
72.Fn DRIVER_MODULE foo pci foo_driver foo_devclass NULL NULL ;
73.Pp
74.Fa driver
75is the driver of type
76.Li driver_t ,
77which contains the information about the driver and is therefore one of the
78two most important parts of the call to
79.Fn DRIVER_MODULE .
80.Pp
81The
82.Fa devclass
83argument contains the kernel-internal information about the device,
73.Pp
74.Fa driver
75is the driver of type
76.Li driver_t ,
77which contains the information about the driver and is therefore one of the
78two most important parts of the call to
79.Fn DRIVER_MODULE .
80.Pp
81The
82.Fa devclass
83argument contains the kernel-internal information about the device,
84which will be used wthin the kernel driver module.
84which will be used within the kernel driver module.
85.Pp
86The
87.Fa evh
88argument is the event handler which is called when the driver (or module)
89is loaded or unloaded (see
90.Xr module 9 ) .
91.Pp
92The
93.Fa arg
94is unused at this time and should be a
95.Dv NULL
96pointer.
97.Sh SEE ALSO
98.Xr device 9 ,
99.Xr driver 9 ,
100.Xr module 9
101.Sh AUTHORS
102This manual page was written by
103.An Alexander Langer Aq alex@FreeBSD.org .
85.Pp
86The
87.Fa evh
88argument is the event handler which is called when the driver (or module)
89is loaded or unloaded (see
90.Xr module 9 ) .
91.Pp
92The
93.Fa arg
94is unused at this time and should be a
95.Dv NULL
96pointer.
97.Sh SEE ALSO
98.Xr device 9 ,
99.Xr driver 9 ,
100.Xr module 9
101.Sh AUTHORS
102This manual page was written by
103.An Alexander Langer Aq alex@FreeBSD.org .