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