Linux Audio

Check our new training course

Loading...
Note: File does not exist in v5.14.15.
  1/*
  2 * Copyright © 2006-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 * Authors:
 24 *    Eric Anholt <eric@anholt.net>
 25 *
 26 */
 27
 28/*
 29 * This information is private to VBT parsing in intel_bios.c.
 30 *
 31 * Please do NOT include anywhere else.
 32 */
 33#ifndef _INTEL_BIOS_PRIVATE
 34#error "intel_vbt_defs.h is private to intel_bios.c"
 35#endif
 36
 37#ifndef _INTEL_VBT_DEFS_H_
 38#define _INTEL_VBT_DEFS_H_
 39
 40#include "intel_bios.h"
 41
 42/**
 43 * struct vbt_header - VBT Header structure
 44 * @signature:		VBT signature, always starts with "$VBT"
 45 * @version:		Version of this structure
 46 * @header_size:	Size of this structure
 47 * @vbt_size:		Size of VBT (VBT Header, BDB Header and data blocks)
 48 * @vbt_checksum:	Checksum
 49 * @reserved0:		Reserved
 50 * @bdb_offset:		Offset of &struct bdb_header from beginning of VBT
 51 * @aim_offset:		Offsets of add-in data blocks from beginning of VBT
 52 */
 53struct vbt_header {
 54	u8 signature[20];
 55	u16 version;
 56	u16 header_size;
 57	u16 vbt_size;
 58	u8 vbt_checksum;
 59	u8 reserved0;
 60	u32 bdb_offset;
 61	u32 aim_offset[4];
 62} __packed;
 63
 64/**
 65 * struct bdb_header - BDB Header structure
 66 * @signature:		BDB signature "BIOS_DATA_BLOCK"
 67 * @version:		Version of the data block definitions
 68 * @header_size:	Size of this structure
 69 * @bdb_size:		Size of BDB (BDB Header and data blocks)
 70 */
 71struct bdb_header {
 72	u8 signature[16];
 73	u16 version;
 74	u16 header_size;
 75	u16 bdb_size;
 76} __packed;
 77
 78/* strictly speaking, this is a "skip" block, but it has interesting info */
 79struct vbios_data {
 80	u8 type; /* 0 == desktop, 1 == mobile */
 81	u8 relstage;
 82	u8 chipset;
 83	u8 lvds_present:1;
 84	u8 tv_present:1;
 85	u8 rsvd2:6; /* finish byte */
 86	u8 rsvd3[4];
 87	u8 signon[155];
 88	u8 copyright[61];
 89	u16 code_segment;
 90	u8 dos_boot_mode;
 91	u8 bandwidth_percent;
 92	u8 rsvd4; /* popup memory size */
 93	u8 resize_pci_bios;
 94	u8 rsvd5; /* is crt already on ddc2 */
 95} __packed;
 96
 97/*
 98 * There are several types of BIOS data blocks (BDBs), each block has
 99 * an ID and size in the first 3 bytes (ID in first, size in next 2).
100 * Known types are listed below.
101 */
102#define BDB_GENERAL_FEATURES	  1
103#define BDB_GENERAL_DEFINITIONS	  2
104#define BDB_OLD_TOGGLE_LIST	  3
105#define BDB_MODE_SUPPORT_LIST	  4
106#define BDB_GENERIC_MODE_TABLE	  5
107#define BDB_EXT_MMIO_REGS	  6
108#define BDB_SWF_IO		  7
109#define BDB_SWF_MMIO		  8
110#define BDB_PSR			  9
111#define BDB_MODE_REMOVAL_TABLE	 10
112#define BDB_CHILD_DEVICE_TABLE	 11
113#define BDB_DRIVER_FEATURES	 12
114#define BDB_DRIVER_PERSISTENCE	 13
115#define BDB_EXT_TABLE_PTRS	 14
116#define BDB_DOT_CLOCK_OVERRIDE	 15
117#define BDB_DISPLAY_SELECT	 16
118/* 17 rsvd */
119#define BDB_DRIVER_ROTATION	 18
120#define BDB_DISPLAY_REMOVE	 19
121#define BDB_OEM_CUSTOM		 20
122#define BDB_EFP_LIST		 21 /* workarounds for VGA hsync/vsync */
123#define BDB_SDVO_LVDS_OPTIONS	 22
124#define BDB_SDVO_PANEL_DTDS	 23
125#define BDB_SDVO_LVDS_PNP_IDS	 24
126#define BDB_SDVO_LVDS_POWER_SEQ	 25
127#define BDB_TV_OPTIONS		 26
128#define BDB_EDP			 27
129#define BDB_LVDS_OPTIONS	 40
130#define BDB_LVDS_LFP_DATA_PTRS	 41
131#define BDB_LVDS_LFP_DATA	 42
132#define BDB_LVDS_BACKLIGHT	 43
133#define BDB_LVDS_POWER		 44
134#define BDB_MIPI_CONFIG		 52
135#define BDB_MIPI_SEQUENCE	 53
136#define BDB_SKIP		254 /* VBIOS private block, ignore */
137
138struct bdb_general_features {
139        /* bits 1 */
140	u8 panel_fitting:2;
141	u8 flexaim:1;
142	u8 msg_enable:1;
143	u8 clear_screen:3;
144	u8 color_flip:1;
145
146        /* bits 2 */
147	u8 download_ext_vbt:1;
148	u8 enable_ssc:1;
149	u8 ssc_freq:1;
150	u8 enable_lfp_on_override:1;
151	u8 disable_ssc_ddt:1;
152	u8 underscan_vga_timings:1;
153	u8 display_clock_mode:1;
154	u8 vbios_hotplug_support:1;
155
156        /* bits 3 */
157	u8 disable_smooth_vision:1;
158	u8 single_dvi:1;
159	u8 rotate_180:1;					/* 181 */
160	u8 fdi_rx_polarity_inverted:1;
161	u8 vbios_extended_mode:1;				/* 160 */
162	u8 copy_ilfp_dtd_to_sdvo_lvds_dtd:1;			/* 160 */
163	u8 panel_best_fit_timing:1;				/* 160 */
164	u8 ignore_strap_state:1;				/* 160 */
165
166        /* bits 4 */
167	u8 legacy_monitor_detect;
168
169        /* bits 5 */
170	u8 int_crt_support:1;
171	u8 int_tv_support:1;
172	u8 int_efp_support:1;
173	u8 dp_ssc_enable:1;	/* PCH attached eDP supports SSC */
174	u8 dp_ssc_freq:1;	/* SSC freq for PCH attached eDP */
175	u8 dp_ssc_dongle_supported:1;
176	u8 rsvd11:2; /* finish byte */
177} __packed;
178
179/* pre-915 */
180#define GPIO_PIN_DVI_LVDS	0x03 /* "DVI/LVDS DDC GPIO pins" */
181#define GPIO_PIN_ADD_I2C	0x05 /* "ADDCARD I2C GPIO pins" */
182#define GPIO_PIN_ADD_DDC	0x04 /* "ADDCARD DDC GPIO pins" */
183#define GPIO_PIN_ADD_DDC_I2C	0x06 /* "ADDCARD DDC/I2C GPIO pins" */
184
185/* Pre 915 */
186#define DEVICE_TYPE_NONE	0x00
187#define DEVICE_TYPE_CRT		0x01
188#define DEVICE_TYPE_TV		0x09
189#define DEVICE_TYPE_EFP		0x12
190#define DEVICE_TYPE_LFP		0x22
191/* On 915+ */
192#define DEVICE_TYPE_CRT_DPMS		0x6001
193#define DEVICE_TYPE_CRT_DPMS_HOTPLUG	0x4001
194#define DEVICE_TYPE_TV_COMPOSITE	0x0209
195#define DEVICE_TYPE_TV_MACROVISION	0x0289
196#define DEVICE_TYPE_TV_RF_COMPOSITE	0x020c
197#define DEVICE_TYPE_TV_SVIDEO_COMPOSITE	0x0609
198#define DEVICE_TYPE_TV_SCART		0x0209
199#define DEVICE_TYPE_TV_CODEC_HOTPLUG_PWR 0x6009
200#define DEVICE_TYPE_EFP_HOTPLUG_PWR	0x6012
201#define DEVICE_TYPE_EFP_DVI_HOTPLUG_PWR	0x6052
202#define DEVICE_TYPE_EFP_DVI_I		0x6053
203#define DEVICE_TYPE_EFP_DVI_D_DUAL	0x6152
204#define DEVICE_TYPE_EFP_DVI_D_HDCP	0x60d2
205#define DEVICE_TYPE_OPENLDI_HOTPLUG_PWR	0x6062
206#define DEVICE_TYPE_OPENLDI_DUALPIX	0x6162
207#define DEVICE_TYPE_LFP_PANELLINK	0x5012
208#define DEVICE_TYPE_LFP_CMOS_PWR	0x5042
209#define DEVICE_TYPE_LFP_LVDS_PWR	0x5062
210#define DEVICE_TYPE_LFP_LVDS_DUAL	0x5162
211#define DEVICE_TYPE_LFP_LVDS_DUAL_HDCP	0x51e2
212
213/* Add the device class for LFP, TV, HDMI */
214#define DEVICE_TYPE_INT_LFP		0x1022
215#define DEVICE_TYPE_INT_TV		0x1009
216#define DEVICE_TYPE_HDMI		0x60D2
217#define DEVICE_TYPE_DP			0x68C6
218#define DEVICE_TYPE_DP_DUAL_MODE	0x60D6
219#define DEVICE_TYPE_eDP			0x78C6
220
221#define DEVICE_TYPE_CLASS_EXTENSION	(1 << 15)
222#define DEVICE_TYPE_POWER_MANAGEMENT	(1 << 14)
223#define DEVICE_TYPE_HOTPLUG_SIGNALING	(1 << 13)
224#define DEVICE_TYPE_INTERNAL_CONNECTOR	(1 << 12)
225#define DEVICE_TYPE_NOT_HDMI_OUTPUT	(1 << 11)
226#define DEVICE_TYPE_MIPI_OUTPUT		(1 << 10)
227#define DEVICE_TYPE_COMPOSITE_OUTPUT	(1 << 9)
228#define DEVICE_TYPE_DUAL_CHANNEL	(1 << 8)
229#define DEVICE_TYPE_HIGH_SPEED_LINK	(1 << 6)
230#define DEVICE_TYPE_LVDS_SIGNALING	(1 << 5)
231#define DEVICE_TYPE_TMDS_DVI_SIGNALING	(1 << 4)
232#define DEVICE_TYPE_VIDEO_SIGNALING	(1 << 3)
233#define DEVICE_TYPE_DISPLAYPORT_OUTPUT	(1 << 2)
234#define DEVICE_TYPE_DIGITAL_OUTPUT	(1 << 1)
235#define DEVICE_TYPE_ANALOG_OUTPUT	(1 << 0)
236
237/*
238 * Bits we care about when checking for DEVICE_TYPE_eDP. Depending on the
239 * system, the other bits may or may not be set for eDP outputs.
240 */
241#define DEVICE_TYPE_eDP_BITS \
242	(DEVICE_TYPE_INTERNAL_CONNECTOR |	\
243	 DEVICE_TYPE_MIPI_OUTPUT |		\
244	 DEVICE_TYPE_COMPOSITE_OUTPUT |		\
245	 DEVICE_TYPE_DUAL_CHANNEL |		\
246	 DEVICE_TYPE_LVDS_SIGNALING |		\
247	 DEVICE_TYPE_TMDS_DVI_SIGNALING |	\
248	 DEVICE_TYPE_VIDEO_SIGNALING |		\
249	 DEVICE_TYPE_DISPLAYPORT_OUTPUT |	\
250	 DEVICE_TYPE_ANALOG_OUTPUT)
251
252#define DEVICE_TYPE_DP_DUAL_MODE_BITS \
253	(DEVICE_TYPE_INTERNAL_CONNECTOR |	\
254	 DEVICE_TYPE_MIPI_OUTPUT |		\
255	 DEVICE_TYPE_COMPOSITE_OUTPUT |		\
256	 DEVICE_TYPE_LVDS_SIGNALING |		\
257	 DEVICE_TYPE_TMDS_DVI_SIGNALING |	\
258	 DEVICE_TYPE_VIDEO_SIGNALING |		\
259	 DEVICE_TYPE_DISPLAYPORT_OUTPUT |	\
260	 DEVICE_TYPE_DIGITAL_OUTPUT |		\
261	 DEVICE_TYPE_ANALOG_OUTPUT)
262
263#define DEVICE_CFG_NONE		0x00
264#define DEVICE_CFG_12BIT_DVOB	0x01
265#define DEVICE_CFG_12BIT_DVOC	0x02
266#define DEVICE_CFG_24BIT_DVOBC	0x09
267#define DEVICE_CFG_24BIT_DVOCB	0x0a
268#define DEVICE_CFG_DUAL_DVOB	0x11
269#define DEVICE_CFG_DUAL_DVOC	0x12
270#define DEVICE_CFG_DUAL_DVOBC	0x13
271#define DEVICE_CFG_DUAL_LINK_DVOBC	0x19
272#define DEVICE_CFG_DUAL_LINK_DVOCB	0x1a
273
274#define DEVICE_WIRE_NONE	0x00
275#define DEVICE_WIRE_DVOB	0x01
276#define DEVICE_WIRE_DVOC	0x02
277#define DEVICE_WIRE_DVOBC	0x03
278#define DEVICE_WIRE_DVOBB	0x05
279#define DEVICE_WIRE_DVOCC	0x06
280#define DEVICE_WIRE_DVOB_MASTER 0x0d
281#define DEVICE_WIRE_DVOC_MASTER 0x0e
282
283/* dvo_port pre BDB 155 */
284#define DEVICE_PORT_DVOA	0x00 /* none on 845+ */
285#define DEVICE_PORT_DVOB	0x01
286#define DEVICE_PORT_DVOC	0x02
287
288/* dvo_port BDB 155+ */
289#define DVO_PORT_HDMIA		0
290#define DVO_PORT_HDMIB		1
291#define DVO_PORT_HDMIC		2
292#define DVO_PORT_HDMID		3
293#define DVO_PORT_LVDS		4
294#define DVO_PORT_TV		5
295#define DVO_PORT_CRT		6
296#define DVO_PORT_DPB		7
297#define DVO_PORT_DPC		8
298#define DVO_PORT_DPD		9
299#define DVO_PORT_DPA		10
300#define DVO_PORT_DPE		11				/* 193 */
301#define DVO_PORT_HDMIE		12				/* 193 */
302#define DVO_PORT_DPF		13				/* N/A */
303#define DVO_PORT_HDMIF		14				/* N/A */
304#define DVO_PORT_MIPIA		21				/* 171 */
305#define DVO_PORT_MIPIB		22				/* 171 */
306#define DVO_PORT_MIPIC		23				/* 171 */
307#define DVO_PORT_MIPID		24				/* 171 */
308
309#define HDMI_MAX_DATA_RATE_PLATFORM	0			/* 204 */
310#define HDMI_MAX_DATA_RATE_297		1			/* 204 */
311#define HDMI_MAX_DATA_RATE_165		2			/* 204 */
312
313#define LEGACY_CHILD_DEVICE_CONFIG_SIZE		33
314
315/* DDC Bus DDI Type 155+ */
316enum vbt_gmbus_ddi {
317	DDC_BUS_DDI_B = 0x1,
318	DDC_BUS_DDI_C,
319	DDC_BUS_DDI_D,
320	DDC_BUS_DDI_F,
321};
322
323#define VBT_DP_MAX_LINK_RATE_HBR3	0
324#define VBT_DP_MAX_LINK_RATE_HBR2	1
325#define VBT_DP_MAX_LINK_RATE_HBR	2
326#define VBT_DP_MAX_LINK_RATE_LBR	3
327
328/*
329 * The child device config, aka the display device data structure, provides a
330 * description of a port and its configuration on the platform.
331 *
332 * The child device config size has been increased, and fields have been added
333 * and their meaning has changed over time. Care must be taken when accessing
334 * basically any of the fields to ensure the correct interpretation for the BDB
335 * version in question.
336 *
337 * When we copy the child device configs to dev_priv->vbt.child_dev, we reserve
338 * space for the full structure below, and initialize the tail not actually
339 * present in VBT to zeros. Accessing those fields is fine, as long as the
340 * default zero is taken into account, again according to the BDB version.
341 *
342 * BDB versions 155 and below are considered legacy, and version 155 seems to be
343 * a baseline for some of the VBT documentation. When adding new fields, please
344 * include the BDB version when the field was added, if it's above that.
345 */
346struct child_device_config {
347	u16 handle;
348	u16 device_type; /* See DEVICE_TYPE_* above */
349
350	union {
351		u8  device_id[10]; /* ascii string */
352		struct {
353			u8 i2c_speed;
354			u8 dp_onboard_redriver;			/* 158 */
355			u8 dp_ondock_redriver;			/* 158 */
356			u8 hdmi_level_shifter_value:5;		/* 169 */
357			u8 hdmi_max_data_rate:3;		/* 204 */
358			u16 dtd_buf_ptr;			/* 161 */
359			u8 edidless_efp:1;			/* 161 */
360			u8 compression_enable:1;		/* 198 */
361			u8 compression_method:1;		/* 198 */
362			u8 ganged_edp:1;			/* 202 */
363			u8 reserved0:4;
364			u8 compression_structure_index:4;	/* 198 */
365			u8 reserved1:4;
366			u8 slave_port;				/* 202 */
367			u8 reserved2;
368		} __packed;
369	} __packed;
370
371	u16 addin_offset;
372	u8 dvo_port; /* See DEVICE_PORT_* and DVO_PORT_* above */
373	u8 i2c_pin;
374	u8 slave_addr;
375	u8 ddc_pin;
376	u16 edid_ptr;
377	u8 dvo_cfg; /* See DEVICE_CFG_* above */
378
379	union {
380		struct {
381			u8 dvo2_port;
382			u8 i2c2_pin;
383			u8 slave2_addr;
384			u8 ddc2_pin;
385		} __packed;
386		struct {
387			u8 efp_routed:1;			/* 158 */
388			u8 lane_reversal:1;			/* 184 */
389			u8 lspcon:1;				/* 192 */
390			u8 iboost:1;				/* 196 */
391			u8 hpd_invert:1;			/* 196 */
392			u8 flag_reserved:3;
393			u8 hdmi_support:1;			/* 158 */
394			u8 dp_support:1;			/* 158 */
395			u8 tmds_support:1;			/* 158 */
396			u8 support_reserved:5;
397			u8 aux_channel;
398			u8 dongle_detect;
399		} __packed;
400	} __packed;
401
402	u8 pipe_cap:2;
403	u8 sdvo_stall:1;					/* 158 */
404	u8 hpd_status:2;
405	u8 integrated_encoder:1;
406	u8 capabilities_reserved:2;
407	u8 dvo_wiring; /* See DEVICE_WIRE_* above */
408
409	union {
410		u8 dvo2_wiring;
411		u8 mipi_bridge_type;				/* 171 */
412	} __packed;
413
414	u16 extended_type;
415	u8 dvo_function;
416	u8 dp_usb_type_c:1;					/* 195 */
417	u8 flags2_reserved:7;					/* 195 */
418	u8 dp_gpio_index;					/* 195 */
419	u16 dp_gpio_pin_num;					/* 195 */
420	u8 dp_iboost_level:4;					/* 196 */
421	u8 hdmi_iboost_level:4;					/* 196 */
422	u8 dp_max_link_rate:2;					/* 216 CNL+ */
423	u8 dp_max_link_rate_reserved:6;				/* 216 */
424} __packed;
425
426struct bdb_general_definitions {
427	/* DDC GPIO */
428	u8 crt_ddc_gmbus_pin;
429
430	/* DPMS bits */
431	u8 dpms_acpi:1;
432	u8 skip_boot_crt_detect:1;
433	u8 dpms_aim:1;
434	u8 rsvd1:5; /* finish byte */
435
436	/* boot device bits */
437	u8 boot_display[2];
438	u8 child_dev_size;
439
440	/*
441	 * Device info:
442	 * If TV is present, it'll be at devices[0].
443	 * LVDS will be next, either devices[0] or [1], if present.
444	 * On some platforms the number of device is 6. But could be as few as
445	 * 4 if both TV and LVDS are missing.
446	 * And the device num is related with the size of general definition
447	 * block. It is obtained by using the following formula:
448	 * number = (block_size - sizeof(bdb_general_definitions))/
449	 *	     defs->child_dev_size;
450	 */
451	uint8_t devices[0];
452} __packed;
453
454/* Mask for DRRS / Panel Channel / SSC / BLT control bits extraction */
455#define MODE_MASK		0x3
456
457struct bdb_lvds_options {
458	u8 panel_type;
459	u8 rsvd1;
460	/* LVDS capabilities, stored in a dword */
461	u8 pfit_mode:2;
462	u8 pfit_text_mode_enhanced:1;
463	u8 pfit_gfx_mode_enhanced:1;
464	u8 pfit_ratio_auto:1;
465	u8 pixel_dither:1;
466	u8 lvds_edid:1;
467	u8 rsvd2:1;
468	u8 rsvd4;
469	/* LVDS Panel channel bits stored here */
470	u32 lvds_panel_channel_bits;
471	/* LVDS SSC (Spread Spectrum Clock) bits stored here. */
472	u16 ssc_bits;
473	u16 ssc_freq;
474	u16 ssc_ddt;
475	/* Panel color depth defined here */
476	u16 panel_color_depth;
477	/* LVDS panel type bits stored here */
478	u32 dps_panel_type_bits;
479	/* LVDS backlight control type bits stored here */
480	u32 blt_control_type_bits;
481} __packed;
482
483/* LFP pointer table contains entries to the struct below */
484struct bdb_lvds_lfp_data_ptr {
485	u16 fp_timing_offset; /* offsets are from start of bdb */
486	u8 fp_table_size;
487	u16 dvo_timing_offset;
488	u8 dvo_table_size;
489	u16 panel_pnp_id_offset;
490	u8 pnp_table_size;
491} __packed;
492
493struct bdb_lvds_lfp_data_ptrs {
494	u8 lvds_entries; /* followed by one or more lvds_data_ptr structs */
495	struct bdb_lvds_lfp_data_ptr ptr[16];
496} __packed;
497
498/* LFP data has 3 blocks per entry */
499struct lvds_fp_timing {
500	u16 x_res;
501	u16 y_res;
502	u32 lvds_reg;
503	u32 lvds_reg_val;
504	u32 pp_on_reg;
505	u32 pp_on_reg_val;
506	u32 pp_off_reg;
507	u32 pp_off_reg_val;
508	u32 pp_cycle_reg;
509	u32 pp_cycle_reg_val;
510	u32 pfit_reg;
511	u32 pfit_reg_val;
512	u16 terminator;
513} __packed;
514
515struct lvds_dvo_timing {
516	u16 clock;		/**< In 10khz */
517	u8 hactive_lo;
518	u8 hblank_lo;
519	u8 hblank_hi:4;
520	u8 hactive_hi:4;
521	u8 vactive_lo;
522	u8 vblank_lo;
523	u8 vblank_hi:4;
524	u8 vactive_hi:4;
525	u8 hsync_off_lo;
526	u8 hsync_pulse_width_lo;
527	u8 vsync_pulse_width_lo:4;
528	u8 vsync_off_lo:4;
529	u8 vsync_pulse_width_hi:2;
530	u8 vsync_off_hi:2;
531	u8 hsync_pulse_width_hi:2;
532	u8 hsync_off_hi:2;
533	u8 himage_lo;
534	u8 vimage_lo;
535	u8 vimage_hi:4;
536	u8 himage_hi:4;
537	u8 h_border;
538	u8 v_border;
539	u8 rsvd1:3;
540	u8 digital:2;
541	u8 vsync_positive:1;
542	u8 hsync_positive:1;
543	u8 non_interlaced:1;
544} __packed;
545
546struct lvds_pnp_id {
547	u16 mfg_name;
548	u16 product_code;
549	u32 serial;
550	u8 mfg_week;
551	u8 mfg_year;
552} __packed;
553
554struct bdb_lvds_lfp_data_entry {
555	struct lvds_fp_timing fp_timing;
556	struct lvds_dvo_timing dvo_timing;
557	struct lvds_pnp_id pnp_id;
558} __packed;
559
560struct bdb_lvds_lfp_data {
561	struct bdb_lvds_lfp_data_entry data[16];
562} __packed;
563
564#define BDB_BACKLIGHT_TYPE_NONE	0
565#define BDB_BACKLIGHT_TYPE_PWM	2
566
567struct bdb_lfp_backlight_data_entry {
568	u8 type:2;
569	u8 active_low_pwm:1;
570	u8 obsolete1:5;
571	u16 pwm_freq_hz;
572	u8 min_brightness;
573	u8 obsolete2;
574	u8 obsolete3;
575} __packed;
576
577struct bdb_lfp_backlight_control_method {
578	u8 type:4;
579	u8 controller:4;
580} __packed;
581
582struct bdb_lfp_backlight_data {
583	u8 entry_size;
584	struct bdb_lfp_backlight_data_entry data[16];
585	u8 level[16];
586	struct bdb_lfp_backlight_control_method backlight_control[16];
587} __packed;
588
589struct aimdb_header {
590	char signature[16];
591	char oem_device[20];
592	u16 aimdb_version;
593	u16 aimdb_header_size;
594	u16 aimdb_size;
595} __packed;
596
597struct aimdb_block {
598	u8 aimdb_id;
599	u16 aimdb_size;
600} __packed;
601
602struct vch_panel_data {
603	u16 fp_timing_offset;
604	u8 fp_timing_size;
605	u16 dvo_timing_offset;
606	u8 dvo_timing_size;
607	u16 text_fitting_offset;
608	u8 text_fitting_size;
609	u16 graphics_fitting_offset;
610	u8 graphics_fitting_size;
611} __packed;
612
613struct vch_bdb_22 {
614	struct aimdb_block aimdb_block;
615	struct vch_panel_data panels[16];
616} __packed;
617
618struct bdb_sdvo_lvds_options {
619	u8 panel_backlight;
620	u8 h40_set_panel_type;
621	u8 panel_type;
622	u8 ssc_clk_freq;
623	u16 als_low_trip;
624	u16 als_high_trip;
625	u8 sclalarcoeff_tab_row_num;
626	u8 sclalarcoeff_tab_row_size;
627	u8 coefficient[8];
628	u8 panel_misc_bits_1;
629	u8 panel_misc_bits_2;
630	u8 panel_misc_bits_3;
631	u8 panel_misc_bits_4;
632} __packed;
633
634
635#define BDB_DRIVER_FEATURE_NO_LVDS		0
636#define BDB_DRIVER_FEATURE_INT_LVDS		1
637#define BDB_DRIVER_FEATURE_SDVO_LVDS		2
638#define BDB_DRIVER_FEATURE_EDP			3
639
640struct bdb_driver_features {
641	u8 boot_dev_algorithm:1;
642	u8 block_display_switch:1;
643	u8 allow_display_switch:1;
644	u8 hotplug_dvo:1;
645	u8 dual_view_zoom:1;
646	u8 int15h_hook:1;
647	u8 sprite_in_clone:1;
648	u8 primary_lfp_id:1;
649
650	u16 boot_mode_x;
651	u16 boot_mode_y;
652	u8 boot_mode_bpp;
653	u8 boot_mode_refresh;
654
655	u16 enable_lfp_primary:1;
656	u16 selective_mode_pruning:1;
657	u16 dual_frequency:1;
658	u16 render_clock_freq:1; /* 0: high freq; 1: low freq */
659	u16 nt_clone_support:1;
660	u16 power_scheme_ui:1; /* 0: CUI; 1: 3rd party */
661	u16 sprite_display_assign:1; /* 0: secondary; 1: primary */
662	u16 cui_aspect_scaling:1;
663	u16 preserve_aspect_ratio:1;
664	u16 sdvo_device_power_down:1;
665	u16 crt_hotplug:1;
666	u16 lvds_config:2;
667	u16 tv_hotplug:1;
668	u16 hdmi_config:2;
669
670	u8 static_display:1;
671	u8 reserved2:7;
672	u16 legacy_crt_max_x;
673	u16 legacy_crt_max_y;
674	u8 legacy_crt_max_refresh;
675
676	u8 hdmi_termination;
677	u8 custom_vbt_version;
678	/* Driver features data block */
679	u16 rmpm_enabled:1;
680	u16 s2ddt_enabled:1;
681	u16 dpst_enabled:1;
682	u16 bltclt_enabled:1;
683	u16 adb_enabled:1;
684	u16 drrs_enabled:1;
685	u16 grs_enabled:1;
686	u16 gpmt_enabled:1;
687	u16 tbt_enabled:1;
688	u16 psr_enabled:1;
689	u16 ips_enabled:1;
690	u16 reserved3:4;
691	u16 pc_feature_valid:1;
692} __packed;
693
694#define EDP_18BPP	0
695#define EDP_24BPP	1
696#define EDP_30BPP	2
697#define EDP_RATE_1_62	0
698#define EDP_RATE_2_7	1
699#define EDP_LANE_1	0
700#define EDP_LANE_2	1
701#define EDP_LANE_4	3
702#define EDP_PREEMPHASIS_NONE	0
703#define EDP_PREEMPHASIS_3_5dB	1
704#define EDP_PREEMPHASIS_6dB	2
705#define EDP_PREEMPHASIS_9_5dB	3
706#define EDP_VSWING_0_4V		0
707#define EDP_VSWING_0_6V		1
708#define EDP_VSWING_0_8V		2
709#define EDP_VSWING_1_2V		3
710
711
712struct edp_fast_link_params {
713	u8 rate:4;
714	u8 lanes:4;
715	u8 preemphasis:4;
716	u8 vswing:4;
717} __packed;
718
719struct edp_pwm_delays {
720	u16 pwm_on_to_backlight_enable;
721	u16 backlight_disable_to_pwm_off;
722} __packed;
723
724struct edp_full_link_params {
725	u8 preemphasis:4;
726	u8 vswing:4;
727} __packed;
728
729struct bdb_edp {
730	struct edp_power_seq power_seqs[16];
731	u32 color_depth;
732	struct edp_fast_link_params fast_link_params[16];
733	u32 sdrrs_msa_timing_delay;
734
735	/* ith bit indicates enabled/disabled for (i+1)th panel */
736	u16 edp_s3d_feature;					/* 162 */
737	u16 edp_t3_optimization;				/* 165 */
738	u64 edp_vswing_preemph;					/* 173 */
739	u16 fast_link_training;					/* 182 */
740	u16 dpcd_600h_write_required;				/* 185 */
741	struct edp_pwm_delays pwm_delays[16];			/* 186 */
742	u16 full_link_params_provided;				/* 199 */
743	struct edp_full_link_params full_link_params[16];	/* 199 */
744} __packed;
745
746struct psr_table {
747	/* Feature bits */
748	u8 full_link:1;
749	u8 require_aux_to_wakeup:1;
750	u8 feature_bits_rsvd:6;
751
752	/* Wait times */
753	u8 idle_frames:4;
754	u8 lines_to_wait:3;
755	u8 wait_times_rsvd:1;
756
757	/* TP wake up time in multiple of 100 */
758	u16 tp1_wakeup_time;
759	u16 tp2_tp3_wakeup_time;
760} __packed;
761
762struct bdb_psr {
763	struct psr_table psr_table[16];
764} __packed;
765
766/*
767 * Driver<->VBIOS interaction occurs through scratch bits in
768 * GR18 & SWF*.
769 */
770
771/* GR18 bits are set on display switch and hotkey events */
772#define GR18_DRIVER_SWITCH_EN	(1<<7) /* 0: VBIOS control, 1: driver control */
773#define GR18_HOTKEY_MASK	0x78 /* See also SWF4 15:0 */
774#define   GR18_HK_NONE		(0x0<<3)
775#define   GR18_HK_LFP_STRETCH	(0x1<<3)
776#define   GR18_HK_TOGGLE_DISP	(0x2<<3)
777#define   GR18_HK_DISP_SWITCH	(0x4<<3) /* see SWF14 15:0 for what to enable */
778#define   GR18_HK_POPUP_DISABLED (0x6<<3)
779#define   GR18_HK_POPUP_ENABLED	(0x7<<3)
780#define   GR18_HK_PFIT		(0x8<<3)
781#define   GR18_HK_APM_CHANGE	(0xa<<3)
782#define   GR18_HK_MULTIPLE	(0xc<<3)
783#define GR18_USER_INT_EN	(1<<2)
784#define GR18_A0000_FLUSH_EN	(1<<1)
785#define GR18_SMM_EN		(1<<0)
786
787/* Set by driver, cleared by VBIOS */
788#define SWF00_YRES_SHIFT	16
789#define SWF00_XRES_SHIFT	0
790#define SWF00_RES_MASK		0xffff
791
792/* Set by VBIOS at boot time and driver at runtime */
793#define SWF01_TV2_FORMAT_SHIFT	8
794#define SWF01_TV1_FORMAT_SHIFT	0
795#define SWF01_TV_FORMAT_MASK	0xffff
796
797#define SWF10_VBIOS_BLC_I2C_EN	(1<<29)
798#define SWF10_GTT_OVERRIDE_EN	(1<<28)
799#define SWF10_LFP_DPMS_OVR	(1<<27) /* override DPMS on display switch */
800#define SWF10_ACTIVE_TOGGLE_LIST_MASK (7<<24)
801#define   SWF10_OLD_TOGGLE	0x0
802#define   SWF10_TOGGLE_LIST_1	0x1
803#define   SWF10_TOGGLE_LIST_2	0x2
804#define   SWF10_TOGGLE_LIST_3	0x3
805#define   SWF10_TOGGLE_LIST_4	0x4
806#define SWF10_PANNING_EN	(1<<23)
807#define SWF10_DRIVER_LOADED	(1<<22)
808#define SWF10_EXTENDED_DESKTOP	(1<<21)
809#define SWF10_EXCLUSIVE_MODE	(1<<20)
810#define SWF10_OVERLAY_EN	(1<<19)
811#define SWF10_PLANEB_HOLDOFF	(1<<18)
812#define SWF10_PLANEA_HOLDOFF	(1<<17)
813#define SWF10_VGA_HOLDOFF	(1<<16)
814#define SWF10_ACTIVE_DISP_MASK	0xffff
815#define   SWF10_PIPEB_LFP2	(1<<15)
816#define   SWF10_PIPEB_EFP2	(1<<14)
817#define   SWF10_PIPEB_TV2	(1<<13)
818#define   SWF10_PIPEB_CRT2	(1<<12)
819#define   SWF10_PIPEB_LFP	(1<<11)
820#define   SWF10_PIPEB_EFP	(1<<10)
821#define   SWF10_PIPEB_TV	(1<<9)
822#define   SWF10_PIPEB_CRT	(1<<8)
823#define   SWF10_PIPEA_LFP2	(1<<7)
824#define   SWF10_PIPEA_EFP2	(1<<6)
825#define   SWF10_PIPEA_TV2	(1<<5)
826#define   SWF10_PIPEA_CRT2	(1<<4)
827#define   SWF10_PIPEA_LFP	(1<<3)
828#define   SWF10_PIPEA_EFP	(1<<2)
829#define   SWF10_PIPEA_TV	(1<<1)
830#define   SWF10_PIPEA_CRT	(1<<0)
831
832#define SWF11_MEMORY_SIZE_SHIFT	16
833#define SWF11_SV_TEST_EN	(1<<15)
834#define SWF11_IS_AGP		(1<<14)
835#define SWF11_DISPLAY_HOLDOFF	(1<<13)
836#define SWF11_DPMS_REDUCED	(1<<12)
837#define SWF11_IS_VBE_MODE	(1<<11)
838#define SWF11_PIPEB_ACCESS	(1<<10) /* 0 here means pipe a */
839#define SWF11_DPMS_MASK		0x07
840#define   SWF11_DPMS_OFF	(1<<2)
841#define   SWF11_DPMS_SUSPEND	(1<<1)
842#define   SWF11_DPMS_STANDBY	(1<<0)
843#define   SWF11_DPMS_ON		0
844
845#define SWF14_GFX_PFIT_EN	(1<<31)
846#define SWF14_TEXT_PFIT_EN	(1<<30)
847#define SWF14_LID_STATUS_CLOSED	(1<<29) /* 0 here means open */
848#define SWF14_POPUP_EN		(1<<28)
849#define SWF14_DISPLAY_HOLDOFF	(1<<27)
850#define SWF14_DISP_DETECT_EN	(1<<26)
851#define SWF14_DOCKING_STATUS_DOCKED (1<<25) /* 0 here means undocked */
852#define SWF14_DRIVER_STATUS	(1<<24)
853#define SWF14_OS_TYPE_WIN9X	(1<<23)
854#define SWF14_OS_TYPE_WINNT	(1<<22)
855/* 21:19 rsvd */
856#define SWF14_PM_TYPE_MASK	0x00070000
857#define   SWF14_PM_ACPI_VIDEO	(0x4 << 16)
858#define   SWF14_PM_ACPI		(0x3 << 16)
859#define   SWF14_PM_APM_12	(0x2 << 16)
860#define   SWF14_PM_APM_11	(0x1 << 16)
861#define SWF14_HK_REQUEST_MASK	0x0000ffff /* see GR18 6:3 for event type */
862          /* if GR18 indicates a display switch */
863#define   SWF14_DS_PIPEB_LFP2_EN (1<<15)
864#define   SWF14_DS_PIPEB_EFP2_EN (1<<14)
865#define   SWF14_DS_PIPEB_TV2_EN  (1<<13)
866#define   SWF14_DS_PIPEB_CRT2_EN (1<<12)
867#define   SWF14_DS_PIPEB_LFP_EN  (1<<11)
868#define   SWF14_DS_PIPEB_EFP_EN  (1<<10)
869#define   SWF14_DS_PIPEB_TV_EN   (1<<9)
870#define   SWF14_DS_PIPEB_CRT_EN  (1<<8)
871#define   SWF14_DS_PIPEA_LFP2_EN (1<<7)
872#define   SWF14_DS_PIPEA_EFP2_EN (1<<6)
873#define   SWF14_DS_PIPEA_TV2_EN  (1<<5)
874#define   SWF14_DS_PIPEA_CRT2_EN (1<<4)
875#define   SWF14_DS_PIPEA_LFP_EN  (1<<3)
876#define   SWF14_DS_PIPEA_EFP_EN  (1<<2)
877#define   SWF14_DS_PIPEA_TV_EN   (1<<1)
878#define   SWF14_DS_PIPEA_CRT_EN  (1<<0)
879          /* if GR18 indicates a panel fitting request */
880#define   SWF14_PFIT_EN		(1<<0) /* 0 means disable */
881          /* if GR18 indicates an APM change request */
882#define   SWF14_APM_HIBERNATE	0x4
883#define   SWF14_APM_SUSPEND	0x3
884#define   SWF14_APM_STANDBY	0x1
885#define   SWF14_APM_RESTORE	0x0
886
887/* Block 52 contains MIPI configuration block
888 * 6 * bdb_mipi_config, followed by 6 pps data block
889 * block below
890 */
891#define MAX_MIPI_CONFIGURATIONS	6
892
893struct bdb_mipi_config {
894	struct mipi_config config[MAX_MIPI_CONFIGURATIONS];
895	struct mipi_pps_data pps[MAX_MIPI_CONFIGURATIONS];
896} __packed;
897
898/* Block 53 contains MIPI sequences as needed by the panel
899 * for enabling it. This block can be variable in size and
900 * can be maximum of 6 blocks
901 */
902struct bdb_mipi_sequence {
903	u8 version;
904	u8 data[0];
905} __packed;
906
907enum mipi_gpio_pin_index {
908	MIPI_GPIO_UNDEFINED = 0,
909	MIPI_GPIO_PANEL_ENABLE,
910	MIPI_GPIO_BL_ENABLE,
911	MIPI_GPIO_PWM_ENABLE,
912	MIPI_GPIO_RESET_N,
913	MIPI_GPIO_PWR_DOWN_R,
914	MIPI_GPIO_STDBY_RST_N,
915	MIPI_GPIO_MAX
916};
917
918#endif /* _INTEL_VBT_DEFS_H_ */