drivers/gpu/drm/amd/powerplay/inc/hwmgr.h

   1 /*
   2  * Copyright 2015 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  */
  23 #ifndef _HWMGR_H_
  24 #define _HWMGR_H_
  25
  26 #include <linux/seq_file.h>
  27 #include "amd_powerplay.h"
  28 #include "pp_instance.h"
  29 #include "hardwaremanager.h"
  30 #include "pp_power_source.h"
  31 #include "hwmgr_ppt.h"
  32 #include "ppatomctrl.h"
  33 #include "hwmgr_ppt.h"
  34
  35 struct pp_instance;
  36 struct pp_hwmgr;
  37 struct pp_hw_power_state;
  38 struct pp_power_state;
  39 struct PP_VCEState;
  40 struct phm_fan_speed_info;
  41 struct pp_atomctrl_voltage_table;
  42
  43
  44 enum DISPLAY_GAP {
  45         DISPLAY_GAP_VBLANK_OR_WM = 0,   /* Wait for vblank or MCHG watermark. */
  46         DISPLAY_GAP_VBLANK       = 1,   /* Wait for vblank. */
  47         DISPLAY_GAP_WATERMARK    = 2,   /* Wait for MCHG watermark. (Note that HW may deassert WM in VBI depending on DC_STUTTER_CNTL.) */
  48         DISPLAY_GAP_IGNORE       = 3    /* Do not wait. */
  49 };
  50 typedef enum DISPLAY_GAP DISPLAY_GAP;
  51
  52
  53 struct vi_dpm_level {
  54         bool enabled;
  55         uint32_t value;
  56         uint32_t param1;
  57 };
  58
  59 struct vi_dpm_table {
  60         uint32_t count;
  61         struct vi_dpm_level dpm_level[1];
  62 };
  63
  64 enum PP_Result {
  65         PP_Result_TableImmediateExit = 0x13,
  66 };
  67
  68 #define PCIE_PERF_REQ_REMOVE_REGISTRY   0
  69 #define PCIE_PERF_REQ_FORCE_LOWPOWER    1
  70 #define PCIE_PERF_REQ_GEN1         2
  71 #define PCIE_PERF_REQ_GEN2         3
  72 #define PCIE_PERF_REQ_GEN3         4
  73
  74 enum PHM_BackEnd_Magic {
  75         PHM_Dummy_Magic       = 0xAA5555AA,
  76         PHM_RV770_Magic       = 0xDCBAABCD,
  77         PHM_Kong_Magic        = 0x239478DF,
  78         PHM_NIslands_Magic    = 0x736C494E,
  79         PHM_Sumo_Magic        = 0x8339FA11,
  80         PHM_SIslands_Magic    = 0x369431AC,
  81         PHM_Trinity_Magic     = 0x96751873,
  82         PHM_CIslands_Magic    = 0x38AC78B0,
  83         PHM_Kv_Magic          = 0xDCBBABC0,
  84         PHM_VIslands_Magic    = 0x20130307,
  85         PHM_Cz_Magic          = 0x67DCBA25
  86 };
  87
  88
  89 #define PHM_PCIE_POWERGATING_TARGET_GFX            0
  90 #define PHM_PCIE_POWERGATING_TARGET_DDI            1
  91 #define PHM_PCIE_POWERGATING_TARGET_PLLCASCADE     2
  92 #define PHM_PCIE_POWERGATING_TARGET_PHY            3
  93
  94 typedef int (*phm_table_function)(struct pp_hwmgr *hwmgr, void *input,
  95                                   void *output, void *storage, int result);
  96
  97 typedef bool (*phm_check_function)(struct pp_hwmgr *hwmgr);
  98
  99 struct phm_set_power_state_input {
 100         const struct pp_hw_power_state *pcurrent_state;
 101         const struct pp_hw_power_state *pnew_state;
 102 };
 103
 104 struct phm_acp_arbiter {
 105         uint32_t acpclk;
 106 };
 107
 108 struct phm_uvd_arbiter {
 109         uint32_t vclk;
 110         uint32_t dclk;
 111         uint32_t vclk_ceiling;
 112         uint32_t dclk_ceiling;
 113 };
 114
 115 struct phm_vce_arbiter {
 116         uint32_t   evclk;
 117         uint32_t   ecclk;
 118 };
 119
 120 struct phm_gfx_arbiter {
 121         uint32_t sclk;
 122         uint32_t mclk;
 123         uint32_t sclk_over_drive;
 124         uint32_t mclk_over_drive;
 125         uint32_t sclk_threshold;
 126         uint32_t num_cus;
 127 };
 128
 129 /* Entries in the master tables */
 130 struct phm_master_table_item {
 131         phm_check_function isFunctionNeededInRuntimeTable;
 132         phm_table_function tableFunction;
 133 };
 134
 135 enum phm_master_table_flag {
 136         PHM_MasterTableFlag_None         = 0,
 137         PHM_MasterTableFlag_ExitOnError  = 1,
 138 };
 139
 140 /* The header of the master tables */
 141 struct phm_master_table_header {
 142         uint32_t storage_size;
 143         uint32_t flags;
 144         struct phm_master_table_item *master_list;
 145 };
 146
 147 struct phm_runtime_table_header {
 148         uint32_t storage_size;
 149         bool exit_error;
 150         phm_table_function *function_list;
 151 };
 152
 153 struct phm_clock_array {
 154         uint32_t count;
 155         uint32_t values[1];
 156 };
 157
 158 struct phm_clock_voltage_dependency_record {
 159         uint32_t clk;
 160         uint32_t v;
 161 };
 162
 163 struct phm_vceclock_voltage_dependency_record {
 164         uint32_t ecclk;
 165         uint32_t evclk;
 166         uint32_t v;
 167 };
 168
 169 struct phm_uvdclock_voltage_dependency_record {
 170         uint32_t vclk;
 171         uint32_t dclk;
 172         uint32_t v;
 173 };
 174
 175 struct phm_samuclock_voltage_dependency_record {
 176         uint32_t samclk;
 177         uint32_t v;
 178 };
 179
 180 struct phm_acpclock_voltage_dependency_record {
 181         uint32_t acpclk;
 182         uint32_t v;
 183 };
 184
 185 struct phm_clock_voltage_dependency_table {
 186         uint32_t count;                                                                         /* Number of entries. */
 187         struct phm_clock_voltage_dependency_record entries[1];          /* Dynamically allocate count entries. */
 188 };
 189
 190 struct phm_phase_shedding_limits_record {
 191         uint32_t  Voltage;
 192         uint32_t    Sclk;
 193         uint32_t    Mclk;
 194 };
 195
 196
 197 extern int phm_dispatch_table(struct pp_hwmgr *hwmgr,
 198                               struct phm_runtime_table_header *rt_table,
 199                               void *input, void *output);
 200
 201 extern int phm_construct_table(struct pp_hwmgr *hwmgr,
 202                                struct phm_master_table_header *master_table,
 203                                struct phm_runtime_table_header *rt_table);
 204
 205 extern int phm_destroy_table(struct pp_hwmgr *hwmgr,
 206                              struct phm_runtime_table_header *rt_table);
 207
 208
 209 struct phm_uvd_clock_voltage_dependency_record {
 210         uint32_t vclk;
 211         uint32_t dclk;
 212         uint32_t v;
 213 };
 214
 215 struct phm_uvd_clock_voltage_dependency_table {
 216         uint8_t count;
 217         struct phm_uvd_clock_voltage_dependency_record entries[1];
 218 };
 219
 220 struct phm_acp_clock_voltage_dependency_record {
 221         uint32_t acpclk;
 222         uint32_t v;
 223 };
 224
 225 struct phm_acp_clock_voltage_dependency_table {
 226         uint32_t count;
 227         struct phm_acp_clock_voltage_dependency_record entries[1];
 228 };
 229
 230 struct phm_vce_clock_voltage_dependency_record {
 231         uint32_t ecclk;
 232         uint32_t evclk;
 233         uint32_t v;
 234 };
 235
 236 struct phm_phase_shedding_limits_table {
 237         uint32_t                           count;
 238         struct phm_phase_shedding_limits_record  entries[1];
 239 };
 240
 241 struct phm_vceclock_voltage_dependency_table {
 242         uint8_t count;                                    /* Number of entries. */
 243         struct phm_vceclock_voltage_dependency_record entries[1]; /* Dynamically allocate count entries. */
 244 };
 245
 246 struct phm_uvdclock_voltage_dependency_table {
 247         uint8_t count;                                    /* Number of entries. */
 248         struct phm_uvdclock_voltage_dependency_record entries[1]; /* Dynamically allocate count entries. */
 249 };
 250
 251 struct phm_samuclock_voltage_dependency_table {
 252         uint8_t count;                                    /* Number of entries. */
 253         struct phm_samuclock_voltage_dependency_record entries[1]; /* Dynamically allocate count entries. */
 254 };
 255
 256 struct phm_acpclock_voltage_dependency_table {
 257         uint32_t count;                                    /* Number of entries. */
 258         struct phm_acpclock_voltage_dependency_record entries[1]; /* Dynamically allocate count entries. */
 259 };
 260
 261 struct phm_vce_clock_voltage_dependency_table {
 262         uint8_t count;
 263         struct phm_vce_clock_voltage_dependency_record entries[1];
 264 };
 265
 266 struct pp_hwmgr_func {
 267         int (*backend_init)(struct pp_hwmgr *hw_mgr);
 268         int (*backend_fini)(struct pp_hwmgr *hw_mgr);
 269         int (*asic_setup)(struct pp_hwmgr *hw_mgr);
 270         int (*get_power_state_size)(struct pp_hwmgr *hw_mgr);
 271
 272         int (*apply_state_adjust_rules)(struct pp_hwmgr *hwmgr,
 273                                 struct pp_power_state  *prequest_ps,
 274                         const struct pp_power_state *pcurrent_ps);
 275
 276         int (*force_dpm_level)(struct pp_hwmgr *hw_mgr,
 277                                         enum amd_dpm_forced_level level);
 278
 279         int (*dynamic_state_management_enable)(
 280                                                 struct pp_hwmgr *hw_mgr);
 281
 282         int (*patch_boot_state)(struct pp_hwmgr *hwmgr,
 283                                      struct pp_hw_power_state *hw_ps);
 284
 285         int (*get_pp_table_entry)(struct pp_hwmgr *hwmgr,
 286                             unsigned long, struct pp_power_state *);
 287         int (*get_num_of_pp_table_entries)(struct pp_hwmgr *hwmgr);
 288         int (*powerdown_uvd)(struct pp_hwmgr *hwmgr);
 289         int (*powergate_vce)(struct pp_hwmgr *hwmgr, bool bgate);
 290         int (*powergate_uvd)(struct pp_hwmgr *hwmgr, bool bgate);
 291         int (*get_mclk)(struct pp_hwmgr *hwmgr, bool low);
 292         int (*get_sclk)(struct pp_hwmgr *hwmgr, bool low);
 293         int (*power_state_set)(struct pp_hwmgr *hwmgr,
 294                                                 const void *state);
 295         void (*print_current_perforce_level)(struct pp_hwmgr *hwmgr,
 296                                                         struct seq_file *m);
 297         int (*enable_clock_power_gating)(struct pp_hwmgr *hwmgr);
 298         int (*notify_smc_display_config_after_ps_adjustment)(struct pp_hwmgr *hwmgr);
 299         int (*display_config_changed)(struct pp_hwmgr *hwmgr);
 300         int (*disable_clock_power_gating)(struct pp_hwmgr *hwmgr);
 301         int (*update_clock_gatings)(struct pp_hwmgr *hwmgr,
 302                                                 const uint32_t *msg_id);
 303         int (*set_max_fan_rpm_output)(struct pp_hwmgr *hwmgr, uint16_t us_max_fan_pwm);
 304         int (*set_max_fan_pwm_output)(struct pp_hwmgr *hwmgr, uint16_t us_max_fan_pwm);
 305         int (*get_temperature)(struct pp_hwmgr *hwmgr);
 306         int (*stop_thermal_controller)(struct pp_hwmgr *hwmgr);
 307         int (*get_fan_speed_info)(struct pp_hwmgr *hwmgr, struct phm_fan_speed_info *fan_speed_info);
 308         int (*set_fan_control_mode)(struct pp_hwmgr *hwmgr, uint32_t mode);
 309         int (*get_fan_control_mode)(struct pp_hwmgr *hwmgr);
 310         int (*set_fan_speed_percent)(struct pp_hwmgr *hwmgr, uint32_t percent);
 311         int (*get_fan_speed_percent)(struct pp_hwmgr *hwmgr, uint32_t *speed);
 312         int (*set_fan_speed_rpm)(struct pp_hwmgr *hwmgr, uint32_t percent);
 313         int (*get_fan_speed_rpm)(struct pp_hwmgr *hwmgr, uint32_t *speed);
 314         int (*reset_fan_speed_to_default)(struct pp_hwmgr *hwmgr);
 315         int (*uninitialize_thermal_controller)(struct pp_hwmgr *hwmgr);
 316         int (*register_internal_thermal_interrupt)(struct pp_hwmgr *hwmgr,
 317                                         const void *thermal_interrupt_info);
 318         bool (*check_smc_update_required_for_display_configuration)(struct pp_hwmgr *hwmgr);
 319         int (*check_states_equal)(struct pp_hwmgr *hwmgr,
 320                                         const struct pp_hw_power_state *pstate1,
 321                                         const struct pp_hw_power_state *pstate2,
 322                                         bool *equal);
 323         int (*set_cpu_power_state)(struct pp_hwmgr *hwmgr);
 324         int (*store_cc6_data)(struct pp_hwmgr *hwmgr, uint32_t separation_time,
 325                                 bool cc6_disable, bool pstate_disable,
 326                                 bool pstate_switch_disable);
 327         int (*get_dal_power_level)(struct pp_hwmgr *hwmgr,
 328                                    struct amd_pp_dal_clock_info *info);
 329         int (*power_off_asic)(struct pp_hwmgr *hwmgr);
 330 };
 331
 332 struct pp_table_func {
 333         int (*pptable_init)(struct pp_hwmgr *hw_mgr);
 334         int (*pptable_fini)(struct pp_hwmgr *hw_mgr);
 335         int (*pptable_get_number_of_vce_state_table_entries)(struct pp_hwmgr *hw_mgr);
 336         int (*pptable_get_vce_state_table_entry)(
 337                                                 struct pp_hwmgr *hwmgr,
 338                                                 unsigned long i,
 339                                                 struct PP_VCEState *vce_state,
 340                                                 void **clock_info,
 341                                                 unsigned long *flag);
 342 };
 343
 344 union phm_cac_leakage_record {
 345         struct {
 346                 uint16_t Vddc;          /* in CI, we use it for StdVoltageHiSidd */
 347                 uint32_t Leakage;       /* in CI, we use it for StdVoltageLoSidd */
 348         };
 349         struct {
 350                 uint16_t Vddc1;
 351                 uint16_t Vddc2;
 352                 uint16_t Vddc3;
 353         };
 354 };
 355
 356 struct phm_cac_leakage_table {
 357         uint32_t count;
 358         union phm_cac_leakage_record entries[1];
 359 };
 360
 361 struct phm_samu_clock_voltage_dependency_record {
 362         uint32_t samclk;
 363         uint32_t v;
 364 };
 365
 366
 367 struct phm_samu_clock_voltage_dependency_table {
 368         uint8_t count;
 369         struct phm_samu_clock_voltage_dependency_record entries[1];
 370 };
 371
 372 struct phm_cac_tdp_table {
 373         uint16_t usTDP;
 374         uint16_t usConfigurableTDP;
 375         uint16_t usTDC;
 376         uint16_t usBatteryPowerLimit;
 377         uint16_t usSmallPowerLimit;
 378         uint16_t usLowCACLeakage;
 379         uint16_t usHighCACLeakage;
 380         uint16_t usMaximumPowerDeliveryLimit;
 381         uint16_t usOperatingTempMinLimit;
 382         uint16_t usOperatingTempMaxLimit;
 383         uint16_t usOperatingTempStep;
 384         uint16_t usOperatingTempHyst;
 385         uint16_t usDefaultTargetOperatingTemp;
 386         uint16_t usTargetOperatingTemp;
 387         uint16_t usPowerTuneDataSetID;
 388         uint16_t usSoftwareShutdownTemp;
 389         uint16_t usClockStretchAmount;
 390         uint16_t usTemperatureLimitHotspot;
 391         uint16_t usTemperatureLimitLiquid1;
 392         uint16_t usTemperatureLimitLiquid2;
 393         uint16_t usTemperatureLimitVrVddc;
 394         uint16_t usTemperatureLimitVrMvdd;
 395         uint16_t usTemperatureLimitPlx;
 396         uint8_t  ucLiquid1_I2C_address;
 397         uint8_t  ucLiquid2_I2C_address;
 398         uint8_t  ucLiquid_I2C_Line;
 399         uint8_t  ucVr_I2C_address;
 400         uint8_t  ucVr_I2C_Line;
 401         uint8_t  ucPlx_I2C_address;
 402         uint8_t  ucPlx_I2C_Line;
 403 };
 404
 405 struct phm_ppm_table {
 406         uint8_t   ppm_design;
 407         uint16_t  cpu_core_number;
 408         uint32_t  platform_tdp;
 409         uint32_t  small_ac_platform_tdp;
 410         uint32_t  platform_tdc;
 411         uint32_t  small_ac_platform_tdc;
 412         uint32_t  apu_tdp;
 413         uint32_t  dgpu_tdp;
 414         uint32_t  dgpu_ulv_power;
 415         uint32_t  tj_max;
 416 };
 417
 418 struct phm_vq_budgeting_record {
 419         uint32_t ulCUs;
 420         uint32_t ulSustainableSOCPowerLimitLow;
 421         uint32_t ulSustainableSOCPowerLimitHigh;
 422         uint32_t ulMinSclkLow;
 423         uint32_t ulMinSclkHigh;
 424         uint8_t  ucDispConfig;
 425         uint32_t ulDClk;
 426         uint32_t ulEClk;
 427         uint32_t ulSustainableSclk;
 428         uint32_t ulSustainableCUs;
 429 };
 430
 431 struct phm_vq_budgeting_table {
 432         uint8_t numEntries;
 433         struct phm_vq_budgeting_record entries[1];
 434 };
 435
 436 struct phm_clock_and_voltage_limits {
 437         uint32_t sclk;
 438         uint32_t mclk;
 439         uint16_t vddc;
 440         uint16_t vddci;
 441         uint16_t vddgfx;
 442 };
 443
 444 /* Structure to hold PPTable information */
 445
 446 struct phm_ppt_v1_information {
 447         struct phm_ppt_v1_clock_voltage_dependency_table *vdd_dep_on_sclk;
 448         struct phm_ppt_v1_clock_voltage_dependency_table *vdd_dep_on_mclk;
 449         struct phm_clock_array *valid_sclk_values;
 450         struct phm_clock_array *valid_mclk_values;
 451         struct phm_clock_and_voltage_limits max_clock_voltage_on_dc;
 452         struct phm_clock_and_voltage_limits max_clock_voltage_on_ac;
 453         struct phm_clock_voltage_dependency_table *vddc_dep_on_dal_pwrl;
 454         struct phm_ppm_table *ppm_parameter_table;
 455         struct phm_cac_tdp_table *cac_dtp_table;
 456         struct phm_ppt_v1_mm_clock_voltage_dependency_table *mm_dep_table;
 457         struct phm_ppt_v1_voltage_lookup_table *vddc_lookup_table;
 458         struct phm_ppt_v1_voltage_lookup_table *vddgfx_lookup_table;
 459         struct phm_ppt_v1_pcie_table *pcie_table;
 460         uint16_t us_ulv_voltage_offset;
 461 };
 462
 463 struct phm_dynamic_state_info {
 464         struct phm_clock_voltage_dependency_table *vddc_dependency_on_sclk;
 465         struct phm_clock_voltage_dependency_table *vddci_dependency_on_mclk;
 466         struct phm_clock_voltage_dependency_table *vddc_dependency_on_mclk;
 467         struct phm_clock_voltage_dependency_table *mvdd_dependency_on_mclk;
 468         struct phm_clock_voltage_dependency_table *vddc_dep_on_dal_pwrl;
 469         struct phm_clock_array                    *valid_sclk_values;
 470         struct phm_clock_array                    *valid_mclk_values;
 471         struct phm_clock_and_voltage_limits       max_clock_voltage_on_dc;
 472         struct phm_clock_and_voltage_limits       max_clock_voltage_on_ac;
 473         uint32_t                                  mclk_sclk_ratio;
 474         uint32_t                                  sclk_mclk_delta;
 475         uint32_t                                  vddc_vddci_delta;
 476         uint32_t                                  min_vddc_for_pcie_gen2;
 477         struct phm_cac_leakage_table              *cac_leakage_table;
 478         struct phm_phase_shedding_limits_table    *vddc_phase_shed_limits_table;
 479
 480         struct phm_vce_clock_voltage_dependency_table
 481                                             *vce_clock_voltage_dependency_table;
 482         struct phm_uvd_clock_voltage_dependency_table
 483                                             *uvd_clock_voltage_dependency_table;
 484         struct phm_acp_clock_voltage_dependency_table
 485                                             *acp_clock_voltage_dependency_table;
 486         struct phm_samu_clock_voltage_dependency_table
 487                                            *samu_clock_voltage_dependency_table;
 488
 489         struct phm_ppm_table                          *ppm_parameter_table;
 490         struct phm_cac_tdp_table                      *cac_dtp_table;
 491         struct phm_clock_voltage_dependency_table         *vdd_gfx_dependency_on_sclk;
 492         struct phm_vq_budgeting_table                             *vq_budgeting_table;
 493 };
 494
 495 struct pp_fan_info {
 496         bool bNoFan;
 497         uint8_t   ucTachometerPulsesPerRevolution;
 498         uint32_t   ulMinRPM;
 499         uint32_t   ulMaxRPM;
 500 };
 501
 502 struct pp_advance_fan_control_parameters {
 503         uint16_t  usTMin;                          /* The temperature, in 0.01 centigrades, below which we just run at a minimal PWM. */
 504         uint16_t  usTMed;                          /* The middle temperature where we change slopes. */
 505         uint16_t  usTHigh;                         /* The high temperature for setting the second slope. */
 506         uint16_t  usPWMMin;                        /* The minimum PWM value in percent (0.01% increments). */
 507         uint16_t  usPWMMed;                        /* The PWM value (in percent) at TMed. */
 508         uint16_t  usPWMHigh;                       /* The PWM value at THigh. */
 509         uint8_t   ucTHyst;                         /* Temperature hysteresis. Integer. */
 510         uint32_t   ulCycleDelay;                   /* The time between two invocations of the fan control routine in microseconds. */
 511         uint16_t  usTMax;                          /* The max temperature */
 512         uint8_t   ucFanControlMode;
 513         uint16_t  usFanPWMMinLimit;
 514         uint16_t  usFanPWMMaxLimit;
 515         uint16_t  usFanPWMStep;
 516         uint16_t  usDefaultMaxFanPWM;
 517         uint16_t  usFanOutputSensitivity;
 518         uint16_t  usDefaultFanOutputSensitivity;
 519         uint16_t  usMaxFanPWM;                     /* The max Fan PWM value for Fuzzy Fan Control feature */
 520         uint16_t  usFanRPMMinLimit;                /* Minimum limit range in percentage, need to calculate based on minRPM/MaxRpm */
 521         uint16_t  usFanRPMMaxLimit;                /* Maximum limit range in percentage, usually set to 100% by default */
 522         uint16_t  usFanRPMStep;                    /* Step increments/decerements, in percent */
 523         uint16_t  usDefaultMaxFanRPM;              /* The max Fan RPM value for Fuzzy Fan Control feature, default from PPTable */
 524         uint16_t  usMaxFanRPM;                     /* The max Fan RPM value for Fuzzy Fan Control feature, user defined */
 525         uint16_t  usFanCurrentLow;                 /* Low current */
 526         uint16_t  usFanCurrentHigh;                /* High current */
 527         uint16_t  usFanRPMLow;                     /* Low RPM */
 528         uint16_t  usFanRPMHigh;                    /* High RPM */
 529         uint32_t   ulMinFanSCLKAcousticLimit;      /* Minimum Fan Controller SCLK Frequency Acoustic Limit. */
 530         uint8_t   ucTargetTemperature;             /* Advanced fan controller target temperature. */
 531         uint8_t   ucMinimumPWMLimit;               /* The minimum PWM that the advanced fan controller can set.  This should be set to the highest PWM that will run the fan at its lowest RPM. */
 532         uint16_t  usFanGainEdge;                   /* The following is added for Fiji */
 533         uint16_t  usFanGainHotspot;
 534         uint16_t  usFanGainLiquid;
 535         uint16_t  usFanGainVrVddc;
 536         uint16_t  usFanGainVrMvdd;
 537         uint16_t  usFanGainPlx;
 538         uint16_t  usFanGainHbm;
 539 };
 540
 541 struct pp_thermal_controller_info {
 542         uint8_t ucType;
 543         uint8_t ucI2cLine;
 544         uint8_t ucI2cAddress;
 545         struct pp_fan_info fanInfo;
 546         struct pp_advance_fan_control_parameters advanceFanControlParameters;
 547 };
 548
 549 struct phm_microcode_version_info {
 550         uint32_t SMC;
 551         uint32_t DMCU;
 552         uint32_t MC;
 553         uint32_t NB;
 554 };
 555
 556 /**
 557  * The main hardware manager structure.
 558  */
 559 struct pp_hwmgr {
 560         uint32_t chip_family;
 561         uint32_t chip_id;
 562         uint32_t hw_revision;
 563         uint32_t sub_sys_id;
 564         uint32_t sub_vendor_id;
 565
 566         void *device;
 567         struct pp_smumgr *smumgr;
 568         const void *soft_pp_table;
 569         bool need_pp_table_upload;
 570         enum amd_dpm_forced_level dpm_level;
 571         bool block_hw_access;
 572         struct phm_gfx_arbiter gfx_arbiter;
 573         struct phm_acp_arbiter acp_arbiter;
 574         struct phm_uvd_arbiter uvd_arbiter;
 575         struct phm_vce_arbiter vce_arbiter;
 576         uint32_t usec_timeout;
 577         void *pptable;
 578         struct phm_platform_descriptor platform_descriptor;
 579         void *backend;
 580         enum PP_DAL_POWERLEVEL dal_power_level;
 581         struct phm_dynamic_state_info dyn_state;
 582         struct phm_runtime_table_header setup_asic;
 583         struct phm_runtime_table_header power_down_asic;
 584         struct phm_runtime_table_header disable_dynamic_state_management;
 585         struct phm_runtime_table_header enable_dynamic_state_management;
 586         struct phm_runtime_table_header set_power_state;
 587         struct phm_runtime_table_header enable_clock_power_gatings;
 588         struct phm_runtime_table_header display_configuration_changed;
 589         struct phm_runtime_table_header start_thermal_controller;
 590         struct phm_runtime_table_header set_temperature_range;
 591         const struct pp_hwmgr_func *hwmgr_func;
 592         const struct pp_table_func *pptable_func;
 593         struct pp_power_state    *ps;
 594         enum pp_power_source  power_source;
 595         uint32_t num_ps;
 596         struct pp_thermal_controller_info thermal_controller;
 597         bool fan_ctrl_is_in_default_mode;
 598         uint32_t fan_ctrl_default_mode;
 599         uint32_t tmin;
 600         struct phm_microcode_version_info microcode_version_info;
 601         uint32_t ps_size;
 602         struct pp_power_state    *current_ps;
 603         struct pp_power_state    *request_ps;
 604         struct pp_power_state    *boot_ps;
 605         struct pp_power_state    *uvd_ps;
 606         struct amd_pp_display_configuration display_config;
 607 };
 608
 609
 610 extern int hwmgr_init(struct amd_pp_init *pp_init,
 611                       struct pp_instance *handle);
 612
 613 extern int hwmgr_fini(struct pp_hwmgr *hwmgr);
 614
 615 extern int hw_init_power_state_table(struct pp_hwmgr *hwmgr);
 616
 617 extern int phm_wait_on_register(struct pp_hwmgr *hwmgr, uint32_t index,
 618                                 uint32_t value, uint32_t mask);
 619
 620 extern int phm_wait_for_register_unequal(struct pp_hwmgr *hwmgr,
 621                                 uint32_t index, uint32_t value, uint32_t mask);
 622
 623 extern uint32_t phm_read_indirect_register(struct pp_hwmgr *hwmgr,
 624                 uint32_t indirect_port, uint32_t index);
 625
 626 extern void phm_write_indirect_register(struct pp_hwmgr *hwmgr,
 627                 uint32_t indirect_port,
 628                 uint32_t index,
 629                 uint32_t value);
 630
 631 extern void phm_wait_on_indirect_register(struct pp_hwmgr *hwmgr,
 632                                 uint32_t indirect_port,
 633                                 uint32_t index,
 634                                 uint32_t value,
 635                                 uint32_t mask);
 636
 637 extern void phm_wait_for_indirect_register_unequal(
 638                                 struct pp_hwmgr *hwmgr,
 639                                 uint32_t indirect_port,
 640                                 uint32_t index,
 641                                 uint32_t value,
 642                                 uint32_t mask);
 643
 644 extern bool phm_cf_want_uvd_power_gating(struct pp_hwmgr *hwmgr);
 645 extern bool phm_cf_want_vce_power_gating(struct pp_hwmgr *hwmgr);
 646 extern bool phm_cf_want_microcode_fan_ctrl(struct pp_hwmgr *hwmgr);
 647
 648 extern int phm_trim_voltage_table(struct pp_atomctrl_voltage_table *vol_table);
 649 extern int phm_get_svi2_mvdd_voltage_table(struct pp_atomctrl_voltage_table *vol_table, phm_ppt_v1_clock_voltage_dependency_table *dep_table);
 650 extern int phm_get_svi2_vddci_voltage_table(struct pp_atomctrl_voltage_table *vol_table, phm_ppt_v1_clock_voltage_dependency_table *dep_table);
 651 extern int phm_get_svi2_vdd_voltage_table(struct pp_atomctrl_voltage_table *vol_table, phm_ppt_v1_voltage_lookup_table *lookup_table);
 652 extern void phm_trim_voltage_table_to_fit_state_table(uint32_t max_vol_steps, struct pp_atomctrl_voltage_table *vol_table);
 653 extern int phm_reset_single_dpm_table(void *table, uint32_t count, int max);
 654 extern void phm_setup_pcie_table_entry(void *table, uint32_t index, uint32_t pcie_gen, uint32_t pcie_lanes);
 655 extern int32_t phm_get_dpm_level_enable_mask_value(void *table);
 656 extern uint8_t phm_get_voltage_index(struct phm_ppt_v1_voltage_lookup_table *lookup_table, uint16_t voltage);
 657 extern uint16_t phm_find_closest_vddci(struct pp_atomctrl_voltage_table *vddci_table, uint16_t vddci);
 658 extern int phm_find_boot_level(void *table, uint32_t value, uint32_t *boot_level);
 659 extern int phm_get_sclk_for_voltage_evv(struct pp_hwmgr *hwmgr, phm_ppt_v1_voltage_lookup_table *lookup_table,
 660                                                                 uint16_t virtual_voltage_id, int32_t *sclk);
 661 extern int phm_initializa_dynamic_state_adjustment_rule_settings(struct pp_hwmgr *hwmgr);
 662 extern int phm_hwmgr_backend_fini(struct pp_hwmgr *hwmgr);
 663 extern uint32_t phm_get_lowest_enabled_level(struct pp_hwmgr *hwmgr, uint32_t mask);
 664
 665
 666 #define PHM_ENTIRE_REGISTER_MASK 0xFFFFFFFFU
 667
 668 #define PHM_FIELD_SHIFT(reg, field) reg##__##field##__SHIFT
 669 #define PHM_FIELD_MASK(reg, field) reg##__##field##_MASK
 670
 671 #define PHM_SET_FIELD(origval, reg, field, fieldval)    \
 672         (((origval) & ~PHM_FIELD_MASK(reg, field)) |    \
 673          (PHM_FIELD_MASK(reg, field) & ((fieldval) << PHM_FIELD_SHIFT(reg, field))))
 674
 675 #define PHM_GET_FIELD(value, reg, field)        \
 676         (((value) & PHM_FIELD_MASK(reg, field)) >>      \
 677          PHM_FIELD_SHIFT(reg, field))
 678
 679
 680 #define PHM_WAIT_REGISTER_GIVEN_INDEX(hwmgr, index, value, mask)        \
 681         phm_wait_on_register(hwmgr, index, value, mask)
 682
 683 #define PHM_WAIT_REGISTER_UNEQUAL_GIVEN_INDEX(hwmgr, index, value, mask)        \
 684         phm_wait_for_register_unequal(hwmgr, index, value, mask)
 685
 686 #define PHM_WAIT_INDIRECT_REGISTER_GIVEN_INDEX(hwmgr, port, index, value, mask) \
 687         phm_wait_on_indirect_register(hwmgr, mm##port##_INDEX, index, value, mask)
 688
 689 #define PHM_WAIT_INDIRECT_REGISTER_UNEQUAL_GIVEN_INDEX(hwmgr, port, index, value, mask) \
 690         phm_wait_for_indirect_register_unequal(hwmgr, mm##port##_INDEX, index, value, mask)
 691
 692 #define PHM_WAIT_VFPF_INDIRECT_REGISTER_GIVEN_INDEX(hwmgr, port, index, value, mask)    \
 693         phm_wait_on_indirect_register(hwmgr, mm##port##_INDEX_0, index, value, mask)
 694
 695 #define PHM_WAIT_VFPF_INDIRECT_REGISTER_UNEQUAL_GIVEN_INDEX(hwmgr, port, index, value, mask)    \
 696         phm_wait_for_indirect_register_unequal(hwmgr, mm##port##_INDEX_0, index, value, mask)
 697
 698 /* Operations on named registers. */
 699
 700 #define PHM_WAIT_REGISTER(hwmgr, reg, value, mask)      \
 701         PHM_WAIT_REGISTER_GIVEN_INDEX(hwmgr, mm##reg, value, mask)
 702
 703 #define PHM_WAIT_REGISTER_UNEQUAL(hwmgr, reg, value, mask)      \
 704         PHM_WAIT_REGISTER_UNEQUAL_GIVEN_INDEX(hwmgr, mm##reg, value, mask)
 705
 706 #define PHM_WAIT_INDIRECT_REGISTER(hwmgr, port, reg, value, mask)       \
 707         PHM_WAIT_INDIRECT_REGISTER_GIVEN_INDEX(hwmgr, port, ix##reg, value, mask)
 708
 709 #define PHM_WAIT_INDIRECT_REGISTER_UNEQUAL(hwmgr, port, reg, value, mask)       \
 710         PHM_WAIT_INDIRECT_REGISTER_UNEQUAL_GIVEN_INDEX(hwmgr, port, ix##reg, value, mask)
 711
 712 #define PHM_WAIT_VFPF_INDIRECT_REGISTER(hwmgr, port, reg, value, mask)  \
 713         PHM_WAIT_VFPF_INDIRECT_REGISTER_GIVEN_INDEX(hwmgr, port, ix##reg, value, mask)
 714
 715 #define PHM_WAIT_VFPF_INDIRECT_REGISTER_UNEQUAL(hwmgr, port, reg, value, mask)  \
 716         PHM_WAIT_VFPF_INDIRECT_REGISTER_UNEQUAL_GIVEN_INDEX(hwmgr, port, ix##reg, value, mask)
 717
 718 /* Operations on named fields. */
 719
 720 #define PHM_READ_FIELD(device, reg, field)      \
 721         PHM_GET_FIELD(cgs_read_register(device, mm##reg), reg, field)
 722
 723 #define PHM_READ_INDIRECT_FIELD(device, port, reg, field)       \
 724         PHM_GET_FIELD(cgs_read_ind_register(device, port, ix##reg),     \
 725                         reg, field)
 726
 727 #define PHM_READ_VFPF_INDIRECT_FIELD(device, port, reg, field)  \
 728         PHM_GET_FIELD(cgs_read_ind_register(device, port, ix##reg),     \
 729                         reg, field)
 730
 731 #define PHM_WRITE_FIELD(device, reg, field, fieldval)   \
 732         cgs_write_register(device, mm##reg, PHM_SET_FIELD(      \
 733                                 cgs_read_register(device, mm##reg), reg, field, fieldval))
 734
 735 #define PHM_WRITE_INDIRECT_FIELD(device, port, reg, field, fieldval)    \
 736         cgs_write_ind_register(device, port, ix##reg,   \
 737                         PHM_SET_FIELD(cgs_read_ind_register(device, port, ix##reg),     \
 738                                 reg, field, fieldval))
 739
 740 #define PHM_WRITE_VFPF_INDIRECT_FIELD(device, port, reg, field, fieldval)       \
 741         cgs_write_ind_register(device, port, ix##reg,   \
 742                         PHM_SET_FIELD(cgs_read_ind_register(device, port, ix##reg),     \
 743                                 reg, field, fieldval))
 744
 745 #define PHM_WAIT_FIELD(hwmgr, reg, field, fieldval)     \
 746         PHM_WAIT_REGISTER(hwmgr, reg, (fieldval)        \
 747                         << PHM_FIELD_SHIFT(reg, field), PHM_FIELD_MASK(reg, field))
 748
 749 #define PHM_WAIT_INDIRECT_FIELD(hwmgr, port, reg, field, fieldval)      \
 750         PHM_WAIT_INDIRECT_REGISTER(hwmgr, port, reg, (fieldval) \
 751                         << PHM_FIELD_SHIFT(reg, field), PHM_FIELD_MASK(reg, field))
 752
 753 #define PHM_WAIT_VFPF_INDIRECT_FIELD(hwmgr, port, reg, field, fieldval) \
 754         PHM_WAIT_VFPF_INDIRECT_REGISTER(hwmgr, port, reg, (fieldval)    \
 755                         << PHM_FIELD_SHIFT(reg, field), PHM_FIELD_MASK(reg, field))
 756
 757 #define PHM_WAIT_FIELD_UNEQUAL(hwmgr, reg, field, fieldval)     \
 758         PHM_WAIT_REGISTER_UNEQUAL(hwmgr, reg, (fieldval)        \
 759                         << PHM_FIELD_SHIFT(reg, field), PHM_FIELD_MASK(reg, field))
 760
 761 #define PHM_WAIT_INDIRECT_FIELD_UNEQUAL(hwmgr, port, reg, field, fieldval)      \
 762         PHM_WAIT_INDIRECT_REGISTER_UNEQUAL(hwmgr, port, reg, (fieldval) \
 763                         << PHM_FIELD_SHIFT(reg, field), PHM_FIELD_MASK(reg, field))
 764
 765 #define PHM_WAIT_VFPF_INDIRECT_FIELD_UNEQUAL(hwmgr, port, reg, field, fieldval) \
 766         PHM_WAIT_VFPF_INDIRECT_REGISTER_UNEQUAL(hwmgr, port, reg, (fieldval)    \
 767                         << PHM_FIELD_SHIFT(reg, field), PHM_FIELD_MASK(reg, field))
 768
 769 /* Operations on arrays of registers & fields. */
 770
 771 #define PHM_READ_ARRAY_REGISTER(device, reg, offset)    \
 772         cgs_read_register(device, mm##reg + (offset))
 773
 774 #define PHM_WRITE_ARRAY_REGISTER(device, reg, offset, value)    \
 775         cgs_write_register(device, mm##reg + (offset), value)
 776
 777 #define PHM_WAIT_ARRAY_REGISTER(hwmgr, reg, offset, value, mask)        \
 778         PHM_WAIT_REGISTER_GIVEN_INDEX(hwmgr, mm##reg + (offset), value, mask)
 779
 780 #define PHM_WAIT_ARRAY_REGISTER_UNEQUAL(hwmgr, reg, offset, value, mask)        \
 781         PHM_WAIT_REGISTER_UNEQUAL_GIVEN_INDEX(hwmgr, mm##reg + (offset), value, mask)
 782
 783 #define PHM_READ_ARRAY_FIELD(hwmgr, reg, offset, field) \
 784         PHM_GET_FIELD(PHM_READ_ARRAY_REGISTER(hwmgr->device, reg, offset), reg, field)
 785
 786 #define PHM_WRITE_ARRAY_FIELD(hwmgr, reg, offset, field, fieldvalue)    \
 787         PHM_WRITE_ARRAY_REGISTER(hwmgr->device, reg, offset,    \
 788                         PHM_SET_FIELD(PHM_READ_ARRAY_REGISTER(hwmgr->device, reg, offset),      \
 789                                 reg, field, fieldvalue))
 790
 791 #define PHM_WAIT_ARRAY_FIELD(hwmgr, reg, offset, field, fieldvalue)     \
 792         PHM_WAIT_REGISTER_GIVEN_INDEX(hwmgr, mm##reg + (offset),        \
 793                         (fieldvalue) << PHM_FIELD_SHIFT(reg, field),    \
 794                         PHM_FIELD_MASK(reg, field))
 795
 796 #define PHM_WAIT_ARRAY_FIELD_UNEQUAL(hwmgr, reg, offset, field, fieldvalue)     \
 797         PHM_WAIT_REGISTER_UNEQUAL_GIVEN_INDEX(hwmgr, mm##reg + (offset),        \
 798                         (fieldvalue) << PHM_FIELD_SHIFT(reg, field),    \
 799                         PHM_FIELD_MASK(reg, field))
 800
 801 #endif /* _HWMGR_H_ */