vbox_drv.h@ 86174

Last change on this file since 86174 was 86174, checked in by vboxsync, 4 years ago
Additions/linux: reverting changesets 140423 & 140424
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 15.8 KB

Line
1	/* $Id: vbox_drv.h 86174 2020-09-18 15:35:52Z vboxsync $ */
2	/** @file
3	* VirtualBox Additions Linux kernel video driver
4	*/
5
6	/*
7	* Copyright (C) 2013-2020 Oracle Corporation
8	* This file is based on ast_drv.h
9	* Copyright 2012 Red Hat Inc.
10	*
11	* Permission is hereby granted, free of charge, to any person obtaining a
12	* copy of this software and associated documentation files (the
13	* "Software"), to deal in the Software without restriction, including
14	* without limitation the rights to use, copy, modify, merge, publish,
15	* distribute, sub license, and/or sell copies of the Software, and to
16	* permit persons to whom the Software is furnished to do so, subject to
17	* the following conditions:
18	*
19	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21	* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
22	* THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
23	* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24	* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
25	* USE OR OTHER DEALINGS IN THE SOFTWARE.
26	*
27	* The above copyright notice and this permission notice (including the
28	* next paragraph) shall be included in all copies or substantial portions
29	* of the Software.
30	*
31	* Authors: Dave Airlie <[email protected]>
32	* Michael Thayer <[email protected],
33	* Hans de Goede <[email protected]>
34	*/
35
36	#ifndef GA_INCLUDED_SRC_linux_drm_vbox_drv_h
37	#define GA_INCLUDED_SRC_linux_drm_vbox_drv_h
38	#ifndef RT_WITHOUT_PRAGMA_ONCE
39	# pragma once
40	#endif
41
42	#include <linux/version.h>
43
44	/* iprt/linux/version.h copy - start */
45	/** @def RTLNX_VER_MIN
46	* Evaluates to true if the linux kernel version is equal or higher to the
47	* one specfied. */
48	#define RTLNX_VER_MIN(a_Major, a_Minor, a_Patch) \
49	(LINUX_VERSION_CODE >= KERNEL_VERSION(a_Major, a_Minor, a_Patch))
50
51	/** @def RTLNX_VER_MAX
52	* Evaluates to true if the linux kernel version is less to the one specfied
53	* (exclusive). */
54	#define RTLNX_VER_MAX(a_Major, a_Minor, a_Patch) \
55	(LINUX_VERSION_CODE < KERNEL_VERSION(a_Major, a_Minor, a_Patch))
56
57	/** @def RTLNX_VER_RANGE
58	* Evaluates to true if the linux kernel version is equal or higher to the given
59	* minimum version and less (but not equal) to the maximum version (exclusive). */
60	#define RTLNX_VER_RANGE(a_MajorMin, a_MinorMin, a_PatchMin, a_MajorMax, a_MinorMax, a_PatchMax) \
61	( LINUX_VERSION_CODE >= KERNEL_VERSION(a_MajorMin, a_MinorMin, a_PatchMin) \
62	&& LINUX_VERSION_CODE < KERNEL_VERSION(a_MajorMax, a_MinorMax, a_PatchMax) )
63
64
65	/** @def RTLNX_RHEL_MIN
66	* Require a minium RedHat release.
67	* @param a_iMajor The major release number (RHEL_MAJOR).
68	* @param a_iMinor The minor release number (RHEL_MINOR).
69	* @sa RTLNX_RHEL_MAX, RTLNX_RHEL_RANGE, RTLNX_RHEL_MAJ_PREREQ
70	*/
71	#if defined(RHEL_MAJOR) && defined(RHEL_MINOR)
72	# define RTLNX_RHEL_MIN(a_iMajor, a_iMinor) \
73	((RHEL_MAJOR) > (a_iMajor) \|\| ((RHEL_MAJOR) == (a_iMajor) && (RHEL_MINOR) >= (a_iMinor)))
74	#else
75	# define RTLNX_RHEL_MIN(a_iMajor, a_iMinor) (0)
76	#endif
77
78	/** @def RTLNX_RHEL_MAX
79	* Require a maximum RedHat release, true for all RHEL versions below it.
80	* @param a_iMajor The major release number (RHEL_MAJOR).
81	* @param a_iMinor The minor release number (RHEL_MINOR).
82	* @sa RTLNX_RHEL_MIN, RTLNX_RHEL_RANGE, RTLNX_RHEL_MAJ_PREREQ
83	*/
84	#if defined(RHEL_MAJOR) && defined(RHEL_MINOR)
85	# define RTLNX_RHEL_MAX(a_iMajor, a_iMinor) \
86	((RHEL_MAJOR) < (a_iMajor) \|\| ((RHEL_MAJOR) == (a_iMajor) && (RHEL_MINOR) < (a_iMinor)))
87	#else
88	# define RTLNX_RHEL_MAX(a_iMajor, a_iMinor) (0)
89	#endif
90
91	/** @def RTLNX_RHEL_RANGE
92	* Check that it's a RedHat kernel in the given version range.
93	* The max version is exclusive, the minimum inclusive.
94	* @sa RTLNX_RHEL_MIN, RTLNX_RHEL_MAX, RTLNX_RHEL_MAJ_PREREQ
95	*/
96	#if defined(RHEL_MAJOR) && defined(RHEL_MINOR)
97	# define RTLNX_RHEL_RANGE(a_iMajorMin, a_iMinorMin, a_iMajorMax, a_iMinorMax) \
98	(RTLNX_RHEL_MIN(a_iMajorMin, a_iMinorMin) && RTLNX_RHEL_MAX(a_iMajorMax, a_iMinorMax))
99	#else
100	# define RTLNX_RHEL_RANGE(a_iMajorMin, a_iMinorMin, a_iMajorMax, a_iMinorMax) (0)
101	#endif
102
103	/** @def RTLNX_RHEL_MAJ_PREREQ
104	* Require a minimum minor release number for the given RedHat release.
105	* @param a_iMajor RHEL_MAJOR must _equal_ this.
106	* @param a_iMinor RHEL_MINOR must be greater or equal to this.
107	* @sa RTLNX_RHEL_MIN, RTLNX_RHEL_MAX
108	*/
109	#if defined(RHEL_MAJOR) && defined(RHEL_MINOR)
110	# define RTLNX_RHEL_MAJ_PREREQ(a_iMajor, a_iMinor) ((RHEL_MAJOR) == (a_iMajor) && (RHEL_MINOR) >= (a_iMinor))
111	#else
112	# define RTLNX_RHEL_MAJ_PREREQ(a_iMajor, a_iMinor) (0)
113	#endif
114
115
116	/** @def RTLNX_SUSE_MAJ_PREREQ
117	* Require a minimum minor release number for the given SUSE release.
118	* @param a_iMajor CONFIG_SUSE_VERSION must _equal_ this.
119	* @param a_iMinor CONFIG_SUSE_PATCHLEVEL must be greater or equal to this.
120	*/
121	#if defined(CONFIG_SUSE_VERSION) && defined(CONFIG_SUSE_PATCHLEVEL)
122	# define RTLNX_SUSE_MAJ_PREREQ(a_iMajor, a_iMinor) ((CONFIG_SUSE_VERSION) == (a_iMajor) && (CONFIG_SUSE_PATCHLEVEL) >= (a_iMinor))
123	#else
124	# define RTLNX_SUSE_MAJ_PREREQ(a_iMajor, a_iMinor) (0)
125	#endif
126	/* iprt/linux/version.h copy - end */
127
128	#if RTLNX_VER_MAX(4,5,0)
129	# include <linux/types.h>
130	# include <linux/spinlock_types.h>
131	#endif
132
133	#include <linux/genalloc.h>
134	#include <linux/io.h>
135	#include <linux/string.h>
136	#include <linux/pci.h>
137
138
139	#if RTLNX_VER_MAX(3,14,0) \|\| RTLNX_RHEL_MAJ_PREREQ(7,1)
140	#define U8_MAX ((u8)~0U)
141	#define S8_MAX ((s8)(U8_MAX>>1))
142	#define S8_MIN ((s8)(-S8_MAX - 1))
143	#define U16_MAX ((u16)~0U)
144	#define S16_MAX ((s16)(U16_MAX>>1))
145	#define S16_MIN ((s16)(-S16_MAX - 1))
146	#define U32_MAX ((u32)~0U)
147	#define S32_MAX ((s32)(U32_MAX>>1))
148	#define S32_MIN ((s32)(-S32_MAX - 1))
149	#define U64_MAX ((u64)~0ULL)
150	#define S64_MAX ((s64)(U64_MAX>>1))
151	#define S64_MIN ((s64)(-S64_MAX - 1))
152	#endif
153
154	#if RTLNX_VER_MAX(5,5,0)
155	# include <drm/drmP.h>
156	#else /* >= 5.5.0 */
157	# include <drm/drm_file.h>
158	# include <drm/drm_drv.h>
159	# include <drm/drm_device.h>
160	# include <drm/drm_ioctl.h>
161	# include <drm/drm_fourcc.h>
162	# include <drm/drm_irq.h>
163	# include <drm/drm_vblank.h>
164	#endif /* >= 5.5.0 */
165	#if RTLNX_VER_MIN(4,11,0) \|\| RTLNX_RHEL_MAJ_PREREQ(7,5)
166	# include <drm/drm_encoder.h>
167	#endif
168	#include <drm/drm_fb_helper.h>
169	#if RTLNX_VER_MIN(3,18,0) \|\| RTLNX_RHEL_MAJ_PREREQ(7,2)
170	# include <drm/drm_gem.h>
171	#endif
172
173	#include <drm/ttm/ttm_bo_api.h>
174	#include <drm/ttm/ttm_bo_driver.h>
175	#include <drm/ttm/ttm_placement.h>
176	#include <drm/ttm/ttm_memory.h>
177	#include <drm/ttm/ttm_module.h>
178
179	#include "vboxvideo_guest.h"
180	#include "vboxvideo_vbe.h"
181	#include "hgsmi_ch_setup.h"
182
183	#include "product-generated.h"
184
185	#if RTLNX_VER_MAX(4,12,0) && !RTLNX_RHEL_MAJ_PREREQ(7,5)
186	static inline void drm_gem_object_put_unlocked(struct drm_gem_object *obj)
187	{
188	drm_gem_object_unreference_unlocked(obj);
189	}
190	#endif
191
192	#if RTLNX_VER_MAX(4,12,0) && !RTLNX_RHEL_MAJ_PREREQ(7,5)
193	static inline void drm_gem_object_put(struct drm_gem_object *obj)
194	{
195	drm_gem_object_unreference(obj);
196	}
197	#endif
198
199	#define DRIVER_AUTHOR VBOX_VENDOR
200
201	#define DRIVER_NAME "vboxvideo"
202	#define DRIVER_DESC VBOX_PRODUCT " Graphics Card"
203	#define DRIVER_DATE "20130823"
204
205	#define DRIVER_MAJOR 1
206	#define DRIVER_MINOR 0
207	#define DRIVER_PATCHLEVEL 0
208
209	#define VBOX_MAX_CURSOR_WIDTH 64
210	#define VBOX_MAX_CURSOR_HEIGHT 64
211	#define CURSOR_PIXEL_COUNT (VBOX_MAX_CURSOR_WIDTH * VBOX_MAX_CURSOR_HEIGHT)
212	#define CURSOR_DATA_SIZE (CURSOR_PIXEL_COUNT * 4 + CURSOR_PIXEL_COUNT / 8)
213
214	#define VBOX_MAX_SCREENS 32
215
216	#define GUEST_HEAP_OFFSET(vbox) ((vbox)->full_vram_size - \
217	VBVA_ADAPTER_INFORMATION_SIZE)
218	#define GUEST_HEAP_SIZE VBVA_ADAPTER_INFORMATION_SIZE
219	#define GUEST_HEAP_USABLE_SIZE (VBVA_ADAPTER_INFORMATION_SIZE - \
220	sizeof(HGSMIHOSTFLAGS))
221	#define HOST_FLAGS_OFFSET GUEST_HEAP_USABLE_SIZE
222
223	/** How frequently we refresh if the guest is not providing dirty rectangles. */
224	#define VBOX_REFRESH_PERIOD (HZ / 2)
225
226	#if RTLNX_VER_MAX(3,13,0) && !RTLNX_RHEL_MAJ_PREREQ(7,2)
227	static inline void devm_kcalloc(struct device dev, size_t n, size_t size,
228	gfp_t flags)
229	{
230	return devm_kzalloc(dev, n * size, flags);
231	}
232	#endif
233
234	struct vbox_fbdev;
235
236	struct vbox_private {
237	struct drm_device *dev;
238
239	u8 __iomem *guest_heap;
240	u8 __iomem *vbva_buffers;
241	struct gen_pool *guest_pool;
242	struct VBVABUFFERCONTEXT *vbva_info;
243	bool any_pitch;
244	u32 num_crtcs;
245	/** Amount of available VRAM, including space used for buffers. */
246	u32 full_vram_size;
247	/** Amount of available VRAM, not including space used for buffers. */
248	u32 available_vram_size;
249	/** Array of structures for receiving mode hints. */
250	VBVAMODEHINT *last_mode_hints;
251
252	struct vbox_fbdev *fbdev;
253
254	int fb_mtrr;
255
256	struct {
257	#if RTLNX_VER_MAX(5,0,0) && !RTLNX_RHEL_MAJ_PREREQ(7,7) && !RTLNX_RHEL_MAJ_PREREQ(8,1)
258	struct drm_global_reference mem_global_ref;
259	struct ttm_bo_global_ref bo_global_ref;
260	#endif
261	struct ttm_bo_device bdev;
262	bool mm_initialised;
263	} ttm;
264
265	struct mutex hw_mutex; /* protects modeset and accel/vbva accesses */
266	/**
267	* We decide whether or not user-space supports display hot-plug
268	* depending on whether they react to a hot-plug event after the initial
269	* mode query.
270	*/
271	bool initial_mode_queried;
272	/**
273	* Do we know that the current user can send us dirty rectangle information?
274	* If not, do periodic refreshes until we do know.
275	*/
276	bool need_refresh_timer;
277	/**
278	* As long as the user is not sending us dirty rectangle information,
279	* refresh the whole screen at regular intervals.
280	*/
281	struct delayed_work refresh_work;
282	struct work_struct hotplug_work;
283	u32 input_mapping_width;
284	u32 input_mapping_height;
285	/**
286	* Is user-space using an X.Org-style layout of one large frame-buffer
287	* encompassing all screen ones or is the fbdev console active?
288	*/
289	bool single_framebuffer;
290	u32 cursor_width;
291	u32 cursor_height;
292	u32 cursor_hot_x;
293	u32 cursor_hot_y;
294	size_t cursor_data_size;
295	u8 cursor_data[CURSOR_DATA_SIZE];
296	};
297
298	#undef CURSOR_PIXEL_COUNT
299	#undef CURSOR_DATA_SIZE
300
301	#if RTLNX_VER_MAX(4,19,0)
302	int vbox_driver_load(struct drm_device *dev, unsigned long flags);
303	#else
304	int vbox_driver_load(struct drm_device *dev);
305	#endif
306	#if RTLNX_VER_MIN(4,11,0) \|\| RTLNX_RHEL_MAJ_PREREQ(7,5)
307	void vbox_driver_unload(struct drm_device *dev);
308	#else
309	int vbox_driver_unload(struct drm_device *dev);
310	#endif
311	void vbox_driver_lastclose(struct drm_device *dev);
312
313	struct vbox_gem_object;
314
315	#ifndef VGA_PORT_HGSMI_HOST
316	#define VGA_PORT_HGSMI_HOST 0x3b0
317	#define VGA_PORT_HGSMI_GUEST 0x3d0
318	#endif
319
320	struct vbox_connector {
321	struct drm_connector base;
322	char name[32];
323	struct vbox_crtc *vbox_crtc;
324	struct {
325	u32 width;
326	u32 height;
327	bool disconnected;
328	} mode_hint;
329	};
330
331	struct vbox_crtc {
332	struct drm_crtc base;
333	bool blanked;
334	bool disconnected;
335	unsigned int crtc_id;
336	u32 fb_offset;
337	bool cursor_enabled;
338	u32 x_hint;
339	u32 y_hint;
340	};
341
342	struct vbox_encoder {
343	struct drm_encoder base;
344	};
345
346	struct vbox_framebuffer {
347	struct drm_framebuffer base;
348	struct drm_gem_object *obj;
349	};
350
351	struct vbox_fbdev {
352	struct drm_fb_helper helper;
353	struct vbox_framebuffer afb;
354	int size;
355	struct ttm_bo_kmap_obj mapping;
356	int x1, y1, x2, y2; /* dirty rect */
357	spinlock_t dirty_lock;
358	};
359
360	#define to_vbox_crtc(x) container_of(x, struct vbox_crtc, base)
361	#define to_vbox_connector(x) container_of(x, struct vbox_connector, base)
362	#define to_vbox_encoder(x) container_of(x, struct vbox_encoder, base)
363	#define to_vbox_framebuffer(x) container_of(x, struct vbox_framebuffer, base)
364
365	int vbox_mode_init(struct drm_device *dev);
366	void vbox_mode_fini(struct drm_device *dev);
367
368	#if RTLNX_VER_MAX(3,3,0)
369	# define DRM_MODE_FB_CMD drm_mode_fb_cmd
370	#else
371	# define DRM_MODE_FB_CMD drm_mode_fb_cmd2
372	#endif
373
374	#if RTLNX_VER_MAX(3,15,0) && !RTLNX_RHEL_MAJ_PREREQ(7,1)
375	# define CRTC_FB(crtc) ((crtc)->fb)
376	#else
377	# define CRTC_FB(crtc) ((crtc)->primary->fb)
378	#endif
379
380	void vbox_enable_accel(struct vbox_private *vbox);
381	void vbox_disable_accel(struct vbox_private *vbox);
382	void vbox_report_caps(struct vbox_private *vbox);
383
384	void vbox_framebuffer_dirty_rectangles(struct drm_framebuffer *fb,
385	struct drm_clip_rect *rects,
386	unsigned int num_rects);
387
388	int vbox_framebuffer_init(struct drm_device *dev,
389	struct vbox_framebuffer *vbox_fb,
390	#if RTLNX_VER_MIN(4,5,0) \|\| RTLNX_RHEL_MAJ_PREREQ(7,3)
391	const struct DRM_MODE_FB_CMD *mode_cmd,
392	#else
393	struct DRM_MODE_FB_CMD *mode_cmd,
394	#endif
395	struct drm_gem_object *obj);
396
397	int vbox_fbdev_init(struct drm_device *dev);
398	void vbox_fbdev_fini(struct drm_device *dev);
399	void vbox_fbdev_set_base(struct vbox_private *vbox, unsigned long gpu_addr);
400
401	struct vbox_bo {
402	struct ttm_buffer_object bo;
403	struct ttm_placement placement;
404	struct ttm_bo_kmap_obj kmap;
405	struct drm_gem_object gem;
406	#if RTLNX_VER_MAX(3,18,0) && !RTLNX_RHEL_MAJ_PREREQ(7,2)
407	u32 placements[3];
408	#else
409	struct ttm_place placements[3];
410	#endif
411	int pin_count;
412	};
413
414	#define gem_to_vbox_bo(gobj) container_of((gobj), struct vbox_bo, gem)
415
416	static inline struct vbox_bo vbox_bo(struct ttm_buffer_object bo)
417	{
418	return container_of(bo, struct vbox_bo, bo);
419	}
420
421	#define to_vbox_obj(x) container_of(x, struct vbox_gem_object, base)
422
423	int vbox_dumb_create(struct drm_file *file,
424	struct drm_device *dev,
425	struct drm_mode_create_dumb *args);
426	#if RTLNX_VER_MAX(3,12,0) && !RTLNX_RHEL_MAJ_PREREQ(7,3)
427	int vbox_dumb_destroy(struct drm_file *file,
428	struct drm_device *dev, u32 handle);
429	#endif
430
431	void vbox_gem_free_object(struct drm_gem_object *obj);
432	int vbox_dumb_mmap_offset(struct drm_file *file,
433	struct drm_device *dev,
434	u32 handle, u64 *offset);
435
436	#define DRM_FILE_PAGE_OFFSET (0x10000000ULL >> PAGE_SHIFT)
437
438	int vbox_mm_init(struct vbox_private *vbox);
439	void vbox_mm_fini(struct vbox_private *vbox);
440
441	int vbox_bo_create(struct drm_device *dev, int size, int align,
442	u32 flags, struct vbox_bo **pvboxbo);
443
444	int vbox_gem_create(struct drm_device *dev,
445	u32 size, bool iskernel, struct drm_gem_object **obj);
446
447	int vbox_bo_pin(struct vbox_bo bo, u32 pl_flag, u64 gpu_addr);
448	int vbox_bo_unpin(struct vbox_bo *bo);
449
450	static inline int vbox_bo_reserve(struct vbox_bo *bo, bool no_wait)
451	{
452	int ret;
453
454	#if RTLNX_VER_MIN(4,7,0) \|\| RTLNX_RHEL_MAJ_PREREQ(7,4)
455	ret = ttm_bo_reserve(&bo->bo, true, no_wait, NULL);
456	#else
457	ret = ttm_bo_reserve(&bo->bo, true, no_wait, false, 0);
458	#endif
459	if (ret) {
460	if (ret != -ERESTARTSYS && ret != -EBUSY)
461	DRM_ERROR("reserve failed %p\n", bo);
462	return ret;
463	}
464	return 0;
465	}
466
467	static inline void vbox_bo_unreserve(struct vbox_bo *bo)
468	{
469	ttm_bo_unreserve(&bo->bo);
470	}
471
472	void vbox_ttm_placement(struct vbox_bo *bo, int domain);
473	int vbox_bo_push_sysram(struct vbox_bo *bo);
474	int vbox_mmap(struct file filp, struct vm_area_struct vma);
475
476	/* vbox_prime.c */
477	int vbox_gem_prime_pin(struct drm_gem_object *obj);
478	void vbox_gem_prime_unpin(struct drm_gem_object *obj);
479	struct sg_table vbox_gem_prime_get_sg_table(struct drm_gem_object obj);
480	#if RTLNX_VER_MAX(3,18,0) && !RTLNX_RHEL_MAJ_PREREQ(7,2)
481	struct drm_gem_object *vbox_gem_prime_import_sg_table(
482	struct drm_device dev, size_t size, struct sg_table table);
483	#else
484	struct drm_gem_object *vbox_gem_prime_import_sg_table(
485	struct drm_device dev, struct dma_buf_attachment attach,
486	struct sg_table *table);
487	#endif
488	void vbox_gem_prime_vmap(struct drm_gem_object obj);
489	void vbox_gem_prime_vunmap(struct drm_gem_object obj, void vaddr);
490	int vbox_gem_prime_mmap(struct drm_gem_object *obj,
491	struct vm_area_struct *area);
492
493	/* vbox_irq.c */
494	int vbox_irq_init(struct vbox_private *vbox);
495	void vbox_irq_fini(struct vbox_private *vbox);
496	void vbox_report_hotplug(struct vbox_private *vbox);
497	irqreturn_t vbox_irq_handler(int irq, void *arg);
498
499	/* vbox_hgsmi.c */
500	void hgsmi_buffer_alloc(struct gen_pool guest_pool, size_t size,
501	u8 channel, u16 channel_info);
502	void hgsmi_buffer_free(struct gen_pool guest_pool, void buf);
503	int hgsmi_buffer_submit(struct gen_pool guest_pool, void buf);
504
505	static inline void vbox_write_ioport(u16 index, u16 data)
506	{
507	outw(index, VBE_DISPI_IOPORT_INDEX);
508	outw(data, VBE_DISPI_IOPORT_DATA);
509	}
510
511	#endif /* !GA_INCLUDED_SRC_linux_drm_vbox_drv_h */

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Additions/linux/drm/vbox_drv.h@ 86174

Download in other formats: