drivers/gpu/drm/vmwgfx/vmwgfx_kms.h

   1 /**************************************************************************
   2  *
   3  * Copyright © 2009-2014 VMware, Inc., Palo Alto, CA., USA
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  21  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  24  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 #ifndef VMWGFX_KMS_H_
  29 #define VMWGFX_KMS_H_
  30
  31 #include <drm/drmP.h>
  32 #include <drm/drm_crtc_helper.h>
  33 #include "vmwgfx_drv.h"
  34
  35 /**
  36  * struct vmw_kms_dirty - closure structure for the vmw_kms_helper_dirty
  37  * function.
  38  *
  39  * @fifo_commit: Callback that is called once for each display unit after
  40  * all clip rects. This function must commit the fifo space reserved by the
  41  * helper. Set up by the caller.
  42  * @clip: Callback that is called for each cliprect on each display unit.
  43  * Set up by the caller.
  44  * @fifo_reserve_size: Fifo size that the helper should try to allocat for
  45  * each display unit. Set up by the caller.
  46  * @dev_priv: Pointer to the device private. Set up by the helper.
  47  * @unit: The current display unit. Set up by the helper before a call to @clip.
  48  * @cmd: The allocated fifo space. Set up by the helper before the first @clip
  49  * call.
  50  * @num_hits: Number of clip rect commands for this display unit.
  51  * Cleared by the helper before the first @clip call. Updated by the @clip
  52  * callback.
  53  * @fb_x: Clip rect left side in framebuffer coordinates.
  54  * @fb_y: Clip rect right side in framebuffer coordinates.
  55  * @unit_x1: Clip rect left side in crtc coordinates.
  56  * @unit_y1: Clip rect top side in crtc coordinates.
  57  * @unit_x2: Clip rect right side in crtc coordinates.
  58  * @unit_y2: Clip rect bottom side in crtc coordinates.
  59  *
  60  * The clip rect coordinates are updated by the helper for each @clip call.
  61  * Note that this may be derived from if more info needs to be passed between
  62  * helper caller and helper callbacks.
  63  */
  64 struct vmw_kms_dirty {
  65         void (*fifo_commit)(struct vmw_kms_dirty *);
  66         void (*clip)(struct vmw_kms_dirty *);
  67         size_t fifo_reserve_size;
  68         struct vmw_private *dev_priv;
  69         struct vmw_display_unit *unit;
  70         void *cmd;
  71         u32 num_hits;
  72         s32 fb_x;
  73         s32 fb_y;
  74         s32 unit_x1;
  75         s32 unit_y1;
  76         s32 unit_x2;
  77         s32 unit_y2;
  78 };
  79
  80 #define VMWGFX_NUM_DISPLAY_UNITS 8
  81
  82
  83 #define vmw_framebuffer_to_vfb(x) \
  84         container_of(x, struct vmw_framebuffer, base)
  85 #define vmw_framebuffer_to_vfbs(x) \
  86         container_of(x, struct vmw_framebuffer_surface, base.base)
  87 #define vmw_framebuffer_to_vfbd(x) \
  88         container_of(x, struct vmw_framebuffer_dmabuf, base.base)
  89
  90 /**
  91  * Base class for framebuffers
  92  *
  93  * @pin is called the when ever a crtc uses this framebuffer
  94  * @unpin is called
  95  */
  96 struct vmw_framebuffer {
  97         struct drm_framebuffer base;
  98         int (*pin)(struct vmw_framebuffer *fb);
  99         int (*unpin)(struct vmw_framebuffer *fb);
 100         bool dmabuf;
 101         struct ttm_base_object *user_obj;
 102         uint32_t user_handle;
 103 };
 104
 105 /*
 106  * Clip rectangle
 107  */
 108 struct vmw_clip_rect {
 109         int x1, x2, y1, y2;
 110 };
 111
 112 struct vmw_framebuffer_surface {
 113         struct vmw_framebuffer base;
 114         struct vmw_surface *surface;
 115         struct vmw_dma_buffer *buffer;
 116         struct list_head head;
 117         struct drm_master *master;
 118         bool is_dmabuf_proxy;  /* true if this is proxy surface for DMA buf */
 119 };
 120
 121
 122 struct vmw_framebuffer_dmabuf {
 123         struct vmw_framebuffer base;
 124         struct vmw_dma_buffer *buffer;
 125 };
 126
 127
 128 /*
 129  * Basic cursor manipulation
 130  */
 131 int vmw_cursor_update_image(struct vmw_private *dev_priv,
 132                             u32 *image, u32 width, u32 height,
 133                             u32 hotspotX, u32 hotspotY);
 134 int vmw_cursor_update_dmabuf(struct vmw_private *dev_priv,
 135                              struct vmw_dma_buffer *dmabuf,
 136                              u32 width, u32 height,
 137                              u32 hotspotX, u32 hotspotY);
 138 void vmw_cursor_update_position(struct vmw_private *dev_priv,
 139                                 bool show, int x, int y);
 140
 141
 142 /**
 143  * Base class display unit.
 144  *
 145  * Since the SVGA hw doesn't have a concept of a crtc, encoder or connector
 146  * so the display unit is all of them at the same time. This is true for both
 147  * legacy multimon and screen objects.
 148  */
 149 struct vmw_display_unit {
 150         struct drm_crtc crtc;
 151         struct drm_encoder encoder;
 152         struct drm_connector connector;
 153
 154         struct vmw_surface *cursor_surface;
 155         struct vmw_dma_buffer *cursor_dmabuf;
 156         size_t cursor_age;
 157
 158         int cursor_x;
 159         int cursor_y;
 160
 161         int hotspot_x;
 162         int hotspot_y;
 163
 164         unsigned unit;
 165
 166         /*
 167          * Prefered mode tracking.
 168          */
 169         unsigned pref_width;
 170         unsigned pref_height;
 171         bool pref_active;
 172         struct drm_display_mode *pref_mode;
 173
 174         /*
 175          * Gui positioning
 176          */
 177         int gui_x;
 178         int gui_y;
 179         bool is_implicit;
 180 };
 181
 182 #define vmw_crtc_to_du(x) \
 183         container_of(x, struct vmw_display_unit, crtc)
 184 #define vmw_connector_to_du(x) \
 185         container_of(x, struct vmw_display_unit, connector)
 186
 187
 188 /*
 189  * Shared display unit functions - vmwgfx_kms.c
 190  */
 191 void vmw_du_cleanup(struct vmw_display_unit *du);
 192 void vmw_du_crtc_save(struct drm_crtc *crtc);
 193 void vmw_du_crtc_restore(struct drm_crtc *crtc);
 194 void vmw_du_crtc_gamma_set(struct drm_crtc *crtc,
 195                            u16 *r, u16 *g, u16 *b,
 196                            uint32_t start, uint32_t size);
 197 int vmw_du_crtc_cursor_set(struct drm_crtc *crtc, struct drm_file *file_priv,
 198                            uint32_t handle, uint32_t width, uint32_t height);
 199 int vmw_du_crtc_cursor_move(struct drm_crtc *crtc, int x, int y);
 200 void vmw_du_connector_dpms(struct drm_connector *connector, int mode);
 201 void vmw_du_connector_save(struct drm_connector *connector);
 202 void vmw_du_connector_restore(struct drm_connector *connector);
 203 enum drm_connector_status
 204 vmw_du_connector_detect(struct drm_connector *connector, bool force);
 205 int vmw_du_connector_fill_modes(struct drm_connector *connector,
 206                                 uint32_t max_width, uint32_t max_height);
 207 int vmw_du_connector_set_property(struct drm_connector *connector,
 208                                   struct drm_property *property,
 209                                   uint64_t val);
 210 int vmw_kms_helper_dirty(struct vmw_private *dev_priv,
 211                          struct vmw_framebuffer *framebuffer,
 212                          const struct drm_clip_rect *clips,
 213                          const struct drm_vmw_rect *vclips,
 214                          s32 dest_x, s32 dest_y,
 215                          int num_clips,
 216                          int increment,
 217                          struct vmw_kms_dirty *dirty);
 218
 219 int vmw_kms_helper_buffer_prepare(struct vmw_private *dev_priv,
 220                                   struct vmw_dma_buffer *buf,
 221                                   bool interruptible,
 222                                   bool validate_as_mob);
 223 void vmw_kms_helper_buffer_revert(struct vmw_dma_buffer *buf);
 224 void vmw_kms_helper_buffer_finish(struct vmw_private *dev_priv,
 225                                   struct drm_file *file_priv,
 226                                   struct vmw_dma_buffer *buf,
 227                                   struct vmw_fence_obj **out_fence,
 228                                   struct drm_vmw_fence_rep __user *
 229                                   user_fence_rep);
 230 int vmw_kms_helper_resource_prepare(struct vmw_resource *res,
 231                                     bool interruptible);
 232 void vmw_kms_helper_resource_revert(struct vmw_resource *res);
 233 void vmw_kms_helper_resource_finish(struct vmw_resource *res,
 234                                     struct vmw_fence_obj **out_fence);
 235 int vmw_kms_readback(struct vmw_private *dev_priv,
 236                      struct drm_file *file_priv,
 237                      struct vmw_framebuffer *vfb,
 238                      struct drm_vmw_fence_rep __user *user_fence_rep,
 239                      struct drm_vmw_rect *vclips,
 240                      uint32_t num_clips);
 241
 242 /*
 243  * Legacy display unit functions - vmwgfx_ldu.c
 244  */
 245 int vmw_kms_ldu_init_display(struct vmw_private *dev_priv);
 246 int vmw_kms_ldu_close_display(struct vmw_private *dev_priv);
 247 int vmw_kms_ldu_do_dmabuf_dirty(struct vmw_private *dev_priv,
 248                                 struct vmw_framebuffer *framebuffer,
 249                                 unsigned flags, unsigned color,
 250                                 struct drm_clip_rect *clips,
 251                                 unsigned num_clips, int increment);
 252
 253 /*
 254  * Screen Objects display functions - vmwgfx_scrn.c
 255  */
 256 int vmw_kms_sou_init_display(struct vmw_private *dev_priv);
 257 int vmw_kms_sou_close_display(struct vmw_private *dev_priv);
 258 int vmw_kms_sou_do_surface_dirty(struct vmw_private *dev_priv,
 259                                  struct vmw_framebuffer *framebuffer,
 260                                  struct drm_clip_rect *clips,
 261                                  struct drm_vmw_rect *vclips,
 262                                  struct vmw_resource *srf,
 263                                  s32 dest_x,
 264                                  s32 dest_y,
 265                                  unsigned num_clips, int inc,
 266                                  struct vmw_fence_obj **out_fence);
 267 int vmw_kms_sou_do_dmabuf_dirty(struct vmw_private *dev_priv,
 268                                 struct vmw_framebuffer *framebuffer,
 269                                 struct drm_clip_rect *clips,
 270                                 unsigned num_clips, int increment,
 271                                 bool interruptible,
 272                                 struct vmw_fence_obj **out_fence);
 273 int vmw_kms_sou_readback(struct vmw_private *dev_priv,
 274                          struct drm_file *file_priv,
 275                          struct vmw_framebuffer *vfb,
 276                          struct drm_vmw_fence_rep __user *user_fence_rep,
 277                          struct drm_vmw_rect *vclips,
 278                          uint32_t num_clips);
 279
 280 /*
 281  * Screen Target Display Unit functions - vmwgfx_stdu.c
 282  */
 283 int vmw_kms_stdu_init_display(struct vmw_private *dev_priv);
 284 int vmw_kms_stdu_close_display(struct vmw_private *dev_priv);
 285 int vmw_kms_stdu_do_surface_dirty(struct vmw_private *dev_priv,
 286                                   struct drm_file *file_priv,
 287                                   struct vmw_framebuffer *framebuffer,
 288                                   struct drm_clip_rect *clips,
 289                                   unsigned num_clips, int increment);
 290 int vmw_kms_stdu_present(struct vmw_private *dev_priv,
 291                          struct drm_file *file_priv,
 292                          struct vmw_framebuffer *vfb,
 293                          uint32_t user_handle,
 294                          int32_t dest_x, int32_t dest_y,
 295                          struct drm_vmw_rect *clips,
 296                          uint32_t num_clips);
 297
 298 #endif