servicesext.h 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  1. /*************************************************************************/ /*!
  2. @File
  3. @Title Services definitions required by external drivers
  4. @Copyright Copyright (c) Imagination Technologies Ltd. All Rights Reserved
  5. @Description Provides services data structures, defines and prototypes
  6. required by external drivers
  7. @License Dual MIT/GPLv2
  8. The contents of this file are subject to the MIT license as set out below.
  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. The above copyright notice and this permission notice shall be included in
  16. all copies or substantial portions of the Software.
  17. Alternatively, the contents of this file may be used under the terms of
  18. the GNU General Public License Version 2 ("GPL") in which case the provisions
  19. of GPL are applicable instead of those above.
  20. If you wish to allow use of your version of this file only under the terms of
  21. GPL, and not to allow others to use your version of this file under the terms
  22. of the MIT license, indicate your decision by deleting the provisions above
  23. and replace them with the notice and other provisions required by GPL as set
  24. out in the file called "GPL-COPYING" included in this distribution. If you do
  25. not delete the provisions above, a recipient may use your version of this file
  26. under the terms of either the MIT license or GPL.
  27. This License is also included in this distribution in the file called
  28. "MIT-COPYING".
  29. EXCEPT AS OTHERWISE STATED IN A NEGOTIATED AGREEMENT: (A) THE SOFTWARE IS
  30. PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
  31. BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  32. PURPOSE AND NONINFRINGEMENT; AND (B) IN NO EVENT SHALL THE AUTHORS OR
  33. COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  34. IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  35. CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  36. */ /**************************************************************************/
  37. #if !defined(SERVICESEXT_H)
  38. #define SERVICESEXT_H
  39. /* include/ */
  40. #include "pvrsrv_error.h"
  41. #include "img_types.h"
  42. #include "img_3dtypes.h"
  43. #include "pvrsrv_device_types.h"
  44. /*
  45. * Lock buffer read/write flags
  46. */
  47. #define PVRSRV_LOCKFLG_READONLY (1) /*!< The locking process will only read the locked surface */
  48. /*!
  49. *****************************************************************************
  50. * Services State
  51. *****************************************************************************/
  52. typedef enum _PVRSRV_SERVICES_STATE_
  53. {
  54. PVRSRV_SERVICES_STATE_UNDEFINED = 0,
  55. PVRSRV_SERVICES_STATE_OK,
  56. PVRSRV_SERVICES_STATE_BAD,
  57. } PVRSRV_SERVICES_STATE;
  58. /*!
  59. *****************************************************************************
  60. * States for power management
  61. *****************************************************************************/
  62. /*!
  63. System Power State Enum
  64. */
  65. typedef enum _PVRSRV_SYS_POWER_STATE_
  66. {
  67. PVRSRV_SYS_POWER_STATE_Unspecified = -1, /*!< Unspecified : Uninitialised */
  68. PVRSRV_SYS_POWER_STATE_OFF = 0, /*!< Off */
  69. PVRSRV_SYS_POWER_STATE_ON = 1, /*!< On */
  70. PVRSRV_SYS_POWER_STATE_FORCE_I32 = 0x7fffffff /*!< Force enum to be at least 32-bits wide */
  71. } PVRSRV_SYS_POWER_STATE, *PPVRSRV_SYS_POWER_STATE; /*!< Typedef for ptr to PVRSRV_SYS_POWER_STATE */
  72. /*!
  73. Device Power State Enum
  74. */
  75. typedef enum _PVRSRV_DEV_POWER_STATE_
  76. {
  77. PVRSRV_DEV_POWER_STATE_DEFAULT = -1, /*!< Default state for the device */
  78. PVRSRV_DEV_POWER_STATE_OFF = 0, /*!< Unpowered */
  79. PVRSRV_DEV_POWER_STATE_ON = 1, /*!< Running */
  80. PVRSRV_DEV_POWER_STATE_FORCE_I32 = 0x7fffffff /*!< Force enum to be at least 32-bits wide */
  81. } PVRSRV_DEV_POWER_STATE, *PPVRSRV_DEV_POWER_STATE; /*!< Typedef for ptr to PVRSRV_DEV_POWER_STATE */ /* PRQA S 3205 */
  82. /*!
  83. Power Flags Enum
  84. */
  85. typedef enum _PVRSRV_POWER_FLAGS_
  86. {
  87. PVRSRV_POWER_FLAGS_NONE = 0, /*!< No flags */
  88. PVRSRV_POWER_FLAGS_FORCED = 1 << 0, /*!< Power the transition should not fail */
  89. PVRSRV_POWER_FLAGS_SUSPEND = 1 << 1, /*!< Power transition is due to OS suspend request */
  90. } PVRSRV_POWER_FLAGS;
  91. /* Clock speed handler prototypes */
  92. /*!
  93. Typedef for a pointer to a Function that will be called before a transition
  94. from one clock speed to another. See also PFN_POST_CLOCKSPEED_CHANGE.
  95. */
  96. typedef PVRSRV_ERROR (*PFN_PRE_CLOCKSPEED_CHANGE) (IMG_HANDLE hDevHandle,
  97. PVRSRV_DEV_POWER_STATE eCurrentPowerState);
  98. /*!
  99. Typedef for a pointer to a Function that will be called after a transition
  100. from one clock speed to another. See also PFN_PRE_CLOCKSPEED_CHANGE.
  101. */
  102. typedef PVRSRV_ERROR (*PFN_POST_CLOCKSPEED_CHANGE) (IMG_HANDLE hDevHandle,
  103. PVRSRV_DEV_POWER_STATE eCurrentPowerState);
  104. /*!
  105. Typedef for a pointer to a function that will be called to transition the
  106. device to a forced idle state. Used in unison with (forced) power requests,
  107. DVFS and cluster count changes.
  108. */
  109. typedef PVRSRV_ERROR (*PFN_FORCED_IDLE_REQUEST) (IMG_HANDLE hDevHandle,
  110. IMG_BOOL bDeviceOffPermitted);
  111. /*!
  112. Typedef for a pointer to a function that will be called to cancel a forced
  113. idle state and return the firmware back to a state where the hardware can be
  114. scheduled.
  115. */
  116. typedef PVRSRV_ERROR (*PFN_FORCED_IDLE_CANCEL_REQUEST) (IMG_HANDLE hDevHandle);
  117. typedef PVRSRV_ERROR (*PFN_GPU_UNITS_POWER_CHANGE) (IMG_HANDLE hDevHandle,
  118. IMG_UINT32 ui32SESPowerState);
  119. /*!
  120. *****************************************************************************
  121. * This structure is used for OS independent registry (profile) access
  122. *****************************************************************************/
  123. typedef struct PVRSRV_REGISTRY_INFO_TAG
  124. {
  125. IMG_UINT32 ui32DevCookie;
  126. IMG_PCHAR pszKey;
  127. IMG_PCHAR pszValue;
  128. IMG_PCHAR pszBuf;
  129. IMG_UINT32 ui32BufSize;
  130. } PVRSRV_REGISTRY_INFO, *PPVRSRV_REGISTRY_INFO;
  131. #endif /* SERVICESEXT_H */
  132. /******************************************************************************
  133. End of file (servicesext.h)
  134. ******************************************************************************/