Commit f9567ab4 authored by Ben Widawsky's avatar Ben Widawsky

gbm: Export a getter for per plane handles

v2: Make the error return be -1 instead of 0 because I think 0 is
actually valid.

v3: Set errno to EINVAL when the specified plane is above the total
planes. (Jason Ekstrand)
Return the bo's handle if there is no image ie. for dumb images like cursor (Daniel)

- Add assertions about plane == 0 (Jason)
- Add a comment about new restriction on planar dumb bo which is not an
earlier patch in the series.
- Correctly refactor from v2 in this patch; it ended up rebased into the
wrong patch.
Signed-off-by: Ben Widawsky's avatarBen Widawsky <>
Reviewed-by: Jason Ekstrand's avatarJason Ekstrand <>
Acked-by: Daniel Stone's avatarDaniel Stone <>
parent 42eacddf
......@@ -625,6 +625,43 @@ gbm_dri_bo_get_planes(struct gbm_bo *_bo)
return get_number_planes(dri, bo->image);
static union gbm_bo_handle
gbm_dri_bo_get_handle_for_plane(struct gbm_bo *_bo, int plane)
struct gbm_dri_device *dri = gbm_dri_device(_bo->gbm);
struct gbm_dri_bo *bo = gbm_dri_bo(_bo);
union gbm_bo_handle ret;
ret.s32 = -1;
if (!dri->image || dri->image->base.version < 13 || !dri->image->fromPlanar) {
errno = ENOSYS;
return ret;
if (plane >= get_number_planes(dri, bo->image)) {
errno = EINVAL;
return ret;
/* dumb BOs can only utilize non-planar formats */
if (!bo->image) {
assert(plane == 0);
ret.s32 = bo->handle;
return ret;
__DRIimage *image = dri->image->fromPlanar(bo->image, plane, NULL);
if (image) {
dri->image->queryImage(image, __DRI_IMAGE_ATTRIB_HANDLE, &ret.s32);
} else {
assert(plane == 0);
dri->image->queryImage(bo->image, __DRI_IMAGE_ATTRIB_HANDLE, &ret.s32);
return ret;
static void
gbm_dri_bo_destroy(struct gbm_bo *_bo)
......@@ -1118,6 +1155,7 @@ dri_device_create(int fd)
dri->base.base.bo_write = gbm_dri_bo_write;
dri->base.base.bo_get_fd = gbm_dri_bo_get_fd;
dri->base.base.bo_get_planes = gbm_dri_bo_get_planes;
dri->base.base.bo_get_handle = gbm_dri_bo_get_handle_for_plane;
dri->base.base.bo_destroy = gbm_dri_bo_destroy;
dri->base.base.destroy = dri_destroy;
dri->base.base.surface_create = gbm_dri_surface_create;
......@@ -19,6 +19,7 @@ gbm_bo_get_device
......@@ -234,6 +234,24 @@ gbm_bo_get_plane_count(struct gbm_bo *bo)
return bo->gbm->bo_get_planes(bo);
/** Get the handle for the specified plane of the buffer object
* This function gets the handle for any plane associated with the BO. When
* dealing with multi-planar formats, or formats which might have implicit
* planes based on different underlying hardware it is necessary for the client
* to be able to get this information to pass to the DRM.
* \param bo The buffer object
* \param plane the plane to get a handle for
* \sa gbm_bo_get_handle()
GBM_EXPORT union gbm_bo_handle
gbm_bo_get_handle_for_plane(struct gbm_bo *bo, int plane)
return bo->gbm->bo_get_handle(bo, plane);
/** Write data into the buffer object
* If the buffer object was created with the GBM_BO_USE_WRITE flag,
......@@ -318,6 +318,9 @@ gbm_bo_get_fd(struct gbm_bo *bo);
gbm_bo_get_plane_count(struct gbm_bo *bo);
union gbm_bo_handle
gbm_bo_get_handle_for_plane(struct gbm_bo *bo, int plane);
gbm_bo_write(struct gbm_bo *bo, const void *buf, size_t count);
......@@ -77,6 +77,7 @@ struct gbm_device {
int (*bo_write)(struct gbm_bo *bo, const void *buf, size_t data);
int (*bo_get_fd)(struct gbm_bo *bo);
int (*bo_get_planes)(struct gbm_bo *bo);
union gbm_bo_handle (*bo_get_handle)(struct gbm_bo *bo, int plane);
void (*bo_destroy)(struct gbm_bo *bo);
struct gbm_surface *(*surface_create)(struct gbm_device *gbm,
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment