drivers/gpu/drm/amd/display/dmub/inc/dmub_cmd.h

   1 /*
   2  * Copyright 2019 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 #ifndef _DMUB_CMD_H_
  27 #define _DMUB_CMD_H_
  28
  29 #if defined(_TEST_HARNESS) || defined(FPGA_USB4)
  30 #include "dmub_fw_types.h"
  31 #include "include_legacy/atomfirmware.h"
  32
  33 #if defined(_TEST_HARNESS)
  34 #include <string.h>
  35 #endif
  36 #else
  37
  38 #include <asm/byteorder.h>
  39 #include <linux/types.h>
  40 #include <linux/string.h>
  41 #include <linux/delay.h>
  42 #include <stdarg.h>
  43
  44 #include "atomfirmware.h"
  45
  46 #endif // defined(_TEST_HARNESS) || defined(FPGA_USB4)
  47
  48 /* Firmware versioning. */
  49 #ifdef DMUB_EXPOSE_VERSION
  50 #define DMUB_FW_VERSION_GIT_HASH 0x931573111
  51 #define DMUB_FW_VERSION_MAJOR 0
  52 #define DMUB_FW_VERSION_MINOR 0
  53 #define DMUB_FW_VERSION_REVISION 45
  54 #define DMUB_FW_VERSION_TEST 0
  55 #define DMUB_FW_VERSION_VBIOS 0
  56 #define DMUB_FW_VERSION_HOTFIX 0
  57 #define DMUB_FW_VERSION_UCODE (((DMUB_FW_VERSION_MAJOR & 0xFF) << 24) | \
  58                 ((DMUB_FW_VERSION_MINOR & 0xFF) << 16) | \
  59                 ((DMUB_FW_VERSION_REVISION & 0xFF) << 8) | \
  60                 ((DMUB_FW_VERSION_TEST & 0x1) << 7) | \
  61                 ((DMUB_FW_VERSION_VBIOS & 0x1) << 6) | \
  62                 (DMUB_FW_VERSION_HOTFIX & 0x3F))
  63
  64 #endif
  65
  66 //<DMUB_TYPES>==================================================================
  67 /* Basic type definitions. */
  68
  69 #define __forceinline inline
  70
  71 #define SET_ABM_PIPE_GRADUALLY_DISABLE           0
  72 #define SET_ABM_PIPE_IMMEDIATELY_DISABLE         255
  73 #define SET_ABM_PIPE_IMMEDIATE_KEEP_GAIN_DISABLE 254
  74 #define SET_ABM_PIPE_NORMAL                      1
  75
  76 /* Maximum number of streams on any ASIC. */
  77 #define DMUB_MAX_STREAMS 6
  78
  79 /* Maximum number of planes on any ASIC. */
  80 #define DMUB_MAX_PLANES 6
  81
  82 #ifndef PHYSICAL_ADDRESS_LOC
  83 #define PHYSICAL_ADDRESS_LOC union large_integer
  84 #endif
  85
  86 #ifndef dmub_memcpy
  87 #define dmub_memcpy(dest, source, bytes) memcpy((dest), (source), (bytes))
  88 #endif
  89
  90 #ifndef dmub_memset
  91 #define dmub_memset(dest, val, bytes) memset((dest), (val), (bytes))
  92 #endif
  93
  94 #if defined(__cplusplus)
  95 extern "C" {
  96 #endif
  97
  98 #ifndef dmub_udelay
  99 #define dmub_udelay(microseconds) udelay(microseconds)
 100 #endif
 101
 102 union dmub_addr {
 103         struct {
 104                 uint32_t low_part;
 105                 uint32_t high_part;
 106         } u;
 107         uint64_t quad_part;
 108 };
 109
 110 union dmub_psr_debug_flags {
 111         struct {
 112                 uint32_t visual_confirm : 1;
 113                 uint32_t use_hw_lock_mgr : 1;
 114                 uint32_t log_line_nums : 1;
 115         } bitfields;
 116
 117         uint32_t u32All;
 118 };
 119
 120 struct dmub_feature_caps {
 121         uint8_t psr;
 122         uint8_t reserved[7];
 123 };
 124
 125 #if defined(__cplusplus)
 126 }
 127 #endif
 128
 129 //==============================================================================
 130 //</DMUB_TYPES>=================================================================
 131 //==============================================================================
 132 //< DMUB_META>==================================================================
 133 //==============================================================================
 134 #pragma pack(push, 1)
 135
 136 /* Magic value for identifying dmub_fw_meta_info */
 137 #define DMUB_FW_META_MAGIC 0x444D5542
 138
 139 /* Offset from the end of the file to the dmub_fw_meta_info */
 140 #define DMUB_FW_META_OFFSET 0x24
 141
 142 /**
 143  * struct dmub_fw_meta_info - metadata associated with fw binary
 144  *
 145  * NOTE: This should be considered a stable API. Fields should
 146  *       not be repurposed or reordered. New fields should be
 147  *       added instead to extend the structure.
 148  *
 149  * @magic_value: magic value identifying DMUB firmware meta info
 150  * @fw_region_size: size of the firmware state region
 151  * @trace_buffer_size: size of the tracebuffer region
 152  * @fw_version: the firmware version information
 153  * @dal_fw: 1 if the firmware is DAL
 154  */
 155 struct dmub_fw_meta_info {
 156         uint32_t magic_value;
 157         uint32_t fw_region_size;
 158         uint32_t trace_buffer_size;
 159         uint32_t fw_version;
 160         uint8_t dal_fw;
 161         uint8_t reserved[3];
 162 };
 163
 164 /* Ensure that the structure remains 64 bytes. */
 165 union dmub_fw_meta {
 166         struct dmub_fw_meta_info info;
 167         uint8_t reserved[64];
 168 };
 169
 170 #pragma pack(pop)
 171
 172 //==============================================================================
 173 //< DMUB_STATUS>================================================================
 174 //==============================================================================
 175
 176 /**
 177  * DMCUB scratch registers can be used to determine firmware status.
 178  * Current scratch register usage is as follows:
 179  *
 180  * SCRATCH0: FW Boot Status register
 181  * SCRATCH15: FW Boot Options register
 182  */
 183
 184 /* Register bit definition for SCRATCH0 */
 185 union dmub_fw_boot_status {
 186         struct {
 187                 uint32_t dal_fw : 1;
 188                 uint32_t mailbox_rdy : 1;
 189                 uint32_t optimized_init_done : 1;
 190                 uint32_t restore_required : 1;
 191         } bits;
 192         uint32_t all;
 193 };
 194
 195 enum dmub_fw_boot_status_bit {
 196         DMUB_FW_BOOT_STATUS_BIT_DAL_FIRMWARE = (1 << 0),
 197         DMUB_FW_BOOT_STATUS_BIT_MAILBOX_READY = (1 << 1),
 198         DMUB_FW_BOOT_STATUS_BIT_OPTIMIZED_INIT_DONE = (1 << 2),
 199         DMUB_FW_BOOT_STATUS_BIT_RESTORE_REQUIRED = (1 << 3),
 200 };
 201
 202 /* Register bit definition for SCRATCH15 */
 203 union dmub_fw_boot_options {
 204         struct {
 205                 uint32_t pemu_env : 1;
 206                 uint32_t fpga_env : 1;
 207                 uint32_t optimized_init : 1;
 208                 uint32_t skip_phy_access : 1;
 209                 uint32_t disable_clk_gate: 1;
 210                 uint32_t skip_phy_init_panel_sequence: 1;
 211                 uint32_t reserved : 26;
 212         } bits;
 213         uint32_t all;
 214 };
 215
 216 enum dmub_fw_boot_options_bit {
 217         DMUB_FW_BOOT_OPTION_BIT_PEMU_ENV = (1 << 0),
 218         DMUB_FW_BOOT_OPTION_BIT_FPGA_ENV = (1 << 1),
 219         DMUB_FW_BOOT_OPTION_BIT_OPTIMIZED_INIT_DONE = (1 << 2),
 220 };
 221
 222 //==============================================================================
 223 //</DMUB_STATUS>================================================================
 224 //==============================================================================
 225 //< DMUB_VBIOS>=================================================================
 226 //==============================================================================
 227
 228 /*
 229  * Command IDs should be treated as stable ABI.
 230  * Do not reuse or modify IDs.
 231  */
 232
 233 enum dmub_cmd_vbios_type {
 234         DMUB_CMD__VBIOS_DIGX_ENCODER_CONTROL = 0,
 235         DMUB_CMD__VBIOS_DIG1_TRANSMITTER_CONTROL = 1,
 236         DMUB_CMD__VBIOS_SET_PIXEL_CLOCK = 2,
 237         DMUB_CMD__VBIOS_ENABLE_DISP_POWER_GATING = 3,
 238         DMUB_CMD__VBIOS_LVTMA_CONTROL = 15,
 239 };
 240
 241 //==============================================================================
 242 //</DMUB_VBIOS>=================================================================
 243 //==============================================================================
 244 //< DMUB_GPINT>=================================================================
 245 //==============================================================================
 246
 247 /**
 248  * The shifts and masks below may alternatively be used to format and read
 249  * the command register bits.
 250  */
 251
 252 #define DMUB_GPINT_DATA_PARAM_MASK 0xFFFF
 253 #define DMUB_GPINT_DATA_PARAM_SHIFT 0
 254
 255 #define DMUB_GPINT_DATA_COMMAND_CODE_MASK 0xFFF
 256 #define DMUB_GPINT_DATA_COMMAND_CODE_SHIFT 16
 257
 258 #define DMUB_GPINT_DATA_STATUS_MASK 0xF
 259 #define DMUB_GPINT_DATA_STATUS_SHIFT 28
 260
 261 /**
 262  * Command responses.
 263  */
 264
 265 #define DMUB_GPINT__STOP_FW_RESPONSE 0xDEADDEAD
 266
 267 /**
 268  * The register format for sending a command via the GPINT.
 269  */
 270 union dmub_gpint_data_register {
 271         struct {
 272                 uint32_t param : 16;
 273                 uint32_t command_code : 12;
 274                 uint32_t status : 4;
 275         } bits;
 276         uint32_t all;
 277 };
 278
 279 /*
 280  * Command IDs should be treated as stable ABI.
 281  * Do not reuse or modify IDs.
 282  */
 283
 284 enum dmub_gpint_command {
 285         DMUB_GPINT__INVALID_COMMAND = 0,
 286         DMUB_GPINT__GET_FW_VERSION = 1,
 287         DMUB_GPINT__STOP_FW = 2,
 288         DMUB_GPINT__GET_PSR_STATE = 7,
 289         /**
 290          * DESC: Notifies DMCUB of the currently active streams.
 291          * ARGS: Stream mask, 1 bit per active stream index.
 292          */
 293         DMUB_GPINT__IDLE_OPT_NOTIFY_STREAM_MASK = 8,
 294         DMUB_GPINT__PSR_RESIDENCY = 9,
 295 };
 296
 297 //==============================================================================
 298 //</DMUB_GPINT>=================================================================
 299 //==============================================================================
 300 //< DMUB_CMD>===================================================================
 301 //==============================================================================
 302
 303 #define DMUB_RB_CMD_SIZE 64
 304 #define DMUB_RB_MAX_ENTRY 128
 305 #define DMUB_RB_SIZE (DMUB_RB_CMD_SIZE * DMUB_RB_MAX_ENTRY)
 306 #define REG_SET_MASK 0xFFFF
 307
 308 /*
 309  * Command IDs should be treated as stable ABI.
 310  * Do not reuse or modify IDs.
 311  */
 312
 313 enum dmub_cmd_type {
 314         DMUB_CMD__NULL = 0,
 315         DMUB_CMD__REG_SEQ_READ_MODIFY_WRITE = 1,
 316         DMUB_CMD__REG_SEQ_FIELD_UPDATE_SEQ = 2,
 317         DMUB_CMD__REG_SEQ_BURST_WRITE = 3,
 318         DMUB_CMD__REG_REG_WAIT = 4,
 319         DMUB_CMD__PLAT_54186_WA = 5,
 320         DMUB_CMD__QUERY_FEATURE_CAPS = 6,
 321         DMUB_CMD__PSR = 64,
 322         DMUB_CMD__MALL = 65,
 323         DMUB_CMD__ABM = 66,
 324         DMUB_CMD__HW_LOCK = 69,
 325         DMUB_CMD__DP_AUX_ACCESS = 70,
 326         DMUB_CMD__OUTBOX1_ENABLE = 71,
 327         DMUB_CMD__VBIOS = 128,
 328 };
 329
 330 enum dmub_out_cmd_type {
 331         DMUB_OUT_CMD__NULL = 0,
 332         DMUB_OUT_CMD__DP_AUX_REPLY = 1,
 333         DMUB_OUT_CMD__DP_HPD_NOTIFY = 2,
 334 };
 335
 336 #pragma pack(push, 1)
 337
 338 struct dmub_cmd_header {
 339         unsigned int type : 8;
 340         unsigned int sub_type : 8;
 341         unsigned int ret_status : 1;
 342         unsigned int reserved0 : 7;
 343         unsigned int payload_bytes : 6;  /* up to 60 bytes */
 344         unsigned int reserved1 : 2;
 345 };
 346
 347 /*
 348  * Read modify write
 349  *
 350  * 60 payload bytes can hold up to 5 sets of read modify writes,
 351  * each take 3 dwords.
 352  *
 353  * number of sequences = header.payload_bytes / sizeof(struct dmub_cmd_read_modify_write_sequence)
 354  *
 355  * modify_mask = 0xffff'ffff means all fields are going to be updated.  in this case
 356  * command parser will skip the read and we can use modify_mask = 0xffff'ffff as reg write
 357  */
 358 struct dmub_cmd_read_modify_write_sequence {
 359         uint32_t addr;
 360         uint32_t modify_mask;
 361         uint32_t modify_value;
 362 };
 363
 364 #define DMUB_READ_MODIFY_WRITE_SEQ__MAX         5
 365 struct dmub_rb_cmd_read_modify_write {
 366         struct dmub_cmd_header header;  // type = DMUB_CMD__REG_SEQ_READ_MODIFY_WRITE
 367         struct dmub_cmd_read_modify_write_sequence seq[DMUB_READ_MODIFY_WRITE_SEQ__MAX];
 368 };
 369
 370 /*
 371  * Update a register with specified masks and values sequeunce
 372  *
 373  * 60 payload bytes can hold address + up to 7 sets of mask/value combo, each take 2 dword
 374  *
 375  * number of field update sequence = (header.payload_bytes - sizeof(addr)) / sizeof(struct read_modify_write_sequence)
 376  *
 377  *
 378  * USE CASE:
 379  *   1. auto-increment register where additional read would update pointer and produce wrong result
 380  *   2. toggle a bit without read in the middle
 381  */
 382
 383 struct dmub_cmd_reg_field_update_sequence {
 384         uint32_t modify_mask;  // 0xffff'ffff to skip initial read
 385         uint32_t modify_value;
 386 };
 387
 388 #define DMUB_REG_FIELD_UPDATE_SEQ__MAX          7
 389 struct dmub_rb_cmd_reg_field_update_sequence {
 390         struct dmub_cmd_header header;
 391         uint32_t addr;
 392         struct dmub_cmd_reg_field_update_sequence seq[DMUB_REG_FIELD_UPDATE_SEQ__MAX];
 393 };
 394
 395 /*
 396  * Burst write
 397  *
 398  * support use case such as writing out LUTs.
 399  *
 400  * 60 payload bytes can hold up to 14 values to write to given address
 401  *
 402  * number of payload = header.payload_bytes / sizeof(struct read_modify_write_sequence)
 403  */
 404 #define DMUB_BURST_WRITE_VALUES__MAX  14
 405 struct dmub_rb_cmd_burst_write {
 406         struct dmub_cmd_header header;  // type = DMUB_CMD__REG_SEQ_BURST_WRITE
 407         uint32_t addr;
 408         uint32_t write_values[DMUB_BURST_WRITE_VALUES__MAX];
 409 };
 410
 411
 412 struct dmub_rb_cmd_common {
 413         struct dmub_cmd_header header;
 414         uint8_t cmd_buffer[DMUB_RB_CMD_SIZE - sizeof(struct dmub_cmd_header)];
 415 };
 416
 417 struct dmub_cmd_reg_wait_data {
 418         uint32_t addr;
 419         uint32_t mask;
 420         uint32_t condition_field_value;
 421         uint32_t time_out_us;
 422 };
 423
 424 struct dmub_rb_cmd_reg_wait {
 425         struct dmub_cmd_header header;
 426         struct dmub_cmd_reg_wait_data reg_wait;
 427 };
 428
 429 struct dmub_cmd_PLAT_54186_wa {
 430         uint32_t DCSURF_SURFACE_CONTROL;
 431         uint32_t DCSURF_PRIMARY_SURFACE_ADDRESS_HIGH;
 432         uint32_t DCSURF_PRIMARY_SURFACE_ADDRESS;
 433         uint32_t DCSURF_PRIMARY_SURFACE_ADDRESS_HIGH_C;
 434         uint32_t DCSURF_PRIMARY_SURFACE_ADDRESS_C;
 435         struct {
 436                 uint8_t hubp_inst : 4;
 437                 uint8_t tmz_surface : 1;
 438                 uint8_t immediate :1;
 439                 uint8_t vmid : 4;
 440                 uint8_t grph_stereo : 1;
 441                 uint32_t reserved : 21;
 442         } flip_params;
 443         uint32_t reserved[9];
 444 };
 445
 446 struct dmub_rb_cmd_PLAT_54186_wa {
 447         struct dmub_cmd_header header;
 448         struct dmub_cmd_PLAT_54186_wa flip;
 449 };
 450
 451 struct dmub_rb_cmd_mall {
 452         struct dmub_cmd_header header;
 453         union dmub_addr cursor_copy_src;
 454         union dmub_addr cursor_copy_dst;
 455         uint32_t tmr_delay;
 456         uint32_t tmr_scale;
 457         uint16_t cursor_width;
 458         uint16_t cursor_pitch;
 459         uint16_t cursor_height;
 460         uint8_t cursor_bpp;
 461 };
 462
 463 struct dmub_cmd_digx_encoder_control_data {
 464         union dig_encoder_control_parameters_v1_5 dig;
 465 };
 466
 467 struct dmub_rb_cmd_digx_encoder_control {
 468         struct dmub_cmd_header header;
 469         struct dmub_cmd_digx_encoder_control_data encoder_control;
 470 };
 471
 472 struct dmub_cmd_set_pixel_clock_data {
 473         struct set_pixel_clock_parameter_v1_7 clk;
 474 };
 475
 476 struct dmub_rb_cmd_set_pixel_clock {
 477         struct dmub_cmd_header header;
 478         struct dmub_cmd_set_pixel_clock_data pixel_clock;
 479 };
 480
 481 struct dmub_cmd_enable_disp_power_gating_data {
 482         struct enable_disp_power_gating_parameters_v2_1 pwr;
 483 };
 484
 485 struct dmub_rb_cmd_enable_disp_power_gating {
 486         struct dmub_cmd_header header;
 487         struct dmub_cmd_enable_disp_power_gating_data power_gating;
 488 };
 489
 490 struct dmub_cmd_dig1_transmitter_control_data {
 491         struct dig_transmitter_control_parameters_v1_6 dig;
 492 };
 493
 494 struct dmub_rb_cmd_dig1_transmitter_control {
 495         struct dmub_cmd_header header;
 496         struct dmub_cmd_dig1_transmitter_control_data transmitter_control;
 497 };
 498
 499 struct dmub_rb_cmd_dpphy_init {
 500         struct dmub_cmd_header header;
 501         uint8_t reserved[60];
 502 };
 503
 504 enum dp_aux_request_action {
 505         DP_AUX_REQ_ACTION_I2C_WRITE             = 0x00,
 506         DP_AUX_REQ_ACTION_I2C_READ              = 0x10,
 507         DP_AUX_REQ_ACTION_I2C_STATUS_REQ        = 0x20,
 508         DP_AUX_REQ_ACTION_I2C_WRITE_MOT         = 0x40,
 509         DP_AUX_REQ_ACTION_I2C_READ_MOT          = 0x50,
 510         DP_AUX_REQ_ACTION_I2C_STATUS_REQ_MOT    = 0x60,
 511         DP_AUX_REQ_ACTION_DPCD_WRITE            = 0x80,
 512         DP_AUX_REQ_ACTION_DPCD_READ             = 0x90
 513 };
 514
 515 enum aux_return_code_type {
 516         AUX_RET_SUCCESS = 0,
 517         AUX_RET_ERROR_TIMEOUT,
 518         AUX_RET_ERROR_NO_DATA,
 519         AUX_RET_ERROR_INVALID_OPERATION,
 520         AUX_RET_ERROR_PROTOCOL_ERROR,
 521 };
 522
 523 /* DP AUX command */
 524 struct aux_transaction_parameters {
 525         uint8_t is_i2c_over_aux;
 526         uint8_t action;
 527         uint8_t length;
 528         uint8_t pad;
 529         uint32_t address;
 530         uint8_t data[16];
 531 };
 532
 533 struct dmub_cmd_dp_aux_control_data {
 534         uint32_t handle;
 535         uint8_t port_index;
 536         uint8_t sw_crc_enabled;
 537         uint16_t timeout;
 538         struct aux_transaction_parameters dpaux;
 539 };
 540
 541 struct dmub_rb_cmd_dp_aux_access {
 542         struct dmub_cmd_header header;
 543         struct dmub_cmd_dp_aux_control_data aux_control;
 544 };
 545
 546 struct dmub_rb_cmd_outbox1_enable {
 547         struct dmub_cmd_header header;
 548         uint32_t enable;
 549 };
 550
 551 /* DP AUX Reply command - OutBox Cmd */
 552 struct aux_reply_data {
 553         uint8_t command;
 554         uint8_t length;
 555         uint8_t pad[2];
 556         uint8_t data[16];
 557 };
 558
 559 struct aux_reply_control_data {
 560         uint32_t handle;
 561         uint8_t phy_port_index;
 562         uint8_t result;
 563         uint16_t pad;
 564 };
 565
 566 struct dmub_rb_cmd_dp_aux_reply {
 567         struct dmub_cmd_header header;
 568         struct aux_reply_control_data control;
 569         struct aux_reply_data reply_data;
 570 };
 571
 572 /* DP HPD Notify command - OutBox Cmd */
 573 enum dp_hpd_type {
 574         DP_HPD = 0,
 575         DP_IRQ
 576 };
 577
 578 enum dp_hpd_status {
 579         DP_HPD_UNPLUG = 0,
 580         DP_HPD_PLUG
 581 };
 582
 583 struct dp_hpd_data {
 584         uint8_t phy_port_index;
 585         uint8_t hpd_type;
 586         uint8_t hpd_status;
 587         uint8_t pad;
 588 };
 589
 590 struct dmub_rb_cmd_dp_hpd_notify {
 591         struct dmub_cmd_header header;
 592         struct dp_hpd_data hpd_data;
 593 };
 594
 595 /*
 596  * Command IDs should be treated as stable ABI.
 597  * Do not reuse or modify IDs.
 598  */
 599
 600 enum dmub_cmd_psr_type {
 601         DMUB_CMD__PSR_SET_VERSION               = 0,
 602         DMUB_CMD__PSR_COPY_SETTINGS             = 1,
 603         DMUB_CMD__PSR_ENABLE                    = 2,
 604         DMUB_CMD__PSR_DISABLE                   = 3,
 605         DMUB_CMD__PSR_SET_LEVEL                 = 4,
 606         DMUB_CMD__PSR_FORCE_STATIC              = 5,
 607 };
 608
 609 enum psr_version {
 610         PSR_VERSION_1                           = 0,
 611         PSR_VERSION_UNSUPPORTED                 = 0xFFFFFFFF,
 612 };
 613
 614 enum dmub_cmd_mall_type {
 615         DMUB_CMD__MALL_ACTION_ALLOW = 0,
 616         DMUB_CMD__MALL_ACTION_DISALLOW = 1,
 617         DMUB_CMD__MALL_ACTION_COPY_CURSOR = 2,
 618 };
 619
 620 struct dmub_cmd_psr_copy_settings_data {
 621         union dmub_psr_debug_flags debug;
 622         uint16_t psr_level;
 623         uint8_t dpp_inst;
 624         /* opp_inst and mpcc_inst will not be used in dmub fw,
 625          * dmub fw will get active opp by reading odm registers.
 626          */
 627         uint8_t mpcc_inst;
 628         uint8_t opp_inst;
 629
 630         uint8_t otg_inst;
 631         uint8_t digfe_inst;
 632         uint8_t digbe_inst;
 633         uint8_t dpphy_inst;
 634         uint8_t aux_inst;
 635         uint8_t smu_optimizations_en;
 636         uint8_t frame_delay;
 637         uint8_t frame_cap_ind;
 638         uint8_t pad[2];
 639         uint8_t multi_disp_optimizations_en;
 640         uint16_t init_sdp_deadline;
 641         uint16_t pad2;
 642 };
 643
 644 struct dmub_rb_cmd_psr_copy_settings {
 645         struct dmub_cmd_header header;
 646         struct dmub_cmd_psr_copy_settings_data psr_copy_settings_data;
 647 };
 648
 649 struct dmub_cmd_psr_set_level_data {
 650         uint16_t psr_level;
 651         uint8_t pad[2];
 652 };
 653
 654 struct dmub_rb_cmd_psr_set_level {
 655         struct dmub_cmd_header header;
 656         struct dmub_cmd_psr_set_level_data psr_set_level_data;
 657 };
 658
 659 struct dmub_rb_cmd_psr_enable {
 660         struct dmub_cmd_header header;
 661 };
 662
 663 struct dmub_cmd_psr_set_version_data {
 664         enum psr_version version; // PSR version 1 or 2
 665 };
 666
 667 struct dmub_rb_cmd_psr_set_version {
 668         struct dmub_cmd_header header;
 669         struct dmub_cmd_psr_set_version_data psr_set_version_data;
 670 };
 671
 672 struct dmub_rb_cmd_psr_force_static {
 673         struct dmub_cmd_header header;
 674 };
 675
 676 union dmub_hw_lock_flags {
 677         struct {
 678                 uint8_t lock_pipe   : 1;
 679                 uint8_t lock_cursor : 1;
 680                 uint8_t lock_dig    : 1;
 681                 uint8_t triple_buffer_lock : 1;
 682         } bits;
 683
 684         uint8_t u8All;
 685 };
 686
 687 struct dmub_hw_lock_inst_flags {
 688         uint8_t otg_inst;
 689         uint8_t opp_inst;
 690         uint8_t dig_inst;
 691         uint8_t pad;
 692 };
 693
 694 enum hw_lock_client {
 695         HW_LOCK_CLIENT_DRIVER = 0,
 696         HW_LOCK_CLIENT_FW,
 697         HW_LOCK_CLIENT_INVALID = 0xFFFFFFFF,
 698 };
 699
 700 struct dmub_cmd_lock_hw_data {
 701         enum hw_lock_client client;
 702         struct dmub_hw_lock_inst_flags inst_flags;
 703         union dmub_hw_lock_flags hw_locks;
 704         uint8_t lock;
 705         uint8_t should_release;
 706         uint8_t pad;
 707 };
 708
 709 struct dmub_rb_cmd_lock_hw {
 710         struct dmub_cmd_header header;
 711         struct dmub_cmd_lock_hw_data lock_hw_data;
 712 };
 713
 714 enum dmub_cmd_abm_type {
 715         DMUB_CMD__ABM_INIT_CONFIG       = 0,
 716         DMUB_CMD__ABM_SET_PIPE          = 1,
 717         DMUB_CMD__ABM_SET_BACKLIGHT     = 2,
 718         DMUB_CMD__ABM_SET_LEVEL         = 3,
 719         DMUB_CMD__ABM_SET_AMBIENT_LEVEL = 4,
 720         DMUB_CMD__ABM_SET_PWM_FRAC      = 5,
 721 };
 722
 723 #define NUM_AMBI_LEVEL                  5
 724 #define NUM_AGGR_LEVEL                  4
 725 #define NUM_POWER_FN_SEGS               8
 726 #define NUM_BL_CURVE_SEGS               16
 727
 728 /*
 729  * Parameters for ABM2.4 algorithm.
 730  * Padded explicitly to 32-bit boundary.
 731  */
 732 struct abm_config_table {
 733         /* Parameters for crgb conversion */
 734         uint16_t crgb_thresh[NUM_POWER_FN_SEGS];                 // 0B
 735         uint16_t crgb_offset[NUM_POWER_FN_SEGS];                 // 15B
 736         uint16_t crgb_slope[NUM_POWER_FN_SEGS];                  // 31B
 737
 738         /* Parameters for custom curve */
 739         uint16_t backlight_thresholds[NUM_BL_CURVE_SEGS];        // 47B
 740         uint16_t backlight_offsets[NUM_BL_CURVE_SEGS];           // 79B
 741
 742         uint16_t ambient_thresholds_lux[NUM_AMBI_LEVEL];         // 111B
 743         uint16_t min_abm_backlight;                              // 121B
 744
 745         uint8_t min_reduction[NUM_AMBI_LEVEL][NUM_AGGR_LEVEL];   // 123B
 746         uint8_t max_reduction[NUM_AMBI_LEVEL][NUM_AGGR_LEVEL];   // 143B
 747         uint8_t bright_pos_gain[NUM_AMBI_LEVEL][NUM_AGGR_LEVEL]; // 163B
 748         uint8_t dark_pos_gain[NUM_AMBI_LEVEL][NUM_AGGR_LEVEL];   // 183B
 749         uint8_t hybrid_factor[NUM_AGGR_LEVEL];                   // 203B
 750         uint8_t contrast_factor[NUM_AGGR_LEVEL];                 // 207B
 751         uint8_t deviation_gain[NUM_AGGR_LEVEL];                  // 211B
 752         uint8_t min_knee[NUM_AGGR_LEVEL];                        // 215B
 753         uint8_t max_knee[NUM_AGGR_LEVEL];                        // 219B
 754         uint8_t iir_curve[NUM_AMBI_LEVEL];                       // 223B
 755         uint8_t pad3[3];                                         // 228B
 756 };
 757
 758 struct dmub_cmd_abm_set_pipe_data {
 759         uint8_t otg_inst;
 760         uint8_t panel_inst;
 761         uint8_t set_pipe_option;
 762         uint8_t ramping_boundary; // TODO: Remove this
 763 };
 764
 765 struct dmub_rb_cmd_abm_set_pipe {
 766         struct dmub_cmd_header header;
 767         struct dmub_cmd_abm_set_pipe_data abm_set_pipe_data;
 768 };
 769
 770 struct dmub_cmd_abm_set_backlight_data {
 771         uint32_t frame_ramp;
 772         uint32_t backlight_user_level;
 773 };
 774
 775 struct dmub_rb_cmd_abm_set_backlight {
 776         struct dmub_cmd_header header;
 777         struct dmub_cmd_abm_set_backlight_data abm_set_backlight_data;
 778 };
 779
 780 struct dmub_cmd_abm_set_level_data {
 781         uint32_t level;
 782 };
 783
 784 struct dmub_rb_cmd_abm_set_level {
 785         struct dmub_cmd_header header;
 786         struct dmub_cmd_abm_set_level_data abm_set_level_data;
 787 };
 788
 789 struct dmub_cmd_abm_set_ambient_level_data {
 790         uint32_t ambient_lux;
 791 };
 792
 793 struct dmub_rb_cmd_abm_set_ambient_level {
 794         struct dmub_cmd_header header;
 795         struct dmub_cmd_abm_set_ambient_level_data abm_set_ambient_level_data;
 796 };
 797
 798 struct dmub_cmd_abm_set_pwm_frac_data {
 799         uint32_t fractional_pwm;
 800 };
 801
 802 struct dmub_rb_cmd_abm_set_pwm_frac {
 803         struct dmub_cmd_header header;
 804         struct dmub_cmd_abm_set_pwm_frac_data abm_set_pwm_frac_data;
 805 };
 806
 807 struct dmub_cmd_abm_init_config_data {
 808         union dmub_addr src;
 809         uint16_t bytes;
 810 };
 811
 812 struct dmub_rb_cmd_abm_init_config {
 813         struct dmub_cmd_header header;
 814         struct dmub_cmd_abm_init_config_data abm_init_config_data;
 815 };
 816
 817 struct dmub_cmd_query_feature_caps_data {
 818          struct dmub_feature_caps feature_caps;
 819 };
 820
 821 struct dmub_rb_cmd_query_feature_caps {
 822          struct dmub_cmd_header header;
 823          struct dmub_cmd_query_feature_caps_data query_feature_caps_data;
 824 };
 825
 826  union dmub_rb_cmd {
 827         struct dmub_rb_cmd_lock_hw lock_hw;
 828         struct dmub_rb_cmd_read_modify_write read_modify_write;
 829         struct dmub_rb_cmd_reg_field_update_sequence reg_field_update_seq;
 830         struct dmub_rb_cmd_burst_write burst_write;
 831         struct dmub_rb_cmd_reg_wait reg_wait;
 832         struct dmub_rb_cmd_common cmd_common;
 833         struct dmub_rb_cmd_digx_encoder_control digx_encoder_control;
 834         struct dmub_rb_cmd_set_pixel_clock set_pixel_clock;
 835         struct dmub_rb_cmd_enable_disp_power_gating enable_disp_power_gating;
 836         struct dmub_rb_cmd_dpphy_init dpphy_init;
 837         struct dmub_rb_cmd_dig1_transmitter_control dig1_transmitter_control;
 838         struct dmub_rb_cmd_psr_set_version psr_set_version;
 839         struct dmub_rb_cmd_psr_copy_settings psr_copy_settings;
 840         struct dmub_rb_cmd_psr_enable psr_enable;
 841         struct dmub_rb_cmd_psr_set_level psr_set_level;
 842         struct dmub_rb_cmd_psr_force_static psr_force_static;
 843         struct dmub_rb_cmd_PLAT_54186_wa PLAT_54186_wa;
 844         struct dmub_rb_cmd_mall mall;
 845         struct dmub_rb_cmd_abm_set_pipe abm_set_pipe;
 846         struct dmub_rb_cmd_abm_set_backlight abm_set_backlight;
 847         struct dmub_rb_cmd_abm_set_level abm_set_level;
 848         struct dmub_rb_cmd_abm_set_ambient_level abm_set_ambient_level;
 849         struct dmub_rb_cmd_abm_set_pwm_frac abm_set_pwm_frac;
 850         struct dmub_rb_cmd_abm_init_config abm_init_config;
 851         struct dmub_rb_cmd_dp_aux_access dp_aux_access;
 852         struct dmub_rb_cmd_outbox1_enable outbox1_enable;
 853         struct dmub_rb_cmd_query_feature_caps query_feature_caps;
 854 };
 855
 856 union dmub_rb_out_cmd {
 857         struct dmub_rb_cmd_common cmd_common;
 858         struct dmub_rb_cmd_dp_aux_reply dp_aux_reply;
 859         struct dmub_rb_cmd_dp_hpd_notify dp_hpd_notify;
 860 };
 861 #pragma pack(pop)
 862
 863
 864 //==============================================================================
 865 //</DMUB_CMD>===================================================================
 866 //==============================================================================
 867 //< DMUB_RB>====================================================================
 868 //==============================================================================
 869
 870 #if defined(__cplusplus)
 871 extern "C" {
 872 #endif
 873
 874 struct dmub_rb_init_params {
 875         void *ctx;
 876         void *base_address;
 877         uint32_t capacity;
 878         uint32_t read_ptr;
 879         uint32_t write_ptr;
 880 };
 881
 882 struct dmub_rb {
 883         void *base_address;
 884         uint32_t data_count;
 885         uint32_t rptr;
 886         uint32_t wrpt;
 887         uint32_t capacity;
 888
 889         void *ctx;
 890         void *dmub;
 891 };
 892
 893
 894 static inline bool dmub_rb_empty(struct dmub_rb *rb)
 895 {
 896         return (rb->wrpt == rb->rptr);
 897 }
 898
 899 static inline bool dmub_rb_full(struct dmub_rb *rb)
 900 {
 901         uint32_t data_count;
 902
 903         if (rb->wrpt >= rb->rptr)
 904                 data_count = rb->wrpt - rb->rptr;
 905         else
 906                 data_count = rb->capacity - (rb->rptr - rb->wrpt);
 907
 908         return (data_count == (rb->capacity - DMUB_RB_CMD_SIZE));
 909 }
 910
 911 static inline bool dmub_rb_push_front(struct dmub_rb *rb,
 912                                       const union dmub_rb_cmd *cmd)
 913 {
 914         uint64_t volatile *dst = (uint64_t volatile *)(rb->base_address) + rb->wrpt / sizeof(uint64_t);
 915         const uint64_t *src = (const uint64_t *)cmd;
 916         uint8_t i;
 917
 918         if (dmub_rb_full(rb))
 919                 return false;
 920
 921         // copying data
 922         for (i = 0; i < DMUB_RB_CMD_SIZE / sizeof(uint64_t); i++)
 923                 *dst++ = *src++;
 924
 925         rb->wrpt += DMUB_RB_CMD_SIZE;
 926
 927         if (rb->wrpt >= rb->capacity)
 928                 rb->wrpt %= rb->capacity;
 929
 930         return true;
 931 }
 932
 933 static inline bool dmub_rb_out_push_front(struct dmub_rb *rb,
 934                                       const union dmub_rb_out_cmd *cmd)
 935 {
 936         uint8_t *dst = (uint8_t *)(rb->base_address) + rb->wrpt;
 937         const uint8_t *src = (uint8_t *)cmd;
 938
 939         if (dmub_rb_full(rb))
 940                 return false;
 941
 942         dmub_memcpy(dst, src, DMUB_RB_CMD_SIZE);
 943
 944         rb->wrpt += DMUB_RB_CMD_SIZE;
 945
 946         if (rb->wrpt >= rb->capacity)
 947                 rb->wrpt %= rb->capacity;
 948
 949         return true;
 950 }
 951
 952 static inline bool dmub_rb_front(struct dmub_rb *rb,
 953                                  union dmub_rb_cmd  **cmd)
 954 {
 955         uint8_t *rb_cmd = (uint8_t *)(rb->base_address) + rb->rptr;
 956
 957         if (dmub_rb_empty(rb))
 958                 return false;
 959
 960         *cmd = (union dmub_rb_cmd *)rb_cmd;
 961
 962         return true;
 963 }
 964
 965 static inline bool dmub_rb_out_front(struct dmub_rb *rb,
 966                                  union dmub_rb_out_cmd  *cmd)
 967 {
 968         const uint64_t volatile *src = (const uint64_t volatile *)(rb->base_address) + rb->rptr / sizeof(uint64_t);
 969         uint64_t *dst = (uint64_t *)cmd;
 970         uint8_t i;
 971
 972         if (dmub_rb_empty(rb))
 973                 return false;
 974
 975         // copying data
 976         for (i = 0; i < DMUB_RB_CMD_SIZE / sizeof(uint64_t); i++)
 977                 *dst++ = *src++;
 978
 979         return true;
 980 }
 981
 982 static inline bool dmub_rb_pop_front(struct dmub_rb *rb)
 983 {
 984         if (dmub_rb_empty(rb))
 985                 return false;
 986
 987         rb->rptr += DMUB_RB_CMD_SIZE;
 988
 989         if (rb->rptr >= rb->capacity)
 990                 rb->rptr %= rb->capacity;
 991
 992         return true;
 993 }
 994
 995 static inline void dmub_rb_flush_pending(const struct dmub_rb *rb)
 996 {
 997         uint32_t rptr = rb->rptr;
 998         uint32_t wptr = rb->wrpt;
 999
1000         while (rptr != wptr) {
1001                 uint64_t volatile *data = (uint64_t volatile *)rb->base_address + rptr / sizeof(uint64_t);
1002                 uint8_t i;
1003
1004                 for (i = 0; i < DMUB_RB_CMD_SIZE / sizeof(uint64_t); i++)
1005                         *data++;
1006
1007                 rptr += DMUB_RB_CMD_SIZE;
1008                 if (rptr >= rb->capacity)
1009                         rptr %= rb->capacity;
1010         }
1011 }
1012
1013 static inline void dmub_rb_init(struct dmub_rb *rb,
1014                                 struct dmub_rb_init_params *init_params)
1015 {
1016         rb->base_address = init_params->base_address;
1017         rb->capacity = init_params->capacity;
1018         rb->rptr = init_params->read_ptr;
1019         rb->wrpt = init_params->write_ptr;
1020 }
1021
1022 static inline void dmub_rb_get_return_data(struct dmub_rb *rb,
1023                                            union dmub_rb_cmd *cmd)
1024 {
1025         // Copy rb entry back into command
1026         uint8_t *rd_ptr = (rb->rptr == 0) ?
1027                 (uint8_t *)rb->base_address + rb->capacity - DMUB_RB_CMD_SIZE :
1028                 (uint8_t *)rb->base_address + rb->rptr - DMUB_RB_CMD_SIZE;
1029
1030         dmub_memcpy(cmd, rd_ptr, DMUB_RB_CMD_SIZE);
1031 }
1032
1033 #if defined(__cplusplus)
1034 }
1035 #endif
1036
1037 //==============================================================================
1038 //</DMUB_RB>====================================================================
1039 //==============================================================================
1040
1041 #endif /* _DMUB_CMD_H_ */