Chameleon

Chameleon Svn Source Tree

Root/branches/cparm/doc/ModuleHelp.txt

1GUI module:␊
2----------␊
3 GUI=No Disable the GUI (Enabled by default).␊
4 "Boot Banner"=Yes|No Show boot banner in GUI mode (Enabled by default).␊
5 "Legacy Logo"=Yes|No Use the legacy grey apple logo (Disabled by default).␊
6 RandomTheme=Yes|No Enable/Disable switching skin randomly at boot time(Disabled by default).␊
7 ␊
8␊
9GraphicsEnabler module:␊
10----------------------␊
11 EnableGFXModule=Yes|No Fully enable/disable the GraphicsEnabler module (Enabled by default, if the module is installed)␊
12 ␊
13 UseAtiROM=Yes|No Use an alternate Ati ROM image ␊
14 (path: /Extra/<vendorid>_<devid>.rom)␊
15 UseNvidiaROM=Yes|No Use an alternate Nvidia ROM image ␊
16 (path: /Extra/<vendorid>_<devid>.rom)␊
17 VBIOS=Yes|No Inject VBIOS to device-properties.␊
18␊
19␊
20 NVIDIA card injection usage e.g: // TODO : add memory info for each card to this structure ␊
21␊
22␉␉<key>NVIDIA</key>␊
23␉␉<array>␊
24␉␉<dict>␊
25␉␉<key>Chipset Name</key>␊
26␉␉<string>Quadro FX 380</string>␊
27␉␉<key>IOPCIPrimaryMatch</key>␊
28␉␉<string>0x10DE0658</string>␊
29␉␉</dict>␊
30␉␉.␊
31␉␉.␊
32␉␉.␊
33␉␉.␊
34␉␉</array>␊
35␊
36Networking module:␊
37-----------------␊
38 EnableNetworkModule=Yes|No␉Fully enable/disable the Networking module (Enabled by default, if the module is installed)␊
39␊
40 EthernetBuiltIn=Yes|No␉␉Automatic "built-in"=yes device-properties generation␊
41␉␉␉␉␉␉␉␉for ethernet interfaces. (Enabled by default)␊
42 ␊
43 EnableWifi=Yes|No␉␉␉␉Enable wifi device-properties generation, if detected. (Enabled by default)␊
44␊
45␉␉␉␉␉␉ ␊
46Memory module:␊
47-------------␊
48 EnableMemoryModule=Yes|No␉ Fully enable/disable the Memory module (Enabled by default, if the module is installed)␊
49␊
50USBFix module:␊
51----------␊
52 EnableUSBModule=Yes|No␉ Fully enable/disable the USB module (Enabled by default, if the module is installed)␊
53␉␊
54 USBBusFix=Yes|No Enable all USB fixes below (except EHCIhard): (Enabled by default)␊
55 EHCIacquire=Yes|No Enable the EHCI fix .␊
56 UHCIreset=Yes|No Enable the UHCI fix .␊
57 USBLegacyOff=Yes|No Enable the USB Legacy fix .␊
58 ␊
59 EHCIhard = Yes|No␉␉␉ Try EHCI soft reset (Disabled by default)␊
60 ␊
61HPET module:␊
62-----------␊
63 EnableUSBModule=Yes|No␉ Fully enable/disable the HPET module (Enabled by default, if the module is installed)␊
64␊
65HibernateEnabler:␊
66----------------␊
67 EnableHibernateModule=Yes|No␉ Fully enable/disable the HibernateEnabler module (Enabled by default, if the module is installed)␊
68 ␊
69 Wake=No␉␉␉␉␉␉Disable wake up after hibernation (default: enabled).␊
70 ForceWake=Yes␉␉␉␉␉Force using the sleepimage (Disabled by default).␊
71 WakeImage=<file>␉␉␉␉Use an alternate sleepimage file. ␊
72␉␉␉␉␉␉␉␉(default path is /private/var/vm/sleepimage).␊
73␊
74SMBIOS modules:␊
75--------------␊
76 SMBIOS=<file> Use an alternate SMBIOS.plist file ␊
77 (default path: /Extra/SMBIOS.plist, ␊
78␉␉␉␉␉␉bt(0,0)/Extra/SMBIOS.plist).␊
79␊
80 SMBIOSdefaults=Yes|No Don't use the Default values for SMBIOS overriding␊
81 if smbios.plist doesn't exist, factory␊
82 values are kept(Disabled by default).␊
83␊
84 randomSerial=Yes|No Generate a machine serial number randomly, can be useful ␊
85␉␉␉ for iCloud registration(Disabled by default).␊
86␊
87RamDiskLoader module:␊
88-------------------- ␊
89 EnableRamDiskLoader=Yes|No␉Fully enable/disable the RamDiskLoader module (Enabled by default, if the module is installed)␊
90 ␊
91 md0=<file>␉␉␉␉␉Load raw img file into memory for use as XNU's md0␊
92␉␉␉␉␉␉␉␉ramdisk. /Extra/Postboot.img is used otherwise.␉␊
93␉␉␉␉␉␉ ␊
94Keymapper module:␊
95----------------␉␊
96 EnableKeyMapper=Yes|No␉Fully enable/disable the Keymapper module (Enabled by default, if the module is installed)␊
97␉␉␉␉␉ ␊
98 KeyboardType=<value>␉␉change the type of the Keyboard. (Default is QWERTY)␊
99␉␉␉␉␉␉␉for now only <value>="AZERTY" is supported.␊
100␊
101CPUfreq module:␊
102--------------␊
103 EnableCPUfreqModule=Yes|No␉Fully enable/disable the CPUfreq module (Enabled by default, if the module is installed)␊
104␊
105 FixFSB=Yes|No␉␉␉␉␉Enable alternative front side bus fix(Disabled by default).␊
106 ␊
107 MaxBusRatio=<n>␉(was BusRatio) Set the current Bus Ratio to n,␊
108 ␉␉␉ n must be a multiple of 10,␊
109␉␉␉ (eg. if you want to set a bus ratio to 8.5, n will be␊
110␉␉␉ 8.5*10=85), ␊
111␉␉␉ if n = 0, MaxBusRatio = Disable,␊
112␉␉␉ if not set, n = the current␊
113␉␉␉ bios bus ratio, set this value allow CPUfreq to ␊
114 fix some cosmetic issues.␊
115␉␉␉␉␉␉ ␉␉␉ ␊
116AcpiCodec module: ␊
117------------------␊
118 IMPORTANT NOTE: 1- with AcpiCodec all aml files must be placed in /Extra/Acpi/, alternate or overridden path is no longer supported␊
119 ␊
120 2- the name of the aml file(s) is not important anymore but it must contain the extention .aml, for example let suppose that you have 3 aml files: dsdt.aml, ssdt-0.aml and ssdt-1.aml␊
121 you can rename your dsdt file into blabla.aml, and rename your ssdt files into blablabla.aml and blablablabla.aml, acpicodec will auto-magically detect those files as 2 ssdt and one dsdt␊
122␊
123 EnableAcpiModule=Yes|No␉Fully enable/disable the Acpipatcher module (Enabled by default, if the module is installed)␊
124 ␊
125 RestartFix=Yes|No␉␉Enable/Disable internal restart fix patch (Enabled by default, only available for intel platform).␊
126␊
127 ResetType=0|1␉␉␉0 : PCI reset (Default)␊
128␉␉␉␉1 : keyboard reset ␊
129␊
130 EnableSpeedStep=Yes|No␉Enable/Disable GenerateCStates & GeneratePStates (Disabled by default).␊
131 ␊
132 GeneratePStates=Yes|No␉Enable/Disable Generate P-states SSDT table (Disabled by default).␊
133 GenerateCStates=Yes|No␉Enable/Disable Generate C-states SSDT table (Disabled by default).␊
134 EnableC4State=Yes|No␉␉Enable C4 state in C-states SSDT table, GenerateCStates=Yes is needed (Disabled by default).␊
135 ␊
136 StripAPICTable=Yes|No␉␉Enable/Disable Generate a stripped MADT (APIC) table (Enabled by default).␊
137␊
138 IntelFADTSpec=Yes|No␉␉Enable/Disable Intel recommendations for the FADT table (Enabled by default). ␊
139␉␉␉␉Warning : When enabled, this setting disable the C2 and C3 C-states, but be aware that these are the Intel's recommendations for the newest CPU, ␊
140␉␉␉␉␉ if you really need those c-states please disable IntelFADTSpec.␊
141␊
142 P-States=<dict>␉␉P-States fine tuning method, see usage below(GeneratePStates=Yes is needed).␊
143 ACPIDropTables=<dict>␉␉drop acpi table(s) method (can drop any unwanted tables), see usage below.␊
144 C-States=<dict>␉␉C-States fine tuning method, see usage below(GenerateCStates=Yes is needed).␊
145 ␊
146 ␉␉␉␉␉␉␉␊
147 UpdateACPI=Yes|No Enable/Disable ACPI version update(Disabled by default). ␉␉␉ ␊
148␊
149 MaxBusRatio=<n>␉(was BusRatio) Set the current Bus Ratio to n, ␊
150␉␉␉ n must be a multiple of 10,␊
151␉␉␉␉␉(eg. if you want to set a bus ratio to 8.5, n will be␊
152␉␉␉ 8.5*10=85), ␊
153␉␉␉ if n = 0, MaxBusRatio = Disable,␊
154␉␉␉ if set, Acpipatcher will drop every P-states with␊
155␉␉␉ a bus ratio higher than n.␊
156␉␉␉␉␉␉ ␊
157 MinBusRatio=<n>␉Set the Minimum Bus Ratio to n,␊
158␉␉␉ n must be a multiple of 10,␊
159␉␉␉ (eg. if you want to set the bus ratio to 8.5, n will be␊
160␉␉␉ 8.5*10=85), if set Acpipatcher will drop every ␊
161␉␉␉ P-states with a bus ratio lower than n, ␊
162␉␉␉ if n = 0, MinBusRatio = Disable.␊
163␉␉ ␊
164 P-States usage e.g: (by default all numbers must be expressed in base 16, ␊
165␉␉␉ except the pss statue key and base key itself)␊
166␉␉␊
167␉␉<key>P-States</key>␊
168␉␉<dict>␊
169␉␉<key>0</key> // the pss status (must be expressed in Base 10)␊
170␉␉<dict>␊
171␉␉<key>Bus Master Latency</key>␊
172␉␉<string>10</string>␊
173␉␉<key>Control</key>␊
174␉␉<string>18719</string>␊
175␉␉<key>CoreFreq</key>␊
176␉␉<string>3164</string>␊
177␉␉<key>Transition Latency</key>␊
178␉␉<string>10</string>␊
179␉␉</dict>␊
180 <key>1</key> // the pss status (must be expressed in Base 10)␊
181 .␊
182 .␊
183 .␊
184␉␉<dict/>␊
185␉␉<key>2</key> // the pss status (must be expressed in Base 10)␊
186 .␊
187 .␊
188 .␊
189␉␉<dict/>␊
190 <key>X</key> // the pss status (must be expressed in Base 10)␊
191 .␊
192 .␊
193 .␊
194␉␉<dict/>␊
195␉␉<key>Base</key>␊
196␉␉<string>10</string> // must always be expressed in Base 10 ␊
197␉␉<key>Mode</key>␊
198␉␉<string>Default</string>␊
199␉␉</dict> ␉␊
200␉␉␉␉␉␉␉␉␉ ␊
201␊
202 C-States usage e.g: (by default all numbers must be expressed in base 16, ␊
203␉␉␉ except the base key itself)␊
204␊
205␉␉<key>C-states</key>␊
206␉␉<dict>␊
207␉␉<key>C1</key>␊
208␉␉<dict>␊
209␉␉<key>Latency</key>␊
210␉␉<string>THE LATENCY FOR THIS STATE</string>␊
211␉␉<key>Power</key>␊
212␉␉<string>THE POWER FOR THIS STATE</string>␊
213␉␉</dict>␊
214␉␉.␊
215␉␉.␉␉␉␉␉␉␉␊
216␉␉<key>C4</key>␊
217␉␉<dict>␊
218␉␉<key>Latency</key>␊
219␉␉<string>THE LATENCY FOR THIS STATE</string>␊
220␉␉<key>Power</key>␊
221␉␉<string>THE POWER FOR THIS STATE</string>␊
222␉␉</dict>␊
223␉␉</dict>␊
224␉␉␊
225 ACPIDropTables usage e.g: ␊
226␊
227␉␉<key>ACPIDropTables</key>␊
228␉␉<dict>␊
229␉␉<key>SSDT</key>␊
230␉␉<string></string> // drop SSDT table(s)␊
231␉␉<key>TAMG</key>␊
232␉␉<string>Yes</string> //drop TAMG table␊
233␉␉<key>ECDT</key>␊
234␉␉<string>ANY_VALUE_EXCEPT_NO</string> //drop ECDT table␊
235␉␉<key>XXXX</key>␊
236␉␉<string></string> //drop XXXX table (if exist)␊
237␉␉<key>YYYY</key>␊
238␉␉<string>No</string> //do not drop YYYY table (if exist)␊
239␉␉</dict>␊
240␊
241␊
242Acpipatcher module:␊
243------------------␊
244 EnableAcpiModule=Yes|No␉Fully enable/disable the Acpipatcher module (Enabled by default, if the module is installed)␊
245 ␊
246 RestartFix=Yes|No␉␉␉Enable/Disable internal restart fix patch(Enabled by default, only available for intel platform).␊
247 ␊
248 EnableSpeedStep=Yes|No␉Enable/Disable GenerateCStates & GeneratePStates (Disabled by default).␊
249 ␊
250 GeneratePStates=Yes|No␉Enable/Disable Generate P-states SSDT table (Disabled by default).␊
251 GenerateCStates=Yes|No␉Enable/Disable Generate C-states SSDT table (Disabled by default).␊
252 EnableC4State=Yes|No␉␉Enable C4 state in C-states SSDT table, GenerateCStates=Yes is needed (Disabled by default).␊
253 ␊
254 P-States=<dict>␉␉␉P-States fine tuning method, see usage below(GeneratePStates=Yes is needed).␊
255 ACPIDropTables=<dict>␉␉drop acpi table(s) method (can drop any unwanted tables), see usage below.␊
256 C-States=<dict>␉␉␉C-States fine tuning method, see usage below(GenerateCStates=Yes is needed).␊
257 ␊
258 DSDT=<file> ␉Use an alternate DSDT.aml file,␊
259␉␉␉ (default path: /DSDT.aml Extra/DSDT.aml,␊
260␉␉␉ bt(0,0)/Extra/DSDT.aml).␊
261␊
262 quickSSDTsearch=Yes|No If Yes, Acpipatcher will not search ssdt-(x+1).aml ␊
263␉␉␉ if ssdt-x.aml do not exist,␊
264␉␉␉ (eg. if ssdt-0.aml do not exist,␊
265 Acpipather will not search ssdt-1.aml)(Enabled by default).␊
266␉␉␉␉␉␉␉␊
267 UpdateACPI=Yes|No Enable/Disable ACPI version update(Disabled by default). ␉␉␉ ␊
268␊
269 MaxBusRatio=<n>␉(was BusRatio) Set the current Bus Ratio to n, ␊
270␉␉␉ n must be a multiple of 10,␊
271␉␉␉␉␉(eg. if you want to set a bus ratio to 8.5, n will be␊
272␉␉␉ 8.5*10=85), ␊
273␉␉␉ if n = 0, MaxBusRatio = Disable,␊
274␉␉␉ if set, Acpipatcher will drop every P-states with␊
275␉␉␉ a bus ratio higher than n.␊
276␉␉␉␉␉␉ ␊
277 MinBusRatio=<n>␉Set the Minimum Bus Ratio to n,␊
278␉␉␉ n must be a multiple of 10,␊
279␉␉␉ (eg. if you want to set the bus ratio to 8.5, n will be␊
280␉␉␉ 8.5*10=85), if set Acpipatcher will drop every ␊
281␉␉␉ P-states with a bus ratio lower than n, ␊
282␉␉␉ if n = 0, MinBusRatio = Disable.␊
283␉␉ ␊
284 P-States usage e.g: same as acpicodec ␉␉␉␉␉␉␉␉ ␊
285␊
286 C-States usage e.g: same as acpicodec ␊
287␉␉␊
288 ACPIDropTables usage e.g: same as acpicodec

Archive Download this file

Revision: 2010