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