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