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
  77 /* enum dmub_status - return code for dmcub functions */
  78 enum dmub_status {
  79         DMUB_STATUS_OK = 0,
  80         DMUB_STATUS_NO_CTX,
  81         DMUB_STATUS_QUEUE_FULL,
  82         DMUB_STATUS_TIMEOUT,
  83         DMUB_STATUS_INVALID,
  84 };
  85
  86 /* enum dmub_asic - dmub asic identifier */
  87 enum dmub_asic {
  88         DMUB_ASIC_NONE = 0,
  89         DMUB_ASIC_DCN20,
  90         DMUB_ASIC_DCN21,
  91 #ifdef CONFIG_DRM_AMD_DC_DCN3_0
  92         DMUB_ASIC_DCN30,
  93 #endif
  94         DMUB_ASIC_MAX,
  95 };
  96
  97 /* enum dmub_window_id - dmub window identifier */
  98 enum dmub_window_id {
  99         DMUB_WINDOW_0_INST_CONST = 0,
 100         DMUB_WINDOW_1_STACK,
 101         DMUB_WINDOW_2_BSS_DATA,
 102         DMUB_WINDOW_3_VBIOS,
 103         DMUB_WINDOW_4_MAILBOX,
 104         DMUB_WINDOW_5_TRACEBUFF,
 105         DMUB_WINDOW_6_FW_STATE,
 106         DMUB_WINDOW_7_SCRATCH_MEM,
 107         DMUB_WINDOW_TOTAL,
 108 };
 109
 110 /**
 111  * struct dmub_region - dmub hw memory region
 112  * @base: base address for region, must be 256 byte aligned
 113  * @top: top address for region
 114  */
 115 struct dmub_region {
 116         uint32_t base;
 117         uint32_t top;
 118 };
 119
 120 /**
 121  * struct dmub_window - dmub hw cache window
 122  * @off: offset to the fb memory in gpu address space
 123  * @r: region in uc address space for cache window
 124  */
 125 struct dmub_window {
 126         union dmub_addr offset;
 127         struct dmub_region region;
 128 };
 129
 130 /**
 131  * struct dmub_fb - defines a dmub framebuffer memory region
 132  * @cpu_addr: cpu virtual address for the region, NULL if invalid
 133  * @gpu_addr: gpu virtual address for the region, NULL if invalid
 134  * @size: size of the region in bytes, zero if invalid
 135  */
 136 struct dmub_fb {
 137         void *cpu_addr;
 138         uint64_t gpu_addr;
 139         uint32_t size;
 140 };
 141
 142 /**
 143  * struct dmub_srv_region_params - params used for calculating dmub regions
 144  * @inst_const_size: size of the fw inst const section
 145  * @bss_data_size: size of the fw bss data section
 146  * @vbios_size: size of the vbios data
 147  * @fw_bss_data: raw firmware bss data section
 148  */
 149 struct dmub_srv_region_params {
 150         uint32_t inst_const_size;
 151         uint32_t bss_data_size;
 152         uint32_t vbios_size;
 153         const uint8_t *fw_inst_const;
 154         const uint8_t *fw_bss_data;
 155 };
 156
 157 /**
 158  * struct dmub_srv_region_info - output region info from the dmub service
 159  * @fb_size: required minimum fb size for all regions, aligned to 4096 bytes
 160  * @num_regions: number of regions used by the dmub service
 161  * @regions: region info
 162  *
 163  * The regions are aligned such that they can be all placed within the
 164  * same framebuffer but they can also be placed into different framebuffers.
 165  *
 166  * The size of each region can be calculated by the caller:
 167  * size = reg.top - reg.base
 168  *
 169  * Care must be taken when performing custom allocations to ensure that each
 170  * region base address is 256 byte aligned.
 171  */
 172 struct dmub_srv_region_info {
 173         uint32_t fb_size;
 174         uint8_t num_regions;
 175         struct dmub_region regions[DMUB_WINDOW_TOTAL];
 176 };
 177
 178 /**
 179  * struct dmub_srv_fb_params - parameters used for driver fb setup
 180  * @region_info: region info calculated by dmub service
 181  * @cpu_addr: base cpu address for the framebuffer
 182  * @gpu_addr: base gpu virtual address for the framebuffer
 183  */
 184 struct dmub_srv_fb_params {
 185         const struct dmub_srv_region_info *region_info;
 186         void *cpu_addr;
 187         uint64_t gpu_addr;
 188 };
 189
 190 /**
 191  * struct dmub_srv_fb_info - output fb info from the dmub service
 192  * @num_fbs: number of required dmub framebuffers
 193  * @fbs: fb data for each region
 194  *
 195  * Output from the dmub service helper that can be used by the
 196  * driver to prepare dmub_fb that can be passed into the dmub
 197  * hw init service.
 198  *
 199  * Assumes that all regions are within the same framebuffer
 200  * and have been setup according to the region_info generated
 201  * by the dmub service.
 202  */
 203 struct dmub_srv_fb_info {
 204         uint8_t num_fb;
 205         struct dmub_fb fb[DMUB_WINDOW_TOTAL];
 206 };
 207
 208 /**
 209  * struct dmub_srv_base_funcs - Driver specific base callbacks
 210  */
 211 struct dmub_srv_base_funcs {
 212         /**
 213          * @reg_read:
 214          *
 215          * Hook for reading a register.
 216          *
 217          * Return: The 32-bit register value from the given address.
 218          */
 219         uint32_t (*reg_read)(void *ctx, uint32_t address);
 220
 221         /**
 222          * @reg_write:
 223          *
 224          * Hook for writing a value to the register specified by address.
 225          */
 226         void (*reg_write)(void *ctx, uint32_t address, uint32_t value);
 227 };
 228
 229 /**
 230  * struct dmub_srv_hw_funcs - hardware sequencer funcs for dmub
 231  */
 232 struct dmub_srv_hw_funcs {
 233         /* private: internal use only */
 234
 235         void (*init)(struct dmub_srv *dmub);
 236
 237         void (*reset)(struct dmub_srv *dmub);
 238
 239         void (*reset_release)(struct dmub_srv *dmub);
 240
 241         void (*backdoor_load)(struct dmub_srv *dmub,
 242                               const struct dmub_window *cw0,
 243                               const struct dmub_window *cw1);
 244
 245         void (*setup_windows)(struct dmub_srv *dmub,
 246                               const struct dmub_window *cw2,
 247                               const struct dmub_window *cw3,
 248                               const struct dmub_window *cw4,
 249                               const struct dmub_window *cw5,
 250                               const struct dmub_window *cw6);
 251
 252         void (*setup_mailbox)(struct dmub_srv *dmub,
 253                               const struct dmub_region *inbox1);
 254
 255         uint32_t (*get_inbox1_rptr)(struct dmub_srv *dmub);
 256
 257         void (*set_inbox1_wptr)(struct dmub_srv *dmub, uint32_t wptr_offset);
 258
 259         uint32_t (*emul_get_inbox1_rptr)(struct dmub_srv *dmub);
 260
 261         void (*emul_set_inbox1_wptr)(struct dmub_srv *dmub, uint32_t wptr_offset);
 262
 263         bool (*is_supported)(struct dmub_srv *dmub);
 264
 265         bool (*is_hw_init)(struct dmub_srv *dmub);
 266
 267         void (*enable_dmub_boot_options)(struct dmub_srv *dmub);
 268
 269         union dmub_fw_boot_status (*get_fw_status)(struct dmub_srv *dmub);
 270
 271
 272         void (*set_gpint)(struct dmub_srv *dmub,
 273                           union dmub_gpint_data_register reg);
 274
 275         bool (*is_gpint_acked)(struct dmub_srv *dmub,
 276                                union dmub_gpint_data_register reg);
 277
 278         uint32_t (*get_gpint_response)(struct dmub_srv *dmub);
 279 };
 280
 281 /**
 282  * struct dmub_srv_create_params - params for dmub service creation
 283  * @base_funcs: driver supplied base routines
 284  * @hw_funcs: optional overrides for hw funcs
 285  * @user_ctx: context data for callback funcs
 286  * @asic: driver supplied asic
 287  * @fw_version: the current firmware version, if any
 288  * @is_virtual: false for hw support only
 289  */
 290 struct dmub_srv_create_params {
 291         struct dmub_srv_base_funcs funcs;
 292         struct dmub_srv_hw_funcs *hw_funcs;
 293         void *user_ctx;
 294         enum dmub_asic asic;
 295         uint32_t fw_version;
 296         bool is_virtual;
 297 };
 298
 299 /*
 300  * struct dmub_srv_hw_params - params for dmub hardware initialization
 301  * @fb: framebuffer info for each region
 302  * @fb_base: base of the framebuffer aperture
 303  * @fb_offset: offset of the framebuffer aperture
 304  * @psp_version: psp version to pass for DMCU init
 305  * @load_inst_const: true if DMUB should load inst const fw
 306  */
 307 struct dmub_srv_hw_params {
 308         struct dmub_fb *fb[DMUB_WINDOW_TOTAL];
 309         uint64_t fb_base;
 310         uint64_t fb_offset;
 311         uint32_t psp_version;
 312         bool load_inst_const;
 313 };
 314
 315 /**
 316  * struct dmub_srv - software state for dmcub
 317  * @asic: dmub asic identifier
 318  * @user_ctx: user provided context for the dmub_srv
 319  * @fw_version: the current firmware version, if any
 320  * @is_virtual: false if hardware support only
 321  * @fw_state: dmub firmware state pointer
 322  */
 323 struct dmub_srv {
 324         enum dmub_asic asic;
 325         void *user_ctx;
 326         uint32_t fw_version;
 327         bool is_virtual;
 328         struct dmub_fb scratch_mem_fb;
 329         volatile const struct dmub_fw_state *fw_state;
 330
 331         /* private: internal use only */
 332         const struct dmub_srv_common_regs *regs;
 333
 334         struct dmub_srv_base_funcs funcs;
 335         struct dmub_srv_hw_funcs hw_funcs;
 336         struct dmub_rb inbox1_rb;
 337
 338         bool sw_init;
 339         bool hw_init;
 340
 341         uint64_t fb_base;
 342         uint64_t fb_offset;
 343         uint32_t psp_version;
 344 };
 345
 346 /**
 347  * DMUB firmware version helper macro - useful for checking if the version
 348  * of a firmware to know if feature or functionality is supported or present.
 349  */
 350 #define DMUB_FW_VERSION(major, minor, revision) \
 351         ((((major) & 0xFF) << 24) | (((minor) & 0xFF) << 16) | ((revision) & 0xFFFF))
 352
 353 /**
 354  * dmub_srv_create() - creates the DMUB service.
 355  * @dmub: the dmub service
 356  * @params: creation parameters for the service
 357  *
 358  * Return:
 359  *   DMUB_STATUS_OK - success
 360  *   DMUB_STATUS_INVALID - unspecified error
 361  */
 362 enum dmub_status dmub_srv_create(struct dmub_srv *dmub,
 363                                  const struct dmub_srv_create_params *params);
 364
 365 /**
 366  * dmub_srv_destroy() - destroys the DMUB service.
 367  * @dmub: the dmub service
 368  */
 369 void dmub_srv_destroy(struct dmub_srv *dmub);
 370
 371 /**
 372  * dmub_srv_calc_region_info() - retreives region info from the dmub service
 373  * @dmub: the dmub service
 374  * @params: parameters used to calculate region locations
 375  * @info_out: the output region info from dmub
 376  *
 377  * Calculates the base and top address for all relevant dmub regions
 378  * using the parameters given (if any).
 379  *
 380  * Return:
 381  *   DMUB_STATUS_OK - success
 382  *   DMUB_STATUS_INVALID - unspecified error
 383  */
 384 enum dmub_status
 385 dmub_srv_calc_region_info(struct dmub_srv *dmub,
 386                           const struct dmub_srv_region_params *params,
 387                           struct dmub_srv_region_info *out);
 388
 389 /**
 390  * dmub_srv_calc_region_info() - retreives fb info from the dmub service
 391  * @dmub: the dmub service
 392  * @params: parameters used to calculate fb locations
 393  * @info_out: the output fb info from dmub
 394  *
 395  * Calculates the base and top address for all relevant dmub regions
 396  * using the parameters given (if any).
 397  *
 398  * Return:
 399  *   DMUB_STATUS_OK - success
 400  *   DMUB_STATUS_INVALID - unspecified error
 401  */
 402 enum dmub_status dmub_srv_calc_fb_info(struct dmub_srv *dmub,
 403                                        const struct dmub_srv_fb_params *params,
 404                                        struct dmub_srv_fb_info *out);
 405
 406 /**
 407  * dmub_srv_has_hw_support() - returns hw support state for dmcub
 408  * @dmub: the dmub service
 409  * @is_supported: hw support state
 410  *
 411  * Queries the hardware for DMCUB support and returns the result.
 412  *
 413  * Can be called before dmub_srv_hw_init().
 414  *
 415  * Return:
 416  *   DMUB_STATUS_OK - success
 417  *   DMUB_STATUS_INVALID - unspecified error
 418  */
 419 enum dmub_status dmub_srv_has_hw_support(struct dmub_srv *dmub,
 420                                          bool *is_supported);
 421
 422 /**
 423  * dmub_srv_is_hw_init() - returns hardware init state
 424  *
 425  * Return:
 426  *   DMUB_STATUS_OK - success
 427  *   DMUB_STATUS_INVALID - unspecified error
 428  */
 429 enum dmub_status dmub_srv_is_hw_init(struct dmub_srv *dmub, bool *is_hw_init);
 430
 431 /**
 432  * dmub_srv_hw_init() - initializes the underlying DMUB hardware
 433  * @dmub: the dmub service
 434  * @params: params for hardware initialization
 435  *
 436  * Resets the DMUB hardware and performs backdoor loading of the
 437  * required cache regions based on the input framebuffer regions.
 438  *
 439  * Return:
 440  *   DMUB_STATUS_OK - success
 441  *   DMUB_STATUS_NO_CTX - dmcub context not initialized
 442  *   DMUB_STATUS_INVALID - unspecified error
 443  */
 444 enum dmub_status dmub_srv_hw_init(struct dmub_srv *dmub,
 445                                   const struct dmub_srv_hw_params *params);
 446
 447 /**
 448  * dmub_srv_hw_reset() - puts the DMUB hardware in reset state if initialized
 449  * @dmub: the dmub service
 450  *
 451  * Before destroying the DMUB service or releasing the backing framebuffer
 452  * memory we'll need to put the DMCUB into reset first.
 453  *
 454  * A subsequent call to dmub_srv_hw_init() will re-enable the DMCUB.
 455  *
 456  * Return:
 457  *   DMUB_STATUS_OK - success
 458  *   DMUB_STATUS_INVALID - unspecified error
 459  */
 460 enum dmub_status dmub_srv_hw_reset(struct dmub_srv *dmub);
 461
 462 /**
 463  * dmub_srv_cmd_queue() - queues a command to the DMUB
 464  * @dmub: the dmub service
 465  * @cmd: the command to queue
 466  *
 467  * Queues a command to the DMUB service but does not begin execution
 468  * immediately.
 469  *
 470  * Return:
 471  *   DMUB_STATUS_OK - success
 472  *   DMUB_STATUS_QUEUE_FULL - no remaining room in queue
 473  *   DMUB_STATUS_INVALID - unspecified error
 474  */
 475 enum dmub_status dmub_srv_cmd_queue(struct dmub_srv *dmub,
 476                                     const union dmub_rb_cmd *cmd);
 477
 478 /**
 479  * dmub_srv_cmd_execute() - Executes a queued sequence to the dmub
 480  * @dmub: the dmub service
 481  *
 482  * Begins execution of queued commands on the dmub.
 483  *
 484  * Return:
 485  *   DMUB_STATUS_OK - success
 486  *   DMUB_STATUS_INVALID - unspecified error
 487  */
 488 enum dmub_status dmub_srv_cmd_execute(struct dmub_srv *dmub);
 489
 490 /**
 491  * dmub_srv_wait_for_auto_load() - Waits for firmware auto load to complete
 492  * @dmub: the dmub service
 493  * @timeout_us: the maximum number of microseconds to wait
 494  *
 495  * Waits until firmware has been autoloaded by the DMCUB. The maximum
 496  * wait time is given in microseconds to prevent spinning forever.
 497  *
 498  * On ASICs without firmware autoload support this function will return
 499  * immediately.
 500  *
 501  * Return:
 502  *   DMUB_STATUS_OK - success
 503  *   DMUB_STATUS_TIMEOUT - wait for phy init timed out
 504  *   DMUB_STATUS_INVALID - unspecified error
 505  */
 506 enum dmub_status dmub_srv_wait_for_auto_load(struct dmub_srv *dmub,
 507                                              uint32_t timeout_us);
 508
 509 /**
 510  * dmub_srv_wait_for_phy_init() - Waits for DMUB PHY init to complete
 511  * @dmub: the dmub service
 512  * @timeout_us: the maximum number of microseconds to wait
 513  *
 514  * Waits until the PHY has been initialized by the DMUB. The maximum
 515  * wait time is given in microseconds to prevent spinning forever.
 516  *
 517  * On ASICs without PHY init support this function will return
 518  * immediately.
 519  *
 520  * Return:
 521  *   DMUB_STATUS_OK - success
 522  *   DMUB_STATUS_TIMEOUT - wait for phy init timed out
 523  *   DMUB_STATUS_INVALID - unspecified error
 524  */
 525 enum dmub_status dmub_srv_wait_for_phy_init(struct dmub_srv *dmub,
 526                                             uint32_t timeout_us);
 527
 528 /**
 529  * dmub_srv_wait_for_idle() - Waits for the DMUB to be idle
 530  * @dmub: the dmub service
 531  * @timeout_us: the maximum number of microseconds to wait
 532  *
 533  * Waits until the DMUB buffer is empty and all commands have
 534  * finished processing. The maximum wait time is given in
 535  * microseconds to prevent spinning forever.
 536  *
 537  * Return:
 538  *   DMUB_STATUS_OK - success
 539  *   DMUB_STATUS_TIMEOUT - wait for buffer to flush timed out
 540  *   DMUB_STATUS_INVALID - unspecified error
 541  */
 542 enum dmub_status dmub_srv_wait_for_idle(struct dmub_srv *dmub,
 543                                         uint32_t timeout_us);
 544
 545 /**
 546  * dmub_srv_send_gpint_command() - Sends a GPINT based command.
 547  * @dmub: the dmub service
 548  * @command_code: the command code to send
 549  * @param: the command parameter to send
 550  * @timeout_us: the maximum number of microseconds to wait
 551  *
 552  * Sends a command via the general purpose interrupt (GPINT).
 553  * Waits for the number of microseconds specified by timeout_us
 554  * for the command ACK before returning.
 555  *
 556  * Can be called after software initialization.
 557  *
 558  * Return:
 559  *   DMUB_STATUS_OK - success
 560  *   DMUB_STATUS_TIMEOUT - wait for ACK timed out
 561  *   DMUB_STATUS_INVALID - unspecified error
 562  */
 563 enum dmub_status
 564 dmub_srv_send_gpint_command(struct dmub_srv *dmub,
 565                             enum dmub_gpint_command command_code,
 566                             uint16_t param, uint32_t timeout_us);
 567
 568 /**
 569  * dmub_srv_get_gpint_response() - Queries the GPINT response.
 570  * @dmub: the dmub service
 571  * @response: the response for the last GPINT
 572  *
 573  * Returns the response code for the last GPINT interrupt.
 574  *
 575  * Can be called after software initialization.
 576  *
 577  * Return:
 578  *   DMUB_STATUS_OK - success
 579  *   DMUB_STATUS_INVALID - unspecified error
 580  */
 581 enum dmub_status dmub_srv_get_gpint_response(struct dmub_srv *dmub,
 582                                              uint32_t *response);
 583
 584 /**
 585  * dmub_flush_buffer_mem() - Read back entire frame buffer region.
 586  * This ensures that the write from x86 has been flushed and will not
 587  * hang the DMCUB.
 588  * @fb: frame buffer to flush
 589  *
 590  * Can be called after software initialization.
 591  */
 592 void dmub_flush_buffer_mem(const struct dmub_fb *fb);
 593
 594 #if defined(__cplusplus)
 595 }
 596 #endif
 597
 598 #endif /* _DMUB_SRV_H_ */