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_SRV_H_ 27 #define _DMUB_SRV_H_ 28 29 /** 30 * DOC: DMUB interface and operation 31 * 32 * DMUB is the interface to the display DMCUB microcontroller on DCN hardware. 33 * It delegates hardware initialization and command submission to the 34 * microcontroller. DMUB is the shortname for DMCUB. 35 * 36 * This interface is not thread-safe. Ensure that all access to the interface 37 * is properly synchronized by the caller. 38 * 39 * Initialization and usage of the DMUB service should be done in the 40 * steps given below: 41 * 42 * 1. dmub_srv_create() 43 * 2. dmub_srv_has_hw_support() 44 * 3. dmub_srv_calc_region_info() 45 * 4. dmub_srv_hw_init() 46 * 47 * The call to dmub_srv_create() is required to use the server. 48 * 49 * The calls to dmub_srv_has_hw_support() and dmub_srv_calc_region_info() 50 * are helpers to query cache window size and allocate framebuffer(s) 51 * for the cache windows. 52 * 53 * The call to dmub_srv_hw_init() programs the DMCUB registers to prepare 54 * for command submission. Commands can be queued via dmub_srv_cmd_queue() 55 * and executed via dmub_srv_cmd_execute(). 56 * 57 * If the queue is full the dmub_srv_wait_for_idle() call can be used to 58 * wait until the queue has been cleared. 59 * 60 * Destroying the DMUB service can be done by calling dmub_srv_destroy(). 61 * This does not clear DMUB hardware state, only software state. 62 * 63 * The interface is intended to be standalone and should not depend on any 64 * other component within DAL. 65 */ 66 67 #include "inc/dmub_cmd.h" 68 69 #if defined(__cplusplus) 70 extern "C" { 71 #endif 72 73 /* Forward declarations */ 74 struct dmub_srv; 75 struct dmub_srv_common_regs; 76 struct dmub_srv_dcn31_regs; 77 78 struct dmcub_trace_buf_entry; 79 80 /* enum dmub_status - return code for dmcub functions */ 81 enum dmub_status { 82 DMUB_STATUS_OK = 0, 83 DMUB_STATUS_NO_CTX, 84 DMUB_STATUS_QUEUE_FULL, 85 DMUB_STATUS_TIMEOUT, 86 DMUB_STATUS_INVALID, 87 DMUB_STATUS_HW_FAILURE, 88 }; 89 90 /* enum dmub_asic - dmub asic identifier */ 91 enum dmub_asic { 92 DMUB_ASIC_NONE = 0, 93 DMUB_ASIC_DCN20, 94 DMUB_ASIC_DCN21, 95 DMUB_ASIC_DCN30, 96 DMUB_ASIC_DCN301, 97 DMUB_ASIC_DCN302, 98 DMUB_ASIC_DCN303, 99 DMUB_ASIC_DCN31, 100 DMUB_ASIC_DCN31B, 101 DMUB_ASIC_DCN314, 102 DMUB_ASIC_DCN315, 103 DMUB_ASIC_DCN316, 104 DMUB_ASIC_DCN32, 105 DMUB_ASIC_DCN321, 106 DMUB_ASIC_MAX, 107 }; 108 109 /* enum dmub_window_id - dmub window identifier */ 110 enum dmub_window_id { 111 DMUB_WINDOW_0_INST_CONST = 0, 112 DMUB_WINDOW_1_STACK, 113 DMUB_WINDOW_2_BSS_DATA, 114 DMUB_WINDOW_3_VBIOS, 115 DMUB_WINDOW_4_MAILBOX, 116 DMUB_WINDOW_5_TRACEBUFF, 117 DMUB_WINDOW_6_FW_STATE, 118 DMUB_WINDOW_7_SCRATCH_MEM, 119 DMUB_WINDOW_TOTAL, 120 }; 121 122 /* enum dmub_notification_type - dmub outbox notification identifier */ 123 enum dmub_notification_type { 124 DMUB_NOTIFICATION_NO_DATA = 0, 125 DMUB_NOTIFICATION_AUX_REPLY, 126 DMUB_NOTIFICATION_HPD, 127 DMUB_NOTIFICATION_HPD_IRQ, 128 DMUB_NOTIFICATION_SET_CONFIG_REPLY, 129 DMUB_NOTIFICATION_DPIA_NOTIFICATION, 130 DMUB_NOTIFICATION_MAX 131 }; 132 133 /** 134 * struct dmub_region - dmub hw memory region 135 * @base: base address for region, must be 256 byte aligned 136 * @top: top address for region 137 */ 138 struct dmub_region { 139 uint32_t base; 140 uint32_t top; 141 }; 142 143 /** 144 * struct dmub_window - dmub hw cache window 145 * @off: offset to the fb memory in gpu address space 146 * @r: region in uc address space for cache window 147 */ 148 struct dmub_window { 149 union dmub_addr offset; 150 struct dmub_region region; 151 }; 152 153 /** 154 * struct dmub_fb - defines a dmub framebuffer memory region 155 * @cpu_addr: cpu virtual address for the region, NULL if invalid 156 * @gpu_addr: gpu virtual address for the region, NULL if invalid 157 * @size: size of the region in bytes, zero if invalid 158 */ 159 struct dmub_fb { 160 void *cpu_addr; 161 uint64_t gpu_addr; 162 uint32_t size; 163 }; 164 165 /** 166 * struct dmub_srv_region_params - params used for calculating dmub regions 167 * @inst_const_size: size of the fw inst const section 168 * @bss_data_size: size of the fw bss data section 169 * @vbios_size: size of the vbios data 170 * @fw_bss_data: raw firmware bss data section 171 */ 172 struct dmub_srv_region_params { 173 uint32_t inst_const_size; 174 uint32_t bss_data_size; 175 uint32_t vbios_size; 176 const uint8_t *fw_inst_const; 177 const uint8_t *fw_bss_data; 178 }; 179 180 /** 181 * struct dmub_srv_region_info - output region info from the dmub service 182 * @fb_size: required minimum fb size for all regions, aligned to 4096 bytes 183 * @num_regions: number of regions used by the dmub service 184 * @regions: region info 185 * 186 * The regions are aligned such that they can be all placed within the 187 * same framebuffer but they can also be placed into different framebuffers. 188 * 189 * The size of each region can be calculated by the caller: 190 * size = reg.top - reg.base 191 * 192 * Care must be taken when performing custom allocations to ensure that each 193 * region base address is 256 byte aligned. 194 */ 195 struct dmub_srv_region_info { 196 uint32_t fb_size; 197 uint8_t num_regions; 198 struct dmub_region regions[DMUB_WINDOW_TOTAL]; 199 }; 200 201 /** 202 * struct dmub_srv_fb_params - parameters used for driver fb setup 203 * @region_info: region info calculated by dmub service 204 * @cpu_addr: base cpu address for the framebuffer 205 * @gpu_addr: base gpu virtual address for the framebuffer 206 */ 207 struct dmub_srv_fb_params { 208 const struct dmub_srv_region_info *region_info; 209 void *cpu_addr; 210 uint64_t gpu_addr; 211 }; 212 213 /** 214 * struct dmub_srv_fb_info - output fb info from the dmub service 215 * @num_fbs: number of required dmub framebuffers 216 * @fbs: fb data for each region 217 * 218 * Output from the dmub service helper that can be used by the 219 * driver to prepare dmub_fb that can be passed into the dmub 220 * hw init service. 221 * 222 * Assumes that all regions are within the same framebuffer 223 * and have been setup according to the region_info generated 224 * by the dmub service. 225 */ 226 struct dmub_srv_fb_info { 227 uint8_t num_fb; 228 struct dmub_fb fb[DMUB_WINDOW_TOTAL]; 229 }; 230 231 /* 232 * struct dmub_srv_hw_params - params for dmub hardware initialization 233 * @fb: framebuffer info for each region 234 * @fb_base: base of the framebuffer aperture 235 * @fb_offset: offset of the framebuffer aperture 236 * @psp_version: psp version to pass for DMCU init 237 * @load_inst_const: true if DMUB should load inst const fw 238 */ 239 struct dmub_srv_hw_params { 240 struct dmub_fb *fb[DMUB_WINDOW_TOTAL]; 241 uint64_t fb_base; 242 uint64_t fb_offset; 243 uint32_t psp_version; 244 bool load_inst_const; 245 bool skip_panel_power_sequence; 246 bool disable_z10; 247 bool power_optimization; 248 bool dpia_supported; 249 bool disable_dpia; 250 bool usb4_cm_version; 251 bool fw_in_system_memory; 252 bool dpia_hpd_int_enable_supported; 253 }; 254 255 /** 256 * struct dmub_diagnostic_data - Diagnostic data retrieved from DMCUB for 257 * debugging purposes, including logging, crash analysis, etc. 258 */ 259 struct dmub_diagnostic_data { 260 uint32_t dmcub_version; 261 uint32_t scratch[16]; 262 uint32_t pc; 263 uint32_t undefined_address_fault_addr; 264 uint32_t inst_fetch_fault_addr; 265 uint32_t data_write_fault_addr; 266 uint32_t inbox1_rptr; 267 uint32_t inbox1_wptr; 268 uint32_t inbox1_size; 269 uint32_t inbox0_rptr; 270 uint32_t inbox0_wptr; 271 uint32_t inbox0_size; 272 uint8_t is_dmcub_enabled : 1; 273 uint8_t is_dmcub_soft_reset : 1; 274 uint8_t is_dmcub_secure_reset : 1; 275 uint8_t is_traceport_en : 1; 276 uint8_t is_cw0_enabled : 1; 277 uint8_t is_cw6_enabled : 1; 278 }; 279 280 /** 281 * struct dmub_srv_base_funcs - Driver specific base callbacks 282 */ 283 struct dmub_srv_base_funcs { 284 /** 285 * @reg_read: 286 * 287 * Hook for reading a register. 288 * 289 * Return: The 32-bit register value from the given address. 290 */ 291 uint32_t (*reg_read)(void *ctx, uint32_t address); 292 293 /** 294 * @reg_write: 295 * 296 * Hook for writing a value to the register specified by address. 297 */ 298 void (*reg_write)(void *ctx, uint32_t address, uint32_t value); 299 }; 300 301 /** 302 * struct dmub_srv_hw_funcs - hardware sequencer funcs for dmub 303 */ 304 struct dmub_srv_hw_funcs { 305 /* private: internal use only */ 306 307 void (*init)(struct dmub_srv *dmub); 308 309 void (*reset)(struct dmub_srv *dmub); 310 311 void (*reset_release)(struct dmub_srv *dmub); 312 313 void (*backdoor_load)(struct dmub_srv *dmub, 314 const struct dmub_window *cw0, 315 const struct dmub_window *cw1); 316 317 void (*backdoor_load_zfb_mode)(struct dmub_srv *dmub, 318 const struct dmub_window *cw0, 319 const struct dmub_window *cw1); 320 void (*setup_windows)(struct dmub_srv *dmub, 321 const struct dmub_window *cw2, 322 const struct dmub_window *cw3, 323 const struct dmub_window *cw4, 324 const struct dmub_window *cw5, 325 const struct dmub_window *cw6); 326 327 void (*setup_mailbox)(struct dmub_srv *dmub, 328 const struct dmub_region *inbox1); 329 330 uint32_t (*get_inbox1_rptr)(struct dmub_srv *dmub); 331 332 void (*set_inbox1_wptr)(struct dmub_srv *dmub, uint32_t wptr_offset); 333 334 void (*setup_out_mailbox)(struct dmub_srv *dmub, 335 const struct dmub_region *outbox1); 336 337 uint32_t (*get_outbox1_wptr)(struct dmub_srv *dmub); 338 339 void (*set_outbox1_rptr)(struct dmub_srv *dmub, uint32_t rptr_offset); 340 341 void (*setup_outbox0)(struct dmub_srv *dmub, 342 const struct dmub_region *outbox0); 343 344 uint32_t (*get_outbox0_wptr)(struct dmub_srv *dmub); 345 346 void (*set_outbox0_rptr)(struct dmub_srv *dmub, uint32_t rptr_offset); 347 348 uint32_t (*emul_get_inbox1_rptr)(struct dmub_srv *dmub); 349 350 void (*emul_set_inbox1_wptr)(struct dmub_srv *dmub, uint32_t wptr_offset); 351 352 bool (*is_supported)(struct dmub_srv *dmub); 353 354 bool (*is_hw_init)(struct dmub_srv *dmub); 355 356 bool (*is_phy_init)(struct dmub_srv *dmub); 357 void (*enable_dmub_boot_options)(struct dmub_srv *dmub, 358 const struct dmub_srv_hw_params *params); 359 360 void (*skip_dmub_panel_power_sequence)(struct dmub_srv *dmub, bool skip); 361 362 union dmub_fw_boot_status (*get_fw_status)(struct dmub_srv *dmub); 363 364 365 void (*set_gpint)(struct dmub_srv *dmub, 366 union dmub_gpint_data_register reg); 367 368 bool (*is_gpint_acked)(struct dmub_srv *dmub, 369 union dmub_gpint_data_register reg); 370 371 uint32_t (*get_gpint_response)(struct dmub_srv *dmub); 372 373 uint32_t (*get_gpint_dataout)(struct dmub_srv *dmub); 374 375 void (*configure_dmub_in_system_memory)(struct dmub_srv *dmub); 376 void (*clear_inbox0_ack_register)(struct dmub_srv *dmub); 377 uint32_t (*read_inbox0_ack_register)(struct dmub_srv *dmub); 378 void (*send_inbox0_cmd)(struct dmub_srv *dmub, union dmub_inbox0_data_register data); 379 uint32_t (*get_current_time)(struct dmub_srv *dmub); 380 381 void (*get_diagnostic_data)(struct dmub_srv *dmub, struct dmub_diagnostic_data *dmub_oca); 382 383 bool (*should_detect)(struct dmub_srv *dmub); 384 }; 385 386 /** 387 * struct dmub_srv_create_params - params for dmub service creation 388 * @base_funcs: driver supplied base routines 389 * @hw_funcs: optional overrides for hw funcs 390 * @user_ctx: context data for callback funcs 391 * @asic: driver supplied asic 392 * @fw_version: the current firmware version, if any 393 * @is_virtual: false for hw support only 394 */ 395 struct dmub_srv_create_params { 396 struct dmub_srv_base_funcs funcs; 397 struct dmub_srv_hw_funcs *hw_funcs; 398 void *user_ctx; 399 enum dmub_asic asic; 400 uint32_t fw_version; 401 bool is_virtual; 402 }; 403 404 /** 405 * struct dmub_srv - software state for dmcub 406 * @asic: dmub asic identifier 407 * @user_ctx: user provided context for the dmub_srv 408 * @fw_version: the current firmware version, if any 409 * @is_virtual: false if hardware support only 410 * @fw_state: dmub firmware state pointer 411 */ 412 struct dmub_srv { 413 enum dmub_asic asic; 414 void *user_ctx; 415 uint32_t fw_version; 416 bool is_virtual; 417 struct dmub_fb scratch_mem_fb; 418 volatile const struct dmub_fw_state *fw_state; 419 420 /* private: internal use only */ 421 const struct dmub_srv_common_regs *regs; 422 const struct dmub_srv_dcn31_regs *regs_dcn31; 423 const struct dmub_srv_dcn32_regs *regs_dcn32; 424 425 struct dmub_srv_base_funcs funcs; 426 struct dmub_srv_hw_funcs hw_funcs; 427 struct dmub_rb inbox1_rb; 428 uint32_t inbox1_last_wptr; 429 /** 430 * outbox1_rb is accessed without locks (dal & dc) 431 * and to be used only in dmub_srv_stat_get_notification() 432 */ 433 struct dmub_rb outbox1_rb; 434 435 struct dmub_rb outbox0_rb; 436 437 bool sw_init; 438 bool hw_init; 439 440 uint64_t fb_base; 441 uint64_t fb_offset; 442 uint32_t psp_version; 443 444 /* Feature capabilities reported by fw */ 445 struct dmub_feature_caps feature_caps; 446 struct dmub_visual_confirm_color visual_confirm_color; 447 }; 448 449 /** 450 * struct dmub_notification - dmub notification data 451 * @type: dmub notification type 452 * @link_index: link index to identify aux connection 453 * @result: USB4 status returned from dmub 454 * @pending_notification: Indicates there are other pending notifications 455 * @aux_reply: aux reply 456 * @hpd_status: hpd status 457 * @bw_alloc_reply: BW Allocation reply from CM/DPIA 458 */ 459 struct dmub_notification { 460 enum dmub_notification_type type; 461 uint8_t link_index; 462 uint8_t result; 463 bool pending_notification; 464 union { 465 struct aux_reply_data aux_reply; 466 enum dp_hpd_status hpd_status; 467 enum set_config_status sc_status; 468 struct dpia_notification_reply_data bw_alloc_reply; 469 }; 470 }; 471 472 /** 473 * DMUB firmware version helper macro - useful for checking if the version 474 * of a firmware to know if feature or functionality is supported or present. 475 */ 476 #define DMUB_FW_VERSION(major, minor, revision) \ 477 ((((major) & 0xFF) << 24) | (((minor) & 0xFF) << 16) | ((revision) & 0xFFFF)) 478 479 /** 480 * dmub_srv_create() - creates the DMUB service. 481 * @dmub: the dmub service 482 * @params: creation parameters for the service 483 * 484 * Return: 485 * DMUB_STATUS_OK - success 486 * DMUB_STATUS_INVALID - unspecified error 487 */ 488 enum dmub_status dmub_srv_create(struct dmub_srv *dmub, 489 const struct dmub_srv_create_params *params); 490 491 /** 492 * dmub_srv_destroy() - destroys the DMUB service. 493 * @dmub: the dmub service 494 */ 495 void dmub_srv_destroy(struct dmub_srv *dmub); 496 497 /** 498 * dmub_srv_calc_region_info() - retreives region info from the dmub service 499 * @dmub: the dmub service 500 * @params: parameters used to calculate region locations 501 * @info_out: the output region info from dmub 502 * 503 * Calculates the base and top address for all relevant dmub regions 504 * using the parameters given (if any). 505 * 506 * Return: 507 * DMUB_STATUS_OK - success 508 * DMUB_STATUS_INVALID - unspecified error 509 */ 510 enum dmub_status 511 dmub_srv_calc_region_info(struct dmub_srv *dmub, 512 const struct dmub_srv_region_params *params, 513 struct dmub_srv_region_info *out); 514 515 /** 516 * dmub_srv_calc_region_info() - retreives fb info from the dmub service 517 * @dmub: the dmub service 518 * @params: parameters used to calculate fb locations 519 * @info_out: the output fb info from dmub 520 * 521 * Calculates the base and top address for all relevant dmub regions 522 * using the parameters given (if any). 523 * 524 * Return: 525 * DMUB_STATUS_OK - success 526 * DMUB_STATUS_INVALID - unspecified error 527 */ 528 enum dmub_status dmub_srv_calc_fb_info(struct dmub_srv *dmub, 529 const struct dmub_srv_fb_params *params, 530 struct dmub_srv_fb_info *out); 531 532 /** 533 * dmub_srv_has_hw_support() - returns hw support state for dmcub 534 * @dmub: the dmub service 535 * @is_supported: hw support state 536 * 537 * Queries the hardware for DMCUB support and returns the result. 538 * 539 * Can be called before dmub_srv_hw_init(). 540 * 541 * Return: 542 * DMUB_STATUS_OK - success 543 * DMUB_STATUS_INVALID - unspecified error 544 */ 545 enum dmub_status dmub_srv_has_hw_support(struct dmub_srv *dmub, 546 bool *is_supported); 547 548 /** 549 * dmub_srv_is_hw_init() - returns hardware init state 550 * 551 * Return: 552 * DMUB_STATUS_OK - success 553 * DMUB_STATUS_INVALID - unspecified error 554 */ 555 enum dmub_status dmub_srv_is_hw_init(struct dmub_srv *dmub, bool *is_hw_init); 556 557 /** 558 * dmub_srv_hw_init() - initializes the underlying DMUB hardware 559 * @dmub: the dmub service 560 * @params: params for hardware initialization 561 * 562 * Resets the DMUB hardware and performs backdoor loading of the 563 * required cache regions based on the input framebuffer regions. 564 * 565 * Return: 566 * DMUB_STATUS_OK - success 567 * DMUB_STATUS_NO_CTX - dmcub context not initialized 568 * DMUB_STATUS_INVALID - unspecified error 569 */ 570 enum dmub_status dmub_srv_hw_init(struct dmub_srv *dmub, 571 const struct dmub_srv_hw_params *params); 572 573 /** 574 * dmub_srv_hw_reset() - puts the DMUB hardware in reset state if initialized 575 * @dmub: the dmub service 576 * 577 * Before destroying the DMUB service or releasing the backing framebuffer 578 * memory we'll need to put the DMCUB into reset first. 579 * 580 * A subsequent call to dmub_srv_hw_init() will re-enable the DMCUB. 581 * 582 * Return: 583 * DMUB_STATUS_OK - success 584 * DMUB_STATUS_INVALID - unspecified error 585 */ 586 enum dmub_status dmub_srv_hw_reset(struct dmub_srv *dmub); 587 588 /** 589 * dmub_srv_cmd_queue() - queues a command to the DMUB 590 * @dmub: the dmub service 591 * @cmd: the command to queue 592 * 593 * Queues a command to the DMUB service but does not begin execution 594 * immediately. 595 * 596 * Return: 597 * DMUB_STATUS_OK - success 598 * DMUB_STATUS_QUEUE_FULL - no remaining room in queue 599 * DMUB_STATUS_INVALID - unspecified error 600 */ 601 enum dmub_status dmub_srv_cmd_queue(struct dmub_srv *dmub, 602 const union dmub_rb_cmd *cmd); 603 604 /** 605 * dmub_srv_cmd_execute() - Executes a queued sequence to the dmub 606 * @dmub: the dmub service 607 * 608 * Begins execution of queued commands on the dmub. 609 * 610 * Return: 611 * DMUB_STATUS_OK - success 612 * DMUB_STATUS_INVALID - unspecified error 613 */ 614 enum dmub_status dmub_srv_cmd_execute(struct dmub_srv *dmub); 615 616 /** 617 * dmub_srv_wait_for_auto_load() - Waits for firmware auto load to complete 618 * @dmub: the dmub service 619 * @timeout_us: the maximum number of microseconds to wait 620 * 621 * Waits until firmware has been autoloaded by the DMCUB. The maximum 622 * wait time is given in microseconds to prevent spinning forever. 623 * 624 * On ASICs without firmware autoload support this function will return 625 * immediately. 626 * 627 * Return: 628 * DMUB_STATUS_OK - success 629 * DMUB_STATUS_TIMEOUT - wait for phy init timed out 630 * DMUB_STATUS_INVALID - unspecified error 631 */ 632 enum dmub_status dmub_srv_wait_for_auto_load(struct dmub_srv *dmub, 633 uint32_t timeout_us); 634 635 /** 636 * dmub_srv_wait_for_phy_init() - Waits for DMUB PHY init to complete 637 * @dmub: the dmub service 638 * @timeout_us: the maximum number of microseconds to wait 639 * 640 * Waits until the PHY has been initialized by the DMUB. The maximum 641 * wait time is given in microseconds to prevent spinning forever. 642 * 643 * On ASICs without PHY init support this function will return 644 * immediately. 645 * 646 * Return: 647 * DMUB_STATUS_OK - success 648 * DMUB_STATUS_TIMEOUT - wait for phy init timed out 649 * DMUB_STATUS_INVALID - unspecified error 650 */ 651 enum dmub_status dmub_srv_wait_for_phy_init(struct dmub_srv *dmub, 652 uint32_t timeout_us); 653 654 /** 655 * dmub_srv_wait_for_idle() - Waits for the DMUB to be idle 656 * @dmub: the dmub service 657 * @timeout_us: the maximum number of microseconds to wait 658 * 659 * Waits until the DMUB buffer is empty and all commands have 660 * finished processing. The maximum wait time is given in 661 * microseconds to prevent spinning forever. 662 * 663 * Return: 664 * DMUB_STATUS_OK - success 665 * DMUB_STATUS_TIMEOUT - wait for buffer to flush timed out 666 * DMUB_STATUS_INVALID - unspecified error 667 */ 668 enum dmub_status dmub_srv_wait_for_idle(struct dmub_srv *dmub, 669 uint32_t timeout_us); 670 671 /** 672 * dmub_srv_send_gpint_command() - Sends a GPINT based command. 673 * @dmub: the dmub service 674 * @command_code: the command code to send 675 * @param: the command parameter to send 676 * @timeout_us: the maximum number of microseconds to wait 677 * 678 * Sends a command via the general purpose interrupt (GPINT). 679 * Waits for the number of microseconds specified by timeout_us 680 * for the command ACK before returning. 681 * 682 * Can be called after software initialization. 683 * 684 * Return: 685 * DMUB_STATUS_OK - success 686 * DMUB_STATUS_TIMEOUT - wait for ACK timed out 687 * DMUB_STATUS_INVALID - unspecified error 688 */ 689 enum dmub_status 690 dmub_srv_send_gpint_command(struct dmub_srv *dmub, 691 enum dmub_gpint_command command_code, 692 uint16_t param, uint32_t timeout_us); 693 694 /** 695 * dmub_srv_get_gpint_response() - Queries the GPINT response. 696 * @dmub: the dmub service 697 * @response: the response for the last GPINT 698 * 699 * Returns the response code for the last GPINT interrupt. 700 * 701 * Can be called after software initialization. 702 * 703 * Return: 704 * DMUB_STATUS_OK - success 705 * DMUB_STATUS_INVALID - unspecified error 706 */ 707 enum dmub_status dmub_srv_get_gpint_response(struct dmub_srv *dmub, 708 uint32_t *response); 709 710 /** 711 * dmub_srv_get_gpint_dataout() - Queries the GPINT DATAOUT. 712 * @dmub: the dmub service 713 * @dataout: the data for the GPINT DATAOUT 714 * 715 * Returns the response code for the last GPINT DATAOUT interrupt. 716 * 717 * Can be called after software initialization. 718 * 719 * Return: 720 * DMUB_STATUS_OK - success 721 * DMUB_STATUS_INVALID - unspecified error 722 */ 723 enum dmub_status dmub_srv_get_gpint_dataout(struct dmub_srv *dmub, 724 uint32_t *dataout); 725 726 /** 727 * dmub_flush_buffer_mem() - Read back entire frame buffer region. 728 * This ensures that the write from x86 has been flushed and will not 729 * hang the DMCUB. 730 * @fb: frame buffer to flush 731 * 732 * Can be called after software initialization. 733 */ 734 void dmub_flush_buffer_mem(const struct dmub_fb *fb); 735 736 /** 737 * dmub_srv_get_fw_boot_status() - Returns the DMUB boot status bits. 738 * 739 * @dmub: the dmub service 740 * @status: out pointer for firmware status 741 * 742 * Return: 743 * DMUB_STATUS_OK - success 744 * DMUB_STATUS_INVALID - unspecified error, unsupported 745 */ 746 enum dmub_status dmub_srv_get_fw_boot_status(struct dmub_srv *dmub, 747 union dmub_fw_boot_status *status); 748 749 enum dmub_status dmub_srv_cmd_with_reply_data(struct dmub_srv *dmub, 750 union dmub_rb_cmd *cmd); 751 752 bool dmub_srv_get_outbox0_msg(struct dmub_srv *dmub, struct dmcub_trace_buf_entry *entry); 753 754 bool dmub_srv_get_diagnostic_data(struct dmub_srv *dmub, struct dmub_diagnostic_data *diag_data); 755 756 bool dmub_srv_should_detect(struct dmub_srv *dmub); 757 758 /** 759 * dmub_srv_send_inbox0_cmd() - Send command to DMUB using INBOX0 760 * @dmub: the dmub service 761 * @data: the data to be sent in the INBOX0 command 762 * 763 * Send command by writing directly to INBOX0 WPTR 764 * 765 * Return: 766 * DMUB_STATUS_OK - success 767 * DMUB_STATUS_INVALID - hw_init false or hw function does not exist 768 */ 769 enum dmub_status dmub_srv_send_inbox0_cmd(struct dmub_srv *dmub, union dmub_inbox0_data_register data); 770 771 /** 772 * dmub_srv_wait_for_inbox0_ack() - wait for DMUB to ACK INBOX0 command 773 * @dmub: the dmub service 774 * @timeout_us: the maximum number of microseconds to wait 775 * 776 * Wait for DMUB to ACK the INBOX0 message 777 * 778 * Return: 779 * DMUB_STATUS_OK - success 780 * DMUB_STATUS_INVALID - hw_init false or hw function does not exist 781 * DMUB_STATUS_TIMEOUT - wait for ack timed out 782 */ 783 enum dmub_status dmub_srv_wait_for_inbox0_ack(struct dmub_srv *dmub, uint32_t timeout_us); 784 785 /** 786 * dmub_srv_wait_for_inbox0_ack() - clear ACK register for INBOX0 787 * @dmub: the dmub service 788 * 789 * Clear ACK register for INBOX0 790 * 791 * Return: 792 * DMUB_STATUS_OK - success 793 * DMUB_STATUS_INVALID - hw_init false or hw function does not exist 794 */ 795 enum dmub_status dmub_srv_clear_inbox0_ack(struct dmub_srv *dmub); 796 797 #if defined(__cplusplus) 798 } 799 #endif 800 801 #endif /* _DMUB_SRV_H_ */ 802