| /* -*- mode: c; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */ |
| /* vi: set ts=8 sw=8 sts=8: */ |
| /*************************************************************************/ /*! |
| @File pvr_buffer_sync.h |
| @Title PowerVR Linux buffer sync interface |
| @Codingstyle LinuxKernel |
| @Copyright Copyright (c) Imagination Technologies Ltd. All Rights Reserved |
| @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(__PVR_BUFFER_SYNC_H__) |
| #define __PVR_BUFFER_SYNC_H__ |
| |
| #include <linux/device.h> |
| #include <linux/err.h> |
| #include <linux/types.h> |
| |
| struct _RGXFWIF_DEV_VIRTADDR_; |
| struct _PMR_; |
| struct pvr_buffer_sync_context; |
| struct pvr_buffer_sync_append_data; |
| |
| /** |
| * pvr_buffer_sync_context_create - creates a buffer sync context |
| * @dev: linux device |
| * @name: context name (used for debugging) |
| * |
| * This function returns a buffer sync context, or NULL if it fails for any |
| * reason. |
| * |
| * @pvr_buffer_sync_context_destroy should be used to clean up the buffer sync |
| * context. |
| */ |
| struct pvr_buffer_sync_context * |
| pvr_buffer_sync_context_create(struct device *dev, const char *name); |
| |
| /** |
| * pvr_buffer_sync_context_destroy - frees a buffer sync context |
| * @ctx: buffer sync context |
| */ |
| void |
| pvr_buffer_sync_context_destroy(struct pvr_buffer_sync_context *ctx); |
| |
| /** |
| * pvr_buffer_sync_resolve_and_create_fences - create checkpoints from buffers |
| * @ctx: buffer sync context |
| * @nr_pmrs: number of buffer objects (PMRs) |
| * @pmrs: buffer array |
| * @pmr_flags: internal flags |
| * @nr_fence_checkpoints_out: returned number of fence sync checkpoints |
| * @fence_checkpoints_out: returned array of fence sync checkpoints |
| * @update_checkpoint_out: returned update sync checkpoint |
| * @data_out: returned buffer sync data |
| * |
| * This function returns 0 on success, or an error code otherwise. |
| * |
| * After this call, either @pvr_buffer_sync_kick_succeeded or |
| * @pvr_buffer_sync_kick_failed must be called. |
| */ |
| int |
| pvr_buffer_sync_resolve_and_create_fences(struct pvr_buffer_sync_context *ctx, |
| u32 nr_pmrs, |
| struct _PMR_ **pmrs, |
| u32 *pmr_flags, |
| u32 *nr_fence_checkpoints_out, |
| PSYNC_CHECKPOINT **fence_checkpoints_out, |
| PSYNC_CHECKPOINT *update_checkpoint_out, |
| struct pvr_buffer_sync_append_data **data_out); |
| |
| /** |
| * pvr_buffer_sync_kick_succeeded - cleans up after a successful kick operation |
| * @data: buffer sync data returned by @pvr_buffer_sync_resolve_and_create_fences |
| * |
| * Should only be called following @pvr_buffer_sync_resolve_and_create_fences. |
| */ |
| void |
| pvr_buffer_sync_kick_succeeded(struct pvr_buffer_sync_append_data *data); |
| |
| /** |
| * pvr_buffer_sync_kick_succeeded - cleans up after a failed kick operation |
| * @data: buffer sync data returned by @pvr_buffer_sync_resolve_and_create_fences |
| * |
| * Should only be called following @pvr_buffer_sync_resolve_and_create_fences. |
| */ |
| void |
| pvr_buffer_sync_kick_failed(struct pvr_buffer_sync_append_data *data); |
| |
| #endif /* !defined(__PVR_BUFFER_SYNC_H__) */ |