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