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

Archive Download this file

Revision: 1676