2 * Copyright © 2017, Google Inc.
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:
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
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
24 #include <hardware/gralloc.h>
25 #include <hardware/hardware.h>
26 #include <hardware/hwvulkan.h>
27 #include <vulkan/vk_android_native_buffer.h>
28 #include <vulkan/vk_icd.h>
29 #include <sync/sync.h>
31 #include "anv_private.h"
32 #include "vk_format_info.h"
35 static int anv_hal_open(const struct hw_module_t
* mod
, const char* id
, struct hw_device_t
** dev
);
36 static int anv_hal_close(struct hw_device_t
*dev
);
41 STATIC_ASSERT(HWVULKAN_DISPATCH_MAGIC
== ICD_LOADER_MAGIC
);
44 PUBLIC
struct hwvulkan_module_t HAL_MODULE_INFO_SYM
= {
46 .tag
= HARDWARE_MODULE_TAG
,
47 .module_api_version
= HWVULKAN_MODULE_API_VERSION_0_1
,
48 .hal_api_version
= HARDWARE_MAKE_API_VERSION(1, 0),
49 .id
= HWVULKAN_HARDWARE_MODULE_ID
,
50 .name
= "Intel Vulkan HAL",
52 .methods
= &(hw_module_methods_t
) {
58 /* If any bits in test_mask are set, then unset them and return true. */
60 unmask32(uint32_t *inout_mask
, uint32_t test_mask
)
62 uint32_t orig_mask
= *inout_mask
;
63 *inout_mask
&= ~test_mask
;
64 return *inout_mask
!= orig_mask
;
68 anv_hal_open(const struct hw_module_t
* mod
, const char* id
,
69 struct hw_device_t
** dev
)
71 assert(mod
== &HAL_MODULE_INFO_SYM
.common
);
72 assert(strcmp(id
, HWVULKAN_DEVICE_0
) == 0);
74 hwvulkan_device_t
*hal_dev
= malloc(sizeof(*hal_dev
));
78 *hal_dev
= (hwvulkan_device_t
) {
80 .tag
= HARDWARE_DEVICE_TAG
,
81 .version
= HWVULKAN_DEVICE_API_VERSION_0_1
,
82 .module
= &HAL_MODULE_INFO_SYM
.common
,
83 .close
= anv_hal_close
,
85 .EnumerateInstanceExtensionProperties
= anv_EnumerateInstanceExtensionProperties
,
86 .CreateInstance
= anv_CreateInstance
,
87 .GetInstanceProcAddr
= anv_GetInstanceProcAddr
,
90 *dev
= &hal_dev
->common
;
95 anv_hal_close(struct hw_device_t
*dev
)
97 /* hwvulkan.h claims that hw_device_t::close() is never called. */
102 get_ahw_buffer_format_properties(
104 const struct AHardwareBuffer
*buffer
,
105 VkAndroidHardwareBufferFormatPropertiesANDROID
*pProperties
)
107 ANV_FROM_HANDLE(anv_device
, device
, device_h
);
109 /* Get a description of buffer contents . */
110 AHardwareBuffer_Desc desc
;
111 AHardwareBuffer_describe(buffer
, &desc
);
113 /* Verify description. */
115 AHARDWAREBUFFER_USAGE_GPU_SAMPLED_IMAGE
|
116 AHARDWAREBUFFER_USAGE_GPU_COLOR_OUTPUT
|
117 AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER
;
119 /* "Buffer must be a valid Android hardware buffer object with at least
120 * one of the AHARDWAREBUFFER_USAGE_GPU_* usage flags."
122 if (!(desc
.usage
& (gpu_usage
)))
123 return VK_ERROR_INVALID_EXTERNAL_HANDLE_KHR
;
125 /* Fill properties fields based on description. */
126 VkAndroidHardwareBufferFormatPropertiesANDROID
*p
= pProperties
;
128 p
->format
= vk_format_from_android(desc
.format
);
130 const struct anv_format
*anv_format
= anv_get_format(p
->format
);
131 p
->externalFormat
= (uint64_t) (uintptr_t) anv_format
;
133 /* Default to OPTIMAL tiling but set to linear in case
134 * of AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER usage.
136 VkImageTiling tiling
= VK_IMAGE_TILING_OPTIMAL
;
138 if (desc
.usage
& AHARDWAREBUFFER_USAGE_GPU_DATA_BUFFER
)
139 tiling
= VK_IMAGE_TILING_LINEAR
;
142 anv_get_image_format_features(&device
->info
, p
->format
, anv_format
,
145 /* "Images can be created with an external format even if the Android hardware
146 * buffer has a format which has an equivalent Vulkan format to enable
147 * consistent handling of images from sources that might use either category
148 * of format. However, all images created with an external format are subject
149 * to the valid usage requirements associated with external formats, even if
150 * the Android hardware buffer’s format has a Vulkan equivalent."
152 * "The formatFeatures member *must* include
153 * VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT and at least one of
154 * VK_FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT or
155 * VK_FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT"
158 VK_FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT
;
160 /* "Implementations may not always be able to determine the color model,
161 * numerical range, or chroma offsets of the image contents, so the values
162 * in VkAndroidHardwareBufferFormatPropertiesANDROID are only suggestions.
163 * Applications should treat these values as sensible defaults to use in
164 * the absence of more reliable information obtained through some other
167 p
->samplerYcbcrConversionComponents
.r
= VK_COMPONENT_SWIZZLE_IDENTITY
;
168 p
->samplerYcbcrConversionComponents
.g
= VK_COMPONENT_SWIZZLE_IDENTITY
;
169 p
->samplerYcbcrConversionComponents
.b
= VK_COMPONENT_SWIZZLE_IDENTITY
;
170 p
->samplerYcbcrConversionComponents
.a
= VK_COMPONENT_SWIZZLE_IDENTITY
;
172 p
->suggestedYcbcrModel
= VK_SAMPLER_YCBCR_MODEL_CONVERSION_YCBCR_601
;
173 p
->suggestedYcbcrRange
= VK_SAMPLER_YCBCR_RANGE_ITU_FULL
;
175 p
->suggestedXChromaOffset
= VK_CHROMA_LOCATION_MIDPOINT
;
176 p
->suggestedYChromaOffset
= VK_CHROMA_LOCATION_MIDPOINT
;
182 anv_GetAndroidHardwareBufferPropertiesANDROID(
184 const struct AHardwareBuffer
*buffer
,
185 VkAndroidHardwareBufferPropertiesANDROID
*pProperties
)
187 ANV_FROM_HANDLE(anv_device
, dev
, device_h
);
188 struct anv_physical_device
*pdevice
= &dev
->instance
->physicalDevice
;
190 VkAndroidHardwareBufferFormatPropertiesANDROID
*format_prop
=
191 vk_find_struct(pProperties
->pNext
,
192 ANDROID_HARDWARE_BUFFER_FORMAT_PROPERTIES_ANDROID
);
194 /* Fill format properties of an Android hardware buffer. */
196 get_ahw_buffer_format_properties(device_h
, buffer
, format_prop
);
198 /* NOTE - We support buffers with only one handle but do not error on
199 * multiple handle case. Reason is that we want to support YUV formats
200 * where we have many logical planes but they all point to the same
201 * buffer, like is the case with VK_FORMAT_G8_B8R8_2PLANE_420_UNORM.
203 const native_handle_t
*handle
=
204 AHardwareBuffer_getNativeHandle(buffer
);
205 int dma_buf
= (handle
&& handle
->numFds
) ? handle
->data
[0] : -1;
207 return VK_ERROR_INVALID_EXTERNAL_HANDLE_KHR
;
209 /* All memory types. */
210 uint32_t memory_types
= (1ull << pdevice
->memory
.type_count
) - 1;
212 pProperties
->allocationSize
= lseek(dma_buf
, 0, SEEK_END
);
213 pProperties
->memoryTypeBits
= memory_types
;
218 /* Construct ahw usage mask from image usage bits, see
219 * 'AHardwareBuffer Usage Equivalence' in Vulkan spec.
222 anv_ahw_usage_from_vk_usage(const VkImageCreateFlags vk_create
,
223 const VkImageUsageFlags vk_usage
)
225 uint64_t ahw_usage
= 0;
227 if (vk_usage
& VK_IMAGE_USAGE_SAMPLED_BIT
)
228 ahw_usage
|= AHARDWAREBUFFER_USAGE_GPU_SAMPLED_IMAGE
;
230 if (vk_usage
& VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT
)
231 ahw_usage
|= AHARDWAREBUFFER_USAGE_GPU_SAMPLED_IMAGE
;
233 if (vk_usage
& VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT
)
234 ahw_usage
|= AHARDWAREBUFFER_USAGE_GPU_COLOR_OUTPUT
;
236 if (vk_create
& VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT
)
237 ahw_usage
|= AHARDWAREBUFFER_USAGE_GPU_CUBE_MAP
;
239 if (vk_create
& VK_IMAGE_CREATE_PROTECTED_BIT
)
240 ahw_usage
|= AHARDWAREBUFFER_USAGE_PROTECTED_CONTENT
;
242 /* No usage bits set - set at least one GPU usage. */
244 ahw_usage
= AHARDWAREBUFFER_USAGE_GPU_SAMPLED_IMAGE
;
250 anv_image_from_gralloc(VkDevice device_h
,
251 const VkImageCreateInfo
*base_info
,
252 const VkNativeBufferANDROID
*gralloc_info
,
253 const VkAllocationCallbacks
*alloc
,
254 VkImage
*out_image_h
)
257 ANV_FROM_HANDLE(anv_device
, device
, device_h
);
258 VkImage image_h
= VK_NULL_HANDLE
;
259 struct anv_image
*image
= NULL
;
260 struct anv_bo
*bo
= NULL
;
263 struct anv_image_create_info anv_info
= {
264 .vk_info
= base_info
,
265 .isl_extra_usage_flags
= ISL_SURF_USAGE_DISABLE_AUX_BIT
,
268 if (gralloc_info
->handle
->numFds
!= 1) {
269 return vk_errorf(device
->instance
, device
,
270 VK_ERROR_INVALID_EXTERNAL_HANDLE_KHR
,
271 "VkNativeBufferANDROID::handle::numFds is %d, "
272 "expected 1", gralloc_info
->handle
->numFds
);
275 /* Do not close the gralloc handle's dma_buf. The lifetime of the dma_buf
276 * must exceed that of the gralloc handle, and we do not own the gralloc
279 int dma_buf
= gralloc_info
->handle
->data
[0];
281 uint64_t bo_flags
= ANV_BO_EXTERNAL
;
282 if (device
->instance
->physicalDevice
.supports_48bit_addresses
)
283 bo_flags
|= EXEC_OBJECT_SUPPORTS_48B_ADDRESS
;
284 if (device
->instance
->physicalDevice
.use_softpin
)
285 bo_flags
|= EXEC_OBJECT_PINNED
;
287 result
= anv_bo_cache_import(device
, &device
->bo_cache
, dma_buf
, bo_flags
, &bo
);
288 if (result
!= VK_SUCCESS
) {
289 return vk_errorf(device
->instance
, device
, result
,
290 "failed to import dma-buf from VkNativeBufferANDROID");
293 int i915_tiling
= anv_gem_get_tiling(device
, bo
->gem_handle
);
294 switch (i915_tiling
) {
295 case I915_TILING_NONE
:
296 anv_info
.isl_tiling_flags
= ISL_TILING_LINEAR_BIT
;
299 anv_info
.isl_tiling_flags
= ISL_TILING_X_BIT
;
302 anv_info
.isl_tiling_flags
= ISL_TILING_Y0_BIT
;
305 result
= vk_errorf(device
->instance
, device
,
306 VK_ERROR_INVALID_EXTERNAL_HANDLE_KHR
,
307 "DRM_IOCTL_I915_GEM_GET_TILING failed for "
308 "VkNativeBufferANDROID");
311 result
= vk_errorf(device
->instance
, device
,
312 VK_ERROR_INVALID_EXTERNAL_HANDLE_KHR
,
313 "DRM_IOCTL_I915_GEM_GET_TILING returned unknown "
314 "tiling %d for VkNativeBufferANDROID", i915_tiling
);
318 enum isl_format format
= anv_get_isl_format(&device
->info
,
320 VK_IMAGE_ASPECT_COLOR_BIT
,
322 assert(format
!= ISL_FORMAT_UNSUPPORTED
);
324 anv_info
.stride
= gralloc_info
->stride
*
325 (isl_format_get_layout(format
)->bpb
/ 8);
327 result
= anv_image_create(device_h
, &anv_info
, alloc
, &image_h
);
328 image
= anv_image_from_handle(image_h
);
329 if (result
!= VK_SUCCESS
)
332 if (bo
->size
< image
->size
) {
333 result
= vk_errorf(device
->instance
, device
,
334 VK_ERROR_INVALID_EXTERNAL_HANDLE_KHR
,
335 "dma-buf from VkNativeBufferANDROID is too small for "
336 "VkImage: %"PRIu64
"B < %"PRIu64
"B",
337 bo
->size
, image
->size
);
341 assert(image
->n_planes
== 1);
342 assert(image
->planes
[0].address
.offset
== 0);
344 image
->planes
[0].address
.bo
= bo
;
345 image
->planes
[0].bo_is_owned
= true;
347 /* We need to set the WRITE flag on window system buffers so that GEM will
348 * know we're writing to them and synchronize uses on other rings (for
349 * example, if the display server uses the blitter ring).
351 * If this function fails and if the imported bo was resident in the cache,
352 * we should avoid updating the bo's flags. Therefore, we defer updating
353 * the flags until success is certain.
356 bo
->flags
&= ~EXEC_OBJECT_ASYNC
;
357 bo
->flags
|= EXEC_OBJECT_WRITE
;
359 /* Don't clobber the out-parameter until success is certain. */
360 *out_image_h
= image_h
;
365 anv_DestroyImage(device_h
, image_h
, alloc
);
368 anv_bo_cache_release(device
, &device
->bo_cache
, bo
);
373 VkResult
anv_GetSwapchainGrallocUsageANDROID(
376 VkImageUsageFlags imageUsage
,
379 ANV_FROM_HANDLE(anv_device
, device
, device_h
);
380 struct anv_physical_device
*phys_dev
= &device
->instance
->physicalDevice
;
381 VkPhysicalDevice phys_dev_h
= anv_physical_device_to_handle(phys_dev
);
385 intel_logd("%s: format=%d, usage=0x%x", __func__
, format
, imageUsage
);
387 /* WARNING: Android Nougat's libvulkan.so hardcodes the VkImageUsageFlags
388 * returned to applications via VkSurfaceCapabilitiesKHR::supportedUsageFlags.
389 * The relevant code in libvulkan/swapchain.cpp contains this fun comment:
391 * TODO(jessehall): I think these are right, but haven't thought hard
392 * about it. Do we need to query the driver for support of any of
395 * Any disagreement between this function and the hardcoded
396 * VkSurfaceCapabilitiesKHR:supportedUsageFlags causes tests
397 * dEQP-VK.wsi.android.swapchain.*.image_usage to fail.
400 const VkPhysicalDeviceImageFormatInfo2KHR image_format_info
= {
401 .sType
= VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_FORMAT_INFO_2_KHR
,
403 .type
= VK_IMAGE_TYPE_2D
,
404 .tiling
= VK_IMAGE_TILING_OPTIMAL
,
408 VkImageFormatProperties2KHR image_format_props
= {
409 .sType
= VK_STRUCTURE_TYPE_IMAGE_FORMAT_PROPERTIES_2_KHR
,
412 /* Check that requested format and usage are supported. */
413 result
= anv_GetPhysicalDeviceImageFormatProperties2(phys_dev_h
,
414 &image_format_info
, &image_format_props
);
415 if (result
!= VK_SUCCESS
) {
416 return vk_errorf(device
->instance
, device
, result
,
417 "anv_GetPhysicalDeviceImageFormatProperties2 failed "
418 "inside %s", __func__
);
421 /* Reject STORAGE here to avoid complexity elsewhere. */
422 if (imageUsage
& VK_IMAGE_USAGE_STORAGE_BIT
) {
423 return vk_errorf(device
->instance
, device
, VK_ERROR_FORMAT_NOT_SUPPORTED
,
424 "VK_IMAGE_USAGE_STORAGE_BIT unsupported for gralloc "
428 if (unmask32(&imageUsage
, VK_IMAGE_USAGE_TRANSFER_DST_BIT
|
429 VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT
))
430 *grallocUsage
|= GRALLOC_USAGE_HW_RENDER
;
432 if (unmask32(&imageUsage
, VK_IMAGE_USAGE_TRANSFER_SRC_BIT
|
433 VK_IMAGE_USAGE_SAMPLED_BIT
|
434 VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT
))
435 *grallocUsage
|= GRALLOC_USAGE_HW_TEXTURE
;
437 /* All VkImageUsageFlags not explicitly checked here are unsupported for
438 * gralloc swapchains.
440 if (imageUsage
!= 0) {
441 return vk_errorf(device
->instance
, device
, VK_ERROR_FORMAT_NOT_SUPPORTED
,
442 "unsupported VkImageUsageFlags(0x%x) for gralloc "
443 "swapchain", imageUsage
);
446 /* The below formats support GRALLOC_USAGE_HW_FB (that is, display
447 * scanout). This short list of formats is univserally supported on Intel
448 * but is incomplete. The full set of supported formats is dependent on
449 * kernel and hardware.
451 * FINISHME: Advertise all display-supported formats.
454 case VK_FORMAT_B8G8R8A8_UNORM
:
455 case VK_FORMAT_B5G6R5_UNORM_PACK16
:
456 case VK_FORMAT_R8G8B8A8_UNORM
:
457 case VK_FORMAT_R8G8B8A8_SRGB
:
458 *grallocUsage
|= GRALLOC_USAGE_HW_FB
|
459 GRALLOC_USAGE_HW_COMPOSER
|
460 GRALLOC_USAGE_EXTERNAL_DISP
;
463 intel_logw("%s: unsupported format=%d", __func__
, format
);
466 if (*grallocUsage
== 0)
467 return VK_ERROR_FORMAT_NOT_SUPPORTED
;
473 anv_AcquireImageANDROID(
477 VkSemaphore semaphore_h
,
480 ANV_FROM_HANDLE(anv_device
, device
, device_h
);
481 VkResult result
= VK_SUCCESS
;
483 if (nativeFenceFd
!= -1) {
484 /* As a simple, firstpass implementation of VK_ANDROID_native_buffer, we
485 * block on the nativeFenceFd. This may introduce latency and is
486 * definitiely inefficient, yet it's correct.
488 * FINISHME(chadv): Import the nativeFenceFd into the VkSemaphore and
491 if (sync_wait(nativeFenceFd
, /*timeout*/ -1) < 0) {
492 result
= vk_errorf(device
->instance
, device
, VK_ERROR_DEVICE_LOST
,
493 "%s: failed to wait on nativeFenceFd=%d",
494 __func__
, nativeFenceFd
);
497 /* From VK_ANDROID_native_buffer's pseudo spec
498 * (https://source.android.com/devices/graphics/implement-vulkan):
500 * The driver takes ownership of the fence fd and is responsible for
501 * closing it [...] even if vkAcquireImageANDROID fails and returns
504 close(nativeFenceFd
);
506 if (result
!= VK_SUCCESS
)
510 if (semaphore_h
|| fence_h
) {
511 /* Thanks to implicit sync, the image is ready for GPU access. But we
512 * must still put the semaphore into the "submit" state; otherwise the
513 * client may get unexpected behavior if the client later uses it as
516 * Because we blocked above on the nativeFenceFd, the image is also
517 * ready for foreign-device access (including CPU access). But we must
518 * still signal the fence; otherwise the client may get unexpected
519 * behavior if the client later waits on it.
521 * For some values of anv_semaphore_type, we must submit the semaphore
522 * to execbuf in order to signal it. Likewise for anv_fence_type.
523 * Instead of open-coding here the signal operation for each
524 * anv_semaphore_type and anv_fence_type, we piggy-back on
527 const VkSubmitInfo submit
= {
528 .sType
= VK_STRUCTURE_TYPE_SUBMIT_INFO
,
529 .waitSemaphoreCount
= 0,
530 .commandBufferCount
= 0,
531 .signalSemaphoreCount
= (semaphore_h
? 1 : 0),
532 .pSignalSemaphores
= &semaphore_h
,
535 result
= anv_QueueSubmit(anv_queue_to_handle(&device
->queue
), 1,
537 if (result
!= VK_SUCCESS
) {
538 return vk_errorf(device
->instance
, device
, result
,
539 "anv_QueueSubmit failed inside %s", __func__
);
547 anv_QueueSignalReleaseImageANDROID(
549 uint32_t waitSemaphoreCount
,
550 const VkSemaphore
* pWaitSemaphores
,
556 if (waitSemaphoreCount
== 0)
559 result
= anv_QueueSubmit(queue
, 1,
561 .sType
= VK_STRUCTURE_TYPE_SUBMIT_INFO
,
562 .waitSemaphoreCount
= 1,
563 .pWaitSemaphores
= pWaitSemaphores
,
565 (VkFence
) VK_NULL_HANDLE
);
566 if (result
!= VK_SUCCESS
)
570 if (pNativeFenceFd
) {
571 /* We can rely implicit on sync because above we submitted all
572 * semaphores to the queue.
574 *pNativeFenceFd
= -1;