lib/libpmc/pmc_init.3

   1 .\" Copyright (c) 2007 Joseph Koshy.  All rights reserved.
   2 .\"
   3 .\" Redistribution and use in source and binary forms, with or without
   4 .\" modification, are permitted provided that the following conditions
   5 .\" are met:
   6 .\" 1. Redistributions of source code must retain the above copyright
   7 .\"    notice, this list of conditions and the following disclaimer.
   8 .\" 2. Redistributions in binary form must reproduce the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer in the
  10 .\"    documentation and/or other materials provided with the distribution.
  11 .\"
  12 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  15 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  22 .\" SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD$
  25 .\"
  26 .Dd November 24, 2007
  27 .Dt PMC_INIT 3
  28 .Os
  29 .Sh NAME
  30 .Nm pmc_init
  31 .Nd initialize library
  32 .Sh LIBRARY
  33 .Lb libpmc
  34 .Sh SYNOPSIS
  35 .In pmc.h
  36 .Ft int
  37 .Fn pmc_init void
  38 .Sh DESCRIPTION
  39 Function
  40 .Fn pmc_init
  41 initializes the PMC library.
  42 This function must be called before any of the other functions in the
  43 library.
  44 .Sh RETURN VALUES
  45 .Rv -std pmc_init
  46 .Sh ERRORS
  47 A call to
  48 .Fn pmc_init
  49 may fail with the following errors:
  50 .Bl -tag -width Er
  51 .It Bq Er ENOENT
  52 The
  53 .Xr hwpmc 4
  54 module was not found in the kernel.
  55 .It Bq Er EPROGMISMATCH
  56 The library's version number did not match that expected by
  57 .Xr hwpmc 4 .
  58 .It Bq Er ENXIO
  59 PMC hardware on this system is unsupported.
  60 .El
  61 .Sh SEE ALSO
  62 .Xr pmc 3 ,
  63 .Xr hwpmc 4