xref: /freebsd-src/share/man/man4/bhnd.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1148ed571SAdrian Chadd.\" Copyright (c) 2015 Landon Fuller
2148ed571SAdrian Chadd.\" All rights reserved.
3148ed571SAdrian Chadd.\"
4148ed571SAdrian Chadd.\" Redistribution and use in source and binary forms, with or without
5148ed571SAdrian Chadd.\" modification, are permitted provided that the following conditions
6148ed571SAdrian Chadd.\" are met:
7148ed571SAdrian Chadd.\" 1. Redistributions of source code must retain the above copyright
8148ed571SAdrian Chadd.\"    notice, this list of conditions and the following disclaimer.
9148ed571SAdrian Chadd.\" 2. Redistributions in binary form must reproduce the above copyright
10148ed571SAdrian Chadd.\"    notice, this list of conditions and the following disclaimer in the
11148ed571SAdrian Chadd.\"    documentation and/or other materials provided with the distribution.
12148ed571SAdrian Chadd.\"
13148ed571SAdrian Chadd.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14148ed571SAdrian Chadd.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15148ed571SAdrian Chadd.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16148ed571SAdrian Chadd.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17148ed571SAdrian Chadd.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18148ed571SAdrian Chadd.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19148ed571SAdrian Chadd.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20148ed571SAdrian Chadd.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21148ed571SAdrian Chadd.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22148ed571SAdrian Chadd.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23148ed571SAdrian Chadd.\" SUCH DAMAGE.
24148ed571SAdrian Chadd.\"
2557484262SLandon J. Fuller.Dd June 3, 2016
26148ed571SAdrian Chadd.Dt BHND 4
27148ed571SAdrian Chadd.Os
28148ed571SAdrian Chadd.Sh NAME
29148ed571SAdrian Chadd.Nm bhnd
30148ed571SAdrian Chadd.Nd Broadcom Home Networking Division interconnect bus
31148ed571SAdrian Chadd.Sh SYNOPSIS
32*05ed3f90SLandon J. FullerTo compile this driver into the kernel, add the following lines to the
33*05ed3f90SLandon J. Fullerkernel configuration file:
34148ed571SAdrian Chadd.Bd -ragged -offset indent
35148ed571SAdrian Chadd.Cd "device bhnd"
36148ed571SAdrian Chadd.Ed
37148ed571SAdrian Chadd.Pp
38*05ed3f90SLandon J. FullerTo load the driver as a module at boot, add this line to
39148ed571SAdrian Chadd.Xr loader.conf 5 :
40148ed571SAdrian Chadd.Bd -literal -offset indent
41148ed571SAdrian Chaddbhnd_load="YES"
42148ed571SAdrian Chadd.Ed
43148ed571SAdrian Chadd.Sh DESCRIPTION
44148ed571SAdrian ChaddThe
45148ed571SAdrian Chadd.Nm
46148ed571SAdrian Chadddriver provides a unified kernel bus interface to the on-chip
47148ed571SAdrian Chaddinterconnects used in Broadcom Home Networking Division (HND)
48148ed571SAdrian Chadddevices.
49148ed571SAdrian Chadd.Pp
50148ed571SAdrian ChaddThe Broadcom HND device family consists of SoCs (System On a Chip)
51148ed571SAdrian Chaddand host-connected chipsets based on a common library of Broadcom IP
5225972509SEdward Tomasz Napieralacores connected via an internal hardware bus architecture.
5325972509SEdward Tomasz NapieralaDrivers for these cores are implemented against the unified
54148ed571SAdrian Chadd.Nm
55148ed571SAdrian Chaddinterface.
56148ed571SAdrian Chadd.Pp
57148ed571SAdrian ChaddThe Sonic Inc. Silicon Backplane used in earlier HND devices is supported
58148ed571SAdrian Chaddby the
59148ed571SAdrian Chadd.Xr siba 4
60148ed571SAdrian ChaddBHND driver.
61148ed571SAdrian Chadd.Pp
62148ed571SAdrian ChaddThe ARM AMBA-based interconnect used in later HND devices is supported by
63148ed571SAdrian Chaddthe
64148ed571SAdrian Chadd.Xr bcma 4
65148ed571SAdrian ChaddBHND driver.
66148ed571SAdrian Chadd.Sh SEE ALSO
67148ed571SAdrian Chadd.Xr bcma 4 ,
682940eb19SChristian Brueffer.Xr bhndb 4 ,
69*05ed3f90SLandon J. Fuller.Xr intro 4 ,
70148ed571SAdrian Chadd.Xr siba 4
71148ed571SAdrian Chadd.Sh HISTORY
72148ed571SAdrian ChaddThe
73148ed571SAdrian Chadd.Nm
74148ed571SAdrian Chadddevice driver first appeared in
75148ed571SAdrian Chadd.Fx 11.0 .
76148ed571SAdrian Chadd.Sh AUTHORS
77148ed571SAdrian Chadd.An -nosplit
78148ed571SAdrian ChaddThe
79148ed571SAdrian Chadd.Nm
80148ed571SAdrian Chadddriver was written by
8157484262SLandon J. Fuller.An Landon Fuller Aq Mt landonf@FreeBSD.org .
82