125fdd593SJeykumar Sankaran /* 225fdd593SJeykumar Sankaran * Copyright (c) 2016-2018, The Linux Foundation. All rights reserved. 325fdd593SJeykumar Sankaran * 425fdd593SJeykumar Sankaran * This program is free software; you can redistribute it and/or modify 525fdd593SJeykumar Sankaran * it under the terms of the GNU General Public License version 2 and 625fdd593SJeykumar Sankaran * only version 2 as published by the Free Software Foundation. 725fdd593SJeykumar Sankaran * 825fdd593SJeykumar Sankaran * This program is distributed in the hope that it will be useful, 925fdd593SJeykumar Sankaran * but WITHOUT ANY WARRANTY; without even the implied warranty of 1025fdd593SJeykumar Sankaran * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 1125fdd593SJeykumar Sankaran * GNU General Public License for more details. 1225fdd593SJeykumar Sankaran * 1325fdd593SJeykumar Sankaran */ 1425fdd593SJeykumar Sankaran 1525fdd593SJeykumar Sankaran #ifndef __DPU_RM_H__ 1625fdd593SJeykumar Sankaran #define __DPU_RM_H__ 1725fdd593SJeykumar Sankaran 1825fdd593SJeykumar Sankaran #include <linux/list.h> 1925fdd593SJeykumar Sankaran 2025fdd593SJeykumar Sankaran #include "msm_kms.h" 2125fdd593SJeykumar Sankaran #include "dpu_hw_top.h" 2225fdd593SJeykumar Sankaran 2325fdd593SJeykumar Sankaran /** 2425fdd593SJeykumar Sankaran * enum dpu_rm_topology_name - HW resource use case in use by connector 2525fdd593SJeykumar Sankaran * @DPU_RM_TOPOLOGY_NONE: No topology in use currently 2625fdd593SJeykumar Sankaran * @DPU_RM_TOPOLOGY_SINGLEPIPE: 1 LM, 1 PP, 1 INTF/WB 2725fdd593SJeykumar Sankaran * @DPU_RM_TOPOLOGY_DUALPIPE: 2 LM, 2 PP, 2 INTF/WB 2825fdd593SJeykumar Sankaran * @DPU_RM_TOPOLOGY_DUALPIPE_3DMERGE: 2 LM, 2 PP, 3DMux, 1 INTF/WB 2925fdd593SJeykumar Sankaran */ 3025fdd593SJeykumar Sankaran enum dpu_rm_topology_name { 3125fdd593SJeykumar Sankaran DPU_RM_TOPOLOGY_NONE = 0, 3225fdd593SJeykumar Sankaran DPU_RM_TOPOLOGY_SINGLEPIPE, 3325fdd593SJeykumar Sankaran DPU_RM_TOPOLOGY_DUALPIPE, 3425fdd593SJeykumar Sankaran DPU_RM_TOPOLOGY_DUALPIPE_3DMERGE, 3525fdd593SJeykumar Sankaran DPU_RM_TOPOLOGY_MAX, 3625fdd593SJeykumar Sankaran }; 3725fdd593SJeykumar Sankaran 3825fdd593SJeykumar Sankaran /** 3925fdd593SJeykumar Sankaran * enum dpu_rm_topology_control - HW resource use case in use by connector 4025fdd593SJeykumar Sankaran * @DPU_RM_TOPCTL_RESERVE_LOCK: If set, in AtomicTest phase, after a successful 4125fdd593SJeykumar Sankaran * test, reserve the resources for this display. 4225fdd593SJeykumar Sankaran * Normal behavior would not impact the reservation 4325fdd593SJeykumar Sankaran * list during the AtomicTest phase. 4425fdd593SJeykumar Sankaran * @DPU_RM_TOPCTL_RESERVE_CLEAR: If set, in AtomicTest phase, before testing, 4525fdd593SJeykumar Sankaran * release any reservation held by this display. 4625fdd593SJeykumar Sankaran * Normal behavior would not impact the 4725fdd593SJeykumar Sankaran * reservation list during the AtomicTest phase. 4825fdd593SJeykumar Sankaran * @DPU_RM_TOPCTL_DS : Require layer mixers with DS capabilities 4925fdd593SJeykumar Sankaran */ 5025fdd593SJeykumar Sankaran enum dpu_rm_topology_control { 5125fdd593SJeykumar Sankaran DPU_RM_TOPCTL_RESERVE_LOCK, 5225fdd593SJeykumar Sankaran DPU_RM_TOPCTL_RESERVE_CLEAR, 5325fdd593SJeykumar Sankaran DPU_RM_TOPCTL_DS, 5425fdd593SJeykumar Sankaran }; 5525fdd593SJeykumar Sankaran 5625fdd593SJeykumar Sankaran /** 5725fdd593SJeykumar Sankaran * struct dpu_rm - DPU dynamic hardware resource manager 5825fdd593SJeykumar Sankaran * @dev: device handle for event logging purposes 5925fdd593SJeykumar Sankaran * @rsvps: list of hardware reservations by each crtc->encoder->connector 6025fdd593SJeykumar Sankaran * @hw_blks: array of lists of hardware resources present in the system, one 6125fdd593SJeykumar Sankaran * list per type of hardware block 6225fdd593SJeykumar Sankaran * @hw_mdp: hardware object for mdp_top 6325fdd593SJeykumar Sankaran * @lm_max_width: cached layer mixer maximum width 6425fdd593SJeykumar Sankaran * @rsvp_next_seq: sequence number for next reservation for debugging purposes 6525fdd593SJeykumar Sankaran * @rm_lock: resource manager mutex 6625fdd593SJeykumar Sankaran */ 6725fdd593SJeykumar Sankaran struct dpu_rm { 6825fdd593SJeykumar Sankaran struct drm_device *dev; 6925fdd593SJeykumar Sankaran struct list_head rsvps; 7025fdd593SJeykumar Sankaran struct list_head hw_blks[DPU_HW_BLK_MAX]; 7125fdd593SJeykumar Sankaran struct dpu_hw_mdp *hw_mdp; 7225fdd593SJeykumar Sankaran uint32_t lm_max_width; 7325fdd593SJeykumar Sankaran uint32_t rsvp_next_seq; 7425fdd593SJeykumar Sankaran struct mutex rm_lock; 7525fdd593SJeykumar Sankaran }; 7625fdd593SJeykumar Sankaran 7725fdd593SJeykumar Sankaran /** 7825fdd593SJeykumar Sankaran * struct dpu_rm_hw_blk - resource manager internal structure 7925fdd593SJeykumar Sankaran * forward declaration for single iterator definition without void pointer 8025fdd593SJeykumar Sankaran */ 8125fdd593SJeykumar Sankaran struct dpu_rm_hw_blk; 8225fdd593SJeykumar Sankaran 8325fdd593SJeykumar Sankaran /** 8425fdd593SJeykumar Sankaran * struct dpu_rm_hw_iter - iterator for use with dpu_rm 8525fdd593SJeykumar Sankaran * @hw: dpu_hw object requested, or NULL on failure 8625fdd593SJeykumar Sankaran * @blk: dpu_rm internal block representation. Clients ignore. Used as iterator. 8725fdd593SJeykumar Sankaran * @enc_id: DRM ID of Encoder client wishes to search for, or 0 for Any Encoder 8825fdd593SJeykumar Sankaran * @type: Hardware Block Type client wishes to search for. 8925fdd593SJeykumar Sankaran */ 9025fdd593SJeykumar Sankaran struct dpu_rm_hw_iter { 9125fdd593SJeykumar Sankaran void *hw; 9225fdd593SJeykumar Sankaran struct dpu_rm_hw_blk *blk; 9325fdd593SJeykumar Sankaran uint32_t enc_id; 9425fdd593SJeykumar Sankaran enum dpu_hw_blk_type type; 9525fdd593SJeykumar Sankaran }; 9625fdd593SJeykumar Sankaran 9725fdd593SJeykumar Sankaran /** 9825fdd593SJeykumar Sankaran * dpu_rm_init - Read hardware catalog and create reservation tracking objects 9925fdd593SJeykumar Sankaran * for all HW blocks. 10025fdd593SJeykumar Sankaran * @rm: DPU Resource Manager handle 10125fdd593SJeykumar Sankaran * @cat: Pointer to hardware catalog 10225fdd593SJeykumar Sankaran * @mmio: mapped register io address of MDP 10325fdd593SJeykumar Sankaran * @dev: device handle for event logging purposes 10425fdd593SJeykumar Sankaran * @Return: 0 on Success otherwise -ERROR 10525fdd593SJeykumar Sankaran */ 10625fdd593SJeykumar Sankaran int dpu_rm_init(struct dpu_rm *rm, 10725fdd593SJeykumar Sankaran struct dpu_mdss_cfg *cat, 10825fdd593SJeykumar Sankaran void *mmio, 10925fdd593SJeykumar Sankaran struct drm_device *dev); 11025fdd593SJeykumar Sankaran 11125fdd593SJeykumar Sankaran /** 11225fdd593SJeykumar Sankaran * dpu_rm_destroy - Free all memory allocated by dpu_rm_init 11325fdd593SJeykumar Sankaran * @rm: DPU Resource Manager handle 11425fdd593SJeykumar Sankaran * @Return: 0 on Success otherwise -ERROR 11525fdd593SJeykumar Sankaran */ 11625fdd593SJeykumar Sankaran int dpu_rm_destroy(struct dpu_rm *rm); 11725fdd593SJeykumar Sankaran 11825fdd593SJeykumar Sankaran /** 11925fdd593SJeykumar Sankaran * dpu_rm_reserve - Given a CRTC->Encoder->Connector display chain, analyze 12025fdd593SJeykumar Sankaran * the use connections and user requirements, specified through related 12125fdd593SJeykumar Sankaran * topology control properties, and reserve hardware blocks to that 12225fdd593SJeykumar Sankaran * display chain. 12325fdd593SJeykumar Sankaran * HW blocks can then be accessed through dpu_rm_get_* functions. 12425fdd593SJeykumar Sankaran * HW Reservations should be released via dpu_rm_release_hw. 12525fdd593SJeykumar Sankaran * @rm: DPU Resource Manager handle 12625fdd593SJeykumar Sankaran * @drm_enc: DRM Encoder handle 12725fdd593SJeykumar Sankaran * @crtc_state: Proposed Atomic DRM CRTC State handle 12825fdd593SJeykumar Sankaran * @conn_state: Proposed Atomic DRM Connector State handle 12925fdd593SJeykumar Sankaran * @topology: Pointer to topology info for the display 13025fdd593SJeykumar Sankaran * @test_only: Atomic-Test phase, discard results (unless property overrides) 13125fdd593SJeykumar Sankaran * @Return: 0 on Success otherwise -ERROR 13225fdd593SJeykumar Sankaran */ 13325fdd593SJeykumar Sankaran int dpu_rm_reserve(struct dpu_rm *rm, 13425fdd593SJeykumar Sankaran struct drm_encoder *drm_enc, 13525fdd593SJeykumar Sankaran struct drm_crtc_state *crtc_state, 13625fdd593SJeykumar Sankaran struct drm_connector_state *conn_state, 13725fdd593SJeykumar Sankaran struct msm_display_topology topology, 13825fdd593SJeykumar Sankaran bool test_only); 13925fdd593SJeykumar Sankaran 14025fdd593SJeykumar Sankaran /** 14125fdd593SJeykumar Sankaran * dpu_rm_reserve - Given the encoder for the display chain, release any 14225fdd593SJeykumar Sankaran * HW blocks previously reserved for that use case. 14325fdd593SJeykumar Sankaran * @rm: DPU Resource Manager handle 14425fdd593SJeykumar Sankaran * @enc: DRM Encoder handle 14525fdd593SJeykumar Sankaran * @Return: 0 on Success otherwise -ERROR 14625fdd593SJeykumar Sankaran */ 14725fdd593SJeykumar Sankaran void dpu_rm_release(struct dpu_rm *rm, struct drm_encoder *enc); 14825fdd593SJeykumar Sankaran 14925fdd593SJeykumar Sankaran /** 15025fdd593SJeykumar Sankaran * dpu_rm_get_mdp - Retrieve HW block for MDP TOP. 15125fdd593SJeykumar Sankaran * This is never reserved, and is usable by any display. 15225fdd593SJeykumar Sankaran * @rm: DPU Resource Manager handle 15325fdd593SJeykumar Sankaran * @Return: Pointer to hw block or NULL 15425fdd593SJeykumar Sankaran */ 15525fdd593SJeykumar Sankaran struct dpu_hw_mdp *dpu_rm_get_mdp(struct dpu_rm *rm); 15625fdd593SJeykumar Sankaran 15725fdd593SJeykumar Sankaran /** 15825fdd593SJeykumar Sankaran * dpu_rm_init_hw_iter - setup given iterator for new iteration over hw list 15925fdd593SJeykumar Sankaran * using dpu_rm_get_hw 16025fdd593SJeykumar Sankaran * @iter: iter object to initialize 16125fdd593SJeykumar Sankaran * @enc_id: DRM ID of Encoder client wishes to search for, or 0 for Any Encoder 16225fdd593SJeykumar Sankaran * @type: Hardware Block Type client wishes to search for. 16325fdd593SJeykumar Sankaran */ 16425fdd593SJeykumar Sankaran void dpu_rm_init_hw_iter( 16525fdd593SJeykumar Sankaran struct dpu_rm_hw_iter *iter, 16625fdd593SJeykumar Sankaran uint32_t enc_id, 16725fdd593SJeykumar Sankaran enum dpu_hw_blk_type type); 16825fdd593SJeykumar Sankaran /** 16925fdd593SJeykumar Sankaran * dpu_rm_get_hw - retrieve reserved hw object given encoder and hw type 17025fdd593SJeykumar Sankaran * Meant to do a single pass through the hardware list to iteratively 17125fdd593SJeykumar Sankaran * retrieve hardware blocks of a given type for a given encoder. 17225fdd593SJeykumar Sankaran * Initialize an iterator object. 17325fdd593SJeykumar Sankaran * Set hw block type of interest. Set encoder id of interest, 0 for any. 17425fdd593SJeykumar Sankaran * Function returns first hw of type for that encoder. 17525fdd593SJeykumar Sankaran * Subsequent calls will return the next reserved hw of that type in-order. 17625fdd593SJeykumar Sankaran * Iterator HW pointer will be null on failure to find hw. 17725fdd593SJeykumar Sankaran * @rm: DPU Resource Manager handle 17825fdd593SJeykumar Sankaran * @iter: iterator object 17925fdd593SJeykumar Sankaran * @Return: true on match found, false on no match found 18025fdd593SJeykumar Sankaran */ 18125fdd593SJeykumar Sankaran bool dpu_rm_get_hw(struct dpu_rm *rm, struct dpu_rm_hw_iter *iter); 18225fdd593SJeykumar Sankaran 18325fdd593SJeykumar Sankaran /** 18425fdd593SJeykumar Sankaran * dpu_rm_check_property_topctl - validate property bitmask before it is set 18525fdd593SJeykumar Sankaran * @val: user's proposed topology control bitmask 18625fdd593SJeykumar Sankaran * @Return: 0 on success or error 18725fdd593SJeykumar Sankaran */ 18825fdd593SJeykumar Sankaran int dpu_rm_check_property_topctl(uint64_t val); 18925fdd593SJeykumar Sankaran 19025fdd593SJeykumar Sankaran /** 19125fdd593SJeykumar Sankaran * dpu_rm_get_topology_name - returns the name of the the given topology 19225fdd593SJeykumar Sankaran * definition 19325fdd593SJeykumar Sankaran * @topology: topology definition 19425fdd593SJeykumar Sankaran * @Return: name of the topology 19525fdd593SJeykumar Sankaran */ 19625fdd593SJeykumar Sankaran enum dpu_rm_topology_name 19725fdd593SJeykumar Sankaran dpu_rm_get_topology_name(struct msm_display_topology topology); 19825fdd593SJeykumar Sankaran 19925fdd593SJeykumar Sankaran #endif /* __DPU_RM_H__ */ 200