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