xref: /freebsd/lib/libpmc/pmc_init.3 (revision 7899f917b1c0ea178f1d2be0cfb452086d079d23)
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.Dd November 24, 2007
25.Dt PMC_INIT 3
26.Os
27.Sh NAME
28.Nm pmc_init
29.Nd initialize library
30.Sh LIBRARY
31.Lb libpmc
32.Sh SYNOPSIS
33.In pmc.h
34.Ft int
35.Fn pmc_init void
36.Sh DESCRIPTION
37Function
38.Fn pmc_init
39initializes the PMC library.
40This function must be called before any of the other functions in the
41library.
42.Sh RETURN VALUES
43.Rv -std pmc_init
44.Sh ERRORS
45A call to
46.Fn pmc_init
47may fail with the following errors:
48.Bl -tag -width Er
49.It Bq Er ENOENT
50The
51.Xr hwpmc 4
52module was not found in the kernel.
53.It Bq Er EPROGMISMATCH
54The library's version number did not match that expected by
55.Xr hwpmc 4 .
56.It Bq Er ENXIO
57PMC hardware on this system is unsupported.
58.El
59.Sh SEE ALSO
60.Xr pmc 3 ,
61.Xr hwpmc 4
62