share/man/man4/bcma.4

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