1 /* SPDX-License-Identifier: MIT */
3 * Copyright (C) 2013-2017 Oracle Corporation
4 * This file is based on ast_drv.h
5 * Copyright 2012 Red Hat Inc.
6 * Authors: Dave Airlie <airlied@redhat.com>
7 * Michael Thayer <michael.thayer@oracle.com,
8 * Hans de Goede <hdegoede@redhat.com>
10 #ifndef __VBOX_DRV_H__
11 #define __VBOX_DRV_H__
13 #include <linux/genalloc.h>
15 #include <linux/irqreturn.h>
16 #include <linux/string.h>
18 #include <drm/drm_encoder.h>
19 #include <drm/drm_gem.h>
20 #include <drm/drm_gem_vram_helper.h>
22 #include "vboxvideo_guest.h"
23 #include "vboxvideo_vbe.h"
24 #include "hgsmi_ch_setup.h"
26 #define DRIVER_NAME "vboxvideo"
27 #define DRIVER_DESC "Oracle VM VirtualBox Graphics Card"
28 #define DRIVER_DATE "20130823"
30 #define DRIVER_MAJOR 1
31 #define DRIVER_MINOR 0
32 #define DRIVER_PATCHLEVEL 0
34 #define VBOX_MAX_CURSOR_WIDTH 64
35 #define VBOX_MAX_CURSOR_HEIGHT 64
36 #define CURSOR_PIXEL_COUNT (VBOX_MAX_CURSOR_WIDTH * VBOX_MAX_CURSOR_HEIGHT)
37 #define CURSOR_DATA_SIZE (CURSOR_PIXEL_COUNT * 4 + CURSOR_PIXEL_COUNT / 8)
39 #define VBOX_MAX_SCREENS 32
41 #define GUEST_HEAP_OFFSET(vbox) ((vbox)->full_vram_size - \
42 VBVA_ADAPTER_INFORMATION_SIZE)
43 #define GUEST_HEAP_SIZE VBVA_ADAPTER_INFORMATION_SIZE
44 #define GUEST_HEAP_USABLE_SIZE (VBVA_ADAPTER_INFORMATION_SIZE - \
45 sizeof(struct hgsmi_host_flags))
46 #define HOST_FLAGS_OFFSET GUEST_HEAP_USABLE_SIZE
48 struct vbox_framebuffer {
49 struct drm_framebuffer base;
50 struct drm_gem_object *obj;
54 /* Must be first; or we must define our own release callback */
55 struct drm_device ddev;
57 u8 __iomem *guest_heap;
58 u8 __iomem *vbva_buffers;
59 struct gen_pool *guest_pool;
60 struct vbva_buf_ctx *vbva_info;
63 /* Amount of available VRAM, including space used for buffers. */
65 /* Amount of available VRAM, not including space used for buffers. */
66 u32 available_vram_size;
67 /* Array of structures for receiving mode hints. */
68 struct vbva_modehint *last_mode_hints;
72 struct mutex hw_mutex; /* protects modeset and accel/vbva accesses */
73 struct work_struct hotplug_work;
74 u32 input_mapping_width;
75 u32 input_mapping_height;
77 * Is user-space using an X.Org-style layout of one large frame-buffer
78 * encompassing all screen ones or is the fbdev console active?
80 bool single_framebuffer;
81 u8 cursor_data[CURSOR_DATA_SIZE];
84 #undef CURSOR_PIXEL_COUNT
85 #undef CURSOR_DATA_SIZE
87 struct vbox_connector {
88 struct drm_connector base;
90 struct vbox_crtc *vbox_crtc;
101 unsigned int crtc_id;
107 * When setting a mode we not only pass the mode to the hypervisor,
108 * but also information on how to map / translate input coordinates
109 * for the emulated USB tablet. This input-mapping may change when
110 * the mode on *another* crtc changes.
112 * This means that sometimes we must do a modeset on other crtc-s then
113 * the one being changed to update the input-mapping. Including crtc-s
114 * which may be disabled inside the guest (shown as a black window
115 * on the host unless closed by the user).
117 * With atomic modesetting the mode-info of disabled crtcs gets zeroed
118 * yet we need it when updating the input-map to avoid resizing the
119 * window as a side effect of a mode_set on another crtc. Therefor we
120 * cache the info of the last mode below.
128 struct vbox_encoder {
129 struct drm_encoder base;
132 #define to_vbox_crtc(x) container_of(x, struct vbox_crtc, base)
133 #define to_vbox_connector(x) container_of(x, struct vbox_connector, base)
134 #define to_vbox_encoder(x) container_of(x, struct vbox_encoder, base)
135 #define to_vbox_framebuffer(x) container_of(x, struct vbox_framebuffer, base)
137 bool vbox_check_supported(u16 id);
138 int vbox_hw_init(struct vbox_private *vbox);
139 void vbox_hw_fini(struct vbox_private *vbox);
141 int vbox_mode_init(struct vbox_private *vbox);
142 void vbox_mode_fini(struct vbox_private *vbox);
144 void vbox_report_caps(struct vbox_private *vbox);
146 int vbox_framebuffer_init(struct vbox_private *vbox,
147 struct vbox_framebuffer *vbox_fb,
148 const struct drm_mode_fb_cmd2 *mode_cmd,
149 struct drm_gem_object *obj);
151 int vbox_mm_init(struct vbox_private *vbox);
152 void vbox_mm_fini(struct vbox_private *vbox);
154 int vbox_gem_create(struct vbox_private *vbox,
155 u32 size, bool iskernel, struct drm_gem_object **obj);
158 int vbox_irq_init(struct vbox_private *vbox);
159 void vbox_irq_fini(struct vbox_private *vbox);
160 void vbox_report_hotplug(struct vbox_private *vbox);
161 irqreturn_t vbox_irq_handler(int irq, void *arg);
164 void *hgsmi_buffer_alloc(struct gen_pool *guest_pool, size_t size,
165 u8 channel, u16 channel_info);
166 void hgsmi_buffer_free(struct gen_pool *guest_pool, void *buf);
167 int hgsmi_buffer_submit(struct gen_pool *guest_pool, void *buf);
169 static inline void vbox_write_ioport(u16 index, u16 data)
171 outw(index, VBE_DISPI_IOPORT_INDEX);
172 outw(data, VBE_DISPI_IOPORT_DATA);