d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a manpage for the last of the driver's functions, the identify

Browse Source 
routine.

PR:		18654
Submitted by:	myself (reworked today)
This commit is contained in:
Alexander Langer 2001-03-10 19:34:42 +00:00
parent ab71708be3
commit 2fccaec614
1 changed files with 96 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
share/man/man9/DEVICE_IDENTIFY.9 Normal file
View File

@ -0,0 +1,96 @@
.\" -*- nroff -*-
.\"
.\" Copyright (c) 2001 Alexander Langer
.\"
.\" All rights reserved.
.\"
.\" This program is free software.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd March 10, 2001
.Dt DEVICE_IDENTIFY 9
.Os
.Sh NAME
.Nm DEVICE_IDENTIFY
.Nd identify a device, register it
.Sh SYNOPSIS
.Fd #include <sys/param.h>
.Fd #include <sys/bus.h>
.Ft void
.Fn DEVICE_IDENTIFY "driver_t *driver" "device_t parent"
.Sh DESCRIPTION
.Pp
The identify function for a device is only needed for devices on busses
that cannot identify their childs independently, e.g. the ISA bus.
It is used to recognize the device (usually done by accessing non-ambigous
registers in the hardware) and to tell the kernel about it and thus
creating a new device instance.
.Pp
.Xr BUS_ADD_CHILD 9
is used to register the device as a child of the bus.
The device's resources (such as IRQ and I/O ports) are registered
with the kernel by calling
.Fn bus_set_resource
for each resource (refer to
.Xr bus_set_resource 9
for more information).
.Sh EXAMPLES
.Pp
The following pseudo-code shows an example of a function that
probes for a piece of hardware and registers it and its resource
(an I/O port) with the kernel.
It also sets the description of the device.
.Bd -literal
void
foo_identify(driver_t *driver, device_t parent)
{
device_t child;
retrieve_device_information;
if (devices matches one of your supported devices) {
child = BUS_ADD_CHILD(parent, 0, "foo", -1);
device_set_desc_copy(child, "foo chip ver.123");
device_set_driver(child, driver);
bus_set_resource(child, SYS_RES_IOPORT, 0, FOO_IOADDR, 1);
}
}
.Ed
.Sh RETURN VALUES
.Pp
Zero is returned on success,
otherwise an appropriate error is returned (see
.Xr errno 2 ) .
.Sh SEE ALSO
.Xr device 9 ,
.Xr BUS_ADD_CHILD 9 ,
.Xr device_add_child 9 ,
.Xr device_set_desc_copy 9 ,
.Xr device_set_driver 9 ,
.Xr DEVICE_ATTACH 9 ,
.Xr DEVICE_DETACH 9 ,
.Xr DEVICE_PROBE 9 ,
.Xr bus_set_resource 9
.Sh AUTHORS
This man page was written by
.An Alexander Langer Aq alex@FreeBSD.org .