arm64: Add multiboot support file grub-core/loader/arm64/multiboot.c and dependent header file include/grub/arm64/multiboot.h

- This multiboot support will be built in linux module for aarch64, and can not be used alone.

- The implementation for Xen is following <Multiboot on ARM Specification>: http://wiki.xen.org/wiki/Xen_ARM_with_Virtualization_Extensions/Multiboot and xen/docs/misc/arm/device-tree/booting.txt in Xen source code.

- Add multiboot command for loading multiboot kernel image. Usage: multiboot <the path of kernel image file> [cmdline]

- Add module command for loading multiboot module. Usage: module [option] <the path of module file> [cmdline]

The [option] for Xen is [--type <compatible stream in FDT>]. For now, the <compatible stream in FDT> could be : "multiboot,kernel", "multiboot,ramdisk", "multiboot,module", "xen,xsm-policy" or the custom compatible stream

- Only support stub-kernel for arm64: support stub-kernel detection and alignment info detection

- The reason of adding this functionality to the existing "linux" module rather than "multiboot(2)" (1)multiboot is x86 only (2)Multiboot is added to "linux" module because it reuses existing code.

Signed-off-by: Fu Wei fu.wei@linaro.org --- grub-core/loader/arm64/multiboot.c | 676 +++++++++++++++++++++++++++++++++++++ include/grub/arm64/multiboot.h | 109 ++++++ 2 files changed, 785 insertions(+) create mode 100644 grub-core/loader/arm64/multiboot.c create mode 100644 include/grub/arm64/multiboot.h

diff --git a/grub-core/loader/arm64/multiboot.c b/grub-core/loader/arm64/multiboot.c new file mode 100644 index 0000000..020476e --- /dev/null +++ b/grub-core/loader/arm64/multiboot.c @@ -0,0 +1,676 @@ +/* + * GRUB -- GRand Unified Bootloader + * Copyright (C) 2014 Free Software Foundation, Inc. + * + * GRUB is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * GRUB is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with GRUB. If not, see http://www.gnu.org/licenses/. + */ + +#include <grub/cache.h> +#include <grub/charset.h> +#include <grub/command.h> +#include <grub/err.h> +#include <grub/file.h> +#include <grub/fdt.h> +#include <grub/linux.h> +#include <grub/list.h> +#include <grub/loader.h> +#include <grub/misc.h> +#include <grub/mm.h> +#include <grub/types.h> +#include <grub/cpu/linux.h> +#include <grub/cpu/multiboot.h> +#include <grub/efi/efi.h> +#include <grub/efi/pe32.h> +#include <grub/i18n.h> +#include <grub/lib/cmdline.h> + +static grub_dl_t linux_mod; +static multiboot_module_t kernel = NULL; +static multiboot_module_t module_head = NULL; +static module_type_t module_type = MODULE_IMAGE; +static const grub_size_t module_default_align[] = + { + MODULE_IMAGE_MIN_ALIGN, + MODULE_INITRD_MIN_ALIGN, + MODULE_OTHER_MIN_ALIGN, + MODULE_CUSTOM_MIN_ALIGN + }; + +static grub_efi_guid_t fdt_guid = GRUB_EFI_DEVICE_TREE_GUID; +static void *multiboot_fdt = NULL; +static grub_size_t multiboot_fdt_size = 0; +static int chosen_node = 0; +static const compatible_struct_t default_compatible[] = + { + FDT_COMPATIBLE(FDT_MODULE_IMAGE_COMPATIBLE), + FDT_COMPATIBLE(FDT_MODULE_INITRD_COMPATIBLE), + FDT_COMPATIBLE(FDT_MODULE_OTHER_COMPATIBLE) + }; + +static grub_err_t +clean_extra_info_fdt (multiboot_module_t module) +{ + if (module && module->extra_info) + { + if (((fdt_node_info_t)module->extra_info)->type == MODULE_CUSTOM) + grub_free(((fdt_node_info_t)module->extra_info)->compatible_custom); + + grub_free (module->extra_info); + module->extra_info = NULL; + } + return (GRUB_ERR_NONE); +} + +static grub_err_t +set_fdt_module_type (multiboot_module_t module, int *argc, char **argv[]) +{ + fdt_node_info_t node_info = (fdt_node_info_t) module->extra_info; + char *temp = NULL; + grub_size_t temp_size = 0, total_size = 0; + int compatible_counter = 0, i = 0; + char **compatible_temp_array = (char **)grub_zalloc (sizeof(char *) * (*argc)); + + if ((*argc) >= 3) + { + while ((*argc) > 1) + { + if (grub_strcmp (*argv[0], "--type") == 0) + { + node_info->type = MODULE_CUSTOM; + (*argc)--; + (*argv)++; + temp_size = grub_strlen(*argv[0]) + 1; + temp = (char *)grub_zalloc (temp_size); + grub_strcpy (temp, *argv[0]); + compatible_temp_array[compatible_counter] = temp; + total_size += temp_size; + compatible_counter++; + (*argc)--; + (*argv)++; + } + else + break; + } + } + + if (node_info->type != MODULE_CUSTOM) + { + node_info->type = module_type++; + if (module_type > MODULE_OTHER) + module_type = MODULE_OTHER; + } + else + { + node_info->compatible_custom = temp = (char *)grub_zalloc (total_size); + node_info->compatible_size = total_size; + for (i = 0; compatible_counter > 0; compatible_counter--, i++, temp++) + { + grub_strcpy (temp, compatible_temp_array[i]); + temp += grub_strlen(compatible_temp_array[i]); + grub_free (compatible_temp_array[i]); + } + } + + grub_free (compatible_temp_array); + return (GRUB_ERR_NONE); +} + +static grub_err_t +prepare_kernel_params_fdt (multiboot_module_t module) +{ + int retval; + + multiboot_fdt = grub_arm64_linux_get_fdt (); + multiboot_fdt_size = grub_fdt_get_totalsize (multiboot_fdt); + if (!multiboot_fdt) + return (grub_error(GRUB_ERR_BAD_OS, "failed to get FDT")); + + chosen_node = grub_fdt_find_subnode (multiboot_fdt, 0, "chosen"); + if (chosen_node < 0) + chosen_node = grub_fdt_add_subnode (multiboot_fdt, 0, "chosen"); + if (chosen_node < 1) + return (grub_error(GRUB_ERR_BAD_OS, "failed to get chosen node")); + + grub_dprintf ("multiboot_loader", "Multiboot Kernel cmdline : %s @ %p size:%d\n", + module->cmdline, module->cmdline, module->cmdline_size); + + retval = grub_fdt_set_prop (multiboot_fdt, chosen_node, + "bootargs", module->cmdline, module->cmdline_size); + if (retval) + return (grub_error(GRUB_ERR_BAD_OS, + "failed to set kernel cmdline info to chosen node")); + + return (GRUB_ERR_NONE); +} + +static grub_err_t +prepare_module_params_fdt (multiboot_module_t module) +{ + int retval, module_node = 0; + fdt_node_info_t node_info = NULL; + char module_name[FDT_MODULE_NAME_MAX_SIZE]; + grub_uint64_t reg_64[2]; + + if (module && module->extra_info) + { + node_info = (fdt_node_info_t) module->extra_info; + } + else + { + return (grub_error (GRUB_ERR_BAD_ARGUMENT, N_("failed to get module"))); + } + + retval = grub_snprintf(module_name, FDT_MODULE_NAME_MAX_SIZE, + "module@%lx", module->start); + grub_dprintf ("multiboot_loader", "Module node name %s \n", module_name); + + if (retval <(int) sizeof("module@")) + return (grub_error(GRUB_ERR_BAD_OS, + N_("failed to set node name for module"))); + + module_node = grub_fdt_find_subnode (multiboot_fdt, chosen_node, module_name); + if (module_node < 0) + module_node = grub_fdt_add_subnode (multiboot_fdt, chosen_node, module_name); + + retval = grub_fdt_set_prop (multiboot_fdt, module_node, "compatible", + node_info->compatible, + (grub_uint32_t)node_info->compatible_size); + if (retval) + return (grub_error(GRUB_ERR_BAD_OS, + N_("failed to get module node in chosen node"))); + + grub_dprintf ("multiboot_loader", "Module %s compatible = %s size = 0x%lx\n", + module->name, + node_info->compatible, + node_info->compatible_size); + + reg_64[0] = grub_cpu_to_be64(module->start); + reg_64[1] = grub_cpu_to_be64(module->size); + retval = grub_fdt_set_prop (multiboot_fdt, module_node, "reg", reg_64, 16); + if (retval) + return (grub_error(GRUB_ERR_BAD_OS, + N_("failed to set reg info in module node"))); + + if ((module->cmdline) && (module->cmdline_size > 0)) + { + grub_dprintf ("multiboot_loader", "Module %s cmdline : %s @ %p size:%d\n", + module->name, module->cmdline, module->cmdline, module->cmdline_size); + + retval = grub_fdt_set_prop (multiboot_fdt, module_node, + "bootargs", module->cmdline, module->cmdline_size + 1); + if (retval) + return (grub_error (GRUB_ERR_BAD_OS, + "failed to set module cmdline info to chosen node")); + } + else + { + grub_dprintf ("multiboot_loader", "Module %s has not bootargs!\n", module->name); + } + + return (GRUB_ERR_NONE); +} + +static void * +install_all_params_fdt (void) +{ + grub_efi_boot_services_t *b; + grub_efi_status_t status; + + b = grub_efi_system_table->boot_services; + status = b->install_configuration_table (&fdt_guid, multiboot_fdt); + if (status != GRUB_EFI_SUCCESS) + { + grub_dprintf ("multiboot_loader", "Installed/updated FDT configuration table fail %p\n", + multiboot_fdt); + return NULL; + } + + grub_dprintf ("multiboot_loader", "Installed/updated FDT configuration table @ %p\n", + multiboot_fdt); + return ((void *)multiboot_fdt); +} + +static grub_err_t +clean_all_params_fdt (void) +{ + if (multiboot_fdt) + { + grub_efi_free_pages ((grub_efi_physical_address_t) multiboot_fdt, + BYTES_TO_PAGES (multiboot_fdt_size)); + multiboot_fdt = NULL; + multiboot_fdt_size = 0; + } + return (GRUB_ERR_NONE); +} + +static grub_err_t +init_module_info_fdt (multiboot_module_t module, int *argc, char **argv[]) +{ + fdt_node_info_t node_info = + (fdt_node_info_t) grub_zalloc (sizeof(struct fdt_node_info)); + if (!node_info) + return (grub_error (GRUB_ERR_OUT_OF_MEMORY, N_("out of memory"))); + module->extra_info = (void *) node_info; + + /* get module type */ + grub_errno = set_fdt_module_type (module, argc, argv); + if (grub_errno != GRUB_ERR_NONE) + return (grub_errno); + + switch (node_info->type) + { + case MODULE_IMAGE: + case MODULE_INITRD: + case MODULE_OTHER: + node_info->compatible = default_compatible[node_info->type].compatible; + node_info->compatible_size = default_compatible[node_info->type].size; + break; + + case MODULE_CUSTOM: + /* node_info->compatible_size has set in set_fdt_module_type() */ + node_info->compatible = node_info->compatible_custom; + break; + + default: + return (grub_error (GRUB_ERR_BAD_ARGUMENT, N_("error module type"))); + } + module->name = node_info->compatible; + module->align = module_default_align[node_info->type]; + + grub_dprintf ("multiboot_loader", "Init %s module and node info:\n" + "compatible %s\ncompatible_size 0x%lx\n", + module->name, + node_info->compatible, + node_info->compatible_size); + + return (GRUB_ERR_NONE); +} + +static grub_err_t +check_multiboot_kernel (stub_header_t sh) +{ + if (sh->efi_head.magic != GRUB_ARM64_LINUX_MAGIC) + return (grub_error(GRUB_ERR_BAD_OS, "invalid magic number")); + + if ((sh->efi_head.code0 & 0xffff) == GRUB_EFI_PE_MAGIC) + { + grub_dprintf ("multiboot_loader", "UEFI stub kernel:\n"); + grub_dprintf ("multiboot_loader", "text_offset = 0x%012llx\n", + (long long unsigned) sh->efi_head.text_offset); + grub_dprintf ("multiboot_loader", "PE/COFF header @ %08x\n", sh->efi_head.hdr_offset); + return (GRUB_ERR_NONE); + } + + return (grub_error (GRUB_ERR_NOT_IMPLEMENTED_YET, + N_("plain image not supported - rebuild with STUB support"))); +} + +static void * +finalize_params_multiboot (void) +{ + multiboot_module_t module; + grub_err_t retval; + void *params_blob = NULL; + + /* Set Multiboot Kernel params info */ + module = (multiboot_module_t) grub_named_list_find ( + GRUB_AS_NAMED_LIST (module_head), + GRUB_MULTIBOOT_KERNEL_NAME); + + if (module) + { + kernel = module; + retval = prepare_kernel_params_fdt (module); + if (retval != GRUB_ERR_NONE) + goto failure_kernel; + grub_list_remove(GRUB_AS_LIST (module)); + } + else + { + grub_dprintf ("multiboot_loader", "Please load Multiboot Kernel first!\n"); + goto failure; + } + + /* Set module params info */ + FOR_LIST_ELEMENTS (module, module_head) + { + if (module->start && module->size > 0) + { + grub_dprintf ("multiboot_loader", "Module %s @ 0x%lx size:0x%lx\n", + module->name, module->start, module->size); + retval = prepare_module_params_fdt (module); + if (retval != GRUB_ERR_NONE) + goto failure_module; + } + else + { + grub_dprintf ("multiboot_loader", "Module info error: %s!\n", module->name); + goto failure_module; + } + } + grub_list_push (GRUB_AS_LIST_P (&module_head), GRUB_AS_LIST (kernel)); + + params_blob = (void *)install_all_params_fdt (); + if (!params_blob) + { + goto failure_kernel; + } + + return (params_blob); + + failure_module: + grub_list_push (GRUB_AS_LIST_P (&module_head), GRUB_AS_LIST (kernel)); + failure_kernel: + clean_all_params_fdt (); + failure: + return NULL; +} + +static grub_err_t +grub_multiboot_boot (void) +{ + void *params_blob; + grub_efi_memory_mapped_device_path_t *mempath; + grub_efi_handle_t image_handle; + grub_efi_boot_services_t *b; + grub_efi_status_t status; + grub_efi_loaded_image_t *loaded_image; + + params_blob = finalize_params_multiboot(); + if (!params_blob) + return (grub_error (GRUB_ERR_BAD_OS, "failed to finalize boot params")); + + mempath = grub_zalloc (2 * sizeof (grub_efi_memory_mapped_device_path_t)); + if (!mempath) + return (grub_errno); + + mempath[0].header.type = GRUB_EFI_HARDWARE_DEVICE_PATH_TYPE; + mempath[0].header.subtype = GRUB_EFI_MEMORY_MAPPED_DEVICE_PATH_SUBTYPE; + mempath[0].header.length = grub_cpu_to_le16_compile_time (sizeof (*mempath)); + mempath[0].memory_type = GRUB_EFI_LOADER_DATA; + mempath[0].start_address = kernel->start; + mempath[0].end_address = kernel->start + kernel->size; + + mempath[1].header.type = GRUB_EFI_END_DEVICE_PATH_TYPE; + mempath[1].header.subtype = GRUB_EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE; + mempath[1].header.length = sizeof (grub_efi_device_path_t); + + b = grub_efi_system_table->boot_services; + status = b->load_image (0, grub_efi_image_handle, + (grub_efi_device_path_t *) mempath, + (void *)kernel->start, kernel->size, + &image_handle); + if (status != GRUB_EFI_SUCCESS) + return (grub_error (GRUB_ERR_BAD_OS, "cannot load stub-kernel image")); + + /* Set command line to NULL, we have added this info to params blob */ + loaded_image = grub_efi_get_loaded_image (image_handle); + loaded_image->load_options_size = 0; + loaded_image->load_options = NULL; + + grub_dprintf("linux", "starting stub-kernel @ %p\n", image_handle); + status = b->start_image (image_handle, 0, NULL); + + /* When successful, not reached */ + b->unload_image (image_handle); + return (grub_error (GRUB_ERR_BAD_OS, "Multiboot call returned")); +} + +static void +single_module_unload (multiboot_module_t module) +{ + if (module && module->start_unaligned && module->size > 0) + { + grub_efi_free_pages ((grub_efi_physical_address_t) module->start_unaligned, + BYTES_TO_PAGES (module->size + module->align)); + } + if (module && module->cmdline && module->cmdline_size > 0) + { + grub_free (module->cmdline); + grub_dprintf ("multiboot_loader", "Module %s cmdline memory free @ %p size: %d\n", + module->name, module->cmdline, module->cmdline_size); + } + if (module) + { + clean_extra_info_fdt(module); + grub_list_remove (GRUB_AS_LIST (module)); + grub_dprintf ("multiboot_loader", "Module %s struct memory free @ %p size: 0x%lx\n", + module->name, module, sizeof(module)); + grub_free (module); + } + return; +} + +static grub_err_t +grub_module_unload_all (void) +{ + multiboot_module_t module; + + FOR_LIST_ELEMENTS (module, module_head) + { + single_module_unload (module); + } + + return (GRUB_ERR_NONE); +} + +static grub_err_t +grub_multiboot_unload (void) +{ + grub_dl_unref (linux_mod); + + grub_arm64_linux_set_loaded(0); + grub_module_unload_all (); + clean_all_params_fdt (); + + return (GRUB_ERR_NONE); +} + +static grub_err_t +grub_module_load (multiboot_module_t module, grub_file_t file, + int argc, char *argv[]) +{ + grub_ssize_t temp = 0; + + module->size = grub_file_size (file); + grub_dprintf ("multiboot_loader", "Multiboot %s file size: 0x%lx\n", + module->name, module->size); + + module->start_unaligned = (grub_addr_t) grub_efi_allocate_pages (0, + (BYTES_TO_PAGES (module->size + module->align))); + if (!module->start_unaligned) + return (grub_error (GRUB_ERR_OUT_OF_MEMORY, N_("out of memory"))); + + grub_dprintf ("multiboot_loader", "Multiboot %s numpages: 0x%lx\n", + module->name, BYTES_TO_PAGES (module->size + module->align)); + + if (module->align) + module->start = ALIGN_UP(module->start_unaligned, module->align); + else + module->start = module->start_unaligned; + + grub_dprintf ("multiboot_loader", "Multiboot %s address align(0x%lx) from 0x%lx to 0x%lx\n", + module->name, module->align, module->start_unaligned, module->start); + + temp = grub_file_read (file, (void *)module->start, module->size); + if (temp != (grub_ssize_t) module->size) + { + grub_dprintf ("multiboot_loader", "Multiboot %s(%p) load fail size: %ld,(expect 0x%lx)\n", + module->name, file, temp, module->size); + single_module_unload(module); + return (grub_error (GRUB_ERR_BAD_OS, + N_("premature end of file %s"), argv[0])); + } + + grub_dprintf ("multiboot_loader", "Multiboot %s loaded to 0x%lx size: 0x%lx\n", + module->name, module->start, temp); + + /* Skip the multiboot module file name */ + argc--; + argv++; + + if (argc > 0) + { + module->cmdline_size = grub_loader_cmdline_size (argc, argv); + module->cmdline = grub_zalloc (module->cmdline_size); + if (!module->cmdline) + { + single_module_unload(module); + return (grub_error (GRUB_ERR_OUT_OF_MEMORY, N_("out of memory"))); + } + grub_create_loader_cmdline (argc, argv, + module->cmdline, module->cmdline_size); + grub_dprintf ("multiboot_loader", "Multiboot %s cmdline @ %p %s, size: %d\n", + module->name, module->cmdline, module->cmdline, module->cmdline_size); + } + else + { + module->cmdline_size = 0; + module->cmdline = NULL; + grub_dprintf ("multiboot_loader", "Multiboot %s has not cmdline\n", module->name); + } + + return (GRUB_ERR_NONE); +} + +static grub_err_t +grub_cmd_module (grub_command_t cmd __attribute__ ((unused)), + int argc, char *argv[]) +{ + + grub_file_t file = 0; + multiboot_module_t module = NULL; + + if (argc == 0) + { + grub_error (GRUB_ERR_BAD_ARGUMENT, N_("filename expected")); + goto fail; + } + + if (!grub_arm64_linux_get_loaded()) + { + grub_error (GRUB_ERR_BAD_ARGUMENT, + N_("Please use multiboot command first")); + goto fail; + } + + module = (multiboot_module_t) grub_zalloc (sizeof(struct multiboot_module)); + if (!module) + return (grub_error (GRUB_ERR_OUT_OF_MEMORY, N_("out of memory"))); + + grub_errno = init_module_info_fdt (module, &argc, &argv); + if (grub_errno != GRUB_ERR_NONE) + goto fail; + + file = grub_file_open (argv[0]); + if (!file) + goto fail; + + grub_errno = grub_module_load (module, file, argc, argv); + + if (grub_errno == GRUB_ERR_NONE) + grub_list_push (GRUB_AS_LIST_P (&module_head), GRUB_AS_LIST (module)); + + fail: + if (file) + grub_file_close (file); + if (grub_errno != GRUB_ERR_NONE) + single_module_unload(module); + + return (grub_errno); +} + +static grub_err_t +grub_cmd_multiboot (grub_command_t cmd __attribute__ ((unused)), + int argc, char *argv[]) +{ + grub_file_t file = NULL; + multiboot_module_t module = NULL; + struct stub_header sh; + + grub_dl_ref (linux_mod); + + if (argc == 0) + { + grub_error (GRUB_ERR_BAD_ARGUMENT, N_("filename expected")); + goto fail; + } + + file = grub_file_open (argv[0]); + if (!file) + goto fail; + + if (grub_file_read (file, &sh, sizeof (sh)) < (long) sizeof (sh)) + return (grub_errno); + if (check_multiboot_kernel (&sh) != GRUB_ERR_NONE) + goto fail; + grub_file_seek (file, 0); + + grub_loader_unset(); + + grub_module_unload_all (); + + module = (multiboot_module_t) grub_zalloc (sizeof(struct multiboot_module)); + if (!module) + return (grub_error (GRUB_ERR_OUT_OF_MEMORY, N_("out of memory"))); + + module->name = GRUB_MULTIBOOT_KERNEL_NAME; + module->extra_info = NULL; + module->align =(grub_size_t) sh.optional_header.section_alignment; + + grub_dprintf ("multiboot_loader", "Init the alignment of %s from stub header: 0x%lx\n", + module->name, module->align); + + grub_errno = grub_module_load (module, file, argc, argv); + + if (grub_errno == GRUB_ERR_NONE) + { + grub_list_push (GRUB_AS_LIST_P (&module_head), GRUB_AS_LIST (module)); + grub_loader_set (grub_multiboot_boot, grub_multiboot_unload, 0); + grub_arm64_linux_set_loaded(1); + } + + fail: + if (file) + grub_file_close (file); + if (grub_errno != GRUB_ERR_NONE) + { + grub_dl_unref (linux_mod); + grub_arm64_linux_set_loaded(0); + grub_module_unload_all (); + } + + return (grub_errno); +} + +static grub_command_t cmd_multiboot, cmd_module; + +void +grub_arm64_linux_register_multiboot_command (grub_dl_t mod) +{ + cmd_multiboot = + grub_register_command ("multiboot", grub_cmd_multiboot, 0, + N_("Load a multiboot kernel.")); + cmd_module = + grub_register_command ("module", grub_cmd_module, 0, + N_("Load a multiboot module.")); + linux_mod = mod; +} + +void +grub_arm64_linux_unregister_multiboot_command (void) +{ + grub_unregister_command (cmd_multiboot); + grub_unregister_command (cmd_module); +} diff --git a/include/grub/arm64/multiboot.h b/include/grub/arm64/multiboot.h new file mode 100644 index 0000000..f15c5ea --- /dev/null +++ b/include/grub/arm64/multiboot.h @@ -0,0 +1,109 @@ +/* multiboot.h - Multiboot header file. */ +/* Copyright (C) 2014 Free Software Foundation, Inc. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL ANY + * DEVELOPER OR DISTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR + * IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ + +#ifndef MULTIBOOT_HEADER +#define MULTIBOOT_HEADER 1 + +#include <grub/list.h> +#include <grub/types.h> +#include <grub/efi/pe32.h> /* required by struct stub_header */ + +#define GRUB_MULTIBOOT_KERNEL_NAME "multiboot_kernel" + +#define MODULE_DEFAULT_ALIGN (0x0) +#define MODULE_IMAGE_MIN_ALIGN MODULE_DEFAULT_ALIGN +#define MODULE_INITRD_MIN_ALIGN MODULE_DEFAULT_ALIGN +#define MODULE_OTHER_MIN_ALIGN MODULE_DEFAULT_ALIGN +#define MODULE_CUSTOM_MIN_ALIGN MODULE_DEFAULT_ALIGN + +#define FDT_MODULE_IMAGE_COMPATIBLE "multiboot,kernel\0multiboot,module" +#define FDT_MODULE_INITRD_COMPATIBLE "multiboot,ramdisk\0multiboot,module" +#define FDT_MODULE_OTHER_COMPATIBLE "multiboot,module" + +/* This maximum size (31 + 1<\0>) is defined in ePAPR */ +#define FDT_MODULE_NAME_MAX_SIZE (32) + +struct compatible_struct +{ + grub_size_t size; + const char *compatible; +}; +typedef struct compatible_struct compatible_struct_t; +#define FDT_COMPATIBLE(x) {.size = sizeof(x), .compatible = x} + +enum module_type +{ + MODULE_IMAGE, + MODULE_INITRD, + MODULE_OTHER, + MODULE_CUSTOM +}; +typedef enum module_type module_type_t; + +struct fdt_node_info +{ + module_type_t type; + + const char *compatible; + char *compatible_custom; + grub_size_t compatible_size; +}; +typedef struct fdt_node_info *fdt_node_info_t; + +struct stub_header +{ + struct grub_arm64_linux_kernel_header efi_head; + + /* This is always PE\0\0. */ + grub_uint8_t signature[GRUB_PE32_SIGNATURE_SIZE]; + /* The COFF file header. */ + struct grub_pe32_coff_header coff_header; + /* The Optional header. */ + struct grub_pe64_optional_header optional_header; +}; +typedef struct stub_header *stub_header_t; + +struct multiboot_module +{ + struct multiboot_module *next; + struct multiboot_module **prev; + const char *name; + + /* int flags; */ + + grub_addr_t start_unaligned; + grub_addr_t start; + grub_size_t size; + grub_size_t align; + + char *cmdline; + int cmdline_size; + + /* for more info */ + void *extra_info; +}; +typedef struct multiboot_module *multiboot_module_t; + +void grub_arm64_linux_register_multiboot_command (grub_dl_t mod); + +void grub_arm64_linux_unregister_multiboot_command (void); + +#endif /* ! MULTIBOOT_HEADER */