xref: /freebsd/share/man/man4/siba.4 (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
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 siba"
38.Ed
39.Pp
40Alternatively, to load the driver as a module at boot time,
41place the following line in
42.Xr loader.conf 5 :
43.Bd -literal -offset indent
44siba_load="YES"
45.Ed
46.Sh DESCRIPTION
47The
48.Nm
49driver supports the Sonic Inc. Silicon Backplane, the interblock
50communications architecture that can be found in most Broadcom
51wireless NICs.
52.Pp
53A bus connects all of the Silicon Backplane's functional blocks.
54These functional blocks, known as cores, use the Open Core Protocol
55(OCP) interface to communicate with agents attached to the Silicon
56Backplane.
57.Pp
58Each NIC uses a chip from the same chip family.
59Each member of the family contains a different set of cores, but
60shares basic architectural features such as address space definition,
61interrupt and error architecture, and backplane register definitions.
62.Pp
63Each core can have an initiator agent that passes read and write
64requests onto the system backplane and a target agent that returns
65responses to those requests.
66Not all cores contain both an initiator and a target agent.
67Initiator agents are present in cores that contain
68host interfaces (PCI, PCMCIA), embedded processors (MIPS),
69or DMA processors associated with communications cores.
70.Pp
71All cores other than PCMCIA have a target agent.
72.Sh SEE ALSO
73.Xr bwn 4
74.Sh HISTORY
75The
76.Nm
77device driver first appeared in
78.Fx 8.0 .
79.Sh AUTHORS
80.An -nosplit
81The
82.Nm
83driver was written by
84.An Bruce M. Simpson Aq Mt bms@FreeBSD.org
85and
86.An Weongyo Jeong Aq Mt weongyo@FreeBSD.org .
87.Sh CAVEATS
88Host mode is not supported at this moment.
89