2 * Copyright © 2011 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,
16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
25 * Benjamin Franzke <benjaminfranzke@googlemail.com>
38 #include <sys/types.h>
42 #include <drm_fourcc.h>
44 #include <GL/gl.h> /* dri_interface needs GL types */
45 #include <GL/internal/dri_interface.h>
47 #include "gbm_driint.h"
51 #include "util/macros.h"
53 /* For importing wl_buffer */
54 #if HAVE_WAYLAND_PLATFORM
55 #include "../../../egl/wayland/wayland-drm/wayland-drm.h"
58 #ifndef DRM_FORMAT_MOD_INVALID
59 #define DRM_FORMAT_MOD_INVALID ((1ULL<<56) - 1)
62 #ifndef DRM_FORMAT_MOD_LINEAR
63 #define DRM_FORMAT_MOD_LINEAR 0
67 dri_lookup_egl_image(__DRIscreen
*screen
, void *image
, void *data
)
69 struct gbm_dri_device
*dri
= data
;
71 if (dri
->lookup_image
== NULL
)
74 return dri
->lookup_image(screen
, image
, dri
->lookup_user_data
);
78 dri_get_buffers(__DRIdrawable
* driDrawable
,
79 int *width
, int *height
,
80 unsigned int *attachments
, int count
,
81 int *out_count
, void *data
)
83 struct gbm_dri_surface
*surf
= data
;
84 struct gbm_dri_device
*dri
= gbm_dri_device(surf
->base
.gbm
);
86 if (dri
->get_buffers
== NULL
)
89 return dri
->get_buffers(driDrawable
, width
, height
, attachments
,
90 count
, out_count
, surf
->dri_private
);
94 dri_flush_front_buffer(__DRIdrawable
* driDrawable
, void *data
)
96 struct gbm_dri_surface
*surf
= data
;
97 struct gbm_dri_device
*dri
= gbm_dri_device(surf
->base
.gbm
);
99 if (dri
->flush_front_buffer
!= NULL
)
100 dri
->flush_front_buffer(driDrawable
, surf
->dri_private
);
104 dri_get_buffers_with_format(__DRIdrawable
* driDrawable
,
105 int *width
, int *height
,
106 unsigned int *attachments
, int count
,
107 int *out_count
, void *data
)
109 struct gbm_dri_surface
*surf
= data
;
110 struct gbm_dri_device
*dri
= gbm_dri_device(surf
->base
.gbm
);
112 if (dri
->get_buffers_with_format
== NULL
)
116 dri
->get_buffers_with_format(driDrawable
, width
, height
, attachments
,
117 count
, out_count
, surf
->dri_private
);
121 image_get_buffers(__DRIdrawable
*driDrawable
,
125 uint32_t buffer_mask
,
126 struct __DRIimageList
*buffers
)
128 struct gbm_dri_surface
*surf
= loaderPrivate
;
129 struct gbm_dri_device
*dri
= gbm_dri_device(surf
->base
.gbm
);
131 if (dri
->image_get_buffers
== NULL
)
134 return dri
->image_get_buffers(driDrawable
, format
, stamp
,
135 surf
->dri_private
, buffer_mask
, buffers
);
139 swrast_get_drawable_info(__DRIdrawable
*driDrawable
,
146 struct gbm_dri_surface
*surf
= loaderPrivate
;
150 *width
= surf
->base
.width
;
151 *height
= surf
->base
.height
;
155 swrast_put_image2(__DRIdrawable
*driDrawable
,
165 struct gbm_dri_surface
*surf
= loaderPrivate
;
166 struct gbm_dri_device
*dri
= gbm_dri_device(surf
->base
.gbm
);
168 dri
->swrast_put_image2(driDrawable
,
170 width
, height
, stride
,
171 data
, surf
->dri_private
);
175 swrast_put_image(__DRIdrawable
*driDrawable
,
184 return swrast_put_image2(driDrawable
, op
, x
, y
, width
, height
,
185 width
* 4, data
, loaderPrivate
);
189 swrast_get_image(__DRIdrawable
*driDrawable
,
197 struct gbm_dri_surface
*surf
= loaderPrivate
;
198 struct gbm_dri_device
*dri
= gbm_dri_device(surf
->base
.gbm
);
200 dri
->swrast_get_image(driDrawable
,
203 data
, surf
->dri_private
);
206 static const __DRIuseInvalidateExtension use_invalidate
= {
207 .base
= { __DRI_USE_INVALIDATE
, 1 }
210 static const __DRIimageLookupExtension image_lookup_extension
= {
211 .base
= { __DRI_IMAGE_LOOKUP
, 1 },
213 .lookupEGLImage
= dri_lookup_egl_image
216 static const __DRIdri2LoaderExtension dri2_loader_extension
= {
217 .base
= { __DRI_DRI2_LOADER
, 3 },
219 .getBuffers
= dri_get_buffers
,
220 .flushFrontBuffer
= dri_flush_front_buffer
,
221 .getBuffersWithFormat
= dri_get_buffers_with_format
,
224 static const __DRIimageLoaderExtension image_loader_extension
= {
225 .base
= { __DRI_IMAGE_LOADER
, 1 },
227 .getBuffers
= image_get_buffers
,
228 .flushFrontBuffer
= dri_flush_front_buffer
,
231 static const __DRIswrastLoaderExtension swrast_loader_extension
= {
232 .base
= { __DRI_SWRAST_LOADER
, 2 },
234 .getDrawableInfo
= swrast_get_drawable_info
,
235 .putImage
= swrast_put_image
,
236 .getImage
= swrast_get_image
,
237 .putImage2
= swrast_put_image2
240 static const __DRIextension
*gbm_dri_screen_extensions
[] = {
241 &image_lookup_extension
.base
,
242 &use_invalidate
.base
,
243 &dri2_loader_extension
.base
,
244 &image_loader_extension
.base
,
245 &swrast_loader_extension
.base
,
249 struct dri_extension_match
{
256 static struct dri_extension_match dri_core_extensions
[] = {
257 { __DRI2_FLUSH
, 1, offsetof(struct gbm_dri_device
, flush
) },
258 { __DRI_IMAGE
, 1, offsetof(struct gbm_dri_device
, image
) },
259 { __DRI2_FENCE
, 1, offsetof(struct gbm_dri_device
, fence
), 1 },
263 static struct dri_extension_match gbm_dri_device_extensions
[] = {
264 { __DRI_CORE
, 1, offsetof(struct gbm_dri_device
, core
) },
265 { __DRI_DRI2
, 1, offsetof(struct gbm_dri_device
, dri2
) },
269 static struct dri_extension_match gbm_swrast_device_extensions
[] = {
270 { __DRI_CORE
, 1, offsetof(struct gbm_dri_device
, core
), },
271 { __DRI_SWRAST
, 1, offsetof(struct gbm_dri_device
, swrast
) },
276 dri_bind_extensions(struct gbm_dri_device
*dri
,
277 struct dri_extension_match
*matches
,
278 const __DRIextension
**extensions
)
283 for (i
= 0; extensions
[i
]; i
++) {
284 for (j
= 0; matches
[j
].name
; j
++) {
285 if (strcmp(extensions
[i
]->name
, matches
[j
].name
) == 0 &&
286 extensions
[i
]->version
>= matches
[j
].version
) {
287 field
= ((char *) dri
+ matches
[j
].offset
);
288 *(const __DRIextension
**) field
= extensions
[i
];
293 for (j
= 0; matches
[j
].name
; j
++) {
294 field
= ((char *) dri
+ matches
[j
].offset
);
295 if ((*(const __DRIextension
**) field
== NULL
) && !matches
[j
].optional
) {
303 static const __DRIextension
**
304 dri_open_driver(struct gbm_dri_device
*dri
)
306 const __DRIextension
**extensions
= NULL
;
307 char path
[PATH_MAX
], *search_paths
, *p
, *next
, *end
;
308 char *get_extensions_name
;
311 /* don't allow setuid apps to use LIBGL_DRIVERS_PATH or GBM_DRIVERS_PATH */
312 if (geteuid() == getuid()) {
313 /* Read GBM_DRIVERS_PATH first for compatibility, but LIBGL_DRIVERS_PATH
314 * is recommended over GBM_DRIVERS_PATH.
316 search_paths
= getenv("GBM_DRIVERS_PATH");
318 /* Read LIBGL_DRIVERS_PATH if GBM_DRIVERS_PATH was not set.
319 * LIBGL_DRIVERS_PATH is recommended over GBM_DRIVERS_PATH.
321 if (search_paths
== NULL
) {
322 search_paths
= getenv("LIBGL_DRIVERS_PATH");
325 if (search_paths
== NULL
)
326 search_paths
= DEFAULT_DRIVER_DIR
;
328 /* Temporarily work around dri driver libs that need symbols in libglapi
329 * but don't automatically link it in.
331 /* XXX: Library name differs on per platforms basis. Update this as
332 * osx/cygwin/windows/bsd gets support for GBM..
334 dlopen("libglapi.so.0", RTLD_LAZY
| RTLD_GLOBAL
);
337 end
= search_paths
+ strlen(search_paths
);
338 for (p
= search_paths
; p
< end
&& dri
->driver
== NULL
; p
= next
+ 1) {
340 next
= strchr(p
, ':');
346 snprintf(path
, sizeof path
,
347 "%.*s/tls/%s_dri.so", len
, p
, dri
->driver_name
);
348 dri
->driver
= dlopen(path
, RTLD_NOW
| RTLD_GLOBAL
);
350 if (dri
->driver
== NULL
) {
351 snprintf(path
, sizeof path
,
352 "%.*s/%s_dri.so", len
, p
, dri
->driver_name
);
353 dri
->driver
= dlopen(path
, RTLD_NOW
| RTLD_GLOBAL
);
355 /* not need continue to loop all paths once the driver is found */
356 if (dri
->driver
!= NULL
)
360 if (dri
->driver
== NULL
) {
361 fprintf(stderr
, "gbm: failed to open any driver (search paths %s)\n",
363 fprintf(stderr
, "gbm: Last dlopen error: %s\n", dlerror());
367 get_extensions_name
= loader_get_extensions_name(dri
->driver_name
);
368 if (get_extensions_name
) {
369 const __DRIextension
**(*get_extensions
)(void);
371 get_extensions
= dlsym(dri
->driver
, get_extensions_name
);
372 free(get_extensions_name
);
375 extensions
= get_extensions();
379 extensions
= dlsym(dri
->driver
, __DRI_DRIVER_EXTENSIONS
);
380 if (extensions
== NULL
) {
381 fprintf(stderr
, "gbm: driver exports no extensions (%s)", dlerror());
382 dlclose(dri
->driver
);
389 dri_load_driver(struct gbm_dri_device
*dri
)
391 const __DRIextension
**extensions
;
393 extensions
= dri_open_driver(dri
);
397 if (dri_bind_extensions(dri
, gbm_dri_device_extensions
, extensions
) < 0) {
398 dlclose(dri
->driver
);
399 fprintf(stderr
, "failed to bind extensions\n");
403 dri
->driver_extensions
= extensions
;
409 dri_load_driver_swrast(struct gbm_dri_device
*dri
)
411 const __DRIextension
**extensions
;
413 extensions
= dri_open_driver(dri
);
417 if (dri_bind_extensions(dri
, gbm_swrast_device_extensions
, extensions
) < 0) {
418 dlclose(dri
->driver
);
419 fprintf(stderr
, "failed to bind extensions\n");
423 dri
->driver_extensions
= extensions
;
429 dri_screen_create_dri2(struct gbm_dri_device
*dri
, char *driver_name
)
431 const __DRIextension
**extensions
;
434 dri
->driver_name
= driver_name
;
435 if (dri
->driver_name
== NULL
)
438 ret
= dri_load_driver(dri
);
440 fprintf(stderr
, "failed to load driver: %s\n", dri
->driver_name
);
444 dri
->loader_extensions
= gbm_dri_screen_extensions
;
446 if (dri
->dri2
== NULL
)
449 if (dri
->dri2
->base
.version
>= 4) {
450 dri
->screen
= dri
->dri2
->createNewScreen2(0, dri
->base
.fd
,
451 dri
->loader_extensions
,
452 dri
->driver_extensions
,
453 &dri
->driver_configs
, dri
);
455 dri
->screen
= dri
->dri2
->createNewScreen(0, dri
->base
.fd
,
456 dri
->loader_extensions
,
457 &dri
->driver_configs
, dri
);
459 if (dri
->screen
== NULL
)
462 extensions
= dri
->core
->getExtensions(dri
->screen
);
463 if (dri_bind_extensions(dri
, dri_core_extensions
, extensions
) < 0) {
468 dri
->lookup_image
= NULL
;
469 dri
->lookup_user_data
= NULL
;
474 dri
->core
->destroyScreen(dri
->screen
);
480 dri_screen_create_swrast(struct gbm_dri_device
*dri
)
484 dri
->driver_name
= strdup("swrast");
485 if (dri
->driver_name
== NULL
)
488 ret
= dri_load_driver_swrast(dri
);
490 fprintf(stderr
, "failed to load swrast driver\n");
494 dri
->loader_extensions
= gbm_dri_screen_extensions
;
496 if (dri
->swrast
== NULL
)
499 if (dri
->swrast
->base
.version
>= 4) {
500 dri
->screen
= dri
->swrast
->createNewScreen2(0, dri
->loader_extensions
,
501 dri
->driver_extensions
,
502 &dri
->driver_configs
, dri
);
504 dri
->screen
= dri
->swrast
->createNewScreen(0, dri
->loader_extensions
,
505 &dri
->driver_configs
, dri
);
507 if (dri
->screen
== NULL
)
510 dri
->lookup_image
= NULL
;
511 dri
->lookup_user_data
= NULL
;
517 dri_screen_create(struct gbm_dri_device
*dri
)
521 driver_name
= loader_get_driver_for_fd(dri
->base
.fd
);
525 return dri_screen_create_dri2(dri
, driver_name
);
529 dri_screen_create_sw(struct gbm_dri_device
*dri
)
534 driver_name
= strdup("kms_swrast");
538 ret
= dri_screen_create_dri2(dri
, driver_name
);
542 return dri_screen_create_swrast(dri
);
545 static const struct {
547 int dri_image_format
;
548 } gbm_to_dri_image_formats
[] = {
549 { GBM_FORMAT_R8
, __DRI_IMAGE_FORMAT_R8
},
550 { GBM_FORMAT_GR88
, __DRI_IMAGE_FORMAT_GR88
},
551 { GBM_FORMAT_RGB565
, __DRI_IMAGE_FORMAT_RGB565
},
552 { GBM_FORMAT_XRGB8888
, __DRI_IMAGE_FORMAT_XRGB8888
},
553 { GBM_FORMAT_ARGB8888
, __DRI_IMAGE_FORMAT_ARGB8888
},
554 { GBM_FORMAT_XBGR8888
, __DRI_IMAGE_FORMAT_XBGR8888
},
555 { GBM_FORMAT_ABGR8888
, __DRI_IMAGE_FORMAT_ABGR8888
},
556 { GBM_FORMAT_XRGB2101010
, __DRI_IMAGE_FORMAT_XRGB2101010
},
557 { GBM_FORMAT_ARGB2101010
, __DRI_IMAGE_FORMAT_ARGB2101010
},
560 /* The two GBM_BO_FORMAT_[XA]RGB8888 formats alias the GBM_FORMAT_*
561 * formats of the same name. We want to accept them whenever someone
562 * has a GBM format, but never return them to the user. */
564 gbm_format_canonicalize(uint32_t gbm_format
)
566 switch (gbm_format
) {
567 case GBM_BO_FORMAT_XRGB8888
:
568 return GBM_FORMAT_XRGB8888
;
569 case GBM_BO_FORMAT_ARGB8888
:
570 return GBM_FORMAT_ARGB8888
;
577 gbm_format_to_dri_format(uint32_t gbm_format
)
581 gbm_format
= gbm_format_canonicalize(gbm_format
);
582 for (i
= 0; i
< ARRAY_SIZE(gbm_to_dri_image_formats
); i
++) {
583 if (gbm_to_dri_image_formats
[i
].gbm_format
== gbm_format
)
584 return gbm_to_dri_image_formats
[i
].dri_image_format
;
591 gbm_dri_to_gbm_format(int dri_format
)
595 for (i
= 0; i
< ARRAY_SIZE(gbm_to_dri_image_formats
); i
++) {
596 if (gbm_to_dri_image_formats
[i
].dri_image_format
== dri_format
)
597 return gbm_to_dri_image_formats
[i
].gbm_format
;
605 gbm_dri_is_format_supported(struct gbm_device
*gbm
,
610 case GBM_BO_FORMAT_XRGB8888
:
611 case GBM_FORMAT_XBGR8888
:
612 case GBM_FORMAT_XRGB8888
:
614 case GBM_BO_FORMAT_ARGB8888
:
615 case GBM_FORMAT_ARGB8888
:
616 if (usage
& GBM_BO_USE_SCANOUT
)
623 if (usage
& GBM_BO_USE_CURSOR
&&
624 usage
& GBM_BO_USE_RENDERING
)
631 gbm_dri_bo_write(struct gbm_bo
*_bo
, const void *buf
, size_t count
)
633 struct gbm_dri_bo
*bo
= gbm_dri_bo(_bo
);
635 if (bo
->image
!= NULL
) {
640 memcpy(bo
->map
, buf
, count
);
646 gbm_dri_bo_get_fd(struct gbm_bo
*_bo
)
648 struct gbm_dri_device
*dri
= gbm_dri_device(_bo
->gbm
);
649 struct gbm_dri_bo
*bo
= gbm_dri_bo(_bo
);
652 if (bo
->image
== NULL
)
655 if (!dri
->image
->queryImage(bo
->image
, __DRI_IMAGE_ATTRIB_FD
, &fd
))
662 get_number_planes(struct gbm_dri_device
*dri
, __DRIimage
*image
)
666 /* Dumb buffers are single-plane only. */
670 dri
->image
->queryImage(image
, __DRI_IMAGE_ATTRIB_NUM_PLANES
, &num_planes
);
679 gbm_dri_bo_get_planes(struct gbm_bo
*_bo
)
681 struct gbm_dri_device
*dri
= gbm_dri_device(_bo
->gbm
);
682 struct gbm_dri_bo
*bo
= gbm_dri_bo(_bo
);
684 return get_number_planes(dri
, bo
->image
);
687 static union gbm_bo_handle
688 gbm_dri_bo_get_handle_for_plane(struct gbm_bo
*_bo
, int plane
)
690 struct gbm_dri_device
*dri
= gbm_dri_device(_bo
->gbm
);
691 struct gbm_dri_bo
*bo
= gbm_dri_bo(_bo
);
692 union gbm_bo_handle ret
;
695 if (!dri
->image
|| dri
->image
->base
.version
< 13 || !dri
->image
->fromPlanar
) {
700 if (plane
>= get_number_planes(dri
, bo
->image
)) {
705 /* dumb BOs can only utilize non-planar formats */
708 ret
.s32
= bo
->handle
;
712 __DRIimage
*image
= dri
->image
->fromPlanar(bo
->image
, plane
, NULL
);
714 dri
->image
->queryImage(image
, __DRI_IMAGE_ATTRIB_HANDLE
, &ret
.s32
);
715 dri
->image
->destroyImage(image
);
718 dri
->image
->queryImage(bo
->image
, __DRI_IMAGE_ATTRIB_HANDLE
, &ret
.s32
);
725 gbm_dri_bo_get_stride(struct gbm_bo
*_bo
, int plane
)
727 struct gbm_dri_device
*dri
= gbm_dri_device(_bo
->gbm
);
728 struct gbm_dri_bo
*bo
= gbm_dri_bo(_bo
);
732 if (!dri
->image
|| dri
->image
->base
.version
< 11 || !dri
->image
->fromPlanar
) {
733 /* Preserve legacy behavior if plane is 0 */
741 if (plane
>= get_number_planes(dri
, bo
->image
)) {
746 if (bo
->image
== NULL
) {
751 image
= dri
->image
->fromPlanar(bo
->image
, plane
, NULL
);
753 dri
->image
->queryImage(image
, __DRI_IMAGE_ATTRIB_STRIDE
, &stride
);
754 dri
->image
->destroyImage(image
);
757 dri
->image
->queryImage(bo
->image
, __DRI_IMAGE_ATTRIB_STRIDE
, &stride
);
760 return (uint32_t)stride
;
764 gbm_dri_bo_get_offset(struct gbm_bo
*_bo
, int plane
)
766 struct gbm_dri_device
*dri
= gbm_dri_device(_bo
->gbm
);
767 struct gbm_dri_bo
*bo
= gbm_dri_bo(_bo
);
770 /* These error cases do not actually return an error code, as the user
771 * will also fail to obtain the handle/FD from the BO. In that case, the
772 * offset is irrelevant, as they have no buffer to offset into, so
773 * returning 0 is harmless.
775 if (!dri
->image
|| dri
->image
->base
.version
< 13 || !dri
->image
->fromPlanar
)
778 if (plane
>= get_number_planes(dri
, bo
->image
))
781 /* Dumb images have no offset */
782 if (bo
->image
== NULL
) {
787 __DRIimage
*image
= dri
->image
->fromPlanar(bo
->image
, plane
, NULL
);
789 dri
->image
->queryImage(image
, __DRI_IMAGE_ATTRIB_OFFSET
, &offset
);
790 dri
->image
->destroyImage(image
);
792 dri
->image
->queryImage(bo
->image
, __DRI_IMAGE_ATTRIB_OFFSET
, &offset
);
795 return (uint32_t)offset
;
799 gbm_dri_bo_get_modifier(struct gbm_bo
*_bo
)
801 struct gbm_dri_device
*dri
= gbm_dri_device(_bo
->gbm
);
802 struct gbm_dri_bo
*bo
= gbm_dri_bo(_bo
);
804 if (!dri
->image
|| dri
->image
->base
.version
< 14) {
806 return DRM_FORMAT_MOD_INVALID
;
809 /* Dumb buffers have no modifiers */
811 return DRM_FORMAT_MOD_LINEAR
;
815 if (!dri
->image
->queryImage(bo
->image
, __DRI_IMAGE_ATTRIB_MODIFIER_UPPER
,
817 return DRM_FORMAT_MOD_INVALID
;
819 ret
= (uint64_t)mod
<< 32;
821 if (!dri
->image
->queryImage(bo
->image
, __DRI_IMAGE_ATTRIB_MODIFIER_LOWER
,
823 return DRM_FORMAT_MOD_INVALID
;
825 ret
|= (uint64_t)(mod
& 0xffffffff);
831 gbm_dri_bo_destroy(struct gbm_bo
*_bo
)
833 struct gbm_dri_device
*dri
= gbm_dri_device(_bo
->gbm
);
834 struct gbm_dri_bo
*bo
= gbm_dri_bo(_bo
);
835 struct drm_mode_destroy_dumb arg
;
837 if (bo
->image
!= NULL
) {
838 dri
->image
->destroyImage(bo
->image
);
840 gbm_dri_bo_unmap_dumb(bo
);
841 memset(&arg
, 0, sizeof(arg
));
842 arg
.handle
= bo
->handle
;
843 drmIoctl(dri
->base
.fd
, DRM_IOCTL_MODE_DESTROY_DUMB
, &arg
);
849 static struct gbm_bo
*
850 gbm_dri_bo_import(struct gbm_device
*gbm
,
851 uint32_t type
, void *buffer
, uint32_t usage
)
853 struct gbm_dri_device
*dri
= gbm_dri_device(gbm
);
854 struct gbm_dri_bo
*bo
;
856 unsigned dri_use
= 0;
859 /* Required for query image WIDTH & HEIGHT */
860 if (dri
->image
== NULL
|| dri
->image
->base
.version
< 4) {
866 #if HAVE_WAYLAND_PLATFORM
867 case GBM_BO_IMPORT_WL_BUFFER
:
869 struct wl_drm_buffer
*wb
;
876 wb
= wayland_drm_buffer_get(dri
->wl_drm
, (struct wl_resource
*) buffer
);
882 image
= dri
->image
->dupImage(wb
->driver_buffer
, NULL
);
884 /* GBM_FORMAT_* is identical to WL_DRM_FORMAT_*, so no conversion
886 gbm_format
= wb
->format
;
891 case GBM_BO_IMPORT_EGL_IMAGE
:
894 if (dri
->lookup_image
== NULL
) {
899 image
= dri
->lookup_image(dri
->screen
, buffer
, dri
->lookup_user_data
);
900 image
= dri
->image
->dupImage(image
, NULL
);
901 dri
->image
->queryImage(image
, __DRI_IMAGE_ATTRIB_FORMAT
, &dri_format
);
902 gbm_format
= gbm_dri_to_gbm_format(dri_format
);
903 if (gbm_format
== 0) {
905 dri
->image
->destroyImage(image
);
911 case GBM_BO_IMPORT_FD
:
913 struct gbm_import_fd_data
*fd_data
= buffer
;
914 int stride
= fd_data
->stride
, offset
= 0;
917 /* GBM's GBM_FORMAT_* tokens are a strict superset of the DRI FourCC
918 * tokens accepted by createImageFromFds, except for not supporting
919 * the sARGB format. */
920 fourcc
= gbm_format_canonicalize(fd_data
->format
);
922 image
= dri
->image
->createImageFromFds(dri
->screen
,
933 gbm_format
= fd_data
->format
;
937 case GBM_BO_IMPORT_FD_MODIFIER
:
939 struct gbm_import_fd_modifier_data
*fd_data
= buffer
;
943 /* Import with modifier requires createImageFromDmaBufs2 */
944 if (dri
->image
== NULL
|| dri
->image
->base
.version
< 15 ||
945 dri
->image
->createImageFromDmaBufs2
== NULL
) {
950 /* GBM's GBM_FORMAT_* tokens are a strict superset of the DRI FourCC
951 * tokens accepted by createImageFromDmaBufs2, except for not supporting
952 * the sARGB format. */
953 fourcc
= gbm_format_canonicalize(fd_data
->format
);
955 image
= dri
->image
->createImageFromDmaBufs2(dri
->screen
, fd_data
->width
,
956 fd_data
->height
, fourcc
,
979 bo
= calloc(1, sizeof *bo
);
981 dri
->image
->destroyImage(image
);
987 if (usage
& GBM_BO_USE_SCANOUT
)
988 dri_use
|= __DRI_IMAGE_USE_SCANOUT
;
989 if (usage
& GBM_BO_USE_CURSOR
)
990 dri_use
|= __DRI_IMAGE_USE_CURSOR
;
991 if (dri
->image
->base
.version
>= 2 &&
992 !dri
->image
->validateUsage(bo
->image
, dri_use
)) {
994 dri
->image
->destroyImage(bo
->image
);
1000 bo
->base
.format
= gbm_format
;
1002 dri
->image
->queryImage(bo
->image
, __DRI_IMAGE_ATTRIB_WIDTH
,
1003 (int*)&bo
->base
.width
);
1004 dri
->image
->queryImage(bo
->image
, __DRI_IMAGE_ATTRIB_HEIGHT
,
1005 (int*)&bo
->base
.height
);
1006 dri
->image
->queryImage(bo
->image
, __DRI_IMAGE_ATTRIB_STRIDE
,
1007 (int*)&bo
->base
.stride
);
1008 dri
->image
->queryImage(bo
->image
, __DRI_IMAGE_ATTRIB_HANDLE
,
1009 &bo
->base
.handle
.s32
);
1015 is_planar_format(uint32_t format
)
1018 case GBM_FORMAT_NV12
:
1019 case GBM_FORMAT_NV21
:
1020 case GBM_FORMAT_NV16
:
1021 case GBM_FORMAT_NV61
:
1022 case GBM_FORMAT_YUV410
:
1023 case GBM_FORMAT_YVU410
:
1024 case GBM_FORMAT_YUV411
:
1025 case GBM_FORMAT_YVU411
:
1026 case GBM_FORMAT_YUV420
:
1027 case GBM_FORMAT_YVU420
:
1028 case GBM_FORMAT_YUV422
:
1029 case GBM_FORMAT_YVU422
:
1030 case GBM_FORMAT_YUV444
:
1031 case GBM_FORMAT_YVU444
:
1039 static struct gbm_bo
*
1040 create_dumb(struct gbm_device
*gbm
,
1041 uint32_t width
, uint32_t height
,
1042 uint32_t format
, uint32_t usage
)
1044 struct gbm_dri_device
*dri
= gbm_dri_device(gbm
);
1045 struct drm_mode_create_dumb create_arg
;
1046 struct gbm_dri_bo
*bo
;
1047 struct drm_mode_destroy_dumb destroy_arg
;
1049 int is_cursor
, is_scanout
;
1051 is_cursor
= (usage
& GBM_BO_USE_CURSOR
) != 0 &&
1052 format
== GBM_FORMAT_ARGB8888
;
1053 is_scanout
= (usage
& GBM_BO_USE_SCANOUT
) != 0 &&
1054 (format
== GBM_FORMAT_XRGB8888
|| format
== GBM_FORMAT_XBGR8888
);
1055 if (!is_cursor
&& !is_scanout
) {
1060 if (is_planar_format(format
)) {
1065 bo
= calloc(1, sizeof *bo
);
1069 memset(&create_arg
, 0, sizeof(create_arg
));
1070 create_arg
.bpp
= 32;
1071 create_arg
.width
= width
;
1072 create_arg
.height
= height
;
1074 ret
= drmIoctl(dri
->base
.fd
, DRM_IOCTL_MODE_CREATE_DUMB
, &create_arg
);
1079 bo
->base
.width
= width
;
1080 bo
->base
.height
= height
;
1081 bo
->base
.stride
= create_arg
.pitch
;
1082 bo
->base
.format
= format
;
1083 bo
->base
.handle
.u32
= create_arg
.handle
;
1084 bo
->handle
= create_arg
.handle
;
1085 bo
->size
= create_arg
.size
;
1087 if (gbm_dri_bo_map_dumb(bo
) == NULL
)
1093 memset(&destroy_arg
, 0, sizeof destroy_arg
);
1094 destroy_arg
.handle
= create_arg
.handle
;
1095 drmIoctl(dri
->base
.fd
, DRM_IOCTL_MODE_DESTROY_DUMB
, &destroy_arg
);
1102 static struct gbm_bo
*
1103 gbm_dri_bo_create(struct gbm_device
*gbm
,
1104 uint32_t width
, uint32_t height
,
1105 uint32_t format
, uint32_t usage
,
1106 const uint64_t *modifiers
,
1107 const unsigned int count
)
1109 struct gbm_dri_device
*dri
= gbm_dri_device(gbm
);
1110 struct gbm_dri_bo
*bo
;
1112 unsigned dri_use
= 0;
1114 /* Callers of this may specify a modifier, or a dri usage, but not both. The
1115 * newer modifier interface deprecates the older usage flags.
1117 assert(!(usage
&& count
));
1119 format
= gbm_format_canonicalize(format
);
1121 if (usage
& GBM_BO_USE_WRITE
|| dri
->image
== NULL
)
1122 return create_dumb(gbm
, width
, height
, format
, usage
);
1124 bo
= calloc(1, sizeof *bo
);
1129 bo
->base
.width
= width
;
1130 bo
->base
.height
= height
;
1131 bo
->base
.format
= format
;
1133 dri_format
= gbm_format_to_dri_format(format
);
1134 if (dri_format
== 0) {
1139 if (usage
& GBM_BO_USE_SCANOUT
)
1140 dri_use
|= __DRI_IMAGE_USE_SCANOUT
;
1141 if (usage
& GBM_BO_USE_CURSOR
)
1142 dri_use
|= __DRI_IMAGE_USE_CURSOR
;
1143 if (usage
& GBM_BO_USE_LINEAR
)
1144 dri_use
|= __DRI_IMAGE_USE_LINEAR
;
1146 /* Gallium drivers requires shared in order to get the handle/stride */
1147 dri_use
|= __DRI_IMAGE_USE_SHARE
;
1150 if (!dri
->image
|| dri
->image
->base
.version
< 14 ||
1151 !dri
->image
->createImageWithModifiers
) {
1152 fprintf(stderr
, "Modifiers specified, but DRI is too old\n");
1157 /* It's acceptable to create an image with INVALID modifier in the list,
1158 * but it cannot be on the only modifier (since it will certainly fail
1159 * later). While we could easily catch this after modifier creation, doing
1160 * the check here is a convenient debug check likely pointing at whatever
1161 * interface the client is using to build its modifier list.
1163 if (count
== 1 && modifiers
[0] == DRM_FORMAT_MOD_INVALID
) {
1164 fprintf(stderr
, "Only invalid modifier specified\n");
1170 dri
->image
->createImageWithModifiers(dri
->screen
,
1177 /* The client passed in a list of invalid modifiers */
1178 assert(gbm_dri_bo_get_modifier(&bo
->base
) != DRM_FORMAT_MOD_INVALID
);
1181 bo
->image
= dri
->image
->createImage(dri
->screen
, width
, height
,
1182 dri_format
, dri_use
, bo
);
1185 if (bo
->image
== NULL
)
1188 dri
->image
->queryImage(bo
->image
, __DRI_IMAGE_ATTRIB_HANDLE
,
1189 &bo
->base
.handle
.s32
);
1190 dri
->image
->queryImage(bo
->image
, __DRI_IMAGE_ATTRIB_STRIDE
,
1191 (int *) &bo
->base
.stride
);
1201 gbm_dri_bo_map(struct gbm_bo
*_bo
,
1202 uint32_t x
, uint32_t y
,
1203 uint32_t width
, uint32_t height
,
1204 uint32_t flags
, uint32_t *stride
, void **map_data
)
1206 struct gbm_dri_device
*dri
= gbm_dri_device(_bo
->gbm
);
1207 struct gbm_dri_bo
*bo
= gbm_dri_bo(_bo
);
1209 /* If it's a dumb buffer, we already have a mapping */
1211 *map_data
= (char *)bo
->map
+ (bo
->base
.stride
* y
) + (x
* 4);
1212 *stride
= bo
->base
.stride
;
1216 if (!dri
->image
|| dri
->image
->base
.version
< 12 || !dri
->image
->mapImage
) {
1221 mtx_lock(&dri
->mutex
);
1223 dri
->context
= dri
->dri2
->createNewContext(dri
->screen
, NULL
,
1225 assert(dri
->context
);
1226 mtx_unlock(&dri
->mutex
);
1228 /* GBM flags and DRI flags are the same, so just pass them on */
1229 return dri
->image
->mapImage(dri
->context
, bo
->image
, x
, y
,
1230 width
, height
, flags
, (int *)stride
,
1235 gbm_dri_bo_unmap(struct gbm_bo
*_bo
, void *map_data
)
1237 struct gbm_dri_device
*dri
= gbm_dri_device(_bo
->gbm
);
1238 struct gbm_dri_bo
*bo
= gbm_dri_bo(_bo
);
1240 /* Check if it's a dumb buffer and check the pointer is in range */
1242 assert(map_data
>= bo
->map
);
1243 assert(map_data
< (bo
->map
+ bo
->size
));
1247 if (!dri
->context
|| !dri
->image
||
1248 dri
->image
->base
.version
< 12 || !dri
->image
->unmapImage
)
1251 dri
->image
->unmapImage(dri
->context
, bo
->image
, map_data
);
1254 * Not all DRI drivers use direct maps. They may queue up DMA operations
1255 * on the mapping context. Since there is no explicit gbm flush
1256 * mechanism, we need to flush here.
1258 if (dri
->flush
->base
.version
>= 4)
1259 dri
->flush
->flush_with_flags(dri
->context
, NULL
, __DRI2_FLUSH_CONTEXT
, 0);
1263 static struct gbm_surface
*
1264 gbm_dri_surface_create(struct gbm_device
*gbm
,
1265 uint32_t width
, uint32_t height
,
1266 uint32_t format
, uint32_t flags
,
1267 const uint64_t *modifiers
, const unsigned count
)
1269 struct gbm_dri_device
*dri
= gbm_dri_device(gbm
);
1270 struct gbm_dri_surface
*surf
;
1273 (!dri
->image
|| dri
->image
->base
.version
< 14 ||
1274 !dri
->image
->createImageWithModifiers
)) {
1282 /* It's acceptable to create an image with INVALID modifier in the list,
1283 * but it cannot be on the only modifier (since it will certainly fail
1284 * later). While we could easily catch this after modifier creation, doing
1285 * the check here is a convenient debug check likely pointing at whatever
1286 * interface the client is using to build its modifier list.
1288 if (count
== 1 && modifiers
[0] == DRM_FORMAT_MOD_INVALID
) {
1289 fprintf(stderr
, "Only invalid modifier specified\n");
1293 surf
= calloc(1, sizeof *surf
);
1299 surf
->base
.gbm
= gbm
;
1300 surf
->base
.width
= width
;
1301 surf
->base
.height
= height
;
1302 surf
->base
.format
= gbm_format_canonicalize(format
);
1303 surf
->base
.flags
= flags
;
1309 surf
->base
.modifiers
= calloc(count
, sizeof(*modifiers
));
1310 if (count
&& !surf
->base
.modifiers
) {
1316 /* TODO: We are deferring validation of modifiers until the image is actually
1317 * created. This deferred creation can fail due to a modifier-format
1318 * mismatch. The result is the client has a surface but no object to back it.
1320 surf
->base
.count
= count
;
1321 memcpy(surf
->base
.modifiers
, modifiers
, count
* sizeof(*modifiers
));
1327 gbm_dri_surface_destroy(struct gbm_surface
*_surf
)
1329 struct gbm_dri_surface
*surf
= gbm_dri_surface(_surf
);
1331 free(surf
->base
.modifiers
);
1336 dri_destroy(struct gbm_device
*gbm
)
1338 struct gbm_dri_device
*dri
= gbm_dri_device(gbm
);
1342 dri
->core
->destroyContext(dri
->context
);
1344 dri
->core
->destroyScreen(dri
->screen
);
1345 for (i
= 0; dri
->driver_configs
[i
]; i
++)
1346 free((__DRIconfig
*) dri
->driver_configs
[i
]);
1347 free(dri
->driver_configs
);
1348 dlclose(dri
->driver
);
1349 free(dri
->driver_name
);
1354 static struct gbm_device
*
1355 dri_device_create(int fd
)
1357 struct gbm_dri_device
*dri
;
1360 dri
= calloc(1, sizeof *dri
);
1365 dri
->base
.bo_create
= gbm_dri_bo_create
;
1366 dri
->base
.bo_import
= gbm_dri_bo_import
;
1367 dri
->base
.bo_map
= gbm_dri_bo_map
;
1368 dri
->base
.bo_unmap
= gbm_dri_bo_unmap
;
1369 dri
->base
.is_format_supported
= gbm_dri_is_format_supported
;
1370 dri
->base
.bo_write
= gbm_dri_bo_write
;
1371 dri
->base
.bo_get_fd
= gbm_dri_bo_get_fd
;
1372 dri
->base
.bo_get_planes
= gbm_dri_bo_get_planes
;
1373 dri
->base
.bo_get_handle
= gbm_dri_bo_get_handle_for_plane
;
1374 dri
->base
.bo_get_stride
= gbm_dri_bo_get_stride
;
1375 dri
->base
.bo_get_offset
= gbm_dri_bo_get_offset
;
1376 dri
->base
.bo_get_modifier
= gbm_dri_bo_get_modifier
;
1377 dri
->base
.bo_destroy
= gbm_dri_bo_destroy
;
1378 dri
->base
.destroy
= dri_destroy
;
1379 dri
->base
.surface_create
= gbm_dri_surface_create
;
1380 dri
->base
.surface_destroy
= gbm_dri_surface_destroy
;
1382 dri
->base
.name
= "drm";
1384 mtx_init(&dri
->mutex
, mtx_plain
);
1386 force_sw
= getenv("GBM_ALWAYS_SOFTWARE") != NULL
;
1388 ret
= dri_screen_create(dri
);
1390 ret
= dri_screen_create_sw(dri
);
1392 ret
= dri_screen_create_sw(dri
);
1406 struct gbm_backend gbm_dri_backend
= {
1407 .backend_name
= "dri",
1408 .create_device
= dri_device_create
,