diff options
Diffstat (limited to 'lib/libpmc/pmc_init.3')
-rw-r--r-- | lib/libpmc/pmc_init.3 | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/lib/libpmc/pmc_init.3 b/lib/libpmc/pmc_init.3 new file mode 100644 index 0000000..655bfb6 --- /dev/null +++ b/lib/libpmc/pmc_init.3 @@ -0,0 +1,63 @@ +.\" Copyright (c) 2007 Joseph Koshy. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" This software is provided by Joseph Koshy ``as is'' and +.\" any express or implied warranties, including, but not limited to, the +.\" implied warranties of merchantability and fitness for a particular purpose +.\" are disclaimed. in no event shall Joseph Koshy be liable +.\" for any direct, indirect, incidental, special, exemplary, or consequential +.\" damages (including, but not limited to, procurement of substitute goods +.\" or services; loss of use, data, or profits; or business interruption) +.\" however caused and on any theory of liability, whether in contract, strict +.\" liability, or tort (including negligence or otherwise) arising in any way +.\" out of the use of this software, even if advised of the possibility of +.\" such damage. +.\" +.\" $FreeBSD$ +.\" +.Dd November 24, 2007 +.Dt PMC_INIT 3 +.Os +.Sh NAME +.Nm pmc_init +.Nd initialize library +.Sh LIBRARY +.Lb libpmc +.Sh SYNOPSIS +.In pmc.h +.Ft int +.Fn pmc_init void +.Sh DESCRIPTION +Function +.Fn pmc_init +initializes the PMC library. +This function must be called before any of the other functions in the +library. +.Sh RETURN VALUES +.Rv -std pmc_init +.Sh ERRORS +A call to +.Fn pmc_init +may fail with the following errors: +.Bl -tag -width Er +.It Bq Er ENOENT +The +.Xr hwpmc 4 +module was not found in the kernel. +.It Bq Er EPROGMISMATCH +The library's version number did not match that expected by +.Xr hwpmc 4 . +.It Bq Er ENXIO +PMC hardware on this system is unsupported. +.El +.Sh SEE ALSO +.Xr pmc 3 , +.Xr hwpmc 4 |