blob: 62fc0d298abb3ed605ce1c0ecfaf1aa0418e630c [file] [log] [blame]
Gurchetan Singh46faf6b2016-08-05 14:40:07 -07001/*
Daniele Castagna7a755de2016-12-16 17:32:30 -05002 * Copyright 2016 The Chromium OS Authors. All rights reserved.
Gurchetan Singh46faf6b2016-08-05 14:40:07 -07003 * Use of this source code is governed by a BSD-style license that can be
4 * found in the LICENSE file.
5 */
6
7#ifndef DRV_H_
8#define DRV_H_
9
10#ifdef __cplusplus
11extern "C" {
12#endif
13
Gurchetan Singhf3b22da2016-11-21 10:46:38 -080014#include <drm_fourcc.h>
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070015#include <stdint.h>
16
17#define DRV_MAX_PLANES 4
18
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070019/* Use flags */
Gurchetan Singh458976f2016-11-23 17:32:33 -080020#define BO_USE_NONE 0
21#define BO_USE_SCANOUT (1ull << 0)
22#define BO_USE_CURSOR (1ull << 1)
23#define BO_USE_CURSOR_64X64 BO_USE_CURSOR
24#define BO_USE_RENDERING (1ull << 2)
25#define BO_USE_LINEAR (1ull << 3)
26#define BO_USE_SW_READ_NEVER (1ull << 4)
27#define BO_USE_SW_READ_RARELY (1ull << 5)
28#define BO_USE_SW_READ_OFTEN (1ull << 6)
29#define BO_USE_SW_WRITE_NEVER (1ull << 7)
30#define BO_USE_SW_WRITE_RARELY (1ull << 8)
31#define BO_USE_SW_WRITE_OFTEN (1ull << 9)
32#define BO_USE_EXTERNAL_DISP (1ull << 10)
33#define BO_USE_PROTECTED (1ull << 11)
34#define BO_USE_HW_VIDEO_ENCODER (1ull << 12)
35#define BO_USE_HW_CAMERA_WRITE (1ull << 13)
36#define BO_USE_HW_CAMERA_READ (1ull << 14)
37#define BO_USE_HW_CAMERA_ZSL (1ull << 15)
38#define BO_USE_RENDERSCRIPT (1ull << 16)
Gurchetan Singh2a30f8a2017-03-02 09:48:49 -080039#define BO_USE_TEXTURE (1ull << 17)
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070040
Gurchetan Singhf3b22da2016-11-21 10:46:38 -080041/* This is our extension to <drm_fourcc.h>. We need to make sure we don't step
42 * on the namespace of already defined formats, which can be done by using invalid
43 * fourcc codes.
44 */
45
46#define DRM_FORMAT_NONE fourcc_code('0', '0', '0', '0')
47#define DRM_FORMAT_FLEX_IMPLEMENTATION_DEFINED fourcc_code('9', '9', '9', '8')
48#define DRM_FORMAT_FLEX_YCbCr_420_888 fourcc_code('9', '9', '9', '9')
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070049
Gurchetan Singh6b41fb52017-03-01 20:14:39 -080050#define BO_COMMON_USE_MASK BO_USE_LINEAR | BO_USE_RENDERING | \
51 BO_USE_SW_READ_OFTEN | BO_USE_SW_WRITE_OFTEN | \
52 BO_USE_SW_READ_RARELY | BO_USE_SW_WRITE_RARELY | \
53 BO_USE_TEXTURE
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070054struct driver;
55struct bo;
Gurchetan Singh6b41fb52017-03-01 20:14:39 -080056struct combination;
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070057
58union bo_handle {
Gurchetan Singhb72badb2016-08-19 16:26:46 -070059 void *ptr;
60 int32_t s32;
61 uint32_t u32;
62 int64_t s64;
63 uint64_t u64;
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070064};
65
66struct drv_import_fd_data {
Gurchetan Singhb72badb2016-08-19 16:26:46 -070067 int fds[DRV_MAX_PLANES];
68 uint32_t strides[DRV_MAX_PLANES];
69 uint32_t offsets[DRV_MAX_PLANES];
70 uint32_t sizes[DRV_MAX_PLANES];
Kristian H. Kristensen33459772016-09-16 11:14:16 -070071 uint64_t format_modifiers[DRV_MAX_PLANES];
Gurchetan Singhb72badb2016-08-19 16:26:46 -070072 uint32_t width;
73 uint32_t height;
Gurchetan Singhf3b22da2016-11-21 10:46:38 -080074 uint32_t format;
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070075};
76
Gurchetan Singh80fc2b92017-02-14 17:47:02 -080077struct map_info {
78 void *addr;
79 size_t length;
80 uint32_t handle;
81 int32_t refcount;
82 void *priv;
83};
84
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070085struct driver *
86drv_create(int fd);
87
88void
89drv_destroy(struct driver *drv);
90
91int
92drv_get_fd(struct driver *drv);
93
94const char *
95drv_get_name(struct driver *drv);
96
Gurchetan Singh6b41fb52017-03-01 20:14:39 -080097struct combination *
98drv_get_combination(struct driver *drv, uint32_t format, uint64_t usage);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070099
100struct bo *
101drv_bo_new(struct driver *drv, uint32_t width, uint32_t height,
Gurchetan Singhf3b22da2016-11-21 10:46:38 -0800102 uint32_t format);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700103
104struct bo *
105drv_bo_create(struct driver *drv, uint32_t width, uint32_t height,
Gurchetan Singhf3b22da2016-11-21 10:46:38 -0800106 uint32_t format, uint64_t flags);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700107
Kristian H. Kristensenb1efbd82016-09-06 11:43:26 -0700108struct bo *
109drv_bo_create_with_modifiers(struct driver *drv,
110 uint32_t width, uint32_t height,
111 uint32_t format,
112 const uint64_t *modifiers, uint32_t count);
113
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700114void
115drv_bo_destroy(struct bo *bo);
116
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700117struct bo *
118drv_bo_import(struct driver *drv, struct drv_import_fd_data *data);
119
Gurchetan Singh1a31e602016-10-06 10:58:00 -0700120void *
121drv_bo_map(struct bo *bo, uint32_t x, uint32_t y, uint32_t width,
Gurchetan Singh80fc2b92017-02-14 17:47:02 -0800122 uint32_t height, uint32_t flags, struct map_info **map_data,
123 size_t plane);
Gurchetan Singh1a31e602016-10-06 10:58:00 -0700124
125int
Gurchetan Singh80fc2b92017-02-14 17:47:02 -0800126drv_bo_unmap(struct bo *bo, struct map_info *map_data);
Gurchetan Singh1a31e602016-10-06 10:58:00 -0700127
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700128uint32_t
129drv_bo_get_width(struct bo *bo);
130
131uint32_t
132drv_bo_get_height(struct bo *bo);
133
134uint32_t
135drv_bo_get_stride_or_tiling(struct bo *bo);
136
137size_t
138drv_bo_get_num_planes(struct bo *bo);
139
140union bo_handle
141drv_bo_get_plane_handle(struct bo *bo, size_t plane);
142
143int
144drv_bo_get_plane_fd(struct bo *bo, size_t plane);
145
146uint32_t
147drv_bo_get_plane_offset(struct bo *bo, size_t plane);
148
149uint32_t
150drv_bo_get_plane_size(struct bo *bo, size_t plane);
151
152uint32_t
153drv_bo_get_plane_stride(struct bo *bo, size_t plane);
154
155uint64_t
156drv_bo_get_plane_format_modifier(struct bo *bo, size_t plane);
157
Gurchetan Singhf3b22da2016-11-21 10:46:38 -0800158uint32_t
Gurchetan Singh2e786ad2016-08-24 18:31:23 -0700159drv_bo_get_format(struct bo *bo);
160
Gurchetan Singhf3b22da2016-11-21 10:46:38 -0800161uint32_t
162drv_resolve_format(struct driver *drv, uint32_t format);
Gurchetan Singhbfba8c22016-08-16 17:57:10 -0700163
Gurchetan Singh2e786ad2016-08-24 18:31:23 -0700164int
165drv_stride_from_format(uint32_t format, uint32_t width, size_t plane);
166
Gurchetan Singh2a119342016-11-02 10:40:51 -0700167size_t
168drv_num_planes_from_format(uint32_t format);
169
170uint32_t
Gurchetan Singhf3b22da2016-11-21 10:46:38 -0800171drv_size_from_format(uint32_t format, uint32_t stride, uint32_t height,
Gurchetan Singh2a119342016-11-02 10:40:51 -0700172 size_t plane);
173
Gurchetan Singh2e786ad2016-08-24 18:31:23 -0700174uint32_t
175drv_num_buffers_per_bo(struct bo *bo);
176
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700177#ifdef __cplusplus
178}
179#endif
180
181#endif