ubuntu/vbox/vboxvideo/vbox_drv.h

   1 /* $Id: vbox_drv.h $ */
   2 /** @file
   3  * VirtualBox Additions Linux kernel video driver
   4  */
   5
   6 /*
   7  * Copyright (C) 2013-2016 Oracle Corporation
   8  *
   9  * This file is part of VirtualBox Open Source Edition (OSE), as
  10  * available from http://www.virtualbox.org. This file is free software;
  11  * you can redistribute it and/or modify it under the terms of the GNU
  12  * General Public License (GPL) as published by the Free Software
  13  * Foundation, in version 2 as it comes in the "COPYING" file of the
  14  * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
  15  * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
  16  * --------------------------------------------------------------------
  17  *
  18  * This code is based on
  19  * ast_drv.h
  20  * with the following copyright and permission notice:
  21  *
  22  * Copyright 2012 Red Hat Inc.
  23  *
  24  * Permission is hereby granted, free of charge, to any person obtaining a
  25  * copy of this software and associated documentation files (the
  26  * "Software"), to deal in the Software without restriction, including
  27  * without limitation the rights to use, copy, modify, merge, publish,
  28  * distribute, sub license, and/or sell copies of the Software, and to
  29  * permit persons to whom the Software is furnished to do so, subject to
  30  * the following conditions:
  31  *
  32  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  33  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  34  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  35  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  36  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  37  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  38  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  39  *
  40  * The above copyright notice and this permission notice (including the
  41  * next paragraph) shall be included in all copies or substantial portions
  42  * of the Software.
  43  *
  44  */
  45 /*
  46  * Authors: Dave Airlie <airlied@redhat.com>
  47  */
  48 #ifndef __VBOX_DRV_H__
  49 #define __VBOX_DRV_H__
  50
  51 #define LOG_GROUP LOG_GROUP_DEV_VGA
  52
  53 #include "the-linux-kernel.h"
  54
  55 #include <VBox/VBoxVideoGuest.h>
  56 #include <VBox/log.h>
  57
  58 #include <drm/drmP.h>
  59 #include <drm/drm_fb_helper.h>
  60
  61 #include <drm/ttm/ttm_bo_api.h>
  62 #include <drm/ttm/ttm_bo_driver.h>
  63 #include <drm/ttm/ttm_placement.h>
  64 #include <drm/ttm/ttm_memory.h>
  65 #include <drm/ttm/ttm_module.h>
  66
  67 #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 18, 0)
  68 # include <drm/drm_gem.h>
  69 #endif
  70
  71 /* #include "vboxvideo.h" */
  72
  73 #include "product-generated.h"
  74
  75 #define DRIVER_AUTHOR       VBOX_VENDOR
  76
  77 #define DRIVER_NAME         "vboxvideo"
  78 #define DRIVER_DESC         VBOX_PRODUCT " Graphics Card"
  79 #define DRIVER_DATE         "20130823"
  80
  81 #define DRIVER_MAJOR        1
  82 #define DRIVER_MINOR        0
  83 #define DRIVER_PATCHLEVEL   0
  84
  85 #define VBOX_MAX_CURSOR_WIDTH  64
  86 #define VBOX_MAX_CURSOR_HEIGHT 64
  87 #define CURSOR_PIXEL_COUNT VBOX_MAX_CURSOR_WIDTH * VBOX_MAX_CURSOR_HEIGHT
  88 #define CURSOR_DATA_SIZE CURSOR_PIXEL_COUNT * 4 + CURSOR_PIXEL_COUNT / 8
  89
  90 #define VBOX_MAX_SCREENS  32
  91
  92 struct vbox_fbdev;
  93
  94 struct vbox_private {
  95     struct drm_device *dev;
  96
  97     uint8_t __iomem *mapped_vram;
  98     HGSMIGUESTCOMMANDCONTEXT submit_info;
  99     struct VBVABUFFERCONTEXT *vbva_info;
 100     bool any_pitch;
 101     unsigned num_crtcs;
 102     bool vga2_clone;
 103     /** Amount of available VRAM, including space used for buffers. */
 104     uint32_t full_vram_size;
 105     /** Amount of available VRAM, not including space used for buffers. */
 106     uint32_t available_vram_size;
 107     /** Offset of mapped VRAM area in full VRAM. */
 108     uint32_t vram_map_start;
 109     /** Offset to the host flags in the VRAM. */
 110     uint32_t host_flags_offset;
 111     /** Array of structures for receiving mode hints. */
 112     VBVAMODEHINT *last_mode_hints;
 113
 114     struct vbox_fbdev *fbdev;
 115
 116     int fb_mtrr;
 117
 118     struct {
 119         struct drm_global_reference mem_global_ref;
 120         struct ttm_bo_global_ref bo_global_ref;
 121         struct ttm_bo_device bdev;
 122         bool mm_initialised;
 123     } ttm;
 124
 125     struct mutex hw_mutex;
 126     bool isr_installed;
 127     /** We decide whether or not user-space supports display hot-plug
 128      * depending on whether they react to a hot-plug event after the initial
 129      * mode query. */
 130     bool initial_mode_queried;
 131     struct work_struct hotplug_work;
 132     uint32_t input_mapping_width;
 133     uint32_t input_mapping_height;
 134     uint32_t cursor_width;
 135     uint32_t cursor_height;
 136     uint32_t cursor_hot_x;
 137     uint32_t cursor_hot_y;
 138     size_t cursor_data_size;
 139     uint8_t cursor_data[CURSOR_DATA_SIZE];
 140 };
 141
 142 #undef CURSOR_PIXEL_COUNT
 143 #undef CURSOR_DATA_SIZE
 144
 145 int vbox_driver_load(struct drm_device *dev, unsigned long flags);
 146 int vbox_driver_unload(struct drm_device *dev);
 147 void vbox_driver_lastclose(struct drm_device *dev);
 148
 149 struct vbox_gem_object;
 150
 151 #ifndef VGA_PORT_HGSMI_HOST
 152 # define VGA_PORT_HGSMI_HOST             0x3b0
 153 # define VGA_PORT_HGSMI_GUEST            0x3d0
 154 #endif
 155
 156 struct vbox_connector {
 157     struct drm_connector base;
 158     char name[32];
 159     struct vbox_crtc *vbox_crtc;
 160     struct {
 161         uint16_t width;
 162         uint16_t height;
 163         bool disconnected;
 164     } mode_hint;
 165 };
 166
 167 struct vbox_crtc {
 168     struct drm_crtc base;
 169     bool blanked;
 170     bool disconnected;
 171     unsigned crtc_id;
 172     uint32_t fb_offset;
 173     bool cursor_enabled;
 174 };
 175
 176 struct vbox_encoder {
 177     struct drm_encoder base;
 178 };
 179
 180 struct vbox_framebuffer {
 181     struct drm_framebuffer base;
 182     struct drm_gem_object *obj;
 183 };
 184
 185 struct vbox_fbdev {
 186     struct drm_fb_helper helper;
 187     struct vbox_framebuffer afb;
 188     void *sysram;
 189     int size;
 190     struct ttm_bo_kmap_obj mapping;
 191     int x1, y1, x2, y2; /* dirty rect */
 192     spinlock_t dirty_lock;
 193 };
 194
 195 #define to_vbox_crtc(x) container_of(x, struct vbox_crtc, base)
 196 #define to_vbox_connector(x) container_of(x, struct vbox_connector, base)
 197 #define to_vbox_encoder(x) container_of(x, struct vbox_encoder, base)
 198 #define to_vbox_framebuffer(x) container_of(x, struct vbox_framebuffer, base)
 199
 200 extern int vbox_mode_init(struct drm_device *dev);
 201 extern void vbox_mode_fini(struct drm_device *dev);
 202
 203 #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 3, 0)
 204 # define DRM_MODE_FB_CMD drm_mode_fb_cmd
 205 #else
 206 # define DRM_MODE_FB_CMD drm_mode_fb_cmd2
 207 #endif
 208
 209 #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 15, 0)
 210 # define CRTC_FB(crtc) (crtc)->fb
 211 #else
 212 # define CRTC_FB(crtc) (crtc)->primary->fb
 213 #endif
 214
 215 void vbox_enable_accel(struct vbox_private *vbox);
 216 void vbox_disable_accel(struct vbox_private *vbox);
 217 void vbox_report_caps(struct vbox_private *vbox);
 218
 219 void vbox_framebuffer_dirty_rectangles(struct drm_framebuffer *fb,
 220                                        struct drm_clip_rect *rects,
 221                                        unsigned num_rects);
 222
 223 int vbox_framebuffer_init(struct drm_device *dev,
 224              struct vbox_framebuffer *vbox_fb,
 225 #if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 5, 0)
 226              const
 227 #endif
 228              struct DRM_MODE_FB_CMD *mode_cmd,
 229              struct drm_gem_object *obj);
 230
 231 int vbox_fbdev_init(struct drm_device *dev);
 232 void vbox_fbdev_fini(struct drm_device *dev);
 233 void vbox_fbdev_set_suspend(struct drm_device *dev, int state);
 234 void vbox_fbdev_set_base(struct vbox_private *vbox, unsigned long gpu_addr);
 235
 236 struct vbox_bo {
 237     struct ttm_buffer_object bo;
 238     struct ttm_placement placement;
 239     struct ttm_bo_kmap_obj kmap;
 240     struct drm_gem_object gem;
 241 #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 18, 0)
 242     u32 placements[3];
 243 #else
 244     struct ttm_place placements[3];
 245 #endif
 246     int pin_count;
 247 };
 248 #define gem_to_vbox_bo(gobj) container_of((gobj), struct vbox_bo, gem)
 249
 250 static inline struct vbox_bo *
 251 vbox_bo(struct ttm_buffer_object *bo)
 252 {
 253     return container_of(bo, struct vbox_bo, bo);
 254 }
 255
 256
 257 #define to_vbox_obj(x) container_of(x, struct vbox_gem_object, base)
 258
 259 extern int vbox_dumb_create(struct drm_file *file,
 260                struct drm_device *dev,
 261                struct drm_mode_create_dumb *args);
 262 #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 12, 0)
 263 extern int vbox_dumb_destroy(struct drm_file *file,
 264                 struct drm_device *dev,
 265                 uint32_t handle);
 266 #endif
 267
 268 extern void vbox_gem_free_object(struct drm_gem_object *obj);
 269 extern int vbox_dumb_mmap_offset(struct drm_file *file,
 270                 struct drm_device *dev,
 271                 uint32_t handle,
 272                 uint64_t *offset);
 273
 274 #define DRM_FILE_PAGE_OFFSET (0x10000000ULL >> PAGE_SHIFT)
 275
 276 int vbox_mm_init(struct vbox_private *vbox);
 277 void vbox_mm_fini(struct vbox_private *vbox);
 278
 279 int vbox_bo_create(struct drm_device *dev, int size, int align,
 280           uint32_t flags, struct vbox_bo **pvboxbo);
 281
 282 int vbox_gem_create(struct drm_device *dev,
 283            u32 size, bool iskernel,
 284            struct drm_gem_object **obj);
 285
 286 int vbox_bo_pin(struct vbox_bo *bo, u32 pl_flag, u64 *gpu_addr);
 287 int vbox_bo_unpin(struct vbox_bo *bo);
 288
 289 static inline int vbox_bo_reserve(struct vbox_bo *bo, bool no_wait)
 290 {
 291     int ret;
 292
 293 #if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 7, 0)
 294     ret = ttm_bo_reserve(&bo->bo, true, no_wait, NULL);
 295 #else
 296     ret = ttm_bo_reserve(&bo->bo, true, no_wait, false, 0);
 297 #endif
 298     if (ret)
 299     {
 300         if (ret != -ERESTARTSYS && ret != -EBUSY)
 301             DRM_ERROR("reserve failed %p\n", bo);
 302         return ret;
 303     }
 304     return 0;
 305 }
 306
 307 static inline void vbox_bo_unreserve(struct vbox_bo *bo)
 308 {
 309     ttm_bo_unreserve(&bo->bo);
 310 }
 311
 312 void vbox_ttm_placement(struct vbox_bo *bo, int domain);
 313 int vbox_bo_push_sysram(struct vbox_bo *bo);
 314 int vbox_mmap(struct file *filp, struct vm_area_struct *vma);
 315
 316 /* vbox_irq.c */
 317 int vbox_irq_init(struct vbox_private *vbox);
 318 void vbox_irq_fini(struct vbox_private *vbox);
 319 void vbox_report_hotplug(struct vbox_private *vbox);
 320 irqreturn_t vbox_irq_handler(int irq, void *arg);
 321 #endif