FreeRTOS: Common I/O
AWS IoT Common I/O library
Return to main page ↑
iot_perfcounter.h
Go to the documentation of this file.
1 /*
2  * FreeRTOS Common IO V1.0.0
3  * Copyright (C) 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
6  * this software and associated documentation files (the "Software"), to deal in
7  * the Software without restriction, including without limitation the rights to
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9  * the Software, and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * http://aws.amazon.com/freertos
23  * http://www.FreeRTOS.org
24  */
25 
26 /*******************************************************************************
27  * @file iot_perfcounter.h
28  *
29  * @breif HAL APIs for Performance Counter
30  *
31  *******************************************************************************
32  */
33 
39 #ifndef _IOT_PERFCOUNTER_H
40 #define _IOT_PERFCOUNTER_H
41 
55 void iot_perfcounter_open(void);
56 
63 uint64_t iot_perfcounter_get_value(void);
64 
74 uint32_t iot_perfcounter_get_frequency(void);
75 
76 
82 void iot_perfcounter_close(void);
83 
88 #endif
uint32_t iot_perfcounter_get_frequency(void)
iot_perfcounter_get_frequency is used to get the current frequency performance counters are running a...
uint64_t iot_perfcounter_get_value(void)
iot_perfcounter_get_value is used to get the current performance counter value.
void iot_perfcounter_open(void)
iot_perfcounter_open is used to Initialize the performance counter.
void iot_perfcounter_close(void)
iot_perfcounter_close is used to de-initialize the perfcounter. It may reset the counter value in per...