share/man/man4/bhnd_pmu.4

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