blob: d27e84590981c6cf1bf66103ed42dc0ed801511f [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 Singh1b1d56a2017-03-10 16:25:23 -080019// clang-format off
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070020/* Use flags */
Gurchetan Singh458976f2016-11-23 17:32:33 -080021#define BO_USE_NONE 0
22#define BO_USE_SCANOUT (1ull << 0)
23#define BO_USE_CURSOR (1ull << 1)
24#define BO_USE_CURSOR_64X64 BO_USE_CURSOR
25#define BO_USE_RENDERING (1ull << 2)
26#define BO_USE_LINEAR (1ull << 3)
27#define BO_USE_SW_READ_NEVER (1ull << 4)
28#define BO_USE_SW_READ_RARELY (1ull << 5)
29#define BO_USE_SW_READ_OFTEN (1ull << 6)
30#define BO_USE_SW_WRITE_NEVER (1ull << 7)
31#define BO_USE_SW_WRITE_RARELY (1ull << 8)
32#define BO_USE_SW_WRITE_OFTEN (1ull << 9)
33#define BO_USE_EXTERNAL_DISP (1ull << 10)
34#define BO_USE_PROTECTED (1ull << 11)
35#define BO_USE_HW_VIDEO_ENCODER (1ull << 12)
Tomasz Figafd0b0162017-07-11 18:28:02 +090036#define BO_USE_CAMERA_WRITE (1ull << 13)
37#define BO_USE_CAMERA_READ (1ull << 14)
Gurchetan Singh458976f2016-11-23 17:32:33 -080038#define BO_USE_RENDERSCRIPT (1ull << 16)
Gurchetan Singh2a30f8a2017-03-02 09:48:49 -080039#define BO_USE_TEXTURE (1ull << 17)
Kristian H. Kristensen3cb5bba2018-04-04 16:10:42 -070040#define BO_USE_HW_VIDEO_DECODER (1ull << 18)
41
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070042
Gurchetan Singhf7f633a2017-09-28 17:02:12 -070043/* Map flags */
44#define BO_MAP_NONE 0
45#define BO_MAP_READ (1 << 0)
46#define BO_MAP_WRITE (1 << 1)
47#define BO_MAP_READ_WRITE (BO_MAP_READ | BO_MAP_WRITE)
Joe Kniss65705852017-06-29 15:02:46 -070048
Gurchetan Singhf3b22da2016-11-21 10:46:38 -080049/* This is our extension to <drm_fourcc.h>. We need to make sure we don't step
50 * on the namespace of already defined formats, which can be done by using invalid
51 * fourcc codes.
52 */
53
54#define DRM_FORMAT_NONE fourcc_code('0', '0', '0', '0')
Gurchetan Singh03f13562017-02-08 15:21:14 -080055#define DRM_FORMAT_YVU420_ANDROID fourcc_code('9', '9', '9', '7')
Gurchetan Singhf3b22da2016-11-21 10:46:38 -080056#define DRM_FORMAT_FLEX_IMPLEMENTATION_DEFINED fourcc_code('9', '9', '9', '8')
57#define DRM_FORMAT_FLEX_YCbCr_420_888 fourcc_code('9', '9', '9', '9')
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070058
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -080059// clang-format on
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070060struct driver;
61struct bo;
Gurchetan Singh6b41fb52017-03-01 20:14:39 -080062struct combination;
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070063
64union bo_handle {
Gurchetan Singhb72badb2016-08-19 16:26:46 -070065 void *ptr;
66 int32_t s32;
67 uint32_t u32;
68 int64_t s64;
69 uint64_t u64;
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070070};
71
72struct drv_import_fd_data {
Gurchetan Singhb72badb2016-08-19 16:26:46 -070073 int fds[DRV_MAX_PLANES];
74 uint32_t strides[DRV_MAX_PLANES];
75 uint32_t offsets[DRV_MAX_PLANES];
Kristian H. Kristensen33459772016-09-16 11:14:16 -070076 uint64_t format_modifiers[DRV_MAX_PLANES];
Gurchetan Singhb72badb2016-08-19 16:26:46 -070077 uint32_t width;
78 uint32_t height;
Gurchetan Singhf3b22da2016-11-21 10:46:38 -080079 uint32_t format;
Gurchetan Singha1892b22017-09-28 16:40:52 -070080 uint64_t use_flags;
Gurchetan Singh46faf6b2016-08-05 14:40:07 -070081};
82
Gurchetan Singh47e629b2017-11-02 14:07:18 -070083struct vma {
Gurchetan Singh80fc2b92017-02-14 17:47:02 -080084 void *addr;
85 size_t length;
86 uint32_t handle;
Gurchetan Singhe29a6402017-10-05 14:52:24 -070087 uint32_t map_flags;
Gurchetan Singh80fc2b92017-02-14 17:47:02 -080088 int32_t refcount;
Satyajit Sahu77b70552018-05-03 16:35:24 +053089 uint32_t map_strides[DRV_MAX_PLANES];
Gurchetan Singh80fc2b92017-02-14 17:47:02 -080090 void *priv;
91};
92
Gurchetan Singh1ef809e2017-11-06 11:07:52 -080093struct rectangle {
94 uint32_t x;
95 uint32_t y;
96 uint32_t width;
97 uint32_t height;
98};
99
Gurchetan Singh47e629b2017-11-02 14:07:18 -0700100struct mapping {
101 struct vma *vma;
Gurchetan Singh1ef809e2017-11-06 11:07:52 -0800102 struct rectangle rect;
103 uint32_t refcount;
Gurchetan Singh47e629b2017-11-02 14:07:18 -0700104};
105
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800106struct driver *drv_create(int fd);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700107
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800108void drv_destroy(struct driver *drv);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700109
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800110int drv_get_fd(struct driver *drv);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700111
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800112const char *drv_get_name(struct driver *drv);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700113
Gurchetan Singha1892b22017-09-28 16:40:52 -0700114struct combination *drv_get_combination(struct driver *drv, uint32_t format, uint64_t use_flags);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700115
Gurchetan Singh18578ed2017-08-03 18:23:27 -0700116struct bo *drv_bo_new(struct driver *drv, uint32_t width, uint32_t height, uint32_t format,
Gurchetan Singha1892b22017-09-28 16:40:52 -0700117 uint64_t use_flags);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700118
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800119struct bo *drv_bo_create(struct driver *drv, uint32_t width, uint32_t height, uint32_t format,
Gurchetan Singha1892b22017-09-28 16:40:52 -0700120 uint64_t use_flags);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700121
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800122struct bo *drv_bo_create_with_modifiers(struct driver *drv, uint32_t width, uint32_t height,
123 uint32_t format, const uint64_t *modifiers, uint32_t count);
Kristian H. Kristensenb1efbd82016-09-06 11:43:26 -0700124
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800125void drv_bo_destroy(struct bo *bo);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700126
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800127struct bo *drv_bo_import(struct driver *drv, struct drv_import_fd_data *data);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700128
Gurchetan Singh1ef809e2017-11-06 11:07:52 -0800129void *drv_bo_map(struct bo *bo, const struct rectangle *rect, uint32_t map_flags,
130 struct mapping **map_data, size_t plane);
Gurchetan Singh1a31e602016-10-06 10:58:00 -0700131
Gurchetan Singh47e629b2017-11-02 14:07:18 -0700132int drv_bo_unmap(struct bo *bo, struct mapping *mapping);
Gurchetan Singhff741412017-09-13 17:54:36 -0700133
Gurchetan Singh47e629b2017-11-02 14:07:18 -0700134int drv_bo_invalidate(struct bo *bo, struct mapping *mapping);
Gurchetan Singhc2ad63e2017-10-09 17:59:47 -0700135
Gurchetan Singhbd1b1b52018-03-29 16:34:53 -0700136int drv_bo_flush_or_unmap(struct bo *bo, struct mapping *mapping);
Gurchetan Singh1a31e602016-10-06 10:58:00 -0700137
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800138uint32_t drv_bo_get_width(struct bo *bo);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700139
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800140uint32_t drv_bo_get_height(struct bo *bo);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700141
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800142uint32_t drv_bo_get_stride_or_tiling(struct bo *bo);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700143
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800144size_t drv_bo_get_num_planes(struct bo *bo);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700145
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800146union bo_handle drv_bo_get_plane_handle(struct bo *bo, size_t plane);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700147
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800148int drv_bo_get_plane_fd(struct bo *bo, size_t plane);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700149
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800150uint32_t drv_bo_get_plane_offset(struct bo *bo, size_t plane);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700151
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800152uint32_t drv_bo_get_plane_size(struct bo *bo, size_t plane);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700153
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800154uint32_t drv_bo_get_plane_stride(struct bo *bo, size_t plane);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700155
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800156uint64_t drv_bo_get_plane_format_modifier(struct bo *bo, size_t plane);
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700157
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800158uint32_t drv_bo_get_format(struct bo *bo);
Gurchetan Singh2e786ad2016-08-24 18:31:23 -0700159
Kristian H. Kristensen22291902018-04-04 13:40:47 -0700160uint32_t drv_bytes_per_pixel_from_format(uint32_t format, size_t plane);
Gurchetan Singh6423ecb2017-03-29 08:23:40 -0700161
Gurchetan Singh1ef809e2017-11-06 11:07:52 -0800162uint32_t drv_stride_from_format(uint32_t format, uint32_t width, size_t plane);
163
Gurchetan Singha1892b22017-09-28 16:40:52 -0700164uint32_t drv_resolve_format(struct driver *drv, uint32_t format, uint64_t use_flags);
Gurchetan Singhbfba8c22016-08-16 17:57:10 -0700165
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800166size_t drv_num_planes_from_format(uint32_t format);
Gurchetan Singh2a119342016-11-02 10:40:51 -0700167
Gurchetan Singh1b1d56a2017-03-10 16:25:23 -0800168uint32_t drv_num_buffers_per_bo(struct bo *bo);
Gurchetan Singh2e786ad2016-08-24 18:31:23 -0700169
Alistair Strachan0cfaaa52018-03-19 14:03:23 -0700170#define drv_log(format, ...) \
171 do { \
172 drv_log_prefix("minigbm", __FILE__, __LINE__, format, ##__VA_ARGS__); \
173 } while (0)
174
175__attribute__((format(printf, 4, 5))) void drv_log_prefix(const char *prefix, const char *file,
176 int line, const char *format, ...);
177
Gurchetan Singh46faf6b2016-08-05 14:40:07 -0700178#ifdef __cplusplus
179}
180#endif
181
182#endif