From patchwork Mon Jul 13 08:53:58 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Fu Wei Fu X-Patchwork-Id: 51062 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-la0-f70.google.com (mail-la0-f70.google.com [209.85.215.70]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 76365218E9 for ; Mon, 13 Jul 2015 08:56:03 +0000 (UTC) Received: by laef2 with SMTP id f2sf5109365lae.0 for ; Mon, 13 Jul 2015 01:56:02 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:subject:date:message-id :in-reply-to:references:cc:precedence:reply-to:list-id :list-unsubscribe:list-archive:list-post:list-help:list-subscribe :mime-version:content-type:content-transfer-encoding:errors-to :sender:x-original-sender:x-original-authentication-results :mailing-list; bh=yrTN5DiGt57UemfJGm3RFHcFxGa8yBcJis/bKQX6GgQ=; b=N2FybY2AObjfvkv4iiL4IDxBtwJpLjebtxIrGpOOMVd+GTBKEf2DQmk/Q5iMgUisx/ qtHp5/5uDtOdSk+VK/zXYo4J61e1j2i6EciDX41nyh21ryBgzyOgxBL40ww5FsDKQss3 Ezoc4Le0PoJyhaPPZqx0a3C9sZVHyIY2Vqly4VZoWqX85O5AVUQ+d6H7OGAB37jqPLQ0 ozNoRVqp8oGd93UzE9tGyX7b1UKY9/yfQREPsG3u+egNv50GYgLBruiAZQtWriRNq34m JRZTT6yN1Gi1VGbNWyQJrXXQE0NKAG0UpXsGQoeVEozrt3lzUfUNWzVXg5rFjA2h8GEd YiUQ== X-Gm-Message-State: ALoCoQmlzfxMT1E4ogjokBfOcqnu2EVuhFBn/ZTiGE74R02JEw9mH/UD0VLrL0OYatcx1cSZ/o4N X-Received: by 10.194.60.73 with SMTP id f9mr18084292wjr.6.1436777762370; Mon, 13 Jul 2015 01:56:02 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.29.36 with SMTP id g4ls1524083lah.33.gmail; Mon, 13 Jul 2015 01:56:02 -0700 (PDT) X-Received: by 10.152.23.167 with SMTP id n7mr31358974laf.108.1436777762172; Mon, 13 Jul 2015 01:56:02 -0700 (PDT) Received: from mail-lb0-f172.google.com (mail-lb0-f172.google.com. [209.85.217.172]) by mx.google.com with ESMTPS id k3si14361763laf.146.2015.07.13.01.56.01 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 13 Jul 2015 01:56:01 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.172 as permitted sender) client-ip=209.85.217.172; Received: by lbbpo10 with SMTP id po10so120693170lbb.3 for ; Mon, 13 Jul 2015 01:56:01 -0700 (PDT) X-Received: by 10.112.55.207 with SMTP id u15mr31283978lbp.88.1436777761863; Mon, 13 Jul 2015 01:56:01 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.108.230 with SMTP id hn6csp1587807lbb; Mon, 13 Jul 2015 01:56:00 -0700 (PDT) X-Received: by 10.69.0.8 with SMTP id au8mr67385735pbd.112.1436777759487; Mon, 13 Jul 2015 01:55:59 -0700 (PDT) Received: from lists.gnu.org (lists.gnu.org. [2001:4830:134:3::11]) by mx.google.com with ESMTPS id iv3si26577161pbb.202.2015.07.13.01.55.58 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Mon, 13 Jul 2015 01:55:59 -0700 (PDT) Received-SPF: pass (google.com: domain of grub-devel-bounces+patch=linaro.org@gnu.org designates 2001:4830:134:3::11 as permitted sender) client-ip=2001:4830:134:3::11; Received: from localhost ([::1]:53668 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZEZWn-0005cS-9s for patch@linaro.org; Mon, 13 Jul 2015 04:55:57 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:33589) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZEZWN-0005c7-Ca for grub-devel@gnu.org; Mon, 13 Jul 2015 04:55:34 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZEZWI-0000eC-IX for grub-devel@gnu.org; Mon, 13 Jul 2015 04:55:31 -0400 Received: from mail-pd0-f174.google.com ([209.85.192.174]:35823) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZEZWI-0000dv-8f for grub-devel@gnu.org; Mon, 13 Jul 2015 04:55:26 -0400 Received: by pdrg1 with SMTP id g1so88811596pdr.2 for ; Mon, 13 Jul 2015 01:55:25 -0700 (PDT) X-Received: by 10.70.134.133 with SMTP id pk5mr67769444pdb.133.1436777725597; Mon, 13 Jul 2015 01:55:25 -0700 (PDT) Received: from localhost.localdomain (li400-65.members.linode.com. [106.187.50.65]) by smtp.googlemail.com with ESMTPSA id g10sm18109895pat.35.2015.07.13.01.54.42 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 13 Jul 2015 01:55:24 -0700 (PDT) From: fu.wei@linaro.org To: grub-devel@gnu.org, arvidjaar@gmail.com, phcoder@gmail.com Subject: [PATCH v2 1/3] arm64: Add Xen boot support file Date: Mon, 13 Jul 2015 16:53:58 +0800 Message-Id: <1436777640-31871-2-git-send-email-fu.wei@linaro.org> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1436777640-31871-1-git-send-email-fu.wei@linaro.org> References: <=fu.wei@linaro.org> <1436777640-31871-1-git-send-email-fu.wei@linaro.org> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.85.192.174 Cc: xen-devel@lists.xensource.com, Ian.Campbell@citrix.com, stefano.stabellini@eu.citrix.com, jcm@redhat.com, leif.lindholm@linaro.org, ryan.harkin@linaro.org, linaro-uefi@lists.linaro.org, Fu Wei X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list Reply-To: The development of GNU GRUB List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: grub-devel-bounces+patch=linaro.org@gnu.org Sender: grub-devel-bounces+patch=linaro.org@gnu.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: fu.wei@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.172 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 From: Fu Wei This patch adds Xen boot support file: grub-core/loader/arm64/xen_boot.c include/grub/arm64/xen_boot.h This patch also adds commands register code and hearder file into grub-core/loader/arm64/linux.c - This adds support for the Xen boot on ARM specification for arm64. - The implementation for Xen is following : http://wiki.xen.org/wiki/Xen_ARM_with_Virtualization_Extensions/Multiboot and xen/docs/misc/arm/device-tree/booting.txt in Xen source code. - The multiboot/module commands have existed, so we use xen_hypervisor/xen_module instead. - This Xen boot support is built into linux module for aarch64. - Adding this functionality to the existing "linux" module is for reusing the existing code of devicetree. Signed-off-by: Fu Wei --- grub-core/Makefile.core.def | 1 + grub-core/loader/arm64/linux.c | 6 + grub-core/loader/arm64/xen_boot.c | 615 ++++++++++++++++++++++++++++++++++++++ include/grub/arm64/xen_boot.h | 115 +++++++ 4 files changed, 737 insertions(+) create mode 100644 grub-core/loader/arm64/xen_boot.c create mode 100644 include/grub/arm64/xen_boot.h diff --git a/grub-core/Makefile.core.def b/grub-core/Makefile.core.def index a6101de..01f8261 100644 --- a/grub-core/Makefile.core.def +++ b/grub-core/Makefile.core.def @@ -1659,6 +1659,7 @@ module = { ia64_efi = loader/ia64/efi/linux.c; arm = loader/arm/linux.c; arm64 = loader/arm64/linux.c; + arm64 = loader/arm64/xen_boot.c; fdt = lib/fdt.c; common = loader/linux.c; common = lib/cmdline.c; diff --git a/grub-core/loader/arm64/linux.c b/grub-core/loader/arm64/linux.c index 987f5b9..7ae9bde 100644 --- a/grub-core/loader/arm64/linux.c +++ b/grub-core/loader/arm64/linux.c @@ -26,6 +26,7 @@ #include #include #include +#include #include #include #include @@ -477,6 +478,9 @@ GRUB_MOD_INIT (linux) cmd_devicetree = grub_register_command ("devicetree", grub_cmd_devicetree, 0, N_("Load DTB file.")); + + grub_arm64_linux_register_xen_boot_command (mod, &loaded); + my_mod = mod; } @@ -485,4 +489,6 @@ GRUB_MOD_FINI (linux) grub_unregister_command (cmd_linux); grub_unregister_command (cmd_initrd); grub_unregister_command (cmd_devicetree); + + grub_arm64_linux_unregister_xen_boot_command (); } diff --git a/grub-core/loader/arm64/xen_boot.c b/grub-core/loader/arm64/xen_boot.c new file mode 100644 index 0000000..23bd00e --- /dev/null +++ b/grub-core/loader/arm64/xen_boot.c @@ -0,0 +1,615 @@ +/* + * 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 . + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +static grub_dl_t linux_mod; +static int *loaded; + +static struct xen_boot_binary *xen_hypervisor; +static struct xen_boot_binary *module_head; +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 void *xen_boot_fdt; +static const compat_string_struct_t default_compat_string[] = { + FDT_COMPATIBLE (MODULE_IMAGE_COMPATIBLE), + FDT_COMPATIBLE (MODULE_INITRD_COMPATIBLE), + FDT_COMPATIBLE (MODULE_OTHER_COMPATIBLE) +}; + + +/* Parse all the options of xen_module command. For now, we support + (1) --type + (2) --nounzip + We also set up the type of module in this function. + If there are some "--type" options in the command line, + we make a custom compatible stream in this function. */ +static grub_err_t +set_module_type (struct xen_boot_binary *module, int argc, char *argv[], + int *file_name_index) +{ + char **compat_string_temp_array = + (char **) grub_zalloc (sizeof (char *) * argc); + static module_type_t default_type = MODULE_IMAGE; + grub_size_t total_size = 0; + int num_types = 0, i; + char *temp = NULL; + + *file_name_index = 0; + + /* if there are some options we need to process. */ + while (argc > 1 && !grub_strncmp (argv[0], "--", 2)) + { + if (!grub_strcmp (argv[0], "--type")) + { + module->node_info.type = MODULE_CUSTOM; + ARG_SHIFT (argc, argv); + total_size += grub_strlen (argv[0]) + 1; + compat_string_temp_array[num_types++] = argv[0]; + ARG_SHIFT (argc, argv); + (*file_name_index) += 2; + } + else if (!grub_strcmp (argv[0], "--nounzip")) + { + grub_file_filter_disable_compression (); + ARG_SHIFT (argc, argv); + (*file_name_index) += 1; + } + else /* we can add more options process code here. */ + { + grub_dprintf ("xen_boot_loader", + "Unknown option %s, skip.\n", argv[0]); + ARG_SHIFT (argc, argv); + (*file_name_index) += 1; + } + } + + /* To prevent some wrong command lines using "--type" option */ + if (!argc) + return grub_error (GRUB_ERR_BAD_ARGUMENT, N_("filename expected")); + + /* For the default module type : + The implementation is following : + Each module will be given a default compatibility property + based on the order in which the modules are added. + The 1st module: compatible = "multiboot,kernel", "multiboot,module" + The 2nd module: compatible = "multiboot,ramdisk", "multiboot,module" + All subsequent modules: compatible = "multiboot,module" + But this order will NOT be interfered with "--type"(MODULE_CUSTOM) + For more detail, please refer to: + http://wiki.xen.org/wiki/Xen_ARM_with_Virtualization_Extensions/Multiboot */ + if (module->node_info.type != MODULE_CUSTOM) + { + /* the module type is set by the load order */ + module->node_info.type = default_type; + switch (default_type) + { + case MODULE_IMAGE: + default_type = MODULE_INITRD; + break; + + case MODULE_INITRD: + default_type = MODULE_OTHER; + break; + + case MODULE_OTHER: + break; + + default: + default_type = MODULE_IMAGE; /* error, reset the type */ + return grub_error (GRUB_ERR_BAD_ARGUMENT, N_("invalid argument")); + } + } + else + { + /* the module type is set by "--type"(MODULE_CUSTOM) */ + module->node_info.compat_string = temp = + (char *) grub_zalloc (total_size); + module->node_info.compat_string_size = total_size; + for (i = 0; num_types > 0; num_types--, i++, temp++) + { + grub_strcpy (temp, compat_string_temp_array[i]); + temp += grub_strlen (compat_string_temp_array[i]); + } + } + + grub_free (compat_string_temp_array); + + return GRUB_ERR_NONE; +} + +static grub_err_t +prepare_xen_hypervisor_params (void) +{ + int chosen_node = 0; + int retval; + + xen_boot_fdt = grub_linux_get_fdt (); + if (!xen_boot_fdt) + return grub_error (GRUB_ERR_BAD_OS, "failed to get FDT"); + + chosen_node = grub_fdt_find_subnode (xen_boot_fdt, 0, "chosen"); + if (chosen_node < 0) + chosen_node = grub_fdt_add_subnode (xen_boot_fdt, 0, "chosen"); + if (chosen_node < 1) + return grub_error (GRUB_ERR_BAD_OS, "failed to get chosen node in FDT"); + + grub_dprintf ("xen_boot_loader", + "Xen Hypervisor cmdline : %s @ %p size:%d\n", + xen_hypervisor->cmdline, xen_hypervisor->cmdline, + xen_hypervisor->cmdline_size); + + retval = grub_fdt_set_prop (xen_boot_fdt, chosen_node, "bootargs", + xen_hypervisor->cmdline, + xen_hypervisor->cmdline_size); + if (retval) + return grub_error (GRUB_ERR_BAD_OS, "failed to install/update FDT"); + + return GRUB_ERR_NONE; +} + +static grub_err_t +prepare_xen_module_params (struct xen_boot_binary *module) +{ + int retval, chosen_node = 0, module_node = 0; + char module_name[FDT_NODE_NAME_MAX_SIZE]; + + retval = grub_snprintf (module_name, FDT_NODE_NAME_MAX_SIZE, "module@%lx", + xen_boot_address_align (module->start, + module->align)); + grub_dprintf ("xen_boot_loader", "Module node name %s \n", module_name); + + if (retval < (int) sizeof ("module@")) + return grub_error (GRUB_ERR_BAD_OS, N_("failed to get FDT")); + + chosen_node = grub_fdt_find_subnode (xen_boot_fdt, 0, "chosen"); + if (chosen_node < 0) + chosen_node = grub_fdt_add_subnode (xen_boot_fdt, 0, "chosen"); + if (chosen_node < 1) + return grub_error (GRUB_ERR_BAD_OS, "failed to get chosen node in FDT"); + + module_node = + grub_fdt_find_subnode (xen_boot_fdt, chosen_node, module_name); + if (module_node < 0) + module_node = + grub_fdt_add_subnode (xen_boot_fdt, chosen_node, module_name); + + retval = grub_fdt_set_prop (xen_boot_fdt, module_node, "compatible", + module->node_info.compat_string, + (grub_uint32_t) module->node_info. + compat_string_size); + if (retval) + return grub_error (GRUB_ERR_BAD_OS, N_("failed to update FDT")); + + grub_dprintf ("xen_boot_loader", "Module %s compatible = %s size = 0x%lx\n", + module->name, module->node_info.compat_string, + module->node_info.compat_string_size); + + retval = grub_fdt_set_reg64 (xen_boot_fdt, module_node, + xen_boot_address_align (module->start, + module->align), + module->size); + if (retval) + return grub_error (GRUB_ERR_BAD_OS, N_("failed to update FDT")); + + if (module->cmdline && module->cmdline_size > 0) + { + grub_dprintf ("xen_boot_loader", + "Module %s cmdline : %s @ %p size:%d\n", module->name, + module->cmdline, module->cmdline, module->cmdline_size); + + retval = grub_fdt_set_prop (xen_boot_fdt, module_node, "bootargs", + module->cmdline, module->cmdline_size + 1); + if (retval) + return grub_error (GRUB_ERR_BAD_OS, "failed to update FDT"); + } + else + { + grub_dprintf ("xen_boot_loader", "Module %s has not bootargs!\n", + module->name); + } + + return GRUB_ERR_NONE; +} + +static grub_err_t +install_all_params (void) +{ + grub_efi_guid_t fdt_guid = GRUB_EFI_DEVICE_TREE_GUID; + 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, xen_boot_fdt); + if (status != GRUB_EFI_SUCCESS) + return grub_error (GRUB_ERR_BAD_OS, "failed to install FDT"); + + grub_dprintf ("xen_boot_loader", + "Installed/updated FDT configuration table @ %p\n", + xen_boot_fdt); + + return GRUB_ERR_NONE; +} + +static grub_err_t +clean_all_params (void) +{ + if (xen_boot_fdt) + { + grub_efi_free_pages ((grub_efi_physical_address_t) xen_boot_fdt, + BYTES_TO_PAGES (grub_fdt_get_totalsize + (xen_boot_fdt))); + xen_boot_fdt = NULL; + } + + return GRUB_ERR_NONE; +} + +static grub_err_t +finalize_params_xen_boot (void) +{ + struct xen_boot_binary *module; + + if (xen_hypervisor) + { + if (prepare_xen_hypervisor_params () != GRUB_ERR_NONE) + goto fail; + } + else + { + grub_dprintf ("xen_boot_loader", + "Failed to get Xen Hypervisor info!\n"); + goto fail; + } + + /* Set module params info */ + FOR_LIST_ELEMENTS (module, module_head) + { + if (module->start && module->size > 0) + { + grub_dprintf ("xen_boot_loader", "Module %s @ 0x%lx size:0x%lx\n", + module->name, + xen_boot_address_align (module->start, module->align), + module->size); + if (prepare_xen_module_params (module) != GRUB_ERR_NONE) + goto fail; + } + else + { + grub_dprintf ("xen_boot_loader", "Module info error: %s!\n", + module->name); + goto fail; + } + } + + if (install_all_params () == GRUB_ERR_NONE) + return GRUB_ERR_NONE; + +fail: + clean_all_params (); + + return grub_error (GRUB_ERR_BAD_OS, "failed to install/update FDT"); +} + + +static grub_err_t +xen_boot (void) +{ + if (finalize_params_xen_boot () != GRUB_ERR_NONE) + return grub_errno; + + return grub_arm64_uefi_boot_image (xen_hypervisor->start, + xen_hypervisor->size, + xen_hypervisor->cmdline); +} + +static void +single_binary_unload (struct xen_boot_binary *binary) +{ + if (binary && binary->start && binary->size > 0) + { + grub_efi_free_pages ((grub_efi_physical_address_t) binary->start, + BYTES_TO_PAGES (binary->size + binary->align)); + } + + if (binary && binary->cmdline && binary->cmdline_size > 0) + { + grub_free (binary->cmdline); + grub_dprintf ("xen_boot_loader", + "Module %s cmdline memory free @ %p size: %d\n", + binary->name, binary->cmdline, binary->cmdline_size); + } + + if (binary) + { + if (binary->node_info.type == MODULE_CUSTOM) + grub_free ((void *) binary->node_info.compat_string); + if (grub_strcmp (binary->name, XEN_HYPERVISOR_NAME)) + grub_list_remove (GRUB_AS_LIST (binary)); + grub_dprintf ("xen_boot_loader", + "Module %s struct memory free @ %p size: 0x%lx\n", + binary->name, binary, sizeof (binary)); + grub_free (binary); + } + + return; +} + +static void +all_binaries_unload (void) +{ + struct xen_boot_binary *binary; + + FOR_LIST_ELEMENTS (binary, module_head) + { + single_binary_unload (binary); + } + + if (xen_hypervisor) + single_binary_unload (xen_hypervisor); + + return; +} + +static grub_err_t +xen_unload (void) +{ + *loaded = 0; + all_binaries_unload (); + clean_all_params (); + grub_dl_unref (linux_mod); + + return GRUB_ERR_NONE; +} + +static grub_err_t +xen_boot_binary_load (struct xen_boot_binary *binary, grub_file_t file, + int argc, char *argv[]) +{ + binary->size = grub_file_size (file); + grub_dprintf ("xen_boot_loader", "Xen_boot %s file size: 0x%lx\n", + binary->name, binary->size); + + binary->start = (grub_addr_t) grub_efi_allocate_pages (0, + (BYTES_TO_PAGES + (binary->size + + binary->align))); + if (!binary->start) + return grub_error (GRUB_ERR_OUT_OF_MEMORY, N_("out of memory")); + + grub_dprintf ("xen_boot_loader", "Xen_boot %s numpages: 0x%lx\n", + binary->name, BYTES_TO_PAGES (binary->size + binary->align)); + + if (grub_file_read (file, (void *) xen_boot_address_align (binary->start, + binary->align), + binary->size) < (grub_ssize_t) binary->size) + { + single_binary_unload (binary); + return grub_error (GRUB_ERR_BAD_OS, N_("premature end of file %s"), + argv[0]); + } + + /* Skip the xen_boot binary file name */ + ARG_SHIFT (argc, argv); + + if (argc > 0) + { + binary->cmdline_size = grub_loader_cmdline_size (argc, argv); + binary->cmdline = grub_zalloc (binary->cmdline_size); + if (!binary->cmdline) + { + single_binary_unload (binary); + return grub_error (GRUB_ERR_OUT_OF_MEMORY, N_("out of memory")); + } + grub_create_loader_cmdline (argc, argv, binary->cmdline, + binary->cmdline_size); + grub_dprintf ("xen_boot_loader", + "Xen_boot %s cmdline @ %p %s, size: %d\n", binary->name, + binary->cmdline, binary->cmdline, binary->cmdline_size); + } + else + { + binary->cmdline_size = 0; + binary->cmdline = NULL; + } + + return GRUB_ERR_NONE; +} + +static grub_err_t +grub_cmd_xen_module (grub_command_t cmd __attribute__ ((unused)), + int argc, char *argv[]) +{ + + struct xen_boot_binary *module = NULL; + int file_name_index = 0; + grub_file_t file = 0; + + if (!argc) + { + grub_error (GRUB_ERR_BAD_ARGUMENT, N_("filename expected")); + goto fail; + } + + if (!*loaded) + { + grub_error (GRUB_ERR_BAD_ARGUMENT, + N_("you need to load the Xen Hypervisor first")); + goto fail; + } + + module = + (struct xen_boot_binary *) grub_zalloc (sizeof (struct xen_boot_binary)); + if (!module) + return grub_error (GRUB_ERR_OUT_OF_MEMORY, N_("out of memory")); + + /* process all the options and get module type */ + if (set_module_type (module, argc, argv, &file_name_index) != GRUB_ERR_NONE) + goto fail; + switch (module->node_info.type) + { + case MODULE_IMAGE: + case MODULE_INITRD: + case MODULE_OTHER: + module->node_info.compat_string = + default_compat_string[module->node_info.type].compat_string; + module->node_info.compat_string_size = + default_compat_string[module->node_info.type].size; + break; + + case MODULE_CUSTOM: + /* we have set the node_info in set_module_type */ + break; + + default: + return grub_error (GRUB_ERR_BAD_ARGUMENT, N_("invalid argument")); + } + module->name = module->node_info.compat_string; + module->align = module_default_align[module->node_info.type]; + + grub_dprintf ("xen_boot_loader", "Init %s module and node info:\n" + "compatible %s\ncompat_string_size 0x%lx\n", + module->name, module->node_info.compat_string, + module->node_info.compat_string_size); + + file = grub_file_open (argv[file_name_index]); + if (!file) + goto fail; + + grub_errno = xen_boot_binary_load (module, file, argc - file_name_index, + argv + file_name_index); + + 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_binary_unload (module); + + return grub_errno; +} + +static grub_err_t +grub_cmd_xen_hypervisor (grub_command_t cmd __attribute__ ((unused)), + int argc, char *argv[]) +{ + struct xen_hypervisor_header sh; + grub_file_t file = NULL; + + grub_dl_ref (linux_mod); + + if (!argc) + { + grub_error (GRUB_ERR_BAD_ARGUMENT, N_("filename expected")); + goto fail; + } + + /* For now, we don't support any option in xen_hypervisor command. + If there are some options, we skip them. */ + while (argc > 1 && !grub_strncmp (argv[0], "--", 2)) + { + grub_dprintf ("xen_boot_loader", "Unknown option %s, skip.\n", argv[0]); + ARG_SHIFT (argc, argv); + } + + file = grub_file_open (argv[0]); + if (!file) + goto fail; + + if (grub_file_read (file, &sh, sizeof (sh)) < (long) sizeof (sh)) + goto fail; + if (grub_arm64_uefi_check_image + ((struct grub_arm64_linux_kernel_header *) &sh) != GRUB_ERR_NONE) + goto fail; + grub_file_seek (file, 0); + + grub_loader_unset (); + + xen_hypervisor = + (struct xen_boot_binary *) grub_zalloc (sizeof (struct xen_boot_binary)); + if (!xen_hypervisor) + return grub_error (GRUB_ERR_OUT_OF_MEMORY, N_("out of memory")); + + xen_hypervisor->name = XEN_HYPERVISOR_NAME; + xen_hypervisor->align = (grub_size_t) sh.optional_header.section_alignment; + + grub_errno = xen_boot_binary_load (xen_hypervisor, file, argc, argv); + if (grub_errno == GRUB_ERR_NONE) + { + grub_loader_set (xen_boot, xen_unload, 0); + *loaded = 1; + } + +fail: + if (file) + grub_file_close (file); + if (grub_errno != GRUB_ERR_NONE) + { + *loaded = 0; + all_binaries_unload (); + grub_dl_unref (linux_mod); + } + + return grub_errno; +} + +static grub_command_t cmd_xen_hypervisor, cmd_xen_module; + +void +grub_arm64_linux_register_xen_boot_command (grub_dl_t mod, int *linux_loaded) +{ + cmd_xen_hypervisor = + grub_register_command ("xen_hypervisor", grub_cmd_xen_hypervisor, 0, + N_("Load a xen hypervisor.")); + cmd_xen_module = + grub_register_command ("xen_module", grub_cmd_xen_module, 0, + N_("Load a xen module.")); + linux_mod = mod; + loaded = linux_loaded; +} + +void +grub_arm64_linux_unregister_xen_boot_command (void) +{ + grub_unregister_command (cmd_xen_hypervisor); + grub_unregister_command (cmd_xen_module); +} diff --git a/include/grub/arm64/xen_boot.h b/include/grub/arm64/xen_boot.h new file mode 100644 index 0000000..8e8f6cb --- /dev/null +++ b/include/grub/arm64/xen_boot.h @@ -0,0 +1,115 @@ +/* + * xen_boot.h - Xen boot header file for Xen boot via FDT + * on AArch64 architecture. + * 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 . + */ + +#ifndef XEN_BOOT_HEADER +#define XEN_BOOT_HEADER 1 + +#include +#include +#include /* required by struct xen_hypervisor_header */ + +#define XEN_HYPERVISOR_NAME "xen_hypervisor" + +#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 MODULE_IMAGE_COMPATIBLE "multiboot,kernel\0multiboot,module" +#define MODULE_INITRD_COMPATIBLE "multiboot,ramdisk\0multiboot,module" +#define MODULE_OTHER_COMPATIBLE "multiboot,module" + +/* This maximum size is defined in Power.org ePAPR V1.1 + * https://www.power.org/documentation/epapr-version-1-1/ + * 2.2.1.1 Node Name Requirements + * node-name@unit-address + * 31 + 1(@) + 16(64bit address in hex format) + 1(\0) = 49 + */ +#define FDT_NODE_NAME_MAX_SIZE (49) + +#define ARG_SHIFT(argc, argv) \ + do { \ + (argc)--; \ + (argv)++; \ + } while (0) + +struct compat_string_struct +{ + grub_size_t size; + const char *compat_string; +}; +typedef struct compat_string_struct compat_string_struct_t; +#define FDT_COMPATIBLE(x) {.size = sizeof(x), .compat_string = (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 *compat_string; + grub_size_t compat_string_size; +}; + +struct xen_hypervisor_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; +}; + +struct xen_boot_binary +{ + struct xen_boot_binary *next; + struct xen_boot_binary **prev; + const char *name; + + grub_addr_t start; + grub_size_t size; + grub_size_t align; + + char *cmdline; + int cmdline_size; + + struct fdt_node_info node_info; +}; + +void grub_arm64_linux_register_xen_boot_command (grub_dl_t mod, int *loaded); +void grub_arm64_linux_unregister_xen_boot_command (void); + +static __inline grub_addr_t +xen_boot_address_align (grub_addr_t start, grub_size_t align) +{ + return (align ? (ALIGN_UP (start, align)) : start); +} + +#endif /* ! XEN_BOOT_HEADER */