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

Archive Download this file

Revision: HEAD