xref: /freebsd/share/man/man4/bhnd.4 (revision 22cf89c938886d14f5796fc49f9f020c23ea8eaf)
1.\" Copyright (c) 2015 Landon Fuller
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd June 3, 2016
26.Dt BHND 4
27.Os
28.Sh NAME
29.Nm bhnd
30.Nd Broadcom Home Networking Division interconnect bus
31.Sh SYNOPSIS
32To compile this driver into the kernel, add the following lines to the
33kernel configuration file:
34.Bd -ragged -offset indent
35.Cd "device bhnd"
36.Ed
37.Pp
38To load the driver as a module at boot, add this line to
39.Xr loader.conf 5 :
40.Bd -literal -offset indent
41bhnd_load="YES"
42.Ed
43.Sh DESCRIPTION
44The
45.Nm
46driver provides a unified kernel bus interface to the on-chip
47interconnects used in Broadcom Home Networking Division (HND)
48devices.
49.Pp
50The Broadcom HND device family consists of SoCs (System On a Chip)
51and host-connected chipsets based on a common library of Broadcom IP
52cores connected via an internal hardware bus architecture.
53Drivers for these cores are implemented against the unified
54.Nm
55interface.
56.Pp
57The Sonic Inc. Silicon Backplane used in earlier HND devices is supported
58by the
59.Xr siba 4
60BHND driver.
61.Pp
62The ARM AMBA-based interconnect used in later HND devices is supported by
63the
64.Xr bcma 4
65BHND driver.
66.Sh SEE ALSO
67.Xr bcma 4 ,
68.Xr bhndb 4 ,
69.Xr intro 4 ,
70.Xr siba 4
71.Sh HISTORY
72The
73.Nm
74device driver first appeared in
75.Fx 11.0 .
76.Sh AUTHORS
77.An -nosplit
78The
79.Nm
80driver was written by
81.An Landon Fuller Aq Mt landonf@FreeBSD.org .
82