1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright (c) 2015-2018, The Linux Foundation. All rights reserved. 4 * Copyright (C) 2013 Red Hat 5 * Author: Rob Clark <robdclark@gmail.com> 6 */ 7 8 #ifndef _DPU_PLANE_H_ 9 #define _DPU_PLANE_H_ 10 11 #include <drm/drm_crtc.h> 12 13 #include "dpu_kms.h" 14 #include "dpu_hw_mdss.h" 15 #include "dpu_hw_sspp.h" 16 17 /** 18 * struct dpu_plane_state: Define dpu extension of drm plane state object 19 * @base: base drm plane state object 20 * @aspace: pointer to address space for input/output buffers 21 * @stage: assigned by crtc blender 22 * @needs_qos_remap: qos remap settings need to be updated 23 * @multirect_index: index of the rectangle of SSPP 24 * @multirect_mode: parallel or time multiplex multirect mode 25 * @pending: whether the current update is still pending 26 * @plane_fetch_bw: calculated BW per plane 27 * @plane_clk: calculated clk per plane 28 */ 29 struct dpu_plane_state { 30 struct drm_plane_state base; 31 struct msm_gem_address_space *aspace; 32 enum dpu_stage stage; 33 bool needs_qos_remap; 34 uint32_t multirect_index; 35 uint32_t multirect_mode; 36 bool pending; 37 38 u64 plane_fetch_bw; 39 u64 plane_clk; 40 }; 41 42 /** 43 * struct dpu_multirect_plane_states: Defines multirect pair of drm plane states 44 * @r0: drm plane configured on rect 0 45 * @r1: drm plane configured on rect 1 46 */ 47 struct dpu_multirect_plane_states { 48 const struct drm_plane_state *r0; 49 const struct drm_plane_state *r1; 50 }; 51 52 #define to_dpu_plane_state(x) \ 53 container_of(x, struct dpu_plane_state, base) 54 55 /** 56 * dpu_plane_pipe - return sspp identifier for the given plane 57 * @plane: Pointer to DRM plane object 58 * Returns: sspp identifier of the given plane 59 */ 60 enum dpu_sspp dpu_plane_pipe(struct drm_plane *plane); 61 62 /** 63 * is_dpu_plane_virtual - check for virtual plane 64 * @plane: Pointer to DRM plane object 65 * returns: true - if the plane is virtual 66 * false - if the plane is primary 67 */ 68 bool is_dpu_plane_virtual(struct drm_plane *plane); 69 70 /** 71 * dpu_plane_get_ctl_flush - get control flush mask 72 * @plane: Pointer to DRM plane object 73 * @ctl: Pointer to control hardware 74 * @flush_sspp: Pointer to sspp flush control word 75 */ 76 void dpu_plane_get_ctl_flush(struct drm_plane *plane, struct dpu_hw_ctl *ctl, 77 u32 *flush_sspp); 78 79 /** 80 * dpu_plane_flush - final plane operations before commit flush 81 * @plane: Pointer to drm plane structure 82 */ 83 void dpu_plane_flush(struct drm_plane *plane); 84 85 /** 86 * dpu_plane_set_error: enable/disable error condition 87 * @plane: pointer to drm_plane structure 88 */ 89 void dpu_plane_set_error(struct drm_plane *plane, bool error); 90 91 /** 92 * dpu_plane_init - create new dpu plane for the given pipe 93 * @dev: Pointer to DRM device 94 * @pipe: dpu hardware pipe identifier 95 * @type: Plane type - PRIMARY/OVERLAY/CURSOR 96 * @possible_crtcs: bitmask of crtc that can be attached to the given pipe 97 * @master_plane_id: primary plane id of a multirect pipe. 0 value passed for 98 * a regular plane initialization. A non-zero primary plane 99 * id will be passed for a virtual pipe initialization. 100 * 101 */ 102 struct drm_plane *dpu_plane_init(struct drm_device *dev, 103 uint32_t pipe, enum drm_plane_type type, 104 unsigned long possible_crtcs, u32 master_plane_id); 105 106 /** 107 * dpu_plane_validate_multirecti_v2 - validate the multirect planes 108 * against hw limitations 109 * @plane: drm plate states of the multirect pair 110 */ 111 int dpu_plane_validate_multirect_v2(struct dpu_multirect_plane_states *plane); 112 113 /** 114 * dpu_plane_clear_multirect - clear multirect bits for the given pipe 115 * @drm_state: Pointer to DRM plane state 116 */ 117 void dpu_plane_clear_multirect(const struct drm_plane_state *drm_state); 118 119 /** 120 * dpu_plane_color_fill - enables color fill on plane 121 * @plane: Pointer to DRM plane object 122 * @color: RGB fill color value, [23..16] Blue, [15..8] Green, [7..0] Red 123 * @alpha: 8-bit fill alpha value, 255 selects 100% alpha 124 * Returns: 0 on success 125 */ 126 int dpu_plane_color_fill(struct drm_plane *plane, 127 uint32_t color, uint32_t alpha); 128 129 #ifdef CONFIG_DEBUG_FS 130 void dpu_plane_danger_signal_ctrl(struct drm_plane *plane, bool enable); 131 #else 132 static inline void dpu_plane_danger_signal_ctrl(struct drm_plane *plane, bool enable) {} 133 #endif 134 135 #endif /* _DPU_PLANE_H_ */ 136