1/*
  2 * Copyright 2012-14 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 DC_LINK_H_
 27#define DC_LINK_H_
 28
 29#include "dc_types.h"
 30#include "grph_object_defs.h"
 31
 32struct dc_link_status {
 33	struct dpcd_caps *dpcd_caps;
 34};
 35
 36/* DP MST stream allocation (payload bandwidth number) */
 37struct link_mst_stream_allocation {
 38	/* DIG front */
 39	const struct stream_encoder *stream_enc;
 40	/* associate DRM payload table with DC stream encoder */
 41	uint8_t vcp_id;
 42	/* number of slots required for the DP stream in transport packet */
 43	uint8_t slot_count;
 44};
 45
 46/* DP MST stream allocation table */
 47struct link_mst_stream_allocation_table {
 48	/* number of DP video streams */
 49	int stream_count;
 50	/* array of stream allocations */
 51	struct link_mst_stream_allocation stream_allocations[MAX_CONTROLLER_NUM];
 52};
 53
 54/*
 55 * A link contains one or more sinks and their connected status.
 56 * The currently active signal type (HDMI, DP-SST, DP-MST) is also reported.
 57 */
 58struct dc_link {
 59	struct dc_sink *remote_sinks[MAX_SINKS_PER_LINK];
 60	unsigned int sink_count;
 61	struct dc_sink *local_sink;
 62	unsigned int link_index;
 63	enum dc_connection_type type;
 64	enum signal_type connector_signal;
 65	enum dc_irq_source irq_source_hpd;
 66	enum dc_irq_source irq_source_hpd_rx;/* aka DP Short Pulse  */
 67	bool is_hpd_filter_disabled;
 68
 69	/* caps is the same as reported_link_cap. link_traing use
 70	 * reported_link_cap. Will clean up.  TODO
 71	 */
 72	struct dc_link_settings reported_link_cap;
 73	struct dc_link_settings verified_link_cap;
 74	struct dc_link_settings cur_link_settings;
 75	struct dc_lane_settings cur_lane_setting;
 76	struct dc_link_settings preferred_link_setting;
 77
 78	uint8_t ddc_hw_inst;
 79
 80	uint8_t hpd_src;
 81
 82	uint8_t link_enc_hw_inst;
 83
 84	bool test_pattern_enabled;
 85	union compliance_test_state compliance_test_state;
 86
 87	void *priv;
 88
 89	struct ddc_service *ddc;
 90
 91	bool aux_mode;
 92
 93	/* Private to DC core */
 94
 95	const struct dc *dc;
 96
 97	struct dc_context *ctx;
 98
 99	struct link_encoder *link_enc;
100	struct graphics_object_id link_id;
101	union ddi_channel_mapping ddi_channel_mapping;
102	struct connector_device_tag_info device_tag;
103	struct dpcd_caps dpcd_caps;
104	unsigned short chip_caps;
105	unsigned int dpcd_sink_count;
106	enum edp_revision edp_revision;
107	bool psr_enabled;
108
109	/* MST record stream using this link */
110	struct link_flags {
111		bool dp_keep_receiver_powered;
112	} wa_flags;
113	struct link_mst_stream_allocation_table mst_stream_alloc_table;
114
115	struct dc_link_status link_status;
116
117};
118
119const struct dc_link_status *dc_link_get_status(const struct dc_link *dc_link);
120
121/*
122 * Return an enumerated dc_link.  dc_link order is constant and determined at
123 * boot time.  They cannot be created or destroyed.
124 * Use dc_get_caps() to get number of links.
125 */
126static inline struct dc_link *dc_get_link_at_index(struct dc *dc, uint32_t link_index)
127{
128	return dc->links[link_index];
129}
130
131/* Set backlight level of an embedded panel (eDP, LVDS). */
132bool dc_link_set_backlight_level(const struct dc_link *dc_link, uint32_t level,
133		uint32_t frame_ramp, const struct dc_stream_state *stream);
134
135bool dc_link_set_abm_disable(const struct dc_link *dc_link);
136
137bool dc_link_set_psr_enable(const struct dc_link *dc_link, bool enable, bool wait);
138
139bool dc_link_get_psr_state(const struct dc_link *dc_link, uint32_t *psr_state);
140
141bool dc_link_setup_psr(struct dc_link *dc_link,
142		const struct dc_stream_state *stream, struct psr_config *psr_config,
143		struct psr_context *psr_context);
144
145/* Request DC to detect if there is a Panel connected.
146 * boot - If this call is during initial boot.
147 * Return false for any type of detection failure or MST detection
148 * true otherwise. True meaning further action is required (status update
149 * and OS notification).
150 */
151enum dc_detect_reason {
152	DETECT_REASON_BOOT,
153	DETECT_REASON_HPD,
154	DETECT_REASON_HPDRX,
155};
156
157bool dc_link_detect(struct dc_link *dc_link, enum dc_detect_reason reason);
158
159/* Notify DC about DP RX Interrupt (aka Short Pulse Interrupt).
160 * Return:
161 * true - Downstream port status changed. DM should call DC to do the
162 * detection.
163 * false - no change in Downstream port status. No further action required
164 * from DM. */
165bool dc_link_handle_hpd_rx_irq(struct dc_link *dc_link,
166		union hpd_irq_data *hpd_irq_dpcd_data);
167
168struct dc_sink_init_data;
169
170struct dc_sink *dc_link_add_remote_sink(
171		struct dc_link *dc_link,
172		const uint8_t *edid,
173		int len,
174		struct dc_sink_init_data *init_data);
175
176void dc_link_remove_remote_sink(
177	struct dc_link *link,
178	struct dc_sink *sink);
179
180/* Used by diagnostics for virtual link at the moment */
181
182void dc_link_dp_set_drive_settings(
183	struct dc_link *link,
184	struct link_training_settings *lt_settings);
185
186enum link_training_result dc_link_dp_perform_link_training(
187	struct dc_link *link,
188	const struct dc_link_settings *link_setting,
189	bool skip_video_pattern);
190
191void dc_link_dp_enable_hpd(const struct dc_link *link);
192
193void dc_link_dp_disable_hpd(const struct dc_link *link);
194
195bool dc_link_dp_set_test_pattern(
196	struct dc_link *link,
197	enum dp_test_pattern test_pattern,
198	const struct link_training_settings *p_link_settings,
199	const unsigned char *p_custom_pattern,
200	unsigned int cust_pattern_size);
201
202void dc_link_enable_hpd_filter(struct dc_link *link, bool enable);
203
204/*
205 * DPCD access interfaces
206 */
207
208bool dc_submit_i2c(
209		struct dc *dc,
210		uint32_t link_index,
211		struct i2c_command *cmd);
212
213#endif /* DC_LINK_H_ */