drivers/gpu/drm/amd/display/dc/dce/dce_clk_mgr.h

   1 /*
   2  * Copyright 2012-16 Advanced Micro Devices, Inc.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20  * OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * Authors: AMD
  23  *
  24  */
  25
  26
  27 #ifndef _DCE_CLK_MGR_H_
  28 #define _DCE_CLK_MGR_H_
  29
  30 #include "clk_mgr.h"
  31 #include "dccg.h"
  32
  33 #define MEMORY_TYPE_MULTIPLIER_CZ 4
  34
  35 #define CLK_COMMON_REG_LIST_DCE_BASE() \
  36         .DPREFCLK_CNTL = mmDPREFCLK_CNTL, \
  37         .DENTIST_DISPCLK_CNTL = mmDENTIST_DISPCLK_CNTL
  38
  39 #define CLK_COMMON_REG_LIST_DCN_BASE() \
  40         SR(DENTIST_DISPCLK_CNTL)
  41
  42 #define CLK_SF(reg_name, field_name, post_fix)\
  43         .field_name = reg_name ## __ ## field_name ## post_fix
  44
  45 #define CLK_COMMON_MASK_SH_LIST_DCE_COMMON_BASE(mask_sh) \
  46         CLK_SF(DPREFCLK_CNTL, DPREFCLK_SRC_SEL, mask_sh), \
  47         CLK_SF(DENTIST_DISPCLK_CNTL, DENTIST_DPREFCLK_WDIVIDER, mask_sh)
  48
  49 #define CLK_COMMON_MASK_SH_LIST_DCN_COMMON_BASE(mask_sh) \
  50         CLK_SF(DENTIST_DISPCLK_CNTL, DENTIST_DISPCLK_WDIVIDER, mask_sh),\
  51         CLK_SF(DENTIST_DISPCLK_CNTL, DENTIST_DISPCLK_CHG_DONE, mask_sh)
  52
  53 #define CLK_REG_FIELD_LIST(type) \
  54         type DPREFCLK_SRC_SEL; \
  55         type DENTIST_DPREFCLK_WDIVIDER; \
  56         type DENTIST_DISPCLK_WDIVIDER; \
  57         type DENTIST_DISPCLK_CHG_DONE;
  58
  59 struct clk_mgr_shift {
  60         CLK_REG_FIELD_LIST(uint8_t)
  61 };
  62
  63 struct clk_mgr_mask {
  64         CLK_REG_FIELD_LIST(uint32_t)
  65 };
  66
  67 struct clk_mgr_registers {
  68         uint32_t DPREFCLK_CNTL;
  69         uint32_t DENTIST_DISPCLK_CNTL;
  70 };
  71
  72 struct state_dependent_clocks {
  73         int display_clk_khz;
  74         int pixel_clk_khz;
  75 };
  76
  77 struct dce_clk_mgr {
  78         struct clk_mgr base;
  79         const struct clk_mgr_registers *regs;
  80         const struct clk_mgr_shift *clk_mgr_shift;
  81         const struct clk_mgr_mask *clk_mgr_mask;
  82
  83         struct dccg *dccg;
  84
  85         struct state_dependent_clocks max_clks_by_state[DM_PP_CLOCKS_MAX_STATES];
  86
  87         int dentist_vco_freq_khz;
  88
  89         /* Cache the status of DFS-bypass feature*/
  90         bool dfs_bypass_enabled;
  91         /* True if the DFS-bypass feature is enabled and active. */
  92         bool dfs_bypass_active;
  93         /* Cache the display clock returned by VBIOS if DFS-bypass is enabled.
  94          * This is basically "Crystal Frequency In KHz" (XTALIN) frequency */
  95         int dfs_bypass_disp_clk;
  96
  97         /* Flag for Enabled SS on DPREFCLK */
  98         bool ss_on_dprefclk;
  99         /* DPREFCLK SS percentage (if down-spread enabled) */
 100         int dprefclk_ss_percentage;
 101         /* DPREFCLK SS percentage Divider (100 or 1000) */
 102         int dprefclk_ss_divider;
 103         int dprefclk_khz;
 104
 105         enum dm_pp_clocks_state max_clks_state;
 106         enum dm_pp_clocks_state cur_min_clks_state;
 107 };
 108
 109 /* Starting DID for each range */
 110 enum dentist_base_divider_id {
 111         DENTIST_BASE_DID_1 = 0x08,
 112         DENTIST_BASE_DID_2 = 0x40,
 113         DENTIST_BASE_DID_3 = 0x60,
 114         DENTIST_BASE_DID_4 = 0x7e,
 115         DENTIST_MAX_DID = 0x7f
 116 };
 117
 118 /* Starting point and step size for each divider range.*/
 119 enum dentist_divider_range {
 120         DENTIST_DIVIDER_RANGE_1_START = 8,   /* 2.00  */
 121         DENTIST_DIVIDER_RANGE_1_STEP  = 1,   /* 0.25  */
 122         DENTIST_DIVIDER_RANGE_2_START = 64,  /* 16.00 */
 123         DENTIST_DIVIDER_RANGE_2_STEP  = 2,   /* 0.50  */
 124         DENTIST_DIVIDER_RANGE_3_START = 128, /* 32.00 */
 125         DENTIST_DIVIDER_RANGE_3_STEP  = 4,   /* 1.00  */
 126         DENTIST_DIVIDER_RANGE_4_START = 248, /* 62.00 */
 127         DENTIST_DIVIDER_RANGE_4_STEP  = 264, /* 66.00 */
 128         DENTIST_DIVIDER_RANGE_SCALE_FACTOR = 4
 129 };
 130
 131 static inline bool should_set_clock(bool safe_to_lower, int calc_clk, int cur_clk)
 132 {
 133         return ((safe_to_lower && calc_clk < cur_clk) || calc_clk > cur_clk);
 134 }
 135
 136 void dce_clock_read_ss_info(struct dce_clk_mgr *dccg_dce);
 137
 138 int dce12_get_dp_ref_freq_khz(struct clk_mgr *dccg);
 139
 140 void dce110_fill_display_configs(
 141         const struct dc_state *context,
 142         struct dm_pp_display_configuration *pp_display_cfg);
 143
 144 int dce112_set_clock(struct clk_mgr *dccg, int requested_clk_khz);
 145
 146 struct clk_mgr *dce_clk_mgr_create(
 147         struct dc_context *ctx,
 148         const struct clk_mgr_registers *regs,
 149         const struct clk_mgr_shift *clk_shift,
 150         const struct clk_mgr_mask *clk_mask);
 151
 152 struct clk_mgr *dce110_clk_mgr_create(
 153         struct dc_context *ctx,
 154         const struct clk_mgr_registers *regs,
 155         const struct clk_mgr_shift *clk_shift,
 156         const struct clk_mgr_mask *clk_mask);
 157
 158 struct clk_mgr *dce112_clk_mgr_create(
 159         struct dc_context *ctx,
 160         const struct clk_mgr_registers *regs,
 161         const struct clk_mgr_shift *clk_shift,
 162         const struct clk_mgr_mask *clk_mask);
 163
 164 struct clk_mgr *dce120_clk_mgr_create(struct dc_context *ctx);
 165
 166 void dce_clk_mgr_destroy(struct clk_mgr **clk_mgr);
 167
 168 int dentist_get_divider_from_did(int did);
 169
 170 #endif /* _DCE_CLK_MGR_H_ */