| /*************************************************************************/ /*! |
| @File |
| @Title RGX API Header kernel mode |
| @Copyright Copyright (c) Imagination Technologies Ltd. All Rights Reserved |
| @Description Exported RGX API details |
| @License MIT |
| |
| 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. |
| |
| 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) |
| /*! |
| ****************************************************************************** |
| |
| @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.h" |
| |
| |
| /****************************************************************************** |
| * RGX HW Performance Profiling Control API(s) |
| *****************************************************************************/ |
| |
| typedef struct _RGX_HWPERF_DEVICE_ |
| { |
| IMG_CHAR pszName[20]; /* Helps identify this device uniquely */ |
| IMG_HANDLE hDevData; /* Handle for the server */ |
| |
| struct _RGX_HWPERF_DEVICE_ *psNext; |
| } RGX_HWPERF_DEVICE; |
| |
| typedef struct |
| { |
| RGX_HWPERF_DEVICE *psHWPerfDevList; |
| } RGX_HWPERF_CONNECTION; |
| |
| /**************************************************************************/ /*! |
| @Function RGXHWPerfLazyConnect |
| @Description Obtain a HWPerf connection object to the RGX device(s). The |
| connections to devices are not actually opened until HWPerfOpen() |
| is called. |
| @Output ppsHWPerfConnection Address of a HWPerf connection object |
| @Return PVRSRV_ERROR: for system error codes |
| */ /***************************************************************************/ |
| PVRSRV_ERROR RGXHWPerfLazyConnect(RGX_HWPERF_CONNECTION** ppsHWPerfConnection); |
| |
| |
| /**************************************************************************/ /*! |
| @Function RGXHWPerfOpen |
| @Description Opens connection(s) to the RGX device(s). 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 psHWPerfConnection HWPerf connection object |
| @Return PVRSRV_ERROR: for system error codes |
| */ /***************************************************************************/ |
| PVRSRV_ERROR RGXHWPerfOpen(RGX_HWPERF_CONNECTION* psHWPerfConnection); |
| |
| |
| /**************************************************************************/ /*! |
| @Function RGXHWPerfConnect |
| @Description Obtain a connection object to the RGX HWPerf module. Allocated |
| connection object(s) reference opened connection(s). |
| 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 ppsHWPerfConnection Address of HWPerf connection object |
| @Return PVRSRV_ERROR: for system error codes |
| */ /***************************************************************************/ |
| PVRSRV_ERROR RGXHWPerfConnect(RGX_HWPERF_CONNECTION** ppsHWPerfConnection); |
| |
| |
| /**************************************************************************/ /*! |
| @Function RGXHWPerfFreeConnection |
| @Description Frees the HWPerf connection object |
| @Input ppsHWPerfConnection Pointer to connection object as returned |
| from RGXHWPerfLazyConnect() |
| @Return PVRSRV_ERROR: for system error codes |
| */ /***************************************************************************/ |
| PVRSRV_ERROR RGXHWPerfFreeConnection(RGX_HWPERF_CONNECTION** psHWPerfConnection); |
| |
| |
| /**************************************************************************/ /*! |
| @Function RGXHWPerfClose |
| @Description Closes all the opened connection(s) to RGX device(s) |
| @Input psHWPerfConnection Pointer to HWPerf connection object as |
| returned from RGXHWPerfConnect() or RGXHWPerfOpen() |
| @Return PVRSRV_ERROR: for system error codes |
| */ /***************************************************************************/ |
| PVRSRV_ERROR RGXHWPerfClose(RGX_HWPERF_CONNECTION *psHWPerfConnection); |
| |
| |
| /**************************************************************************/ /*! |
| @Function RGXHWPerfDisconnect |
| @Description Disconnect from the RGX device |
| @Input ppsHWPerfConnection Pointer to HWPerf 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(RGX_HWPERF_CONNECTION** ppsHWPerfConnection); |
| |
| |
| /**************************************************************************/ /*! |
| @Function RGXHWPerfControl |
| @Description Enable or disable the generation of RGX HWPerf event packets. |
| See RGXCtrlHWPerf(). |
| @Input psHWPerfConnection Pointer to HWPerf 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( |
| RGX_HWPERF_CONNECTION *psHWPerfConnection, |
| 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 psHWPerfConnection Pointer to HWPerf 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( |
| RGX_HWPERF_CONNECTION *psHWPerfConnection, |
| IMG_UINT32 ui32NumBlocks, |
| RGX_HWPERF_CONFIG_CNTBLK* asBlockConfigs); |
| |
| /**************************************************************************/ /*! |
| @Function RGXHWPerfConfigureAndEnableCustomCounters |
| @Description Enable and configure custom performance counters |
| @Input psHWPerfConnection Pointer to connection object |
| @Input ui16CustomBlockID ID of the custom block to configure |
| @Input ui16NumCustomCounters Number of custom counters |
| @Input pui32CustomCounterIDs pointer to array containing |
| custom counter IDs |
| @Return PVRSRV_ERROR for system error codes |
| */ /***************************************************************************/ |
| PVRSRV_ERROR IMG_CALLCONV RGXHWPerfConfigureAndEnableCustomCounters( |
| RGX_HWPERF_CONNECTION *psHWPerfConnection, |
| IMG_UINT16 ui16CustomBlockID, |
| IMG_UINT16 ui16NumCustomCounters, |
| IMG_UINT32 *pui32CustomCounterIDs); |
| |
| /**************************************************************************/ /*! |
| @Function RGXDisableHWPerfCounters |
| @Description Disable the performance counter block for one or more |
| device layout modules. See RGXDisableHWPerfCounters(). |
| @Input psHWPerfConnection Pointer to HWPerf connection 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( |
| RGX_HWPERF_CONNECTION *psHWPerfConnection, |
| 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) |
| ******************************************************************************/ |
