share/man/man4/bhnd.4

   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 .\" $FreeBSD$
  26 .\"
  27 .Dd June 3, 2016
  28 .Dt BHND 4
  29 .Os
  30 .Sh NAME
  31 .Nm bhnd
  32 .Nd Broadcom Home Networking Division interconnect bus
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device bhnd"
  38 .Ed
  39 .Pp
  40 Alternatively, to load the driver as a module at boot time,
  41 place the following line in
  42 .Xr loader.conf 5 :
  43 .Bd -literal -offset indent
  44 bhnd_load="YES"
  45 .Ed
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 driver provides a unified kernel bus interface to the on-chip
  50 interconnects used in Broadcom Home Networking Division (HND)
  51 devices.
  52 .Pp
  53 The Broadcom HND device family consists of SoCs (System On a Chip)
  54 and host-connected chipsets based on a common library of Broadcom IP
  55 cores connected via an internal hardware bus architecture.
  56 Drivers for these cores are implemented against the unified
  57 .Nm
  58 interface.
  59 .Pp
  60 The Sonic Inc. Silicon Backplane used in earlier HND devices is supported
  61 by the
  62 .Xr siba 4
  63 BHND driver.
  64 .Pp
  65 The ARM AMBA-based interconnect used in later HND devices is supported by
  66 the
  67 .Xr bcma 4
  68 BHND driver.
  69 .Sh SEE ALSO
  70 .Xr bhndb 4 ,
  71 .Xr bcma 4 ,
  72 .Xr siba 4
  73 .Sh HISTORY
  74 The
  75 .Nm
  76 device driver first appeared in
  77 .Fx 11.0 .
  78 .Sh AUTHORS
  79 .An -nosplit
  80 The
  81 .Nm
  82 driver was written by
  83 .An Landon Fuller Aq Mt landonf@FreeBSD.org .