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