drivers/gpu/drm/vboxvideo/vbox_drv.h

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