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