1/*
  2 * Copyright © 2016 Intel Corporation
  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 (including the next
 12 * paragraph) shall be included in all copies or substantial portions of the
 13 * Software.
 14 *
 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 21 * SOFTWARE.
 22 */
 23
 24/*
 25 * Please use intel_vbt_defs.h for VBT private data, to hide and abstract away
 26 * the VBT from the rest of the driver. Add the parsed, clean data to struct
 27 * intel_vbt_data within struct drm_i915_private.
 28 */
 29
 30#ifndef _INTEL_BIOS_H_
 31#define _INTEL_BIOS_H_
 32
 33#include <linux/types.h>
 34
 35#include <drm/i915_drm.h>
 36
 37struct drm_i915_private;
 38
 39enum intel_backlight_type {
 40	INTEL_BACKLIGHT_PMIC,
 41	INTEL_BACKLIGHT_LPSS,
 42	INTEL_BACKLIGHT_DISPLAY_DDI,
 43	INTEL_BACKLIGHT_DSI_DCS,
 44	INTEL_BACKLIGHT_PANEL_DRIVER_INTERFACE,
 45	INTEL_BACKLIGHT_VESA_EDP_AUX_INTERFACE,
 46};
 47
 48struct edp_power_seq {
 49	u16 t1_t3;
 50	u16 t8;
 51	u16 t9;
 52	u16 t10;
 53	u16 t11_t12;
 54} __packed;
 55
 56/*
 57 * MIPI Sequence Block definitions
 58 *
 59 * Note the VBT spec has AssertReset / DeassertReset swapped from their
 60 * usual naming, we use the proper names here to avoid confusion when
 61 * reading the code.
 62 */
 63enum mipi_seq {
 64	MIPI_SEQ_END = 0,
 65	MIPI_SEQ_DEASSERT_RESET,	/* Spec says MipiAssertResetPin */
 66	MIPI_SEQ_INIT_OTP,
 67	MIPI_SEQ_DISPLAY_ON,
 68	MIPI_SEQ_DISPLAY_OFF,
 69	MIPI_SEQ_ASSERT_RESET,		/* Spec says MipiDeassertResetPin */
 70	MIPI_SEQ_BACKLIGHT_ON,		/* sequence block v2+ */
 71	MIPI_SEQ_BACKLIGHT_OFF,		/* sequence block v2+ */
 72	MIPI_SEQ_TEAR_ON,		/* sequence block v2+ */
 73	MIPI_SEQ_TEAR_OFF,		/* sequence block v3+ */
 74	MIPI_SEQ_POWER_ON,		/* sequence block v3+ */
 75	MIPI_SEQ_POWER_OFF,		/* sequence block v3+ */
 76	MIPI_SEQ_MAX
 77};
 78
 79enum mipi_seq_element {
 80	MIPI_SEQ_ELEM_END = 0,
 81	MIPI_SEQ_ELEM_SEND_PKT,
 82	MIPI_SEQ_ELEM_DELAY,
 83	MIPI_SEQ_ELEM_GPIO,
 84	MIPI_SEQ_ELEM_I2C,		/* sequence block v2+ */
 85	MIPI_SEQ_ELEM_SPI,		/* sequence block v3+ */
 86	MIPI_SEQ_ELEM_PMIC,		/* sequence block v3+ */
 87	MIPI_SEQ_ELEM_MAX
 88};
 89
 90#define MIPI_DSI_UNDEFINED_PANEL_ID	0
 91#define MIPI_DSI_GENERIC_PANEL_ID	1
 92
 93struct mipi_config {
 94	u16 panel_id;
 95
 96	/* General Params */
 97	u32 enable_dithering:1;
 98	u32 rsvd1:1;
 99	u32 is_bridge:1;
100
101	u32 panel_arch_type:2;
102	u32 is_cmd_mode:1;
103
104#define NON_BURST_SYNC_PULSE	0x1
105#define NON_BURST_SYNC_EVENTS	0x2
106#define BURST_MODE		0x3
107	u32 video_transfer_mode:2;
108
109	u32 cabc_supported:1;
110#define PPS_BLC_PMIC   0
111#define PPS_BLC_SOC    1
112	u32 pwm_blc:1;
113
114	/* Bit 13:10 */
115#define PIXEL_FORMAT_RGB565			0x1
116#define PIXEL_FORMAT_RGB666			0x2
117#define PIXEL_FORMAT_RGB666_LOOSELY_PACKED	0x3
118#define PIXEL_FORMAT_RGB888			0x4
119	u32 videomode_color_format:4;
120
121	/* Bit 15:14 */
122#define ENABLE_ROTATION_0	0x0
123#define ENABLE_ROTATION_90	0x1
124#define ENABLE_ROTATION_180	0x2
125#define ENABLE_ROTATION_270	0x3
126	u32 rotation:2;
127	u32 bta_enabled:1;
128	u32 rsvd2:15;
129
130	/* 2 byte Port Description */
131#define DUAL_LINK_NOT_SUPPORTED	0
132#define DUAL_LINK_FRONT_BACK	1
133#define DUAL_LINK_PIXEL_ALT	2
134	u16 dual_link:2;
135	u16 lane_cnt:2;
136	u16 pixel_overlap:3;
137	u16 rgb_flip:1;
138#define DL_DCS_PORT_A			0x00
139#define DL_DCS_PORT_C			0x01
140#define DL_DCS_PORT_A_AND_C		0x02
141	u16 dl_dcs_cabc_ports:2;
142	u16 dl_dcs_backlight_ports:2;
143	u16 rsvd3:4;
144
145	u16 rsvd4;
146
147	u8 rsvd5;
148	u32 target_burst_mode_freq;
149	u32 dsi_ddr_clk;
150	u32 bridge_ref_clk;
151
152#define  BYTE_CLK_SEL_20MHZ		0
153#define  BYTE_CLK_SEL_10MHZ		1
154#define  BYTE_CLK_SEL_5MHZ		2
155	u8 byte_clk_sel:2;
156
157	u8 rsvd6:6;
158
159	/* DPHY Flags */
160	u16 dphy_param_valid:1;
161	u16 eot_pkt_disabled:1;
162	u16 enable_clk_stop:1;
163	u16 rsvd7:13;
164
165	u32 hs_tx_timeout;
166	u32 lp_rx_timeout;
167	u32 turn_around_timeout;
168	u32 device_reset_timer;
169	u32 master_init_timer;
170	u32 dbi_bw_timer;
171	u32 lp_byte_clk_val;
172
173	/*  4 byte Dphy Params */
174	u32 prepare_cnt:6;
175	u32 rsvd8:2;
176	u32 clk_zero_cnt:8;
177	u32 trail_cnt:5;
178	u32 rsvd9:3;
179	u32 exit_zero_cnt:6;
180	u32 rsvd10:2;
181
182	u32 clk_lane_switch_cnt;
183	u32 hl_switch_cnt;
184
185	u32 rsvd11[6];
186
187	/* timings based on dphy spec */
188	u8 tclk_miss;
189	u8 tclk_post;
190	u8 rsvd12;
191	u8 tclk_pre;
192	u8 tclk_prepare;
193	u8 tclk_settle;
194	u8 tclk_term_enable;
195	u8 tclk_trail;
196	u16 tclk_prepare_clkzero;
197	u8 rsvd13;
198	u8 td_term_enable;
199	u8 teot;
200	u8 ths_exit;
201	u8 ths_prepare;
202	u16 ths_prepare_hszero;
203	u8 rsvd14;
204	u8 ths_settle;
205	u8 ths_skip;
206	u8 ths_trail;
207	u8 tinit;
208	u8 tlpx;
209	u8 rsvd15[3];
210
211	/* GPIOs */
212	u8 panel_enable;
213	u8 bl_enable;
214	u8 pwm_enable;
215	u8 reset_r_n;
216	u8 pwr_down_r;
217	u8 stdby_r_n;
218
219} __packed;
220
221/* all delays have a unit of 100us */
222struct mipi_pps_data {
223	u16 panel_on_delay;
224	u16 bl_enable_delay;
225	u16 bl_disable_delay;
226	u16 panel_off_delay;
227	u16 panel_power_cycle_delay;
228} __packed;
229
230void intel_bios_init(struct drm_i915_private *dev_priv);
231void intel_bios_driver_remove(struct drm_i915_private *dev_priv);
232bool intel_bios_is_valid_vbt(const void *buf, size_t size);
233bool intel_bios_is_tv_present(struct drm_i915_private *dev_priv);
234bool intel_bios_is_lvds_present(struct drm_i915_private *dev_priv, u8 *i2c_pin);
235bool intel_bios_is_port_present(struct drm_i915_private *dev_priv, enum port port);
236bool intel_bios_is_port_edp(struct drm_i915_private *dev_priv, enum port port);
237bool intel_bios_is_port_dp_dual_mode(struct drm_i915_private *dev_priv, enum port port);
238bool intel_bios_is_dsi_present(struct drm_i915_private *dev_priv, enum port *port);
239bool intel_bios_is_port_hpd_inverted(const struct drm_i915_private *i915,
240				     enum port port);
241bool intel_bios_is_lspcon_present(const struct drm_i915_private *i915,
242				  enum port port);
243enum aux_ch intel_bios_port_aux_ch(struct drm_i915_private *dev_priv, enum port port);
244
245#endif /* _INTEL_BIOS_H_ */