xref: /freebsd/share/man/man4/bhnd_pmu.4 (revision 8a271827e7b5d5310e06df1f9f49ba0ef9efd263)
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_PMU 4
31.Os
32.Sh NAME
33.Nm bhnd_pmu
34.Nd Broadcom Home Networking Division PMU 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 load the driver as a module at boot, add this line to
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45bhnd_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50driver supports the Power Management Unit (PMU) found in Broadcom Home
51Networking Division network chipsets and embedded systems.
52.Pp
53The PMU provides a hardware interface for managing the device's clock and power
54topology.
55.Sh SEE ALSO
56.Xr bhnd 4 ,
57.Xr intro 4
58.Sh HISTORY
59The
60.Nm
61device driver first appeared in
62.Fx 12.0 .
63.Sh AUTHORS
64.An -nosplit
65The
66.Nm
67driver was derived from Broadcom's ISC-licensed Linux PMU drivers, and was
68ported to
69.Fx
70and
71.Xr bhnd 4
72by
73.An Landon Fuller Aq Mt landonf@FreeBSD.org .
74