1 /* -----------------------------------------------------------------------
3 * Copyright 2011 Intel Corporation; author Matt Fleming
5 * This file is part of the Linux kernel, and is made available under
6 * the terms of the GNU General Public License version 2.
8 * ----------------------------------------------------------------------- */
10 #include <linux/efi.h>
11 #include <linux/pci.h>
13 #include <asm/setup.h>
16 #undef memcpy /* Use memcpy from misc.c */
20 static efi_system_table_t *sys_table;
23 #include "../../../../drivers/firmware/efi/efi-stub-helper.c"
27 static void find_bits(unsigned long mask, u8 *pos, u8 *size)
35 while (!(mask & 0x1)) {
50 static efi_status_t setup_efi_pci(struct boot_params *params)
52 efi_pci_io_protocol *pci;
55 efi_guid_t pci_proto = EFI_PCI_IO_PROTOCOL_GUID;
56 unsigned long nr_pci, size = 0;
58 struct setup_data *data;
60 data = (struct setup_data *)(unsigned long)params->hdr.setup_data;
62 while (data && data->next)
63 data = (struct setup_data *)(unsigned long)data->next;
65 status = efi_call_phys5(sys_table->boottime->locate_handle,
66 EFI_LOCATE_BY_PROTOCOL, &pci_proto,
67 NULL, &size, pci_handle);
69 if (status == EFI_BUFFER_TOO_SMALL) {
70 status = efi_call_phys3(sys_table->boottime->allocate_pool,
71 EFI_LOADER_DATA, size, &pci_handle);
73 if (status != EFI_SUCCESS)
76 status = efi_call_phys5(sys_table->boottime->locate_handle,
77 EFI_LOCATE_BY_PROTOCOL, &pci_proto,
78 NULL, &size, pci_handle);
81 if (status != EFI_SUCCESS)
84 nr_pci = size / sizeof(void *);
85 for (i = 0; i < nr_pci; i++) {
86 void *h = pci_handle[i];
88 struct pci_setup_rom *rom;
90 status = efi_call_phys3(sys_table->boottime->handle_protocol,
93 if (status != EFI_SUCCESS)
100 status = efi_call_phys4(pci->attributes, pci,
101 EfiPciIoAttributeOperationGet, 0,
104 status = efi_call_phys5(pci->attributes, pci,
105 EfiPciIoAttributeOperationGet, 0, 0,
108 if (status != EFI_SUCCESS)
111 if (!pci->romimage || !pci->romsize)
114 size = pci->romsize + sizeof(*rom);
116 status = efi_call_phys3(sys_table->boottime->allocate_pool,
117 EFI_LOADER_DATA, size, &rom);
119 if (status != EFI_SUCCESS)
122 rom->data.type = SETUP_PCI;
123 rom->data.len = size - sizeof(struct setup_data);
125 rom->pcilen = pci->romsize;
127 status = efi_call_phys5(pci->pci.read, pci,
128 EfiPciIoWidthUint16, PCI_VENDOR_ID,
131 if (status != EFI_SUCCESS)
134 status = efi_call_phys5(pci->pci.read, pci,
135 EfiPciIoWidthUint16, PCI_DEVICE_ID,
138 if (status != EFI_SUCCESS)
141 status = efi_call_phys5(pci->get_location, pci,
142 &(rom->segment), &(rom->bus),
143 &(rom->device), &(rom->function));
145 if (status != EFI_SUCCESS)
148 memcpy(rom->romdata, pci->romimage, pci->romsize);
151 data->next = (unsigned long)rom;
153 params->hdr.setup_data = (unsigned long)rom;
155 data = (struct setup_data *)rom;
159 efi_call_phys1(sys_table->boottime->free_pool, rom);
163 efi_call_phys1(sys_table->boottime->free_pool, pci_handle);
168 * See if we have Graphics Output Protocol
170 static efi_status_t setup_gop(struct screen_info *si, efi_guid_t *proto,
173 struct efi_graphics_output_protocol *gop, *first_gop;
174 struct efi_pixel_bitmask pixel_info;
175 unsigned long nr_gops;
179 u32 fb_base, fb_size;
180 u32 pixels_per_scan_line;
184 status = efi_call_phys3(sys_table->boottime->allocate_pool,
185 EFI_LOADER_DATA, size, &gop_handle);
186 if (status != EFI_SUCCESS)
189 status = efi_call_phys5(sys_table->boottime->locate_handle,
190 EFI_LOCATE_BY_PROTOCOL, proto,
191 NULL, &size, gop_handle);
192 if (status != EFI_SUCCESS)
197 nr_gops = size / sizeof(void *);
198 for (i = 0; i < nr_gops; i++) {
199 struct efi_graphics_output_mode_info *info;
200 efi_guid_t conout_proto = EFI_CONSOLE_OUT_DEVICE_GUID;
201 bool conout_found = false;
203 void *h = gop_handle[i];
205 status = efi_call_phys3(sys_table->boottime->handle_protocol,
207 if (status != EFI_SUCCESS)
210 status = efi_call_phys3(sys_table->boottime->handle_protocol,
211 h, &conout_proto, &dummy);
213 if (status == EFI_SUCCESS)
216 status = efi_call_phys4(gop->query_mode, gop,
217 gop->mode->mode, &size, &info);
218 if (status == EFI_SUCCESS && (!first_gop || conout_found)) {
220 * Systems that use the UEFI Console Splitter may
221 * provide multiple GOP devices, not all of which are
222 * backed by real hardware. The workaround is to search
223 * for a GOP implementing the ConOut protocol, and if
224 * one isn't found, to just fall back to the first GOP.
226 width = info->horizontal_resolution;
227 height = info->vertical_resolution;
228 fb_base = gop->mode->frame_buffer_base;
229 fb_size = gop->mode->frame_buffer_size;
230 pixel_format = info->pixel_format;
231 pixel_info = info->pixel_information;
232 pixels_per_scan_line = info->pixels_per_scan_line;
235 * Once we've found a GOP supporting ConOut,
236 * don't bother looking any further.
244 /* Did we find any GOPs? */
248 /* EFI framebuffer */
249 si->orig_video_isVGA = VIDEO_TYPE_EFI;
251 si->lfb_width = width;
252 si->lfb_height = height;
253 si->lfb_base = fb_base;
256 if (pixel_format == PIXEL_RGB_RESERVED_8BIT_PER_COLOR) {
258 si->lfb_linelength = pixels_per_scan_line * 4;
267 } else if (pixel_format == PIXEL_BGR_RESERVED_8BIT_PER_COLOR) {
269 si->lfb_linelength = pixels_per_scan_line * 4;
278 } else if (pixel_format == PIXEL_BIT_MASK) {
279 find_bits(pixel_info.red_mask, &si->red_pos, &si->red_size);
280 find_bits(pixel_info.green_mask, &si->green_pos,
282 find_bits(pixel_info.blue_mask, &si->blue_pos, &si->blue_size);
283 find_bits(pixel_info.reserved_mask, &si->rsvd_pos,
285 si->lfb_depth = si->red_size + si->green_size +
286 si->blue_size + si->rsvd_size;
287 si->lfb_linelength = (pixels_per_scan_line * si->lfb_depth) / 8;
290 si->lfb_linelength = si->lfb_width / 2;
301 si->lfb_size = si->lfb_linelength * si->lfb_height;
303 si->capabilities |= VIDEO_CAPABILITY_SKIP_QUIRKS;
306 efi_call_phys1(sys_table->boottime->free_pool, gop_handle);
311 * See if we have Universal Graphics Adapter (UGA) protocol
313 static efi_status_t setup_uga(struct screen_info *si, efi_guid_t *uga_proto,
316 struct efi_uga_draw_protocol *uga, *first_uga;
317 unsigned long nr_ugas;
320 void **uga_handle = NULL;
323 status = efi_call_phys3(sys_table->boottime->allocate_pool,
324 EFI_LOADER_DATA, size, &uga_handle);
325 if (status != EFI_SUCCESS)
328 status = efi_call_phys5(sys_table->boottime->locate_handle,
329 EFI_LOCATE_BY_PROTOCOL, uga_proto,
330 NULL, &size, uga_handle);
331 if (status != EFI_SUCCESS)
336 nr_ugas = size / sizeof(void *);
337 for (i = 0; i < nr_ugas; i++) {
338 efi_guid_t pciio_proto = EFI_PCI_IO_PROTOCOL_GUID;
339 void *handle = uga_handle[i];
340 u32 w, h, depth, refresh;
343 status = efi_call_phys3(sys_table->boottime->handle_protocol,
344 handle, uga_proto, &uga);
345 if (status != EFI_SUCCESS)
348 efi_call_phys3(sys_table->boottime->handle_protocol,
349 handle, &pciio_proto, &pciio);
351 status = efi_call_phys5(uga->get_mode, uga, &w, &h,
353 if (status == EFI_SUCCESS && (!first_uga || pciio)) {
358 * Once we've found a UGA supporting PCIIO,
359 * don't bother looking any further.
371 /* EFI framebuffer */
372 si->orig_video_isVGA = VIDEO_TYPE_EFI;
375 si->lfb_width = width;
376 si->lfb_height = height;
389 efi_call_phys1(sys_table->boottime->free_pool, uga_handle);
393 void setup_graphics(struct boot_params *boot_params)
395 efi_guid_t graphics_proto = EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID;
396 struct screen_info *si;
397 efi_guid_t uga_proto = EFI_UGA_PROTOCOL_GUID;
400 void **gop_handle = NULL;
401 void **uga_handle = NULL;
403 si = &boot_params->screen_info;
404 memset(si, 0, sizeof(*si));
407 status = efi_call_phys5(sys_table->boottime->locate_handle,
408 EFI_LOCATE_BY_PROTOCOL, &graphics_proto,
409 NULL, &size, gop_handle);
410 if (status == EFI_BUFFER_TOO_SMALL)
411 status = setup_gop(si, &graphics_proto, size);
413 if (status != EFI_SUCCESS) {
415 status = efi_call_phys5(sys_table->boottime->locate_handle,
416 EFI_LOCATE_BY_PROTOCOL, &uga_proto,
417 NULL, &size, uga_handle);
418 if (status == EFI_BUFFER_TOO_SMALL)
419 setup_uga(si, &uga_proto, size);
425 * Because the x86 boot code expects to be passed a boot_params we
426 * need to create one ourselves (usually the bootloader would create
429 struct boot_params *make_boot_params(void *handle, efi_system_table_t *_table)
431 struct boot_params *boot_params;
432 struct sys_desc_table *sdt;
433 struct apm_bios_info *bi;
434 struct setup_header *hdr;
435 struct efi_info *efi;
436 efi_loaded_image_t *image;
438 u32 load_options_size;
439 efi_guid_t proto = LOADED_IMAGE_PROTOCOL_GUID;
440 int options_size = 0;
442 unsigned long cmdline;
449 /* Check if we were booted by the EFI firmware */
450 if (sys_table->hdr.signature != EFI_SYSTEM_TABLE_SIGNATURE)
453 status = efi_call_phys3(sys_table->boottime->handle_protocol,
454 handle, &proto, (void *)&image);
455 if (status != EFI_SUCCESS) {
456 efi_printk(sys_table, "Failed to get handle for LOADED_IMAGE_PROTOCOL\n");
460 status = efi_low_alloc(sys_table, 0x4000, 1,
461 (unsigned long *)&boot_params);
462 if (status != EFI_SUCCESS) {
463 efi_printk(sys_table, "Failed to alloc lowmem for boot params\n");
467 memset(boot_params, 0x0, 0x4000);
469 hdr = &boot_params->hdr;
470 efi = &boot_params->efi_info;
471 bi = &boot_params->apm_bios_info;
472 sdt = &boot_params->sys_desc_table;
474 /* Copy the second sector to boot_params */
475 memcpy(&hdr->jump, image->image_base + 512, 512);
478 * Fill out some of the header fields ourselves because the
479 * EFI firmware loader doesn't load the first sector.
482 hdr->vid_mode = 0xffff;
483 hdr->boot_flag = 0xAA55;
485 hdr->code32_start = (__u64)(unsigned long)image->image_base;
487 hdr->type_of_loader = 0x21;
489 /* Convert unicode cmdline to ascii */
490 options = image->load_options;
491 load_options_size = image->load_options_size / 2; /* ASCII */
496 while (*s2 && *s2 != '\n' && options_size < load_options_size) {
502 if (options_size > hdr->cmdline_size)
503 options_size = hdr->cmdline_size;
505 options_size++; /* NUL termination */
507 status = efi_low_alloc(sys_table, options_size, 1,
509 if (status != EFI_SUCCESS) {
510 efi_printk(sys_table, "Failed to alloc mem for cmdline\n");
514 s1 = (u8 *)(unsigned long)cmdline;
517 for (i = 0; i < options_size - 1; i++)
524 hdr->cmd_line_ptr = cmdline;
526 hdr->ramdisk_image = 0;
527 hdr->ramdisk_size = 0;
529 /* Clear APM BIOS info */
530 memset(bi, 0, sizeof(*bi));
532 memset(sdt, 0, sizeof(*sdt));
534 status = handle_ramdisks(sys_table, image, hdr);
535 if (status != EFI_SUCCESS)
541 efi_free(sys_table, options_size, hdr->cmd_line_ptr);
543 efi_free(sys_table, 0x4000, (unsigned long)boot_params);
547 static efi_status_t exit_boot(struct boot_params *boot_params,
550 struct efi_info *efi = &boot_params->efi_info;
551 struct e820entry *e820_map = &boot_params->e820_map[0];
552 struct e820entry *prev = NULL;
553 unsigned long size, key, desc_size, _size;
554 efi_memory_desc_t *mem_map;
557 bool called_exit = false;
561 size = sizeof(*mem_map) * 32;
564 size += sizeof(*mem_map) * 2;
566 status = efi_low_alloc(sys_table, size, 1, (unsigned long *)&mem_map);
567 if (status != EFI_SUCCESS)
571 status = efi_call_phys5(sys_table->boottime->get_memory_map, &size,
572 mem_map, &key, &desc_size, &desc_version);
573 if (status == EFI_BUFFER_TOO_SMALL) {
574 efi_free(sys_table, _size, (unsigned long)mem_map);
578 if (status != EFI_SUCCESS)
581 memcpy(&efi->efi_loader_signature, EFI_LOADER_SIGNATURE, sizeof(__u32));
582 efi->efi_systab = (unsigned long)sys_table;
583 efi->efi_memdesc_size = desc_size;
584 efi->efi_memdesc_version = desc_version;
585 efi->efi_memmap = (unsigned long)mem_map;
586 efi->efi_memmap_size = size;
589 efi->efi_systab_hi = (unsigned long)sys_table >> 32;
590 efi->efi_memmap_hi = (unsigned long)mem_map >> 32;
593 /* Might as well exit boot services now */
594 status = efi_call_phys2(sys_table->boottime->exit_boot_services,
596 if (status != EFI_SUCCESS) {
598 * ExitBootServices() will fail if any of the event
599 * handlers change the memory map. In which case, we
600 * must be prepared to retry, but only once so that
601 * we're guaranteed to exit on repeated failures instead
602 * of spinning forever.
612 boot_params->alt_mem_k = 32 * 1024;
615 * Convert the EFI memory map to E820.
618 for (i = 0; i < size / desc_size; i++) {
619 efi_memory_desc_t *d;
620 unsigned int e820_type = 0;
621 unsigned long m = (unsigned long)mem_map;
623 d = (efi_memory_desc_t *)(m + (i * desc_size));
625 case EFI_RESERVED_TYPE:
626 case EFI_RUNTIME_SERVICES_CODE:
627 case EFI_RUNTIME_SERVICES_DATA:
628 case EFI_MEMORY_MAPPED_IO:
629 case EFI_MEMORY_MAPPED_IO_PORT_SPACE:
631 e820_type = E820_RESERVED;
634 case EFI_UNUSABLE_MEMORY:
635 e820_type = E820_UNUSABLE;
638 case EFI_ACPI_RECLAIM_MEMORY:
639 e820_type = E820_ACPI;
642 case EFI_LOADER_CODE:
643 case EFI_LOADER_DATA:
644 case EFI_BOOT_SERVICES_CODE:
645 case EFI_BOOT_SERVICES_DATA:
646 case EFI_CONVENTIONAL_MEMORY:
647 e820_type = E820_RAM;
650 case EFI_ACPI_MEMORY_NVS:
651 e820_type = E820_NVS;
658 /* Merge adjacent mappings */
659 if (prev && prev->type == e820_type &&
660 (prev->addr + prev->size) == d->phys_addr)
661 prev->size += d->num_pages << 12;
663 e820_map->addr = d->phys_addr;
664 e820_map->size = d->num_pages << 12;
665 e820_map->type = e820_type;
671 boot_params->e820_entries = nr_entries;
676 efi_free(sys_table, _size, (unsigned long)mem_map);
682 * On success we return a pointer to a boot_params structure, and NULL
685 struct boot_params *efi_main(void *handle, efi_system_table_t *_table,
686 struct boot_params *boot_params)
688 struct desc_ptr *gdt, *idt;
689 efi_loaded_image_t *image;
690 struct setup_header *hdr = &boot_params->hdr;
692 struct desc_struct *desc;
696 /* Check if we were booted by the EFI firmware */
697 if (sys_table->hdr.signature != EFI_SYSTEM_TABLE_SIGNATURE)
700 setup_graphics(boot_params);
702 setup_efi_pci(boot_params);
704 status = efi_call_phys3(sys_table->boottime->allocate_pool,
705 EFI_LOADER_DATA, sizeof(*gdt),
707 if (status != EFI_SUCCESS) {
708 efi_printk(sys_table, "Failed to alloc mem for gdt structure\n");
713 status = efi_low_alloc(sys_table, gdt->size, 8,
714 (unsigned long *)&gdt->address);
715 if (status != EFI_SUCCESS) {
716 efi_printk(sys_table, "Failed to alloc mem for gdt\n");
720 status = efi_call_phys3(sys_table->boottime->allocate_pool,
721 EFI_LOADER_DATA, sizeof(*idt),
723 if (status != EFI_SUCCESS) {
724 efi_printk(sys_table, "Failed to alloc mem for idt structure\n");
732 * If the kernel isn't already loaded at the preferred load
733 * address, relocate it.
735 if (hdr->pref_address != hdr->code32_start) {
736 unsigned long bzimage_addr = hdr->code32_start;
737 status = efi_relocate_kernel(sys_table, &bzimage_addr,
738 hdr->init_size, hdr->init_size,
740 hdr->kernel_alignment);
741 if (status != EFI_SUCCESS)
744 hdr->pref_address = hdr->code32_start;
745 hdr->code32_start = bzimage_addr;
748 status = exit_boot(boot_params, handle);
749 if (status != EFI_SUCCESS)
752 memset((char *)gdt->address, 0x0, gdt->size);
753 desc = (struct desc_struct *)gdt->address;
755 /* The first GDT is a dummy and the second is unused. */
758 desc->limit0 = 0xffff;
759 desc->base0 = 0x0000;
760 desc->base1 = 0x0000;
761 desc->type = SEG_TYPE_CODE | SEG_TYPE_EXEC_READ;
762 desc->s = DESC_TYPE_CODE_DATA;
768 desc->d = SEG_OP_SIZE_32BIT;
769 desc->g = SEG_GRANULARITY_4KB;
773 desc->limit0 = 0xffff;
774 desc->base0 = 0x0000;
775 desc->base1 = 0x0000;
776 desc->type = SEG_TYPE_DATA | SEG_TYPE_READ_WRITE;
777 desc->s = DESC_TYPE_CODE_DATA;
783 desc->d = SEG_OP_SIZE_32BIT;
784 desc->g = SEG_GRANULARITY_4KB;
788 /* Task segment value */
790 desc->limit0 = 0x0000;
791 desc->base0 = 0x0000;
792 desc->base1 = 0x0000;
793 desc->type = SEG_TYPE_TSS;
801 desc->g = SEG_GRANULARITY_4KB;
803 #endif /* CONFIG_X86_64 */
805 asm volatile ("lidt %0" : : "m" (*idt));
806 asm volatile ("lgdt %0" : : "m" (*gdt));