xref: /freebsd/share/man/man9/bus_generic_print_child.9 (revision 1669d8afc64812c8d2d1d147ae1fd42ff441e1b1)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 1998 Doug Rabson
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 June 16, 1998
32.Dt BUS_GENERIC_PRINT_CHILD 9
33.Os
34.Sh NAME
35.Nm bus_generic_print_child
36.Nd generic implementation of
37.Dv DEVICE_PRINT_CHILD
38for busses
39.Sh SYNOPSIS
40.In sys/param.h
41.In sys/bus.h
42.Ft int
43.Fn bus_generic_print_child "device_t dev" "device_t child"
44.Sh DESCRIPTION
45This implementation prints out the default device announcement message.
46Given device 'foo0' on bus 'bar0' where foo0 has the name "FooCard 1234" the
47following would be printed:
48.Pp
49foo0: <FooCard 1234> on bar0
50.Pp
51bus_generic_print_child itself calls two functions
52.Fn bus_print_child_header
53and
54.Fn bus_print_child_footer
55The former prints "foo0: <FooCard 1234>" and the latter "on bar0".
56These routines should be used if possible in your own code if
57.Fn bus_generic_print_child
58does not completely suit your needs.
59.Sh RETURN VALUES
60The number of characters output.
61.Sh SEE ALSO
62.Xr device 9
63.Sh AUTHORS
64This manual page was written by
65.An Doug Rabson .
66