drivers/gpu/rogue/services/server/include/devicemem_history_server.h

   1 /*************************************************************************/ /*!
   2 @File                   devicemem_history_server.h
   3 @Title          Resource Information abstraction
   4 @Copyright      Copyright (c) Imagination Technologies Ltd. All Rights Reserved
   5 @Description    Devicemem History functions
   6 @License        Dual MIT/GPLv2
   7
   8 The contents of this file are subject to the MIT license as set out below.
   9
  10 Permission is hereby granted, free of charge, to any person obtaining a copy
  11 of this software and associated documentation files (the "Software"), to deal
  12 in the Software without restriction, including without limitation the rights
  13 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14 copies of the Software, and to permit persons to whom the Software is
  15 furnished to do so, subject to the following conditions:
  16
  17 The above copyright notice and this permission notice shall be included in
  18 all copies or substantial portions of the Software.
  19
  20 Alternatively, the contents of this file may be used under the terms of
  21 the GNU General Public License Version 2 ("GPL") in which case the provisions
  22 of GPL are applicable instead of those above.
  23
  24 If you wish to allow use of your version of this file only under the terms of
  25 GPL, and not to allow others to use your version of this file under the terms
  26 of the MIT license, indicate your decision by deleting the provisions above
  27 and replace them with the notice and other provisions required by GPL as set
  28 out in the file called "GPL-COPYING" included in this distribution. If you do
  29 not delete the provisions above, a recipient may use your version of this file
  30 under the terms of either the MIT license or GPL.
  31
  32 This License is also included in this distribution in the file called
  33 "MIT-COPYING".
  34
  35 EXCEPT AS OTHERWISE STATED IN A NEGOTIATED AGREEMENT: (A) THE SOFTWARE IS
  36 PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
  37 BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  38 PURPOSE AND NONINFRINGEMENT; AND (B) IN NO EVENT SHALL THE AUTHORS OR
  39 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  40 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  41 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  42 */ /**************************************************************************/
  43
  44 #ifndef _DEVICEMEM_HISTORY_SERVER_H_
  45 #define _DEVICEMEM_HISTORY_SERVER_H_
  46
  47 #include "img_defs.h"
  48 #include "mm_common.h"
  49 #include "pvrsrv_error.h"
  50 #include "rgxmem.h"
  51 #include "pvrsrv.h"
  52
  53 extern PVRSRV_ERROR
  54 DevicememHistoryInitKM(IMG_VOID);
  55
  56 extern IMG_VOID
  57 DevicememHistoryDeInitKM(IMG_VOID);
  58
  59 extern PVRSRV_ERROR
  60 DevicememHistoryMapKM(IMG_DEV_VIRTADDR sDevVAddr, IMG_SIZE_T uiSize, const char szText[DEVICEMEM_HISTORY_TEXT_BUFSZ]);
  61
  62 extern PVRSRV_ERROR
  63 DevicememHistoryUnmapKM(IMG_DEV_VIRTADDR sDevVAddr, IMG_SIZE_T uiSize, const char szText[DEVICEMEM_HISTORY_TEXT_BUFSZ]);
  64
  65 /* used when the PID does not matter */
  66 #define DEVICEMEM_HISTORY_PID_ANY 0xFFFFFFFE
  67
  68 typedef struct _DEVICEMEM_HISTORY_QUERY_IN_
  69 {
  70         IMG_PID uiPID;
  71         IMG_DEV_VIRTADDR sDevVAddr;
  72 } DEVICEMEM_HISTORY_QUERY_IN;
  73
  74 /* store up to 2 results for a lookup. in the case of the faulting page being
  75  * re-mapped between the page fault occurring on HW and the page fault analysis
  76  * being done, the second result entry will show the allocation being unmapped
  77  */
  78 #define DEVICEMEM_HISTORY_QUERY_OUT_MAX_RESULTS 2
  79
  80 typedef struct _DEVICEMEM_HISTORY_QUERY_OUT_RESULT_
  81 {
  82         IMG_CHAR szString[DEVICEMEM_HISTORY_TEXT_BUFSZ];
  83         IMG_DEV_VIRTADDR sBaseDevVAddr;
  84         IMG_SIZE_T uiSize;
  85         IMG_BOOL bAllocated;
  86         IMG_UINT64 ui64When;
  87         IMG_UINT64 ui64Age;
  88         RGXMEM_PROCESS_INFO sProcessInfo;
  89 } DEVICEMEM_HISTORY_QUERY_OUT_RESULT;
  90
  91 typedef struct _DEVICEMEM_HISTORY_QUERY_OUT_
  92 {
  93         IMG_UINT32 ui32NumResults;
  94         /* result 0 is the newest */
  95         DEVICEMEM_HISTORY_QUERY_OUT_RESULT sResults[DEVICEMEM_HISTORY_QUERY_OUT_MAX_RESULTS];
  96 } DEVICEMEM_HISTORY_QUERY_OUT;
  97
  98 extern IMG_BOOL
  99 DevicememHistoryQuery(DEVICEMEM_HISTORY_QUERY_IN *psQueryIn, DEVICEMEM_HISTORY_QUERY_OUT *psQueryOut);
 100
 101 extern void
 102 DevicememHistoryPrintAllWrapper(DUMPDEBUG_PRINTF_FUNC *pfnDumpDebugPrintf);
 103
 104 #endif