Sync usage with man page.
[netbsd-mini2440.git] / lib / libpmc / pmc.h
blob242bade8c0601dc0d29a5824871ab3a8345d4d7b
1 /* $NetBSD: pmc.h,v 1.1 2002/08/09 00:03:15 thorpej Exp $ */
3 /*
4 * Copyright (c 2002 Wasabi Systems, Inc.
5 * All rights reserved.
7 * Written by Jason R. Thorpe for Wasabi Systems, Inc.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed for the NetBSD Project by
20 * Wasabi Systems, Inc.
21 * 4. The name of Wasabi Systems, Inc. may not be used to endorse
22 * or promote products derived from this software without specific prior
23 * written permission.
25 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
29 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
38 #ifndef _PMC_H_
39 #define _PMC_H_
41 #include <sys/types.h>
42 #include <sys/pmc.h>
44 struct pmc_event {
45 const char *name;
46 pmc_evid_t val;
49 __BEGIN_DECLS
50 int pmc_configure_counter(int, const char *, pmc_ctr_t, uint32_t);
51 int pmc_start_counter(int);
52 int pmc_stop_counter(int);
53 int pmc_get_num_counters(void);
54 int pmc_get_counter_class(void);
55 int pmc_get_counter_type(int, int *);
56 int pmc_get_counter_value(int, uint64_t *);
57 int pmc_get_accumulated_counter_value(int, uint64_t *);
59 const char *pmc_get_counter_class_name(int);
60 const char *pmc_get_counter_type_name(int);
61 const char *pmc_get_counter_event_name(pmc_evid_t);
62 const struct pmc_event *pmc_get_counter_event_list(void);
63 __END_DECLS
65 #endif /* _PMC_H_ */