summaryrefslogtreecommitdiff
path: root/drv.h
blob: ff33c92ace577946e779011796392f26167ad12b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/*
 * 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')

struct driver;
struct bo;

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);

int
drv_is_combination_supported(struct driver *drv, uint32_t format,
			     uint64_t usage, uint64_t modifier);

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