xref: /freebsd/share/man/man4/bhnd_chipc.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1*05ed3f90SLandon J. Fuller.\" Copyright (c) 2017 The FreeBSD Foundation
2*05ed3f90SLandon J. Fuller.\"
3*05ed3f90SLandon J. Fuller.\" This documentation was written by Landon Fuller under sponsorship from
4*05ed3f90SLandon J. Fuller.\" the FreeBSD Foundation.
5*05ed3f90SLandon J. Fuller.\"
6*05ed3f90SLandon J. Fuller.\" Redistribution and use in source and binary forms, with or without
7*05ed3f90SLandon J. Fuller.\" modification, are permitted provided that the following conditions
8*05ed3f90SLandon J. Fuller.\" are met:
9*05ed3f90SLandon J. Fuller.\" 1. Redistributions of source code must retain the above copyright
10*05ed3f90SLandon J. Fuller.\"    notice, this list of conditions and the following disclaimer.
11*05ed3f90SLandon J. Fuller.\" 2. Redistributions in binary form must reproduce the above copyright
12*05ed3f90SLandon J. Fuller.\"    notice, this list of conditions and the following disclaimer in the
13*05ed3f90SLandon J. Fuller.\"    documentation and/or other materials provided with the distribution.
14*05ed3f90SLandon J. Fuller.\"
15*05ed3f90SLandon J. Fuller.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16*05ed3f90SLandon J. Fuller.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17*05ed3f90SLandon J. Fuller.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18*05ed3f90SLandon J. Fuller.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19*05ed3f90SLandon J. Fuller.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20*05ed3f90SLandon J. Fuller.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21*05ed3f90SLandon J. Fuller.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22*05ed3f90SLandon J. Fuller.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23*05ed3f90SLandon J. Fuller.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24*05ed3f90SLandon J. Fuller.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25*05ed3f90SLandon J. Fuller.\" SUCH DAMAGE.
26*05ed3f90SLandon J. Fuller.\"
27*05ed3f90SLandon J. Fuller.Dd October 16, 2017
28*05ed3f90SLandon J. Fuller.Dt BHND_CHIPC 4
29*05ed3f90SLandon J. Fuller.Os
30*05ed3f90SLandon J. Fuller.Sh NAME
31*05ed3f90SLandon J. Fuller.Nm bhnd_chipc
32*05ed3f90SLandon J. Fuller.Nd Broadcom Home Networking Division ChipCommon Driver
33*05ed3f90SLandon J. Fuller.Sh SYNOPSIS
34*05ed3f90SLandon J. FullerTo compile this driver into the kernel, add this line to the
35*05ed3f90SLandon J. Fullerkernel configuration file:
36*05ed3f90SLandon J. Fuller.Bd -ragged -offset indent
37*05ed3f90SLandon J. Fuller.Cd "device bhnd"
38*05ed3f90SLandon J. Fuller.Ed
39*05ed3f90SLandon J. Fuller.Pp
40*05ed3f90SLandon J. FullerTo compile driver support for all additional devices found in embedded systems,
41*05ed3f90SLandon J. Fulleradd the following additional lines to the kernel configuration file:
42*05ed3f90SLandon J. Fuller.Bd -ragged -offset indent
43*05ed3f90SLandon J. Fuller.Cd "device cfi"
44*05ed3f90SLandon J. Fuller.Cd "device gpio"
45*05ed3f90SLandon J. Fuller.Cd "device spibus"
46*05ed3f90SLandon J. Fuller.Cd "device uart"
47*05ed3f90SLandon J. Fuller.Ed
48*05ed3f90SLandon J. Fuller.Pp
49*05ed3f90SLandon J. FullerTo load the driver as a module at boot, add this line to
50*05ed3f90SLandon J. Fuller.Xr loader.conf 5 :
51*05ed3f90SLandon J. Fuller.Bd -literal -offset indent
52*05ed3f90SLandon J. Fullerbhnd_load="YES"
53*05ed3f90SLandon J. Fuller.Ed
54*05ed3f90SLandon J. Fuller.Sh DESCRIPTION
55*05ed3f90SLandon J. FullerThe
56*05ed3f90SLandon J. Fuller.Nm
57*05ed3f90SLandon J. Fullerdriver supports the ChipCommon core found in Broadcom Home Networking
58*05ed3f90SLandon J. FullerDivision network chipsets and embedded systems.
59*05ed3f90SLandon J. Fuller.Pp
60*05ed3f90SLandon J. FullerThe ChipCommon core provides an interface to common hardware facilities,
61*05ed3f90SLandon J. Fullerincluding device identification, UARTs, CFI and SPI flash, One-time Programmable
62*05ed3f90SLandon J. Fuller(OTP) Memory, and GPIO.
63*05ed3f90SLandon J. Fuller.Sh SEE ALSO
64*05ed3f90SLandon J. Fuller.Xr bhnd 4 ,
65*05ed3f90SLandon J. Fuller.Xr intro 4
66*05ed3f90SLandon J. Fuller.Sh HISTORY
67*05ed3f90SLandon J. FullerThe
68*05ed3f90SLandon J. Fuller.Nm
69*05ed3f90SLandon J. Fullerdevice driver first appeared in
70*05ed3f90SLandon J. Fuller.Fx 11.0 .
71*05ed3f90SLandon J. Fuller.Sh AUTHORS
72*05ed3f90SLandon J. Fuller.An -nosplit
73*05ed3f90SLandon J. FullerThe
74*05ed3f90SLandon J. Fuller.Nm
75*05ed3f90SLandon J. Fullerdriver was written by
76*05ed3f90SLandon J. Fuller.An Landon Fuller Aq Mt landonf@FreeBSD.org ,
77*05ed3f90SLandon J. Fullerand
78*05ed3f90SLandon J. Fuller.An Michael Zhilin Aq Mt mizhka@FreeBSD.org .
79