2 * Copyright © 2015 Intel Corporation
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
30 #include "anv_private.h"
32 static const uint8_t anv_halign
[] = {
38 static const uint8_t anv_valign
[] = {
44 static const uint8_t anv_surf_type_from_image_type
[] = {
45 [VK_IMAGE_TYPE_1D
] = SURFTYPE_1D
,
46 [VK_IMAGE_TYPE_2D
] = SURFTYPE_2D
,
47 [VK_IMAGE_TYPE_3D
] = SURFTYPE_3D
,
51 static const struct anv_image_view_info
52 anv_image_view_info_table
[] = {
53 #define INFO(s, ...) { .surface_type = s, __VA_ARGS__ }
54 [VK_IMAGE_VIEW_TYPE_1D
] = INFO(SURFTYPE_1D
),
55 [VK_IMAGE_VIEW_TYPE_2D
] = INFO(SURFTYPE_2D
),
56 [VK_IMAGE_VIEW_TYPE_3D
] = INFO(SURFTYPE_3D
),
57 [VK_IMAGE_VIEW_TYPE_CUBE
] = INFO(SURFTYPE_CUBE
, .is_cube
= 1),
58 [VK_IMAGE_VIEW_TYPE_1D_ARRAY
] = INFO(SURFTYPE_1D
, .is_array
= 1),
59 [VK_IMAGE_VIEW_TYPE_2D_ARRAY
] = INFO(SURFTYPE_2D
, .is_array
= 1),
60 [VK_IMAGE_VIEW_TYPE_CUBE_ARRAY
] = INFO(SURFTYPE_CUBE
, .is_array
= 1, .is_cube
= 1),
64 const struct anv_image_view_info
*
65 anv_image_view_info_for_vk_image_view_type(VkImageViewType type
)
67 return &anv_image_view_info_table
[type
];
70 static const struct anv_surf_type_limits
{
74 } anv_surf_type_limits
[] = {
75 [SURFTYPE_1D
] = {16384, 0, 2048},
76 [SURFTYPE_2D
] = {16384, 16384, 2048},
77 [SURFTYPE_3D
] = {2048, 2048, 2048},
78 [SURFTYPE_CUBE
] = {16384, 16384, 340},
79 [SURFTYPE_BUFFER
] = {128, 16384, 64},
80 [SURFTYPE_STRBUF
] = {128, 16384, 64},
83 static const struct anv_tile_info
{
88 * Alignment for RENDER_SURFACE_STATE.SurfaceBaseAddress.
90 * To simplify calculations, the alignments defined in the table are
91 * sometimes larger than required. For example, Skylake requires that X and
92 * Y tiled buffers be aligned to 4K, but Broadwell permits smaller
93 * alignment. We choose 4K to accomodate both chipsets. The alignment of
94 * a linear buffer depends on its element type and usage. Linear depth
95 * buffers have the largest alignment, 64B, so we choose that for all linear
98 uint32_t surface_alignment
;
99 } anv_tile_info_table
[] = {
100 [LINEAR
] = { 1, 1, 64 },
101 [XMAJOR
] = { 512, 8, 4096 },
102 [YMAJOR
] = { 128, 32, 4096 },
103 [WMAJOR
] = { 128, 32, 4096 },
107 * Return -1 on failure.
110 anv_image_choose_tile_mode(const struct anv_image_create_info
*anv_info
)
112 if (anv_info
->force_tile_mode
)
113 return anv_info
->tile_mode
;
115 /* The Sandybridge PRM says that the stencil buffer "is supported
116 * only in Tile W memory".
119 switch (anv_info
->vk_info
->tiling
) {
120 case VK_IMAGE_TILING_LINEAR
:
121 if (unlikely(anv_info
->vk_info
->format
== VK_FORMAT_S8_UINT
)) {
126 case VK_IMAGE_TILING_OPTIMAL
:
127 if (unlikely(anv_info
->vk_info
->format
== VK_FORMAT_S8_UINT
)) {
133 assert(!"bad VKImageTiling");
140 * The \a format argument is required and overrides any format in
141 * struct anv_image_create_info.
144 anv_image_make_surface(const struct anv_image_create_info
*create_info
,
145 const struct anv_format
*format
,
146 uint64_t *inout_image_size
,
147 uint32_t *inout_image_alignment
,
148 struct anv_surface
*out_surface
)
150 /* See RENDER_SURFACE_STATE.SurfaceQPitch */
151 static const uint16_t min_qpitch UNUSED
= 0x4;
152 static const uint16_t max_qpitch UNUSED
= 0x1ffc;
154 const VkExtent3D
*restrict extent
= &create_info
->vk_info
->extent
;
155 const uint32_t levels
= create_info
->vk_info
->mipLevels
;
156 const uint32_t array_size
= create_info
->vk_info
->arraySize
;
158 const int8_t tile_mode
= anv_image_choose_tile_mode(create_info
);
160 return vk_error(VK_ERROR_INVALID_IMAGE
);
162 const struct anv_tile_info
*tile_info
=
163 &anv_tile_info_table
[tile_mode
];
165 const uint32_t i
= 4; /* FINISHME: Stop hardcoding subimage alignment */
166 const uint32_t j
= 4; /* FINISHME: Stop hardcoding subimage alignment */
167 const uint32_t w0
= align_u32(extent
->width
, i
);
168 const uint32_t h0
= align_u32(extent
->height
, j
);
174 if (levels
== 1 && array_size
== 1) {
179 uint32_t w1
= align_u32(anv_minify(extent
->width
, 1), i
);
180 uint32_t h1
= align_u32(anv_minify(extent
->height
, 1), j
);
181 uint32_t w2
= align_u32(anv_minify(extent
->width
, 2), i
);
183 qpitch
= h0
+ h1
+ 11 * j
;
184 mt_width
= MAX(w0
, w1
+ w2
);
185 mt_height
= array_size
* qpitch
;
188 assert(qpitch
>= min_qpitch
);
189 if (qpitch
> max_qpitch
) {
190 anv_loge("image qpitch > 0x%x\n", max_qpitch
);
191 return vk_error(VK_ERROR_OUT_OF_DEVICE_MEMORY
);
194 /* From the Broadwell PRM, RENDER_SURFACE_STATE.SurfaceQpitch:
196 * This field must be set an integer multiple of the Surface Vertical
199 assert(anv_is_aligned(qpitch
, j
));
201 uint32_t stride
= align_u32(mt_width
* format
->cpp
, tile_info
->width
);
202 if (create_info
->stride
> 0)
203 stride
= create_info
->stride
;
205 const uint32_t size
= stride
* align_u32(mt_height
, tile_info
->height
);
206 const uint32_t offset
= align_u32(*inout_image_size
,
207 tile_info
->surface_alignment
);
209 *inout_image_size
= offset
+ size
;
210 *inout_image_alignment
= MAX(*inout_image_alignment
,
211 tile_info
->surface_alignment
);
213 *out_surface
= (struct anv_surface
) {
216 .tile_mode
= tile_mode
,
226 anv_image_create(VkDevice _device
,
227 const struct anv_image_create_info
*create_info
,
230 ANV_FROM_HANDLE(anv_device
, device
, _device
);
231 const VkImageCreateInfo
*pCreateInfo
= create_info
->vk_info
;
232 const VkExtent3D
*restrict extent
= &pCreateInfo
->extent
;
233 struct anv_image
*image
= NULL
;
236 assert(pCreateInfo
->sType
== VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO
);
238 /* XXX: We don't handle any of these */
239 anv_assert(pCreateInfo
->imageType
== VK_IMAGE_TYPE_2D
);
240 anv_assert(pCreateInfo
->mipLevels
> 0);
241 anv_assert(pCreateInfo
->arraySize
> 0);
242 anv_assert(pCreateInfo
->samples
== 1);
243 anv_assert(pCreateInfo
->extent
.width
> 0);
244 anv_assert(pCreateInfo
->extent
.height
> 0);
245 anv_assert(pCreateInfo
->extent
.depth
> 0);
247 /* TODO(chadv): How should we validate inputs? */
248 const uint8_t surf_type
=
249 anv_surf_type_from_image_type
[pCreateInfo
->imageType
];
251 const struct anv_surf_type_limits
*limits
=
252 &anv_surf_type_limits
[surf_type
];
254 if (extent
->width
> limits
->width
||
255 extent
->height
> limits
->height
||
256 extent
->depth
> limits
->depth
) {
257 /* TODO(chadv): What is the correct error? */
258 anv_loge("image extent is too large");
259 return vk_error(VK_ERROR_INVALID_MEMORY_SIZE
);
262 image
= anv_device_alloc(device
, sizeof(*image
), 8,
263 VK_SYSTEM_ALLOC_TYPE_API_OBJECT
);
265 return vk_error(VK_ERROR_OUT_OF_HOST_MEMORY
);
267 memset(image
, 0, sizeof(*image
));
268 image
->type
= pCreateInfo
->imageType
;
269 image
->extent
= pCreateInfo
->extent
;
270 image
->format
= anv_format_for_vk_format(pCreateInfo
->format
);
271 image
->levels
= pCreateInfo
->mipLevels
;
272 image
->array_size
= pCreateInfo
->arraySize
;
273 image
->surf_type
= surf_type
;
275 if (likely(anv_format_is_color(image
->format
))) {
276 r
= anv_image_make_surface(create_info
, image
->format
,
277 &image
->size
, &image
->alignment
,
278 &image
->color_surface
);
282 if (image
->format
->depth_format
) {
283 r
= anv_image_make_surface(create_info
, image
->format
,
284 &image
->size
, &image
->alignment
,
285 &image
->depth_surface
);
290 if (image
->format
->has_stencil
) {
291 r
= anv_image_make_surface(create_info
, anv_format_s8_uint
,
292 &image
->size
, &image
->alignment
,
293 &image
->stencil_surface
);
299 *pImage
= anv_image_to_handle(image
);
305 anv_device_free(device
, image
);
311 anv_CreateImage(VkDevice device
,
312 const VkImageCreateInfo
*pCreateInfo
,
315 return anv_image_create(device
,
316 &(struct anv_image_create_info
) {
317 .vk_info
= pCreateInfo
,
323 anv_DestroyImage(VkDevice _device
, VkImage _image
)
325 ANV_FROM_HANDLE(anv_device
, device
, _device
);
327 anv_device_free(device
, anv_image_from_handle(_image
));
332 VkResult
anv_GetImageSubresourceLayout(
335 const VkImageSubresource
* pSubresource
,
336 VkSubresourceLayout
* pLayout
)
338 stub_return(VK_UNSUPPORTED
);
342 anv_surface_view_fini(struct anv_device
*device
,
343 struct anv_surface_view
*view
)
345 anv_state_pool_free(&device
->surface_state_pool
, view
->surface_state
);
349 anv_validate_CreateImageView(VkDevice _device
,
350 const VkImageViewCreateInfo
*pCreateInfo
,
353 ANV_FROM_HANDLE(anv_image
, image
, pCreateInfo
->image
);
354 const VkImageSubresourceRange
*subresource
;
355 const struct anv_image_view_info
*view_info
;
356 const struct anv_format
*view_format_info
;
358 /* Validate structure type before dereferencing it. */
360 assert(pCreateInfo
->sType
== VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO
);
361 subresource
= &pCreateInfo
->subresourceRange
;
363 /* Validate viewType is in range before using it. */
364 assert(pCreateInfo
->viewType
>= VK_IMAGE_VIEW_TYPE_BEGIN_RANGE
);
365 assert(pCreateInfo
->viewType
<= VK_IMAGE_VIEW_TYPE_END_RANGE
);
366 view_info
= &anv_image_view_info_table
[pCreateInfo
->viewType
];
368 /* Validate format is in range before using it. */
369 assert(pCreateInfo
->format
>= VK_FORMAT_BEGIN_RANGE
);
370 assert(pCreateInfo
->format
<= VK_FORMAT_END_RANGE
);
371 view_format_info
= anv_format_for_vk_format(pCreateInfo
->format
);
373 /* Validate channel swizzles. */
374 assert(pCreateInfo
->channels
.r
>= VK_CHANNEL_SWIZZLE_BEGIN_RANGE
);
375 assert(pCreateInfo
->channels
.r
<= VK_CHANNEL_SWIZZLE_END_RANGE
);
376 assert(pCreateInfo
->channels
.g
>= VK_CHANNEL_SWIZZLE_BEGIN_RANGE
);
377 assert(pCreateInfo
->channels
.g
<= VK_CHANNEL_SWIZZLE_END_RANGE
);
378 assert(pCreateInfo
->channels
.b
>= VK_CHANNEL_SWIZZLE_BEGIN_RANGE
);
379 assert(pCreateInfo
->channels
.b
<= VK_CHANNEL_SWIZZLE_END_RANGE
);
380 assert(pCreateInfo
->channels
.a
>= VK_CHANNEL_SWIZZLE_BEGIN_RANGE
);
381 assert(pCreateInfo
->channels
.a
<= VK_CHANNEL_SWIZZLE_END_RANGE
);
383 /* Validate subresource. */
384 assert(subresource
->aspect
>= VK_IMAGE_ASPECT_BEGIN_RANGE
);
385 assert(subresource
->aspect
<= VK_IMAGE_ASPECT_END_RANGE
);
386 assert(subresource
->mipLevels
> 0);
387 assert(subresource
->arraySize
> 0);
388 assert(subresource
->baseMipLevel
< image
->levels
);
389 assert(subresource
->baseMipLevel
+ subresource
->mipLevels
<= image
->levels
);
390 assert(subresource
->baseArraySlice
< image
->array_size
);
391 assert(subresource
->baseArraySlice
+ subresource
->arraySize
<= image
->array_size
);
394 if (view_info
->is_cube
) {
395 assert(subresource
->baseArraySlice
% 6 == 0);
396 assert(subresource
->arraySize
% 6 == 0);
399 /* Validate format. */
400 switch (subresource
->aspect
) {
401 case VK_IMAGE_ASPECT_COLOR
:
402 assert(!image
->format
->depth_format
);
403 assert(!image
->format
->has_stencil
);
404 assert(!view_format_info
->depth_format
);
405 assert(!view_format_info
->has_stencil
);
406 assert(view_format_info
->cpp
== image
->format
->cpp
);
408 case VK_IMAGE_ASPECT_DEPTH
:
409 assert(image
->format
->depth_format
);
410 assert(view_format_info
->depth_format
);
411 assert(view_format_info
->cpp
== image
->format
->cpp
);
413 case VK_IMAGE_ASPECT_STENCIL
:
414 /* FINISHME: Is it legal to have an R8 view of S8? */
415 assert(image
->format
->has_stencil
);
416 assert(view_format_info
->has_stencil
);
419 assert(!"bad VkImageAspect");
423 return anv_CreateImageView(_device
, pCreateInfo
, pView
);
427 anv_image_view_init(struct anv_image_view
*iview
,
428 struct anv_device
*device
,
429 const VkImageViewCreateInfo
* pCreateInfo
,
430 struct anv_cmd_buffer
*cmd_buffer
)
432 switch (device
->info
.gen
) {
434 gen7_image_view_init(iview
, device
, pCreateInfo
, cmd_buffer
);
437 gen8_image_view_init(iview
, device
, pCreateInfo
, cmd_buffer
);
440 unreachable("unsupported gen\n");
445 anv_CreateImageView(VkDevice _device
,
446 const VkImageViewCreateInfo
*pCreateInfo
,
449 ANV_FROM_HANDLE(anv_device
, device
, _device
);
450 struct anv_image_view
*view
;
452 view
= anv_device_alloc(device
, sizeof(*view
), 8,
453 VK_SYSTEM_ALLOC_TYPE_API_OBJECT
);
455 return vk_error(VK_ERROR_OUT_OF_HOST_MEMORY
);
457 anv_image_view_init(view
, device
, pCreateInfo
, NULL
);
459 *pView
= anv_image_view_to_handle(view
);
465 anv_DestroyImageView(VkDevice _device
, VkImageView _iview
)
467 ANV_FROM_HANDLE(anv_device
, device
, _device
);
468 ANV_FROM_HANDLE(anv_image_view
, iview
, _iview
);
470 anv_surface_view_fini(device
, &iview
->view
);
471 anv_device_free(device
, iview
);
477 anv_depth_stencil_view_init(struct anv_depth_stencil_view
*view
,
478 const VkAttachmentViewCreateInfo
*pCreateInfo
)
480 ANV_FROM_HANDLE(anv_image
, image
, pCreateInfo
->image
);
482 view
->base
.attachment_type
= ANV_ATTACHMENT_VIEW_TYPE_DEPTH_STENCIL
;
484 /* XXX: We don't handle any of these */
485 anv_assert(pCreateInfo
->mipLevel
== 0);
486 anv_assert(pCreateInfo
->baseArraySlice
== 0);
487 anv_assert(pCreateInfo
->arraySize
== 1);
490 view
->format
= anv_format_for_vk_format(pCreateInfo
->format
);
492 assert(anv_format_is_depth_or_stencil(image
->format
));
493 assert(anv_format_is_depth_or_stencil(view
->format
));
497 anv_image_get_surface_for_aspect(struct anv_image
*image
, VkImageAspect aspect
)
500 case VK_IMAGE_ASPECT_COLOR
:
501 assert(anv_format_is_color(image
->format
));
502 return &image
->color_surface
;
503 case VK_IMAGE_ASPECT_DEPTH
:
504 assert(image
->format
->depth_format
);
505 return &image
->depth_surface
;
506 case VK_IMAGE_ASPECT_STENCIL
:
507 assert(image
->format
->has_stencil
);
508 anv_finishme("stencil image views");
509 return &image
->stencil_surface
;
511 unreachable("image does not have aspect");
516 /** The attachment may be a color view into a non-color image. */
518 anv_image_get_surface_for_color_attachment(struct anv_image
*image
)
520 if (anv_format_is_color(image
->format
)) {
521 return &image
->color_surface
;
522 } else if (image
->format
->depth_format
) {
523 return &image
->depth_surface
;
524 } else if (image
->format
->has_stencil
) {
525 return &image
->stencil_surface
;
527 unreachable("image has bad format");
533 anv_color_attachment_view_init(struct anv_color_attachment_view
*aview
,
534 struct anv_device
*device
,
535 const VkAttachmentViewCreateInfo
* pCreateInfo
,
536 struct anv_cmd_buffer
*cmd_buffer
)
538 switch (device
->info
.gen
) {
540 gen7_color_attachment_view_init(aview
, device
, pCreateInfo
, cmd_buffer
);
543 gen8_color_attachment_view_init(aview
, device
, pCreateInfo
, cmd_buffer
);
546 unreachable("unsupported gen\n");
551 anv_CreateAttachmentView(VkDevice _device
,
552 const VkAttachmentViewCreateInfo
*pCreateInfo
,
553 VkAttachmentView
*pView
)
555 ANV_FROM_HANDLE(anv_device
, device
, _device
);
557 assert(pCreateInfo
->sType
== VK_STRUCTURE_TYPE_ATTACHMENT_VIEW_CREATE_INFO
);
559 const struct anv_format
*format
=
560 anv_format_for_vk_format(pCreateInfo
->format
);
562 if (anv_format_is_depth_or_stencil(format
)) {
563 struct anv_depth_stencil_view
*view
=
564 anv_device_alloc(device
, sizeof(*view
), 8,
565 VK_SYSTEM_ALLOC_TYPE_API_OBJECT
);
567 return vk_error(VK_ERROR_OUT_OF_HOST_MEMORY
);
569 anv_depth_stencil_view_init(view
, pCreateInfo
);
571 *pView
= anv_attachment_view_to_handle(&view
->base
);
573 struct anv_color_attachment_view
*view
=
574 anv_device_alloc(device
, sizeof(*view
), 8,
575 VK_SYSTEM_ALLOC_TYPE_API_OBJECT
);
577 return vk_error(VK_ERROR_OUT_OF_HOST_MEMORY
);
579 anv_color_attachment_view_init(view
, device
, pCreateInfo
, NULL
);
581 *pView
= anv_attachment_view_to_handle(&view
->base
);
588 anv_DestroyAttachmentView(VkDevice _device
, VkAttachmentView _view
)
590 ANV_FROM_HANDLE(anv_device
, device
, _device
);
591 ANV_FROM_HANDLE(anv_attachment_view
, view
, _view
);
593 if (view
->attachment_type
== ANV_ATTACHMENT_VIEW_TYPE_COLOR
) {
594 struct anv_color_attachment_view
*aview
=
595 (struct anv_color_attachment_view
*)view
;
597 anv_surface_view_fini(device
, &aview
->view
);
600 anv_device_free(device
, view
);