| /*************************************************************************/ /*! |
| @File |
| @Title RGX time correlation and calibration header file |
| @Copyright Copyright (c) Imagination Technologies Ltd. All Rights Reserved |
| @Description Header for the RGX time correlation and calibration routines |
| @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. |
| */ /**************************************************************************/ |
| |
| #if !defined(__RGXTIMECORR_H__) |
| #define __RGXTIMECORR_H__ |
| |
| #include "img_types.h" |
| #include "device.h" |
| |
| typedef enum |
| { |
| RGXTIMECORR_CLOCK_MONO, |
| RGXTIMECORR_CLOCK_MONO_RAW, |
| RGXTIMECORR_CLOCK_SCHED, |
| |
| RGXTIMECORR_CLOCK_LAST |
| } RGXTIMECORR_CLOCK_TYPE; |
| |
| typedef enum |
| { |
| RGXTIMECORR_EVENT_POWER, |
| RGXTIMECORR_EVENT_DVFS, |
| RGXTIMECORR_EVENT_PERIODIC, |
| RGXTIMECORR_EVENT_CLOCK_CHANGE |
| } RGXTIMECORR_EVENT; |
| |
| /*! |
| ****************************************************************************** |
| |
| @Function RGXTimeCorrBegin |
| |
| @Description Generate new timer correlation data, and start tracking |
| the current GPU frequency. |
| |
| @Input hDevHandle : RGX Device Node |
| @Input eEvent : Event associated with the beginning of a timer |
| correlation period |
| |
| @Return void |
| |
| ******************************************************************************/ |
| void RGXTimeCorrBegin(IMG_HANDLE hDevHandle, RGXTIMECORR_EVENT eEvent); |
| |
| /*! |
| ****************************************************************************** |
| |
| @Function RGXTimeCorrEnd |
| |
| @Description Stop tracking the CPU and GPU timers, and if possible |
| recalculate the GPU frequency to a value which makes the timer |
| correlation data more accurate. |
| |
| @Input hDevHandle : RGX Device Node |
| @Input eEvent : Event associated with the end of a timer |
| correlation period |
| |
| @Return void |
| |
| ******************************************************************************/ |
| void RGXTimeCorrEnd(IMG_HANDLE hDevHandle, RGXTIMECORR_EVENT eEvent); |
| |
| /*! |
| ****************************************************************************** |
| |
| @Function RGXTimeCorrRestartPeriodic |
| |
| @Description Perform actions from RGXTimeCorrEnd and RGXTimeCorrBegin, |
| but only if enough time has passed since the last timer |
| correlation data was generated. |
| |
| @Input hDevHandle : RGX Device Node |
| |
| @Return void |
| |
| ******************************************************************************/ |
| void RGXTimeCorrRestartPeriodic(IMG_HANDLE hDevHandle); |
| |
| /*! |
| ****************************************************************************** |
| |
| @Function RGXTimeCorrGetClockns64 |
| |
| @Description Returns value of currently selected clock (in ns). |
| |
| @Return clock value from currently selected clock source |
| |
| ******************************************************************************/ |
| IMG_UINT64 RGXTimeCorrGetClockns64(void); |
| |
| /*! |
| ****************************************************************************** |
| |
| @Function RGXTimeCorrGetClockus64 |
| |
| @Description Returns value of currently selected clock (in us). |
| |
| @Return clock value from currently selected clock source |
| |
| ******************************************************************************/ |
| IMG_UINT64 RGXTimeCorrGetClockus64(void); |
| |
| /*! |
| ****************************************************************************** |
| |
| @Function RGXTimeCorrGetClockSource |
| |
| @Description Returns currently selected clock source |
| |
| @Return clock source type |
| |
| ******************************************************************************/ |
| RGXTIMECORR_CLOCK_TYPE RGXTimeCorrGetClockSource(void); |
| |
| /*! |
| ****************************************************************************** |
| |
| @Function RGXTimeCorrSetClockSource |
| |
| @Description Sets clock source for correlation data. |
| |
| @Input psDeviceNode : RGX Device Node |
| @Input eClockType : clock source type |
| |
| @Return error code |
| |
| ******************************************************************************/ |
| PVRSRV_ERROR RGXTimeCorrSetClockSource(PVRSRV_DEVICE_NODE *psDeviceNode, |
| RGXTIMECORR_CLOCK_TYPE eClockType); |
| |
| /*! |
| ****************************************************************************** |
| |
| @Function RGXTimeCorrInitAppHintCallbacks |
| |
| @Description Initialise apphint callbacks for timer correlation |
| related apphints. |
| |
| @Input psDeviceNode : RGX Device Node |
| |
| @Return void |
| |
| ******************************************************************************/ |
| void RGXTimeCorrInitAppHintCallbacks(const PVRSRV_DEVICE_NODE *psDeviceNode); |
| |
| /*! |
| ****************************************************************************** |
| |
| @Function RGXGetTimeCorrData |
| |
| @Description Get a number of the most recent time correlation data points |
| |
| @Input psDeviceNode : RGX Device Node |
| @Output psTimeCorrs : Output array of RGXFWIF_TIME_CORR elements |
| for data to be written to |
| @Input ui32NumOut : Number of elements to be written out |
| |
| @Return void |
| |
| ******************************************************************************/ |
| void RGXGetTimeCorrData(PVRSRV_DEVICE_NODE *psDeviceNode, |
| RGXFWIF_TIME_CORR *psTimeCorrs, |
| IMG_UINT32 ui32NumOut); |
| |
| #endif /* __RGXTIMECORR_H__ */ |