1 /*
2  * Copyright 2018 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_DC_SRV_H_
27 #define _DMUB_DC_SRV_H_
28 
29 #include "os_types.h"
30 #include "dmub/dmub_srv.h"
31 
32 struct dmub_srv;
33 struct dc;
34 
35 struct dc_reg_helper_state {
36 	bool gather_in_progress;
37 	uint32_t same_addr_count;
38 	bool should_burst_write;
39 	union dmub_rb_cmd cmd_data;
40 	unsigned int reg_seq_count;
41 };
42 
43 struct dc_dmub_srv {
44 	struct dmub_srv *dmub;
45 	struct dc_reg_helper_state reg_helper_offload;
46 
47 	struct dc_context *ctx;
48 	void *dm;
49 };
50 
51 void dc_dmub_srv_cmd_queue(struct dc_dmub_srv *dc_dmub_srv,
52 			   union dmub_rb_cmd *cmd);
53 
54 void dc_dmub_srv_cmd_execute(struct dc_dmub_srv *dc_dmub_srv);
55 
56 void dc_dmub_srv_wait_idle(struct dc_dmub_srv *dc_dmub_srv);
57 
58 void dc_dmub_srv_wait_phy_init(struct dc_dmub_srv *dc_dmub_srv);
59 
60 bool dc_dmub_srv_cmd_with_reply_data(struct dc_dmub_srv *dc_dmub_srv, union dmub_rb_cmd *cmd);
61 
62 bool dc_dmub_srv_notify_stream_mask(struct dc_dmub_srv *dc_dmub_srv,
63 				    unsigned int stream_mask);
64 
65 bool dc_dmub_srv_is_restore_required(struct dc_dmub_srv *dc_dmub_srv);
66 
67 bool dc_dmub_srv_get_dmub_outbox0_msg(const struct dc *dc, struct dmcub_trace_buf_entry *entry);
68 
69 void dc_dmub_trace_event_control(struct dc *dc, bool enable);
70 
71 void dc_dmub_srv_clear_inbox0_ack(struct dc_dmub_srv *dmub_srv);
72 void dc_dmub_srv_wait_for_inbox0_ack(struct dc_dmub_srv *dmub_srv);
73 void dc_dmub_srv_send_inbox0_cmd(struct dc_dmub_srv *dmub_srv, union dmub_inbox0_data_register data);
74 
75 bool dc_dmub_srv_get_diagnostic_data(struct dc_dmub_srv *dc_dmub_srv, struct dmub_diagnostic_data *dmub_oca);
76 
77 void dc_dmub_srv_log_diagnostic_data(struct dc_dmub_srv *dc_dmub_srv);
78 
79 #endif /* _DMUB_DC_SRV_H_ */
80