1.\" Copyright (c) 2000 Alexander Langer 2.\" 3.\" All rights reserved. 4.\" 5.\" This program is free software. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR 17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT, 20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26.\" 27.\" $FreeBSD: src/share/man/man9/DRIVER_MODULE.9,v 1.1.2.5 2001/12/17 11:30:18 ru Exp $ 28.\" $DragonFly: src/share/man/man9/DRIVER_MODULE.9,v 1.4 2007/02/10 23:54:18 swildner Exp $ 29.\" 30.Dd May 16, 2000 31.Dt DRIVER_MODULE 9 32.Os 33.Sh NAME 34.Nm DRIVER_MODULE 35.Nd kernel driver declaration macro 36.Sh SYNOPSIS 37.In sys/types.h 38.In sys/bus.h 39.In sys/module.h 40.Fn DRIVER_MODULE name busname "driver_t driver" "devclass_t devclass" "modeventhand_t evh" "void *arg" 41.Sh DESCRIPTION 42The 43.Fn DRIVER_MODULE 44macro declares a kernel driver. 45.Fn DRIVER_MODULE 46expands to the real driver declaration, where the phrase 47.Fa name 48is used as the naming prefix for the driver and its functions. 49Note that it is supplied as plain text, and not a 50.Li char 51or 52.Li char * . 53.Pp 54.Fa busname 55is the parent bus of the driver (PCI, ISA, PPBUS and others), e.g.\& 56.Ql pci , 57.Ql isa , 58or 59.Ql ppbus . 60.Pp 61The identifier used in 62.Fn DRIVER_MODULE 63can be different from the driver name. 64Also, the same driver identifier can exist on different busses, 65which is a pretty clean way of making front ends for different cards 66using the same driver on the same or different busses. 67For example, the following is allowed: 68.Pp 69.Fn DRIVER_MODULE foo isa foo_driver foo_devclass NULL NULL ; 70.Pp 71.Fn DRIVER_MODULE foo pci foo_driver foo_devclass NULL NULL ; 72.Pp 73.Fa driver 74is the driver of type 75.Li driver_t , 76which contains the information about the driver and is therefore one of the 77two most important parts of the call to 78.Fn DRIVER_MODULE . 79.Pp 80The 81.Fa devclass 82argument contains the kernel-internal information about the device, 83which will be used within the kernel driver module. 84.Pp 85The 86.Fa evh 87argument is the event handler which is called when the driver (or module) 88is loaded or unloaded (see 89.Xr module 9 ) . 90.Pp 91The 92.Fa arg 93is unused at this time and should be a 94.Dv NULL 95pointer. 96.Sh SEE ALSO 97.Xr device 9 , 98.Xr driver 9 , 99.Xr module 9 100.Sh AUTHORS 101This manual page was written by 102.An Alexander Langer Aq alex@FreeBSD.org . 103