xref: /freebsd/share/man/man4/siba.4 (revision 574842628054be87be9d1768332b42d5be9acf93)
1b5212e27SChristian Brueffer.\" Copyright (c) 2010 Weongyo Jeong
2b5212e27SChristian Brueffer.\" All rights reserved.
3b5212e27SChristian Brueffer.\"
4b5212e27SChristian Brueffer.\" Redistribution and use in source and binary forms, with or without
5b5212e27SChristian Brueffer.\" modification, are permitted provided that the following conditions
6b5212e27SChristian Brueffer.\" are met:
7b5212e27SChristian Brueffer.\" 1. Redistributions of source code must retain the above copyright
8b5212e27SChristian Brueffer.\"    notice, this list of conditions and the following disclaimer.
9b5212e27SChristian Brueffer.\" 2. Redistributions in binary form must reproduce the above copyright
10b5212e27SChristian Brueffer.\"    notice, this list of conditions and the following disclaimer in the
11b5212e27SChristian Brueffer.\"    documentation and/or other materials provided with the distribution.
12b5212e27SChristian Brueffer.\"
13b5212e27SChristian Brueffer.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14b5212e27SChristian Brueffer.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15b5212e27SChristian Brueffer.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16b5212e27SChristian Brueffer.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17b5212e27SChristian Brueffer.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18b5212e27SChristian Brueffer.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19b5212e27SChristian Brueffer.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20b5212e27SChristian Brueffer.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21b5212e27SChristian Brueffer.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22b5212e27SChristian Brueffer.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23b5212e27SChristian Brueffer.\" SUCH DAMAGE.
24b5212e27SChristian Brueffer.\"
25b5212e27SChristian Brueffer.\" $FreeBSD$
26b5212e27SChristian Brueffer.\"
27*57484262SLandon J. Fuller.Dd June 3, 2016
28b5212e27SChristian Brueffer.Dt SIBA 4
29b5212e27SChristian Brueffer.Os
30b5212e27SChristian Brueffer.Sh NAME
31b5212e27SChristian Brueffer.Nm siba
32b5212e27SChristian Brueffer.Nd Sonic Inc. Silicon Backplane driver
33b5212e27SChristian Brueffer.Sh SYNOPSIS
34b5212e27SChristian BruefferTo compile this driver into the kernel,
35b5212e27SChristian Bruefferplace the following lines in your kernel configuration file:
36b5212e27SChristian Brueffer.Bd -ragged -offset indent
37148ed571SAdrian Chadd.Cd "device bhnd"
38b5212e27SChristian Brueffer.Cd "device siba"
39b5212e27SChristian Brueffer.Ed
40b5212e27SChristian Brueffer.Pp
41b5212e27SChristian BruefferAlternatively, to load the driver as a module at boot time,
42b5212e27SChristian Bruefferplace the following line in
43b5212e27SChristian Brueffer.Xr loader.conf 5 :
44b5212e27SChristian Brueffer.Bd -literal -offset indent
45b5212e27SChristian Brueffersiba_load="YES"
46b5212e27SChristian Brueffer.Ed
47b5212e27SChristian Brueffer.Sh DESCRIPTION
48b5212e27SChristian BruefferThe
49b5212e27SChristian Brueffer.Nm
50148ed571SAdrian Chadddriver provides
51148ed571SAdrian Chadd.Xr bhnd 4
52148ed571SAdrian Chaddsupport for devices based on the Sonic Inc. Silicon Backplane, an
53148ed571SAdrian Chaddinterblock communications architecture found in earlier Broadcom Home
54148ed571SAdrian ChaddNetworking Division wireless chipsets and embedded systems.
55b5212e27SChristian Brueffer.Pp
56148ed571SAdrian ChaddA common interconnect connects all of the Silicon Backplane's functional
57148ed571SAdrian Chaddblocks. These functional blocks, known as cores, use the Open Core Protocol
58b5212e27SChristian Brueffer(OCP) interface to communicate with agents attached to the Silicon
59b5212e27SChristian BruefferBackplane.
60b5212e27SChristian Brueffer.Pp
61b5212e27SChristian BruefferEach core can have an initiator agent that passes read and write
62b5212e27SChristian Bruefferrequests onto the system backplane and a target agent that returns
63b5212e27SChristian Bruefferresponses to those requests.
64b5212e27SChristian BruefferNot all cores contain both an initiator and a target agent.
65b5212e27SChristian BruefferInitiator agents are present in cores that contain
66b5212e27SChristian Bruefferhost interfaces (PCI, PCMCIA), embedded processors (MIPS),
67b5212e27SChristian Bruefferor DMA processors associated with communications cores.
68b5212e27SChristian Brueffer.Sh SEE ALSO
69148ed571SAdrian Chadd.Xr bcma 4 ,
70148ed571SAdrian Chadd.Xr bhnd 4
71b5212e27SChristian Brueffer.Sh HISTORY
72b5212e27SChristian BruefferThe
73b5212e27SChristian Brueffer.Nm
74b5212e27SChristian Bruefferdevice driver first appeared in
75b5212e27SChristian Brueffer.Fx 8.0 .
76148ed571SAdrian ChaddThe driver was rewritten for
77148ed571SAdrian Chadd.Fx 11.0 .
78148ed571SAdrian Chaddto support the common Broadcom
79148ed571SAdrian Chadd.Xr bhnd 4
80148ed571SAdrian Chaddbus interface.
81b5212e27SChristian Brueffer.Sh AUTHORS
82b5212e27SChristian Brueffer.An -nosplit
83b5212e27SChristian BruefferThe
84b5212e27SChristian Brueffer.Nm
85148ed571SAdrian Chadddriver was originally written by
866c899950SBaptiste Daroussin.An Bruce M. Simpson Aq Mt bms@FreeBSD.org
87b5212e27SChristian Bruefferand
886c899950SBaptiste Daroussin.An Weongyo Jeong Aq Mt weongyo@FreeBSD.org .
89148ed571SAdrian Chadd
90148ed571SAdrian ChaddThe driver was rewritten for
91*57484262SLandon J. Fuller.Fx 11.0
92148ed571SAdrian Chaddby
93*57484262SLandon J. Fuller.An Landon Fuller Aq Mt landonf@FreeBSD.org .
94