1*4882a593Smuzhiyun /* SPDX-License-Identifier: MIT */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Copyright (C) 2013-2017 Oracle Corporation
4*4882a593Smuzhiyun * This file is based on ast_drv.h
5*4882a593Smuzhiyun * Copyright 2012 Red Hat Inc.
6*4882a593Smuzhiyun * Authors: Dave Airlie <airlied@redhat.com>
7*4882a593Smuzhiyun * Michael Thayer <michael.thayer@oracle.com,
8*4882a593Smuzhiyun * Hans de Goede <hdegoede@redhat.com>
9*4882a593Smuzhiyun */
10*4882a593Smuzhiyun #ifndef __VBOX_DRV_H__
11*4882a593Smuzhiyun #define __VBOX_DRV_H__
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun #include <linux/genalloc.h>
14*4882a593Smuzhiyun #include <linux/io.h>
15*4882a593Smuzhiyun #include <linux/irqreturn.h>
16*4882a593Smuzhiyun #include <linux/string.h>
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun #include <drm/drm_encoder.h>
19*4882a593Smuzhiyun #include <drm/drm_gem.h>
20*4882a593Smuzhiyun #include <drm/drm_gem_vram_helper.h>
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun #include "vboxvideo_guest.h"
23*4882a593Smuzhiyun #include "vboxvideo_vbe.h"
24*4882a593Smuzhiyun #include "hgsmi_ch_setup.h"
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun #define DRIVER_NAME "vboxvideo"
27*4882a593Smuzhiyun #define DRIVER_DESC "Oracle VM VirtualBox Graphics Card"
28*4882a593Smuzhiyun #define DRIVER_DATE "20130823"
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun #define DRIVER_MAJOR 1
31*4882a593Smuzhiyun #define DRIVER_MINOR 0
32*4882a593Smuzhiyun #define DRIVER_PATCHLEVEL 0
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun #define VBOX_MAX_CURSOR_WIDTH 64
35*4882a593Smuzhiyun #define VBOX_MAX_CURSOR_HEIGHT 64
36*4882a593Smuzhiyun #define CURSOR_PIXEL_COUNT (VBOX_MAX_CURSOR_WIDTH * VBOX_MAX_CURSOR_HEIGHT)
37*4882a593Smuzhiyun #define CURSOR_DATA_SIZE (CURSOR_PIXEL_COUNT * 4 + CURSOR_PIXEL_COUNT / 8)
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun #define VBOX_MAX_SCREENS 32
40*4882a593Smuzhiyun
41*4882a593Smuzhiyun #define GUEST_HEAP_OFFSET(vbox) ((vbox)->full_vram_size - \
42*4882a593Smuzhiyun VBVA_ADAPTER_INFORMATION_SIZE)
43*4882a593Smuzhiyun #define GUEST_HEAP_SIZE VBVA_ADAPTER_INFORMATION_SIZE
44*4882a593Smuzhiyun #define GUEST_HEAP_USABLE_SIZE (VBVA_ADAPTER_INFORMATION_SIZE - \
45*4882a593Smuzhiyun sizeof(struct hgsmi_host_flags))
46*4882a593Smuzhiyun #define HOST_FLAGS_OFFSET GUEST_HEAP_USABLE_SIZE
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun struct vbox_private {
49*4882a593Smuzhiyun /* Must be first; or we must define our own release callback */
50*4882a593Smuzhiyun struct drm_device ddev;
51*4882a593Smuzhiyun
52*4882a593Smuzhiyun u8 __iomem *guest_heap;
53*4882a593Smuzhiyun u8 __iomem *vbva_buffers;
54*4882a593Smuzhiyun struct gen_pool *guest_pool;
55*4882a593Smuzhiyun struct vbva_buf_ctx *vbva_info;
56*4882a593Smuzhiyun bool any_pitch;
57*4882a593Smuzhiyun u32 num_crtcs;
58*4882a593Smuzhiyun /* Amount of available VRAM, including space used for buffers. */
59*4882a593Smuzhiyun u32 full_vram_size;
60*4882a593Smuzhiyun /* Amount of available VRAM, not including space used for buffers. */
61*4882a593Smuzhiyun u32 available_vram_size;
62*4882a593Smuzhiyun /* Array of structures for receiving mode hints. */
63*4882a593Smuzhiyun struct vbva_modehint *last_mode_hints;
64*4882a593Smuzhiyun
65*4882a593Smuzhiyun int fb_mtrr;
66*4882a593Smuzhiyun
67*4882a593Smuzhiyun struct mutex hw_mutex; /* protects modeset and accel/vbva accesses */
68*4882a593Smuzhiyun struct work_struct hotplug_work;
69*4882a593Smuzhiyun u32 input_mapping_width;
70*4882a593Smuzhiyun u32 input_mapping_height;
71*4882a593Smuzhiyun /*
72*4882a593Smuzhiyun * Is user-space using an X.Org-style layout of one large frame-buffer
73*4882a593Smuzhiyun * encompassing all screen ones or is the fbdev console active?
74*4882a593Smuzhiyun */
75*4882a593Smuzhiyun bool single_framebuffer;
76*4882a593Smuzhiyun u8 cursor_data[CURSOR_DATA_SIZE];
77*4882a593Smuzhiyun };
78*4882a593Smuzhiyun
79*4882a593Smuzhiyun #undef CURSOR_PIXEL_COUNT
80*4882a593Smuzhiyun #undef CURSOR_DATA_SIZE
81*4882a593Smuzhiyun
82*4882a593Smuzhiyun struct vbox_connector {
83*4882a593Smuzhiyun struct drm_connector base;
84*4882a593Smuzhiyun char name[32];
85*4882a593Smuzhiyun struct vbox_crtc *vbox_crtc;
86*4882a593Smuzhiyun struct {
87*4882a593Smuzhiyun u32 width;
88*4882a593Smuzhiyun u32 height;
89*4882a593Smuzhiyun bool disconnected;
90*4882a593Smuzhiyun } mode_hint;
91*4882a593Smuzhiyun };
92*4882a593Smuzhiyun
93*4882a593Smuzhiyun struct vbox_crtc {
94*4882a593Smuzhiyun struct drm_crtc base;
95*4882a593Smuzhiyun bool disconnected;
96*4882a593Smuzhiyun unsigned int crtc_id;
97*4882a593Smuzhiyun u32 fb_offset;
98*4882a593Smuzhiyun bool cursor_enabled;
99*4882a593Smuzhiyun u32 x_hint;
100*4882a593Smuzhiyun u32 y_hint;
101*4882a593Smuzhiyun /*
102*4882a593Smuzhiyun * When setting a mode we not only pass the mode to the hypervisor,
103*4882a593Smuzhiyun * but also information on how to map / translate input coordinates
104*4882a593Smuzhiyun * for the emulated USB tablet. This input-mapping may change when
105*4882a593Smuzhiyun * the mode on *another* crtc changes.
106*4882a593Smuzhiyun *
107*4882a593Smuzhiyun * This means that sometimes we must do a modeset on other crtc-s then
108*4882a593Smuzhiyun * the one being changed to update the input-mapping. Including crtc-s
109*4882a593Smuzhiyun * which may be disabled inside the guest (shown as a black window
110*4882a593Smuzhiyun * on the host unless closed by the user).
111*4882a593Smuzhiyun *
112*4882a593Smuzhiyun * With atomic modesetting the mode-info of disabled crtcs gets zeroed
113*4882a593Smuzhiyun * yet we need it when updating the input-map to avoid resizing the
114*4882a593Smuzhiyun * window as a side effect of a mode_set on another crtc. Therefor we
115*4882a593Smuzhiyun * cache the info of the last mode below.
116*4882a593Smuzhiyun */
117*4882a593Smuzhiyun u32 width;
118*4882a593Smuzhiyun u32 height;
119*4882a593Smuzhiyun u32 x;
120*4882a593Smuzhiyun u32 y;
121*4882a593Smuzhiyun };
122*4882a593Smuzhiyun
123*4882a593Smuzhiyun struct vbox_encoder {
124*4882a593Smuzhiyun struct drm_encoder base;
125*4882a593Smuzhiyun };
126*4882a593Smuzhiyun
127*4882a593Smuzhiyun #define to_vbox_crtc(x) container_of(x, struct vbox_crtc, base)
128*4882a593Smuzhiyun #define to_vbox_connector(x) container_of(x, struct vbox_connector, base)
129*4882a593Smuzhiyun #define to_vbox_encoder(x) container_of(x, struct vbox_encoder, base)
130*4882a593Smuzhiyun #define to_vbox_dev(x) container_of(x, struct vbox_private, ddev)
131*4882a593Smuzhiyun
132*4882a593Smuzhiyun bool vbox_check_supported(u16 id);
133*4882a593Smuzhiyun int vbox_hw_init(struct vbox_private *vbox);
134*4882a593Smuzhiyun void vbox_hw_fini(struct vbox_private *vbox);
135*4882a593Smuzhiyun
136*4882a593Smuzhiyun int vbox_mode_init(struct vbox_private *vbox);
137*4882a593Smuzhiyun void vbox_mode_fini(struct vbox_private *vbox);
138*4882a593Smuzhiyun
139*4882a593Smuzhiyun void vbox_report_caps(struct vbox_private *vbox);
140*4882a593Smuzhiyun
141*4882a593Smuzhiyun int vbox_mm_init(struct vbox_private *vbox);
142*4882a593Smuzhiyun void vbox_mm_fini(struct vbox_private *vbox);
143*4882a593Smuzhiyun
144*4882a593Smuzhiyun /* vbox_irq.c */
145*4882a593Smuzhiyun int vbox_irq_init(struct vbox_private *vbox);
146*4882a593Smuzhiyun void vbox_irq_fini(struct vbox_private *vbox);
147*4882a593Smuzhiyun void vbox_report_hotplug(struct vbox_private *vbox);
148*4882a593Smuzhiyun irqreturn_t vbox_irq_handler(int irq, void *arg);
149*4882a593Smuzhiyun
150*4882a593Smuzhiyun /* vbox_hgsmi.c */
151*4882a593Smuzhiyun void *hgsmi_buffer_alloc(struct gen_pool *guest_pool, size_t size,
152*4882a593Smuzhiyun u8 channel, u16 channel_info);
153*4882a593Smuzhiyun void hgsmi_buffer_free(struct gen_pool *guest_pool, void *buf);
154*4882a593Smuzhiyun int hgsmi_buffer_submit(struct gen_pool *guest_pool, void *buf);
155*4882a593Smuzhiyun
vbox_write_ioport(u16 index,u16 data)156*4882a593Smuzhiyun static inline void vbox_write_ioport(u16 index, u16 data)
157*4882a593Smuzhiyun {
158*4882a593Smuzhiyun outw(index, VBE_DISPI_IOPORT_INDEX);
159*4882a593Smuzhiyun outw(data, VBE_DISPI_IOPORT_DATA);
160*4882a593Smuzhiyun }
161*4882a593Smuzhiyun
162*4882a593Smuzhiyun #endif
163