xref: /freebsd/share/man/man4/bhnd_chipc.4 (revision 2008043f386721d58158e37e0d7e50df8095942d)
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.Dd October 16, 2017
28.Dt BHND_CHIPC 4
29.Os
30.Sh NAME
31.Nm bhnd_chipc
32.Nd Broadcom Home Networking Division ChipCommon Driver
33.Sh SYNOPSIS
34To compile this driver into the kernel, add this line to the
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device bhnd"
38.Ed
39.Pp
40To compile driver support for all additional devices found in embedded systems,
41add the following additional lines to the kernel configuration file:
42.Bd -ragged -offset indent
43.Cd "device cfi"
44.Cd "device gpio"
45.Cd "device spibus"
46.Cd "device uart"
47.Ed
48.Pp
49To load the driver as a module at boot, add this line to
50.Xr loader.conf 5 :
51.Bd -literal -offset indent
52bhnd_load="YES"
53.Ed
54.Sh DESCRIPTION
55The
56.Nm
57driver supports the ChipCommon core found in Broadcom Home Networking
58Division network chipsets and embedded systems.
59.Pp
60The ChipCommon core provides an interface to common hardware facilities,
61including device identification, UARTs, CFI and SPI flash, One-time Programmable
62(OTP) Memory, and GPIO.
63.Sh SEE ALSO
64.Xr bhnd 4 ,
65.Xr intro 4
66.Sh HISTORY
67The
68.Nm
69device driver first appeared in
70.Fx 11.0 .
71.Sh AUTHORS
72.An -nosplit
73The
74.Nm
75driver was written by
76.An Landon Fuller Aq Mt landonf@FreeBSD.org ,
77and
78.An Michael Zhilin Aq Mt mizhka@FreeBSD.org .
79