src/vulkan/wsi/wsi_common.h

   1 /*
   2  * Copyright © 2015 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23 #ifndef WSI_COMMON_H
  24 #define WSI_COMMON_H
  25
  26 #include <stdint.h>
  27 #include <stdbool.h>
  28
  29 #include "vk_alloc.h"
  30 #include <vulkan/vulkan.h>
  31 #include <vulkan/vk_icd.h>
  32
  33 /* This is guaranteed to not collide with anything because it's in the
  34  * VK_KHR_swapchain namespace but not actually used by the extension.
  35  */
  36 #define VK_STRUCTURE_TYPE_WSI_IMAGE_CREATE_INFO_MESA (VkStructureType)1000001002
  37 #define VK_STRUCTURE_TYPE_WSI_MEMORY_ALLOCATE_INFO_MESA (VkStructureType)1000001003
  38 #define VK_STRUCTURE_TYPE_WSI_FORMAT_MODIFIER_PROPERTIES_LIST_MESA (VkStructureType)1000001004
  39 #define VK_STRUCTURE_TYPE_WSI_SURFACE_SUPPORTED_COUNTERS_MESA (VkStructureType)1000001005
  40
  41 struct wsi_image_create_info {
  42     VkStructureType sType;
  43     const void *pNext;
  44     bool scanout;
  45
  46     uint32_t modifier_count;
  47     const uint64_t *modifiers;
  48 };
  49
  50 struct wsi_memory_allocate_info {
  51     VkStructureType sType;
  52     const void *pNext;
  53     bool implicit_sync;
  54 };
  55
  56 struct wsi_format_modifier_properties {
  57    uint64_t modifier;
  58    uint32_t modifier_plane_count;
  59 };
  60
  61 /* Chain in for vkGetPhysicalDeviceFormatProperties2KHR */
  62 struct wsi_format_modifier_properties_list {
  63    VkStructureType sType;
  64    const void *pNext;
  65
  66    uint32_t modifier_count;
  67    struct wsi_format_modifier_properties *modifier_properties;
  68 };
  69
  70 /* To be chained into VkSurfaceCapabilities2KHR */
  71 struct wsi_surface_supported_counters {
  72    VkStructureType sType;
  73    const void *pNext;
  74
  75    VkSurfaceCounterFlagsEXT supported_surface_counters;
  76
  77 };
  78
  79 struct wsi_fence {
  80    VkDevice                     device;
  81    const struct wsi_device      *wsi_device;
  82    VkDisplayKHR                 display;
  83    const VkAllocationCallbacks  *alloc;
  84    VkResult                     (*wait)(struct wsi_fence *fence, uint64_t abs_timeout);
  85    void                         (*destroy)(struct wsi_fence *fence);
  86 };
  87
  88 struct wsi_interface;
  89
  90 #define VK_ICD_WSI_PLATFORM_MAX (VK_ICD_WSI_PLATFORM_DISPLAY + 1)
  91
  92 struct wsi_device {
  93    VkPhysicalDevice pdevice;
  94    VkPhysicalDeviceMemoryProperties memory_props;
  95    uint32_t queue_family_count;
  96
  97    bool supports_modifiers;
  98    uint64_t (*image_get_modifier)(VkImage image);
  99
 100 #define WSI_CB(cb) PFN_vk##cb cb
 101    WSI_CB(AllocateMemory);
 102    WSI_CB(AllocateCommandBuffers);
 103    WSI_CB(BindBufferMemory);
 104    WSI_CB(BindImageMemory);
 105    WSI_CB(BeginCommandBuffer);
 106    WSI_CB(CmdCopyImageToBuffer);
 107    WSI_CB(CreateBuffer);
 108    WSI_CB(CreateCommandPool);
 109    WSI_CB(CreateFence);
 110    WSI_CB(CreateImage);
 111    WSI_CB(DestroyBuffer);
 112    WSI_CB(DestroyCommandPool);
 113    WSI_CB(DestroyFence);
 114    WSI_CB(DestroyImage);
 115    WSI_CB(EndCommandBuffer);
 116    WSI_CB(FreeMemory);
 117    WSI_CB(FreeCommandBuffers);
 118    WSI_CB(GetBufferMemoryRequirements);
 119    WSI_CB(GetImageMemoryRequirements);
 120    WSI_CB(GetImageSubresourceLayout);
 121    WSI_CB(GetMemoryFdKHR);
 122    WSI_CB(GetPhysicalDeviceFormatProperties);
 123    WSI_CB(GetPhysicalDeviceFormatProperties2KHR);
 124    WSI_CB(ResetFences);
 125    WSI_CB(QueueSubmit);
 126    WSI_CB(WaitForFences);
 127 #undef WSI_CB
 128
 129     struct wsi_interface *                  wsi[VK_ICD_WSI_PLATFORM_MAX];
 130 };
 131
 132 typedef PFN_vkVoidFunction (VKAPI_PTR *WSI_FN_GetPhysicalDeviceProcAddr)(VkPhysicalDevice physicalDevice, const char* pName);
 133
 134 VkResult
 135 wsi_device_init(struct wsi_device *wsi,
 136                 VkPhysicalDevice pdevice,
 137                 WSI_FN_GetPhysicalDeviceProcAddr proc_addr,
 138                 const VkAllocationCallbacks *alloc,
 139                 int display_fd);
 140
 141 void
 142 wsi_device_finish(struct wsi_device *wsi,
 143                   const VkAllocationCallbacks *alloc);
 144
 145 #define ICD_DEFINE_NONDISP_HANDLE_CASTS(__VkIcdType, __VkType)             \
 146                                                                            \
 147    static inline __VkIcdType *                                             \
 148    __VkIcdType ## _from_handle(__VkType _handle)                           \
 149    {                                                                       \
 150       return (__VkIcdType *)(uintptr_t) _handle;                           \
 151    }                                                                       \
 152                                                                            \
 153    static inline __VkType                                                  \
 154    __VkIcdType ## _to_handle(__VkIcdType *_obj)                            \
 155    {                                                                       \
 156       return (__VkType)(uintptr_t) _obj;                                   \
 157    }
 158
 159 #define ICD_FROM_HANDLE(__VkIcdType, __name, __handle) \
 160    __VkIcdType *__name = __VkIcdType ## _from_handle(__handle)
 161
 162 ICD_DEFINE_NONDISP_HANDLE_CASTS(VkIcdSurfaceBase, VkSurfaceKHR)
 163
 164 VkResult
 165 wsi_common_get_surface_support(struct wsi_device *wsi_device,
 166                                int local_fd,
 167                                uint32_t queueFamilyIndex,
 168                                VkSurfaceKHR surface,
 169                                const VkAllocationCallbacks *alloc,
 170                                VkBool32* pSupported);
 171
 172 VkResult
 173 wsi_common_get_surface_capabilities(struct wsi_device *wsi_device,
 174                                     VkSurfaceKHR surface,
 175                                     VkSurfaceCapabilitiesKHR *pSurfaceCapabilities);
 176
 177 VkResult
 178 wsi_common_get_surface_capabilities2(struct wsi_device *wsi_device,
 179                                      const VkPhysicalDeviceSurfaceInfo2KHR *pSurfaceInfo,
 180                                      VkSurfaceCapabilities2KHR *pSurfaceCapabilities);
 181
 182 VkResult
 183 wsi_common_get_surface_formats(struct wsi_device *wsi_device,
 184                                VkSurfaceKHR surface,
 185                                uint32_t *pSurfaceFormatCount,
 186                                VkSurfaceFormatKHR *pSurfaceFormats);
 187
 188 VkResult
 189 wsi_common_get_surface_formats2(struct wsi_device *wsi_device,
 190                                 const VkPhysicalDeviceSurfaceInfo2KHR *pSurfaceInfo,
 191                                 uint32_t *pSurfaceFormatCount,
 192                                 VkSurfaceFormat2KHR *pSurfaceFormats);
 193
 194 VkResult
 195 wsi_common_get_surface_present_modes(struct wsi_device *wsi_device,
 196                                      VkSurfaceKHR surface,
 197                                      uint32_t *pPresentModeCount,
 198                                      VkPresentModeKHR *pPresentModes);
 199
 200 VkResult
 201 wsi_common_get_surface_capabilities2ext(
 202    struct wsi_device *wsi_device,
 203    VkSurfaceKHR surface,
 204    VkSurfaceCapabilities2EXT *pSurfaceCapabilities);
 205
 206 VkResult
 207 wsi_common_get_images(VkSwapchainKHR _swapchain,
 208                       uint32_t *pSwapchainImageCount,
 209                       VkImage *pSwapchainImages);
 210
 211 VkResult
 212 wsi_common_acquire_next_image(const struct wsi_device *wsi,
 213                               VkDevice device,
 214                               VkSwapchainKHR swapchain,
 215                               uint64_t timeout,
 216                               VkSemaphore semaphore,
 217                               uint32_t *pImageIndex);
 218
 219 VkResult
 220 wsi_common_create_swapchain(struct wsi_device *wsi,
 221                             VkDevice device,
 222                             int fd,
 223                             const VkSwapchainCreateInfoKHR *pCreateInfo,
 224                             const VkAllocationCallbacks *pAllocator,
 225                             VkSwapchainKHR *pSwapchain);
 226 void
 227 wsi_common_destroy_swapchain(VkDevice device,
 228                              VkSwapchainKHR swapchain,
 229                              const VkAllocationCallbacks *pAllocator);
 230
 231 VkResult
 232 wsi_common_queue_present(const struct wsi_device *wsi,
 233                          VkDevice device_h,
 234                          VkQueue queue_h,
 235                          int queue_family_index,
 236                          const VkPresentInfoKHR *pPresentInfo);
 237
 238 #endif