EmbeddedPkg: import Lan91x Ethernet controller driver
[mirror_edk2.git] / EmbeddedPkg / Drivers / FdtPlatformDxe / FdtPlatformDxe.uni
CommitLineData
e1ab367a
JJ
1// *++\r
2//\r
3// Copyright (c) 2014, ARM Ltd. All rights reserved.<BR>\r
4//\r
5// This program and the accompanying materials are licensed and made available\r
6// under the terms and conditions of the BSD License which accompanies this\r
7// distribution. The full text of the license may be found at\r
8// http://opensource.org/licenses/bsd-license.php\r
9//\r
10// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12//\r
13//\r
14// Module Name:\r
15//\r
16// FdtPlatformDxe\r
17//\r
18// Abstract:\r
19//\r
20// String definitions for the EFI Shell 'setfdt' command\r
21//\r
22// Revision History:\r
23//\r
24// --*/\r
25\r
26/=#\r
27\r
28#langdef en-US "English"\r
29\r
30#string STR_SETFDT_INSTALLING #language en-US "Installing the FDT ...\r\n"\r
31#string STR_SETFDT_INSTALL_SUCCEEDED #language en-US "Installation of\r\n'%s'\r\ncompleted.\r\n"\r
32\r
33#string STR_SETFDT_UPDATING #language en-US "Updating the FDT device path ...\r\n"\r
34#string STR_SETFDT_UPDATE_SUCCEEDED #language en-US "Update of the FDT device path '%s' completed.\r\n"\r
35#string STR_SETFDT_UPDATE_DELETED #language en-US "The UEFI variable "Fdt" was deleted.\r\n"\r
36\r
37#string STR_SETFDT_INVALID_DEVICE_PATH #language en-US "Invalid device path.\r\n"\r
38#string STR_SETFDT_INVALID_PATH #language en-US "The EFI Shell or device file path '%s' is invalid.\r\n"\r
39#string STR_SETFDT_ERROR #language en-US "Error - %r.\r\n"\r
40#string STR_SETFDT_DEVICE_PATH_LIST #language en-US "FDT device paths :\r\n"\r
41#string STR_SETFDT_DEVICE_PATH #language en-US "'%s'\r\n"\r
42\r
43#string STR_GET_HELP_SETFDT #language en-US ""\r
44".TH setfdt 0 "Define and/or install a new Flat Device Tree (FDT) for the platform."\r\n"\r
45".SH NAME\r\n"\r
46"Define and/or re-install a Flat Device Tree (FDT)\r\n"\r
47".SH SYNOPSIS\r\n"\r
48"setfdt [-i] [fdt_path]\r\n"\r
49".SH OPTIONS\r\n"\r
50"-i run the FDT installation process\r\n"\r
51"file_path EFI Shell file path or device path to a FDT\r\n"\r
52"\r\n"\r
53".SH DESCRIPTION\r\n"\r
54"NOTES:\r\n"\r
55"1. If a valid EFI Shell file path is passed to the command, then the\r\n"\r
56" command translates the EFI Shell file path into a device path in the\r\n"\r
57" text form and saves it in the non volatile UEFI variable "Fdt". If\r\n"\r
58" the path to the FDT is a device path in the text form, it is saved as\r\n"\r
59" it is in the non volatile UEFI variable "Fdt". The next time the FDT\r\n"\r
60" installation process is run, it will first try to install the FDT from\r\n"\r
61" the device path specified by the UEFI variable "Fdt".\r\n"\r
62" \r\n\r
63"2. If the option -i is passed to the command, then the FDT installation\r\n"\r
64" process is run. If a path to the FDT is passed to the command as well,\r\n"\r
65" the update of the "Fdt" UEFI variable is done first before to launch\r\n"\r
66" the FDT installation process.\r\n"\r
67" \r\n\r
68".SH RETURNVALUES\r\n"\r
69"SHELL_SUCCESS Operation(s) completed.\r\n"\r
70"SHELL_ABORTED Operation aborted.\r\n"\r
71"SHELL_INVALID_PARAMETER Invalid argument(s).\r\n"\r
72"SHELL_NOT_FOUND Failed to locate a protocol or a file.\r\n"\r
73"SHELL_UNSUPPORTED Device path not supported.\r\n"\r
74"SHELL_OUT_OF_RESOURCES A memory allocation failed.\r\n"\r
75"SHELL_DEVICE ERROR Hardware failure.\r\n"\r
76"SHELL_ACCESS_DENIED Access to the Fdt UEFI variable for modification denied.\r\n"\r
77".SH EXAMPLES\r\n"\r
78"EXAMPLES:\r\n"\r
79"1. Relaunch the FDT installation process :\r\n"\r
80" Shell> setfdt -i\r\n"\r
81" \r\n"\r
82"2. Set the EFI Shell file path 'fs0:\>fdt.dtb' to be the default path\r\n"\r
83" to the FDT :\r\n"\r
84" Shell> setfdt fs0:fdt.dtb\r\n"\r
85" \r\n"\r
86"3. Set a TFTP device path to be the default path to the FDT :\r\n"\r
87" Shell> setfdt MAC(0002f700570b,0x1)/IPv4(192.168.1.1)/fdt.dtb\r\n"\r
88" where . 00:02:f7:00:57:0b is the MAC address of the network\r\n"\r
89" interface card to be used. The 'ifconfig -l' EFI Shell\r\n"\r
90" command allows to get the MAC address of the network\r\n"\r
91" interface cards.\r\n"\r
92" . 192.168.1.1 is the address of the TFTP server.\r\n"\r
93" . fdt.dtb is the file path to the FDT file on the server.\r\n"\r
94"4. Display the FDT device paths from the highest to the lowest\r\n"\r
95" priority :\r\n"\r
96" Shell> setfdt\r\n"\r
97"5. Delete the "Fdt" UEFI variable :\r\n"\r
98" Shell> setfdt ""\r\n"\r
99"\r\n"\r
100\r
101#string STR_GET_HELP_DUMPFDT #language en-US ""\r
102".TH dumpfdt 0 "Dump installed Flat Device Tree (FDT) of the platform."\r\n"\r
103".SH NAME\r\n"\r
104"Dump current Flat Device Tree (FDT)\r\n"\r
105".SH SYNOPSIS\r\n"\r
106"dumpfdt\r\n"\r
107"\r\n"\r
108".SH DESCRIPTION\r\n"\r
109"\r\n"\r