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