1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
|
/*************************************************************************/ /*!
@File
@Title RGX API Header kernel mode
@Copyright Copyright (c) Imagination Technologies Ltd. All Rights Reserved
@Description Exported RGX API details
@License Dual MIT/GPLv2
The contents of this file are subject to the MIT license as set out below.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
Alternatively, the contents of this file may be used under the terms of
the GNU General Public License Version 2 ("GPL") in which case the provisions
of GPL are applicable instead of those above.
If you wish to allow use of your version of this file only under the terms of
GPL, and not to allow others to use your version of this file under the terms
of the MIT license, indicate your decision by deleting the provisions above
and replace them with the notice and other provisions required by GPL as set
out in the file called "GPL-COPYING" included in this distribution. If you do
not delete the provisions above, a recipient may use your version of this file
under the terms of either the MIT license or GPL.
This License is also included in this distribution in the file called
"MIT-COPYING".
EXCEPT AS OTHERWISE STATED IN A NEGOTIATED AGREEMENT: (A) THE SOFTWARE IS
PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT; AND (B) IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/ /**************************************************************************/
#ifndef __RGXAPI_KM_H__
#define __RGXAPI_KM_H__
#if defined(SUPPORT_SHARED_SLC) && !defined(PVRSRV_GPUVIRT_GUESTDRV)
/*!
******************************************************************************
@Function RGXInitSLC
@Description Init the SLC after a power up. It is required to call this
function if using SUPPORT_SHARED_SLC. Otherwise, it shouldn't
be called.
@Input hDevHandle : RGX Device Node
@Return PVRSRV_ERROR :
******************************************************************************/
PVRSRV_ERROR RGXInitSLC(IMG_HANDLE hDevHandle);
#endif
#include "rgx_hwperf_km.h"
/******************************************************************************
* RGX HW Performance Profiling Control API(s)
*****************************************************************************/
/**************************************************************************/ /*!
@Function RGXHWPerfLazyConnect
@Description Obtain a connection object to the RGX device. The connection
is not actually opened until HWPerfOpen() is called.
@Output phDevData Address of a handle to a connection object
@Return PVRSRV_ERROR: for system error codes
*/ /***************************************************************************/
PVRSRV_ERROR RGXHWPerfLazyConnect(
IMG_HANDLE* phDevData);
/**************************************************************************/ /*!
@Function RGXHWPerfOpen
@Description Opens a connection to the RGX device. Valid handle to the
connection object has to be provided which means the this
function needs to be preceded by the call to
RGXHWPerfLazyConnect() function.
@Input phDevData handle to a connection object
@Return PVRSRV_ERROR: for system error codes
*/ /***************************************************************************/
PVRSRV_ERROR RGXHWPerfOpen(
IMG_HANDLE hDevData);
/**************************************************************************/ /*!
@Function RGXHWPerfConnect
@Description Obtain a connection object to the RGX device. Allocated
connection object references opened connection.
Calling this function is an equivalent of calling
RGXHWPerfLazyConnect and RGXHWPerfOpen.
This connect should be used when the caller will be retrieving
event data.
@Output phDevData Address of a handle to a connection object
@Return PVRSRV_ERROR: for system error codes
*/ /***************************************************************************/
PVRSRV_ERROR RGXHWPerfConnect(
IMG_HANDLE* phDevData);
/**************************************************************************/ /*!
@Function RGXHWPerfFreeConnection
@Description Frees the handle to RGX device
@Input hDevData Handle to connection object as returned from
RGXHWPerfLazyConnect()
@Return PVRSRV_ERROR: for system error codes
*/ /***************************************************************************/
PVRSRV_ERROR RGXHWPerfFreeConnection(
IMG_HANDLE hDevData);
/**************************************************************************/ /*!
@Function RGXHWPerfClose
@Description Disconnect from the RGX device
@Input hDevData Handle to connection object as returned from
RGXHWPerfConnect() or RGXHWPerfOpen()
@Return PVRSRV_ERROR: for system error codes
*/ /***************************************************************************/
PVRSRV_ERROR RGXHWPerfClose(
IMG_HANDLE hDevData);
/**************************************************************************/ /*!
@Function RGXHWPerfDisconnect
@Description Disconnect from the RGX device
@Input hDevData Handle to connection object as returned from
RGXHWPerfConnect() or RGXHWPerfOpen().
Calling this function is an equivalent of calling
RGXHWPerfClose and RGXHWPerfFreeConnection.
@Return PVRSRV_ERROR: for system error codes
*/ /***************************************************************************/
PVRSRV_ERROR RGXHWPerfDisconnect(
IMG_HANDLE hDevData);
/**************************************************************************/ /*!
@Function RGXHWPerfControl
@Description Enable or disable the generation of RGX HWPerf event packets.
See RGXCtrlHWPerf().
@Input hDevData Handle to connection object
@Input eStreamId ID of the HWPerf stream
@Input bToggle Switch to toggle or apply mask.
@Input ui64Mask Mask of events to control.
@Return PVRSRV_ERROR: for system error codes
*/ /***************************************************************************/
PVRSRV_ERROR IMG_CALLCONV RGXHWPerfControl(
IMG_HANDLE hDevData,
RGX_HWPERF_STREAM_ID eStreamId,
IMG_BOOL bToggle,
IMG_UINT64 ui64Mask);
/**************************************************************************/ /*!
@Function RGXHWPerfGetFilter
@Description Reads HWPerf stream filter where stream is identified by
the given stream ID.
@Input hDevData Handle to connection/device object
@Input eStreamId ID of the HWPerf stream
@Output IMG_UINT64 HWPerf filter value
@Return PVRSRV_ERROR: for system error codes
*/ /***************************************************************************/
PVRSRV_ERROR RGXHWPerfGetFilter(
IMG_HANDLE hDevData,
RGX_HWPERF_STREAM_ID eStreamId,
IMG_UINT64 *ui64Filter
);
/**************************************************************************/ /*!
@Function RGXHWPerfConfigureAndEnableCounters
@Description Enable and configure the performance counter block for
one or more device layout modules.
See RGXConfigureAndEnableHWPerfCounters().
@Input hDevData Handle to connection object
@Input ui32NumBlocks Number of elements in the array
@Input asBlockConfigs Address of the array of configuration blocks
@Return PVRSRV_ERROR: for system error codes
*/ /***************************************************************************/
PVRSRV_ERROR IMG_CALLCONV RGXHWPerfConfigureAndEnableCounters(
IMG_HANDLE hDevData,
IMG_UINT32 ui32NumBlocks,
RGX_HWPERF_CONFIG_CNTBLK* asBlockConfigs);
/**************************************************************************/ /*!
@Function RGXDisableHWPerfCounters
@Description Disable the performance counter block for one or more
device layout modules. See RGXDisableHWPerfCounters().
@Input hDevData Handle to connection/device object
@Input ui32NumBlocks Number of elements in the array
@Input aeBlockIDs An array of bytes with values taken from
the RGX_HWPERF_CNTBLK_ID enumeration.
@Return PVRSRV_ERROR: for system error codes
*/ /***************************************************************************/
PVRSRV_ERROR IMG_CALLCONV RGXHWPerfDisableCounters(
IMG_HANDLE hDevData,
IMG_UINT32 ui32NumBlocks,
IMG_UINT16* aeBlockIDs);
/**************************************************************************/ /*!
@Function RGXEnableHWPerfCounters
@Description Enable the performance counter block for one or more
device layout modules. See RGXEnableHWPerfCounters().
@Input hDevData Handle to connection/device object
@Input ui32NumBlocks Number of elements in the array
@Input aeBlockIDs An array of bytes with values taken from
the RGX_HWPERF_CNTBLK_ID enumeration.
@Return PVRSRV_ERROR: for system error codes
*/ /***************************************************************************/
PVRSRV_ERROR IMG_CALLCONV RGXHWPerfEnableCounters(
IMG_HANDLE hDevData,
IMG_UINT32 ui32NumBlocks,
IMG_UINT16* aeBlockIDs);
/******************************************************************************
* RGX HW Performance Profiling Retrieval API(s)
*
* The client must ensure their use of this acquire/release API for a single
* connection/stream must not be shared with multiple execution contexts e.g.
* between a kernel thread and an ISR handler. It is the client’s
* responsibility to ensure this API is not interrupted by a high priority
* thread/ISR
*****************************************************************************/
/**************************************************************************/ /*!
@Function RGXHWPerfAcquireEvents
@Description When there is data available to read this call returns with OK
and the address and length of the data buffer the
client can safely read. This buffer may contain one or more
event packets.
When there is no data to read, this call returns with OK
and sets *puiBufLen to 0 on exit.
Clients must pair this call with a ReleaseEvents call.
@Input hDevData Handle to connection/device object
@Input eStreamId ID of the HWPerf stream
@Output ppBuf Address of a pointer to a byte buffer. On exit
it contains the address of buffer to read from
@Output pui32BufLen Pointer to an integer. On exit it is the size
of the data to read from the buffer
@Return PVRSRV_ERROR: for system error codes
*/ /***************************************************************************/
PVRSRV_ERROR RGXHWPerfAcquireEvents(
IMG_HANDLE hDevData,
RGX_HWPERF_STREAM_ID eStreamId,
IMG_PBYTE* ppBuf,
IMG_UINT32* pui32BufLen);
/**************************************************************************/ /*!
@Function RGXHWPerfReleaseEvents
@Description Called after client has read the event data out of the buffer
retrieved from the Acquire Events call to release resources.
@Input hDevData Handle to connection/device object
@Input eStreamId ID of the HWPerf stream
@Return PVRSRV_ERROR: for system error codes
*/ /***************************************************************************/
IMG_INTERNAL
PVRSRV_ERROR RGXHWPerfReleaseEvents(
IMG_HANDLE hDevData,
RGX_HWPERF_STREAM_ID eStreamId);
/**************************************************************************/ /*!
@Function RGXHWPerfConvertCRTimeStamp
@Description Converts the timestamp given by FW events to the common OS
timestamp. The first three inputs are obtained via
a CLK_SYNC event, ui64CRTimeStamp is the CR timestamp
from the FW event to be converted.
@Input ui32ClkSpeed Clock speed given by sync event
@Input ui64CorrCRTimeStamp CR Timestamp given by sync event
@Input ui64CorrOSTimeStamp Correlating OS Timestamp given by sync
event
@Input ui64CRTimeStamp CR Timestamp to convert
@Return IMG_UINT64: Calculated OS Timestamp
*/ /**************************************************************************/
IMG_UINT64 RGXHWPerfConvertCRTimeStamp(
IMG_UINT32 ui32ClkSpeed,
IMG_UINT64 ui64CorrCRTimeStamp,
IMG_UINT64 ui64CorrOSTimeStamp,
IMG_UINT64 ui64CRTimeStamp);
#endif /* __RGXAPI_KM_H__ */
/******************************************************************************
End of file (rgxapi_km.h)
******************************************************************************/
|
