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