drv.h

/*
 * Copyright 2016 The Chromium OS Authors. All rights reserved.
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

#ifndef DRV_H_
#define DRV_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <drm_fourcc.h>
#include <stdint.h>

#define DRV_MAX_PLANES 4

/* Use flags */
#define BO_USE_NONE			0
#define BO_USE_SCANOUT			(1ull << 0)
#define BO_USE_CURSOR			(1ull << 1)
#define BO_USE_CURSOR_64X64		BO_USE_CURSOR
#define BO_USE_RENDERING		(1ull << 2)
#define BO_USE_LINEAR			(1ull << 3)
#define BO_USE_SW_READ_NEVER		(1ull << 4)
#define BO_USE_SW_READ_RARELY		(1ull << 5)
#define BO_USE_SW_READ_OFTEN		(1ull << 6)
#define BO_USE_SW_WRITE_NEVER		(1ull << 7)
#define BO_USE_SW_WRITE_RARELY		(1ull << 8)
#define BO_USE_SW_WRITE_OFTEN		(1ull << 9)
#define BO_USE_EXTERNAL_DISP		(1ull << 10)
#define BO_USE_PROTECTED		(1ull << 11)
#define BO_USE_HW_VIDEO_ENCODER		(1ull << 12)
#define BO_USE_HW_CAMERA_WRITE		(1ull << 13)
#define BO_USE_HW_CAMERA_READ		(1ull << 14)
#define BO_USE_HW_CAMERA_ZSL		(1ull << 15)
#define BO_USE_RENDERSCRIPT		(1ull << 16)
#define BO_USE_TEXTURE			(1ull << 17)

/* This is our extension to <drm_fourcc.h>.  We need to make sure we don't step
 * on the namespace of already defined formats, which can be done by using invalid
 * fourcc codes.
 */

#define DRM_FORMAT_NONE				fourcc_code('0', '0', '0', '0')
#define DRM_FORMAT_FLEX_IMPLEMENTATION_DEFINED	fourcc_code('9', '9', '9', '8')
#define DRM_FORMAT_FLEX_YCbCr_420_888		fourcc_code('9', '9', '9', '9')

#define BO_COMMON_USE_MASK BO_USE_LINEAR | BO_USE_RENDERING | \
			   BO_USE_SW_READ_OFTEN | BO_USE_SW_WRITE_OFTEN | \
			   BO_USE_SW_READ_RARELY | BO_USE_SW_WRITE_RARELY | \
			   BO_USE_TEXTURE
struct driver;
struct bo;
struct combination;

union bo_handle {
	void *ptr;
	int32_t s32;
	uint32_t u32;
	int64_t s64;
	uint64_t u64;
};

struct drv_import_fd_data {
	int fds[DRV_MAX_PLANES];
	uint32_t strides[DRV_MAX_PLANES];
	uint32_t offsets[DRV_MAX_PLANES];
	uint32_t sizes[DRV_MAX_PLANES];
	uint64_t format_modifiers[DRV_MAX_PLANES];
	uint32_t width;
	uint32_t height;
	uint32_t format;
};

struct driver *
drv_create(int fd);

void
drv_destroy(struct driver *drv);

int
drv_get_fd(struct driver *drv);

const char *
drv_get_name(struct driver *drv);

struct combination *
drv_get_combination(struct driver *drv, uint32_t format, uint64_t usage);

struct bo *
drv_bo_new(struct driver *drv, uint32_t width, uint32_t height,
	   uint32_t format);

struct bo *
drv_bo_create(struct driver *drv, uint32_t width, uint32_t height,
	      uint32_t format, uint64_t flags);

struct bo *
drv_bo_create_with_modifiers(struct driver *drv,
			     uint32_t width, uint32_t height,
			     uint32_t format,
			     const uint64_t *modifiers, uint32_t count);

void
drv_bo_destroy(struct bo *bo);

struct bo *
drv_bo_import(struct driver *drv, struct drv_import_fd_data *data);

void *
drv_bo_map(struct bo *bo, uint32_t x, uint32_t y, uint32_t width,
	   uint32_t height, uint32_t flags, void **map_data, size_t plane);

int
drv_bo_unmap(struct bo *bo, void *map_data);

uint32_t
drv_bo_get_width(struct bo *bo);

uint32_t
drv_bo_get_height(struct bo *bo);

uint32_t
drv_bo_get_stride_or_tiling(struct bo *bo);

size_t
drv_bo_get_num_planes(struct bo *bo);

union bo_handle
drv_bo_get_plane_handle(struct bo *bo, size_t plane);

int
drv_bo_get_plane_fd(struct bo *bo, size_t plane);

uint32_t
drv_bo_get_plane_offset(struct bo *bo, size_t plane);

uint32_t
drv_bo_get_plane_size(struct bo *bo, size_t plane);

uint32_t
drv_bo_get_plane_stride(struct bo *bo, size_t plane);

uint64_t
drv_bo_get_plane_format_modifier(struct bo *bo, size_t plane);

uint32_t
drv_bo_get_format(struct bo *bo);

uint32_t
drv_resolve_format(struct driver *drv, uint32_t format);

int
drv_stride_from_format(uint32_t format, uint32_t width, size_t plane);

size_t
drv_num_planes_from_format(uint32_t format);

uint32_t
drv_size_from_format(uint32_t format, uint32_t stride, uint32_t height,
		     size_t plane);

uint32_t
drv_num_buffers_per_bo(struct bo *bo);

#ifdef __cplusplus
}
#endif

#endif