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