3c1e53ce8f
The 'setfdt' EFI Shell command allows to define a new FDT as the prefered one for development purposes. It allows to trigger the run of the FDT installation process as well. Please refer to the README.txt file for more comprehensive description. Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Ronald Cron <Ronald.Cron@arm.com> Reviewed-by: Olivier Martin <olivier.martin@arm.com> git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16934 6f19259b-4bc3-4df7-8a09-765794883524
78 lines
6.5 KiB
Plaintext
78 lines
6.5 KiB
Plaintext
// *++
|
|
//
|
|
// Copyright (c) 2014, ARM Ltd. All rights reserved.<BR>
|
|
//
|
|
// This program and the accompanying materials are licensed and made available
|
|
// under the terms and conditions of the BSD License which accompanies this
|
|
// distribution. The full text of the license may be found at
|
|
// http://opensource.org/licenses/bsd-license.php
|
|
//
|
|
// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
//
|
|
//
|
|
// Module Name:
|
|
//
|
|
// FdtPlatformDxe
|
|
//
|
|
// Abstract:
|
|
//
|
|
// String definitions for the EFI Shell 'setfdt' command
|
|
//
|
|
// Revision History:
|
|
//
|
|
// --*/
|
|
|
|
/=#
|
|
|
|
#langdef en-US "English"
|
|
|
|
#string STR_SETFDT_INSTALLING #language en-US "Installing the FDT ...\n"
|
|
#string STR_SETFDT_INSTALL_SUCCEEDED #language en-US "FDT installation completed.\n"
|
|
#string STR_SETFDT_INSTALL_FAILED #language en-US "FDT installation failed : \n"
|
|
|
|
#string STR_SETFDT_UPDATING #language en-US "Updating the FDT device path ...\n"
|
|
#string STR_SETFDT_UPDATE_SUCCEEDED #language en-US "Update of the FDT device path <%s> completed.\n"
|
|
#string STR_SETFDT_UPDATE_FAILED #language en-US "The update of the FDT device path failed : \n"
|
|
|
|
#string STR_SETFDT_INVALID_DEVICE_PATH #language en-US "Invalid device path.\n"
|
|
#string STR_SETFDT_INVALID_PATH #language en-US "The EFI Shell or device file path <%s> is invalid.\n"
|
|
#string STR_SETFDT_ERROR #language en-US "Error - %r.\n"
|
|
|
|
#string STR_GET_HELP_SETFDT #language en-US ""
|
|
".TH setfdt 0 "Define and/or install a new Flat Device Tree (FDT) for the platform."\r\n"
|
|
".SH NAME\r\n"
|
|
"setfdt - Define and/or re-install a Flat Device Tree (FDT)"\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"setfdt [-i] [file_path]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"-i run the FDT installation process\r\n"
|
|
"file_path EFI Shell file path to a FDT\r\n"
|
|
"\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"NOTES:\r\n"
|
|
"1. If a valid EFI Shell file path is passed to the command, then the command\r\n"
|
|
" translates the EFI Shell device path into a device path in the text form\r\n"
|
|
" and saves it in the non volatile UEFI variable "Fdt". The next time the\r\n"
|
|
" FDT installation process is run, it will first try to install the FDT from\r\n"
|
|
" the device path specified by the UEFI variable "Fdt".\r\n"
|
|
"\r\n"
|
|
"2. If the option -i is passed to the command, then the FDT installation process\r\n"
|
|
" is run. If a valid EFI Shell path is passed to the command as well, the\r\n"
|
|
" update of the "Fdt" UEFI variable is done first before to launch the FDT\r\n"
|
|
" installation process.\r\n"
|
|
".SH RETURNVALUES\r\n"
|
|
"SHELL_SUCCESS Operation(s) completed.\r\n"
|
|
"SHELL_ABORTED Operation aborted.\r\n"
|
|
"SHELL_INVALID_PARAMETER Invalid argument(s).\r\n"
|
|
"SHELL_NOT_FOUND Failed to locate a protocol or a file.\r\n"
|
|
"SHELL_UNSUPPORTED Device path not supported.\r\n"
|
|
"SHELL_OUT_OF_RESOURCES A memory allocation failed.\r\n"
|
|
"SHELL_DEVICE ERROR Hardware failure.\r\n"
|
|
"SHELL_ACCESS_DENIED Access to the Fdt UEFI variable for modification denied.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"EXAMPLES:\r\n"
|
|
" fs0:\> setfdt -i\r\n"
|
|
" fs0:\> setfdt fdt.dtb\r\n"
|
|
" fs0:\> setfdt -i fdt.dtb\r\n"
|