display/dmub/dmub_srv.h

36  * This interface is not thread-safe. Ensure that all access to the interface
77 /* enum dmub_status - return code for dmcub functions */
86 /* enum dmub_asic - dmub asic identifier */
97 /* enum dmub_window_id - dmub window identifier */
111  * struct dmub_region - dmub hw memory region
121  * struct dmub_window - dmub hw cache window
131  * struct dmub_fb - defines a dmub framebuffer memory region
143  * struct dmub_srv_region_params - params used for calculating dmub regions
147  * @fw_bss_data: raw firmware bss data section
158  * struct dmub_srv_region_info - output region info from the dmub service
167  * size = reg.top - reg.base
179  * struct dmub_srv_fb_params - parameters used for driver fb setup
191  * struct dmub_srv_fb_info - output fb info from the dmub service
209  * struct dmub_srv_base_funcs - Driver specific base callbacks
217 	 * Return: The 32-bit register value from the given address.
230  * struct dmub_srv_hw_funcs - hardware sequencer funcs for dmub
281  * struct dmub_srv_create_params - params for dmub service creation
286  * @fw_version: the current firmware version, if any
299  * struct dmub_srv_hw_params - params for dmub hardware initialization
315  * struct dmub_srv - software state for dmcub
318  * @fw_version: the current firmware version, if any
320  * @fw_state: dmub firmware state pointer
346  * DMUB firmware version helper macro - useful for checking if the version
347  * of a firmware to know if feature or functionality is supported or present.
353  * dmub_srv_create() - creates the DMUB service.
358  *   DMUB_STATUS_OK - success
359  *   DMUB_STATUS_INVALID - unspecified error
365  * dmub_srv_destroy() - destroys the DMUB service.
371  * dmub_srv_calc_region_info() - retreives region info from the dmub service
380  *   DMUB_STATUS_OK - success
381  *   DMUB_STATUS_INVALID - unspecified error
389  * dmub_srv_calc_region_info() - retreives fb info from the dmub service
398  *   DMUB_STATUS_OK - success
399  *   DMUB_STATUS_INVALID - unspecified error
406  * dmub_srv_has_hw_support() - returns hw support state for dmcub
415  *   DMUB_STATUS_OK - success
416  *   DMUB_STATUS_INVALID - unspecified error
422  * dmub_srv_is_hw_init() - returns hardware init state
425  *   DMUB_STATUS_OK - success
426  *   DMUB_STATUS_INVALID - unspecified error
431  * dmub_srv_hw_init() - initializes the underlying DMUB hardware
439  *   DMUB_STATUS_OK - success
440  *   DMUB_STATUS_NO_CTX - dmcub context not initialized
441  *   DMUB_STATUS_INVALID - unspecified error
447  * dmub_srv_hw_reset() - puts the DMUB hardware in reset state if initialized
453  * A subsequent call to dmub_srv_hw_init() will re-enable the DMCUB.
456  *   DMUB_STATUS_OK - success
457  *   DMUB_STATUS_INVALID - unspecified error
462  * dmub_srv_cmd_queue() - queues a command to the DMUB
470  *   DMUB_STATUS_OK - success
471  *   DMUB_STATUS_QUEUE_FULL - no remaining room in queue
472  *   DMUB_STATUS_INVALID - unspecified error
478  * dmub_srv_cmd_execute() - Executes a queued sequence to the dmub
484  *   DMUB_STATUS_OK - success
485  *   DMUB_STATUS_INVALID - unspecified error
490  * dmub_srv_wait_for_auto_load() - Waits for firmware auto load to complete
494  * Waits until firmware has been autoloaded by the DMCUB. The maximum
497  * On ASICs without firmware autoload support this function will return
501  *   DMUB_STATUS_OK - success
502  *   DMUB_STATUS_TIMEOUT - wait for phy init timed out
503  *   DMUB_STATUS_INVALID - unspecified error
509  * dmub_srv_wait_for_phy_init() - Waits for DMUB PHY init to complete
513  * Waits until the PHY has been initialized by the DMUB. The maximum
520  *   DMUB_STATUS_OK - success
521  *   DMUB_STATUS_TIMEOUT - wait for phy init timed out
522  *   DMUB_STATUS_INVALID - unspecified error
528  * dmub_srv_wait_for_idle() - Waits for the DMUB to be idle
537  *   DMUB_STATUS_OK - success
538  *   DMUB_STATUS_TIMEOUT - wait for buffer to flush timed out
539  *   DMUB_STATUS_INVALID - unspecified error
545  * dmub_srv_send_gpint_command() - Sends a GPINT based command.
558  *   DMUB_STATUS_OK - success
559  *   DMUB_STATUS_TIMEOUT - wait for ACK timed out
560  *   DMUB_STATUS_INVALID - unspecified error
568  * dmub_srv_get_gpint_response() - Queries the GPINT response.
577  *   DMUB_STATUS_OK - success
578  *   DMUB_STATUS_INVALID - unspecified error
584  * dmub_flush_buffer_mem() - Read back entire frame buffer region.