omap5/sgx_src/eurasia_km/services4/include/kernelbuffer.h

   1 /*************************************************************************/ /*!
   2 @Title          buffer device class API structures and prototypes
   3                 for kernel services to kernel 3rd party buffer device driver
   4 @Copyright      Copyright (c) Imagination Technologies Ltd. All Rights Reserved
   5 @Description    provides display device class API structures and prototypes
   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 #if !defined (__KERNELBUFFER_H__)
  45 #define __KERNELBUFFER_H__
  46
  47 #if defined (__cplusplus)
  48 extern "C" {
  49 #endif
  50
  51 /*
  52         Function table and pointers for SRVKM->BUFFER
  53 */
  54 typedef PVRSRV_ERROR (*PFN_OPEN_BC_DEVICE)(IMG_UINT32, IMG_HANDLE*);
  55 typedef PVRSRV_ERROR (*PFN_CLOSE_BC_DEVICE)(IMG_UINT32, IMG_HANDLE);
  56 typedef PVRSRV_ERROR (*PFN_GET_BC_INFO)(IMG_HANDLE, BUFFER_INFO*);
  57 typedef PVRSRV_ERROR (*PFN_GET_BC_BUFFER)(IMG_HANDLE, IMG_UINT32, PVRSRV_SYNC_DATA*, IMG_HANDLE*);
  58
  59 typedef struct PVRSRV_BC_SRV2BUFFER_KMJTABLE_TAG
  60 {
  61         IMG_UINT32                                                      ui32TableSize;
  62         PFN_OPEN_BC_DEVICE                                      pfnOpenBCDevice;
  63         PFN_CLOSE_BC_DEVICE                                     pfnCloseBCDevice;
  64         PFN_GET_BC_INFO                                         pfnGetBCInfo;
  65         PFN_GET_BC_BUFFER                                       pfnGetBCBuffer;
  66         PFN_GET_BUFFER_ADDR                                     pfnGetBufferAddr;
  67
  68 } PVRSRV_BC_SRV2BUFFER_KMJTABLE;
  69
  70
  71 /*
  72         Function table and pointers for BUFFER->SRVKM
  73 */
  74 typedef PVRSRV_ERROR (*PFN_BC_REGISTER_BUFFER_DEV)(PVRSRV_BC_SRV2BUFFER_KMJTABLE*, IMG_UINT32*);
  75 typedef IMG_VOID (*PFN_BC_SCHEDULE_DEVICES)(IMG_VOID);
  76 typedef PVRSRV_ERROR (*PFN_BC_REMOVE_BUFFER_DEV)(IMG_UINT32);
  77
  78 typedef struct PVRSRV_BC_BUFFER2SRV_KMJTABLE_TAG
  79 {
  80         IMG_UINT32                                                      ui32TableSize;
  81         PFN_BC_REGISTER_BUFFER_DEV                      pfnPVRSRVRegisterBCDevice;
  82         PFN_BC_SCHEDULE_DEVICES                         pfnPVRSRVScheduleDevices;
  83         PFN_BC_REMOVE_BUFFER_DEV                        pfnPVRSRVRemoveBCDevice;
  84
  85 } PVRSRV_BC_BUFFER2SRV_KMJTABLE, *PPVRSRV_BC_BUFFER2SRV_KMJTABLE;
  86
  87 /* function to retrieve kernel services function table from kernel services */
  88 typedef IMG_BOOL (*PFN_BC_GET_PVRJTABLE) (PPVRSRV_BC_BUFFER2SRV_KMJTABLE);
  89
  90 /* Prototype for platforms that access the JTable via linkage */
  91 IMG_IMPORT IMG_BOOL PVRGetBufferClassJTable(PVRSRV_BC_BUFFER2SRV_KMJTABLE *psJTable);
  92
  93 #if defined (__cplusplus)
  94 }
  95 #endif
  96
  97 #endif/* #if !defined (__KERNELBUFFER_H__) */