drivers/gpu/drm/img/img-rogue/services/server/include/sofunc_rgx.h

   1 /*************************************************************************/ /*!
   2 @File
   3 @Title          SO Interface header file for devices/RGX functions
   4 @Copyright      Copyright (c) Imagination Technologies Ltd. All Rights Reserved
   5 @Description    Contains SO interface functions. These functions are defined in
   6                 the common devices layer and are called from the env layer OS
   7                 specific implementation.
   8 @License        Dual MIT/GPLv2
   9
  10 The contents of this file are subject to the MIT license as set out below.
  11
  12 Permission is hereby granted, free of charge, to any person obtaining a copy
  13 of this software and associated documentation files (the "Software"), to deal
  14 in the Software without restriction, including without limitation the rights
  15 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  16 copies of the Software, and to permit persons to whom the Software is
  17 furnished to do so, subject to the following conditions:
  18
  19 The above copyright notice and this permission notice shall be included in
  20 all copies or substantial portions of the Software.
  21
  22 Alternatively, the contents of this file may be used under the terms of
  23 the GNU General Public License Version 2 ("GPL") in which case the provisions
  24 of GPL are applicable instead of those above.
  25
  26 If you wish to allow use of your version of this file only under the terms of
  27 GPL, and not to allow others to use your version of this file under the terms
  28 of the MIT license, indicate your decision by deleting the provisions above
  29 and replace them with the notice and other provisions required by GPL as set
  30 out in the file called "GPL-COPYING" included in this distribution. If you do
  31 not delete the provisions above, a recipient may use your version of this file
  32 under the terms of either the MIT license or GPL.
  33
  34 This License is also included in this distribution in the file called
  35 "MIT-COPYING".
  36
  37 EXCEPT AS OTHERWISE STATED IN A NEGOTIATED AGREEMENT: (A) THE SOFTWARE IS
  38 PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
  39 BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  40 PURPOSE AND NONINFRINGEMENT; AND (B) IN NO EVENT SHALL THE AUTHORS OR
  41 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  42 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  43 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  44 */ /**************************************************************************/
  45
  46 #if !defined(SOFUNC_RGX_H_)
  47 #define SOFUNC_RGX_H_
  48
  49 #include "img_types.h"
  50 #include "pvrsrv_error.h"
  51
  52
  53 #if !defined(NO_HARDWARE)
  54 /*!
  55 *******************************************************************************
  56
  57  @Function     SORgxGpuUtilStatsRegister
  58
  59  @Description  SO Interface function called from the OS layer implementation.
  60                Initialise data used to compute GPU utilisation statistics
  61                for a particular user (identified by the handle passed as
  62                argument). This function must be called only once for each
  63                different user/handle.
  64
  65  @Input        phGpuUtilUser - Pointer to handle used to identify a user of
  66                                RGXGetGpuUtilStats
  67
  68  @Return       PVRSRV_ERROR
  69
  70 ******************************************************************************/
  71 PVRSRV_ERROR SORgxGpuUtilStatsRegister(IMG_HANDLE *phGpuUtilUser);
  72
  73
  74 /*!
  75 *******************************************************************************
  76
  77  @Function     SORgxGpuUtilStatsUnregister
  78
  79  @Description  SO Interface function called from the OS layer implementation.
  80                Free data previously used to compute GPU utilisation statistics
  81                for a particular user (identified by the handle passed as
  82                argument).
  83
  84  @Input        hGpuUtilUser - Handle used to identify a user of
  85                               RGXGetGpuUtilStats
  86
  87  @Return       PVRSRV_ERROR
  88
  89 ******************************************************************************/
  90 PVRSRV_ERROR SORgxGpuUtilStatsUnregister(IMG_HANDLE hGpuUtilUser);
  91 #endif /* !defined(NO_HARDWARE) */
  92
  93
  94
  95 #endif /* SOFUNC_RGX_H_ */