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