readme.txt
1Percepio Trace Recorder SDK v4.5.1
2Copyright 2021 Percepio AB
3www.percepio.com
4
5The SDK is intended to simplify Trace Recorder integration for third party software.
6
7API:
8traceResult xTraceSDKRegisterObject(uint32_t uiEventCode, void* pxObject, uint32_t uiData)
9
10Parameters:
11uiEventCode - The event code.
12pxObject - The pointer to the object.
13uiData - The object's initial data.
14
15Returns:
16TRACE_SUCCESS or TRACE_FAIL.
17
18
19traceResult xTraceSDKUnregisterObject(uint32_t uiEventCode, void* pxObject, uint32_t uiData)
20
21This function will unregister an object in the trace.
22
23Parameters:
24uiEventCode - The event code.
25pxObject - The pointer to the object.
26uiData - The object's end data.
27
28Returns:
29TRACE_SUCCESS or TRACE_FAIL.
30
31
32traceResult xTraceSDKSetObjectName(void* pxObject, const char* pszName)
33
34This function will set an object's name.
35
36Parameters:
37pxObject - The pointer to the object.
38pszName - The task name.
39
40Returns:
41TRACE_SUCCESS or TRACE_FAIL.
42
43
44traceResult xTraceSDKSetObjectData(void* pxObject, uint32_t uiData)
45
46This function will set an object's data.
47
48Parameters:
49pxObject - The pointer to the object.
50uiData - The object's data.
51
52Returns:
53TRACE_SUCCESS or TRACE_FAIL.
54
55
56traceResult xTraceSDKTaskSwitch(void* pxTCB, uint32_t uiPriority)
57
58This function will register a task switch and the task's priority.
59
60Parameters:
61pxTCB - The pointer to the TCB.
62uiPriority - The task priority.
63
64Returns:
65TRACE_SUCCESS or TRACE_FAIL.
66
67traceResult xTraceSDKTaskReady(void* pxTCB)
68
69This function will set a task to ready in the trace.
70
71Parameters:
72pxTCB - The pointer to the TCB.
73
74Returns:
75TRACE_SUCCESS or TRACE_FAIL.
76
77
78traceResult xTraceSDKEventBegin(uint32_t uiEventCode, uint32_t uiPayloadSize)
79
80This function will begin an event and allow for payload to be added via the
81xTraceSDKEventAdd****() functions.
82
83Parameters:
84uiEventCode - The event code.
85uiPayloadSize - The expected payload size in bytes.
86
87Returns:
88TRACE_SUCCESS or TRACE_FAIL.
89
90
91traceResult xTraceSDKEventEnd(void)
92
93This function ends an event.
94
95Returns:
96TRACE_SUCCESS or TRACE_FAIL.
97
98
99traceResult xTraceSDKEventAddData(void* pvData, uint32_t uiSize)
100
101This function will add data as payload.
102
103Parameters:
104pvData - The pointer to the data.
105uiSize - The data size.
106
107Returns:
108TRACE_SUCCESS or TRACE_FAIL.
109
110
111traceResult xTraceSDKEventAddObject(void* pxObject)
112
113This function will add an object as payload.
114
115Parameters:
116pxObject - The pointer to the object.
117
118Returns:
119TRACE_SUCCESS or TRACE_FAIL.
120
121
122traceResult xTraceSDKEventAdd32(uint32_t value)
123
124This function will add an uint32_t as payload.
125
126Parameters:
127value - The value.
128
129Returns:
130TRACE_SUCCESS or TRACE_FAIL.
131
132
133traceResult xTraceSDKEventAdd16(uint16_t value)
134
135This function will add an uint16_t as payload.
136
137Parameters:
138value - The value.
139
140Returns:
141TRACE_SUCCESS or TRACE_FAIL.
142
143
144traceResult xTraceSDKEventAdd8(uint8_t value)
145
146This function will add an uint8_t as payload.
147
148Parameters:
149value - The value.
150
151Returns:
152TRACE_SUCCESS or TRACE_FAIL.
153
