| driver.9 (79538) | driver.9 (79727) |
|---|---|
| 1.\" -*- nroff -*- 2.\" 3.\" Copyright (c) 1998 Doug Rabson 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) 1998 Doug Rabson 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.9 79538 2001-07-10 15:31:11Z ru $ | 29.\" $FreeBSD: head/share/man/man9/driver.9 79727 2001-07-14 19:41:16Z schweikh $ |
| 30.\" 31.Dd June 16, 1998 32.Dt DRIVER 9 33.Os 34.Sh NAME 35.Nm driver 36.Nd structure describing a device driver 37.Sh SYNOPSIS --- 33 unchanged lines hidden (view full) --- 71DRIVER_MODULE(foo, bogo, foo_driver, foo_devclass, 0, 0); 72.Ed 73.Sh DESCRIPTION 74Each driver in the kernel is described by a 75.Dv driver_t 76structure. The structure contains the name of the device, a pointer 77to a list of methods, an indication of the kind of device which the 78driver implements and the size of the private data which the driver | 30.\" 31.Dd June 16, 1998 32.Dt DRIVER 9 33.Os 34.Sh NAME 35.Nm driver 36.Nd structure describing a device driver 37.Sh SYNOPSIS --- 33 unchanged lines hidden (view full) --- 71DRIVER_MODULE(foo, bogo, foo_driver, foo_devclass, 0, 0); 72.Ed 73.Sh DESCRIPTION 74Each driver in the kernel is described by a 75.Dv driver_t 76structure. The structure contains the name of the device, a pointer 77to a list of methods, an indication of the kind of device which the 78driver implements and the size of the private data which the driver |
| 79needs to associate with a device instance. Each driver will implement | 79needs to associate with a device instance. Each driver will implement |
| 80one or more sets of methods (called interfaces). The example driver 81implements the standard "driver" interface and the fictitious "bogo" 82interface. 83.Pp 84When a driver is registered with the system (by the 85.Dv DRIVER_MODULE 86macro, see 87.Xr DRIVER_MODULE 9 ) , 88it is added to the list of drivers contained in the devclass 89of its parent bus type. For instance all PCI drivers would be 90contained in the devclass named "pci" and all ISA drivers would be 91in the devclass named "isa". | 80one or more sets of methods (called interfaces). The example driver 81implements the standard "driver" interface and the fictitious "bogo" 82interface. 83.Pp 84When a driver is registered with the system (by the 85.Dv DRIVER_MODULE 86macro, see 87.Xr DRIVER_MODULE 9 ) , 88it is added to the list of drivers contained in the devclass 89of its parent bus type. For instance all PCI drivers would be 90contained in the devclass named "pci" and all ISA drivers would be 91in the devclass named "isa". |
| 92The reason the drivers are not held in the device object of the parent | 92The reason the drivers are not held in the device object of the parent |
| 93bus is to handle multiple instances of a given type of bus. 94The 95.Dv DRIVER_MODULE 96macro will also create the devclass with the name of the driver and 97can optionally call extra initialisation code in the driver by 98specifying an extra module event handler and argument as the last two 99arguments. 100.Sh SEE ALSO 101.Xr devclass 9 , 102.Xr device 9 , 103.Xr DEVICE_ATTACH 9 , 104.Xr DEVICE_DETACH 9 , 105.Xr DEVICE_IDENTIFY 9 , 106.Xr DEVICE_PROBE 9 , 107.Xr DEVICE_SHUTDOWN 9 , 108.Xr DRIVER_MODULE 9 109.Sh AUTHORS 110This man page was written by 111.An Doug Rabson . | 93bus is to handle multiple instances of a given type of bus. 94The 95.Dv DRIVER_MODULE 96macro will also create the devclass with the name of the driver and 97can optionally call extra initialisation code in the driver by 98specifying an extra module event handler and argument as the last two 99arguments. 100.Sh SEE ALSO 101.Xr devclass 9 , 102.Xr device 9 , 103.Xr DEVICE_ATTACH 9 , 104.Xr DEVICE_DETACH 9 , 105.Xr DEVICE_IDENTIFY 9 , 106.Xr DEVICE_PROBE 9 , 107.Xr DEVICE_SHUTDOWN 9 , 108.Xr DRIVER_MODULE 9 109.Sh AUTHORS 110This man page was written by 111.An Doug Rabson . |