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

Archive Download this file

Revision: 1142