AM263Px MCU+ SDK: pmu.h Source File

| AM263Px MCU+ SDK 26.00.00 |

pmu.h
Go to the documentation of this file.
1 /*
2 * Copyright (C) 2023 Texas Instruments Incorporated
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the
14 * distribution.
15 *
16 * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
50 #ifndef PMU_V0_H_
51 #define PMU_V0_H_
52
53 /* ========================================================================== */
54 /* Include Files */
55 /* ========================================================================== */
56
57 #include <stdint.h>
58 #include <drivers/pmu/r5f/csl_arm_r5_pmu.h>
59
60 #ifdef __cplusplus
61 extern "C" {
62 #endif
63
64 /* ========================================================================== */
65 /* Macros & Typedefs */
66 /* ========================================================================== */
67
68 /* ========================================================================== */
69 /* Structure Declarations */
70 /* ========================================================================== */
76 typedef struct
77 {
78 uint32_t type;
79 /* Type of the event. Refer \ref R5_PMU_EventTypes */
80 const char* name;
81 /* Name of the event, user can give any logical name */
82 } PMU_EventCfg;
83
89 typedef struct
90 {
91 uint32_t bCycleCounter;
92 uint32_t numEventCounters;
93 PMU_EventCfg *eventCounters;
94
95 } PMU_Config;
96
97 /* ========================================================================== */
98 /* Function Declarations */
99 /* ========================================================================== */
100
109 int32_t PMU_init(PMU_Config *cfg);
110
119 int32_t PMU_profileStart(const char *name);
120
132 int32_t PMU_profileEnd(const char *name);
133
142 void PMU_profilePrintEntry(const char *name);
143
150 void PMU_profilePrint(void);
151
152 #ifdef __cplusplus
153 }
154 #endif
155
156 #endif /* #ifndef PMU_V0_H_ */
157
158
PMU_Config::numEventCounters
uint32_t numEventCounters
Definition: pmu.h:92
PMU_profileStart
int32_t PMU_profileStart(const char *name)
Function to start profiling with the current configuration.
PMU_Config::eventCounters
PMU_EventCfg * eventCounters
Definition: pmu.h:93
PMU_init
int32_t PMU_init(PMU_Config *cfg)
Function to initialize the PMU for profiling.
PMU_EventCfg
Data structure used in PMU_Config.
Definition: pmu.h:77
PMU_profileEnd
int32_t PMU_profileEnd(const char *name)
Function to end profiling with the current configuration.
PMU_EventCfg::type
uint32_t type
Definition: pmu.h:78
PMU_Config
Data structure to be used with PMU_init.
Definition: pmu.h:90
PMU_Config::bCycleCounter
uint32_t bCycleCounter
Definition: pmu.h:91
PMU_EventCfg::name
const char * name
Definition: pmu.h:80
PMU_profilePrintEntry
void PMU_profilePrintEntry(const char *name)
Function to print the profiling stats for a particular profiling point.
PMU_profilePrint
void PMU_profilePrint(void)
Function to print the profiling stats for all the points done till now.