v3d: Introduce a DRM shim for calling out to the simulator.
[mesa.git] / src / drm-shim / drm_shim.h
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 "util/macros.h"
25 #include "util/hash_table.h"
26
27 #ifdef __linux__
28 #define DRM_MAJOR 226
29 #endif
30
31 typedef int (*ioctl_fn_t)(int fd, unsigned long request, void *arg);
32
33 struct shim_bo;
34
35 struct shim_device {
36 /* Mapping from int fd to struct shim_fd *. */
37 struct hash_table *fd_map;
38
39 int (**driver_ioctls)(int fd, unsigned long request, void *arg);
40 int driver_ioctl_count;
41
42 void (*driver_bo_free)(struct shim_bo *bo);
43
44 /* Returned by drmGetVersion(). */
45 const char *driver_name;
46 };
47
48 extern struct shim_device shim_device;
49
50 struct shim_fd {
51 int fd;
52 /* mapping from int gem handle to struct shim_bo *. */
53 struct hash_table *handles;
54 };
55
56 struct shim_bo {
57 int fd;
58 void *map;
59 int refcount;
60 uint32_t size;
61 };
62
63 /* Core support. */
64 extern int render_node_minor;
65 void drm_shim_device_init(void);
66 void drm_shim_override_file(const char *contents,
67 const char *path_format, ...) PRINTFLIKE(2, 3);
68 void drm_shim_fd_register(int fd, struct shim_fd *shim_fd);
69 struct shim_fd *drm_shim_fd_lookup(int fd);
70 int drm_shim_ioctl(int fd, unsigned long request, void *arg);
71 void *drm_shim_mmap(struct shim_fd *shim_fd, size_t length, int prot, int flags,
72 int fd, off_t offset);
73
74 void drm_shim_bo_init(struct shim_bo *bo, size_t size);
75 void drm_shim_bo_get(struct shim_bo *bo);
76 void drm_shim_bo_put(struct shim_bo *bo);
77 struct shim_bo *drm_shim_bo_lookup(struct shim_fd *shim_fd, int handle);
78 int drm_shim_bo_get_handle(struct shim_fd *shim_fd, struct shim_bo *bo);
79 uint64_t drm_shim_bo_get_mmap_offset(struct shim_fd *shim_fd,
80 struct shim_bo *bo);
81
82 /* driver-specific hooks. */
83 void drm_shim_driver_init(void);