drivers/gpu/rogue_m/services/server/include/pvrsrv_cleanup.h

   1 /**************************************************************************/ /*!
   2 @File
   3 @Title          PowerVR SrvKM cleanup thread deferred work interface
   4 @Copyright      Copyright (c) Imagination Technologies Ltd. All Rights Reserved
   5 @License        Dual MIT/GPLv2
   6
   7 The contents of this file are subject to the MIT license as set out below.
   8
   9 Permission is hereby granted, free of charge, to any person obtaining a copy
  10 of this software and associated documentation files (the "Software"), to deal
  11 in the Software without restriction, including without limitation the rights
  12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13 copies of the Software, and to permit persons to whom the Software is
  14 furnished to do so, subject to the following conditions:
  15
  16 The above copyright notice and this permission notice shall be included in
  17 all copies or substantial portions of the Software.
  18
  19 Alternatively, the contents of this file may be used under the terms of
  20 the GNU General Public License Version 2 ("GPL") in which case the provisions
  21 of GPL are applicable instead of those above.
  22
  23 If you wish to allow use of your version of this file only under the terms of
  24 GPL, and not to allow others to use your version of this file under the terms
  25 of the MIT license, indicate your decision by deleting the provisions above
  26 and replace them with the notice and other provisions required by GPL as set
  27 out in the file called "GPL-COPYING" included in this distribution. If you do
  28 not delete the provisions above, a recipient may use your version of this file
  29 under the terms of either the MIT license or GPL.
  30
  31 This License is also included in this distribution in the file called
  32 "MIT-COPYING".
  33
  34 EXCEPT AS OTHERWISE STATED IN A NEGOTIATED AGREEMENT: (A) THE SOFTWARE IS
  35 PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
  36 BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  37 PURPOSE AND NONINFRINGEMENT; AND (B) IN NO EVENT SHALL THE AUTHORS OR
  38 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  39 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  40 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  41 */ /***************************************************************************/
  42
  43 #ifndef PVRSRV_CLEANUP_H
  44 #define PVRSRV_CLEANUP_H
  45
  46 typedef PVRSRV_ERROR (*CLEANUP_THREAD_FN)(void *pvParam);
  47
  48 /* typical number of times a caller should want the work to be retried in case
  49  * of the callback function (pfnFree) returning an error.
  50  * Callers to PVRSRVCleanupThreadAddWork should provide this value as the retry
  51  * count (ui32RetryCount) unless there are special requirements.
  52  * A value of 6000 corresponds to around 10 minutes.
  53  */
  54 #define CLEANUP_THREAD_RETRY_COUNT_DEFAULT 6000
  55
  56 typedef struct _PVRSRV_CLEANUP_THREAD_WORK_
  57 {
  58         DLLIST_NODE sNode; /*!< list node to attach to the cleanup thread work list */
  59         CLEANUP_THREAD_FN pfnFree; /*!< function to be called */
  60         void *pvData; /*!< private data for pfnFree */
  61         IMG_UINT32 ui32RetryCount; /*!< number of times the callback should be re-tried when it returns error */
  62 } PVRSRV_CLEANUP_THREAD_WORK;
  63
  64 /*!
  65 ******************************************************************************
  66  @Function                PVRSRVCleanupThreadAddWork
  67
  68  @Description             Add a work item to be called from the cleanup thread
  69
  70  @Input psData          : The function pointer and private data for the callback
  71
  72  @Return                  None
  73 ******************************************************************************/
  74 void PVRSRVCleanupThreadAddWork(PVRSRV_CLEANUP_THREAD_WORK *psData);
  75
  76 #endif /* PVRSRV_CLEANUP_H */