1.\" Copyright (c) 2001 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/DEV_MODULE.9,v 1.1.2.3 2001/12/17 11:30:18 ru Exp $ 28.\" $DragonFly: src/share/man/man9/DEV_MODULE.9,v 1.3 2004/06/01 11:36:53 hmp Exp $ 29.\" 30.Dd March 11, 2001 31.Dt DEV_MODULE 9 32.Os 33.Sh NAME 34.Nm DEV_MODULE 35.Nd device driver module declaration macro 36.Sh SYNOPSIS 37.In sys/module.h 38.In sys/conf.h 39.Fn DEV_MODULE "name" "modeventhand_t evh" "void *arg" 40.Sh DESCRIPTION 41The 42.Fn DEV_MODULE 43macro declares a device driver kernel module. 44It fills in a 45.Vt moduledata_t 46structure and then calls 47.Fn DECLARE_MODULE 48with the correct args, where 49.Fa name 50is the name of the module and 51.Fa evh 52(with its argument 53.Fa arg ) 54is the event handler for the module (refer to 55.Xr DECLARE_MODULE 9 56for more information). 57The event handler is supposed to create the device with 58.Fn make_dev 59on load and to destroy it when it is unloaded using 60.Fn destroy_dev . 61.Sh EXAMPLES 62.Bd -literal 63#include <sys/module.h> 64#include <sys/conf.h> 65 66static struct cdevsw foo_devsw = { ... }; 67 68static dev_t sdev; 69 70static int 71foo_load(module_t mod, int cmd, void *arg) 72{ 73 int err = 0; 74 75 switch (cmd) { 76 case MOD_LOAD: 77 sdev = make_dev(&foo_devsw, 0, UID_ROOT, GID_WHEEL, 0600, "foo"); 78 break; /* Success*/ 79 80 case MOD_UNLOAD: 81 case MOD_SHUTDOWN: 82 destroy_dev(sdev); 83 break; /* Success*/ 84 85 default: 86 err = EINVAL; 87 break; 88 } 89 90 return(err); 91} 92 93DEV_MODULE(foo, foo_load, NULL); 94.Ed 95.Sh SEE ALSO 96.Xr DECLARE_MODULE 9 , 97.Xr destroy_dev 9 , 98.Xr make_dev 9 , 99.Xr module 9 100.Sh AUTHORS 101This manual page was written by 102.An Alexander Langer Aq alex@FreeBSD.org . 103