2 * Copyright (C) 2013-2017 Oracle Corporation
3 * This file is based on ast_drv.h
4 * Copyright 2012 Red Hat Inc.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
18 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
19 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 * USE OR OTHER DEALINGS IN THE SOFTWARE.
22 * The above copyright notice and this permission notice (including the
23 * next paragraph) shall be included in all copies or substantial portions
26 * Authors: Dave Airlie <airlied@redhat.com>
27 * Michael Thayer <michael.thayer@oracle.com,
28 * Hans de Goede <hdegoede@redhat.com>
30 #ifndef __VBOX_DRV_H__
31 #define __VBOX_DRV_H__
33 #include <linux/genalloc.h>
35 #include <linux/string.h>
36 #include <linux/version.h>
39 #include <drm/drm_encoder.h>
40 #include <drm/drm_fb_helper.h>
41 #include <drm/drm_gem.h>
43 #include <drm/ttm/ttm_bo_api.h>
44 #include <drm/ttm/ttm_bo_driver.h>
45 #include <drm/ttm/ttm_placement.h>
46 #include <drm/ttm/ttm_memory.h>
47 #include <drm/ttm/ttm_module.h>
49 #include "vboxvideo_guest.h"
50 #include "vboxvideo_vbe.h"
51 #include "hgsmi_ch_setup.h"
53 #define DRIVER_NAME "vboxvideo"
54 #define DRIVER_DESC "Oracle VM VirtualBox Graphics Card"
55 #define DRIVER_DATE "20130823"
57 #define DRIVER_MAJOR 1
58 #define DRIVER_MINOR 0
59 #define DRIVER_PATCHLEVEL 0
61 #define VBOX_MAX_CURSOR_WIDTH 64
62 #define VBOX_MAX_CURSOR_HEIGHT 64
63 #define CURSOR_PIXEL_COUNT (VBOX_MAX_CURSOR_WIDTH * VBOX_MAX_CURSOR_HEIGHT)
64 #define CURSOR_DATA_SIZE (CURSOR_PIXEL_COUNT * 4 + CURSOR_PIXEL_COUNT / 8)
66 #define VBOX_MAX_SCREENS 32
68 #define GUEST_HEAP_OFFSET(vbox) ((vbox)->full_vram_size - \
69 VBVA_ADAPTER_INFORMATION_SIZE)
70 #define GUEST_HEAP_SIZE VBVA_ADAPTER_INFORMATION_SIZE
71 #define GUEST_HEAP_USABLE_SIZE (VBVA_ADAPTER_INFORMATION_SIZE - \
72 sizeof(struct hgsmi_host_flags))
73 #define HOST_FLAGS_OFFSET GUEST_HEAP_USABLE_SIZE
75 struct vbox_framebuffer {
76 struct drm_framebuffer base;
77 struct drm_gem_object *obj;
81 /* Must be first; or we must define our own release callback */
82 struct drm_device ddev;
83 struct drm_fb_helper fb_helper;
84 struct vbox_framebuffer afb;
86 u8 __iomem *guest_heap;
87 u8 __iomem *vbva_buffers;
88 struct gen_pool *guest_pool;
89 struct vbva_buf_ctx *vbva_info;
92 /** Amount of available VRAM, including space used for buffers. */
94 /** Amount of available VRAM, not including space used for buffers. */
95 u32 available_vram_size;
96 /** Array of structures for receiving mode hints. */
97 struct vbva_modehint *last_mode_hints;
102 struct ttm_bo_global_ref bo_global_ref;
103 struct ttm_bo_device bdev;
106 struct mutex hw_mutex; /* protects modeset and accel/vbva accesses */
108 * We decide whether or not user-space supports display hot-plug
109 * depending on whether they react to a hot-plug event after the initial
112 bool initial_mode_queried;
113 struct work_struct hotplug_work;
114 u32 input_mapping_width;
115 u32 input_mapping_height;
117 * Is user-space using an X.Org-style layout of one large frame-buffer
118 * encompassing all screen ones or is the fbdev console active?
120 bool single_framebuffer;
121 u8 cursor_data[CURSOR_DATA_SIZE];
124 #undef CURSOR_PIXEL_COUNT
125 #undef CURSOR_DATA_SIZE
127 struct vbox_gem_object;
129 struct vbox_connector {
130 struct drm_connector base;
132 struct vbox_crtc *vbox_crtc;
141 struct drm_crtc base;
143 unsigned int crtc_id;
149 * When setting a mode we not only pass the mode to the hypervisor,
150 * but also information on how to map / translate input coordinates
151 * for the emulated USB tablet. This input-mapping may change when
152 * the mode on *another* crtc changes.
154 * This means that sometimes we must do a modeset on other crtc-s then
155 * the one being changed to update the input-mapping. Including crtc-s
156 * which may be disabled inside the guest (shown as a black window
157 * on the host unless closed by the user).
159 * With atomic modesetting the mode-info of disabled crtcs gets zeroed
160 * yet we need it when updating the input-map to avoid resizing the
161 * window as a side effect of a mode_set on another crtc. Therefor we
162 * cache the info of the last mode below.
170 struct vbox_encoder {
171 struct drm_encoder base;
174 #define to_vbox_crtc(x) container_of(x, struct vbox_crtc, base)
175 #define to_vbox_connector(x) container_of(x, struct vbox_connector, base)
176 #define to_vbox_encoder(x) container_of(x, struct vbox_encoder, base)
177 #define to_vbox_framebuffer(x) container_of(x, struct vbox_framebuffer, base)
179 bool vbox_check_supported(u16 id);
180 int vbox_hw_init(struct vbox_private *vbox);
181 void vbox_hw_fini(struct vbox_private *vbox);
183 int vbox_mode_init(struct vbox_private *vbox);
184 void vbox_mode_fini(struct vbox_private *vbox);
186 #define DRM_MODE_FB_CMD drm_mode_fb_cmd2
188 void vbox_enable_accel(struct vbox_private *vbox);
189 void vbox_disable_accel(struct vbox_private *vbox);
190 void vbox_report_caps(struct vbox_private *vbox);
192 void vbox_framebuffer_dirty_rectangles(struct drm_framebuffer *fb,
193 struct drm_clip_rect *rects,
194 unsigned int num_rects);
196 int vbox_framebuffer_init(struct vbox_private *vbox,
197 struct vbox_framebuffer *vbox_fb,
198 const struct DRM_MODE_FB_CMD *mode_cmd,
199 struct drm_gem_object *obj);
201 int vboxfb_create(struct drm_fb_helper *helper,
202 struct drm_fb_helper_surface_size *sizes);
203 void vbox_fbdev_fini(struct vbox_private *vbox);
206 struct ttm_buffer_object bo;
207 struct ttm_placement placement;
208 struct ttm_bo_kmap_obj kmap;
209 struct drm_gem_object gem;
210 struct ttm_place placements[3];
214 #define gem_to_vbox_bo(gobj) container_of((gobj), struct vbox_bo, gem)
216 static inline struct vbox_bo *vbox_bo(struct ttm_buffer_object *bo)
218 return container_of(bo, struct vbox_bo, bo);
221 #define to_vbox_obj(x) container_of(x, struct vbox_gem_object, base)
223 static inline u64 vbox_bo_gpu_offset(struct vbox_bo *bo)
225 return bo->bo.offset;
228 int vbox_dumb_create(struct drm_file *file,
229 struct drm_device *dev,
230 struct drm_mode_create_dumb *args);
232 void vbox_gem_free_object(struct drm_gem_object *obj);
233 int vbox_dumb_mmap_offset(struct drm_file *file,
234 struct drm_device *dev,
235 u32 handle, u64 *offset);
237 #define DRM_FILE_PAGE_OFFSET (0x10000000ULL >> PAGE_SHIFT)
239 int vbox_mm_init(struct vbox_private *vbox);
240 void vbox_mm_fini(struct vbox_private *vbox);
242 int vbox_bo_create(struct vbox_private *vbox, int size, int align,
243 u32 flags, struct vbox_bo **pvboxbo);
245 int vbox_gem_create(struct vbox_private *vbox,
246 u32 size, bool iskernel, struct drm_gem_object **obj);
248 int vbox_bo_pin(struct vbox_bo *bo, u32 pl_flag);
249 int vbox_bo_unpin(struct vbox_bo *bo);
251 static inline int vbox_bo_reserve(struct vbox_bo *bo, bool no_wait)
255 ret = ttm_bo_reserve(&bo->bo, true, no_wait, NULL);
257 if (ret != -ERESTARTSYS && ret != -EBUSY)
258 DRM_ERROR("reserve failed %p\n", bo);
264 static inline void vbox_bo_unreserve(struct vbox_bo *bo)
266 ttm_bo_unreserve(&bo->bo);
269 void vbox_ttm_placement(struct vbox_bo *bo, int domain);
270 int vbox_bo_push_sysram(struct vbox_bo *bo);
271 int vbox_mmap(struct file *filp, struct vm_area_struct *vma);
272 void *vbox_bo_kmap(struct vbox_bo *bo);
273 void vbox_bo_kunmap(struct vbox_bo *bo);
276 int vbox_gem_prime_pin(struct drm_gem_object *obj);
277 void vbox_gem_prime_unpin(struct drm_gem_object *obj);
278 struct sg_table *vbox_gem_prime_get_sg_table(struct drm_gem_object *obj);
279 struct drm_gem_object *vbox_gem_prime_import_sg_table(
280 struct drm_device *dev, struct dma_buf_attachment *attach,
281 struct sg_table *table);
282 void *vbox_gem_prime_vmap(struct drm_gem_object *obj);
283 void vbox_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
284 int vbox_gem_prime_mmap(struct drm_gem_object *obj,
285 struct vm_area_struct *area);
288 int vbox_irq_init(struct vbox_private *vbox);
289 void vbox_irq_fini(struct vbox_private *vbox);
290 void vbox_report_hotplug(struct vbox_private *vbox);
291 irqreturn_t vbox_irq_handler(int irq, void *arg);
294 void *hgsmi_buffer_alloc(struct gen_pool *guest_pool, size_t size,
295 u8 channel, u16 channel_info);
296 void hgsmi_buffer_free(struct gen_pool *guest_pool, void *buf);
297 int hgsmi_buffer_submit(struct gen_pool *guest_pool, void *buf);
299 static inline void vbox_write_ioport(u16 index, u16 data)
301 outw(index, VBE_DISPI_IOPORT_INDEX);
302 outw(data, VBE_DISPI_IOPORT_DATA);