/* * Copyright (c) 2017-2018, The Linux Foundation. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following * disclaimer in the documentation and/or other materials provided * with the distribution. * * Neither the name of The Linux Foundation nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef __DRM_INTERFACE_H__ #define __DRM_INTERFACE_H__ #include #include #include #include #include "xf86drm.h" #include "xf86drmMode.h" #include namespace sde_drm { typedef std::map, float> CompRatioMap; /* * Drm Atomic Operation Codes */ enum struct DRMOps { /* * Op: Sets plane source crop * Arg: uint32_t - Plane ID * DRMRect - Source Rectangle */ PLANE_SET_SRC_RECT, /* * Op: Sets plane destination rect * Arg: uint32_t - Plane ID * DRMRect - Dst Rectangle */ PLANE_SET_DST_RECT, /* * Op: Sets plane zorder * Arg: uint32_t - Plane ID * uint32_t - zorder */ PLANE_SET_ZORDER, /* * Op: Sets plane rotation flags * Arg: uint32_t - Plane ID * uint32_t - bit mask of rotation flags (See drm_mode.h for enums) */ PLANE_SET_ROTATION, /* * Op: Sets plane alpha * Arg: uint32_t - Plane ID * uint32_t - alpha value */ PLANE_SET_ALPHA, /* * Op: Sets the blend type * Arg: uint32_t - Plane ID * uint32_t - blend type (see DRMBlendType) */ PLANE_SET_BLEND_TYPE, /* * Op: Sets horizontal decimation * Arg: uint32_t - Plane ID * uint32_t - decimation factor */ PLANE_SET_H_DECIMATION, /* * Op: Sets vertical decimation * Arg: uint32_t - Plane ID * uint32_t - decimation factor */ PLANE_SET_V_DECIMATION, /* * Op: Sets source config flags * Arg: uint32_t - Plane ID * uint32_t - flags to enable or disable a specific op. E.g. deinterlacing */ PLANE_SET_SRC_CONFIG, /* * Op: Sets frame buffer ID for plane. Set together with CRTC. * Arg: uint32_t - Plane ID * uint32_t - Framebuffer ID */ PLANE_SET_FB_ID, /* * Op: Sets the crtc for this plane. Set together with FB_ID. * Arg: uint32_t - Plane ID * uint32_t - CRTC ID */ PLANE_SET_CRTC, /* * Op: Sets acquire fence for this plane's buffer. Set together with FB_ID, CRTC. * Arg: uint32_t - Plane ID * uint32_t - Input fence */ PLANE_SET_INPUT_FENCE, /* * Op: Sets scaler config on this plane. * Arg: uint32_t - Plane ID * uint64_t - Address of the scaler config object (version based) */ PLANE_SET_SCALER_CONFIG, /* * Op: Sets plane rotation destination rect * Arg: uint32_t - Plane ID * DRMRect - rotator dst Rectangle */ PLANE_SET_ROTATION_DST_RECT, /* * Op: Sets FB Secure mode for this plane. * Arg: uint32_t - Plane ID * uint32_t - Value of the FB Secure mode. */ PLANE_SET_FB_SECURE_MODE, /* * Op: Sets csc config on this plane. * Arg: uint32_t - Plane ID * uint32_t* - pointer to csc type */ PLANE_SET_CSC_CONFIG, /* * Op: Sets multirect mode on this plane. * Arg: uint32_t - Plane ID * uint32_t - multirect mode */ PLANE_SET_MULTIRECT_MODE, /* * Op: Activate or deactivate a CRTC * Arg: uint32_t - CRTC ID * uint32_t - 1 to enable, 0 to disable */ CRTC_SET_ACTIVE, /* * Op: Sets display mode * Arg: uint32_t - CRTC ID * drmModeModeInfo* - Pointer to display mode */ CRTC_SET_MODE, /* * Op: Sets an offset indicating when a release fence should be signalled. * Arg: uint32_t - offset * 0: non-speculative, default * 1: speculative */ CRTC_SET_OUTPUT_FENCE_OFFSET, /* * Op: Sets overall SDE core clock * Arg: uint32_t - CRTC ID * uint32_t - core_clk */ CRTC_SET_CORE_CLK, /* * Op: Sets MNOC bus average bandwidth * Arg: uint32_t - CRTC ID * uint32_t - core_ab */ CRTC_SET_CORE_AB, /* * Op: Sets MNOC bus instantaneous bandwidth * Arg: uint32_t - CRTC ID * uint32_t - core_ib */ CRTC_SET_CORE_IB, /* * Op: Sets LLCC Bus average bandwidth * Arg: uint32_t - CRTC ID * uint32_t - llcc_ab */ CRTC_SET_LLCC_AB, /* * Op: Sets LLCC Bus instantaneous bandwidth * Arg: uint32_t - CRTC ID * uint32_t - llcc_ib */ CRTC_SET_LLCC_IB, /* * Op: Sets DRAM bus average bandwidth * Arg: uint32_t - CRTC ID * uint32_t - dram_ab */ CRTC_SET_DRAM_AB, /* * Op: Sets DRAM bus instantaneous bandwidth * Arg: uint32_t - CRTC ID * uint32_t - dram_ib */ CRTC_SET_DRAM_IB, /* * Op: Sets Rotator BW for inline rotation * Arg: uint32_t - CRTC ID * uint32_t - rot_bw */ CRTC_SET_ROT_PREFILL_BW, /* * Op: Sets rotator clock for inline rotation * Arg: uint32_t - CRTC ID * uint32_t - rot_clk */ CRTC_SET_ROT_CLK, /* * Op: Sets destination scalar data * Arg: uint32_t - CRTC ID * uint64_t - Pointer to destination scalar data */ CRTC_SET_DEST_SCALER_CONFIG, /* * Op: Returns release fence for this frame. Should be called after Commit() on * DRMAtomicReqInterface. * Arg: uint32_t - CRTC ID * int * - Pointer to an integer that will hold the returned fence */ CRTC_GET_RELEASE_FENCE, /* * Op: Sets PP feature * Arg: uint32_t - CRTC ID * DRMPPFeatureInfo * - PP feature data pointer */ CRTC_SET_POST_PROC, /* * Op: Sets CRTC ROIs. * Arg: uint32_t - CRTC ID * uint32_t - number of ROIs * DRMRect * - Array of CRTC ROIs */ CRTC_SET_ROI, /* * Op: Sets Security level for CRTC. * Arg: uint32_t - CRTC ID * uint32_t - Security level */ CRTC_SET_SECURITY_LEVEL, /* * Op: sets solid fill stages * Arg: uint32_t - CRTC ID * Vector of DRMSolidfillStage */ CRTC_SET_SOLIDFILL_STAGES, /* * Op: Sets idle timeout. * Arg: uint32_t - CRTC ID * uint32_t - idle timeout in ms */ CRTC_SET_IDLE_TIMEOUT, /* * Op: enables Secure UI enhancement feature. * Arg: uint32_t - CRTC ID * uint32_t - enable/disable secure UI enhancement feature. */ CRTC_SET_SECURE_UI_ENHANCEMENT, /* * Op: Sets Capture mode for Concurrent Writeback feature. * Arg: uint32_t - CRTC ID * uint32_t - Capture mode */ CRTC_SET_CAPTURE_MODE, /* * Op: Sets Idle PC state for CRTC. * Arg: uint32_t - CRTC ID * uint32_t - idle pc state */ CRTC_SET_IDLE_PC_STATE, /* * Op: Returns retire fence for this commit. Should be called after Commit() on * DRMAtomicReqInterface. * Arg: uint32_t - Connector ID * int * - Pointer to an integer that will hold the returned fence */ CONNECTOR_GET_RETIRE_FENCE, /* * Op: Sets writeback connector destination rect * Arg: uint32_t - Connector ID * DRMRect - Dst Rectangle */ CONNECTOR_SET_OUTPUT_RECT, /* * Op: Sets frame buffer ID for writeback connector. * Arg: uint32_t - Connector ID * uint32_t - Framebuffer ID */ CONNECTOR_SET_OUTPUT_FB_ID, /* * Op: Sets power mode for connector. * Arg: uint32_t - Connector ID * uint32_t - Power Mode */ CONNECTOR_SET_POWER_MODE, /* * Op: Sets panel ROIs. * Arg: uint32_t - Connector ID * uint32_t - number of ROIs * DRMRect * - Array of Connector ROIs */ CONNECTOR_SET_ROI, /* * Op: Sets the connector to autorefresh mode. * Arg: uint32_t - Connector ID * uint32_t - Enable-1, Disable-0 */ CONNECTOR_SET_AUTOREFRESH, /* * Op: Set FB secure mode for Writeback connector. * Arg: uint32_t - Connector ID * uint32_t - FB Secure mode */ CONNECTOR_SET_FB_SECURE_MODE, /* * Op: Sets a crtc id to this connector * Arg: uint32_t - Connector ID * uint32_t - CRTC ID */ CONNECTOR_SET_CRTC, /* * Op: Sets PP feature * Arg: uint32_t - Connector ID * DRMPPFeatureInfo * - PP feature data pointer */ CONNECTOR_SET_POST_PROC, /* * Op: Sets connector hdr metadata * Arg: uint32_t - Connector ID * drm_msm_ext_hdr_metadata - hdr_metadata */ CONNECTOR_SET_HDR_METADATA, }; enum struct DRMRotation { FLIP_H = 0x1, FLIP_V = 0x2, ROT_180 = FLIP_H | FLIP_V, ROT_90 = 0x4, }; enum struct DRMPowerMode { ON, DOZE, DOZE_SUSPEND, OFF, }; enum struct DRMBlendType { UNDEFINED = 0, OPAQUE = 1, PREMULTIPLIED = 2, COVERAGE = 3, }; enum struct DRMSrcConfig { DEINTERLACE = 0, }; enum struct DRMIdlePCState { NONE, ENABLE, DISABLE, }; /* Display type to identify a suitable connector */ enum struct DRMDisplayType { PERIPHERAL, TV, VIRTUAL, }; struct DRMRect { uint32_t left; // Left-most pixel coordinate. uint32_t top; // Top-most pixel coordinate. uint32_t right; // Right-most pixel coordinate. uint32_t bottom; // Bottom-most pixel coordinate. }; //------------------------------------------------------------------------ // DRM Info Query Types //------------------------------------------------------------------------ enum struct QSEEDVersion { V1, V2, V3, }; /* QSEED3 Step version */ enum struct QSEEDStepVersion { V2, V3, V4, }; enum struct SmartDMARevision { V1, V2, }; /* Per CRTC Resource Info*/ struct DRMCrtcInfo { bool has_src_split; bool has_hdr; uint32_t max_blend_stages; uint32_t max_solidfill_stages; QSEEDVersion qseed_version; SmartDMARevision smart_dma_rev; float ib_fudge_factor; float clk_fudge_factor; uint32_t dest_scale_prefill_lines; uint32_t undersized_prefill_lines; uint32_t macrotile_prefill_lines; uint32_t nv12_prefill_lines; uint32_t linear_prefill_lines; uint32_t downscale_prefill_lines; uint32_t extra_prefill_lines; uint32_t amortized_threshold; uint64_t max_bandwidth_low; uint64_t max_bandwidth_high; uint32_t max_sde_clk; CompRatioMap comp_ratio_rt_map; CompRatioMap comp_ratio_nrt_map; uint32_t hw_version; uint32_t dest_scaler_count = 0; uint32_t max_dest_scaler_input_width = 0; uint32_t max_dest_scaler_output_width = 0; uint32_t max_dest_scale_up = 1; uint32_t min_prefill_lines = 0; bool concurrent_writeback = false; }; enum struct DRMPlaneType { // Has CSC and scaling capability VIG = 0, // Has scaling capability but no CSC RGB, // No scaling support DMA, // Supports a small dimension and doesn't use a CRTC stage CURSOR, MAX, }; struct DRMPlaneTypeInfo { DRMPlaneType type; uint32_t master_plane_id; // FourCC format enum and modifier std::vector> formats_supported; uint32_t max_linewidth; uint32_t max_upscale; uint32_t max_downscale; uint32_t max_horizontal_deci; uint32_t max_vertical_deci; uint64_t max_pipe_bandwidth; uint32_t cache_size; // cache size in bytes for inline rotation support. QSEEDStepVersion qseed3_version; bool multirect_prop_present = false; bool block_sec_ui = false; }; // All DRM Planes as map listed from highest to lowest priority typedef std::vector> DRMPlanesInfo; enum struct DRMTopology { UNKNOWN, // To be compat with driver defs in sde_rm.h SINGLE_LM, SINGLE_LM_DSC, DUAL_LM, DUAL_LM_DSC, DUAL_LM_MERGE, DUAL_LM_MERGE_DSC, DUAL_LM_DSCMERGE, PPSPLIT, }; enum struct DRMPanelMode { VIDEO, COMMAND, }; /* Per mode info */ struct DRMModeInfo { drmModeModeInfo mode; DRMTopology topology; // Valid only if mode is command int num_roi; int xstart; int ystart; int walign; int halign; int wmin; int hmin; bool roi_merge; }; /* Per Connector Info*/ struct DRMConnectorInfo { uint32_t mmWidth; uint32_t mmHeight; uint32_t type; std::vector modes; std::string panel_name; DRMPanelMode panel_mode; bool is_primary; // Valid only if DRMPanelMode is VIDEO bool dynamic_fps; // FourCC format enum and modifier std::vector> formats_supported; // Valid only if type is DRM_MODE_CONNECTOR_VIRTUAL uint32_t max_linewidth; DRMRotation panel_orientation; drm_panel_hdr_properties panel_hdr_prop; uint32_t transfer_time_us; drm_msm_ext_hdr_properties ext_hdr_prop; }; /* Identifier token for a display */ struct DRMDisplayToken { uint32_t conn_id; uint32_t crtc_id; uint32_t crtc_index; }; enum DRMPPFeatureID { kFeaturePcc, kFeatureIgc, kFeaturePgc, kFeatureMixerGc, kFeaturePaV2, kFeatureDither, kFeatureGamut, kFeaturePADither, kFeaturePAHsic, kFeaturePASixZone, kFeaturePAMemColSkin, kFeaturePAMemColSky, kFeaturePAMemColFoliage, kFeaturePAMemColProt, kPPFeaturesMax, }; enum DRMPPPropType { kPropEnum, kPropRange, kPropBlob, kPropTypeMax, }; struct DRMPPFeatureInfo { DRMPPFeatureID id; DRMPPPropType type; uint32_t version; uint32_t payload_size; void *payload; uint32_t object_type; }; enum DRMCscType { kCscYuv2Rgb601L, kCscYuv2Rgb601FR, kCscYuv2Rgb709L, kCscYuv2Rgb2020L, kCscYuv2Rgb2020FR, kCscTypeMax, }; struct DRMScalerLUTInfo { uint32_t dir_lut_size = 0; uint32_t cir_lut_size = 0; uint32_t sep_lut_size = 0; uint64_t dir_lut = 0; uint64_t cir_lut = 0; uint64_t sep_lut = 0; }; enum struct DRMSecureMode { NON_SECURE, SECURE, NON_SECURE_DIR_TRANSLATION, SECURE_DIR_TRANSLATION, }; enum struct DRMSecurityLevel { SECURE_NON_SECURE, SECURE_ONLY, }; enum struct DRMMultiRectMode { NONE = 0, PARALLEL = 1, SERIAL = 2, }; enum struct DRMCWbCaptureMode { MIXER_OUT = 0, DSPP_OUT = 1, }; struct DRMSolidfillStage { DRMRect bounding_rect {}; bool is_exclusion_rect = false; uint32_t color = 0xff000000; // in 8bit argb uint32_t red = 0; uint32_t blue = 0; uint32_t green = 0; uint32_t alpha = 0xff; uint32_t color_bit_depth = 0; uint32_t z_order = 0; uint32_t plane_alpha = 0xff; }; /* DRM Atomic Request Property Set. * * Helper class to create and populate atomic properties of DRM components * when rendered in DRM atomic mode */ class DRMAtomicReqInterface { public: virtual ~DRMAtomicReqInterface() {} /* Perform request operation. * * [input]: opcode: operation code from DRMOps list. * var_arg: arguments for DRMOps's can differ in number and * data type. Refer above DRMOps to details. * [return]: Error code if the API fails, 0 on success. */ virtual int Perform(DRMOps opcode, ...) = 0; /* * Commit the params set via Perform(). Also resets the properties after commit. Needs to be * called every frame. * [input]: synchronous: Determines if the call should block until a h/w flip * [input]: retain_planes: Retains already staged planes. Useful when not explicitly programming * planes but still need the previously staged ones to not be unstaged * [return]: Error code if the API fails, 0 on success. */ virtual int Commit(bool synchronous, bool retain_planes) = 0; /* * Validate the params set via Perform(). * [return]: Error code if the API fails, 0 on success. */ virtual int Validate() = 0; }; class DRMManagerInterface; /* Populates a singleton instance of DRMManager */ typedef int (*GetDRMManager)(int fd, DRMManagerInterface **intf); /* Destroy DRMManager instance */ typedef int (*DestroyDRMManager)(); /* * DRM Manager Interface - Any class which plans to implement helper function for vendor * specific DRM driver implementation must implement the below interface routines to work * with SDM. */ class DRMManagerInterface { public: virtual ~DRMManagerInterface() {} /* * Since SDM completely manages the planes. GetPlanesInfo will provide all * the plane information. * [output]: DRMPlanesInfo: Resource Info for planes. */ virtual void GetPlanesInfo(DRMPlanesInfo *info) = 0; /* * Will provide all the information of a selected crtc. * [input]: Use crtc id 0 to obtain system wide info * [output]: DRMCrtcInfo: Resource Info for the given CRTC id. */ virtual void GetCrtcInfo(uint32_t crtc_id, DRMCrtcInfo *info) = 0; /* * Will provide all the information of a selected connector. * [output]: DRMConnectorInfo: Resource Info for the given connector id */ virtual void GetConnectorInfo(uint32_t conn_id, DRMConnectorInfo *info) = 0; /* * Will query post propcessing feature info of a CRTC. * [output]: DRMPPFeatureInfo: CRTC post processing feature info */ virtual void GetCrtcPPInfo(uint32_t crtc_id, DRMPPFeatureInfo *info) = 0; /* * Register a logical display to receive a token. * Each display pipeline in DRM is identified by its CRTC and Connector(s). * On display connect(bootup or hotplug), clients should invoke this interface to * establish the pipeline for the display and should get a DisplayToken * populated with crtc and connnector(s) id's. Here onwards, Client should * use this token to represent the display for any Perform operations if * needed. * * [input]: disp_type - Peripheral / TV / Virtual * [output]: DRMDisplayToken - CRTC and Connector id's for the display * [return]: 0 on success, a negative error value otherwise */ virtual int RegisterDisplay(DRMDisplayType disp_type, DRMDisplayToken *tok) = 0; /* Client should invoke this interface on display disconnect. * [input]: DRMDisplayToken - identifier for the display. */ virtual void UnregisterDisplay(const DRMDisplayToken &token) = 0; /* * Creates and returns an instance of DRMAtomicReqInterface corresponding to a display token * returned as part of RegisterDisplay API. Needs to be called per display. * [input]: DRMDisplayToken that identifies a display pipeline * [output]: Pointer to an instance of DRMAtomicReqInterface. * [return]: Error code if the API fails, 0 on success. */ virtual int CreateAtomicReq(const DRMDisplayToken &token, DRMAtomicReqInterface **intf) = 0; /* * Destroys the instance of DRMAtomicReqInterface * [input]: Pointer to a DRMAtomicReqInterface * [return]: Error code if the API fails, 0 on success. */ virtual int DestroyAtomicReq(DRMAtomicReqInterface *intf) = 0; /* * Sets the global scaler LUT * [input]: LUT Info * [return]: Error code if the API fails, 0 on success. */ virtual int SetScalerLUT(const DRMScalerLUTInfo &lut_info) = 0; }; } // namespace sde_drm #endif // __DRM_INTERFACE_H__