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
  40 struct wsi_image_create_info {
  41     VkStructureType sType;
  42     const void *pNext;
  43     bool scanout;
  44
  45     uint32_t modifier_count;
  46     const uint64_t *modifiers;
  47 };
  48
  49 struct wsi_memory_allocate_info {
  50     VkStructureType sType;
  51     const void *pNext;
  52     bool implicit_sync;
  53 };
  54
  55 struct wsi_format_modifier_properties {
  56    uint64_t modifier;
  57    uint32_t modifier_plane_count;
  58 };
  59
  60 /* Chain in for vkGetPhysicalDeviceFormatProperties2KHR */
  61 struct wsi_format_modifier_properties_list {
  62    VkStructureType sType;
  63    const void *pNext;
  64
  65    uint32_t modifier_count;
  66    struct wsi_format_modifier_properties *modifier_properties;
  67 };
  68
  69 struct wsi_interface;
  70
  71 #define VK_ICD_WSI_PLATFORM_MAX 5
  72
  73 struct wsi_device {
  74    VkPhysicalDevice pdevice;
  75    VkPhysicalDeviceMemoryProperties memory_props;
  76    uint32_t queue_family_count;
  77
  78    bool supports_modifiers;
  79    uint64_t (*image_get_modifier)(VkImage image);
  80
  81 #define WSI_CB(cb) PFN_vk##cb cb
  82    WSI_CB(AllocateMemory);
  83    WSI_CB(AllocateCommandBuffers);
  84    WSI_CB(BindBufferMemory);
  85    WSI_CB(BindImageMemory);
  86    WSI_CB(BeginCommandBuffer);
  87    WSI_CB(CmdCopyImageToBuffer);
  88    WSI_CB(CreateBuffer);
  89    WSI_CB(CreateCommandPool);
  90    WSI_CB(CreateFence);
  91    WSI_CB(CreateImage);
  92    WSI_CB(DestroyBuffer);
  93    WSI_CB(DestroyCommandPool);
  94    WSI_CB(DestroyFence);
  95    WSI_CB(DestroyImage);
  96    WSI_CB(EndCommandBuffer);
  97    WSI_CB(FreeMemory);
  98    WSI_CB(FreeCommandBuffers);
  99    WSI_CB(GetBufferMemoryRequirements);
 100    WSI_CB(GetImageMemoryRequirements);
 101    WSI_CB(GetImageSubresourceLayout);
 102    WSI_CB(GetMemoryFdKHR);
 103    WSI_CB(GetPhysicalDeviceFormatProperties);
 104    WSI_CB(GetPhysicalDeviceFormatProperties2KHR);
 105    WSI_CB(ResetFences);
 106    WSI_CB(QueueSubmit);
 107    WSI_CB(WaitForFences);
 108 #undef WSI_CB
 109
 110     struct wsi_interface *                  wsi[VK_ICD_WSI_PLATFORM_MAX];
 111 };
 112
 113 typedef PFN_vkVoidFunction (VKAPI_PTR *WSI_FN_GetPhysicalDeviceProcAddr)(VkPhysicalDevice physicalDevice, const char* pName);
 114
 115 VkResult
 116 wsi_device_init(struct wsi_device *wsi,
 117                 VkPhysicalDevice pdevice,
 118                 WSI_FN_GetPhysicalDeviceProcAddr proc_addr,
 119                 const VkAllocationCallbacks *alloc);
 120
 121 void
 122 wsi_device_finish(struct wsi_device *wsi,
 123                   const VkAllocationCallbacks *alloc);
 124
 125 #define ICD_DEFINE_NONDISP_HANDLE_CASTS(__VkIcdType, __VkType)             \
 126                                                                            \
 127    static inline __VkIcdType *                                             \
 128    __VkIcdType ## _from_handle(__VkType _handle)                           \
 129    {                                                                       \
 130       return (__VkIcdType *)(uintptr_t) _handle;                           \
 131    }                                                                       \
 132                                                                            \
 133    static inline __VkType                                                  \
 134    __VkIcdType ## _to_handle(__VkIcdType *_obj)                            \
 135    {                                                                       \
 136       return (__VkType)(uintptr_t) _obj;                                   \
 137    }
 138
 139 #define ICD_FROM_HANDLE(__VkIcdType, __name, __handle) \
 140    __VkIcdType *__name = __VkIcdType ## _from_handle(__handle)
 141
 142 ICD_DEFINE_NONDISP_HANDLE_CASTS(VkIcdSurfaceBase, VkSurfaceKHR)
 143
 144 VkResult
 145 wsi_common_get_surface_support(struct wsi_device *wsi_device,
 146                                int local_fd,
 147                                uint32_t queueFamilyIndex,
 148                                VkSurfaceKHR surface,
 149                                const VkAllocationCallbacks *alloc,
 150                                VkBool32* pSupported);
 151
 152 VkResult
 153 wsi_common_get_surface_capabilities(struct wsi_device *wsi_device,
 154                                     VkSurfaceKHR surface,
 155                                     VkSurfaceCapabilitiesKHR *pSurfaceCapabilities);
 156
 157 VkResult
 158 wsi_common_get_surface_capabilities2(struct wsi_device *wsi_device,
 159                                      const VkPhysicalDeviceSurfaceInfo2KHR *pSurfaceInfo,
 160                                      VkSurfaceCapabilities2KHR *pSurfaceCapabilities);
 161
 162 VkResult
 163 wsi_common_get_surface_formats(struct wsi_device *wsi_device,
 164                                VkSurfaceKHR surface,
 165                                uint32_t *pSurfaceFormatCount,
 166                                VkSurfaceFormatKHR *pSurfaceFormats);
 167
 168 VkResult
 169 wsi_common_get_surface_formats2(struct wsi_device *wsi_device,
 170                                 const VkPhysicalDeviceSurfaceInfo2KHR *pSurfaceInfo,
 171                                 uint32_t *pSurfaceFormatCount,
 172                                 VkSurfaceFormat2KHR *pSurfaceFormats);
 173
 174 VkResult
 175 wsi_common_get_surface_present_modes(struct wsi_device *wsi_device,
 176                                      VkSurfaceKHR surface,
 177                                      uint32_t *pPresentModeCount,
 178                                      VkPresentModeKHR *pPresentModes);
 179
 180 VkResult
 181 wsi_common_get_images(VkSwapchainKHR _swapchain,
 182                       uint32_t *pSwapchainImageCount,
 183                       VkImage *pSwapchainImages);
 184
 185 VkResult
 186 wsi_common_acquire_next_image(const struct wsi_device *wsi,
 187                               VkDevice device,
 188                               VkSwapchainKHR swapchain,
 189                               uint64_t timeout,
 190                               VkSemaphore semaphore,
 191                               uint32_t *pImageIndex);
 192
 193 VkResult
 194 wsi_common_create_swapchain(struct wsi_device *wsi,
 195                             VkDevice device,
 196                             int fd,
 197                             const VkSwapchainCreateInfoKHR *pCreateInfo,
 198                             const VkAllocationCallbacks *pAllocator,
 199                             VkSwapchainKHR *pSwapchain);
 200 void
 201 wsi_common_destroy_swapchain(VkDevice device,
 202                              VkSwapchainKHR swapchain,
 203                              const VkAllocationCallbacks *pAllocator);
 204
 205 VkResult
 206 wsi_common_queue_present(const struct wsi_device *wsi,
 207                          VkDevice device_h,
 208                          VkQueue queue_h,
 209                          int queue_family_index,
 210                          const VkPresentInfoKHR *pPresentInfo);
 211
 212 #endif