| DRIVER_MODULE.9 (225220) | DRIVER_MODULE.9 (239510) |
|---|---|
| 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 225220 2011-08-27 22:08:01Z brueffer $ | 29.\" $FreeBSD: head/share/man/man9/DRIVER_MODULE.9 239510 2012-08-21 17:58:39Z jhb $ |
| 30.\" | 30.\" |
| 31.Dd August 27, 2011 | 31.Dd August 21, 2012 |
| 32.Dt DRIVER_MODULE 9 33.Os 34.Sh NAME | 32.Dt DRIVER_MODULE 9 33.Os 34.Sh NAME |
| 35.Nm DRIVER_MODULE | 35.Nm DRIVER_MODULE , 36.Nm DRIVER_MODULE_ORDERED , 37.Nm EARLY_DRIVER_MODULE , 38.Nm EARLY_DRIVER_MODULE_ORDERED |
| 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" | 39.Nd kernel driver declaration macro 40.Sh SYNOPSIS 41.In sys/param.h 42.In sys/kernel.h 43.In sys/bus.h 44.In sys/module.h 45.Fn DRIVER_MODULE name busname "driver_t driver" "devclass_t devclass" "modeventhand_t evh" "void *arg" |
| 46.Fn DRIVER_MODULE_ORDERED name busname "driver_t driver" "devclass_t devclass" "modeventhand_t evh" "void *arg" "int order" 47.Fn EARLY_DRIVER_MODULE name busname "driver_t driver" "devclass_t devclass" "modeventhand_t evh" "void *arg" "enum sysinit_elem_order order" "int pass" 48.Fn EARLY_DRIVER_MODULE_ORDERED name busname "driver_t driver" "devclass_t devclass" "modeventhand_t evh" "void *arg" "enum sysinit_elem_order order" "int pass" |
|
| 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. --- 39 unchanged lines hidden (view full) --- 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. | 49.Sh DESCRIPTION 50The 51.Fn DRIVER_MODULE 52macro declares a kernel driver. 53.Fn DRIVER_MODULE 54expands to the real driver declaration, where the phrase 55.Fa name 56is used as the naming prefix for the driver and its functions. --- 39 unchanged lines hidden (view full) --- 96is loaded or unloaded (see 97.Xr module 9 ) . 98.Pp 99The 100.Fa arg 101is unused at this time and should be a 102.Dv NULL 103pointer. |
| 104.Pp 105The 106.Fn DRIVER_MODULE_ORDERED 107macro allows a driver to be registered in a specific order. 108This can be useful if a single kernel module contains multiple drivers 109that are inter-dependent. 110The 111.Fa order 112argument should be one of the 113.Xr SYSINIT 9 114initialization ordering constants 115.Pq Dv SI_ORDER_* . 116The default order for a driver module is 117.Dv SI_ORDER_MIDDLE . 118Typically a module will specify an order of 119.Dv SI_ORDER_ANY 120for a single driver to ensure it is registered last. 121.Pp 122The 123.Fn EARLY_DRIVER_MODULE 124macro allows a driver to be registered for a specific pass level. 125The boot time probe and attach process makes multiple passes over the 126device tree. 127Certain critical drivers that provide basic services needed by other 128devices are attach during earlier passes. 129Most drivers are attached in a final general pass. 130A driver that attaches during an early pass must register for a specific 131pass level 132.Pq BUS_PASS_* 133via the 134.Fa pass 135argument. 136Once a driver is registered it is available to attach to devices for 137all subsequent passes. 138.Pp 139The 140.Fn EARLY_DRIVER_MODULE_ORDERED 141macro allows a driver to be registered both in a specific order and 142for a specific pass level. |
|
| 98.Sh SEE ALSO 99.Xr device 9 , 100.Xr driver 9 , | 143.Sh SEE ALSO 144.Xr device 9 , 145.Xr driver 9 , |
| 101.Xr module 9 | 146.Xr module 9 , 147.Xr SYSINIT 9 |
| 102.Sh AUTHORS 103This manual page was written by 104.An Alexander Langer Aq alex@FreeBSD.org . | 148.Sh AUTHORS 149This manual page was written by 150.An Alexander Langer Aq alex@FreeBSD.org . |