123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579 |
- /* SPDX-License-Identifier: GPL-2.0 OR MIT */
- /**************************************************************************
- *
- * Copyright 2009-2015 VMware, Inc., Palo Alto, CA., USA
- *
- * Permission is hereby granted, free of charge, to any person obtaining a
- * copy of this software and associated documentation files (the
- * "Software"), to deal in the Software without restriction, including
- * without limitation the rights to use, copy, modify, merge, publish,
- * distribute, sub license, and/or sell copies of the Software, and to
- * permit persons to whom the Software is furnished to do so, subject to
- * the following conditions:
- *
- * The above copyright notice and this permission notice (including the
- * next paragraph) shall be included in all copies or substantial portions
- * of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
- * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
- * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
- * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
- * USE OR OTHER DEALINGS IN THE SOFTWARE.
- *
- **************************************************************************/
- #ifndef VMWGFX_KMS_H_
- #define VMWGFX_KMS_H_
- #include <drm/drm_encoder.h>
- #include <drm/drm_probe_helper.h>
- #include "vmwgfx_drv.h"
- /**
- * struct vmw_du_update_plane - Closure structure for vmw_du_helper_plane_update
- * @plane: Plane which is being updated.
- * @old_state: Old state of plane.
- * @dev_priv: Device private.
- * @du: Display unit on which to update the plane.
- * @vfb: Framebuffer which is blitted to display unit.
- * @out_fence: Out fence for resource finish.
- * @mutex: The mutex used to protect resource reservation.
- * @cpu_blit: True if need cpu blit.
- * @intr: Whether to perform waits interruptible if possible.
- *
- * This structure loosely represent the set of operations needed to perform a
- * plane update on a display unit. Implementer will define that functionality
- * according to the function callbacks for this structure. In brief it involves
- * surface/buffer object validation, populate FIFO commands and command
- * submission to the device.
- */
- struct vmw_du_update_plane {
- /**
- * @calc_fifo_size: Calculate fifo size.
- *
- * Determine fifo size for the commands needed for update. The number of
- * damage clips on display unit @num_hits will be passed to allocate
- * sufficient fifo space.
- *
- * Return: Fifo size needed
- */
- uint32_t (*calc_fifo_size)(struct vmw_du_update_plane *update,
- uint32_t num_hits);
- /**
- * @post_prepare: Populate fifo for resource preparation.
- *
- * Some surface resource or buffer object need some extra cmd submission
- * like update GB image for proxy surface and define a GMRFB for screen
- * object. That should should be done here as this callback will be
- * called after FIFO allocation with the address of command buufer.
- *
- * This callback is optional.
- *
- * Return: Size of commands populated to command buffer.
- */
- uint32_t (*post_prepare)(struct vmw_du_update_plane *update, void *cmd);
- /**
- * @pre_clip: Populate fifo before clip.
- *
- * This is where pre clip related command should be populated like
- * surface copy/DMA, etc.
- *
- * This callback is optional.
- *
- * Return: Size of commands populated to command buffer.
- */
- uint32_t (*pre_clip)(struct vmw_du_update_plane *update, void *cmd,
- uint32_t num_hits);
- /**
- * @clip: Populate fifo for clip.
- *
- * This is where to populate clips for surface copy/dma or blit commands
- * if needed. This will be called times have damage in display unit,
- * which is one if doing full update. @clip is the damage in destination
- * coordinates which is crtc/DU and @src_x, @src_y is damage clip src in
- * framebuffer coordinate.
- *
- * This callback is optional.
- *
- * Return: Size of commands populated to command buffer.
- */
- uint32_t (*clip)(struct vmw_du_update_plane *update, void *cmd,
- struct drm_rect *clip, uint32_t src_x, uint32_t src_y);
- /**
- * @post_clip: Populate fifo after clip.
- *
- * This is where to populate display unit update commands or blit
- * commands.
- *
- * Return: Size of commands populated to command buffer.
- */
- uint32_t (*post_clip)(struct vmw_du_update_plane *update, void *cmd,
- struct drm_rect *bb);
- struct drm_plane *plane;
- struct drm_plane_state *old_state;
- struct vmw_private *dev_priv;
- struct vmw_display_unit *du;
- struct vmw_framebuffer *vfb;
- struct vmw_fence_obj **out_fence;
- struct mutex *mutex;
- bool cpu_blit;
- bool intr;
- };
- /**
- * struct vmw_du_update_plane_surface - closure structure for surface
- * @base: base closure structure.
- * @cmd_start: FIFO command start address (used by SOU only).
- */
- struct vmw_du_update_plane_surface {
- struct vmw_du_update_plane base;
- /* This member is to handle special case SOU surface update */
- void *cmd_start;
- };
- /**
- * struct vmw_du_update_plane_buffer - Closure structure for buffer object
- * @base: Base closure structure.
- * @fb_left: x1 for fb damage bounding box.
- * @fb_top: y1 for fb damage bounding box.
- */
- struct vmw_du_update_plane_buffer {
- struct vmw_du_update_plane base;
- int fb_left, fb_top;
- };
- /**
- * struct vmw_kms_dirty - closure structure for the vmw_kms_helper_dirty
- * function.
- *
- * @fifo_commit: Callback that is called once for each display unit after
- * all clip rects. This function must commit the fifo space reserved by the
- * helper. Set up by the caller.
- * @clip: Callback that is called for each cliprect on each display unit.
- * Set up by the caller.
- * @fifo_reserve_size: Fifo size that the helper should try to allocat for
- * each display unit. Set up by the caller.
- * @dev_priv: Pointer to the device private. Set up by the helper.
- * @unit: The current display unit. Set up by the helper before a call to @clip.
- * @cmd: The allocated fifo space. Set up by the helper before the first @clip
- * call.
- * @crtc: The crtc for which to build dirty commands.
- * @num_hits: Number of clip rect commands for this display unit.
- * Cleared by the helper before the first @clip call. Updated by the @clip
- * callback.
- * @fb_x: Clip rect left side in framebuffer coordinates.
- * @fb_y: Clip rect right side in framebuffer coordinates.
- * @unit_x1: Clip rect left side in crtc coordinates.
- * @unit_y1: Clip rect top side in crtc coordinates.
- * @unit_x2: Clip rect right side in crtc coordinates.
- * @unit_y2: Clip rect bottom side in crtc coordinates.
- *
- * The clip rect coordinates are updated by the helper for each @clip call.
- * Note that this may be derived from if more info needs to be passed between
- * helper caller and helper callbacks.
- */
- struct vmw_kms_dirty {
- void (*fifo_commit)(struct vmw_kms_dirty *);
- void (*clip)(struct vmw_kms_dirty *);
- size_t fifo_reserve_size;
- struct vmw_private *dev_priv;
- struct vmw_display_unit *unit;
- void *cmd;
- struct drm_crtc *crtc;
- u32 num_hits;
- s32 fb_x;
- s32 fb_y;
- s32 unit_x1;
- s32 unit_y1;
- s32 unit_x2;
- s32 unit_y2;
- };
- #define VMWGFX_NUM_DISPLAY_UNITS 8
- #define vmw_framebuffer_to_vfb(x) \
- container_of(x, struct vmw_framebuffer, base)
- #define vmw_framebuffer_to_vfbs(x) \
- container_of(x, struct vmw_framebuffer_surface, base.base)
- #define vmw_framebuffer_to_vfbd(x) \
- container_of(x, struct vmw_framebuffer_bo, base.base)
- /**
- * Base class for framebuffers
- *
- * @pin is called the when ever a crtc uses this framebuffer
- * @unpin is called
- */
- struct vmw_framebuffer {
- struct drm_framebuffer base;
- int (*pin)(struct vmw_framebuffer *fb);
- int (*unpin)(struct vmw_framebuffer *fb);
- bool bo;
- struct ttm_base_object *user_obj;
- uint32_t user_handle;
- };
- /*
- * Clip rectangle
- */
- struct vmw_clip_rect {
- int x1, x2, y1, y2;
- };
- struct vmw_framebuffer_surface {
- struct vmw_framebuffer base;
- struct vmw_surface *surface;
- struct vmw_buffer_object *buffer;
- struct list_head head;
- bool is_bo_proxy; /* true if this is proxy surface for DMA buf */
- };
- struct vmw_framebuffer_bo {
- struct vmw_framebuffer base;
- struct vmw_buffer_object *buffer;
- };
- static const uint32_t vmw_primary_plane_formats[] = {
- DRM_FORMAT_XRGB1555,
- DRM_FORMAT_RGB565,
- DRM_FORMAT_RGB888,
- DRM_FORMAT_XRGB8888,
- DRM_FORMAT_ARGB8888,
- };
- static const uint32_t vmw_cursor_plane_formats[] = {
- DRM_FORMAT_ARGB8888,
- };
- #define vmw_crtc_state_to_vcs(x) container_of(x, struct vmw_crtc_state, base)
- #define vmw_plane_state_to_vps(x) container_of(x, struct vmw_plane_state, base)
- #define vmw_connector_state_to_vcs(x) \
- container_of(x, struct vmw_connector_state, base)
- /**
- * Derived class for crtc state object
- *
- * @base DRM crtc object
- */
- struct vmw_crtc_state {
- struct drm_crtc_state base;
- };
- /**
- * Derived class for plane state object
- *
- * @base DRM plane object
- * @surf Display surface for STDU
- * @bo display bo for SOU
- * @content_fb_type Used by STDU.
- * @bo_size Size of the bo, used by Screen Object Display Unit
- * @pinned pin count for STDU display surface
- */
- struct vmw_plane_state {
- struct drm_plane_state base;
- struct vmw_surface *surf;
- struct vmw_buffer_object *bo;
- int content_fb_type;
- unsigned long bo_size;
- int pinned;
- /* For CPU Blit */
- unsigned int cpp;
- };
- /**
- * Derived class for connector state object
- *
- * @base DRM connector object
- * @is_implicit connector property
- *
- */
- struct vmw_connector_state {
- struct drm_connector_state base;
- /**
- * @gui_x:
- *
- * vmwgfx connector property representing the x position of this display
- * unit (connector is synonymous to display unit) in overall topology.
- * This is what the device expect as xRoot while creating screen.
- */
- int gui_x;
- /**
- * @gui_y:
- *
- * vmwgfx connector property representing the y position of this display
- * unit (connector is synonymous to display unit) in overall topology.
- * This is what the device expect as yRoot while creating screen.
- */
- int gui_y;
- };
- /**
- * Base class display unit.
- *
- * Since the SVGA hw doesn't have a concept of a crtc, encoder or connector
- * so the display unit is all of them at the same time. This is true for both
- * legacy multimon and screen objects.
- */
- struct vmw_display_unit {
- struct drm_crtc crtc;
- struct drm_encoder encoder;
- struct drm_connector connector;
- struct drm_plane primary;
- struct drm_plane cursor;
- struct vmw_surface *cursor_surface;
- struct vmw_buffer_object *cursor_bo;
- size_t cursor_age;
- int cursor_x;
- int cursor_y;
- int hotspot_x;
- int hotspot_y;
- s32 core_hotspot_x;
- s32 core_hotspot_y;
- unsigned unit;
- /*
- * Prefered mode tracking.
- */
- unsigned pref_width;
- unsigned pref_height;
- bool pref_active;
- struct drm_display_mode *pref_mode;
- /*
- * Gui positioning
- */
- int gui_x;
- int gui_y;
- bool is_implicit;
- int set_gui_x;
- int set_gui_y;
- };
- struct vmw_validation_ctx {
- struct vmw_resource *res;
- struct vmw_buffer_object *buf;
- };
- #define vmw_crtc_to_du(x) \
- container_of(x, struct vmw_display_unit, crtc)
- #define vmw_connector_to_du(x) \
- container_of(x, struct vmw_display_unit, connector)
- /*
- * Shared display unit functions - vmwgfx_kms.c
- */
- void vmw_du_cleanup(struct vmw_display_unit *du);
- void vmw_du_crtc_save(struct drm_crtc *crtc);
- void vmw_du_crtc_restore(struct drm_crtc *crtc);
- int vmw_du_crtc_gamma_set(struct drm_crtc *crtc,
- u16 *r, u16 *g, u16 *b,
- uint32_t size,
- struct drm_modeset_acquire_ctx *ctx);
- int vmw_du_connector_set_property(struct drm_connector *connector,
- struct drm_property *property,
- uint64_t val);
- int vmw_du_connector_atomic_set_property(struct drm_connector *connector,
- struct drm_connector_state *state,
- struct drm_property *property,
- uint64_t val);
- int
- vmw_du_connector_atomic_get_property(struct drm_connector *connector,
- const struct drm_connector_state *state,
- struct drm_property *property,
- uint64_t *val);
- int vmw_du_connector_dpms(struct drm_connector *connector, int mode);
- void vmw_du_connector_save(struct drm_connector *connector);
- void vmw_du_connector_restore(struct drm_connector *connector);
- enum drm_connector_status
- vmw_du_connector_detect(struct drm_connector *connector, bool force);
- int vmw_du_connector_fill_modes(struct drm_connector *connector,
- uint32_t max_width, uint32_t max_height);
- int vmw_kms_helper_dirty(struct vmw_private *dev_priv,
- struct vmw_framebuffer *framebuffer,
- const struct drm_clip_rect *clips,
- const struct drm_vmw_rect *vclips,
- s32 dest_x, s32 dest_y,
- int num_clips,
- int increment,
- struct vmw_kms_dirty *dirty);
- void vmw_kms_helper_validation_finish(struct vmw_private *dev_priv,
- struct drm_file *file_priv,
- struct vmw_validation_context *ctx,
- struct vmw_fence_obj **out_fence,
- struct drm_vmw_fence_rep __user *
- user_fence_rep);
- int vmw_kms_readback(struct vmw_private *dev_priv,
- struct drm_file *file_priv,
- struct vmw_framebuffer *vfb,
- struct drm_vmw_fence_rep __user *user_fence_rep,
- struct drm_vmw_rect *vclips,
- uint32_t num_clips);
- struct vmw_framebuffer *
- vmw_kms_new_framebuffer(struct vmw_private *dev_priv,
- struct vmw_buffer_object *bo,
- struct vmw_surface *surface,
- bool only_2d,
- const struct drm_mode_fb_cmd2 *mode_cmd);
- int vmw_kms_fbdev_init_data(struct vmw_private *dev_priv,
- unsigned unit,
- u32 max_width,
- u32 max_height,
- struct drm_connector **p_con,
- struct drm_crtc **p_crtc,
- struct drm_display_mode **p_mode);
- void vmw_guess_mode_timing(struct drm_display_mode *mode);
- void vmw_kms_update_implicit_fb(struct vmw_private *dev_priv);
- void vmw_kms_create_implicit_placement_property(struct vmw_private *dev_priv);
- /* Universal Plane Helpers */
- void vmw_du_primary_plane_destroy(struct drm_plane *plane);
- void vmw_du_cursor_plane_destroy(struct drm_plane *plane);
- /* Atomic Helpers */
- int vmw_du_primary_plane_atomic_check(struct drm_plane *plane,
- struct drm_plane_state *state);
- int vmw_du_cursor_plane_atomic_check(struct drm_plane *plane,
- struct drm_plane_state *state);
- void vmw_du_cursor_plane_atomic_update(struct drm_plane *plane,
- struct drm_plane_state *old_state);
- int vmw_du_cursor_plane_prepare_fb(struct drm_plane *plane,
- struct drm_plane_state *new_state);
- void vmw_du_plane_cleanup_fb(struct drm_plane *plane,
- struct drm_plane_state *old_state);
- void vmw_du_plane_reset(struct drm_plane *plane);
- struct drm_plane_state *vmw_du_plane_duplicate_state(struct drm_plane *plane);
- void vmw_du_plane_destroy_state(struct drm_plane *plane,
- struct drm_plane_state *state);
- void vmw_du_plane_unpin_surf(struct vmw_plane_state *vps,
- bool unreference);
- int vmw_du_crtc_atomic_check(struct drm_crtc *crtc,
- struct drm_crtc_state *state);
- void vmw_du_crtc_atomic_begin(struct drm_crtc *crtc,
- struct drm_crtc_state *old_crtc_state);
- void vmw_du_crtc_atomic_flush(struct drm_crtc *crtc,
- struct drm_crtc_state *old_crtc_state);
- void vmw_du_crtc_reset(struct drm_crtc *crtc);
- struct drm_crtc_state *vmw_du_crtc_duplicate_state(struct drm_crtc *crtc);
- void vmw_du_crtc_destroy_state(struct drm_crtc *crtc,
- struct drm_crtc_state *state);
- void vmw_du_connector_reset(struct drm_connector *connector);
- struct drm_connector_state *
- vmw_du_connector_duplicate_state(struct drm_connector *connector);
- void vmw_du_connector_destroy_state(struct drm_connector *connector,
- struct drm_connector_state *state);
- /*
- * Legacy display unit functions - vmwgfx_ldu.c
- */
- int vmw_kms_ldu_init_display(struct vmw_private *dev_priv);
- int vmw_kms_ldu_close_display(struct vmw_private *dev_priv);
- int vmw_kms_ldu_do_bo_dirty(struct vmw_private *dev_priv,
- struct vmw_framebuffer *framebuffer,
- unsigned int flags, unsigned int color,
- struct drm_clip_rect *clips,
- unsigned int num_clips, int increment);
- int vmw_kms_update_proxy(struct vmw_resource *res,
- const struct drm_clip_rect *clips,
- unsigned num_clips,
- int increment);
- /*
- * Screen Objects display functions - vmwgfx_scrn.c
- */
- int vmw_kms_sou_init_display(struct vmw_private *dev_priv);
- int vmw_kms_sou_do_surface_dirty(struct vmw_private *dev_priv,
- struct vmw_framebuffer *framebuffer,
- struct drm_clip_rect *clips,
- struct drm_vmw_rect *vclips,
- struct vmw_resource *srf,
- s32 dest_x,
- s32 dest_y,
- unsigned num_clips, int inc,
- struct vmw_fence_obj **out_fence,
- struct drm_crtc *crtc);
- int vmw_kms_sou_do_bo_dirty(struct vmw_private *dev_priv,
- struct vmw_framebuffer *framebuffer,
- struct drm_clip_rect *clips,
- struct drm_vmw_rect *vclips,
- unsigned int num_clips, int increment,
- bool interruptible,
- struct vmw_fence_obj **out_fence,
- struct drm_crtc *crtc);
- int vmw_kms_sou_readback(struct vmw_private *dev_priv,
- struct drm_file *file_priv,
- struct vmw_framebuffer *vfb,
- struct drm_vmw_fence_rep __user *user_fence_rep,
- struct drm_vmw_rect *vclips,
- uint32_t num_clips,
- struct drm_crtc *crtc);
- /*
- * Screen Target Display Unit functions - vmwgfx_stdu.c
- */
- int vmw_kms_stdu_init_display(struct vmw_private *dev_priv);
- int vmw_kms_stdu_surface_dirty(struct vmw_private *dev_priv,
- struct vmw_framebuffer *framebuffer,
- struct drm_clip_rect *clips,
- struct drm_vmw_rect *vclips,
- struct vmw_resource *srf,
- s32 dest_x,
- s32 dest_y,
- unsigned num_clips, int inc,
- struct vmw_fence_obj **out_fence,
- struct drm_crtc *crtc);
- int vmw_kms_stdu_dma(struct vmw_private *dev_priv,
- struct drm_file *file_priv,
- struct vmw_framebuffer *vfb,
- struct drm_vmw_fence_rep __user *user_fence_rep,
- struct drm_clip_rect *clips,
- struct drm_vmw_rect *vclips,
- uint32_t num_clips,
- int increment,
- bool to_surface,
- bool interruptible,
- struct drm_crtc *crtc);
- int vmw_du_helper_plane_update(struct vmw_du_update_plane *update);
- /**
- * vmw_du_translate_to_crtc - Translate a rect from framebuffer to crtc
- * @state: Plane state.
- * @r: Rectangle to translate.
- */
- static inline void vmw_du_translate_to_crtc(struct drm_plane_state *state,
- struct drm_rect *r)
- {
- int translate_crtc_x = -((state->src_x >> 16) - state->crtc_x);
- int translate_crtc_y = -((state->src_y >> 16) - state->crtc_y);
- drm_rect_translate(r, translate_crtc_x, translate_crtc_y);
- }
- #endif
|