xref: /third_party/mesa3d/src/drm-shim/drm_shim.h (revision bf215546) 
1/*
2 * Copyright © 2018 Broadcom
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 */
23
24#include <c11/threads.h>
25
26#include "util/macros.h"
27#include "util/hash_table.h"
28#include "util/vma.h"
29
30#include <xf86drm.h>
31
32#ifdef __linux__
33#define DRM_MAJOR 226
34#endif
35
36typedef int (*ioctl_fn_t)(int fd, unsigned long request, void *arg);
37
38struct shim_bo;
39
40struct shim_device {
41   /* Mapping from int fd to struct shim_fd *. */
42   struct hash_table *fd_map;
43
44   /* Mapping from mmap offset to shim_bo */
45   struct hash_table_u64 *offset_map;
46
47   mtx_t mem_lock;
48   /* Heap from which shim_bo are allocated */
49   struct util_vma_heap mem_heap;
50
51   int mem_fd;
52
53   int (**driver_ioctls)(int fd, unsigned long request, void *arg);
54   int driver_ioctl_count;
55
56   void (*driver_bo_free)(struct shim_bo *bo);
57
58   /* Returned by drmGetVersion(). */
59   const char *driver_name;
60
61   /* Returned by drmGetBusid(). */
62   const char *unique;
63
64   int version_major, version_minor, version_patchlevel;
65   int bus_type;
66};
67
68extern struct shim_device shim_device;
69
70struct shim_fd {
71   int fd;
72   int refcount;
73   mtx_t handle_lock;
74   /* mapping from int gem handle to struct shim_bo *. */
75   struct hash_table *handles;
76};
77
78struct shim_bo {
79   uint64_t mem_addr;
80   void *map;
81   int refcount;
82   uint32_t size;
83};
84
85/* Core support. */
86extern int render_node_minor;
87void drm_shim_device_init(void);
88void drm_shim_override_file(const char *contents,
89                            const char *path_format, ...) PRINTFLIKE(2, 3);
90void drm_shim_fd_register(int fd, struct shim_fd *shim_fd);
91void drm_shim_fd_unregister(int fd);
92struct shim_fd *drm_shim_fd_lookup(int fd);
93int drm_shim_ioctl(int fd, unsigned long request, void *arg);
94void *drm_shim_mmap(struct shim_fd *shim_fd, size_t length, int prot, int flags,
95                    int fd, off64_t offset);
96
97int drm_shim_bo_init(struct shim_bo *bo, size_t size);
98void drm_shim_bo_get(struct shim_bo *bo);
99void drm_shim_bo_put(struct shim_bo *bo);
100struct shim_bo *drm_shim_bo_lookup(struct shim_fd *shim_fd, int handle);
101int drm_shim_bo_get_handle(struct shim_fd *shim_fd, struct shim_bo *bo);
102uint64_t drm_shim_bo_get_mmap_offset(struct shim_fd *shim_fd,
103                                     struct shim_bo *bo);
104
105/* driver-specific hooks. */
106void drm_shim_driver_init(void);
107extern bool drm_shim_driver_prefers_new_render_node;
108