xref: /freebsd/share/man/man4/siba.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
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.\"
25fc3562dbSGlen Barber.Dd September 13, 2017
26b5212e27SChristian Brueffer.Dt SIBA 4
27b5212e27SChristian Brueffer.Os
28b5212e27SChristian Brueffer.Sh NAME
29b5212e27SChristian Brueffer.Nm siba
30b5212e27SChristian Brueffer.Nd Sonic Inc. Silicon Backplane driver
31b5212e27SChristian Brueffer.Sh SYNOPSIS
32*05ed3f90SLandon J. FullerTo compile this driver into the kernel, add the following lines to the
33*05ed3f90SLandon J. Fullerkernel configuration file:
34b5212e27SChristian Brueffer.Bd -ragged -offset indent
35148ed571SAdrian Chadd.Cd "device bhnd"
36b5212e27SChristian Brueffer.Cd "device siba"
37b5212e27SChristian Brueffer.Ed
38b5212e27SChristian Brueffer.Pp
39*05ed3f90SLandon J. FullerTo load the driver as a module at boot, add this line to
40b5212e27SChristian Brueffer.Xr loader.conf 5 :
41b5212e27SChristian Brueffer.Bd -literal -offset indent
42b5212e27SChristian Brueffersiba_load="YES"
43b5212e27SChristian Brueffer.Ed
44b5212e27SChristian Brueffer.Sh DESCRIPTION
45b5212e27SChristian BruefferThe
46b5212e27SChristian Brueffer.Nm
47148ed571SAdrian Chadddriver provides
48148ed571SAdrian Chadd.Xr bhnd 4
49148ed571SAdrian Chaddsupport for devices based on the Sonic Inc. Silicon Backplane, an
50148ed571SAdrian Chaddinterblock communications architecture found in earlier Broadcom Home
51148ed571SAdrian ChaddNetworking Division wireless chipsets and embedded systems.
52b5212e27SChristian Brueffer.Pp
53148ed571SAdrian ChaddA common interconnect connects all of the Silicon Backplane's functional
5425972509SEdward Tomasz Napieralablocks.
5525972509SEdward Tomasz NapieralaThese functional blocks, known as cores, use the Open Core Protocol
56b5212e27SChristian Brueffer(OCP) interface to communicate with agents attached to the Silicon
57b5212e27SChristian BruefferBackplane.
58b5212e27SChristian Brueffer.Pp
59b5212e27SChristian BruefferEach core can have an initiator agent that passes read and write
60b5212e27SChristian Bruefferrequests onto the system backplane and a target agent that returns
61b5212e27SChristian Bruefferresponses to those requests.
62b5212e27SChristian BruefferNot all cores contain both an initiator and a target agent.
63b5212e27SChristian BruefferInitiator agents are present in cores that contain
64b5212e27SChristian Bruefferhost interfaces (PCI, PCMCIA), embedded processors (MIPS),
65b5212e27SChristian Bruefferor DMA processors associated with communications cores.
66b5212e27SChristian Brueffer.Sh SEE ALSO
67148ed571SAdrian Chadd.Xr bcma 4 ,
68*05ed3f90SLandon J. Fuller.Xr bhnd 4 ,
69*05ed3f90SLandon J. Fuller.Xr intro 4
70b5212e27SChristian Brueffer.Sh HISTORY
71b5212e27SChristian BruefferThe
72b5212e27SChristian Brueffer.Nm
73b5212e27SChristian Bruefferdevice driver first appeared in
74b5212e27SChristian Brueffer.Fx 8.0 .
75148ed571SAdrian ChaddThe driver was rewritten for
76fc3562dbSGlen Barber.Fx 11.0
77148ed571SAdrian Chaddto support the common Broadcom
78148ed571SAdrian Chadd.Xr bhnd 4
79148ed571SAdrian Chaddbus interface.
80b5212e27SChristian Brueffer.Sh AUTHORS
81b5212e27SChristian Brueffer.An -nosplit
82b5212e27SChristian BruefferThe
83b5212e27SChristian Brueffer.Nm
84148ed571SAdrian Chadddriver was originally written by
856c899950SBaptiste Daroussin.An Bruce M. Simpson Aq Mt bms@FreeBSD.org
86b5212e27SChristian Bruefferand
876c899950SBaptiste Daroussin.An Weongyo Jeong Aq Mt weongyo@FreeBSD.org .
88148ed571SAdrian ChaddThe driver was rewritten for
8957484262SLandon J. Fuller.Fx 11.0
90148ed571SAdrian Chaddby
9157484262SLandon J. Fuller.An Landon Fuller Aq Mt landonf@FreeBSD.org .
92