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