xref: /freebsd/share/man/man4/siba.4 (revision 6c89995002b9c6d1a9c7365483c55c106fc752d5)
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.\"
27b5212e27SChristian Brueffer.Dd January 8, 2010
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
37b5212e27SChristian Brueffer.Cd "device siba"
38b5212e27SChristian Brueffer.Ed
39b5212e27SChristian Brueffer.Pp
40b5212e27SChristian BruefferAlternatively, to load the driver as a module at boot time,
41b5212e27SChristian Bruefferplace the following line in
42b5212e27SChristian Brueffer.Xr loader.conf 5 :
43b5212e27SChristian Brueffer.Bd -literal -offset indent
44b5212e27SChristian Brueffersiba_load="YES"
45b5212e27SChristian Brueffer.Ed
46b5212e27SChristian Brueffer.Sh DESCRIPTION
47b5212e27SChristian BruefferThe
48b5212e27SChristian Brueffer.Nm
49b5212e27SChristian Bruefferdriver supports the Sonic Inc. Silicon Backplane, the interblock
50b5212e27SChristian Brueffercommunications architecture that can be found in most Broadcom
51b5212e27SChristian Bruefferwireless NICs.
52b5212e27SChristian Brueffer.Pp
53b5212e27SChristian BruefferA bus connects all of the Silicon Backplane's functional blocks.
54b5212e27SChristian BruefferThese functional blocks, known as cores, use the Open Core Protocol
55b5212e27SChristian Brueffer(OCP) interface to communicate with agents attached to the Silicon
56b5212e27SChristian BruefferBackplane.
57b5212e27SChristian Brueffer.Pp
58b5212e27SChristian BruefferEach NIC uses a chip from the same chip family.
59b5212e27SChristian BruefferEach member of the family contains a different set of cores, but
60b5212e27SChristian Brueffershares basic architectural features such as address space definition,
61b5212e27SChristian Bruefferinterrupt and error architecture, and backplane register definitions.
62b5212e27SChristian Brueffer.Pp
63b5212e27SChristian BruefferEach core can have an initiator agent that passes read and write
64b5212e27SChristian Bruefferrequests onto the system backplane and a target agent that returns
65b5212e27SChristian Bruefferresponses to those requests.
66b5212e27SChristian BruefferNot all cores contain both an initiator and a target agent.
67b5212e27SChristian BruefferInitiator agents are present in cores that contain
68b5212e27SChristian Bruefferhost interfaces (PCI, PCMCIA), embedded processors (MIPS),
69b5212e27SChristian Bruefferor DMA processors associated with communications cores.
70b5212e27SChristian Brueffer.Pp
71b5212e27SChristian BruefferAll cores other than PCMCIA have a target agent.
72b5212e27SChristian Brueffer.Sh SEE ALSO
73b5212e27SChristian Brueffer.Xr bwn 4
74b5212e27SChristian Brueffer.Sh HISTORY
75b5212e27SChristian BruefferThe
76b5212e27SChristian Brueffer.Nm
77b5212e27SChristian Bruefferdevice driver first appeared in
78b5212e27SChristian Brueffer.Fx 8.0 .
79b5212e27SChristian Brueffer.Sh AUTHORS
80b5212e27SChristian Brueffer.An -nosplit
81b5212e27SChristian BruefferThe
82b5212e27SChristian Brueffer.Nm
83b5212e27SChristian Bruefferdriver was written by
84*6c899950SBaptiste Daroussin.An Bruce M. Simpson Aq Mt bms@FreeBSD.org
85b5212e27SChristian Bruefferand
86*6c899950SBaptiste Daroussin.An Weongyo Jeong Aq Mt weongyo@FreeBSD.org .
87b5212e27SChristian Brueffer.Sh CAVEATS
88b5212e27SChristian BruefferHost mode is not supported at this moment.
89