README revision 1.1.1.3 1 1.1.1.3 mrg OpenChrome Version 0.4.0 Release Note (March 30th, 2016)
2 1.1.1.3 mrg --------------------------------------------------------
3 1.1 mrg
4 1.1.1.3 mrg OpenChrome is an open source implementation of x.org X Server
5 1.1.1.3 mrg DDX (Device Dependent X) graphics device driver for VIA Technologies
6 1.1.1.3 mrg UniChrome and Chrome9 IGPs (Integrated Graphics Processor).
7 1.1.1.3 mrg Please note that OpenChrome does not support VIA Technologies IGPs
8 1.1.1.3 mrg that are related to Trident Microsystems (i.e., Apollo MVP4, PLE133,
9 1.1.1.3 mrg and KLE133) or S3 Graphics (i.e., KM266).
10 1.1.1.3 mrg Here is the project home page for OpenChrome.
11 1.1 mrg
12 1.1.1.3 mrg http://www.freedesktop.org/wiki/Openchrome/
13 1.1 mrg
14 1.1.1.3 mrg Please note that VIA Technologies does not support OpenChrome in any way.
15 1.1.1.3 mrg
16 1.1.1.3 mrg
17 1.1.1.3 mrg Supported Chipsets
18 1.1.1.3 mrg ------------------
19 1.1.1.3 mrg
20 1.1.1.3 mrg - CLE266
21 1.1.1.3 mrg - KM400 / KM400A / KN400 / P4M800
22 1.1.1.3 mrg - K8M800 / K8N800
23 1.1.1.3 mrg - PM800 / PN800 / PM880 / CN333 / CN400
24 1.1.1.3 mrg - P4M800 Pro / VN800 / CN700
25 1.1.1.3 mrg - CX700 / VX700
26 1.1.1.3 mrg - P4M890 / VN890 / CN800
27 1.1.1.3 mrg - K8M890 / K8N890
28 1.1.1.3 mrg - P4M900 / VN896 / CN896
29 1.1.1.3 mrg - VX800 / VX820
30 1.1.1.3 mrg - VX855 / VX875
31 1.1.1.3 mrg - VX900
32 1.1.1.3 mrg
33 1.1.1.3 mrg
34 1.1.1.3 mrg Supported Features
35 1.1.1.3 mrg ------------------
36 1.1.1.3 mrg
37 1.1.1.3 mrg - VGA
38 1.1.1.3 mrg - DVI from an integrated TMDS transmitter (CX700, VX700, and
39 1.1.1.3 mrg VX900 chipsets)
40 1.1.1.3 mrg - LVDS flat panel (i.e., laptop LCD flat panel)
41 1.1.1.3 mrg - EXA acceleration (RENDER acceleration)
42 1.1.1.3 mrg - Xv and XvMC
43 1.1.1.3 mrg - Dual screen (Screen clone mode only. No extended screen support at
44 1.1.1.3 mrg this point.)
45 1.1.1.3 mrg
46 1.1.1.3 mrg
47 1.1.1.3 mrg Unproven Features
48 1.1.1.3 mrg -----------------
49 1.1.1.3 mrg
50 1.1.1.3 mrg - Standby (ACPI S1 and S3 State) resume
51 1.1.1.3 mrg - TV out
52 1.1.1.3 mrg - KMS support (Kernel Mode Setting; requires the use of VIA
53 1.1.1.3 mrg Technologies IGP DRM module supporting KMS. See "Where to Obtain
54 1.1.1.3 mrg OpenChrome Source Code" chapter for more details.)
55 1.1.1.3 mrg
56 1.1.1.3 mrg
57 1.1.1.3 mrg Unimplemented Features
58 1.1.1.3 mrg ----------------------
59 1.1.1.3 mrg
60 1.1.1.3 mrg - Extended screen support
61 1.1.1.3 mrg - Hardware cursor support for CLE266, KM400, KM400A, KN400, and
62 1.1.1.3 mrg P4M800 chipsets
63 1.1.1.3 mrg - DVI via VT1632A TMDS transmitter (functionality is currently disabled)
64 1.1.1.3 mrg - DVI via Silicon Image SiI 164 TMDS transmitter
65 1.1.1.3 mrg - External HDMI transmitter (i.e., Jetway J7F5M-VHE-LF motherboard,
66 1.1.1.3 mrg VIA Embedded EPIA-P720 motherboard, etc.)
67 1.1.1.3 mrg - DisplayPort and HDMI support for VX900 chipset (Might work with
68 1.1.1.3 mrg the experimental DRM module that supports KMS. See "Where to Obtain
69 1.1.1.3 mrg OpenChrome Source Code" chapter for more details.)
70 1.1.1.3 mrg
71 1.1.1.3 mrg
72 1.1.1.3 mrg What's New for OpenChrome Version 0.4.0
73 1.1.1.3 mrg ---------------------------------------
74 1.1.1.3 mrg
75 1.1.1.3 mrg OpenChrome Version 0.4.0 is a major break from the past versions where
76 1.1.1.3 mrg configuring the display resources were done manually. Now the displays
77 1.1.1.3 mrg are detected mostly automatically, although a few manual options still
78 1.1.1.3 mrg remain. These will be retired in the near future. Besides that, two
79 1.1.1.3 mrg alternative mode setting options were discontinued (VBE mode setting
80 1.1.1.3 mrg and "legacy" mode setting), in order to simplify the code. A regression
81 1.1.1.3 mrg affecting those with DVI to VGA adapter, which appeared in OpenChrome
82 1.1.1.3 mrg Version 0.3.x, is fixed. More importantly, devices that were not
83 1.1.1.3 mrg registered with a known device table (a table that is located
84 1.1.1.3 mrg internally inside the code) used to crash at boot time, but since this
85 1.1.1.3 mrg table was removed completely, this bug does not appear anymore.
86 1.1.1.3 mrg
87 1.1.1.3 mrg - Removal of VBE (VESA BIOS Extension) mode setting
88 1.1.1.3 mrg (removal of VBEModes and VbeSaveRestore options)
89 1.1.1.3 mrg - Removal of "legacy" mode setting
90 1.1.1.3 mrg (removal of ModeSwitchMethod option)
91 1.1.1.3 mrg - Removal of ActiveDevice option
92 1.1.1.3 mrg - Removal of ForcePanel option
93 1.1.1.3 mrg - Removal of PanelSize option
94 1.1.1.3 mrg - Removal of a known device table internally
95 1.1.1.3 mrg - Mostly automatic display detection
96 1.1.1.3 mrg - Fix for a regression affecting those with DVI to VGA adapter
97 1.1.1.3 mrg - Fix for a boot time crash for devices that were not on the known
98 1.1.1.3 mrg device table
99 1.1.1.3 mrg - Fix for a possible OLPC XO-1.5 detection issue (untested)
100 1.1.1.3 mrg - Fix for various small compilation warnings / errors
101 1.1.1.3 mrg
102 1.1.1.3 mrg
103 1.1.1.3 mrg Known Bugs for OpenChrome Version 0.4.0
104 1.1.1.3 mrg ---------------------------------------
105 1.1.1.3 mrg
106 1.1.1.3 mrg Please note that the developers are committed to fixing every one of
107 1.1.1.3 mrg these bugs eventually, but due to time and resource issues, these bugs
108 1.1.1.3 mrg remain in the code currently.
109 1.1.1.3 mrg
110 1.1.1.3 mrg
111 1.1.1.3 mrg * The computer will fail to boot if RCA composite Video is used
112 1.1.1.3 mrg
113 1.1.1.3 mrg This was observed with the following motherboard.
114 1.1.1.3 mrg
115 1.1.1.3 mrg - VIA Embedded EPIA-M motherboard (CLE266 chipset)
116 1.1.1.3 mrg
117 1.1.1.3 mrg
118 1.1.1.3 mrg * Resume from ACPI S3 State or Suspend to RAM (STR) will cause a hang
119 1.1.1.3 mrg
120 1.1.1.3 mrg This was observed with the following motherboards.
121 1.1.1.3 mrg
122 1.1.1.3 mrg - VIA Embedded EPIA-CL motherboard (CLE266 chipset)
123 1.1.1.3 mrg - VIA Embedded EPIA-M motherboard (CLE266 chipset)
124 1.1.1.3 mrg - Foxconn 400M01-G-6L motherboard (KM400 chipset)
125 1.1.1.3 mrg - VIA Embedded EPIA-M830 motherboard (VX800 chipset)
126 1.1.1.3 mrg - Quanta IL1 laptop (VX800 chipset)
127 1.1.1.3 mrg
128 1.1.1.3 mrg
129 1.1.1.3 mrg * Resume from ACPI S3 State or Suspend to RAM (STR) will not cause
130 1.1.1.3 mrg a hang, but LVDS flat panel screen is lost or gets messed up
131 1.1.1.3 mrg
132 1.1.1.3 mrg If VGA still works, you might still be able to partially operate the
133 1.1.1.3 mrg computer. This was observed with the following computer.
134 1.1.1.3 mrg
135 1.1.1.3 mrg - Sylvania gnet 13001 netbook (VX700 chipset)
136 1.1.1.3 mrg - Epic Learning Epic 1314 laptop (MSI VR321 laptop equivalent,
137 1.1.1.3 mrg VN896 chipset)
138 1.1.1.3 mrg
139 1.1.1.3 mrg
140 1.1.1.3 mrg * There is no cursor on the screen in Lubuntu 10.04
141 1.1.1.3 mrg
142 1.1.1.3 mrg This bug affects CLE266, KM400, KM400A, KN400, and P4M800 chipsets.
143 1.1.1.3 mrg It is related to the lack of hardware cursor support in OpenChrome
144 1.1.1.3 mrg code for these chipsets at the present time. This bug does not affect
145 1.1.1.3 mrg Ubuntu 10.04 LTS.
146 1.1.1.3 mrg
147 1.1.1.3 mrg
148 1.1.1.3 mrg * Window title for LXTerminal is not displayed correctly in
149 1.1.1.3 mrg Lubuntu 10.04
150 1.1.1.3 mrg
151 1.1.1.3 mrg This bug likely affects every supported chipset.
152 1.1.1.3 mrg
153 1.1.1.3 mrg
154 1.1.1.3 mrg * DVI does not work
155 1.1.1.3 mrg
156 1.1.1.3 mrg DVI coming out of VT1632A DVI transmitter chip is currently broken,
157 1.1.1.3 mrg so the code to initialize it is currently disabled. Another possibility
158 1.1.1.3 mrg is that DVI is coming out of Silicon Image SiI 164 TMDS transmitter.
159 1.1.1.3 mrg SiI 164 is not supported by OpenChrome at this time.
160 1.1.1.3 mrg
161 1.1.1.3 mrg
162 1.1.1.3 mrg * DVI and flat panel does not work simultaneously in clone mode
163 1.1.1.3 mrg
164 1.1.1.3 mrg This has been observed with Sylvania gnet 13001 netbook (i.e., laptops
165 1.1.1.3 mrg based on VIA Technologies NanoBook reference design).
166 1.1.1.3 mrg
167 1.1.1.3 mrg
168 1.1.1.3 mrg * GUI screen will crash when the screen resolution is changed via a
169 1.1.1.3 mrg utility
170 1.1.1.3 mrg
171 1.1.1.3 mrg This bug has been observed in Lubuntu 12.04, but likely affects other
172 1.1.1.3 mrg OSes.
173 1.1.1.3 mrg
174 1.1.1.3 mrg
175 1.1.1.3 mrg How to Contact OpenChrome Developers
176 1.1.1.3 mrg ------------------------------------
177 1.1.1.3 mrg
178 1.1.1.3 mrg Please visit these OpenChrome mailing lists.
179 1.1.1.3 mrg
180 1.1.1.3 mrg http://lists.freedesktop.org/mailman/listinfo/openchrome-users
181 1.1.1.3 mrg http://lists.freedesktop.org/mailman/listinfo/openchrome-devel
182 1.1.1.3 mrg
183 1.1.1.3 mrg openchrome-users mailing list is meant for casual, non-technical
184 1.1.1.3 mrg users asking questions about how to use OpenChrome, etc.
185 1.1.1.3 mrg openchrome-devel mailing list is for discussing OpenChrome development
186 1.1.1.3 mrg issues.
187 1.1.1.3 mrg
188 1.1.1.3 mrg
189 1.1.1.3 mrg Where to File a Bug Report
190 1.1.1.3 mrg --------------------------
191 1.1.1.3 mrg
192 1.1.1.3 mrg In order to file a bug report, please visit http://bugs.freedesktop.org.
193 1.1.1.3 mrg When you file the bug, file it against "xorg." When specifying the
194 1.1.1.3 mrg component, please select "Driver/openchrome." This allows a message to
195 1.1.1.3 mrg be sent to openchrome-devel mailing list, so that developers can be
196 1.1.1.3 mrg notified of the bug.
197 1.1.1.3 mrg It is highly recommended to file the bug report over at
198 1.1.1.3 mrg http://bugs.freedesktop.org rather than sending a message to
199 1.1.1.3 mrg openchrome-devel mailing list. Also, filing a bug report against the
200 1.1.1.3 mrg Linux / BSD distribution you are using (i.e., Debian, Ubuntu, Fedora,
201 1.1.1.3 mrg etc.) will likely be a waste of your time since the developers for those
202 1.1.1.3 mrg distributions do not directly work on developing OpenChrome.
203 1.1.1.3 mrg
204 1.1.1.3 mrg
205 1.1.1.3 mrg Where to Submit a Patch
206 1.1.1.3 mrg -----------------------
207 1.1.1.3 mrg
208 1.1.1.3 mrg In order to submit a patch to improve OpenChrome, please visit
209 1.1.1.3 mrg http://bugs.freedesktop.org. Open a bug report and upload the patch there.
210 1.1.1.3 mrg When you file the bug, file it against "xorg." When specifying the
211 1.1.1.3 mrg component, please select "Driver/openchrome." This allows a message to
212 1.1.1.3 mrg be sent to openchrome-devel mailing list, so that developers can be
213 1.1.1.3 mrg notified of the bug.
214 1.1.1.3 mrg
215 1.1.1.3 mrg
216 1.1.1.3 mrg Where to Obtain OpenChrome Source Code
217 1.1.1.3 mrg --------------------------------------
218 1.1.1.3 mrg
219 1.1.1.3 mrg The OpenChrome source code repository is located at.
220 1.1.1.3 mrg
221 1.1.1.3 mrg http://cgit.freedesktop.org/openchrome/xf86-video-openchrome/
222 1.1.1.3 mrg
223 1.1.1.3 mrg
224 1.1.1.3 mrg The experimental DRM (Direct Rendering Manager) module that supports
225 1.1.1.3 mrg KMS (Kernel Mode Setting) is located at.
226 1.1.1.3 mrg
227 1.1.1.3 mrg https://cgit.freedesktop.org/openchrome/drm-openchrome/tree/drivers/gpu/drm/via
228 1.1.1.3 mrg
229 1.1.1.3 mrg
230 1.1.1.3 mrg If You See a Bug
231 1.1.1.3 mrg ----------------
232 1.1.1.3 mrg
233 1.1.1.3 mrg If you see a bug, please don't be surprised. OpenChrome has been in
234 1.1.1.3 mrg development for more than 10 years. In that process, there were many
235 1.1.1.3 mrg different developers that wrote the code in varying ways. Due to the fact
236 1.1.1.3 mrg that OpenChrome is a unified graphics device driver that supports every
237 1.1.1.3 mrg UniChrome and Chrome9 IGP (even the VIA Technoloiges in house unified
238 1.1.1.3 mrg graphics device driver does not support the number of devices OpenChrome
239 1.1.1.3 mrg does), and UniChrome and Chrome9 IGPs tend to rely heavily on many
240 1.1.1.3 mrg different external encoders and transmitters. As a result, it is very
241 1.1.1.3 mrg difficult to get the code right for every possible configuration.
242 1.1.1.3 mrg Starting with OpenChrome Version 0.4.0, the project is under new
243 1.1.1.3 mrg management, and moving forward, the emphasis will be on device driver
244 1.1.1.3 mrg reliability, and code maintainability.
245 1.1.1.3 mrg
246 1.1.1.3 mrg (End of this document.)
247