drivers/gpu/drm/vmwgfx/vmwgfx_kms.h

   1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */
   2 /**************************************************************************
   3  *
   4  * Copyright 2009-2015 VMware, Inc., Palo Alto, CA., USA
   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 <drm/drm_encoder.h>
  34 #include "vmwgfx_drv.h"
  35
  36
  37
  38 /**
  39  * struct vmw_kms_dirty - closure structure for the vmw_kms_helper_dirty
  40  * function.
  41  *
  42  * @fifo_commit: Callback that is called once for each display unit after
  43  * all clip rects. This function must commit the fifo space reserved by the
  44  * helper. Set up by the caller.
  45  * @clip: Callback that is called for each cliprect on each display unit.
  46  * Set up by the caller.
  47  * @fifo_reserve_size: Fifo size that the helper should try to allocat for
  48  * each display unit. Set up by the caller.
  49  * @dev_priv: Pointer to the device private. Set up by the helper.
  50  * @unit: The current display unit. Set up by the helper before a call to @clip.
  51  * @cmd: The allocated fifo space. Set up by the helper before the first @clip
  52  * call.
  53  * @crtc: The crtc for which to build dirty commands.
  54  * @num_hits: Number of clip rect commands for this display unit.
  55  * Cleared by the helper before the first @clip call. Updated by the @clip
  56  * callback.
  57  * @fb_x: Clip rect left side in framebuffer coordinates.
  58  * @fb_y: Clip rect right side in framebuffer coordinates.
  59  * @unit_x1: Clip rect left side in crtc coordinates.
  60  * @unit_y1: Clip rect top side in crtc coordinates.
  61  * @unit_x2: Clip rect right side in crtc coordinates.
  62  * @unit_y2: Clip rect bottom side in crtc coordinates.
  63  *
  64  * The clip rect coordinates are updated by the helper for each @clip call.
  65  * Note that this may be derived from if more info needs to be passed between
  66  * helper caller and helper callbacks.
  67  */
  68 struct vmw_kms_dirty {
  69         void (*fifo_commit)(struct vmw_kms_dirty *);
  70         void (*clip)(struct vmw_kms_dirty *);
  71         size_t fifo_reserve_size;
  72         struct vmw_private *dev_priv;
  73         struct vmw_display_unit *unit;
  74         void *cmd;
  75         struct drm_crtc *crtc;
  76         u32 num_hits;
  77         s32 fb_x;
  78         s32 fb_y;
  79         s32 unit_x1;
  80         s32 unit_y1;
  81         s32 unit_x2;
  82         s32 unit_y2;
  83 };
  84
  85 #define VMWGFX_NUM_DISPLAY_UNITS 8
  86
  87
  88 #define vmw_framebuffer_to_vfb(x) \
  89         container_of(x, struct vmw_framebuffer, base)
  90 #define vmw_framebuffer_to_vfbs(x) \
  91         container_of(x, struct vmw_framebuffer_surface, base.base)
  92 #define vmw_framebuffer_to_vfbd(x) \
  93         container_of(x, struct vmw_framebuffer_bo, base.base)
  94
  95 /**
  96  * Base class for framebuffers
  97  *
  98  * @pin is called the when ever a crtc uses this framebuffer
  99  * @unpin is called
 100  */
 101 struct vmw_framebuffer {
 102         struct drm_framebuffer base;
 103         int (*pin)(struct vmw_framebuffer *fb);
 104         int (*unpin)(struct vmw_framebuffer *fb);
 105         bool bo;
 106         struct ttm_base_object *user_obj;
 107         uint32_t user_handle;
 108 };
 109
 110 /*
 111  * Clip rectangle
 112  */
 113 struct vmw_clip_rect {
 114         int x1, x2, y1, y2;
 115 };
 116
 117 struct vmw_framebuffer_surface {
 118         struct vmw_framebuffer base;
 119         struct vmw_surface *surface;
 120         struct vmw_buffer_object *buffer;
 121         struct list_head head;
 122         bool is_bo_proxy;  /* true if this is proxy surface for DMA buf */
 123 };
 124
 125
 126 struct vmw_framebuffer_bo {
 127         struct vmw_framebuffer base;
 128         struct vmw_buffer_object *buffer;
 129 };
 130
 131
 132 static const uint32_t vmw_primary_plane_formats[] = {
 133         DRM_FORMAT_XRGB1555,
 134         DRM_FORMAT_RGB565,
 135         DRM_FORMAT_RGB888,
 136         DRM_FORMAT_XRGB8888,
 137         DRM_FORMAT_ARGB8888,
 138 };
 139
 140 static const uint32_t vmw_cursor_plane_formats[] = {
 141         DRM_FORMAT_ARGB8888,
 142 };
 143
 144
 145 #define vmw_crtc_state_to_vcs(x) container_of(x, struct vmw_crtc_state, base)
 146 #define vmw_plane_state_to_vps(x) container_of(x, struct vmw_plane_state, base)
 147 #define vmw_connector_state_to_vcs(x) \
 148                 container_of(x, struct vmw_connector_state, base)
 149
 150 /**
 151  * Derived class for crtc state object
 152  *
 153  * @base DRM crtc object
 154  */
 155 struct vmw_crtc_state {
 156         struct drm_crtc_state base;
 157 };
 158
 159 /**
 160  * Derived class for plane state object
 161  *
 162  * @base DRM plane object
 163  * @surf Display surface for STDU
 164  * @bo display bo for SOU
 165  * @content_fb_type Used by STDU.
 166  * @bo_size Size of the bo, used by Screen Object Display Unit
 167  * @pinned pin count for STDU display surface
 168  */
 169 struct vmw_plane_state {
 170         struct drm_plane_state base;
 171         struct vmw_surface *surf;
 172         struct vmw_buffer_object *bo;
 173
 174         int content_fb_type;
 175         unsigned long bo_size;
 176
 177         int pinned;
 178
 179         /* For CPU Blit */
 180         unsigned int cpp;
 181 };
 182
 183
 184 /**
 185  * Derived class for connector state object
 186  *
 187  * @base DRM connector object
 188  * @is_implicit connector property
 189  *
 190  */
 191 struct vmw_connector_state {
 192         struct drm_connector_state base;
 193
 194         bool is_implicit;
 195
 196         /**
 197          * @gui_x:
 198          *
 199          * vmwgfx connector property representing the x position of this display
 200          * unit (connector is synonymous to display unit) in overall topology.
 201          * This is what the device expect as xRoot while creating screen.
 202          */
 203         int gui_x;
 204
 205         /**
 206          * @gui_y:
 207          *
 208          * vmwgfx connector property representing the y position of this display
 209          * unit (connector is synonymous to display unit) in overall topology.
 210          * This is what the device expect as yRoot while creating screen.
 211          */
 212         int gui_y;
 213 };
 214
 215 /**
 216  * Base class display unit.
 217  *
 218  * Since the SVGA hw doesn't have a concept of a crtc, encoder or connector
 219  * so the display unit is all of them at the same time. This is true for both
 220  * legacy multimon and screen objects.
 221  */
 222 struct vmw_display_unit {
 223         struct drm_crtc crtc;
 224         struct drm_encoder encoder;
 225         struct drm_connector connector;
 226         struct drm_plane primary;
 227         struct drm_plane cursor;
 228
 229         struct vmw_surface *cursor_surface;
 230         struct vmw_buffer_object *cursor_bo;
 231         size_t cursor_age;
 232
 233         int cursor_x;
 234         int cursor_y;
 235
 236         int hotspot_x;
 237         int hotspot_y;
 238         s32 core_hotspot_x;
 239         s32 core_hotspot_y;
 240
 241         unsigned unit;
 242
 243         /*
 244          * Prefered mode tracking.
 245          */
 246         unsigned pref_width;
 247         unsigned pref_height;
 248         bool pref_active;
 249         struct drm_display_mode *pref_mode;
 250
 251         /*
 252          * Gui positioning
 253          */
 254         int gui_x;
 255         int gui_y;
 256         bool is_implicit;
 257         bool active_implicit;
 258         int set_gui_x;
 259         int set_gui_y;
 260 };
 261
 262 struct vmw_validation_ctx {
 263         struct vmw_resource *res;
 264         struct vmw_buffer_object *buf;
 265 };
 266
 267 #define vmw_crtc_to_du(x) \
 268         container_of(x, struct vmw_display_unit, crtc)
 269 #define vmw_connector_to_du(x) \
 270         container_of(x, struct vmw_display_unit, connector)
 271
 272
 273 /*
 274  * Shared display unit functions - vmwgfx_kms.c
 275  */
 276 void vmw_du_cleanup(struct vmw_display_unit *du);
 277 void vmw_du_crtc_save(struct drm_crtc *crtc);
 278 void vmw_du_crtc_restore(struct drm_crtc *crtc);
 279 int vmw_du_crtc_gamma_set(struct drm_crtc *crtc,
 280                            u16 *r, u16 *g, u16 *b,
 281                            uint32_t size,
 282                            struct drm_modeset_acquire_ctx *ctx);
 283 int vmw_du_connector_set_property(struct drm_connector *connector,
 284                                   struct drm_property *property,
 285                                   uint64_t val);
 286 int vmw_du_connector_atomic_set_property(struct drm_connector *connector,
 287                                          struct drm_connector_state *state,
 288                                          struct drm_property *property,
 289                                          uint64_t val);
 290 int
 291 vmw_du_connector_atomic_get_property(struct drm_connector *connector,
 292                                      const struct drm_connector_state *state,
 293                                      struct drm_property *property,
 294                                      uint64_t *val);
 295 int vmw_du_connector_dpms(struct drm_connector *connector, int mode);
 296 void vmw_du_connector_save(struct drm_connector *connector);
 297 void vmw_du_connector_restore(struct drm_connector *connector);
 298 enum drm_connector_status
 299 vmw_du_connector_detect(struct drm_connector *connector, bool force);
 300 int vmw_du_connector_fill_modes(struct drm_connector *connector,
 301                                 uint32_t max_width, uint32_t max_height);
 302 int vmw_kms_helper_dirty(struct vmw_private *dev_priv,
 303                          struct vmw_framebuffer *framebuffer,
 304                          const struct drm_clip_rect *clips,
 305                          const struct drm_vmw_rect *vclips,
 306                          s32 dest_x, s32 dest_y,
 307                          int num_clips,
 308                          int increment,
 309                          struct vmw_kms_dirty *dirty);
 310
 311 int vmw_kms_helper_buffer_prepare(struct vmw_private *dev_priv,
 312                                   struct vmw_buffer_object *buf,
 313                                   bool interruptible,
 314                                   bool validate_as_mob,
 315                                   bool for_cpu_blit);
 316 void vmw_kms_helper_buffer_revert(struct vmw_buffer_object *buf);
 317 void vmw_kms_helper_buffer_finish(struct vmw_private *dev_priv,
 318                                   struct drm_file *file_priv,
 319                                   struct vmw_buffer_object *buf,
 320                                   struct vmw_fence_obj **out_fence,
 321                                   struct drm_vmw_fence_rep __user *
 322                                   user_fence_rep);
 323 int vmw_kms_helper_resource_prepare(struct vmw_resource *res,
 324                                     bool interruptible,
 325                                     struct vmw_validation_ctx *ctx);
 326 void vmw_kms_helper_resource_revert(struct vmw_validation_ctx *ctx);
 327 void vmw_kms_helper_resource_finish(struct vmw_validation_ctx *ctx,
 328                                     struct vmw_fence_obj **out_fence);
 329 int vmw_kms_readback(struct vmw_private *dev_priv,
 330                      struct drm_file *file_priv,
 331                      struct vmw_framebuffer *vfb,
 332                      struct drm_vmw_fence_rep __user *user_fence_rep,
 333                      struct drm_vmw_rect *vclips,
 334                      uint32_t num_clips);
 335 struct vmw_framebuffer *
 336 vmw_kms_new_framebuffer(struct vmw_private *dev_priv,
 337                         struct vmw_buffer_object *bo,
 338                         struct vmw_surface *surface,
 339                         bool only_2d,
 340                         const struct drm_mode_fb_cmd2 *mode_cmd);
 341 int vmw_kms_fbdev_init_data(struct vmw_private *dev_priv,
 342                             unsigned unit,
 343                             u32 max_width,
 344                             u32 max_height,
 345                             struct drm_connector **p_con,
 346                             struct drm_crtc **p_crtc,
 347                             struct drm_display_mode **p_mode);
 348 void vmw_guess_mode_timing(struct drm_display_mode *mode);
 349 void vmw_kms_del_active(struct vmw_private *dev_priv,
 350                         struct vmw_display_unit *du);
 351 void vmw_kms_add_active(struct vmw_private *dev_priv,
 352                         struct vmw_display_unit *du,
 353                         struct vmw_framebuffer *vfb);
 354 bool vmw_kms_crtc_flippable(struct vmw_private *dev_priv,
 355                             struct drm_crtc *crtc);
 356 void vmw_kms_update_implicit_fb(struct vmw_private *dev_priv,
 357                                 struct drm_crtc *crtc);
 358 void vmw_kms_create_implicit_placement_property(struct vmw_private *dev_priv,
 359                                                 bool immutable);
 360
 361 /* Universal Plane Helpers */
 362 void vmw_du_primary_plane_destroy(struct drm_plane *plane);
 363 void vmw_du_cursor_plane_destroy(struct drm_plane *plane);
 364
 365 /* Atomic Helpers */
 366 int vmw_du_primary_plane_atomic_check(struct drm_plane *plane,
 367                                       struct drm_plane_state *state);
 368 int vmw_du_cursor_plane_atomic_check(struct drm_plane *plane,
 369                                      struct drm_plane_state *state);
 370 void vmw_du_cursor_plane_atomic_update(struct drm_plane *plane,
 371                                        struct drm_plane_state *old_state);
 372 int vmw_du_cursor_plane_prepare_fb(struct drm_plane *plane,
 373                                    struct drm_plane_state *new_state);
 374 void vmw_du_plane_cleanup_fb(struct drm_plane *plane,
 375                              struct drm_plane_state *old_state);
 376 void vmw_du_plane_reset(struct drm_plane *plane);
 377 struct drm_plane_state *vmw_du_plane_duplicate_state(struct drm_plane *plane);
 378 void vmw_du_plane_destroy_state(struct drm_plane *plane,
 379                                 struct drm_plane_state *state);
 380 void vmw_du_plane_unpin_surf(struct vmw_plane_state *vps,
 381                              bool unreference);
 382
 383 int vmw_du_crtc_atomic_check(struct drm_crtc *crtc,
 384                              struct drm_crtc_state *state);
 385 void vmw_du_crtc_atomic_begin(struct drm_crtc *crtc,
 386                               struct drm_crtc_state *old_crtc_state);
 387 void vmw_du_crtc_atomic_flush(struct drm_crtc *crtc,
 388                               struct drm_crtc_state *old_crtc_state);
 389 void vmw_du_crtc_reset(struct drm_crtc *crtc);
 390 struct drm_crtc_state *vmw_du_crtc_duplicate_state(struct drm_crtc *crtc);
 391 void vmw_du_crtc_destroy_state(struct drm_crtc *crtc,
 392                                 struct drm_crtc_state *state);
 393 void vmw_du_connector_reset(struct drm_connector *connector);
 394 struct drm_connector_state *
 395 vmw_du_connector_duplicate_state(struct drm_connector *connector);
 396
 397 void vmw_du_connector_destroy_state(struct drm_connector *connector,
 398                                     struct drm_connector_state *state);
 399
 400 /*
 401  * Legacy display unit functions - vmwgfx_ldu.c
 402  */
 403 int vmw_kms_ldu_init_display(struct vmw_private *dev_priv);
 404 int vmw_kms_ldu_close_display(struct vmw_private *dev_priv);
 405 int vmw_kms_ldu_do_bo_dirty(struct vmw_private *dev_priv,
 406                             struct vmw_framebuffer *framebuffer,
 407                             unsigned int flags, unsigned int color,
 408                             struct drm_clip_rect *clips,
 409                             unsigned int num_clips, int increment);
 410 int vmw_kms_update_proxy(struct vmw_resource *res,
 411                          const struct drm_clip_rect *clips,
 412                          unsigned num_clips,
 413                          int increment);
 414
 415 /*
 416  * Screen Objects display functions - vmwgfx_scrn.c
 417  */
 418 int vmw_kms_sou_init_display(struct vmw_private *dev_priv);
 419 int vmw_kms_sou_do_surface_dirty(struct vmw_private *dev_priv,
 420                                  struct vmw_framebuffer *framebuffer,
 421                                  struct drm_clip_rect *clips,
 422                                  struct drm_vmw_rect *vclips,
 423                                  struct vmw_resource *srf,
 424                                  s32 dest_x,
 425                                  s32 dest_y,
 426                                  unsigned num_clips, int inc,
 427                                  struct vmw_fence_obj **out_fence,
 428                                  struct drm_crtc *crtc);
 429 int vmw_kms_sou_do_bo_dirty(struct vmw_private *dev_priv,
 430                             struct vmw_framebuffer *framebuffer,
 431                             struct drm_clip_rect *clips,
 432                             struct drm_vmw_rect *vclips,
 433                             unsigned int num_clips, int increment,
 434                             bool interruptible,
 435                             struct vmw_fence_obj **out_fence,
 436                             struct drm_crtc *crtc);
 437 int vmw_kms_sou_readback(struct vmw_private *dev_priv,
 438                          struct drm_file *file_priv,
 439                          struct vmw_framebuffer *vfb,
 440                          struct drm_vmw_fence_rep __user *user_fence_rep,
 441                          struct drm_vmw_rect *vclips,
 442                          uint32_t num_clips,
 443                          struct drm_crtc *crtc);
 444
 445 /*
 446  * Screen Target Display Unit functions - vmwgfx_stdu.c
 447  */
 448 int vmw_kms_stdu_init_display(struct vmw_private *dev_priv);
 449 int vmw_kms_stdu_surface_dirty(struct vmw_private *dev_priv,
 450                                struct vmw_framebuffer *framebuffer,
 451                                struct drm_clip_rect *clips,
 452                                struct drm_vmw_rect *vclips,
 453                                struct vmw_resource *srf,
 454                                s32 dest_x,
 455                                s32 dest_y,
 456                                unsigned num_clips, int inc,
 457                                struct vmw_fence_obj **out_fence,
 458                                struct drm_crtc *crtc);
 459 int vmw_kms_stdu_dma(struct vmw_private *dev_priv,
 460                      struct drm_file *file_priv,
 461                      struct vmw_framebuffer *vfb,
 462                      struct drm_vmw_fence_rep __user *user_fence_rep,
 463                      struct drm_clip_rect *clips,
 464                      struct drm_vmw_rect *vclips,
 465                      uint32_t num_clips,
 466                      int increment,
 467                      bool to_surface,
 468                      bool interruptible,
 469                      struct drm_crtc *crtc);
 470
 471 int vmw_kms_set_config(struct drm_mode_set *set,
 472                        struct drm_modeset_acquire_ctx *ctx);
 473 #endif