PDK API Guide for J721E
LoadP.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015-2020, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the 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 "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
49 #ifndef ti_osal_LoadP__include
50 #define ti_osal_LoadP__include
51 
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55 
56 #include <stdint.h>
57 #include <stdbool.h>
58 #include <stddef.h>
59 #include <ti/osal/TaskP.h>
60 
64 typedef enum LoadP_Status_e
65 {
67  LoadP_OK = 0,
69  LoadP_FAILURE = (-(int32_t)1)
70 } LoadP_Status;
71 
75 typedef struct LoadP_Stats_s
76 {
77  const char *name;
78  uint64_t threadTime;
79  uint64_t totalTime;
80  uint32_t percentLoad;
81 } LoadP_Stats;
82 
88 extern void LoadP_reset(void);
89 
100 extern LoadP_Status LoadP_getTaskLoad(TaskP_Handle taskHandle, LoadP_Stats *stats);
101 
107 extern uint32_t LoadP_getCPULoad(void);
108 
126 extern void LoadP_update(void);
127 
128 
129 #ifdef __cplusplus
130 }
131 #endif
132 
133 #endif /* ti_osal_LoadP__include */
134 /* @} */
void LoadP_update(void)
Update load statistics.
uint64_t threadTime
Definition: LoadP.h:78
LoadP_Status LoadP_getTaskLoad(TaskP_Handle taskHandle, LoadP_Stats *stats)
Function to get task load statistics.
const char * name
Definition: LoadP.h:77
uint32_t percentLoad
Definition: LoadP.h:80
Load statistics info.
Definition: LoadP.h:75
void * TaskP_Handle
Opaque client reference to an instance of a TaskP.
Definition: TaskP.h:81
Definition: LoadP.h:69
uint32_t LoadP_getCPULoad(void)
Function to get CPU load in percentage.
Task module for the RTOS Porting Interface.
uint64_t totalTime
Definition: LoadP.h:79
void LoadP_reset(void)
Function to Reset load statistics.
Definition: LoadP.h:67
LoadP_Status
Status codes for LoadP APIs.
Definition: LoadP.h:64