1 | ␊ |
2 | /*␊ |
3 | * Copyright 2007 David F. Elliott.␉ All rights reserved.␊ |
4 | */␊ |
5 | ␊ |
6 | #include "libsaio.h"␊ |
7 | #include "boot.h"␊ |
8 | #include "bootstruct.h"␊ |
9 | #include "efi.h"␊ |
10 | #include "acpi.h"␊ |
11 | #include "fake_efi.h"␊ |
12 | #include "efi_tables.h"␊ |
13 | #include "platform.h"␊ |
14 | #include "acpi_patcher.h"␊ |
15 | #include "smbios.h"␊ |
16 | #include "device_inject.h"␊ |
17 | #include "convert.h"␊ |
18 | #include "pci.h"␊ |
19 | #include "sl.h"␊ |
20 | ␊ |
21 | extern void setup_pci_devs(pci_dt_t *pci_dt);␊ |
22 | ␊ |
23 | /*␊ |
24 | * Modern Darwin kernels require some amount of EFI because Apple machines all␊ |
25 | * have EFI. Modifying the kernel source to not require EFI is of course␊ |
26 | * possible but would have to be maintained as a separate patch because it is␊ |
27 | * unlikely that Apple wishes to add legacy support to their kernel.␊ |
28 | *␊ |
29 | * As you can see from the Apple-supplied code in bootstruct.c, it seems that␊ |
30 | * the intention was clearly to modify this booter to provide EFI-like structures␊ |
31 | * to the kernel rather than modifying the kernel to handle non-EFI stuff.␉ This␊ |
32 | * makes a lot of sense from an engineering point of view as it means the kernel␊ |
33 | * for the as yet unreleased EFI-only Macs could still be booted by the non-EFI␊ |
34 | * DTK systems so long as the kernel checked to ensure the boot tables were␊ |
35 | * filled in appropriately.␉ Modern xnu requires a system table and a runtime␊ |
36 | * services table and performs no checks whatsoever to ensure the pointers to␊ |
37 | * these tables are non-NULL.␉Therefore, any modern xnu kernel will page fault␊ |
38 | * early on in the boot process if the system table pointer is zero.␊ |
39 | *␊ |
40 | * Even before that happens, the tsc_init function in modern xnu requires the FSB␊ |
41 | * Frequency to be a property in the /efi/platform node of the device tree or else␊ |
42 | * it panics the bootstrap process very early on.␊ |
43 | *␊ |
44 | * As of this writing, the current implementation found here is good enough␊ |
45 | * to make the currently available xnu kernel boot without modification on a␊ |
46 | * system with an appropriate processor. With a minor source modification to␊ |
47 | * the tsc_init function to remove the explicit check for Core or Core 2␊ |
48 | * processors the kernel can be made to boot on other processors so long as␊ |
49 | * the code can be executed by the processor and the machine contains the␊ |
50 | * necessary hardware.␊ |
51 | */␊ |
52 | ␊ |
53 | /*==========================================================================␊ |
54 | * Utility function to make a device tree string from an EFI_GUID␊ |
55 | */␊ |
56 | ␊ |
57 | static inline char * mallocStringForGuid(EFI_GUID const *pGuid)␊ |
58 | {␊ |
59 | ␉char *string = malloc(37);␊ |
60 | ␉efi_guid_unparse_upper(pGuid, string);␊ |
61 | ␉return string;␊ |
62 | }␊ |
63 | ␊ |
64 | /*==========================================================================␊ |
65 | * Function to map 32 bit physical address to 64 bit virtual address␊ |
66 | */␊ |
67 | ␊ |
68 | static uint64_t ptov64(uint32_t addr)␊ |
69 | {␊ |
70 | ␉return ((uint64_t)addr | 0xFFFFFF8000000000ULL);␊ |
71 | }␊ |
72 | ␊ |
73 | /*==========================================================================␊ |
74 | * Fake EFI implementation␊ |
75 | */␊ |
76 | ␊ |
77 | /* Identify ourselves as the EFI firmware vendor */␊ |
78 | static EFI_CHAR16 const FIRMWARE_VENDOR[] = {'C','h','a','m','e','l','e','o','n','_','2','.','0', 0};␊ |
79 | static EFI_UINT32 const FIRMWARE_REVISION = 132; /* FIXME: Find a constant for this. */␊ |
80 | ␊ |
81 | /* Default platform system_id (fix by IntVar) */␊ |
82 | static EFI_CHAR8 const SYSTEM_ID[] = "0123456789ABCDEF"; //random value gen by uuidgen␊ |
83 | ␊ |
84 | /* Just a ret instruction */␊ |
85 | static uint8_t const VOIDRET_INSTRUCTIONS[] = {0xc3};␊ |
86 | ␊ |
87 | /* movl $0x80000003,%eax; ret */␊ |
88 | static uint8_t const UNSUPPORTEDRET_INSTRUCTIONS[] = {0xb8, 0x03, 0x00, 0x00, 0x80, 0xc3};␊ |
89 | ␊ |
90 | EFI_SYSTEM_TABLE_32 *gST32 = NULL;␊ |
91 | EFI_SYSTEM_TABLE_64 *gST64 = NULL;␊ |
92 | Node *gEfiConfigurationTableNode = NULL;␊ |
93 | ␊ |
94 | extern EFI_STATUS addConfigurationTable(EFI_GUID const *pGuid, void *table, char const *alias)␊ |
95 | {␊ |
96 | ␉EFI_UINTN i = 0;␊ |
97 | ␉␊ |
98 | ␉//Azi: as is, cpu's with em64t will use EFI64 on pre 10.6 systems,␊ |
99 | ␉// wich seems to cause no problem. In case it does, force i386 arch.␊ |
100 | ␉if (archCpuType == CPU_TYPE_I386)␊ |
101 | ␉{␊ |
102 | ␉␉i = gST32->NumberOfTableEntries;␊ |
103 | ␉}␊ |
104 | ␉else␊ |
105 | ␉{␊ |
106 | ␉␉i = gST64->NumberOfTableEntries;␊ |
107 | ␉}␊ |
108 | ␉␊ |
109 | ␉// We only do adds, not modifications and deletes like InstallConfigurationTable␊ |
110 | ␉if (i >= MAX_CONFIGURATION_TABLE_ENTRIES)␊ |
111 | ␉␉stop("Ran out of space for configuration tables. Increase the reserved size in the code.\n");␊ |
112 | ␉␊ |
113 | ␉if (pGuid == NULL)␊ |
114 | ␉␉return EFI_INVALID_PARAMETER;␊ |
115 | ␉␊ |
116 | ␉if (table != NULL)␊ |
117 | ␉{␊ |
118 | ␉␉// FIXME␊ |
119 | ␉␉//((EFI_CONFIGURATION_TABLE_64 *)gST->ConfigurationTable)[i].VendorGuid = *pGuid;␊ |
120 | ␉␉//((EFI_CONFIGURATION_TABLE_64 *)gST->ConfigurationTable)[i].VendorTable = (EFI_PTR64)table;␊ |
121 | ␉␉␊ |
122 | ␉␉//++gST->NumberOfTableEntries;␊ |
123 | ␉␉␊ |
124 | ␉␉Node *tableNode = DT__AddChild(gEfiConfigurationTableNode, mallocStringForGuid(pGuid));␊ |
125 | ␉␉␊ |
126 | ␉␉// Use the pointer to the GUID we just stuffed into the system table␊ |
127 | ␉␉DT__AddProperty(tableNode, "guid", sizeof(EFI_GUID), (void*)pGuid);␊ |
128 | ␉␉␊ |
129 | ␉␉// The "table" property is the 32-bit (in our implementation) physical address of the table␊ |
130 | ␉␉DT__AddProperty(tableNode, "table", sizeof(void*) * 2, table);␊ |
131 | ␉␉␊ |
132 | ␉␉// Assume the alias pointer is a global or static piece of data␊ |
133 | ␉␉if (alias != NULL)␊ |
134 | ␉␉␉DT__AddProperty(tableNode, "alias", strlen(alias)+1, (char*)alias);␊ |
135 | ␉␉␊ |
136 | ␉␉return EFI_SUCCESS;␊ |
137 | ␉}␊ |
138 | ␉return EFI_UNSUPPORTED;␊ |
139 | }␊ |
140 | ␊ |
141 | //Azi: crc32 done in place, on the cases were it wasn't.␊ |
142 | /*static inline void fixupEfiSystemTableCRC32(EFI_SYSTEM_TABLE_64 *efiSystemTable)␊ |
143 | {␊ |
144 | ␉efiSystemTable->Hdr.CRC32 = 0;␊ |
145 | ␉efiSystemTable->Hdr.CRC32 = crc32(0L, efiSystemTable, efiSystemTable->Hdr.HeaderSize);␊ |
146 | }*/␊ |
147 | ␊ |
148 | /*␊ |
149 | * What we do here is simply allocate a fake EFI system table and a fake EFI␊ |
150 | * runtime services table.␊ |
151 | *␊ |
152 | * Because we build against modern headers with kBootArgsRevision 4 we␊ |
153 | * also take care to set efiMode = 32.␊ |
154 | */␊ |
155 | ␊ |
156 | void setupEfiTables32(void)␊ |
157 | {␊ |
158 | ␉// We use the fake_efi_pages struct so that we only need to do one kernel␊ |
159 | ␉// memory allocation for all needed EFI data. Otherwise, small allocations␊ |
160 | ␉// like the FIRMWARE_VENDOR string would take up an entire page.␊ |
161 | ␉// NOTE WELL: Do NOT assume this struct has any particular layout within itself.␊ |
162 | ␉// It is absolutely not intended to be publicly exposed anywhere␊ |
163 | ␉// We say pages (plural) although right now we are well within the 1 page size␊ |
164 | ␉// and probably will stay that way.␊ |
165 | ␉struct fake_efi_pages␊ |
166 | ␉{␊ |
167 | ␉␉EFI_SYSTEM_TABLE_32 efiSystemTable;␊ |
168 | ␉␉EFI_RUNTIME_SERVICES_32 efiRuntimeServices;␊ |
169 | ␉␉EFI_CONFIGURATION_TABLE_32 efiConfigurationTable[MAX_CONFIGURATION_TABLE_ENTRIES];␊ |
170 | ␉␉EFI_CHAR16 firmwareVendor[sizeof(FIRMWARE_VENDOR)/sizeof(EFI_CHAR16)];␊ |
171 | ␉␉uint8_t voidret_instructions[sizeof(VOIDRET_INSTRUCTIONS)/sizeof(uint8_t)];␊ |
172 | ␉␉uint8_t unsupportedret_instructions[sizeof(UNSUPPORTEDRET_INSTRUCTIONS)/sizeof(uint8_t)];␊ |
173 | ␉};␊ |
174 | ␉␊ |
175 | ␉struct fake_efi_pages *fakeEfiPages = (struct fake_efi_pages*)AllocateKernelMemory(sizeof(struct fake_efi_pages));␊ |
176 | ␉␊ |
177 | ␉// Zero out all the tables in case fields are added later␊ |
178 | ␉bzero(fakeEfiPages, sizeof(struct fake_efi_pages));␊ |
179 | ␉␊ |
180 | ␉// --------------------------------------------------------------------␊ |
181 | ␉// Initialize some machine code that will return EFI_UNSUPPORTED for␊ |
182 | ␉// functions returning int and simply return for void functions.␊ |
183 | ␉memcpy(fakeEfiPages->voidret_instructions, VOIDRET_INSTRUCTIONS, sizeof(VOIDRET_INSTRUCTIONS));␊ |
184 | ␉memcpy(fakeEfiPages->unsupportedret_instructions, UNSUPPORTEDRET_INSTRUCTIONS, sizeof(UNSUPPORTEDRET_INSTRUCTIONS));␊ |
185 | ␉␊ |
186 | ␉// --------------------------------------------------------------------␊ |
187 | ␉// System table␊ |
188 | ␉EFI_SYSTEM_TABLE_32 *efiSystemTable = gST32 = &fakeEfiPages->efiSystemTable;␊ |
189 | ␉efiSystemTable->Hdr.Signature = EFI_SYSTEM_TABLE_SIGNATURE;␊ |
190 | ␉efiSystemTable->Hdr.Revision = EFI_SYSTEM_TABLE_REVISION;␊ |
191 | ␉efiSystemTable->Hdr.HeaderSize = sizeof(EFI_SYSTEM_TABLE_32);␊ |
192 | ␉efiSystemTable->Hdr.CRC32 = 0; // Initialize to zero and then do CRC32␊ |
193 | ␉efiSystemTable->Hdr.Reserved = 0;␊ |
194 | ␉␊ |
195 | ␉efiSystemTable->FirmwareVendor = (EFI_PTR32)&fakeEfiPages->firmwareVendor;␊ |
196 | ␉memcpy(fakeEfiPages->firmwareVendor, FIRMWARE_VENDOR, sizeof(FIRMWARE_VENDOR));␊ |
197 | ␉efiSystemTable->FirmwareRevision = FIRMWARE_REVISION;␊ |
198 | ␉␊ |
199 | ␉// XXX: We may need to have basic implementations of ConIn/ConOut/StdErr␊ |
200 | ␉// The EFI spec states that all handles are invalid after boot services have been␊ |
201 | ␉// exited so we can probably get by with leaving the handles as zero.␊ |
202 | ␉efiSystemTable->ConsoleInHandle = 0;␊ |
203 | ␉efiSystemTable->ConIn = 0;␊ |
204 | ␉␊ |
205 | ␉efiSystemTable->ConsoleOutHandle = 0;␊ |
206 | ␉efiSystemTable->ConOut = 0;␊ |
207 | ␉␊ |
208 | ␉efiSystemTable->StandardErrorHandle = 0;␊ |
209 | ␉efiSystemTable->StdErr = 0;␊ |
210 | ␉␊ |
211 | ␉efiSystemTable->RuntimeServices = (EFI_PTR32)&fakeEfiPages->efiRuntimeServices;␊ |
212 | ␉␊ |
213 | ␉// According to the EFI spec, BootServices aren't valid after the␊ |
214 | ␉// boot process is exited so we can probably do without it.␊ |
215 | ␉// Apple didn't provide a definition for it in pexpert/i386/efi.h␊ |
216 | ␉// so I'm guessing they don't use it.␊ |
217 | ␉efiSystemTable->BootServices = 0;␊ |
218 | ␉␊ |
219 | ␉efiSystemTable->NumberOfTableEntries = 0;␊ |
220 | ␉efiSystemTable->ConfigurationTable = (EFI_PTR32)fakeEfiPages->efiConfigurationTable;␊ |
221 | ␉␊ |
222 | ␉// We're done. Now CRC32 the thing so the kernel will accept it.␊ |
223 | ␉// Must be initialized to zero before CRC32, done above.␊ |
224 | ␉gST32->Hdr.CRC32 = crc32(0L, gST32, gST32->Hdr.HeaderSize);␊ |
225 | ␉␊ |
226 | ␉// --------------------------------------------------------------------␊ |
227 | ␉// Runtime services␊ |
228 | ␉EFI_RUNTIME_SERVICES_32 *efiRuntimeServices = &fakeEfiPages->efiRuntimeServices;␊ |
229 | ␉efiRuntimeServices->Hdr.Signature = EFI_RUNTIME_SERVICES_SIGNATURE;␊ |
230 | ␉efiRuntimeServices->Hdr.Revision = EFI_RUNTIME_SERVICES_REVISION;␊ |
231 | ␉efiRuntimeServices->Hdr.HeaderSize = sizeof(EFI_RUNTIME_SERVICES_32);␊ |
232 | ␉efiRuntimeServices->Hdr.CRC32 = 0;␊ |
233 | ␉efiRuntimeServices->Hdr.Reserved = 0;␊ |
234 | ␉␊ |
235 | ␉// There are a number of function pointers in the efiRuntimeServices table.␊ |
236 | ␉// These are the Foundation (e.g. core) services and are expected to be present on␊ |
237 | ␉// all EFI-compliant machines.␉Some kernel extensions (notably AppleEFIRuntime)␊ |
238 | ␉// will call these without checking to see if they are null.␊ |
239 | ␉//␊ |
240 | ␉// We don't really feel like doing an EFI implementation in the bootloader␊ |
241 | ␉// but it is nice if we can at least prevent a complete crash by␊ |
242 | ␉// at least providing some sort of implementation until one can be provided␊ |
243 | ␉// nicely in a kext.␊ |
244 | ␉void (*voidret_fp)() = (void*)fakeEfiPages->voidret_instructions;␊ |
245 | ␉void (*unsupportedret_fp)() = (void*)fakeEfiPages->unsupportedret_instructions;␊ |
246 | ␉efiRuntimeServices->GetTime = (EFI_PTR32)unsupportedret_fp;␊ |
247 | ␉efiRuntimeServices->SetTime = (EFI_PTR32)unsupportedret_fp;␊ |
248 | ␉efiRuntimeServices->GetWakeupTime = (EFI_PTR32)unsupportedret_fp;␊ |
249 | ␉efiRuntimeServices->SetWakeupTime = (EFI_PTR32)unsupportedret_fp;␊ |
250 | ␉efiRuntimeServices->SetVirtualAddressMap = (EFI_PTR32)unsupportedret_fp;␊ |
251 | ␉efiRuntimeServices->ConvertPointer = (EFI_PTR32)unsupportedret_fp;␊ |
252 | ␉efiRuntimeServices->GetVariable = (EFI_PTR32)unsupportedret_fp;␊ |
253 | ␉efiRuntimeServices->GetNextVariableName = (EFI_PTR32)unsupportedret_fp;␊ |
254 | ␉efiRuntimeServices->SetVariable = (EFI_PTR32)unsupportedret_fp;␊ |
255 | ␉efiRuntimeServices->GetNextHighMonotonicCount = (EFI_PTR32)unsupportedret_fp;␊ |
256 | ␉efiRuntimeServices->ResetSystem = (EFI_PTR32)voidret_fp;␊ |
257 | ␉␊ |
258 | ␉// We're done.␉Now CRC32 the thing so the kernel will accept it␊ |
259 | ␉efiRuntimeServices->Hdr.CRC32 = crc32(0L, efiRuntimeServices, efiRuntimeServices->Hdr.HeaderSize);␊ |
260 | ␉␊ |
261 | ␉// --------------------------------------------------------------------␊ |
262 | ␉// Finish filling in the rest of the boot args that we need.␊ |
263 | ␉bootArgs->efiSystemTable = (uint32_t)efiSystemTable;␊ |
264 | ␉bootArgs->efiMode = kBootArgsEfiMode32;␊ |
265 | ␉␊ |
266 | ␉// The bootArgs structure as a whole is bzero'd so we don't need to fill in␊ |
267 | ␉// things like efiRuntimeServices* and what not.␊ |
268 | ␉//␊ |
269 | ␉// In fact, the only code that seems to use that is the hibernate code so it␊ |
270 | ␉// knows not to save the pages.␉ It even checks to make sure its nonzero.␊ |
271 | }␊ |
272 | ␊ |
273 | void setupEfiTables64(void)␊ |
274 | {␊ |
275 | ␉struct fake_efi_pages␊ |
276 | ␉{␊ |
277 | ␉␉EFI_SYSTEM_TABLE_64 efiSystemTable;␊ |
278 | ␉␉EFI_RUNTIME_SERVICES_64 efiRuntimeServices;␊ |
279 | ␉␉EFI_CONFIGURATION_TABLE_64 efiConfigurationTable[MAX_CONFIGURATION_TABLE_ENTRIES];␊ |
280 | ␉␉EFI_CHAR16 firmwareVendor[sizeof(FIRMWARE_VENDOR)/sizeof(EFI_CHAR16)];␊ |
281 | ␉␉uint8_t voidret_instructions[sizeof(VOIDRET_INSTRUCTIONS)/sizeof(uint8_t)];␊ |
282 | ␉␉uint8_t unsupportedret_instructions[sizeof(UNSUPPORTEDRET_INSTRUCTIONS)/sizeof(uint8_t)];␊ |
283 | ␉};␊ |
284 | ␉␊ |
285 | ␉struct fake_efi_pages *fakeEfiPages = (struct fake_efi_pages*)AllocateKernelMemory(sizeof(struct fake_efi_pages));␊ |
286 | ␉␊ |
287 | ␉// Zero out all the tables in case fields are added later␊ |
288 | ␉bzero(fakeEfiPages, sizeof(struct fake_efi_pages));␊ |
289 | ␉␊ |
290 | ␉// --------------------------------------------------------------------␊ |
291 | ␉// Initialize some machine code that will return EFI_UNSUPPORTED for␊ |
292 | ␉// functions returning int and simply return for void functions.␊ |
293 | ␉memcpy(fakeEfiPages->voidret_instructions, VOIDRET_INSTRUCTIONS, sizeof(VOIDRET_INSTRUCTIONS));␊ |
294 | ␉memcpy(fakeEfiPages->unsupportedret_instructions, UNSUPPORTEDRET_INSTRUCTIONS, sizeof(UNSUPPORTEDRET_INSTRUCTIONS));␊ |
295 | ␉␊ |
296 | ␉// --------------------------------------------------------------------␊ |
297 | ␉// System table␊ |
298 | ␉EFI_SYSTEM_TABLE_64 *efiSystemTable = gST64 = &fakeEfiPages->efiSystemTable;␊ |
299 | ␉efiSystemTable->Hdr.Signature = EFI_SYSTEM_TABLE_SIGNATURE;␊ |
300 | ␉efiSystemTable->Hdr.Revision = EFI_SYSTEM_TABLE_REVISION;␊ |
301 | ␉efiSystemTable->Hdr.HeaderSize = sizeof(EFI_SYSTEM_TABLE_64);␊ |
302 | ␉efiSystemTable->Hdr.CRC32 = 0; // Initialize to zero and then do CRC32␊ |
303 | ␉efiSystemTable->Hdr.Reserved = 0;␊ |
304 | ␉␊ |
305 | ␉efiSystemTable->FirmwareVendor = ptov64((EFI_PTR32)&fakeEfiPages->firmwareVendor);␊ |
306 | ␉memcpy(fakeEfiPages->firmwareVendor, FIRMWARE_VENDOR, sizeof(FIRMWARE_VENDOR));␊ |
307 | ␉efiSystemTable->FirmwareRevision = FIRMWARE_REVISION;␊ |
308 | ␉␊ |
309 | ␉// XXX: We may need to have basic implementations of ConIn/ConOut/StdErr␊ |
310 | ␉// The EFI spec states that all handles are invalid after boot services have been␊ |
311 | ␉// exited so we can probably get by with leaving the handles as zero.␊ |
312 | ␉efiSystemTable->ConsoleInHandle = 0;␊ |
313 | ␉efiSystemTable->ConIn = 0;␊ |
314 | ␉␊ |
315 | ␉efiSystemTable->ConsoleOutHandle = 0;␊ |
316 | ␉efiSystemTable->ConOut = 0;␊ |
317 | ␉␊ |
318 | ␉efiSystemTable->StandardErrorHandle = 0;␊ |
319 | ␉efiSystemTable->StdErr = 0;␊ |
320 | ␉␊ |
321 | ␉efiSystemTable->RuntimeServices = ptov64((EFI_PTR32)&fakeEfiPages->efiRuntimeServices);␊ |
322 | ␉// According to the EFI spec, BootServices aren't valid after the␊ |
323 | ␉// boot process is exited so we can probably do without it.␊ |
324 | ␉// Apple didn't provide a definition for it in pexpert/i386/efi.h␊ |
325 | ␉// so I'm guessing they don't use it.␊ |
326 | ␉efiSystemTable->BootServices = 0;␊ |
327 | ␉␊ |
328 | ␉efiSystemTable->NumberOfTableEntries = 0;␊ |
329 | ␉efiSystemTable->ConfigurationTable = ptov64((EFI_PTR32)fakeEfiPages->efiConfigurationTable);␊ |
330 | ␉␊ |
331 | ␉// We're done.␉Now CRC32 the thing so the kernel will accept it␊ |
332 | ␉gST64->Hdr.CRC32 = crc32(0L, gST64, gST64->Hdr.HeaderSize);␊ |
333 | ␉␊ |
334 | ␉// --------------------------------------------------------------------␊ |
335 | ␉// Runtime services␊ |
336 | ␉EFI_RUNTIME_SERVICES_64 *efiRuntimeServices = &fakeEfiPages->efiRuntimeServices;␊ |
337 | ␉efiRuntimeServices->Hdr.Signature = EFI_RUNTIME_SERVICES_SIGNATURE;␊ |
338 | ␉efiRuntimeServices->Hdr.Revision = EFI_RUNTIME_SERVICES_REVISION;␊ |
339 | ␉efiRuntimeServices->Hdr.HeaderSize = sizeof(EFI_RUNTIME_SERVICES_64);␊ |
340 | ␉efiRuntimeServices->Hdr.CRC32 = 0;␊ |
341 | ␉efiRuntimeServices->Hdr.Reserved = 0;␊ |
342 | ␉␊ |
343 | ␉// There are a number of function pointers in the efiRuntimeServices table.␊ |
344 | ␉// These are the Foundation (e.g. core) services and are expected to be present on␊ |
345 | ␉// all EFI-compliant machines.␉Some kernel extensions (notably AppleEFIRuntime)␊ |
346 | ␉// will call these without checking to see if they are null.␊ |
347 | ␉//␊ |
348 | ␉// We don't really feel like doing an EFI implementation in the bootloader␊ |
349 | ␉// but it is nice if we can at least prevent a complete crash by␊ |
350 | ␉// at least providing some sort of implementation until one can be provided␊ |
351 | ␉// nicely in a kext.␊ |
352 | ␉␊ |
353 | ␉void (*voidret_fp)() = (void*)fakeEfiPages->voidret_instructions;␊ |
354 | ␉void (*unsupportedret_fp)() = (void*)fakeEfiPages->unsupportedret_instructions;␊ |
355 | ␉efiRuntimeServices->GetTime = ptov64((EFI_PTR32)unsupportedret_fp);␊ |
356 | ␉efiRuntimeServices->SetTime = ptov64((EFI_PTR32)unsupportedret_fp);␊ |
357 | ␉efiRuntimeServices->GetWakeupTime = ptov64((EFI_PTR32)unsupportedret_fp);␊ |
358 | ␉efiRuntimeServices->SetWakeupTime = ptov64((EFI_PTR32)unsupportedret_fp);␊ |
359 | ␉efiRuntimeServices->SetVirtualAddressMap = ptov64((EFI_PTR32)unsupportedret_fp);␊ |
360 | ␉efiRuntimeServices->ConvertPointer = ptov64((EFI_PTR32)unsupportedret_fp);␊ |
361 | ␉efiRuntimeServices->GetVariable = ptov64((EFI_PTR32)unsupportedret_fp);␊ |
362 | ␉efiRuntimeServices->GetNextVariableName = ptov64((EFI_PTR32)unsupportedret_fp);␊ |
363 | ␉efiRuntimeServices->SetVariable = ptov64((EFI_PTR32)unsupportedret_fp);␊ |
364 | ␉efiRuntimeServices->GetNextHighMonotonicCount = ptov64((EFI_PTR32)unsupportedret_fp);␊ |
365 | ␉efiRuntimeServices->ResetSystem = ptov64((EFI_PTR32)voidret_fp);␊ |
366 | ␉␊ |
367 | ␉// We're done.␉Now CRC32 the thing so the kernel will accept it␊ |
368 | ␉efiRuntimeServices->Hdr.CRC32 = crc32(0L, efiRuntimeServices, efiRuntimeServices->Hdr.HeaderSize);␊ |
369 | ␉␊ |
370 | ␉// --------------------------------------------------------------------␊ |
371 | ␉// Finish filling in the rest of the boot args that we need.␊ |
372 | ␉bootArgs->efiSystemTable = (uint32_t)efiSystemTable;␊ |
373 | ␉bootArgs->efiMode = kBootArgsEfiMode64;␊ |
374 | ␉␊ |
375 | ␉// The bootArgs structure as a whole is bzero'd so we don't need to fill in␊ |
376 | ␉// things like efiRuntimeServices* and what not.␊ |
377 | ␉//␊ |
378 | ␉// In fact, the only code that seems to use that is the hibernate code so it␊ |
379 | ␉// knows not to save the pages.␉ It even checks to make sure its nonzero.␊ |
380 | }␊ |
381 | ␊ |
382 | /*␊ |
383 | * In addition to the EFI tables there is also the EFI device tree node.␊ |
384 | * In particular, we need /efi/platform to have an FSBFrequency key. Without it,␊ |
385 | * the tsc_init function will panic very early on in kernel startup, before␊ |
386 | * the console is available.␊ |
387 | */␊ |
388 | ␊ |
389 | /*==========================================================================␊ |
390 | * FSB Frequency detection␊ |
391 | */␊ |
392 | ␊ |
393 | /* These should be const but DT__AddProperty takes char* */␊ |
394 | static const char const TSC_Frequency_prop[] = "TSCFrequency";␊ |
395 | static const char const FSB_Frequency_prop[] = "FSBFrequency";␊ |
396 | static const char const CPU_Frequency_prop[] = "CPUFrequency";␊ |
397 | ␊ |
398 | /*==========================================================================␊ |
399 | * SMBIOS␊ |
400 | */␊ |
401 | ␊ |
402 | /* From Foundation/Efi/Guid/Smbios/SmBios.c */␊ |
403 | EFI_GUID const␉gEfiSmbiosTableGuid = EFI_SMBIOS_TABLE_GUID;␊ |
404 | ␊ |
405 | #define SMBIOS_RANGE_START␉␉0x000F0000␊ |
406 | #define SMBIOS_RANGE_END␉␉0x000FFFFF␊ |
407 | ␊ |
408 | /* '_SM_' in little endian: */␊ |
409 | #define SMBIOS_ANCHOR_UINT32_LE 0x5f4d535f␊ |
410 | ␊ |
411 | #define EFI_ACPI_TABLE_GUID \␊ |
412 | { \␊ |
413 | ␉0xeb9d2d30, 0x2d88, 0x11d3, { 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \␊ |
414 | }␊ |
415 | ␊ |
416 | #define EFI_ACPI_20_TABLE_GUID \␊ |
417 | { \␊ |
418 | ␉0x8868e871, 0xe4f1, 0x11d3, { 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \␊ |
419 | }␊ |
420 | ␊ |
421 | EFI_GUID gEfiAcpiTableGuid = EFI_ACPI_TABLE_GUID;␊ |
422 | EFI_GUID gEfiAcpi20TableGuid = EFI_ACPI_20_TABLE_GUID;␊ |
423 | ␊ |
424 | ␊ |
425 | /*==========================================================================␊ |
426 | * Fake EFI implementation␊ |
427 | */␊ |
428 | ␊ |
429 | /* These should be const but DT__AddProperty takes char* */␊ |
430 | static const char const FIRMWARE_REVISION_PROP[] = "firmware-revision";␊ |
431 | static const char const FIRMWARE_ABI_PROP[] = "firmware-abi";␊ |
432 | static const char const FIRMWARE_VENDOR_PROP[] = "firmware-vendor";␊ |
433 | static const char const FIRMWARE_ABI_32_PROP_VALUE[] = "EFI32";␊ |
434 | static const char const FIRMWARE_ABI_64_PROP_VALUE[] = "EFI64";␊ |
435 | static const char const SYSTEM_ID_PROP[] = "system-id";␊ |
436 | static const char const SYSTEM_SERIAL_PROP[] = "SystemSerialNumber";␊ |
437 | static const char const SYSTEM_TYPE_PROP[] = "system-type";␊ |
438 | static const char const MODEL_PROP[] = "Model";␊ |
439 | ␊ |
440 | ␊ |
441 | /*␊ |
442 | * Get an smbios option string option to convert to EFI_CHAR16 string␊ |
443 | */␊ |
444 | ␊ |
445 | static EFI_CHAR16* getSmbiosChar16(const char * key, size_t* len)␊ |
446 | {␊ |
447 | ␉const char␉*src = getStringForKey(key, &bootInfo->smbiosConfig);␊ |
448 | ␉EFI_CHAR16*␉ dst = 0;␊ |
449 | ␉size_t␉␉ i = 0;␊ |
450 | ␉␊ |
451 | ␉if (!key || !(*key) || !len || !src) return 0;␊ |
452 | ␉␊ |
453 | ␉*len = strlen(src);␊ |
454 | ␉dst = (EFI_CHAR16*) malloc( ((*len)+1) * 2 );␊ |
455 | ␉for (; i < (*len); i++)␉ dst[i] = src[i];␊ |
456 | ␉dst[(*len)] = '\0';␊ |
457 | ␉*len = ((*len)+1)*2; // return the CHAR16 bufsize in cluding zero terminated CHAR16␊ |
458 | ␉return dst;␊ |
459 | }␊ |
460 | ␊ |
461 | /*␊ |
462 | * Get the SystemID from the bios dmi info␊ |
463 | */␊ |
464 | ␊ |
465 | static␉EFI_CHAR8* getSmbiosUUID()␊ |
466 | {␊ |
467 | ␉static EFI_CHAR8␉␉ uuid[UUID_LEN];␊ |
468 | ␉int␉␉␉␉␉␉ i, isZero, isOnes;␊ |
469 | ␉SMBByte␉␉␉␉␉*p;␊ |
470 | ␉␊ |
471 | ␉p = (SMBByte*)Platform.UUID;␊ |
472 | ␉␊ |
473 | ␉for (i=0, isZero=1, isOnes=1; i<UUID_LEN; i++)␊ |
474 | ␉{␊ |
475 | ␉␉if (p[i] != 0x00) isZero = 0;␊ |
476 | ␉␉if (p[i] != 0xff) isOnes = 0;␊ |
477 | ␉}␊ |
478 | ␉␊ |
479 | ␉if (isZero || isOnes) // empty or setable means: no uuid present␊ |
480 | ␉{␊ |
481 | ␉␉verbose("No UUID present in SMBIOS System Information Table\n");␊ |
482 | ␉␉return 0;␊ |
483 | ␉}␊ |
484 | ␉␊ |
485 | ␉memcpy(uuid, p, UUID_LEN);␊ |
486 | ␉return uuid;␊ |
487 | }␊ |
488 | ␊ |
489 | /*␊ |
490 | * return a binary UUID value from the overriden SystemID and SMUUID if found, ␊ |
491 | * or from the bios if not, or from a fixed value if no bios value is found ␊ |
492 | */␊ |
493 | ␊ |
494 | static EFI_CHAR8* getSystemID()␊ |
495 | {␊ |
496 | ␉// unable to determine UUID for host. Error: 35 fix␊ |
497 | ␉// Rek: new SMsystemid option conforming to smbios notation standards, this option should␊ |
498 | ␉// belong to smbios config only ...␊ |
499 | ␉const char *sysId = getStringForKey(kSystemID, &bootInfo->bootConfig);␊ |
500 | ␉EFI_CHAR8*␉ret = getUUIDFromString(sysId);␊ |
501 | ␊ |
502 | ␉if (!sysId || !ret) // try bios dmi info UUID extraction␊ |
503 | ␉{␊ |
504 | ␉␉ret = getSmbiosUUID();␊ |
505 | ␉␉sysId = 0;␊ |
506 | ␉}␊ |
507 | ␉␊ |
508 | ␉if (!ret) // no bios dmi UUID available, set a fixed value for system-id␊ |
509 | ␉␉ret=getUUIDFromString((sysId = (const char*) SYSTEM_ID));␊ |
510 | ␉␊ |
511 | ␉verbose("Customizing SystemID with : %s\n", getStringFromUUID(ret)); // apply a nice formatting to the displayed output␊ |
512 | ␉return ret;␊ |
513 | }␊ |
514 | ␊ |
515 | /*␊ |
516 | * Must be called AFTER setup Acpi because we need to take care of correct␊ |
517 | * facp content to reflect in ioregs␊ |
518 | */␊ |
519 | ␊ |
520 | void setupSystemType()␊ |
521 | {␊ |
522 | ␉Node *node = DT__FindNode("/", false);␊ |
523 | ␉if (node == 0) stop("Couldn't get root node");␊ |
524 | ␉// we need to write this property after facp parsing␊ |
525 | ␉// Export system-type only if it has been overrriden by the SystemType option␊ |
526 | ␉DT__AddProperty(node, SYSTEM_TYPE_PROP, sizeof(Platform.Type), &Platform.Type);␊ |
527 | }␊ |
528 | ␊ |
529 | void setupEfiDeviceTree(void)␊ |
530 | {␊ |
531 | ␉EFI_CHAR8*␉ ret = 0;␊ |
532 | ␉EFI_CHAR16*␉ ret16 = 0;␊ |
533 | ␉size_t␉␉ len = 0;␊ |
534 | ␉Node␉␉*node;␊ |
535 | ␉␊ |
536 | ␉node = DT__FindNode("/", false);␊ |
537 | ␉␊ |
538 | ␉if (node == 0) stop("Couldn't get root node");␊ |
539 | ␉␊ |
540 | ␉// We could also just do DT__FindNode("/efi/platform", true)␊ |
541 | ␉// But I think eventually we want to fill stuff in the efi node␊ |
542 | ␉// too so we might as well create it so we have a pointer for it too.␊ |
543 | ␉node = DT__AddChild(node, "efi");␊ |
544 | ␉␊ |
545 | ␉if (archCpuType == CPU_TYPE_I386)␊ |
546 | ␉{␊ |
547 | ␉␉DT__AddProperty(node, FIRMWARE_ABI_PROP, sizeof(FIRMWARE_ABI_32_PROP_VALUE), (char*)FIRMWARE_ABI_32_PROP_VALUE);␊ |
548 | ␉}␊ |
549 | ␉else␊ |
550 | ␉{␊ |
551 | ␉␉DT__AddProperty(node, FIRMWARE_ABI_PROP, sizeof(FIRMWARE_ABI_64_PROP_VALUE), (char*)FIRMWARE_ABI_64_PROP_VALUE);␊ |
552 | ␉}␊ |
553 | ␉␊ |
554 | ␉DT__AddProperty(node, FIRMWARE_REVISION_PROP, sizeof(FIRMWARE_REVISION), (EFI_UINT32*)&FIRMWARE_REVISION);␊ |
555 | ␉DT__AddProperty(node, FIRMWARE_VENDOR_PROP, sizeof(FIRMWARE_VENDOR), (EFI_CHAR16*)FIRMWARE_VENDOR);␊ |
556 | ␉␊ |
557 | ␉// TODO: Fill in other efi properties if necessary␊ |
558 | ␉␊ |
559 | ␉// Set up the /efi/runtime-services table node similar to the way a child node of configuration-table␊ |
560 | ␉// is set up. That is, name and table properties␊ |
561 | ␉Node *runtimeServicesNode = DT__AddChild(node, "runtime-services");␊ |
562 | ␉␊ |
563 | ␉if (archCpuType == CPU_TYPE_I386)␊ |
564 | ␉{␊ |
565 | ␉␉// The value of the table property is the 32-bit physical address for the RuntimeServices table.␊ |
566 | ␉␉// Since the EFI system table already has a pointer to it, we simply use the address of that pointer␊ |
567 | ␉␉// for the pointer to the property data. Warning.. DT finalization calls free on that but we're not␊ |
568 | ␉␉// the only thing to use a non-malloc'd pointer for something in the DT␊ |
569 | ␉␉␊ |
570 | ␉␉DT__AddProperty(runtimeServicesNode, "table", sizeof(uint64_t), &gST32->RuntimeServices);␊ |
571 | ␉}␊ |
572 | ␉else␊ |
573 | ␉{␊ |
574 | ␉␉DT__AddProperty(runtimeServicesNode, "table", sizeof(uint64_t), &gST64->RuntimeServices);␊ |
575 | ␉}␊ |
576 | ␊ |
577 | ␉// Set up the /efi/configuration-table node which will eventually have several child nodes for␊ |
578 | ␉// all of the configuration tables needed by various kernel extensions.␊ |
579 | ␉gEfiConfigurationTableNode = DT__AddChild(node, "configuration-table");␊ |
580 | ␉␊ |
581 | ␉// Now fill in the /efi/platform Node␊ |
582 | ␉Node *efiPlatformNode = DT__AddChild(node, "platform");␊ |
583 | ␉␊ |
584 | ␉// NOTE WELL: If you do add FSB Frequency detection, make sure to store␊ |
585 | ␉// the value in the fsbFrequency global and not an malloc'd pointer␊ |
586 | ␉// because the DT_AddProperty function does not copy its args.␊ |
587 | ␉␊ |
588 | ␉if (Platform.CPU.FSBFrequency != 0)␊ |
589 | ␉␉DT__AddProperty(efiPlatformNode, FSB_Frequency_prop, sizeof(uint64_t), &Platform.CPU.FSBFrequency);␊ |
590 | ␉␊ |
591 | ␉// Export TSC and CPU frequencies for use by the kernel or KEXTs␊ |
592 | ␉if (Platform.CPU.TSCFrequency != 0)␊ |
593 | ␉␉DT__AddProperty(efiPlatformNode, TSC_Frequency_prop, sizeof(uint64_t), &Platform.CPU.TSCFrequency);␊ |
594 | ␉␊ |
595 | ␉if (Platform.CPU.CPUFrequency != 0)␊ |
596 | ␉␉DT__AddProperty(efiPlatformNode, CPU_Frequency_prop, sizeof(uint64_t), &Platform.CPU.CPUFrequency);␊ |
597 | ␉␊ |
598 | ␉// Export system-id. Can be disabled with SystemId=No in com.apple.Boot.plist␊ |
599 | ␉if ((ret=getSystemID()))␊ |
600 | ␉␉DT__AddProperty(efiPlatformNode, SYSTEM_ID_PROP, UUID_LEN, (EFI_UINT32*) ret);␊ |
601 | ␊ |
602 | ␉ // Export SystemSerialNumber if present␊ |
603 | ␉if ((ret16=getSmbiosChar16("SMserial", &len)))␊ |
604 | ␉␉DT__AddProperty(efiPlatformNode, SYSTEM_SERIAL_PROP, len, ret16);␊ |
605 | ␉␊ |
606 | ␉// Export Model if present␊ |
607 | ␉if ((ret16=getSmbiosChar16("SMproductname", &len)))␊ |
608 | ␉␉DT__AddProperty(efiPlatformNode, MODEL_PROP, len, ret16);␊ |
609 | ␉␊ |
610 | ␉// Fill /efi/device-properties node.␊ |
611 | ␉setupDeviceProperties(node);␊ |
612 | }␊ |
613 | ␊ |
614 | /*␊ |
615 | * Load the smbios.plist override config file if any␊ |
616 | */␊ |
617 | ␊ |
618 | static void setupSmbiosConfigFile(const char *filename)␊ |
619 | {␊ |
620 | ␉char␉␉dirSpecSMBIOS[128] = "";␊ |
621 | ␉const char *override_pathname = NULL;␊ |
622 | ␉int␉␉␉len = 0, err = 0;␊ |
623 | ␉extern void scan_mem();␊ |
624 | ␉␊ |
625 | ␉// Take in account user overriding␊ |
626 | ␉if (getValueForKey(kSMBIOSKey, &override_pathname, &len, &bootInfo->bootConfig) && len > 0)␊ |
627 | ␉{␊ |
628 | ␉␉// Specify a path to a file, e.g. SMBIOS=/Extra/macProXY.plist␊ |
629 | ␉␉sprintf(dirSpecSMBIOS, override_pathname);␊ |
630 | ␉␉err = loadConfigFile(dirSpecSMBIOS, &bootInfo->smbiosConfig);␊ |
631 | ␉}␊ |
632 | ␉else␊ |
633 | ␉{␊ |
634 | ␉␉// Check selected volume's Extra.␊ |
635 | ␉␉sprintf(dirSpecSMBIOS, "/Extra/%s", filename);␊ |
636 | ␉␉if (err = loadConfigFile(dirSpecSMBIOS, &bootInfo->smbiosConfig))␊ |
637 | ␉␉{␊ |
638 | ␉␉␉// Check booter volume/rdbt Extra.␊ |
639 | ␉␉␉sprintf(dirSpecSMBIOS, "bt(0,0)/Extra/%s", filename);␊ |
640 | ␉␉␉err = loadConfigFile(dirSpecSMBIOS, &bootInfo->smbiosConfig);␊ |
641 | ␉␉}␊ |
642 | ␉}␊ |
643 | ␊ |
644 | ␉if (err)␊ |
645 | ␉{␊ |
646 | ␉␉verbose("No SMBIOS replacement found.\n");␊ |
647 | ␉}␊ |
648 | ␊ |
649 | ␉// get a chance to scan mem dynamically if user asks for it while having the config options loaded as well,␊ |
650 | ␉// as opposed to when it was in scan_platform(); also load the orig. smbios so that we can access dmi info without␊ |
651 | ␉// patching the smbios yet␊ |
652 | ␊ |
653 | ␉scan_mem(); ␊ |
654 | }␊ |
655 | ␊ |
656 | /*␊ |
657 | * Installs all the needed configuration table entries␊ |
658 | */␊ |
659 | ␊ |
660 | static void setupEfiConfigurationTable()␊ |
661 | {␊ |
662 | ␉smbios_p = (EFI_PTR32)getSmbios(SMBIOS_PATCHED);␊ |
663 | ␉addConfigurationTable(&gEfiSmbiosTableGuid, &smbios_p, NULL);␊ |
664 | ␉␊ |
665 | ␉// Setup ACPI with DSDT overrides (mackerintel's patch)␊ |
666 | ␉setupAcpi();␊ |
667 | ␉␊ |
668 | ␉// We've obviously changed the count.. so fix up the CRC32␊ |
669 | ␉if (archCpuType == CPU_TYPE_I386)␊ |
670 | ␉{␊ |
671 | ␉␉gST32->Hdr.CRC32 = 0;␊ |
672 | ␉␉gST32->Hdr.CRC32 = crc32(0L, gST32, gST32->Hdr.HeaderSize);␊ |
673 | ␉}␊ |
674 | ␉else␊ |
675 | ␉{␊ |
676 | ␉␉gST64->Hdr.CRC32 = 0;␊ |
677 | ␉␉gST64->Hdr.CRC32 = crc32(0L, gST64, gST64->Hdr.HeaderSize);␊ |
678 | ␉}␊ |
679 | }␊ |
680 | ␊ |
681 | /*␊ |
682 | * Entrypoint from boot.c␊ |
683 | */␊ |
684 | ␊ |
685 | void setupFakeEfi(void)␊ |
686 | {␊ |
687 | ␉// Generate efi device strings ␊ |
688 | ␉setup_pci_devs(root_pci_dev);␊ |
689 | ␊ |
690 | ␉readSMBIOSInfo(getSmbios(SMBIOS_ORIGINAL));␊ |
691 | ␊ |
692 | ␉// load smbios.plist file if any␊ |
693 | ␉setupSmbiosConfigFile("smbios.plist");␊ |
694 | ␉␊ |
695 | ␉setupSMBIOSTable();␊ |
696 | ␊ |
697 | ␉// Initialize the base table␊ |
698 | ␉if (archCpuType == CPU_TYPE_I386)␊ |
699 | ␉{␊ |
700 | ␉␉setupEfiTables32();␊ |
701 | ␉}␊ |
702 | ␉else␊ |
703 | ␉{␊ |
704 | ␉␉setupEfiTables64();␊ |
705 | ␉}␊ |
706 | ␉␊ |
707 | ␉// Initialize the device tree␊ |
708 | ␉setupEfiDeviceTree();␊ |
709 | ␉␊ |
710 | ␉// Add configuration table entries to both the services table and the device tree␊ |
711 | ␉setupEfiConfigurationTable();␊ |
712 | }␊ |
713 | ␊ |
714 | |