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