| /*************************************************************************/ /*! |
| @File |
| @Title Synchronisation checkpoint interface header |
| @Copyright Copyright (c) Imagination Technologies Ltd. All Rights Reserved |
| @Description Defines the client side interface for synchronisation |
| @License Dual MIT/GPLv2 |
| |
| 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. |
| |
| Alternatively, the contents of this file may be used under the terms of |
| the GNU General Public License Version 2 ("GPL") in which case the provisions |
| of GPL are applicable instead of those above. |
| |
| If you wish to allow use of your version of this file only under the terms of |
| GPL, and not to allow others to use your version of this file under the terms |
| of the MIT license, indicate your decision by deleting the provisions above |
| and replace them with the notice and other provisions required by GPL as set |
| out in the file called "GPL-COPYING" included in this distribution. If you do |
| not delete the provisions above, a recipient may use your version of this file |
| under the terms of either the MIT license or GPL. |
| |
| 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 _SYNC_CHECKPOINT_ |
| #define _SYNC_CHECKPOINT_ |
| |
| #include "img_types.h" |
| #include "pvrsrv_error.h" |
| #include "pvrsrv_sync_km.h" |
| #include "pdumpdefs.h" |
| #include "pdump.h" |
| #include "dllist.h" |
| #include "pvr_debug.h" |
| #include "device_connection.h" |
| #include "opaque_types.h" |
| |
| #ifndef _CHECKPOINT_TYPES_ |
| #define _CHECKPOINT_TYPES_ |
| typedef struct _SYNC_CHECKPOINT_CONTEXT *PSYNC_CHECKPOINT_CONTEXT; |
| |
| typedef struct _SYNC_CHECKPOINT *PSYNC_CHECKPOINT; |
| #endif |
| |
| /* definitions for functions to be implemented by OS-specific sync - the OS-specific sync code |
| will call SyncCheckpointRegisterFunctions() when initialised, in order to register functions |
| we can then call */ |
| #ifndef _CHECKPOINT_PFNS_ |
| #define _CHECKPOINT_PFNS_ |
| typedef PVRSRV_ERROR (*PFN_SYNC_CHECKPOINT_FENCE_RESOLVE_FN)(PSYNC_CHECKPOINT_CONTEXT psSyncCheckpointContext, |
| PVRSRV_FENCE fence, |
| IMG_UINT32 *nr_checkpoints, |
| PSYNC_CHECKPOINT **checkpoint_handles, |
| IMG_UINT32 *pui32FenceUID); |
| typedef PVRSRV_ERROR (*PFN_SYNC_CHECKPOINT_FENCE_CREATE_FN)(const IMG_CHAR *fence_name, |
| PVRSRV_TIMELINE timeline, |
| PSYNC_CHECKPOINT_CONTEXT psSyncCheckpointContext, |
| PVRSRV_FENCE *new_fence, |
| IMG_UINT32 *pui32FenceUID, |
| void **ppvFenceFinaliseData, |
| PSYNC_CHECKPOINT *new_checkpoint_handle, |
| IMG_HANDLE *timeline_update_sync, |
| IMG_UINT32 *timeline_update_value); |
| typedef PVRSRV_ERROR (*PFN_SYNC_CHECKPOINT_FENCE_ROLLBACK_DATA_FN)(PVRSRV_FENCE fence_to_rollback, void *finalise_data); |
| typedef PVRSRV_ERROR (*PFN_SYNC_CHECKPOINT_FENCE_FINALISE_FN)(PVRSRV_FENCE fence_to_finalise, void *finalise_data); |
| typedef void (*PFN_SYNC_CHECKPOINT_NOHW_UPDATE_TIMELINES_FN)(void *private_data); |
| typedef void (*PFN_SYNC_CHECKPOINT_FREE_CHECKPOINT_LIST_MEM_FN)(void *mem_ptr); |
| #endif |
| |
| PVRSRV_ERROR SyncCheckpointRegisterFunctions(PFN_SYNC_CHECKPOINT_FENCE_RESOLVE_FN pfnFenceResolve, |
| PFN_SYNC_CHECKPOINT_FENCE_CREATE_FN pfnFenceCreate, |
| PFN_SYNC_CHECKPOINT_FENCE_ROLLBACK_DATA_FN pfnFenceDataRollback, |
| PFN_SYNC_CHECKPOINT_FENCE_FINALISE_FN pfnFenceFinalise, |
| PFN_SYNC_CHECKPOINT_NOHW_UPDATE_TIMELINES_FN pfnNoHWUpdateTimelines, |
| PFN_SYNC_CHECKPOINT_FREE_CHECKPOINT_LIST_MEM_FN pfnFreeCheckpointListMem); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointContextCreate |
| |
| @Description Create a new synchronisation checkpoint context |
| |
| @Input psDevNode Device node |
| |
| @Output ppsSyncCheckpointContext Handle to the created synchronisation |
| checkpoint context |
| |
| @Return PVRSRV_OK if the synchronisation checkpoint context was |
| successfully created |
| */ |
| /*****************************************************************************/ |
| PVRSRV_ERROR |
| SyncCheckpointContextCreate(PPVRSRV_DEVICE_NODE psDevNode, |
| PSYNC_CHECKPOINT_CONTEXT *ppsSyncCheckpointContext); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointContextDestroy |
| |
| @Description Destroy a synchronisation checkpoint context |
| |
| @Input psSyncCheckpointContext Handle to the synchronisation |
| checkpoint context to destroy |
| |
| @Return PVRSRV_OK if the synchronisation checkpoint context was |
| successfully destroyed. |
| PVRSRV_ERROR_UNABLE_TO_DESTROY_CONTEXT if the context still |
| has sync checkpoints defined |
| */ |
| /*****************************************************************************/ |
| PVRSRV_ERROR |
| SyncCheckpointContextDestroy(PSYNC_CHECKPOINT_CONTEXT psSyncCheckpointContext); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointAlloc |
| |
| @Description Allocate a new synchronisation checkpoint on the specified |
| synchronisation checkpoint context |
| |
| @Input hSyncCheckpointContext Handle to the synchronisation |
| checkpoint context |
| |
| @Input hTimeline Timeline on which this sync |
| checkpoint is being created |
| |
| @Input pszClassName Sync checkpoint source annotation |
| (will be truncated to at most |
| PVRSRV_SYNC_NAME_LENGTH chars) |
| |
| @Output ppsSyncCheckpoint Created synchronisation checkpoint |
| |
| @Return PVRSRV_OK if the synchronisation checkpoint was |
| successfully created |
| */ |
| /*****************************************************************************/ |
| PVRSRV_ERROR |
| SyncCheckpointAlloc(PSYNC_CHECKPOINT_CONTEXT psSyncContext, |
| PVRSRV_TIMELINE hTimeline, |
| const IMG_CHAR *pszCheckpointName, |
| PSYNC_CHECKPOINT *ppsSyncCheckpoint); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointFree |
| |
| @Description Free a synchronization checkpoint |
| The reference count held for the synchronization checkpoint |
| is decremented - if it has becomes zero, it is also freed. |
| |
| @Input psSyncCheckpoint The synchronisation checkpoint to free |
| |
| @Return None |
| */ |
| /*****************************************************************************/ |
| void |
| SyncCheckpointFree(PSYNC_CHECKPOINT psSyncCheckpoint); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointSignal |
| |
| @Description Signal the synchronisation checkpoint |
| |
| @Input psSyncCheckpoint The synchronisation checkpoint to signal |
| |
| @Return None |
| */ |
| /*****************************************************************************/ |
| void |
| SyncCheckpointSignal(PSYNC_CHECKPOINT psSyncCheckpoint); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointSignalNoHW |
| |
| @Description Signal the synchronisation checkpoint in NO_HARWARE build |
| |
| @Input psSyncCheckpoint The synchronisation checkpoint to signal |
| |
| @Return None |
| */ |
| /*****************************************************************************/ |
| void |
| SyncCheckpointSignalNoHW(PSYNC_CHECKPOINT psSyncCheckpoint); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointError |
| |
| @Description Error the synchronisation checkpoint |
| |
| @Input psSyncCheckpoint The synchronisation checkpoint to error |
| |
| @Return None |
| */ |
| /*****************************************************************************/ |
| void |
| SyncCheckpointError(PSYNC_CHECKPOINT psSyncCheckpoint); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointErrorFromUFO |
| |
| @Description Error the synchronisation checkpoint which has the |
| given UFO firmware address |
| |
| @Input psDevNode The device owning the sync |
| checkpoint to be errored |
| |
| @Input ui32FwAddr The firmware address of the sync |
| checkpoint to be errored |
| |
| @Return None |
| */ |
| /*****************************************************************************/ |
| void |
| SyncCheckpointErrorFromUFO(PPVRSRV_DEVICE_NODE psDevNode, IMG_UINT32 ui32FwAddr); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointRollbackFromUFO |
| |
| @Description Drop the enqueued count reference taken on the synchronisation |
| checkpoint on behalf of the firmware. |
| Called in the event of a DM Kick failing. |
| |
| @Input psDevNode The device owning the sync |
| checkpoint to be rolled back |
| |
| @Input ui32FwAddr The firmware address of the sync |
| checkpoint to be rolled back |
| |
| @Return None |
| */ |
| /*****************************************************************************/ |
| void |
| SyncCheckpointRollbackFromUFO(PPVRSRV_DEVICE_NODE psDevNode, IMG_UINT32 ui32FwAddr); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointIsSignalled |
| |
| @Description Returns IMG_TRUE if the synchronisation checkpoint is |
| signalled or errored |
| |
| @Input psSyncCheckpoint The synchronisation checkpoint to test |
| |
| @Return None |
| */ |
| /*****************************************************************************/ |
| IMG_BOOL |
| SyncCheckpointIsSignalled(PSYNC_CHECKPOINT psSyncCheckpoint); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointIsErrored |
| |
| @Description Returns IMG_TRUE if the synchronisation checkpoint is |
| errored |
| |
| @Input psSyncCheckpoint The synchronisation checkpoint to test |
| |
| @Return None |
| */ |
| /*****************************************************************************/ |
| IMG_BOOL |
| SyncCheckpointIsErrored(PSYNC_CHECKPOINT psSyncCheckpoint); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointTakeRef |
| |
| @Description Take a reference on a synchronisation checkpoint |
| |
| @Input psSyncCheckpoint Synchronisation checkpoint to take a |
| reference on |
| |
| @Return PVRSRV_OK if a reference was taken on the synchronisation |
| primitive |
| */ |
| /*****************************************************************************/ |
| PVRSRV_ERROR |
| SyncCheckpointTakeRef(PSYNC_CHECKPOINT psSyncCheckpoint); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointDropRef |
| |
| @Description Drop a reference on a synchronisation checkpoint |
| |
| @Input psSyncCheckpoint Synchronisation checkpoint to drop a |
| reference on |
| |
| @Return PVRSRV_OK if a reference was dropped on the synchronisation |
| primitive |
| */ |
| /*****************************************************************************/ |
| PVRSRV_ERROR |
| SyncCheckpointDropRef(PSYNC_CHECKPOINT psSyncCheckpoint); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointResolveFence |
| |
| @Description Resolve a fence, returning a list of the sync checkpoints |
| that fence contains. |
| This function in turn calls a function provided by the |
| OS native sync implementation. |
| |
| @Input psSyncCheckpointContext The sync checkpoint context |
| on which checkpoints should be |
| created (in the event of the fence |
| having a native sync pt with no |
| associated sync checkpoint) |
| |
| @Input hFence The fence to be resolved |
| |
| @Output pui32NumSyncCheckpoints The number of sync checkpoints the |
| fence contains. Can return 0 if |
| passed a null (-1) fence. |
| |
| @Output papsSyncCheckpoints List of sync checkpoints the fence |
| contains |
| |
| @Output puiFenceUID Unique ID of the resolved fence |
| |
| @Return PVRSRV_OK if a valid fence was provided. |
| PVRSRV_ERROR_SYNC_NATIVESYNC_NOT_REGISTERED if the OS native |
| sync has not registered a callback function. |
| */ |
| /*****************************************************************************/ |
| PVRSRV_ERROR |
| SyncCheckpointResolveFence(PSYNC_CHECKPOINT_CONTEXT psSyncCheckpointContext, PVRSRV_FENCE hFence, IMG_UINT32 *pui32NumSyncCheckpoints, PSYNC_CHECKPOINT **papsSyncCheckpoints, IMG_UINT32 *puiFenceUID); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointCreateFence |
| |
| @Description Create a fence containing a single sync checkpoint. |
| Return the fence and a ptr to sync checkpoint it contains. |
| This function in turn calls a function provided by the |
| OS native sync implementation. |
| |
| @Input pszFenceName String to assign to the new fence |
| (for debugging purposes) |
| |
| @Input hTimeline Timeline on which the new fence is |
| to be created |
| |
| @Input psSyncCheckpointContext Sync checkpoint context to be used |
| when creating the new fence |
| |
| @Output phNewFence The newly created fence |
| |
| @Output pui32FenceUID Unique ID of the created fence |
| |
| @Output ppvFenceFinaliseData Any data needed to finalise the fence |
| in a later call to the function |
| SyncCheckpointFinaliseFence() |
| |
| @Output psNewSyncCheckpoint The sync checkpoint contained in |
| the new fence |
| |
| @Return PVRSRV_OK if a valid fence was provided. |
| PVRSRV_ERROR_SYNC_NATIVESYNC_NOT_REGISTERED if the OS native |
| sync has not registered a callback function. |
| */ |
| /*****************************************************************************/ |
| PVRSRV_ERROR |
| SyncCheckpointCreateFence(PPVRSRV_DEVICE_NODE psDeviceNode, |
| const IMG_CHAR *pszFenceName, |
| PVRSRV_TIMELINE hTimeline, |
| PSYNC_CHECKPOINT_CONTEXT psSyncCheckpointContext, |
| PVRSRV_FENCE *phNewFence, |
| IMG_UINT32 *pui32FenceUID, |
| void **ppvFenceFinaliseData, |
| PSYNC_CHECKPOINT *psNewSyncCheckpoint, |
| void **ppvTimelineUpdateSyncPrim, |
| IMG_UINT32 *pui32TimelineUpdateValue); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointRollbackFenceData |
| |
| @Description 'Rolls back' the fence specified (destroys the fence and |
| takes any other required actions to undo the fence |
| creation (eg if the implementation wishes to revert the |
| incrementing of the fence's timeline, etc). |
| This function in turn calls a function provided by the |
| OS native sync implementation. |
| |
| @Input hFence Fence to be 'rolled back' |
| |
| @Input pvFinaliseData Data needed to finalise the |
| fence |
| |
| @Return PVRSRV_OK if a valid fence was provided. |
| PVRSRV_ERROR_SYNC_NATIVESYNC_NOT_REGISTERED if the OS native |
| sync has not registered a callback function. |
| */ |
| /*****************************************************************************/ |
| PVRSRV_ERROR |
| SyncCheckpointRollbackFenceData(PVRSRV_FENCE hFence, void *pvFinaliseData); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointFinaliseFence |
| |
| @Description 'Finalise' the fence specified (performs any actions the |
| underlying implementation may need to perform just prior |
| to the fence being returned to the client. |
| This function in turn calls a function provided by the |
| OS native sync implementation - if the native sync |
| implementation does not need to perform any actions at |
| this time, this function does not need to be registered. |
| |
| @Input hFence Fence to be 'finalised' |
| |
| @Input pvFinaliseData Data needed to finalise the fence |
| |
| @Return PVRSRV_OK if a valid fence and finalise data were provided. |
| PVRSRV_ERROR_INVALID_PARAMS if an invalid fence or finalise |
| data were provided. |
| PVRSRV_ERROR_SYNC_NATIVESYNC_NOT_REGISTERED if the OS native |
| sync has not registered a callback function (permitted). |
| */ |
| /*****************************************************************************/ |
| PVRSRV_ERROR |
| SyncCheckpointFinaliseFence(PVRSRV_FENCE hFence, void *pvFinaliseData); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointFreeCheckpointListMem |
| |
| @Description Free memory the memory which was allocated by the sync |
| implementation and used to return the list of sync |
| checkpoints when resolving a fence. |
| to the fence being returned to the client. |
| This function in turn calls a free function registered by |
| the sync implementation (if a function has been registered). |
| |
| @Input pvCheckpointListMem Pointer to the memory to be freed |
| |
| @Return None |
| */ |
| /*****************************************************************************/ |
| void |
| SyncCheckpointFreeCheckpointListMem(void *pvCheckpointListMem); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointNoHWUpdateTimelines |
| |
| @Description Called by the DDK in a NO_HARDWARE build only. |
| After syncs have been manually signalled by the DDK, this |
| function is called to allow the OS native sync implementation |
| to update its timelines (as the usual callback notification |
| of signalled checkpoints is not supported for NO_HARDWARE). |
| This function in turn calls a function provided by the |
| OS native sync implementation. |
| |
| @Input pvPrivateData Any data the OS native sync |
| implementation might require. |
| |
| @Return PVRSRV_ERROR_SYNC_NATIVESYNC_NOT_REGISTERED if the OS native |
| sync has not registered a callback function, otherwise |
| PVRSRV_OK. |
| */ |
| /*****************************************************************************/ |
| PVRSRV_ERROR |
| SyncCheckpointNoHWUpdateTimelines(void *pvPrivateData); |
| |
| /*************************************************************************/ /*! |
| @Function SyncCheckpointPDumpPol |
| |
| @Description Called to insert a poll into the PDump script on a given |
| sync checkpoint being signalled or errored. |
| |
| @Input psSyncCheckpoint Synchronisation checkpoint for |
| PDump to poll on |
| |
| @Input ui32PDumpFlags PDump flags |
| |
| @Return PVRSRV_OK if a valid sync checkpoint was provided. |
| */ |
| /*****************************************************************************/ |
| PVRSRV_ERROR |
| SyncCheckpointPDumpPol(PSYNC_CHECKPOINT psSyncCheckpoint, PDUMP_FLAGS_T ui32PDumpFlags); |
| |
| #endif /* _SYNC_CHECKPOINT_ */ |
| |
