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 struct dmub_srv_dcn31_regs;
77 
78 struct dmcub_trace_buf_entry;
79 
80 /* enum dmub_status - return code for dmcub functions */
81 enum dmub_status {
82 	DMUB_STATUS_OK = 0,
83 	DMUB_STATUS_NO_CTX,
84 	DMUB_STATUS_QUEUE_FULL,
85 	DMUB_STATUS_TIMEOUT,
86 	DMUB_STATUS_INVALID,
87 	DMUB_STATUS_HW_FAILURE,
88 };
89 
90 /* enum dmub_asic - dmub asic identifier */
91 enum dmub_asic {
92 	DMUB_ASIC_NONE = 0,
93 	DMUB_ASIC_DCN20,
94 	DMUB_ASIC_DCN21,
95 	DMUB_ASIC_DCN30,
96 	DMUB_ASIC_DCN301,
97 	DMUB_ASIC_DCN302,
98 	DMUB_ASIC_DCN303,
99 	DMUB_ASIC_DCN31,
100 	DMUB_ASIC_DCN31B,
101 	DMUB_ASIC_DCN314,
102 	DMUB_ASIC_DCN315,
103 	DMUB_ASIC_DCN316,
104 	DMUB_ASIC_DCN32,
105 	DMUB_ASIC_DCN321,
106 	DMUB_ASIC_MAX,
107 };
108 
109 /* enum dmub_window_id - dmub window identifier */
110 enum dmub_window_id {
111 	DMUB_WINDOW_0_INST_CONST = 0,
112 	DMUB_WINDOW_1_STACK,
113 	DMUB_WINDOW_2_BSS_DATA,
114 	DMUB_WINDOW_3_VBIOS,
115 	DMUB_WINDOW_4_MAILBOX,
116 	DMUB_WINDOW_5_TRACEBUFF,
117 	DMUB_WINDOW_6_FW_STATE,
118 	DMUB_WINDOW_7_SCRATCH_MEM,
119 	DMUB_WINDOW_TOTAL,
120 };
121 
122 /* enum dmub_notification_type - dmub outbox notification identifier */
123 enum dmub_notification_type {
124 	DMUB_NOTIFICATION_NO_DATA = 0,
125 	DMUB_NOTIFICATION_AUX_REPLY,
126 	DMUB_NOTIFICATION_HPD,
127 	DMUB_NOTIFICATION_HPD_IRQ,
128 	DMUB_NOTIFICATION_SET_CONFIG_REPLY,
129 	DMUB_NOTIFICATION_MAX
130 };
131 
132 /**
133  * struct dmub_region - dmub hw memory region
134  * @base: base address for region, must be 256 byte aligned
135  * @top: top address for region
136  */
137 struct dmub_region {
138 	uint32_t base;
139 	uint32_t top;
140 };
141 
142 /**
143  * struct dmub_window - dmub hw cache window
144  * @off: offset to the fb memory in gpu address space
145  * @r: region in uc address space for cache window
146  */
147 struct dmub_window {
148 	union dmub_addr offset;
149 	struct dmub_region region;
150 };
151 
152 /**
153  * struct dmub_fb - defines a dmub framebuffer memory region
154  * @cpu_addr: cpu virtual address for the region, NULL if invalid
155  * @gpu_addr: gpu virtual address for the region, NULL if invalid
156  * @size: size of the region in bytes, zero if invalid
157  */
158 struct dmub_fb {
159 	void *cpu_addr;
160 	uint64_t gpu_addr;
161 	uint32_t size;
162 };
163 
164 /**
165  * struct dmub_srv_region_params - params used for calculating dmub regions
166  * @inst_const_size: size of the fw inst const section
167  * @bss_data_size: size of the fw bss data section
168  * @vbios_size: size of the vbios data
169  * @fw_bss_data: raw firmware bss data section
170  */
171 struct dmub_srv_region_params {
172 	uint32_t inst_const_size;
173 	uint32_t bss_data_size;
174 	uint32_t vbios_size;
175 	const uint8_t *fw_inst_const;
176 	const uint8_t *fw_bss_data;
177 };
178 
179 /**
180  * struct dmub_srv_region_info - output region info from the dmub service
181  * @fb_size: required minimum fb size for all regions, aligned to 4096 bytes
182  * @num_regions: number of regions used by the dmub service
183  * @regions: region info
184  *
185  * The regions are aligned such that they can be all placed within the
186  * same framebuffer but they can also be placed into different framebuffers.
187  *
188  * The size of each region can be calculated by the caller:
189  * size = reg.top - reg.base
190  *
191  * Care must be taken when performing custom allocations to ensure that each
192  * region base address is 256 byte aligned.
193  */
194 struct dmub_srv_region_info {
195 	uint32_t fb_size;
196 	uint8_t num_regions;
197 	struct dmub_region regions[DMUB_WINDOW_TOTAL];
198 };
199 
200 /**
201  * struct dmub_srv_fb_params - parameters used for driver fb setup
202  * @region_info: region info calculated by dmub service
203  * @cpu_addr: base cpu address for the framebuffer
204  * @gpu_addr: base gpu virtual address for the framebuffer
205  */
206 struct dmub_srv_fb_params {
207 	const struct dmub_srv_region_info *region_info;
208 	void *cpu_addr;
209 	uint64_t gpu_addr;
210 };
211 
212 /**
213  * struct dmub_srv_fb_info - output fb info from the dmub service
214  * @num_fbs: number of required dmub framebuffers
215  * @fbs: fb data for each region
216  *
217  * Output from the dmub service helper that can be used by the
218  * driver to prepare dmub_fb that can be passed into the dmub
219  * hw init service.
220  *
221  * Assumes that all regions are within the same framebuffer
222  * and have been setup according to the region_info generated
223  * by the dmub service.
224  */
225 struct dmub_srv_fb_info {
226 	uint8_t num_fb;
227 	struct dmub_fb fb[DMUB_WINDOW_TOTAL];
228 };
229 
230 /*
231  * struct dmub_srv_hw_params - params for dmub hardware initialization
232  * @fb: framebuffer info for each region
233  * @fb_base: base of the framebuffer aperture
234  * @fb_offset: offset of the framebuffer aperture
235  * @psp_version: psp version to pass for DMCU init
236  * @load_inst_const: true if DMUB should load inst const fw
237  */
238 struct dmub_srv_hw_params {
239 	struct dmub_fb *fb[DMUB_WINDOW_TOTAL];
240 	uint64_t fb_base;
241 	uint64_t fb_offset;
242 	uint32_t psp_version;
243 	bool load_inst_const;
244 	bool skip_panel_power_sequence;
245 	bool disable_z10;
246 	bool power_optimization;
247 	bool dpia_supported;
248 	bool disable_dpia;
249 	bool usb4_cm_version;
250 	bool fw_in_system_memory;
251 	bool dpia_hpd_int_enable_supported;
252 };
253 
254 /**
255  * struct dmub_diagnostic_data - Diagnostic data retrieved from DMCUB for
256  * debugging purposes, including logging, crash analysis, etc.
257  */
258 struct dmub_diagnostic_data {
259 	uint32_t dmcub_version;
260 	uint32_t scratch[16];
261 	uint32_t pc;
262 	uint32_t undefined_address_fault_addr;
263 	uint32_t inst_fetch_fault_addr;
264 	uint32_t data_write_fault_addr;
265 	uint32_t inbox1_rptr;
266 	uint32_t inbox1_wptr;
267 	uint32_t inbox1_size;
268 	uint32_t inbox0_rptr;
269 	uint32_t inbox0_wptr;
270 	uint32_t inbox0_size;
271 	uint8_t is_dmcub_enabled : 1;
272 	uint8_t is_dmcub_soft_reset : 1;
273 	uint8_t is_dmcub_secure_reset : 1;
274 	uint8_t is_traceport_en : 1;
275 	uint8_t is_cw0_enabled : 1;
276 	uint8_t is_cw6_enabled : 1;
277 };
278 
279 /**
280  * struct dmub_srv_base_funcs - Driver specific base callbacks
281  */
282 struct dmub_srv_base_funcs {
283 	/**
284 	 * @reg_read:
285 	 *
286 	 * Hook for reading a register.
287 	 *
288 	 * Return: The 32-bit register value from the given address.
289 	 */
290 	uint32_t (*reg_read)(void *ctx, uint32_t address);
291 
292 	/**
293 	 * @reg_write:
294 	 *
295 	 * Hook for writing a value to the register specified by address.
296 	 */
297 	void (*reg_write)(void *ctx, uint32_t address, uint32_t value);
298 };
299 
300 /**
301  * struct dmub_srv_hw_funcs - hardware sequencer funcs for dmub
302  */
303 struct dmub_srv_hw_funcs {
304 	/* private: internal use only */
305 
306 	void (*init)(struct dmub_srv *dmub);
307 
308 	void (*reset)(struct dmub_srv *dmub);
309 
310 	void (*reset_release)(struct dmub_srv *dmub);
311 
312 	void (*backdoor_load)(struct dmub_srv *dmub,
313 			      const struct dmub_window *cw0,
314 			      const struct dmub_window *cw1);
315 
316 	void (*backdoor_load_zfb_mode)(struct dmub_srv *dmub,
317 			      const struct dmub_window *cw0,
318 			      const struct dmub_window *cw1);
319 	void (*setup_windows)(struct dmub_srv *dmub,
320 			      const struct dmub_window *cw2,
321 			      const struct dmub_window *cw3,
322 			      const struct dmub_window *cw4,
323 			      const struct dmub_window *cw5,
324 			      const struct dmub_window *cw6);
325 
326 	void (*setup_mailbox)(struct dmub_srv *dmub,
327 			      const struct dmub_region *inbox1);
328 
329 	uint32_t (*get_inbox1_rptr)(struct dmub_srv *dmub);
330 
331 	void (*set_inbox1_wptr)(struct dmub_srv *dmub, uint32_t wptr_offset);
332 
333 	void (*setup_out_mailbox)(struct dmub_srv *dmub,
334 			      const struct dmub_region *outbox1);
335 
336 	uint32_t (*get_outbox1_wptr)(struct dmub_srv *dmub);
337 
338 	void (*set_outbox1_rptr)(struct dmub_srv *dmub, uint32_t rptr_offset);
339 
340 	void (*setup_outbox0)(struct dmub_srv *dmub,
341 			      const struct dmub_region *outbox0);
342 
343 	uint32_t (*get_outbox0_wptr)(struct dmub_srv *dmub);
344 
345 	void (*set_outbox0_rptr)(struct dmub_srv *dmub, uint32_t rptr_offset);
346 
347 	uint32_t (*emul_get_inbox1_rptr)(struct dmub_srv *dmub);
348 
349 	void (*emul_set_inbox1_wptr)(struct dmub_srv *dmub, uint32_t wptr_offset);
350 
351 	bool (*is_supported)(struct dmub_srv *dmub);
352 
353 	bool (*is_hw_init)(struct dmub_srv *dmub);
354 
355 	bool (*is_phy_init)(struct dmub_srv *dmub);
356 	void (*enable_dmub_boot_options)(struct dmub_srv *dmub,
357 				const struct dmub_srv_hw_params *params);
358 
359 	void (*skip_dmub_panel_power_sequence)(struct dmub_srv *dmub, bool skip);
360 
361 	union dmub_fw_boot_status (*get_fw_status)(struct dmub_srv *dmub);
362 
363 
364 	void (*set_gpint)(struct dmub_srv *dmub,
365 			  union dmub_gpint_data_register reg);
366 
367 	bool (*is_gpint_acked)(struct dmub_srv *dmub,
368 			       union dmub_gpint_data_register reg);
369 
370 	uint32_t (*get_gpint_response)(struct dmub_srv *dmub);
371 
372 	uint32_t (*get_gpint_dataout)(struct dmub_srv *dmub);
373 
374 	void (*configure_dmub_in_system_memory)(struct dmub_srv *dmub);
375 	void (*clear_inbox0_ack_register)(struct dmub_srv *dmub);
376 	uint32_t (*read_inbox0_ack_register)(struct dmub_srv *dmub);
377 	void (*send_inbox0_cmd)(struct dmub_srv *dmub, union dmub_inbox0_data_register data);
378 	uint32_t (*get_current_time)(struct dmub_srv *dmub);
379 
380 	void (*get_diagnostic_data)(struct dmub_srv *dmub, struct dmub_diagnostic_data *dmub_oca);
381 
382 	bool (*should_detect)(struct dmub_srv *dmub);
383 };
384 
385 /**
386  * struct dmub_srv_create_params - params for dmub service creation
387  * @base_funcs: driver supplied base routines
388  * @hw_funcs: optional overrides for hw funcs
389  * @user_ctx: context data for callback funcs
390  * @asic: driver supplied asic
391  * @fw_version: the current firmware version, if any
392  * @is_virtual: false for hw support only
393  */
394 struct dmub_srv_create_params {
395 	struct dmub_srv_base_funcs funcs;
396 	struct dmub_srv_hw_funcs *hw_funcs;
397 	void *user_ctx;
398 	enum dmub_asic asic;
399 	uint32_t fw_version;
400 	bool is_virtual;
401 };
402 
403 /**
404  * struct dmub_srv - software state for dmcub
405  * @asic: dmub asic identifier
406  * @user_ctx: user provided context for the dmub_srv
407  * @fw_version: the current firmware version, if any
408  * @is_virtual: false if hardware support only
409  * @fw_state: dmub firmware state pointer
410  */
411 struct dmub_srv {
412 	enum dmub_asic asic;
413 	void *user_ctx;
414 	uint32_t fw_version;
415 	bool is_virtual;
416 	struct dmub_fb scratch_mem_fb;
417 	volatile const struct dmub_fw_state *fw_state;
418 
419 	/* private: internal use only */
420 	const struct dmub_srv_common_regs *regs;
421 	const struct dmub_srv_dcn31_regs *regs_dcn31;
422 	const struct dmub_srv_dcn32_regs *regs_dcn32;
423 
424 	struct dmub_srv_base_funcs funcs;
425 	struct dmub_srv_hw_funcs hw_funcs;
426 	struct dmub_rb inbox1_rb;
427 	uint32_t inbox1_last_wptr;
428 	/**
429 	 * outbox1_rb is accessed without locks (dal & dc)
430 	 * and to be used only in dmub_srv_stat_get_notification()
431 	 */
432 	struct dmub_rb outbox1_rb;
433 
434 	struct dmub_rb outbox0_rb;
435 
436 	bool sw_init;
437 	bool hw_init;
438 
439 	uint64_t fb_base;
440 	uint64_t fb_offset;
441 	uint32_t psp_version;
442 
443 	/* Feature capabilities reported by fw */
444 	struct dmub_feature_caps feature_caps;
445 	struct dmub_visual_confirm_color visual_confirm_color;
446 };
447 
448 /**
449  * struct dmub_notification - dmub notification data
450  * @type: dmub notification type
451  * @link_index: link index to identify aux connection
452  * @result: USB4 status returned from dmub
453  * @pending_notification: Indicates there are other pending notifications
454  * @aux_reply: aux reply
455  * @hpd_status: hpd status
456  */
457 struct dmub_notification {
458 	enum dmub_notification_type type;
459 	uint8_t link_index;
460 	uint8_t result;
461 	bool pending_notification;
462 	union {
463 		struct aux_reply_data aux_reply;
464 		enum dp_hpd_status hpd_status;
465 		enum set_config_status sc_status;
466 	};
467 };
468 
469 /**
470  * DMUB firmware version helper macro - useful for checking if the version
471  * of a firmware to know if feature or functionality is supported or present.
472  */
473 #define DMUB_FW_VERSION(major, minor, revision) \
474 	((((major) & 0xFF) << 24) | (((minor) & 0xFF) << 16) | ((revision) & 0xFFFF))
475 
476 /**
477  * dmub_srv_create() - creates the DMUB service.
478  * @dmub: the dmub service
479  * @params: creation parameters for the service
480  *
481  * Return:
482  *   DMUB_STATUS_OK - success
483  *   DMUB_STATUS_INVALID - unspecified error
484  */
485 enum dmub_status dmub_srv_create(struct dmub_srv *dmub,
486 				 const struct dmub_srv_create_params *params);
487 
488 /**
489  * dmub_srv_destroy() - destroys the DMUB service.
490  * @dmub: the dmub service
491  */
492 void dmub_srv_destroy(struct dmub_srv *dmub);
493 
494 /**
495  * dmub_srv_calc_region_info() - retreives region info from the dmub service
496  * @dmub: the dmub service
497  * @params: parameters used to calculate region locations
498  * @info_out: the output region info from dmub
499  *
500  * Calculates the base and top address for all relevant dmub regions
501  * using the parameters given (if any).
502  *
503  * Return:
504  *   DMUB_STATUS_OK - success
505  *   DMUB_STATUS_INVALID - unspecified error
506  */
507 enum dmub_status
508 dmub_srv_calc_region_info(struct dmub_srv *dmub,
509 			  const struct dmub_srv_region_params *params,
510 			  struct dmub_srv_region_info *out);
511 
512 /**
513  * dmub_srv_calc_region_info() - retreives fb info from the dmub service
514  * @dmub: the dmub service
515  * @params: parameters used to calculate fb locations
516  * @info_out: the output fb info from dmub
517  *
518  * Calculates the base and top address for all relevant dmub regions
519  * using the parameters given (if any).
520  *
521  * Return:
522  *   DMUB_STATUS_OK - success
523  *   DMUB_STATUS_INVALID - unspecified error
524  */
525 enum dmub_status dmub_srv_calc_fb_info(struct dmub_srv *dmub,
526 				       const struct dmub_srv_fb_params *params,
527 				       struct dmub_srv_fb_info *out);
528 
529 /**
530  * dmub_srv_has_hw_support() - returns hw support state for dmcub
531  * @dmub: the dmub service
532  * @is_supported: hw support state
533  *
534  * Queries the hardware for DMCUB support and returns the result.
535  *
536  * Can be called before dmub_srv_hw_init().
537  *
538  * Return:
539  *   DMUB_STATUS_OK - success
540  *   DMUB_STATUS_INVALID - unspecified error
541  */
542 enum dmub_status dmub_srv_has_hw_support(struct dmub_srv *dmub,
543 					 bool *is_supported);
544 
545 /**
546  * dmub_srv_is_hw_init() - returns hardware init state
547  *
548  * Return:
549  *   DMUB_STATUS_OK - success
550  *   DMUB_STATUS_INVALID - unspecified error
551  */
552 enum dmub_status dmub_srv_is_hw_init(struct dmub_srv *dmub, bool *is_hw_init);
553 
554 /**
555  * dmub_srv_hw_init() - initializes the underlying DMUB hardware
556  * @dmub: the dmub service
557  * @params: params for hardware initialization
558  *
559  * Resets the DMUB hardware and performs backdoor loading of the
560  * required cache regions based on the input framebuffer regions.
561  *
562  * Return:
563  *   DMUB_STATUS_OK - success
564  *   DMUB_STATUS_NO_CTX - dmcub context not initialized
565  *   DMUB_STATUS_INVALID - unspecified error
566  */
567 enum dmub_status dmub_srv_hw_init(struct dmub_srv *dmub,
568 				  const struct dmub_srv_hw_params *params);
569 
570 /**
571  * dmub_srv_hw_reset() - puts the DMUB hardware in reset state if initialized
572  * @dmub: the dmub service
573  *
574  * Before destroying the DMUB service or releasing the backing framebuffer
575  * memory we'll need to put the DMCUB into reset first.
576  *
577  * A subsequent call to dmub_srv_hw_init() will re-enable the DMCUB.
578  *
579  * Return:
580  *   DMUB_STATUS_OK - success
581  *   DMUB_STATUS_INVALID - unspecified error
582  */
583 enum dmub_status dmub_srv_hw_reset(struct dmub_srv *dmub);
584 
585 /**
586  * dmub_srv_cmd_queue() - queues a command to the DMUB
587  * @dmub: the dmub service
588  * @cmd: the command to queue
589  *
590  * Queues a command to the DMUB service but does not begin execution
591  * immediately.
592  *
593  * Return:
594  *   DMUB_STATUS_OK - success
595  *   DMUB_STATUS_QUEUE_FULL - no remaining room in queue
596  *   DMUB_STATUS_INVALID - unspecified error
597  */
598 enum dmub_status dmub_srv_cmd_queue(struct dmub_srv *dmub,
599 				    const union dmub_rb_cmd *cmd);
600 
601 /**
602  * dmub_srv_cmd_execute() - Executes a queued sequence to the dmub
603  * @dmub: the dmub service
604  *
605  * Begins execution of queued commands on the dmub.
606  *
607  * Return:
608  *   DMUB_STATUS_OK - success
609  *   DMUB_STATUS_INVALID - unspecified error
610  */
611 enum dmub_status dmub_srv_cmd_execute(struct dmub_srv *dmub);
612 
613 /**
614  * dmub_srv_wait_for_auto_load() - Waits for firmware auto load to complete
615  * @dmub: the dmub service
616  * @timeout_us: the maximum number of microseconds to wait
617  *
618  * Waits until firmware has been autoloaded by the DMCUB. The maximum
619  * wait time is given in microseconds to prevent spinning forever.
620  *
621  * On ASICs without firmware autoload support this function will return
622  * immediately.
623  *
624  * Return:
625  *   DMUB_STATUS_OK - success
626  *   DMUB_STATUS_TIMEOUT - wait for phy init timed out
627  *   DMUB_STATUS_INVALID - unspecified error
628  */
629 enum dmub_status dmub_srv_wait_for_auto_load(struct dmub_srv *dmub,
630 					     uint32_t timeout_us);
631 
632 /**
633  * dmub_srv_wait_for_phy_init() - Waits for DMUB PHY init to complete
634  * @dmub: the dmub service
635  * @timeout_us: the maximum number of microseconds to wait
636  *
637  * Waits until the PHY has been initialized by the DMUB. The maximum
638  * wait time is given in microseconds to prevent spinning forever.
639  *
640  * On ASICs without PHY init support this function will return
641  * immediately.
642  *
643  * Return:
644  *   DMUB_STATUS_OK - success
645  *   DMUB_STATUS_TIMEOUT - wait for phy init timed out
646  *   DMUB_STATUS_INVALID - unspecified error
647  */
648 enum dmub_status dmub_srv_wait_for_phy_init(struct dmub_srv *dmub,
649 					    uint32_t timeout_us);
650 
651 /**
652  * dmub_srv_wait_for_idle() - Waits for the DMUB to be idle
653  * @dmub: the dmub service
654  * @timeout_us: the maximum number of microseconds to wait
655  *
656  * Waits until the DMUB buffer is empty and all commands have
657  * finished processing. The maximum wait time is given in
658  * microseconds to prevent spinning forever.
659  *
660  * Return:
661  *   DMUB_STATUS_OK - success
662  *   DMUB_STATUS_TIMEOUT - wait for buffer to flush timed out
663  *   DMUB_STATUS_INVALID - unspecified error
664  */
665 enum dmub_status dmub_srv_wait_for_idle(struct dmub_srv *dmub,
666 					uint32_t timeout_us);
667 
668 /**
669  * dmub_srv_send_gpint_command() - Sends a GPINT based command.
670  * @dmub: the dmub service
671  * @command_code: the command code to send
672  * @param: the command parameter to send
673  * @timeout_us: the maximum number of microseconds to wait
674  *
675  * Sends a command via the general purpose interrupt (GPINT).
676  * Waits for the number of microseconds specified by timeout_us
677  * for the command ACK before returning.
678  *
679  * Can be called after software initialization.
680  *
681  * Return:
682  *   DMUB_STATUS_OK - success
683  *   DMUB_STATUS_TIMEOUT - wait for ACK timed out
684  *   DMUB_STATUS_INVALID - unspecified error
685  */
686 enum dmub_status
687 dmub_srv_send_gpint_command(struct dmub_srv *dmub,
688 			    enum dmub_gpint_command command_code,
689 			    uint16_t param, uint32_t timeout_us);
690 
691 /**
692  * dmub_srv_get_gpint_response() - Queries the GPINT response.
693  * @dmub: the dmub service
694  * @response: the response for the last GPINT
695  *
696  * Returns the response code for the last GPINT interrupt.
697  *
698  * Can be called after software initialization.
699  *
700  * Return:
701  *   DMUB_STATUS_OK - success
702  *   DMUB_STATUS_INVALID - unspecified error
703  */
704 enum dmub_status dmub_srv_get_gpint_response(struct dmub_srv *dmub,
705 					     uint32_t *response);
706 
707 /**
708  * dmub_srv_get_gpint_dataout() - Queries the GPINT DATAOUT.
709  * @dmub: the dmub service
710  * @dataout: the data for the GPINT DATAOUT
711  *
712  * Returns the response code for the last GPINT DATAOUT interrupt.
713  *
714  * Can be called after software initialization.
715  *
716  * Return:
717  *   DMUB_STATUS_OK - success
718  *   DMUB_STATUS_INVALID - unspecified error
719  */
720 enum dmub_status dmub_srv_get_gpint_dataout(struct dmub_srv *dmub,
721 					     uint32_t *dataout);
722 
723 /**
724  * dmub_flush_buffer_mem() - Read back entire frame buffer region.
725  * This ensures that the write from x86 has been flushed and will not
726  * hang the DMCUB.
727  * @fb: frame buffer to flush
728  *
729  * Can be called after software initialization.
730  */
731 void dmub_flush_buffer_mem(const struct dmub_fb *fb);
732 
733 /**
734  * dmub_srv_get_fw_boot_status() - Returns the DMUB boot status bits.
735  *
736  * @dmub: the dmub service
737  * @status: out pointer for firmware status
738  *
739  * Return:
740  *   DMUB_STATUS_OK - success
741  *   DMUB_STATUS_INVALID - unspecified error, unsupported
742  */
743 enum dmub_status dmub_srv_get_fw_boot_status(struct dmub_srv *dmub,
744 					     union dmub_fw_boot_status *status);
745 
746 enum dmub_status dmub_srv_cmd_with_reply_data(struct dmub_srv *dmub,
747 					      union dmub_rb_cmd *cmd);
748 
749 bool dmub_srv_get_outbox0_msg(struct dmub_srv *dmub, struct dmcub_trace_buf_entry *entry);
750 
751 bool dmub_srv_get_diagnostic_data(struct dmub_srv *dmub, struct dmub_diagnostic_data *diag_data);
752 
753 bool dmub_srv_should_detect(struct dmub_srv *dmub);
754 
755 /**
756  * dmub_srv_send_inbox0_cmd() - Send command to DMUB using INBOX0
757  * @dmub: the dmub service
758  * @data: the data to be sent in the INBOX0 command
759  *
760  * Send command by writing directly to INBOX0 WPTR
761  *
762  * Return:
763  *   DMUB_STATUS_OK - success
764  *   DMUB_STATUS_INVALID - hw_init false or hw function does not exist
765  */
766 enum dmub_status dmub_srv_send_inbox0_cmd(struct dmub_srv *dmub, union dmub_inbox0_data_register data);
767 
768 /**
769  * dmub_srv_wait_for_inbox0_ack() - wait for DMUB to ACK INBOX0 command
770  * @dmub: the dmub service
771  * @timeout_us: the maximum number of microseconds to wait
772  *
773  * Wait for DMUB to ACK the INBOX0 message
774  *
775  * Return:
776  *   DMUB_STATUS_OK - success
777  *   DMUB_STATUS_INVALID - hw_init false or hw function does not exist
778  *   DMUB_STATUS_TIMEOUT - wait for ack timed out
779  */
780 enum dmub_status dmub_srv_wait_for_inbox0_ack(struct dmub_srv *dmub, uint32_t timeout_us);
781 
782 /**
783  * dmub_srv_wait_for_inbox0_ack() - clear ACK register for INBOX0
784  * @dmub: the dmub service
785  *
786  * Clear ACK register for INBOX0
787  *
788  * Return:
789  *   DMUB_STATUS_OK - success
790  *   DMUB_STATUS_INVALID - hw_init false or hw function does not exist
791  */
792 enum dmub_status dmub_srv_clear_inbox0_ack(struct dmub_srv *dmub);
793 
794 #if defined(__cplusplus)
795 }
796 #endif
797 
798 #endif /* _DMUB_SRV_H_ */
799