Merge branch 'drm-intel-next' of git://git.kernel.org/pub/scm/linux/kernel/git/anholt...
[linux-2.6] / drivers / gpu / drm / i915 / intel_bios.h
1 /*
2  * Copyright © 2006 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 #ifndef _I830_BIOS_H_
29 #define _I830_BIOS_H_
30
31 #include "drmP.h"
32
33 struct vbt_header {
34         u8 signature[20];               /**< Always starts with 'VBT$' */
35         u16 version;                    /**< decimal */
36         u16 header_size;                /**< in bytes */
37         u16 vbt_size;                   /**< in bytes */
38         u8 vbt_checksum;
39         u8 reserved0;
40         u32 bdb_offset;                 /**< from beginning of VBT */
41         u32 aim_offset[4];              /**< from beginning of VBT */
42 } __attribute__((packed));
43
44 struct bdb_header {
45         u8 signature[16];               /**< Always 'BIOS_DATA_BLOCK' */
46         u16 version;                    /**< decimal */
47         u16 header_size;                /**< in bytes */
48         u16 bdb_size;                   /**< in bytes */
49 };
50
51 /* strictly speaking, this is a "skip" block, but it has interesting info */
52 struct vbios_data {
53         u8 type; /* 0 == desktop, 1 == mobile */
54         u8 relstage;
55         u8 chipset;
56         u8 lvds_present:1;
57         u8 tv_present:1;
58         u8 rsvd2:6; /* finish byte */
59         u8 rsvd3[4];
60         u8 signon[155];
61         u8 copyright[61];
62         u16 code_segment;
63         u8 dos_boot_mode;
64         u8 bandwidth_percent;
65         u8 rsvd4; /* popup memory size */
66         u8 resize_pci_bios;
67         u8 rsvd5; /* is crt already on ddc2 */
68 } __attribute__((packed));
69
70 /*
71  * There are several types of BIOS data blocks (BDBs), each block has
72  * an ID and size in the first 3 bytes (ID in first, size in next 2).
73  * Known types are listed below.
74  */
75 #define BDB_GENERAL_FEATURES      1
76 #define BDB_GENERAL_DEFINITIONS   2
77 #define BDB_OLD_TOGGLE_LIST       3
78 #define BDB_MODE_SUPPORT_LIST     4
79 #define BDB_GENERIC_MODE_TABLE    5
80 #define BDB_EXT_MMIO_REGS         6
81 #define BDB_SWF_IO                7
82 #define BDB_SWF_MMIO              8
83 #define BDB_DOT_CLOCK_TABLE       9
84 #define BDB_MODE_REMOVAL_TABLE   10
85 #define BDB_CHILD_DEVICE_TABLE   11
86 #define BDB_DRIVER_FEATURES      12
87 #define BDB_DRIVER_PERSISTENCE   13
88 #define BDB_EXT_TABLE_PTRS       14
89 #define BDB_DOT_CLOCK_OVERRIDE   15
90 #define BDB_DISPLAY_SELECT       16
91 /* 17 rsvd */
92 #define BDB_DRIVER_ROTATION      18
93 #define BDB_DISPLAY_REMOVE       19
94 #define BDB_OEM_CUSTOM           20
95 #define BDB_EFP_LIST             21 /* workarounds for VGA hsync/vsync */
96 #define BDB_SDVO_LVDS_OPTIONS    22
97 #define BDB_SDVO_PANEL_DTDS      23
98 #define BDB_SDVO_LVDS_PNP_IDS    24
99 #define BDB_SDVO_LVDS_POWER_SEQ  25
100 #define BDB_TV_OPTIONS           26
101 #define BDB_LVDS_OPTIONS         40
102 #define BDB_LVDS_LFP_DATA_PTRS   41
103 #define BDB_LVDS_LFP_DATA        42
104 #define BDB_LVDS_BACKLIGHT       43
105 #define BDB_LVDS_POWER           44
106 #define BDB_SKIP                254 /* VBIOS private block, ignore */
107
108 struct bdb_general_features {
109         /* bits 1 */
110         u8 panel_fitting:2;
111         u8 flexaim:1;
112         u8 msg_enable:1;
113         u8 clear_screen:3;
114         u8 color_flip:1;
115
116         /* bits 2 */
117         u8 download_ext_vbt:1;
118         u8 enable_ssc:1;
119         u8 ssc_freq:1;
120         u8 enable_lfp_on_override:1;
121         u8 disable_ssc_ddt:1;
122         u8 rsvd8:3; /* finish byte */
123
124         /* bits 3 */
125         u8 disable_smooth_vision:1;
126         u8 single_dvi:1;
127         u8 rsvd9:6; /* finish byte */
128
129         /* bits 4 */
130         u8 legacy_monitor_detect;
131
132         /* bits 5 */
133         u8 int_crt_support:1;
134         u8 int_tv_support:1;
135         u8 rsvd11:6; /* finish byte */
136 } __attribute__((packed));
137
138 /* pre-915 */
139 #define GPIO_PIN_DVI_LVDS       0x03 /* "DVI/LVDS DDC GPIO pins" */
140 #define GPIO_PIN_ADD_I2C        0x05 /* "ADDCARD I2C GPIO pins" */
141 #define GPIO_PIN_ADD_DDC        0x04 /* "ADDCARD DDC GPIO pins" */
142 #define GPIO_PIN_ADD_DDC_I2C    0x06 /* "ADDCARD DDC/I2C GPIO pins" */
143
144 /* Pre 915 */
145 #define DEVICE_TYPE_NONE        0x00
146 #define DEVICE_TYPE_CRT         0x01
147 #define DEVICE_TYPE_TV          0x09
148 #define DEVICE_TYPE_EFP         0x12
149 #define DEVICE_TYPE_LFP         0x22
150 /* On 915+ */
151 #define DEVICE_TYPE_CRT_DPMS            0x6001
152 #define DEVICE_TYPE_CRT_DPMS_HOTPLUG    0x4001
153 #define DEVICE_TYPE_TV_COMPOSITE        0x0209
154 #define DEVICE_TYPE_TV_MACROVISION      0x0289
155 #define DEVICE_TYPE_TV_RF_COMPOSITE     0x020c
156 #define DEVICE_TYPE_TV_SVIDEO_COMPOSITE 0x0609
157 #define DEVICE_TYPE_TV_SCART            0x0209
158 #define DEVICE_TYPE_TV_CODEC_HOTPLUG_PWR 0x6009
159 #define DEVICE_TYPE_EFP_HOTPLUG_PWR     0x6012
160 #define DEVICE_TYPE_EFP_DVI_HOTPLUG_PWR 0x6052
161 #define DEVICE_TYPE_EFP_DVI_I           0x6053
162 #define DEVICE_TYPE_EFP_DVI_D_DUAL      0x6152
163 #define DEVICE_TYPE_EFP_DVI_D_HDCP      0x60d2
164 #define DEVICE_TYPE_OPENLDI_HOTPLUG_PWR 0x6062
165 #define DEVICE_TYPE_OPENLDI_DUALPIX     0x6162
166 #define DEVICE_TYPE_LFP_PANELLINK       0x5012
167 #define DEVICE_TYPE_LFP_CMOS_PWR        0x5042
168 #define DEVICE_TYPE_LFP_LVDS_PWR        0x5062
169 #define DEVICE_TYPE_LFP_LVDS_DUAL       0x5162
170 #define DEVICE_TYPE_LFP_LVDS_DUAL_HDCP  0x51e2
171
172 #define DEVICE_CFG_NONE         0x00
173 #define DEVICE_CFG_12BIT_DVOB   0x01
174 #define DEVICE_CFG_12BIT_DVOC   0x02
175 #define DEVICE_CFG_24BIT_DVOBC  0x09
176 #define DEVICE_CFG_24BIT_DVOCB  0x0a
177 #define DEVICE_CFG_DUAL_DVOB    0x11
178 #define DEVICE_CFG_DUAL_DVOC    0x12
179 #define DEVICE_CFG_DUAL_DVOBC   0x13
180 #define DEVICE_CFG_DUAL_LINK_DVOBC      0x19
181 #define DEVICE_CFG_DUAL_LINK_DVOCB      0x1a
182
183 #define DEVICE_WIRE_NONE        0x00
184 #define DEVICE_WIRE_DVOB        0x01
185 #define DEVICE_WIRE_DVOC        0x02
186 #define DEVICE_WIRE_DVOBC       0x03
187 #define DEVICE_WIRE_DVOBB       0x05
188 #define DEVICE_WIRE_DVOCC       0x06
189 #define DEVICE_WIRE_DVOB_MASTER 0x0d
190 #define DEVICE_WIRE_DVOC_MASTER 0x0e
191
192 #define DEVICE_PORT_DVOA        0x00 /* none on 845+ */
193 #define DEVICE_PORT_DVOB        0x01
194 #define DEVICE_PORT_DVOC        0x02
195
196 struct child_device_config {
197         u16 handle;
198         u16 device_type;
199         u8  device_id[10]; /* See DEVICE_TYPE_* above */
200         u16 addin_offset;
201         u8  dvo_port; /* See Device_PORT_* above */
202         u8  i2c_pin;
203         u8  slave_addr;
204         u8  ddc_pin;
205         u16 edid_ptr;
206         u8  dvo_cfg; /* See DEVICE_CFG_* above */
207         u8  dvo2_port;
208         u8  i2c2_pin;
209         u8  slave2_addr;
210         u8  ddc2_pin;
211         u8  capabilities;
212         u8  dvo_wiring;/* See DEVICE_WIRE_* above */
213         u8  dvo2_wiring;
214         u16 extended_type;
215         u8  dvo_function;
216 } __attribute__((packed));
217
218 struct bdb_general_definitions {
219         /* DDC GPIO */
220         u8 crt_ddc_gmbus_pin;
221
222         /* DPMS bits */
223         u8 dpms_acpi:1;
224         u8 skip_boot_crt_detect:1;
225         u8 dpms_aim:1;
226         u8 rsvd1:5; /* finish byte */
227
228         /* boot device bits */
229         u8 boot_display[2];
230         u8 child_dev_size;
231
232         /*
233          * Device info:
234          * If TV is present, it'll be at devices[0].
235          * LVDS will be next, either devices[0] or [1], if present.
236          * On some platforms the number of device is 6. But could be as few as
237          * 4 if both TV and LVDS are missing.
238          * And the device num is related with the size of general definition
239          * block. It is obtained by using the following formula:
240          * number = (block_size - sizeof(bdb_general_definitions))/
241          *              sizeof(child_device_config);
242          */
243         struct child_device_config devices[0];
244 } __attribute__((packed));
245
246 struct bdb_lvds_options {
247         u8 panel_type;
248         u8 rsvd1;
249         /* LVDS capabilities, stored in a dword */
250         u8 pfit_mode:2;
251         u8 pfit_text_mode_enhanced:1;
252         u8 pfit_gfx_mode_enhanced:1;
253         u8 pfit_ratio_auto:1;
254         u8 pixel_dither:1;
255         u8 lvds_edid:1;
256         u8 rsvd2:1;
257         u8 rsvd4;
258 } __attribute__((packed));
259
260 /* LFP pointer table contains entries to the struct below */
261 struct bdb_lvds_lfp_data_ptr {
262         u16 fp_timing_offset; /* offsets are from start of bdb */
263         u8 fp_table_size;
264         u16 dvo_timing_offset;
265         u8 dvo_table_size;
266         u16 panel_pnp_id_offset;
267         u8 pnp_table_size;
268 } __attribute__((packed));
269
270 struct bdb_lvds_lfp_data_ptrs {
271         u8 lvds_entries; /* followed by one or more lvds_data_ptr structs */
272         struct bdb_lvds_lfp_data_ptr ptr[16];
273 } __attribute__((packed));
274
275 /* LFP data has 3 blocks per entry */
276 struct lvds_fp_timing {
277         u16 x_res;
278         u16 y_res;
279         u32 lvds_reg;
280         u32 lvds_reg_val;
281         u32 pp_on_reg;
282         u32 pp_on_reg_val;
283         u32 pp_off_reg;
284         u32 pp_off_reg_val;
285         u32 pp_cycle_reg;
286         u32 pp_cycle_reg_val;
287         u32 pfit_reg;
288         u32 pfit_reg_val;
289         u16 terminator;
290 } __attribute__((packed));
291
292 struct lvds_dvo_timing {
293         u16 clock;              /**< In 10khz */
294         u8 hactive_lo;
295         u8 hblank_lo;
296         u8 hblank_hi:4;
297         u8 hactive_hi:4;
298         u8 vactive_lo;
299         u8 vblank_lo;
300         u8 vblank_hi:4;
301         u8 vactive_hi:4;
302         u8 hsync_off_lo;
303         u8 hsync_pulse_width;
304         u8 vsync_pulse_width:4;
305         u8 vsync_off:4;
306         u8 rsvd0:6;
307         u8 hsync_off_hi:2;
308         u8 h_image;
309         u8 v_image;
310         u8 max_hv;
311         u8 h_border;
312         u8 v_border;
313         u8 rsvd1:3;
314         u8 digital:2;
315         u8 vsync_positive:1;
316         u8 hsync_positive:1;
317         u8 rsvd2:1;
318 } __attribute__((packed));
319
320 struct lvds_pnp_id {
321         u16 mfg_name;
322         u16 product_code;
323         u32 serial;
324         u8 mfg_week;
325         u8 mfg_year;
326 } __attribute__((packed));
327
328 struct bdb_lvds_lfp_data_entry {
329         struct lvds_fp_timing fp_timing;
330         struct lvds_dvo_timing dvo_timing;
331         struct lvds_pnp_id pnp_id;
332 } __attribute__((packed));
333
334 struct bdb_lvds_lfp_data {
335         struct bdb_lvds_lfp_data_entry data[16];
336 } __attribute__((packed));
337
338 struct aimdb_header {
339         char signature[16];
340         char oem_device[20];
341         u16 aimdb_version;
342         u16 aimdb_header_size;
343         u16 aimdb_size;
344 } __attribute__((packed));
345
346 struct aimdb_block {
347         u8 aimdb_id;
348         u16 aimdb_size;
349 } __attribute__((packed));
350
351 struct vch_panel_data {
352         u16 fp_timing_offset;
353         u8 fp_timing_size;
354         u16 dvo_timing_offset;
355         u8 dvo_timing_size;
356         u16 text_fitting_offset;
357         u8 text_fitting_size;
358         u16 graphics_fitting_offset;
359         u8 graphics_fitting_size;
360 } __attribute__((packed));
361
362 struct vch_bdb_22 {
363         struct aimdb_block aimdb_block;
364         struct vch_panel_data panels[16];
365 } __attribute__((packed));
366
367 struct bdb_sdvo_lvds_options {
368         u8 panel_backlight;
369         u8 h40_set_panel_type;
370         u8 panel_type;
371         u8 ssc_clk_freq;
372         u16 als_low_trip;
373         u16 als_high_trip;
374         u8 sclalarcoeff_tab_row_num;
375         u8 sclalarcoeff_tab_row_size;
376         u8 coefficient[8];
377         u8 panel_misc_bits_1;
378         u8 panel_misc_bits_2;
379         u8 panel_misc_bits_3;
380         u8 panel_misc_bits_4;
381 } __attribute__((packed));
382
383
384 bool intel_init_bios(struct drm_device *dev);
385
386 /*
387  * Driver<->VBIOS interaction occurs through scratch bits in
388  * GR18 & SWF*.
389  */
390
391 /* GR18 bits are set on display switch and hotkey events */
392 #define GR18_DRIVER_SWITCH_EN   (1<<7) /* 0: VBIOS control, 1: driver control */
393 #define GR18_HOTKEY_MASK        0x78 /* See also SWF4 15:0 */
394 #define   GR18_HK_NONE          (0x0<<3)
395 #define   GR18_HK_LFP_STRETCH   (0x1<<3)
396 #define   GR18_HK_TOGGLE_DISP   (0x2<<3)
397 #define   GR18_HK_DISP_SWITCH   (0x4<<3) /* see SWF14 15:0 for what to enable */
398 #define   GR18_HK_POPUP_DISABLED (0x6<<3)
399 #define   GR18_HK_POPUP_ENABLED (0x7<<3)
400 #define   GR18_HK_PFIT          (0x8<<3)
401 #define   GR18_HK_APM_CHANGE    (0xa<<3)
402 #define   GR18_HK_MULTIPLE      (0xc<<3)
403 #define GR18_USER_INT_EN        (1<<2)
404 #define GR18_A0000_FLUSH_EN     (1<<1)
405 #define GR18_SMM_EN             (1<<0)
406
407 /* Set by driver, cleared by VBIOS */
408 #define SWF00_YRES_SHIFT        16
409 #define SWF00_XRES_SHIFT        0
410 #define SWF00_RES_MASK          0xffff
411
412 /* Set by VBIOS at boot time and driver at runtime */
413 #define SWF01_TV2_FORMAT_SHIFT  8
414 #define SWF01_TV1_FORMAT_SHIFT  0
415 #define SWF01_TV_FORMAT_MASK    0xffff
416
417 #define SWF10_VBIOS_BLC_I2C_EN  (1<<29)
418 #define SWF10_GTT_OVERRIDE_EN   (1<<28)
419 #define SWF10_LFP_DPMS_OVR      (1<<27) /* override DPMS on display switch */
420 #define SWF10_ACTIVE_TOGGLE_LIST_MASK (7<<24)
421 #define   SWF10_OLD_TOGGLE      0x0
422 #define   SWF10_TOGGLE_LIST_1   0x1
423 #define   SWF10_TOGGLE_LIST_2   0x2
424 #define   SWF10_TOGGLE_LIST_3   0x3
425 #define   SWF10_TOGGLE_LIST_4   0x4
426 #define SWF10_PANNING_EN        (1<<23)
427 #define SWF10_DRIVER_LOADED     (1<<22)
428 #define SWF10_EXTENDED_DESKTOP  (1<<21)
429 #define SWF10_EXCLUSIVE_MODE    (1<<20)
430 #define SWF10_OVERLAY_EN        (1<<19)
431 #define SWF10_PLANEB_HOLDOFF    (1<<18)
432 #define SWF10_PLANEA_HOLDOFF    (1<<17)
433 #define SWF10_VGA_HOLDOFF       (1<<16)
434 #define SWF10_ACTIVE_DISP_MASK  0xffff
435 #define   SWF10_PIPEB_LFP2      (1<<15)
436 #define   SWF10_PIPEB_EFP2      (1<<14)
437 #define   SWF10_PIPEB_TV2       (1<<13)
438 #define   SWF10_PIPEB_CRT2      (1<<12)
439 #define   SWF10_PIPEB_LFP       (1<<11)
440 #define   SWF10_PIPEB_EFP       (1<<10)
441 #define   SWF10_PIPEB_TV        (1<<9)
442 #define   SWF10_PIPEB_CRT       (1<<8)
443 #define   SWF10_PIPEA_LFP2      (1<<7)
444 #define   SWF10_PIPEA_EFP2      (1<<6)
445 #define   SWF10_PIPEA_TV2       (1<<5)
446 #define   SWF10_PIPEA_CRT2      (1<<4)
447 #define   SWF10_PIPEA_LFP       (1<<3)
448 #define   SWF10_PIPEA_EFP       (1<<2)
449 #define   SWF10_PIPEA_TV        (1<<1)
450 #define   SWF10_PIPEA_CRT       (1<<0)
451
452 #define SWF11_MEMORY_SIZE_SHIFT 16
453 #define SWF11_SV_TEST_EN        (1<<15)
454 #define SWF11_IS_AGP            (1<<14)
455 #define SWF11_DISPLAY_HOLDOFF   (1<<13)
456 #define SWF11_DPMS_REDUCED      (1<<12)
457 #define SWF11_IS_VBE_MODE       (1<<11)
458 #define SWF11_PIPEB_ACCESS      (1<<10) /* 0 here means pipe a */
459 #define SWF11_DPMS_MASK         0x07
460 #define   SWF11_DPMS_OFF        (1<<2)
461 #define   SWF11_DPMS_SUSPEND    (1<<1)
462 #define   SWF11_DPMS_STANDBY    (1<<0)
463 #define   SWF11_DPMS_ON         0
464
465 #define SWF14_GFX_PFIT_EN       (1<<31)
466 #define SWF14_TEXT_PFIT_EN      (1<<30)
467 #define SWF14_LID_STATUS_CLOSED (1<<29) /* 0 here means open */
468 #define SWF14_POPUP_EN          (1<<28)
469 #define SWF14_DISPLAY_HOLDOFF   (1<<27)
470 #define SWF14_DISP_DETECT_EN    (1<<26)
471 #define SWF14_DOCKING_STATUS_DOCKED (1<<25) /* 0 here means undocked */
472 #define SWF14_DRIVER_STATUS     (1<<24)
473 #define SWF14_OS_TYPE_WIN9X     (1<<23)
474 #define SWF14_OS_TYPE_WINNT     (1<<22)
475 /* 21:19 rsvd */
476 #define SWF14_PM_TYPE_MASK      0x00070000
477 #define   SWF14_PM_ACPI_VIDEO   (0x4 << 16)
478 #define   SWF14_PM_ACPI         (0x3 << 16)
479 #define   SWF14_PM_APM_12       (0x2 << 16)
480 #define   SWF14_PM_APM_11       (0x1 << 16)
481 #define SWF14_HK_REQUEST_MASK   0x0000ffff /* see GR18 6:3 for event type */
482           /* if GR18 indicates a display switch */
483 #define   SWF14_DS_PIPEB_LFP2_EN (1<<15)
484 #define   SWF14_DS_PIPEB_EFP2_EN (1<<14)
485 #define   SWF14_DS_PIPEB_TV2_EN  (1<<13)
486 #define   SWF14_DS_PIPEB_CRT2_EN (1<<12)
487 #define   SWF14_DS_PIPEB_LFP_EN  (1<<11)
488 #define   SWF14_DS_PIPEB_EFP_EN  (1<<10)
489 #define   SWF14_DS_PIPEB_TV_EN   (1<<9)
490 #define   SWF14_DS_PIPEB_CRT_EN  (1<<8)
491 #define   SWF14_DS_PIPEA_LFP2_EN (1<<7)
492 #define   SWF14_DS_PIPEA_EFP2_EN (1<<6)
493 #define   SWF14_DS_PIPEA_TV2_EN  (1<<5)
494 #define   SWF14_DS_PIPEA_CRT2_EN (1<<4)
495 #define   SWF14_DS_PIPEA_LFP_EN  (1<<3)
496 #define   SWF14_DS_PIPEA_EFP_EN  (1<<2)
497 #define   SWF14_DS_PIPEA_TV_EN   (1<<1)
498 #define   SWF14_DS_PIPEA_CRT_EN  (1<<0)
499           /* if GR18 indicates a panel fitting request */
500 #define   SWF14_PFIT_EN         (1<<0) /* 0 means disable */
501           /* if GR18 indicates an APM change request */
502 #define   SWF14_APM_HIBERNATE   0x4
503 #define   SWF14_APM_SUSPEND     0x3
504 #define   SWF14_APM_STANDBY     0x1
505 #define   SWF14_APM_RESTORE     0x0
506
507 #endif /* _I830_BIOS_H_ */