Arm® SBSA Architecture Compliance User Guide Arm
User Manual:
Open the PDF directly: View PDF .
Page Count: 20
Download | |
Open PDF In Browser | View PDF |
Arm® SBSA Architecture Compliance Revision: r2p0 User Guide Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. 101547_0200_02_en Arm® SBSA Architecture Compliance Arm® SBSA Architecture Compliance User Guide Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Release Information Document History Issue Date Confidentiality Change A 30 November 2016 Non-Confidential Alpha release B 31 March 2017 Non-Confidential Beta release C 13 July 2017 Non-Confidential RELv1.0 D 11 May 2018 Non-Confidential RELv2.0 0200-01 27 December 2018 Non-Confidential RELv2.1. The document now follows a new numbering format. 0200-02 26 April 2019 Non-Confidential RELv2.2 Non-Confidential Proprietary Notice This document is protected by copyright and other related rights and the practice or implementation of the information contained in this document may be protected by one or more patents or pending patent applications. No part of this document may be reproduced in any form by any means without the express prior written permission of Arm. No license, express or implied, by estoppel or otherwise to any intellectual property rights is granted by this document unless specifically stated. Your access to the information in this document is conditional upon your acceptance that you will not use or permit others to use the information for the purposes of determining whether implementations infringe any third party patents. THIS DOCUMENT IS PROVIDED “AS IS”. ARM PROVIDES NO REPRESENTATIONS AND NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY, SATISFACTORY QUALITY, NON-INFRINGEMENT OR FITNESS FOR A PARTICULAR PURPOSE WITH RESPECT TO THE DOCUMENT. For the avoidance of doubt, Arm makes no representation with respect to, and has undertaken no analysis to identify or understand the scope and content of, third party patents, copyrights, trade secrets, or other rights. This document may include technical inaccuracies or typographical errors. TO THE EXTENT NOT PROHIBITED BY LAW, IN NO EVENT WILL ARM BE LIABLE FOR ANY DAMAGES, INCLUDING WITHOUT LIMITATION ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF ANY USE OF THIS DOCUMENT, EVEN IF ARM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. This document consists solely of commercial items. You shall be responsible for ensuring that any use, duplication or disclosure of this document complies fully with any relevant export laws and regulations to assure that this document or any portion thereof is not exported, directly or indirectly, in violation of such export laws. Use of the word “partner” in reference to Arm’s customers is not intended to create or refer to any partnership relationship with any other company. Arm may make changes to this document at any time and without notice. If any of the provisions contained in these terms conflict with any of the provisions of any click through or signed written agreement covering this document with Arm, then the click through or signed written agreement prevails over and supersedes the conflicting provisions of these terms. This document may be translated into other languages for convenience, and you agree that if there is any conflict between the English version of this document and any translation, the terms of the English version of the Agreement shall prevail. The Arm corporate logo and words marked with ® or ™ are registered trademarks or trademarks of Arm Limited (or its subsidiaries) in the US and/or elsewhere. All rights reserved. Other brands and names mentioned in this document may be the trademarks of their respective owners. Please follow Arm’s trademark usage guidelines at http://www.arm.com/company/policies/ trademarks. Copyright © 2016–2019 Arm Limited (or its affiliates). All rights reserved. 101547_0200_02_en Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential 2 Arm® SBSA Architecture Compliance Arm Limited. Company 02557590 registered in England. 110 Fulbourn Road, Cambridge, England CB1 9NJ. LES-PRE-20349 Confidentiality Status This document is Non-Confidential. The right to use, copy and disclose this document may be subject to license restrictions in accordance with the terms of the agreement entered into by Arm and the party that Arm delivered this document to. Unrestricted Access is an Arm internal classification. Product Status The information in this document is Final, that is for a developed product. Web Address http://www.arm.com 101547_0200_02_en Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential 3 Contents Arm® SBSA Architecture Compliance User Guide Preface About this book ...................................................... ...................................................... 6 Feedback ...................................................................................................................... 8 Chapter 1 UEFI shell application 1.1 1.2 1.3 1.4 Chapter 2 Linux application 2.1 2.2 Appendix A Linux application arguments .................................................................................... 2-16 Build steps and environment setup .................................... .................................... 2-17 Revisions A.1 101547_0200_02_en Overview of tests .................................................. .................................................. 1-10 UEFI application arguments .......................................... .......................................... 1-11 Test IDs .................................................................................................................... 1-12 UEFI implementation of PAL APIs ..................................... ..................................... 1-13 Revisions ................................................... ................................................... Appx-A-20 Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential 4 Preface This preface introduces the Arm® SBSA Architecture Compliance User Guide. It contains the following: • About this book on page 6. • Feedback on page 8. 101547_0200_02_en Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential 5 Preface About this book About this book This book is the user guide for Arm® SBSA architecture compliance. Product revision status The rmpn identifier indicates the revision status of the product described in this book, for example, r1p2, where: rm Identifies the major revision of the product, for example, r1. pn Identifies the minor revision or modification status of the product, for example, p2. Intended audience This book is written for engineers who are designing or verifying an implementation of the Arm® Server Base System Architecture. Using this book This book is organized into the following chapters: Chapter 1 UEFI shell application Read this chapter for information on executing tests from the UEFI Shell application. Chapter 2 Linux application Read this chapter for information on executing tests from the Linux application. Appendix A Revisions This appendix describes the technical changes between released issues of this book. Glossary The Arm Glossary is a list of terms used in Arm documentation, together with definitions for those terms. The Arm Glossary does not contain terms that are industry standard unless the Arm meaning differs from the generally accepted meaning. See the Arm® Glossary for more information. Typographic conventions italic Introduces special terminology, denotes cross-references, and citations. bold Highlights interface elements, such as menu names. Denotes signal names. Also used for terms in descriptive lists, where appropriate. monospace Denotes text that you can enter at the keyboard, such as commands, file and program names, and source code. monospace Denotes a permitted abbreviation for a command or option. You can enter the underlined text instead of the full command or option name. monospace italic Denotes arguments to monospace text where the argument is to be replaced by a specific value. monospace bold Denotes language keywords when used outside example code. 101547_0200_02_en Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential 6 Preface About this bookEncloses replaceable terms for assembler syntax where they appear in code or code fragments. For example: MRC p15, 0, , , , SMALL CAPITALS Used in body text for a few terms that have specific technical meanings, that are defined in the Arm® Glossary. For example, IMPLEMENTATION DEFINED, IMPLEMENTATION SPECIFIC, UNKNOWN, and UNPREDICTABLE. Timing diagrams The following figure explains the components used in timing diagrams. Variations, when they occur, have clear labels. You must not assume any timing information that is not explicit in the diagrams. Shaded bus and signal areas are undefined, so the bus or signal can assume any value within the shaded area at that time. The actual level is unimportant and does not affect normal operation. Clock HIGH to LOW Transient HIGH/LOW to HIGH Bus stable Bus to high impedance Bus change High impedance to stable bus Figure 1 Key to timing diagram conventions Signals The signal conventions are: Signal level The level of an asserted signal depends on whether the signal is active-HIGH or active-LOW. Asserted means: • HIGH for active-HIGH signals. • LOW for active-LOW signals. Lowercase n At the start or end of a signal name denotes an active-LOW signal. Additional reading This book contains information that is specific to this product. See the following documents for other relevant information. Arm publications • Arm® Server Base System Architecture Specification (ARM-DEN-0029 Version 3.0). • Arm® Server Base Boot Requirements (ARM-DEN-0044B). • Arm® Architecture Reference Manual ARMv8, for Armv8-A architecture profile (ARM DDI 0487). Other publications None. 101547_0200_02_en Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential 7 Preface Feedback Feedback Feedback on this product If you have any comments or suggestions about this product, contact your supplier and give: • The product name. • The product revision or version. • An explanation with as much information as you can provide. Include symptoms and diagnostic procedures if appropriate. Feedback on content If you have comments on content then send an e-mail to errata@arm.com. Give: • • • • The title Arm SBSA Architecture Compliance User Guide. The number 101547_0200_02_en. If applicable, the page number(s) to which your comments refer. A concise explanation of your comments. Arm also welcomes general suggestions for additions and improvements. Note Arm tests the PDF only in Adobe Acrobat and Acrobat Reader, and cannot guarantee the quality of the represented document when used with any other PDF reader. 101547_0200_02_en Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential 8 Chapter 1 UEFI shell application Read this chapter for information on executing tests from the UEFI Shell application. It contains the following sections: • 1.1 Overview of tests on page 1-10. • 1.2 UEFI application arguments on page 1-11. • 1.3 Test IDs on page 1-12. • 1.4 UEFI implementation of PAL APIs on page 1-13. 101547_0200_02_en Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential 1-9 1 UEFI shell application 1.1 Overview of tests 1.1 Overview of tests The general division of tests between UEFI Shell application and Linux application is illustrated in the following table. Table 1-1 Test environment and modules Test environment Modules UEFI Shell PE, GIC, Timers, Watchdog, Wakeup, Secure devices Linux command line PCIe, SMMU, Exerciser Bare-metal 101547_0200_02_en Exerciser Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential 1-10 1 UEFI shell application 1.2 UEFI application arguments 1.2 UEFI application arguments Run the UEFI Shell application with the following set of arguments: uefi shell> sbsa.efi [-v ] [-l ] [-skip ] [-f ] [-s] The parameter descriptions are available in the following table. Table 1-2 Descriptions of UEFI application parameters Parameter Description v Print level 1 INFO and above. 2 DEBUG and above. 3 TEST and above. 4 WARN and ERROR. 5 ERROR. l Level of compliance to be tested for (0-5). skip Overrides the suite to skip the execution of a particular test. It allows a maximum of three values (comma-separated). For example, 300 skips test case with ID = 300. 500 skips all tests in module with ID = 500. For details on module IDs, see 1.3 Test IDs on page 1-12. f File name to which the output log is written. s Runs Secure tests before executing Non-secure tests. It requires Secure firmware code from SBSA ACS to be ported to EL3 FW. If this option is not given, only Non-secure tests are run. Example shell > sbsa.efi –v 2 –l 3 –f acs.txt –skip 20,36 The set of parameters shown in the above code block: • Prints messages with verbosity of 2 and above. • Tests for compliance against SBSA level 3. • Skips execution of all tests belonging to GIC module and test number 36. • Stores the log messages to the file acs.txt. 101547_0200_02_en Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential 1-11 1 UEFI shell application 1.3 Test IDs 1.3 Test IDs Test ID of each test is generated as an addition of module ID and unit test ID. For a given module, unit test ID begins from 1. Module IDs are as follows. Table 1-3 Module Name and Module ID Module name Module ID PE 0 GIC 100 Timer 200 Watchdog 300 PCIe 400 Power and Wakeup 500 101547_0200_02_en Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential Peripheral 600 SMMU 700 Exerciser 800 Secure 900 1-12 1 UEFI shell application 1.4 UEFI implementation of PAL APIs 1.4 UEFI implementation of PAL APIs The following table lists the UEFI interfaces used for the implementation of the Platform Abstraction Layer (PAL) APIs mentioned in the Arm® SBSA Validation Methodology document. PAL APIs are classified into infrastructure and module-specific APIs. Infrastructure APIs Table 1-4 PAL APIs and UEFI interfaces PAL API UEFI interfaces pal_print AsciiPrint mem_alloc gBS->AllocatePool mem_free gBS->FreePool mem_alloc_shared gBS->AllocatePool mem_free_shared gBS->FreePool mem_get_shared_addr None 101547_0200_02_en mmio_read None mmio_write None Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential 1-13 1 UEFI shell application 1.4 UEFI implementation of PAL APIs Module-specific APIs Table 1-5 PAL APIs, UEFI interfaces, and ACPI tables consumed PAL API UEFI interfaces consumed ACPI table consumed pe_create_info_table • • • MADT Table call_smc None - pe_execute_payload None - pe_install_esr • • gEfiCpuArchProtocolGuid Cpu->RegisterInterruptHandler - gic_create_info_table • • • gST->ConfigurationTable CompareGuid IndustryStandard/Acpi61.h MADT table gic_install_isr • • • gHardwareInterruptProtocolGuid RegisterInterruptSource EnableInterruptSource - timer_create_info_table • • • gST->ConfigurationTable CompareGuid IndustryStandard/Acpi61.h GTDT table wd_create_info_table • • • gST->ConfigurationTable CompareGuid IndustryStandard/Acpi61.h GTDT table pcie_create_info_table • • • gST->ConfigurationTable CompareGuid IndustryStandard/Acpi61.h MCFG table pcie_get_mcfg_ecam • • • gST->ConfigurationTable CompareGuid, IndustryStandard/Acpi61.h IndustryStandard/ MemoryMappedConfigurationSpaceAccessTable.h MCFG table iovirt_create_info_table • • • gST->ConfigurationTable CompareGuid IndustryStandard/Acpi61.h IORT table gEfiPciIoProtocolGuid Pci->GetLocation Pci->Pci.Read - peripheral_create_info_table • • • memory_create_info_table 101547_0200_02_en gST->ConfigurationTable CompareGuid IndustryStandard/Acpi61.h gBS->GetMemoryMap Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential - 1-14 Chapter 2 Linux application Read this chapter for information on executing tests from the Linux application. It contains the following sections: • 2.1 Linux application arguments on page 2-16. • 2.2 Build steps and environment setup on page 2-17. 101547_0200_02_en Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential 2-15 2 Linux application 2.1 Linux application arguments 2.1 Linux application arguments Run the Linux application with the following set of arguments: shell> sbsa [--v ] [--l ] [--e ] [--skip ] Table 2-1 Description of Linux application parameters Parameter Description v Print level 1 INFO and above 2 DEBUG and above 3 TEST and above 4 WARN and ERROR 5 ERROR l Level of compliance to be tested for. (0 to 5) e 1 Run exerciser tests. 0 Do not run exerciser tests. Note Additional hardware and software porting may be required to run the exerciser tests. skip Overrides the suite to skip the execution of a particular test. For example, 53 skips test case with ID 53. Example shell> sbsa --v 3 –-l 3 --e 1 --skip 57 This set of parameters tests for compliance against SBSA level 3 with print verbosity set to 3, runs the exerciser tests, and skips test number 57. Loading the kernel module Before the SBSA ACS Linux application can be run, load the SBSA ACS kernel module using the insmod command. shell> insmod sbsa_acs.ko 101547_0200_02_en Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential 2-16 2 Linux application 2.2 Build steps and environment setup 2.2 Build steps and environment setup This section lists the porting and build steps for the kernel module. The patch for the kernel tree and the Linux Platform Abstraction Layer are hosted separately on linuxarm.org. Building the kernel module Prerequisites • Linux kernel source version 4.14. • Linaro GCC tool chain 5.3 or above. • Build environment for AArch64 Linux kernel. Porting steps for Linux kernel 1. git clone git://linux-arm.org/linux-acs.git 2. git clone https://github.com/ARM-software/sbsa-acs.git 3. Apply the /kernel/src/0001-Enterprise-acs-linux-v4.13.patch patch to your kernel source tree. 4. Build the kernel. Build steps for SBSA kernel module 1. cd /sbsa-acs-drv/files 2. Set CROSS_COMPILE to the ARM64 toolchain path. 3. export KERNEL_SRC= 4. ./setup.sh 5. ./linux_sbsa_acs.sh sbsa_acs.ko file is generated. SBSA Linux application build 1. cd /linux_app/sbsa-acs-app 2. Set CROSS_COMPILE to the ARM64 toolchain path. export CROSS_COMPILE= /gcc-linaro-5.3-2016.02/bin/aarch64-linux-gnu- 3. make The executable file sbsa is generated. This section contains the following subsections: • 2.2.1 Target environment setup on page 2-17. • 2.2.2 Runtime environment on page 2-18. 2.2.1 Target environment setup The set of tests assumes that at least one SATA controller is behind a PCIe root complex. The SATA controller may or may not be behind an IOMMU. Before running these tests, at least one SATA hard disk must be connected to the SATA controller. The test performs read and write operations to the SATA hard disk. Therefore, the data on the HDD is overwritten. The SATA drive must not be the boot device for the OS. 101547_0200_02_en Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential 2-17 2 Linux application 2.2 Build steps and environment setup 2.2.2 Runtime environment Figure 2-1 Hardware functional blocks The PCIe-DMA tests initiate data transfers from a DMA master. By default, the test searches for a SATA controller which is part of the PCIe subsystem. 1. The test writes known data from the PE to main memory. 2. The test programs the DMA master to transfer this known data to its end-point device. 3. The test asks the DMA master to transfer the data back to a different location in the main memory. 4. The test compares the data at both the locations. If the SATA controller is not behind an IOMMU, during this data transfer, the address that is used by the SATA controller is retrieved and compared with the DMA address that is seen by the PE. If the DMA master is behind an IOMMU, then the address that is used by the SATA AHCI controller is compared with the address that is seen by the IOMMU. Both these addresses must match. To enable the export of the addresses that are seen by the SATA AHCI controller and IOMMU, the kernel drivers for these two modules must be patched. 101547_0200_02_en Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential 2-18 Appendix A Revisions This appendix describes the technical changes between released issues of this book. It contains the following section: • A.1 Revisions on page Appx-A-20. 101547_0200_02_en Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential Appx-A-19 A Revisions A.1 Revisions A.1 Revisions Table A-1 Issue0200-01 Change Location Affects Added information about exerciser. See 1.3 Test IDs on page 1-12. All revisions Added a new parameter [--e] to the Linux application arguments. See 2.1 Linux application arguments on page 2-16. All revisions Table A-2 Differences between Issue 0200-01 and Issue 0200-02 Change Location Affects Added bare-metal test environment to the table. See 1.1 Overview of tests on page 1-10. All revisions Added a note about additional porting for the exerciser. See 2.1 Linux application arguments on page 2-16. All revisions 101547_0200_02_en Copyright © 2016–2019 Arm Limited or its affiliates. All rights reserved. Non-Confidential Appx-A-20
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.7 Linearized : Yes Encryption : Standard V4.4 (128-bit) User Access : Print, Copy, Annotate, Fill forms, Extract, Print high-res Author : ARM Create Date : 2019:04:08 11:28:30+05:30 Modify Date : 2019:04:08 11:30:23+05:30 Subject : This book is the user guide for Arm® SBSA architecture compliance. Language : EN XMP Toolkit : Adobe XMP Core 5.6-c016 91.163616, 2018/10/29-16:58:49 Format : application/pdf Creator : ARM Description : This book is the user guide for Arm® SBSA architecture compliance. Title : Arm® SBSA Architecture Compliance User Guide Creator Tool : AH XSL Formatter V6.4 MR2 for Linux64 : 6.4.4.28196 (2017/03/15 08:49JST) Metadata Date : 2019:04:08 11:30:23+05:30 Producer : Antenna House PDF Output Library 6.4.993 (Linux64) Trapped : False Document ID : uuid:9f2f1d2e-d93e-4f72-99c5-1fa197c47289 Instance ID : uuid:984773cc-5f20-468d-a4ea-9768eba73182 Page Mode : UseOutlines Page Count : 20EXIF Metadata provided by EXIF.tools