display/dmub/dmub_srv.h

36  * This interface is not thread-safe. Ensure that all access to the interface
81 /* enum dmub_status - return code for dmcub functions */
92 /* enum dmub_asic - dmub asic identifier */
112 /* enum dmub_window_id - dmub window identifier */
125 /* enum dmub_notification_type - dmub outbox notification identifier */
147 /* enum dmub_memory_access_type - memory access method */
154 /* enum dmub_power_state type - to track DC power state in dmub_srv */
162  * struct dmub_region - dmub hw memory region
172  * struct dmub_window - dmub hw cache window
182  * struct dmub_fb - defines a dmub framebuffer memory region
194  * struct dmub_srv_region_params - params used for calculating dmub regions
210  * struct dmub_srv_region_info - output region info from the dmub service
219  * size = reg.top - reg.base
232  * struct dmub_srv_memory_params - parameters used for driver fb setup
248  * struct dmub_srv_fb_info - output fb info from the dmub service
266  * struct dmub_srv_hw_params - params for dmub hardware initialization
294  * struct dmub_diagnostic_data - Diagnostic data retrieved from DMCUB for
300 	uint32_t pc;  member
320  * struct dmub_srv_base_funcs - Driver specific base callbacks
328 	 * Return: The 32-bit register value from the given address.
341  * struct dmub_srv_hw_funcs - hardware sequencer funcs for dmub
434  * struct dmub_srv_create_params - params for dmub service creation
453  * struct dmub_srv - software state for dmcub
501  * struct dmub_notification - dmub notification data
527  * DMUB firmware version helper macro - useful for checking if the version
534  * dmub_srv_create() - creates the DMUB service.
539  *   DMUB_STATUS_OK - success
540  *   DMUB_STATUS_INVALID - unspecified error
546  * dmub_srv_destroy() - destroys the DMUB service.
552  * dmub_srv_calc_region_info() - retreives region info from the dmub service
561  *   DMUB_STATUS_OK - success
562  *   DMUB_STATUS_INVALID - unspecified error
570  * dmub_srv_calc_region_info() - retreives fb info from the dmub service
579  *   DMUB_STATUS_OK - success
580  *   DMUB_STATUS_INVALID - unspecified error
587  * dmub_srv_has_hw_support() - returns hw support state for dmcub
596  *   DMUB_STATUS_OK - success
597  *   DMUB_STATUS_INVALID - unspecified error
603  * dmub_srv_is_hw_init() - returns hardware init state
606  *   DMUB_STATUS_OK - success
607  *   DMUB_STATUS_INVALID - unspecified error
612  * dmub_srv_hw_init() - initializes the underlying DMUB hardware
620  *   DMUB_STATUS_OK - success
621  *   DMUB_STATUS_NO_CTX - dmcub context not initialized
622  *   DMUB_STATUS_INVALID - unspecified error
628  * dmub_srv_hw_reset() - puts the DMUB hardware in reset state if initialized
634  * A subsequent call to dmub_srv_hw_init() will re-enable the DMCUB.
637  *   DMUB_STATUS_OK - success
638  *   DMUB_STATUS_INVALID - unspecified error
643  * dmub_srv_sync_inbox1() - sync sw state with hw state
649  *   DMUB_STATUS_OK - success
650  *   DMUB_STATUS_INVALID - unspecified error
655  * dmub_srv_cmd_queue() - queues a command to the DMUB
663  *   DMUB_STATUS_OK - success
664  *   DMUB_STATUS_QUEUE_FULL - no remaining room in queue
665  *   DMUB_STATUS_INVALID - unspecified error
671  * dmub_srv_cmd_execute() - Executes a queued sequence to the dmub
677  *   DMUB_STATUS_OK - success
678  *   DMUB_STATUS_INVALID - unspecified error
683  * dmub_srv_wait_for_hw_pwr_up() - Waits for firmware hardware power up is completed
691  *   DMUB_STATUS_OK - success
692  *   DMUB_STATUS_TIMEOUT - timed out
693  *   DMUB_STATUS_INVALID - unspecified error
701  * dmub_srv_wait_for_auto_load() - Waits for firmware auto load to complete
712  *   DMUB_STATUS_OK - success
713  *   DMUB_STATUS_TIMEOUT - wait for phy init timed out
714  *   DMUB_STATUS_INVALID - unspecified error
720  * dmub_srv_wait_for_phy_init() - Waits for DMUB PHY init to complete
731  *   DMUB_STATUS_OK - success
732  *   DMUB_STATUS_TIMEOUT - wait for phy init timed out
733  *   DMUB_STATUS_INVALID - unspecified error
739  * dmub_srv_wait_for_idle() - Waits for the DMUB to be idle
748  *   DMUB_STATUS_OK - success
749  *   DMUB_STATUS_TIMEOUT - wait for buffer to flush timed out
750  *   DMUB_STATUS_INVALID - unspecified error
756  * dmub_srv_send_gpint_command() - Sends a GPINT based command.
764  * for the command ACK before returning.
769  *   DMUB_STATUS_OK - success
770  *   DMUB_STATUS_TIMEOUT - wait for ACK timed out
771  *   DMUB_STATUS_INVALID - unspecified error
779  * dmub_srv_get_gpint_response() - Queries the GPINT response.
788  *   DMUB_STATUS_OK - success
789  *   DMUB_STATUS_INVALID - unspecified error
795  * dmub_srv_get_gpint_dataout() - Queries the GPINT DATAOUT.
804  *   DMUB_STATUS_OK - success
805  *   DMUB_STATUS_INVALID - unspecified error
811  * dmub_flush_buffer_mem() - Read back entire frame buffer region.
821  * dmub_srv_get_fw_boot_status() - Returns the DMUB boot status bits.
827  *   DMUB_STATUS_OK - success
828  *   DMUB_STATUS_INVALID - unspecified error, unsupported
849  * dmub_srv_send_inbox0_cmd() - Send command to DMUB using INBOX0
856  *   DMUB_STATUS_OK - success
857  *   DMUB_STATUS_INVALID - hw_init false or hw function does not exist
862  * dmub_srv_wait_for_inbox0_ack() - wait for DMUB to ACK INBOX0 command
866  * Wait for DMUB to ACK the INBOX0 message
869  *   DMUB_STATUS_OK - success
870  *   DMUB_STATUS_INVALID - hw_init false or hw function does not exist
871  *   DMUB_STATUS_TIMEOUT - wait for ack timed out
876  * dmub_srv_wait_for_inbox0_ack() - clear ACK register for INBOX0
879  * Clear ACK register for INBOX0
882  *   DMUB_STATUS_OK - success
883  *   DMUB_STATUS_INVALID - hw_init false or hw function does not exist
888  * dmub_srv_subvp_save_surf_addr() - Save primary and meta address for subvp on each flip
903  * dmub_srv_set_power_state() - Track DC power state in dmub_srv