1 /* SPDX-License-Identifier: MIT */ 2 /* 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> 9 */ 10 #ifndef __VBOX_DRV_H__ 11 #define __VBOX_DRV_H__ 12 13 #include <linux/genalloc.h> 14 #include <linux/io.h> 15 #include <linux/irqreturn.h> 16 #include <linux/string.h> 17 18 #include <drm/drm_encoder.h> 19 #include <drm/drm_fb_helper.h> 20 #include <drm/drm_gem.h> 21 #include <drm/drm_gem_vram_helper.h> 22 23 #include <drm/ttm/ttm_bo_api.h> 24 #include <drm/ttm/ttm_bo_driver.h> 25 #include <drm/ttm/ttm_placement.h> 26 #include <drm/ttm/ttm_memory.h> 27 #include <drm/ttm/ttm_module.h> 28 29 #include "vboxvideo_guest.h" 30 #include "vboxvideo_vbe.h" 31 #include "hgsmi_ch_setup.h" 32 33 #define DRIVER_NAME "vboxvideo" 34 #define DRIVER_DESC "Oracle VM VirtualBox Graphics Card" 35 #define DRIVER_DATE "20130823" 36 37 #define DRIVER_MAJOR 1 38 #define DRIVER_MINOR 0 39 #define DRIVER_PATCHLEVEL 0 40 41 #define VBOX_MAX_CURSOR_WIDTH 64 42 #define VBOX_MAX_CURSOR_HEIGHT 64 43 #define CURSOR_PIXEL_COUNT (VBOX_MAX_CURSOR_WIDTH * VBOX_MAX_CURSOR_HEIGHT) 44 #define CURSOR_DATA_SIZE (CURSOR_PIXEL_COUNT * 4 + CURSOR_PIXEL_COUNT / 8) 45 46 #define VBOX_MAX_SCREENS 32 47 48 #define GUEST_HEAP_OFFSET(vbox) ((vbox)->full_vram_size - \ 49 VBVA_ADAPTER_INFORMATION_SIZE) 50 #define GUEST_HEAP_SIZE VBVA_ADAPTER_INFORMATION_SIZE 51 #define GUEST_HEAP_USABLE_SIZE (VBVA_ADAPTER_INFORMATION_SIZE - \ 52 sizeof(struct hgsmi_host_flags)) 53 #define HOST_FLAGS_OFFSET GUEST_HEAP_USABLE_SIZE 54 55 struct vbox_framebuffer { 56 struct drm_framebuffer base; 57 struct drm_gem_object *obj; 58 }; 59 60 struct vbox_private { 61 /* Must be first; or we must define our own release callback */ 62 struct drm_device ddev; 63 struct drm_fb_helper fb_helper; 64 struct vbox_framebuffer afb; 65 66 u8 __iomem *guest_heap; 67 u8 __iomem *vbva_buffers; 68 struct gen_pool *guest_pool; 69 struct vbva_buf_ctx *vbva_info; 70 bool any_pitch; 71 u32 num_crtcs; 72 /* Amount of available VRAM, including space used for buffers. */ 73 u32 full_vram_size; 74 /* Amount of available VRAM, not including space used for buffers. */ 75 u32 available_vram_size; 76 /* Array of structures for receiving mode hints. */ 77 struct vbva_modehint *last_mode_hints; 78 79 int fb_mtrr; 80 81 struct { 82 struct ttm_bo_device bdev; 83 } ttm; 84 85 struct mutex hw_mutex; /* protects modeset and accel/vbva accesses */ 86 struct work_struct hotplug_work; 87 u32 input_mapping_width; 88 u32 input_mapping_height; 89 /* 90 * Is user-space using an X.Org-style layout of one large frame-buffer 91 * encompassing all screen ones or is the fbdev console active? 92 */ 93 bool single_framebuffer; 94 u8 cursor_data[CURSOR_DATA_SIZE]; 95 }; 96 97 #undef CURSOR_PIXEL_COUNT 98 #undef CURSOR_DATA_SIZE 99 100 struct vbox_connector { 101 struct drm_connector base; 102 char name[32]; 103 struct vbox_crtc *vbox_crtc; 104 struct { 105 u32 width; 106 u32 height; 107 bool disconnected; 108 } mode_hint; 109 }; 110 111 struct vbox_crtc { 112 struct drm_crtc base; 113 bool disconnected; 114 unsigned int crtc_id; 115 u32 fb_offset; 116 bool cursor_enabled; 117 u32 x_hint; 118 u32 y_hint; 119 /* 120 * When setting a mode we not only pass the mode to the hypervisor, 121 * but also information on how to map / translate input coordinates 122 * for the emulated USB tablet. This input-mapping may change when 123 * the mode on *another* crtc changes. 124 * 125 * This means that sometimes we must do a modeset on other crtc-s then 126 * the one being changed to update the input-mapping. Including crtc-s 127 * which may be disabled inside the guest (shown as a black window 128 * on the host unless closed by the user). 129 * 130 * With atomic modesetting the mode-info of disabled crtcs gets zeroed 131 * yet we need it when updating the input-map to avoid resizing the 132 * window as a side effect of a mode_set on another crtc. Therefor we 133 * cache the info of the last mode below. 134 */ 135 u32 width; 136 u32 height; 137 u32 x; 138 u32 y; 139 }; 140 141 struct vbox_encoder { 142 struct drm_encoder base; 143 }; 144 145 #define to_vbox_crtc(x) container_of(x, struct vbox_crtc, base) 146 #define to_vbox_connector(x) container_of(x, struct vbox_connector, base) 147 #define to_vbox_encoder(x) container_of(x, struct vbox_encoder, base) 148 #define to_vbox_framebuffer(x) container_of(x, struct vbox_framebuffer, base) 149 150 bool vbox_check_supported(u16 id); 151 int vbox_hw_init(struct vbox_private *vbox); 152 void vbox_hw_fini(struct vbox_private *vbox); 153 154 int vbox_mode_init(struct vbox_private *vbox); 155 void vbox_mode_fini(struct vbox_private *vbox); 156 157 void vbox_report_caps(struct vbox_private *vbox); 158 159 void vbox_framebuffer_dirty_rectangles(struct drm_framebuffer *fb, 160 struct drm_clip_rect *rects, 161 unsigned int num_rects); 162 163 int vbox_framebuffer_init(struct vbox_private *vbox, 164 struct vbox_framebuffer *vbox_fb, 165 const struct drm_mode_fb_cmd2 *mode_cmd, 166 struct drm_gem_object *obj); 167 168 int vboxfb_create(struct drm_fb_helper *helper, 169 struct drm_fb_helper_surface_size *sizes); 170 void vbox_fbdev_fini(struct vbox_private *vbox); 171 172 int vbox_dumb_create(struct drm_file *file, 173 struct drm_device *dev, 174 struct drm_mode_create_dumb *args); 175 176 int vbox_mm_init(struct vbox_private *vbox); 177 void vbox_mm_fini(struct vbox_private *vbox); 178 179 int vbox_gem_create(struct vbox_private *vbox, 180 u32 size, bool iskernel, struct drm_gem_object **obj); 181 int vbox_mmap(struct file *filp, struct vm_area_struct *vma); 182 183 /* vbox_prime.c */ 184 int vbox_gem_prime_pin(struct drm_gem_object *obj); 185 void vbox_gem_prime_unpin(struct drm_gem_object *obj); 186 struct sg_table *vbox_gem_prime_get_sg_table(struct drm_gem_object *obj); 187 struct drm_gem_object *vbox_gem_prime_import_sg_table( 188 struct drm_device *dev, struct dma_buf_attachment *attach, 189 struct sg_table *table); 190 void *vbox_gem_prime_vmap(struct drm_gem_object *obj); 191 void vbox_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr); 192 int vbox_gem_prime_mmap(struct drm_gem_object *obj, 193 struct vm_area_struct *area); 194 195 /* vbox_irq.c */ 196 int vbox_irq_init(struct vbox_private *vbox); 197 void vbox_irq_fini(struct vbox_private *vbox); 198 void vbox_report_hotplug(struct vbox_private *vbox); 199 irqreturn_t vbox_irq_handler(int irq, void *arg); 200 201 /* vbox_hgsmi.c */ 202 void *hgsmi_buffer_alloc(struct gen_pool *guest_pool, size_t size, 203 u8 channel, u16 channel_info); 204 void hgsmi_buffer_free(struct gen_pool *guest_pool, void *buf); 205 int hgsmi_buffer_submit(struct gen_pool *guest_pool, void *buf); 206 207 static inline void vbox_write_ioport(u16 index, u16 data) 208 { 209 outw(index, VBE_DISPI_IOPORT_INDEX); 210 outw(data, VBE_DISPI_IOPORT_DATA); 211 } 212 213 #endif 214