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 "dm_services_types.h"
30#include "dmub/dmub_srv.h"
31
32struct dmub_srv;
33struct dc;
34struct pipe_ctx;
35struct dc_crtc_timing_adjust;
36struct dc_crtc_timing;
37struct dc_state;
38
39struct dc_reg_helper_state {
40	bool gather_in_progress;
41	uint32_t same_addr_count;
42	bool should_burst_write;
43	union dmub_rb_cmd cmd_data;
44	unsigned int reg_seq_count;
45};
46
47struct dc_dmub_srv {
48	struct dmub_srv *dmub;
49	struct dc_reg_helper_state reg_helper_offload;
50
51	struct dc_context *ctx;
52	void *dm;
53
54	bool idle_allowed;
55};
56
57void dc_dmub_srv_wait_idle(struct dc_dmub_srv *dc_dmub_srv);
58
59bool dc_dmub_srv_optimized_init_done(struct dc_dmub_srv *dc_dmub_srv);
60
61bool dc_dmub_srv_cmd_list_queue_execute(struct dc_dmub_srv *dc_dmub_srv,
62		unsigned int count,
63		union dmub_rb_cmd *cmd_list);
64
65bool dc_dmub_srv_wait_for_idle(struct dc_dmub_srv *dc_dmub_srv,
66		enum dm_dmub_wait_type wait_type,
67		union dmub_rb_cmd *cmd_list);
68
69bool dc_dmub_srv_cmd_run(struct dc_dmub_srv *dc_dmub_srv, union dmub_rb_cmd *cmd, enum dm_dmub_wait_type wait_type);
70
71bool dc_dmub_srv_cmd_run_list(struct dc_dmub_srv *dc_dmub_srv, unsigned int count, union dmub_rb_cmd *cmd_list, enum dm_dmub_wait_type wait_type);
72
73bool dc_dmub_srv_notify_stream_mask(struct dc_dmub_srv *dc_dmub_srv,
74				    unsigned int stream_mask);
75
76bool dc_dmub_srv_is_restore_required(struct dc_dmub_srv *dc_dmub_srv);
77
78bool dc_dmub_srv_get_dmub_outbox0_msg(const struct dc *dc, struct dmcub_trace_buf_entry *entry);
79
80void dc_dmub_trace_event_control(struct dc *dc, bool enable);
81
82void dc_dmub_srv_drr_update_cmd(struct dc *dc, uint32_t tg_inst, uint32_t vtotal_min, uint32_t vtotal_max);
83
84void dc_dmub_srv_set_drr_manual_trigger_cmd(struct dc *dc, uint32_t tg_inst);
85bool dc_dmub_srv_p_state_delegate(struct dc *dc, bool enable_pstate, struct dc_state *context);
86
87void dc_dmub_srv_query_caps_cmd(struct dc_dmub_srv *dc_dmub_srv);
88void dc_dmub_srv_get_visual_confirm_color_cmd(struct dc *dc, struct pipe_ctx *pipe_ctx);
89void dc_dmub_srv_clear_inbox0_ack(struct dc_dmub_srv *dmub_srv);
90void dc_dmub_srv_wait_for_inbox0_ack(struct dc_dmub_srv *dmub_srv);
91void dc_dmub_srv_send_inbox0_cmd(struct dc_dmub_srv *dmub_srv, union dmub_inbox0_data_register data);
92
93bool dc_dmub_srv_get_diagnostic_data(struct dc_dmub_srv *dc_dmub_srv, struct dmub_diagnostic_data *dmub_oca);
94
95void dc_dmub_setup_subvp_dmub_command(struct dc *dc, struct dc_state *context, bool enable);
96void dc_dmub_srv_log_diagnostic_data(struct dc_dmub_srv *dc_dmub_srv);
97
98void dc_send_update_cursor_info_to_dmu(struct pipe_ctx *pCtx, uint8_t pipe_idx);
99bool dc_dmub_check_min_version(struct dmub_srv *srv);
100
101void dc_dmub_srv_enable_dpia_trace(const struct dc *dc);
102void dc_dmub_srv_subvp_save_surf_addr(const struct dc_dmub_srv *dc_dmub_srv, const struct dc_plane_address *addr, uint8_t subvp_index);
103
104bool dc_dmub_srv_is_hw_pwr_up(struct dc_dmub_srv *dc_dmub_srv, bool wait);
105
106void dc_dmub_srv_apply_idle_power_optimizations(const struct dc *dc, bool allow_idle);
107
108void dc_dmub_srv_set_power_state(struct dc_dmub_srv *dc_dmub_srv, enum dc_acpi_cm_power_state powerState);
109
110/**
111 * dc_wake_and_execute_dmub_cmd() - Wrapper for DMUB command execution.
112 *
113 * Refer to dc_wake_and_execute_dmub_cmd_list() for usage and limitations,
114 * This function is a convenience wrapper for a single command execution.
115 *
116 * @ctx: DC context
117 * @cmd: The command to send/receive
118 * @wait_type: The wait behavior for the execution
119 *
120 * Return: true on command submission success, false otherwise
121 */
122bool dc_wake_and_execute_dmub_cmd(const struct dc_context *ctx, union dmub_rb_cmd *cmd,
123				  enum dm_dmub_wait_type wait_type);
124
125/**
126 * dc_wake_and_execute_dmub_cmd_list() - Wrapper for DMUB command list execution.
127 *
128 * If the DMCUB hardware was asleep then it wakes the DMUB before
129 * executing the command and attempts to re-enter if the command
130 * submission was successful.
131 *
132 * This should be the preferred command submission interface provided
133 * the DC lock is acquired.
134 *
135 * Entry/exit out of idle power optimizations would need to be
136 * manually performed otherwise through dc_allow_idle_optimizations().
137 *
138 * @ctx: DC context
139 * @count: Number of commands to send/receive
140 * @cmd: Array of commands to send
141 * @wait_type: The wait behavior for the execution
142 *
143 * Return: true on command submission success, false otherwise
144 */
145bool dc_wake_and_execute_dmub_cmd_list(const struct dc_context *ctx, unsigned int count,
146				       union dmub_rb_cmd *cmd, enum dm_dmub_wait_type wait_type);
147
148/**
149 * dc_wake_and_execute_gpint()
150 *
151 * @ctx: DC context
152 * @command_code: The command ID to send to DMCUB
153 * @param: The parameter to message DMCUB
154 * @response: Optional response out value - may be NULL.
155 * @wait_type: The wait behavior for the execution
156 */
157bool dc_wake_and_execute_gpint(const struct dc_context *ctx, enum dmub_gpint_command command_code,
158			       uint16_t param, uint32_t *response, enum dm_dmub_wait_type wait_type);
159
160#endif /* _DMUB_DC_SRV_H_ */
161