display/dmub/dmub_srv.h

36  * This interface is not thread-safe. Ensure that all access to the interface
58  * wait until the queue has been cleared.
61  * This does not clear DMUB hardware state, only software state.
82 /* enum dmub_window_memory_type - memory location type specification for windows */
88 /* enum dmub_status - return code for dmcub functions */
99 /* enum dmub_asic - dmub asic identifier */
122 /* enum dmub_window_id - dmub window identifier */
136 /* enum dmub_notification_type - dmub outbox notification identifier */
159 /* enum dmub_memory_access_type - memory access method */
166 /* enum dmub_power_state type - to track DC power state in dmub_srv */
174  * struct dmub_region - dmub hw memory region
184  * struct dmub_window - dmub hw cache window
194  * struct dmub_fb - defines a dmub framebuffer memory region
206  * struct dmub_srv_region_params - params used for calculating dmub regions
222  * struct dmub_srv_region_info - output region info from the dmub service
231  * size = reg.top - reg.base
244  * struct dmub_srv_memory_params - parameters used for driver fb setup
261  * struct dmub_srv_fb_info - output fb info from the dmub service
279  * struct dmub_srv_hw_params - params for dmub hardware initialization
312  * struct dmub_srv_debug - Debug info for dmub_srv
314  * @timeout_cmd: first cmd sent from driver that timed out - subsequent timeouts are not stored
323  * struct dmub_diagnostic_data - Diagnostic data retrieved from DMCUB for
353  * struct dmub_srv_base_funcs - Driver specific base callbacks
361 	 * Return: The 32-bit register value from the given address.
374  * struct dmub_srv_hw_funcs - hardware sequencer funcs for dmub
481  * struct dmub_srv_create_params - params for dmub service creation
499  * struct dmub_srv - software state for dmcub
504  * @shared_state: dmub shared state between firmware and driver
505  * @fw_state: dmub firmware state pointer
551  * struct dmub_notification - dmub notification data
577 /* enum dmub_ips_mode - IPS mode identifier */
586  * DMUB firmware version helper macro - useful for checking if the version
593  * dmub_srv_create() - creates the DMUB service.
598  *   DMUB_STATUS_OK - success
599  *   DMUB_STATUS_INVALID - unspecified error
605  * dmub_srv_destroy() - destroys the DMUB service.
611  * dmub_srv_calc_region_info() - retreives region info from the dmub service
620  *   DMUB_STATUS_OK - success
621  *   DMUB_STATUS_INVALID - unspecified error
629  * dmub_srv_calc_region_info() - retreives fb info from the dmub service
638  *   DMUB_STATUS_OK - success
639  *   DMUB_STATUS_INVALID - unspecified error
646  * dmub_srv_has_hw_support() - returns hw support state for dmcub
648  * @is_supported: hw support state
655  *   DMUB_STATUS_OK - success
656  *   DMUB_STATUS_INVALID - unspecified error
662  * dmub_srv_is_hw_init() - returns hardware init state
665  *   DMUB_STATUS_OK - success
666  *   DMUB_STATUS_INVALID - unspecified error
671  * dmub_srv_hw_init() - initializes the underlying DMUB hardware
679  *   DMUB_STATUS_OK - success
680  *   DMUB_STATUS_NO_CTX - dmcub context not initialized
681  *   DMUB_STATUS_INVALID - unspecified error
687  * dmub_srv_hw_reset() - puts the DMUB hardware in reset state if initialized
693  * A subsequent call to dmub_srv_hw_init() will re-enable the DMCUB.
696  *   DMUB_STATUS_OK - success
697  *   DMUB_STATUS_INVALID - unspecified error
702  * dmub_srv_sync_inbox1() - sync sw state with hw state
705  * Sync sw state with hw state when resume from S0i3
708  *   DMUB_STATUS_OK - success
709  *   DMUB_STATUS_INVALID - unspecified error
714  * dmub_srv_cmd_queue() - queues a command to the DMUB
722  *   DMUB_STATUS_OK - success
723  *   DMUB_STATUS_QUEUE_FULL - no remaining room in queue
724  *   DMUB_STATUS_INVALID - unspecified error
730  * dmub_srv_cmd_execute() - Executes a queued sequence to the dmub
736  *   DMUB_STATUS_OK - success
737  *   DMUB_STATUS_INVALID - unspecified error
742  * dmub_srv_wait_for_hw_pwr_up() - Waits for firmware hardware power up is completed
744  * @timeout_us: the maximum number of microseconds to wait
747  * wait time is given in microseconds to prevent spinning forever.
750  *   DMUB_STATUS_OK - success
751  *   DMUB_STATUS_TIMEOUT - timed out
752  *   DMUB_STATUS_INVALID - unspecified error
760  * dmub_srv_wait_for_auto_load() - Waits for firmware auto load to complete
762  * @timeout_us: the maximum number of microseconds to wait
765  * wait time is given in microseconds to prevent spinning forever.
771  *   DMUB_STATUS_OK - success
772  *   DMUB_STATUS_TIMEOUT - wait for phy init timed out
773  *   DMUB_STATUS_INVALID - unspecified error
779  * dmub_srv_wait_for_phy_init() - Waits for DMUB PHY init to complete
781  * @timeout_us: the maximum number of microseconds to wait
784  * wait time is given in microseconds to prevent spinning forever.
790  *   DMUB_STATUS_OK - success
791  *   DMUB_STATUS_TIMEOUT - wait for phy init timed out
792  *   DMUB_STATUS_INVALID - unspecified error
798  * dmub_srv_wait_for_idle() - Waits for the DMUB to be idle
800  * @timeout_us: the maximum number of microseconds to wait
803  * finished processing. The maximum wait time is given in
807  *   DMUB_STATUS_OK - success
808  *   DMUB_STATUS_TIMEOUT - wait for buffer to flush timed out
809  *   DMUB_STATUS_INVALID - unspecified error
815  * dmub_srv_send_gpint_command() - Sends a GPINT based command.
819  * @timeout_us: the maximum number of microseconds to wait
828  *   DMUB_STATUS_OK - success
829  *   DMUB_STATUS_TIMEOUT - wait for ACK timed out
830  *   DMUB_STATUS_INVALID - unspecified error
838  * dmub_srv_get_gpint_response() - Queries the GPINT response.
847  *   DMUB_STATUS_OK - success
848  *   DMUB_STATUS_INVALID - unspecified error
854  * dmub_srv_get_gpint_dataout() - Queries the GPINT DATAOUT.
863  *   DMUB_STATUS_OK - success
864  *   DMUB_STATUS_INVALID - unspecified error
870  * dmub_flush_buffer_mem() - Read back entire frame buffer region.
880  * dmub_srv_get_fw_boot_status() - Returns the DMUB boot status bits.
886  *   DMUB_STATUS_OK - success
887  *   DMUB_STATUS_INVALID - unspecified error, unsupported
908  * dmub_srv_send_inbox0_cmd() - Send command to DMUB using INBOX0
915  *   DMUB_STATUS_OK - success
916  *   DMUB_STATUS_INVALID - hw_init false or hw function does not exist
921  * dmub_srv_wait_for_inbox0_ack() - wait for DMUB to ACK INBOX0 command
923  * @timeout_us: the maximum number of microseconds to wait
925  * Wait for DMUB to ACK the INBOX0 message
928  *   DMUB_STATUS_OK - success
929  *   DMUB_STATUS_INVALID - hw_init false or hw function does not exist
930  *   DMUB_STATUS_TIMEOUT - wait for ack timed out
935  * dmub_srv_wait_for_inbox0_ack() - clear ACK register for INBOX0
941  *   DMUB_STATUS_OK - success
942  *   DMUB_STATUS_INVALID - hw_init false or hw function does not exist
947  * dmub_srv_subvp_save_surf_addr() - Save primary and meta address for subvp on each flip
962  * dmub_srv_send_reg_inbox0_cmd() - send a dmub command and wait for the command
972  * DMUB_STATUS_OK - success
973  * DMUB_STATUS_TIMEOUT - DMUB fails to process the command within the timeout
982  * dmub_srv_set_power_state() - Track DC power state in dmub_srv
984  * @power_state: DC power state setting
986  * Store DC power state in dmub_srv.  If dmub_srv is in D3, then don't send messages to DMUB