display/dmub/dmub_srv.h

36  * This interface is not thread-safe. Ensure that all access to the interface
79 /* enum dmub_window_memory_type - memory location type specification for windows */
85 /* enum dmub_status - return code for dmcub functions */
96 /* enum dmub_asic - dmub asic identifier */
118 /* enum dmub_window_id - dmub window identifier */
132 /* enum dmub_notification_type - dmub outbox notification identifier */
155 /* enum dmub_memory_access_type - memory access method */
162 /* enum dmub_power_state type - to track DC power state in dmub_srv */
170  * struct dmub_region - dmub hw memory region
180  * struct dmub_window - dmub hw cache window
190  * struct dmub_fb - defines a dmub framebuffer memory region
202  * struct dmub_srv_region_params - params used for calculating dmub regions
218  * struct dmub_srv_region_info - output region info from the dmub service
227  * size = reg.top - reg.base
240  * struct dmub_srv_memory_params - parameters used for driver fb setup
257  * struct dmub_srv_fb_info - output fb info from the dmub service
275  * struct dmub_srv_hw_params - params for dmub hardware initialization
307  * struct dmub_srv_debug - Debug info for dmub_srv
309  * @timeout_cmd: first cmd sent from driver that timed out - subsequent timeouts are not stored
318  * struct dmub_diagnostic_data - Diagnostic data retrieved from DMCUB for
324 	uint32_t pc[DMUB_PC_SNAPSHOT_COUNT];  member
348  * struct dmub_srv_base_funcs - Driver specific base callbacks
356 	 * Return: The 32-bit register value from the given address.
369  * struct dmub_srv_hw_funcs - hardware sequencer funcs for dmub
476  * struct dmub_srv_create_params - params for dmub service creation
494  * struct dmub_srv - software state for dmcub
547  * struct dmub_notification - dmub notification data
574  * DMUB firmware version helper macro - useful for checking if the version
581  * dmub_srv_create() - creates the DMUB service.
586  *   DMUB_STATUS_OK - success
587  *   DMUB_STATUS_INVALID - unspecified error
593  * dmub_srv_destroy() - destroys the DMUB service.
599  * dmub_srv_calc_region_info() - retreives region info from the dmub service
608  *   DMUB_STATUS_OK - success
609  *   DMUB_STATUS_INVALID - unspecified error
617  * dmub_srv_calc_region_info() - retreives fb info from the dmub service
626  *   DMUB_STATUS_OK - success
627  *   DMUB_STATUS_INVALID - unspecified error
634  * dmub_srv_has_hw_support() - returns hw support state for dmcub
643  *   DMUB_STATUS_OK - success
644  *   DMUB_STATUS_INVALID - unspecified error
650  * dmub_srv_is_hw_init() - returns hardware init state
653  *   DMUB_STATUS_OK - success
654  *   DMUB_STATUS_INVALID - unspecified error
659  * dmub_srv_hw_init() - initializes the underlying DMUB hardware
667  *   DMUB_STATUS_OK - success
668  *   DMUB_STATUS_NO_CTX - dmcub context not initialized
669  *   DMUB_STATUS_INVALID - unspecified error
675  * dmub_srv_hw_reset() - puts the DMUB hardware in reset state if initialized
681  * A subsequent call to dmub_srv_hw_init() will re-enable the DMCUB.
684  *   DMUB_STATUS_OK - success
685  *   DMUB_STATUS_INVALID - unspecified error
690  * dmub_srv_sync_inbox1() - sync sw state with hw state
696  *   DMUB_STATUS_OK - success
697  *   DMUB_STATUS_INVALID - unspecified error
702  * dmub_srv_cmd_queue() - queues a command to the DMUB
710  *   DMUB_STATUS_OK - success
711  *   DMUB_STATUS_QUEUE_FULL - no remaining room in queue
712  *   DMUB_STATUS_INVALID - unspecified error
718  * dmub_srv_cmd_execute() - Executes a queued sequence to the dmub
724  *   DMUB_STATUS_OK - success
725  *   DMUB_STATUS_INVALID - unspecified error
730  * dmub_srv_wait_for_hw_pwr_up() - Waits for firmware hardware power up is completed
738  *   DMUB_STATUS_OK - success
739  *   DMUB_STATUS_TIMEOUT - timed out
740  *   DMUB_STATUS_INVALID - unspecified error
748  * dmub_srv_wait_for_auto_load() - Waits for firmware auto load to complete
759  *   DMUB_STATUS_OK - success
760  *   DMUB_STATUS_TIMEOUT - wait for phy init timed out
761  *   DMUB_STATUS_INVALID - unspecified error
767  * dmub_srv_wait_for_phy_init() - Waits for DMUB PHY init to complete
778  *   DMUB_STATUS_OK - success
779  *   DMUB_STATUS_TIMEOUT - wait for phy init timed out
780  *   DMUB_STATUS_INVALID - unspecified error
786  * dmub_srv_wait_for_idle() - Waits for the DMUB to be idle
795  *   DMUB_STATUS_OK - success
796  *   DMUB_STATUS_TIMEOUT - wait for buffer to flush timed out
797  *   DMUB_STATUS_INVALID - unspecified error
803  * dmub_srv_send_gpint_command() - Sends a GPINT based command.
811  * for the command ACK before returning.
816  *   DMUB_STATUS_OK - success
817  *   DMUB_STATUS_TIMEOUT - wait for ACK timed out
818  *   DMUB_STATUS_INVALID - unspecified error
826  * dmub_srv_get_gpint_response() - Queries the GPINT response.
835  *   DMUB_STATUS_OK - success
836  *   DMUB_STATUS_INVALID - unspecified error
842  * dmub_srv_get_gpint_dataout() - Queries the GPINT DATAOUT.
851  *   DMUB_STATUS_OK - success
852  *   DMUB_STATUS_INVALID - unspecified error
858  * dmub_flush_buffer_mem() - Read back entire frame buffer region.
868  * dmub_srv_get_fw_boot_status() - Returns the DMUB boot status bits.
874  *   DMUB_STATUS_OK - success
875  *   DMUB_STATUS_INVALID - unspecified error, unsupported
896  * dmub_srv_send_inbox0_cmd() - Send command to DMUB using INBOX0
903  *   DMUB_STATUS_OK - success
904  *   DMUB_STATUS_INVALID - hw_init false or hw function does not exist
909  * dmub_srv_wait_for_inbox0_ack() - wait for DMUB to ACK INBOX0 command
913  * Wait for DMUB to ACK the INBOX0 message
916  *   DMUB_STATUS_OK - success
917  *   DMUB_STATUS_INVALID - hw_init false or hw function does not exist
918  *   DMUB_STATUS_TIMEOUT - wait for ack timed out
923  * dmub_srv_wait_for_inbox0_ack() - clear ACK register for INBOX0
926  * Clear ACK register for INBOX0
929  *   DMUB_STATUS_OK - success
930  *   DMUB_STATUS_INVALID - hw_init false or hw function does not exist
935  * dmub_srv_subvp_save_surf_addr() - Save primary and meta address for subvp on each flip
950  * dmub_srv_send_reg_inbox0_cmd() - send a dmub command and wait for the command
960  * DMUB_STATUS_OK - success
961  * DMUB_STATUS_TIMEOUT - DMUB fails to process the command within the timeout
970  * dmub_srv_set_power_state() - Track DC power state in dmub_srv