580 lines · c
1/* SPDX-License-Identifier: GPL-2.0 OR MIT */2/**************************************************************************3 *4 * Copyright (c) 2009-2024 Broadcom. All Rights Reserved. The term5 * “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.6 *7 * Permission is hereby granted, free of charge, to any person obtaining a8 * copy of this software and associated documentation files (the9 * "Software"), to deal in the Software without restriction, including10 * without limitation the rights to use, copy, modify, merge, publish,11 * distribute, sub license, and/or sell copies of the Software, and to12 * permit persons to whom the Software is furnished to do so, subject to13 * the following conditions:14 *15 * The above copyright notice and this permission notice (including the16 * next paragraph) shall be included in all copies or substantial portions17 * of the Software.18 *19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,21 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL22 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,23 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR24 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE25 * USE OR OTHER DEALINGS IN THE SOFTWARE.26 *27 **************************************************************************/28 29#ifndef VMWGFX_KMS_H_30#define VMWGFX_KMS_H_31 32#include <drm/drm_encoder.h>33#include <drm/drm_framebuffer.h>34#include <drm/drm_probe_helper.h>35 36#include "vmwgfx_drv.h"37 38/**39 * struct vmw_du_update_plane - Closure structure for vmw_du_helper_plane_update40 * @plane: Plane which is being updated.41 * @old_state: Old state of plane.42 * @dev_priv: Device private.43 * @du: Display unit on which to update the plane.44 * @vfb: Framebuffer which is blitted to display unit.45 * @out_fence: Out fence for resource finish.46 * @mutex: The mutex used to protect resource reservation.47 * @cpu_blit: True if need cpu blit.48 * @intr: Whether to perform waits interruptible if possible.49 *50 * This structure loosely represent the set of operations needed to perform a51 * plane update on a display unit. Implementer will define that functionality52 * according to the function callbacks for this structure. In brief it involves53 * surface/buffer object validation, populate FIFO commands and command54 * submission to the device.55 */56struct vmw_du_update_plane {57 /**58 * @calc_fifo_size: Calculate fifo size.59 *60 * Determine fifo size for the commands needed for update. The number of61 * damage clips on display unit @num_hits will be passed to allocate62 * sufficient fifo space.63 *64 * Return: Fifo size needed65 */66 uint32_t (*calc_fifo_size)(struct vmw_du_update_plane *update,67 uint32_t num_hits);68 69 /**70 * @post_prepare: Populate fifo for resource preparation.71 *72 * Some surface resource or buffer object need some extra cmd submission73 * like update GB image for proxy surface and define a GMRFB for screen74 * object. That should be done here as this callback will be75 * called after FIFO allocation with the address of command buufer.76 *77 * This callback is optional.78 *79 * Return: Size of commands populated to command buffer.80 */81 uint32_t (*post_prepare)(struct vmw_du_update_plane *update, void *cmd);82 83 /**84 * @pre_clip: Populate fifo before clip.85 *86 * This is where pre clip related command should be populated like87 * surface copy/DMA, etc.88 *89 * This callback is optional.90 *91 * Return: Size of commands populated to command buffer.92 */93 uint32_t (*pre_clip)(struct vmw_du_update_plane *update, void *cmd,94 uint32_t num_hits);95 96 /**97 * @clip: Populate fifo for clip.98 *99 * This is where to populate clips for surface copy/dma or blit commands100 * if needed. This will be called times have damage in display unit,101 * which is one if doing full update. @clip is the damage in destination102 * coordinates which is crtc/DU and @src_x, @src_y is damage clip src in103 * framebuffer coordinate.104 *105 * This callback is optional.106 *107 * Return: Size of commands populated to command buffer.108 */109 uint32_t (*clip)(struct vmw_du_update_plane *update, void *cmd,110 struct drm_rect *clip, uint32_t src_x, uint32_t src_y);111 112 /**113 * @post_clip: Populate fifo after clip.114 *115 * This is where to populate display unit update commands or blit116 * commands.117 *118 * Return: Size of commands populated to command buffer.119 */120 uint32_t (*post_clip)(struct vmw_du_update_plane *update, void *cmd,121 struct drm_rect *bb);122 123 struct drm_plane *plane;124 struct drm_plane_state *old_state;125 struct vmw_private *dev_priv;126 struct vmw_display_unit *du;127 struct vmw_framebuffer *vfb;128 struct vmw_fence_obj **out_fence;129 struct mutex *mutex;130 bool intr;131};132 133/**134 * struct vmw_du_update_plane_surface - closure structure for surface135 * @base: base closure structure.136 * @cmd_start: FIFO command start address (used by SOU only).137 */138struct vmw_du_update_plane_surface {139 struct vmw_du_update_plane base;140 /* This member is to handle special case SOU surface update */141 void *cmd_start;142};143 144/**145 * struct vmw_du_update_plane_buffer - Closure structure for buffer object146 * @base: Base closure structure.147 * @fb_left: x1 for fb damage bounding box.148 * @fb_top: y1 for fb damage bounding box.149 */150struct vmw_du_update_plane_buffer {151 struct vmw_du_update_plane base;152 int fb_left, fb_top;153};154 155/**156 * struct vmw_kms_dirty - closure structure for the vmw_kms_helper_dirty157 * function.158 *159 * @fifo_commit: Callback that is called once for each display unit after160 * all clip rects. This function must commit the fifo space reserved by the161 * helper. Set up by the caller.162 * @clip: Callback that is called for each cliprect on each display unit.163 * Set up by the caller.164 * @fifo_reserve_size: Fifo size that the helper should try to allocat for165 * each display unit. Set up by the caller.166 * @dev_priv: Pointer to the device private. Set up by the helper.167 * @unit: The current display unit. Set up by the helper before a call to @clip.168 * @cmd: The allocated fifo space. Set up by the helper before the first @clip169 * call.170 * @crtc: The crtc for which to build dirty commands.171 * @num_hits: Number of clip rect commands for this display unit.172 * Cleared by the helper before the first @clip call. Updated by the @clip173 * callback.174 * @fb_x: Clip rect left side in framebuffer coordinates.175 * @fb_y: Clip rect right side in framebuffer coordinates.176 * @unit_x1: Clip rect left side in crtc coordinates.177 * @unit_y1: Clip rect top side in crtc coordinates.178 * @unit_x2: Clip rect right side in crtc coordinates.179 * @unit_y2: Clip rect bottom side in crtc coordinates.180 *181 * The clip rect coordinates are updated by the helper for each @clip call.182 * Note that this may be derived from if more info needs to be passed between183 * helper caller and helper callbacks.184 */185struct vmw_kms_dirty {186 void (*fifo_commit)(struct vmw_kms_dirty *);187 void (*clip)(struct vmw_kms_dirty *);188 size_t fifo_reserve_size;189 struct vmw_private *dev_priv;190 struct vmw_display_unit *unit;191 void *cmd;192 struct drm_crtc *crtc;193 u32 num_hits;194 s32 fb_x;195 s32 fb_y;196 s32 unit_x1;197 s32 unit_y1;198 s32 unit_x2;199 s32 unit_y2;200};201 202#define vmw_framebuffer_to_vfb(x) \203 container_of(x, struct vmw_framebuffer, base)204#define vmw_framebuffer_to_vfbs(x) \205 container_of(x, struct vmw_framebuffer_surface, base.base)206#define vmw_framebuffer_to_vfbd(x) \207 container_of(x, struct vmw_framebuffer_bo, base.base)208 209/**210 * Base class for framebuffers211 *212 * @pin is called the when ever a crtc uses this framebuffer213 * @unpin is called214 */215struct vmw_framebuffer {216 struct drm_framebuffer base;217 bool bo;218};219 220struct vmw_framebuffer_surface {221 struct vmw_framebuffer base;222 struct vmw_user_object uo;223};224 225struct vmw_framebuffer_bo {226 struct vmw_framebuffer base;227 struct vmw_bo *buffer;228};229 230 231static const uint32_t __maybe_unused vmw_primary_plane_formats[] = {232 DRM_FORMAT_XRGB8888,233 DRM_FORMAT_ARGB8888,234 DRM_FORMAT_RGB565,235 DRM_FORMAT_XRGB1555,236};237 238static const uint32_t __maybe_unused vmw_cursor_plane_formats[] = {239 DRM_FORMAT_ARGB8888,240};241 242 243#define vmw_crtc_state_to_vcs(x) container_of(x, struct vmw_crtc_state, base)244#define vmw_plane_state_to_vps(x) container_of(x, struct vmw_plane_state, base)245#define vmw_connector_state_to_vcs(x) \246 container_of(x, struct vmw_connector_state, base)247#define vmw_plane_to_vcp(x) container_of(x, struct vmw_cursor_plane, base)248 249/**250 * Derived class for crtc state object251 *252 * @base DRM crtc object253 */254struct vmw_crtc_state {255 struct drm_crtc_state base;256};257 258struct vmw_cursor_plane_state {259 struct vmw_bo *bo;260 s32 hotspot_x;261 s32 hotspot_y;262};263 264/**265 * Derived class for plane state object266 *267 * @base DRM plane object268 * @surf Display surface for STDU269 * @bo display bo for SOU270 * @content_fb_type Used by STDU.271 * @bo_size Size of the bo, used by Screen Object Display Unit272 * @pinned pin count for STDU display surface273 */274struct vmw_plane_state {275 struct drm_plane_state base;276 struct vmw_user_object uo;277 278 int content_fb_type;279 unsigned long bo_size;280 281 int pinned;282 283 /* For CPU Blit */284 unsigned int cpp;285 286 bool surf_mapped;287 struct vmw_cursor_plane_state cursor;288};289 290 291/**292 * Derived class for connector state object293 *294 * @base DRM connector object295 * @is_implicit connector property296 *297 */298struct vmw_connector_state {299 struct drm_connector_state base;300 301 /**302 * @gui_x:303 *304 * vmwgfx connector property representing the x position of this display305 * unit (connector is synonymous to display unit) in overall topology.306 * This is what the device expect as xRoot while creating screen.307 */308 int gui_x;309 310 /**311 * @gui_y:312 *313 * vmwgfx connector property representing the y position of this display314 * unit (connector is synonymous to display unit) in overall topology.315 * This is what the device expect as yRoot while creating screen.316 */317 int gui_y;318};319 320/**321 * Derived class for cursor plane object322 *323 * @base DRM plane object324 * @cursor.cursor_mobs Cursor mobs available for re-use325 */326struct vmw_cursor_plane {327 struct drm_plane base;328 329 struct vmw_bo *cursor_mobs[3];330};331 332/**333 * Base class display unit.334 *335 * Since the SVGA hw doesn't have a concept of a crtc, encoder or connector336 * so the display unit is all of them at the same time. This is true for both337 * legacy multimon and screen objects.338 */339struct vmw_display_unit {340 struct drm_crtc crtc;341 struct drm_encoder encoder;342 struct drm_connector connector;343 struct drm_plane primary;344 struct vmw_cursor_plane cursor;345 346 struct vmw_surface *cursor_surface;347 size_t cursor_age;348 349 int cursor_x;350 int cursor_y;351 352 int hotspot_x;353 int hotspot_y;354 s32 core_hotspot_x;355 s32 core_hotspot_y;356 357 unsigned unit;358 359 /*360 * Prefered mode tracking.361 */362 unsigned pref_width;363 unsigned pref_height;364 bool pref_active;365 366 /*367 * Gui positioning368 */369 int gui_x;370 int gui_y;371 bool is_implicit;372 int set_gui_x;373 int set_gui_y;374 375 struct {376 struct work_struct crc_generator_work;377 struct hrtimer timer;378 ktime_t period_ns;379 380 /* protects concurrent access to the vblank handler */381 atomic_t atomic_lock;382 /* protected by @atomic_lock */383 bool crc_enabled;384 struct vmw_surface *surface;385 386 /* protects concurrent access to the crc worker */387 spinlock_t crc_state_lock;388 /* protected by @crc_state_lock */389 bool crc_pending;390 u64 frame_start;391 u64 frame_end;392 } vkms;393};394 395#define vmw_crtc_to_du(x) \396 container_of(x, struct vmw_display_unit, crtc)397#define vmw_connector_to_du(x) \398 container_of(x, struct vmw_display_unit, connector)399 400 401/*402 * Shared display unit functions - vmwgfx_kms.c403 */404void vmw_du_init(struct vmw_display_unit *du);405void vmw_du_cleanup(struct vmw_display_unit *du);406void vmw_du_crtc_save(struct drm_crtc *crtc);407void vmw_du_crtc_restore(struct drm_crtc *crtc);408int vmw_du_crtc_gamma_set(struct drm_crtc *crtc,409 u16 *r, u16 *g, u16 *b,410 uint32_t size,411 struct drm_modeset_acquire_ctx *ctx);412int vmw_du_connector_set_property(struct drm_connector *connector,413 struct drm_property *property,414 uint64_t val);415int vmw_du_connector_atomic_set_property(struct drm_connector *connector,416 struct drm_connector_state *state,417 struct drm_property *property,418 uint64_t val);419int420vmw_du_connector_atomic_get_property(struct drm_connector *connector,421 const struct drm_connector_state *state,422 struct drm_property *property,423 uint64_t *val);424int vmw_du_connector_dpms(struct drm_connector *connector, int mode);425void vmw_du_connector_save(struct drm_connector *connector);426void vmw_du_connector_restore(struct drm_connector *connector);427enum drm_connector_status428vmw_du_connector_detect(struct drm_connector *connector, bool force);429int vmw_kms_helper_dirty(struct vmw_private *dev_priv,430 struct vmw_framebuffer *framebuffer,431 const struct drm_clip_rect *clips,432 const struct drm_vmw_rect *vclips,433 s32 dest_x, s32 dest_y,434 int num_clips,435 int increment,436 struct vmw_kms_dirty *dirty);437enum drm_mode_status vmw_connector_mode_valid(struct drm_connector *connector,438 struct drm_display_mode *mode);439int vmw_connector_get_modes(struct drm_connector *connector);440 441void vmw_kms_helper_validation_finish(struct vmw_private *dev_priv,442 struct drm_file *file_priv,443 struct vmw_validation_context *ctx,444 struct vmw_fence_obj **out_fence,445 struct drm_vmw_fence_rep __user *446 user_fence_rep);447int vmw_kms_readback(struct vmw_private *dev_priv,448 struct drm_file *file_priv,449 struct vmw_framebuffer *vfb,450 struct drm_vmw_fence_rep __user *user_fence_rep,451 struct drm_vmw_rect *vclips,452 uint32_t num_clips);453struct vmw_framebuffer *454vmw_kms_new_framebuffer(struct vmw_private *dev_priv,455 struct vmw_user_object *uo,456 const struct drm_mode_fb_cmd2 *mode_cmd);457void vmw_guess_mode_timing(struct drm_display_mode *mode);458void vmw_kms_update_implicit_fb(struct vmw_private *dev_priv);459void vmw_kms_create_implicit_placement_property(struct vmw_private *dev_priv);460 461/* Universal Plane Helpers */462void vmw_du_primary_plane_destroy(struct drm_plane *plane);463void vmw_du_cursor_plane_destroy(struct drm_plane *plane);464 465/* Atomic Helpers */466int vmw_du_primary_plane_atomic_check(struct drm_plane *plane,467 struct drm_atomic_state *state);468int vmw_du_cursor_plane_atomic_check(struct drm_plane *plane,469 struct drm_atomic_state *state);470void vmw_du_cursor_plane_atomic_update(struct drm_plane *plane,471 struct drm_atomic_state *state);472int vmw_du_cursor_plane_prepare_fb(struct drm_plane *plane,473 struct drm_plane_state *new_state);474void vmw_du_cursor_plane_cleanup_fb(struct drm_plane *plane,475 struct drm_plane_state *old_state);476void vmw_du_plane_cleanup_fb(struct drm_plane *plane,477 struct drm_plane_state *old_state);478void vmw_du_plane_reset(struct drm_plane *plane);479struct drm_plane_state *vmw_du_plane_duplicate_state(struct drm_plane *plane);480void vmw_du_plane_destroy_state(struct drm_plane *plane,481 struct drm_plane_state *state);482void vmw_du_plane_unpin_surf(struct vmw_plane_state *vps);483 484int vmw_du_crtc_atomic_check(struct drm_crtc *crtc,485 struct drm_atomic_state *state);486void vmw_du_crtc_atomic_begin(struct drm_crtc *crtc,487 struct drm_atomic_state *state);488void vmw_du_crtc_reset(struct drm_crtc *crtc);489struct drm_crtc_state *vmw_du_crtc_duplicate_state(struct drm_crtc *crtc);490void vmw_du_crtc_destroy_state(struct drm_crtc *crtc,491 struct drm_crtc_state *state);492void vmw_du_connector_reset(struct drm_connector *connector);493struct drm_connector_state *494vmw_du_connector_duplicate_state(struct drm_connector *connector);495 496void vmw_du_connector_destroy_state(struct drm_connector *connector,497 struct drm_connector_state *state);498 499/*500 * Legacy display unit functions - vmwgfx_ldu.c501 */502int vmw_kms_ldu_init_display(struct vmw_private *dev_priv);503int vmw_kms_ldu_close_display(struct vmw_private *dev_priv);504int vmw_kms_update_proxy(struct vmw_resource *res,505 const struct drm_clip_rect *clips,506 unsigned num_clips,507 int increment);508 509/*510 * Screen Objects display functions - vmwgfx_scrn.c511 */512int vmw_kms_sou_init_display(struct vmw_private *dev_priv);513int vmw_kms_sou_do_surface_dirty(struct vmw_private *dev_priv,514 struct vmw_framebuffer *framebuffer,515 struct drm_clip_rect *clips,516 struct drm_vmw_rect *vclips,517 struct vmw_resource *srf,518 s32 dest_x,519 s32 dest_y,520 unsigned num_clips, int inc,521 struct vmw_fence_obj **out_fence,522 struct drm_crtc *crtc);523int vmw_kms_sou_do_bo_dirty(struct vmw_private *dev_priv,524 struct vmw_framebuffer *framebuffer,525 struct drm_clip_rect *clips,526 struct drm_vmw_rect *vclips,527 unsigned int num_clips, int increment,528 bool interruptible,529 struct vmw_fence_obj **out_fence,530 struct drm_crtc *crtc);531int vmw_kms_sou_readback(struct vmw_private *dev_priv,532 struct drm_file *file_priv,533 struct vmw_framebuffer *vfb,534 struct drm_vmw_fence_rep __user *user_fence_rep,535 struct drm_vmw_rect *vclips,536 uint32_t num_clips,537 struct drm_crtc *crtc);538 539/*540 * Screen Target Display Unit functions - vmwgfx_stdu.c541 */542int vmw_kms_stdu_init_display(struct vmw_private *dev_priv);543int vmw_kms_stdu_surface_dirty(struct vmw_private *dev_priv,544 struct vmw_framebuffer *framebuffer,545 struct drm_clip_rect *clips,546 struct drm_vmw_rect *vclips,547 struct vmw_resource *srf,548 s32 dest_x,549 s32 dest_y,550 unsigned num_clips, int inc,551 struct vmw_fence_obj **out_fence,552 struct drm_crtc *crtc);553int vmw_kms_stdu_readback(struct vmw_private *dev_priv,554 struct drm_file *file_priv,555 struct vmw_framebuffer *vfb,556 struct drm_vmw_fence_rep __user *user_fence_rep,557 struct drm_clip_rect *clips,558 struct drm_vmw_rect *vclips,559 uint32_t num_clips,560 int increment,561 struct drm_crtc *crtc);562 563int vmw_du_helper_plane_update(struct vmw_du_update_plane *update);564 565/**566 * vmw_du_translate_to_crtc - Translate a rect from framebuffer to crtc567 * @state: Plane state.568 * @r: Rectangle to translate.569 */570static inline void vmw_du_translate_to_crtc(struct drm_plane_state *state,571 struct drm_rect *r)572{573 int translate_crtc_x = -((state->src_x >> 16) - state->crtc_x);574 int translate_crtc_y = -((state->src_y >> 16) - state->crtc_y);575 576 drm_rect_translate(r, translate_crtc_x, translate_crtc_y);577}578 579#endif580