From patchwork Thu Nov 28 16:41:21 2013 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Leif Lindholm X-Patchwork-Id: 21841 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-qe0-f69.google.com (mail-qe0-f69.google.com [209.85.128.69]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 8633020299 for ; Thu, 28 Nov 2013 16:42:08 +0000 (UTC) Received: by mail-qe0-f69.google.com with SMTP id 1sf14730347qec.8 for ; Thu, 28 Nov 2013 08:42:08 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:delivered-to:from:to:cc:subject :date:message-id:in-reply-to:references:x-original-sender :x-original-authentication-results:precedence:mailing-list:list-id :list-post:list-help:list-archive:list-unsubscribe; bh=bo9/gDfLGqTQ4jg525Yloy/TGqWMLeUNEYG908CUpVQ=; b=OZjwhgTK/7mNmvtmr6zkm7MlCY0ttK3YSeGLqyrNx4DrJbM91WjIA/bfeo+cYsbGI/ p2hB5CYmjW2rVnCBixLVF8KyGIjBVfje94xd1TLE5YU9ddWaJ+YLKf7oPO7a3J5cvMyp dcNkLhxje4z0qVCt8n1jnxCCAiDoYnv3rl3W7Ts8nZ/Yg7KLWIzNUifo3EnmTAtsjbfn Z034RmQCO6XMrAVjJk5RXfJYI9558JulMTrVmbP6wlGQsxO3ST/WUKD18EddT/VOgOe3 ALhLeQ3JFDDZ6QY+zcHs7HmGKXhIF3MOxSuq7OkfDmJsAtTzeoC1zN9+q8zICR9MbijM 4SUw== X-Gm-Message-State: ALoCoQkACVTGpQvfMlXCSrIFQCRAZ4LZk9qB4AyPOBu20ibVaXK+g2NzC/dAItCrnnDrsMUAfb7+ X-Received: by 10.52.248.195 with SMTP id yo3mr13124236vdc.1.1385656928201; Thu, 28 Nov 2013 08:42:08 -0800 (PST) MIME-Version: 1.0 X-BeenThere: patchwork-forward@linaro.org Received: by 10.49.48.82 with SMTP id j18ls2504388qen.49.gmail; Thu, 28 Nov 2013 08:42:08 -0800 (PST) X-Received: by 10.220.159.4 with SMTP id h4mr38480313vcx.1.1385656928125; Thu, 28 Nov 2013 08:42:08 -0800 (PST) Received: from mail-vc0-f169.google.com (mail-vc0-f169.google.com [209.85.220.169]) by mx.google.com with ESMTPS id tr2si4158032vdc.3.2013.11.28.08.42.08 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 28 Nov 2013 08:42:08 -0800 (PST) Received-SPF: neutral (google.com: 209.85.220.169 is neither permitted nor denied by best guess record for domain of patch+caf_=patchwork-forward=linaro.org@linaro.org) client-ip=209.85.220.169; Received: by mail-vc0-f169.google.com with SMTP id hu19so6186181vcb.28 for ; Thu, 28 Nov 2013 08:42:08 -0800 (PST) X-Received: by 10.220.123.6 with SMTP id n6mr1620008vcr.28.1385656928014; Thu, 28 Nov 2013 08:42:08 -0800 (PST) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patches@linaro.org Received: by 10.220.174.196 with SMTP id u4csp27774vcz; Thu, 28 Nov 2013 08:42:07 -0800 (PST) X-Received: by 10.180.87.69 with SMTP id v5mr3166214wiz.45.1385656927088; Thu, 28 Nov 2013 08:42:07 -0800 (PST) Received: from mail-wi0-f178.google.com (mail-wi0-f178.google.com [209.85.212.178]) by mx.google.com with ESMTPS id 5si23512452wjs.75.2013.11.28.08.42.06 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 28 Nov 2013 08:42:07 -0800 (PST) Received-SPF: neutral (google.com: 209.85.212.178 is neither permitted nor denied by best guess record for domain of leif.lindholm@linaro.org) client-ip=209.85.212.178; Received: by mail-wi0-f178.google.com with SMTP id ca18so1078351wib.5 for ; Thu, 28 Nov 2013 08:42:06 -0800 (PST) X-Received: by 10.194.11.38 with SMTP id n6mr38214144wjb.25.1385656926566; Thu, 28 Nov 2013 08:42:06 -0800 (PST) Received: from mohikan.mushroom.smurfnet.nu (cpc4-cmbg17-2-0-cust71.5-4.cable.virginm.net. [86.14.224.72]) by mx.google.com with ESMTPSA id s2sm83470728wiy.7.2013.11.28.08.42.03 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 28 Nov 2013 08:42:05 -0800 (PST) From: Leif Lindholm To: linux-arm-kernel@lists.infradead.org, linux-efi@vger.kernel.org, linux-kernel@vger.kernel.org, linux@arm.linux.org.uk Cc: matt.fleming@intel.com, grant.likely@linaro.org, roy.franz@linaro.org, msalter@redhat.com, patches@linaro.org, linaro-uefi@linaro.org, mark.rutland@arm.com, Leif Lindholm , Rob Landley , linux-doc@vger.kernel.org Subject: [PATCH v3 1/3] Documentation: arm: add UEFI support documentation Date: Thu, 28 Nov 2013 16:41:21 +0000 Message-Id: <1385656883-4420-2-git-send-email-leif.lindholm@linaro.org> X-Mailer: git-send-email 1.7.10.4 In-Reply-To: <1385656883-4420-1-git-send-email-leif.lindholm@linaro.org> References: <1385656883-4420-1-git-send-email-leif.lindholm@linaro.org> X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: leif.lindholm@linaro.org X-Original-Authentication-Results: mx.google.com; spf=neutral (google.com: 209.85.220.169 is neither permitted nor denied by best guess record for domain of patch+caf_=patchwork-forward=linaro.org@linaro.org) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Precedence: list Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org List-ID: X-Google-Group-Id: 836684582541 List-Post: , List-Help: , List-Archive: List-Unsubscribe: , This patch provides documentation of the [U]EFI runtime service and configuration features for the arm architecture. Changes since v1/v2: - Complete rewrite. - New FDT bindings. Cc: Rob Landley Cc: linux-doc@vger.kernel.org Signed-off-by: Leif Lindholm Acked-by: Grant Likely --- Documentation/arm/00-INDEX | 3 +++ Documentation/arm/uefi.txt | 61 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+) create mode 100644 Documentation/arm/uefi.txt diff --git a/Documentation/arm/00-INDEX b/Documentation/arm/00-INDEX index 36420e1..b3af704 100644 --- a/Documentation/arm/00-INDEX +++ b/Documentation/arm/00-INDEX @@ -34,3 +34,6 @@ nwfpe/ - NWFPE floating point emulator documentation swp_emulation - SWP/SWPB emulation handler/logging description + +uefi.txt + - [U]EFI configuration and runtime services documentation diff --git a/Documentation/arm/uefi.txt b/Documentation/arm/uefi.txt new file mode 100644 index 0000000..9ba59509 --- /dev/null +++ b/Documentation/arm/uefi.txt @@ -0,0 +1,61 @@ +UEFI, the Unified Extensible Firmware Interface is, a specification +governing the behaviours of compatible firmware interfaces. It is +maintained by the UEFI Forum - http://www.uefi.org/. + +UEFI is an evolution of its predecessor 'EFI', so the terms EFI and +UEFI are used somewhat interchangeably in this document and associated +source code. As a rule, anything new uses 'UEFI', whereas 'EFI' refers +to legacy code or specifications. + +UEFI support in Linux +===================== +Booting on a platform with firmware compliant with the UEFI specification +makes it possible for the kernel to support additional features: +- UEFI Runtime Services +- Retrieving various configuration information through the standardised + interface of UEFI configuration tables. (ACPI, SMBIOS, ...) + +For actually enabling [U]EFI support, enable: +- CONFIG_EFI=y +- CONFIG_EFI_VARS=y or m + +The implementation depends on receiving information about the UEFI environment +in a Flattened Device Tree (FDT) - so is only available with CONFIG_OF. + +UEFI stub +========= +The "stub" is a feature that turns the Image/zImage into a valid UEFI PE/COFF +executable, including a loader application that makes it possible to load the +kernel directly from the UEFI shell, boot menu, or one of the lightweight +bootloaders like Gummiboot or rEFInd. + +The kernel image built with stub support remains a valid kernel image for +booting in non-UEFI environments. + +UEFI kernel support on ARM +========================== +UEFI kernel support on the ARM architectures (arm and arm64) is only available +when boot is performed through the stub. + +The stub populates the FDT /chosen node with (and the kernel scans for) the +following parameters: +________________________________________________________________________________ +Name | Size | Description +================================================================================ +linux,uefi-system-table | 64-bit | Physical address of the UEFI System Table. +-------------------------------------------------------------------------------- +linux,uefi-mmap-start | 64-bit | Physical address of the UEFI memory map, + | | populated by the UEFI GetMemoryMap() call. +-------------------------------------------------------------------------------- +linux,uefi-mmap-size | 32-bit | Size in bytes of the UEFI memory map + | | pointed to in previous entry. +-------------------------------------------------------------------------------- +linux,uefi-mmap-desc-size | 32-bit | Size in bytes of each entry in the UEFI + | | memory map. +-------------------------------------------------------------------------------- +linux,uefi-mmap-desc-ver | 32-bit | Version of the mmap descriptor format. +-------------------------------------------------------------------------------- +linux,uefi-stub-kern-ver | string | Copy of linux_banner from build. +-------------------------------------------------------------------------------- + +For verbose debug messages, specify 'uefi_debug' on the kernel command line.