share/man/man4/siba.4

   1 .\" Copyright (c) 2010 Weongyo Jeong
   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 September 13, 2017
  28 .Dt SIBA 4
  29 .Os
  30 .Sh NAME
  31 .Nm siba
  32 .Nd Sonic Inc. Silicon Backplane driver
  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 .Cd "device siba"
  39 .Ed
  40 .Pp
  41 Alternatively, to load the driver as a module at boot time,
  42 place the following line in
  43 .Xr loader.conf 5 :
  44 .Bd -literal -offset indent
  45 siba_load="YES"
  46 .Ed
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 driver provides
  51 .Xr bhnd 4
  52 support for devices based on the Sonic Inc. Silicon Backplane, an
  53 interblock communications architecture found in earlier Broadcom Home
  54 Networking Division wireless chipsets and embedded systems.
  55 .Pp
  56 A common interconnect connects all of the Silicon Backplane's functional
  57 blocks.
  58 These functional blocks, known as cores, use the Open Core Protocol
  59 (OCP) interface to communicate with agents attached to the Silicon
  60 Backplane.
  61 .Pp
  62 Each core can have an initiator agent that passes read and write
  63 requests onto the system backplane and a target agent that returns
  64 responses to those requests.
  65 Not all cores contain both an initiator and a target agent.
  66 Initiator agents are present in cores that contain
  67 host interfaces (PCI, PCMCIA), embedded processors (MIPS),
  68 or DMA processors associated with communications cores.
  69 .Sh SEE ALSO
  70 .Xr bcma 4 ,
  71 .Xr bhnd 4
  72 .Sh HISTORY
  73 The
  74 .Nm
  75 device driver first appeared in
  76 .Fx 8.0 .
  77 The driver was rewritten for
  78 .Fx 11.0
  79 to support the common Broadcom
  80 .Xr bhnd 4
  81 bus interface.
  82 .Sh AUTHORS
  83 .An -nosplit
  84 The
  85 .Nm
  86 driver was originally written by
  87 .An Bruce M. Simpson Aq Mt bms@FreeBSD.org
  88 and
  89 .An Weongyo Jeong Aq Mt weongyo@FreeBSD.org .
  90 The driver was rewritten for
  91 .Fx 11.0
  92 by
  93 .An Landon Fuller Aq Mt landonf@FreeBSD.org .