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