[mirror_edk2.git] / ShellPkg / Library / UefiShellLevel2CommandsLib / UefiShellLevel2CommandsLib.h

/** @file\r
  Main file for NULL named library for level 2 shell command functions.\r
\r
  these functions are:\r
  attrib,   cd,   cp,   date*,  time*,  rm,   reset,\r
  load,     ls,   map,  mkdir,  mv,     parse,  set,  timezone*\r
\r
\r
  * functions are non-interactive only\r
\r
\r
  Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _UEFI_SHELL_LEVEL2_COMMANDS_LIB_H_\r
#define _UEFI_SHELL_LEVEL2_COMMANDS_LIB_H_\r
\r
#include <Uefi.h>\r
#include <ShellBase.h>\r
\r
#include <Guid/ShellLibHiiGuid.h>\r
\r
#include <Protocol/EfiShell.h>\r
#include <Protocol/EfiShellParameters.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/LoadedImage.h>\r
#include <Protocol/UnicodeCollation.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/ShellCommandLib.h>\r
#include <Library/ShellLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/SortLib.h>\r
#include <Library/FileHandleLib.h>\r
#include <Library/PathLib.h>\r
\r
extern CONST  CHAR16                            mFileName[];\r
extern        EFI_HANDLE                        gShellLevel2HiiHandle;\r
\r
/**\r
  Function for 'attrib' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunAttrib (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'date' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunDate (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'time' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunTime (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'load' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunLoad (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'ls' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunLs (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'map' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunMap (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'reset' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunReset (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'timezone' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunTimeZone (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'set' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunSet (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'mkdir' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunMkDir (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'cd' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunCd (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'cp' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunCp (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'parse' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunParse (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'rm' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunRm (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'mv' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunMv (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  returns a fully qualified directory (contains a map drive at the begining)\r
  path from a unknown directory path.\r
\r
  If Path is already fully qualified this will return a duplicat otherwise this\r
  will use get the current directory and use that to build the fully qualified\r
  version.\r
\r
  if the return value is not NULL it must be caller freed.\r
\r
  @param[in] Path         The unknown Path Value\r
\r
  @retval NULL            A memory allocation failed\r
  @retval NULL            a fully qualified path could not be discovered.\r
  @retval other           pointer to a fuly qualified path.\r
**/\r
CHAR16*\r
EFIAPI\r
GetFullyQualifiedPath(\r
  IN CONST CHAR16* Path\r
  );\r
\r
/**\r
  Function to verify all intermediate directories in the path.\r
\r
  @param[in] Path       The pointer to the path to fix.\r
\r
  @retval EFI_SUCCESS   The operation was successful.\r
**/\r
EFI_STATUS\r
EFIAPI\r
VerifyIntermediateDirectories (\r
  IN CONST CHAR16 *Path\r
  );\r
\r
/**\r
  CaseInsensitive length limited string comparison.\r
\r
  @param[in] Source   Pointer to first string.\r
  @param[in] Target   Pointer to second string.\r
  @param[in] Count    Number of characters to compare.\r
\r
  @retval 0   The strings are the same.\r
  @return     non-zero if the strings are different.\r
**/\r
CONST CHAR16*\r
EFIAPI\r
StrniCmp(\r
  IN CONST CHAR16 *Source,\r
  IN CONST CHAR16 *Target,\r
  IN CONST UINTN  Count\r
  );\r
\r
/**\r
  Function for 'Vol' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunVol (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
#endif\r
\r
Commit	Line	Data
a405b86d	1	/** @file\r
	2	Main file for NULL named library for level 2 shell command functions.\r
	3	\r
	4	these functions are:\r
	5	attrib, cd, cp, date, time, rm, reset,\r
	6	load, ls, map, mkdir, mv, parse, set, timezone*\r
	7	\r
	8	\r
	9	* functions are non-interactive only\r
	10	\r
	11	\r
863986b3	12	Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.<BR>\r
a405b86d	13	This program and the accompanying materials\r
	14	are licensed and made available under the terms and conditions of the BSD License\r
	15	which accompanies this distribution. The full text of the license may be found at\r
	16	http://opensource.org/licenses/bsd-license.php\r
	17	\r
	18	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	19	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	20	\r
	21	**/\r
	22	\r
a1d4bfcc	23	#ifndef _UEFI_SHELL_LEVEL2_COMMANDS_LIB_H_\r
b54fd049	24	#define _UEFI_SHELL_LEVEL2_COMMANDS_LIB_H_\r
b54fd049	25	\r
a405b86d	26	#include <Uefi.h>\r
	27	#include <ShellBase.h>\r
	28	\r
bca163ff LG	29	#include <Guid/ShellLibHiiGuid.h>\r
bca163ff LG	30	\r
a405b86d	31	#include <Protocol/EfiShell.h>\r
	32	#include <Protocol/EfiShellParameters.h>\r
	33	#include <Protocol/DevicePath.h>\r
	34	#include <Protocol/LoadedImage.h>\r
	35	#include <Protocol/UnicodeCollation.h>\r
a405b86d	36	\r
	37	#include <Library/BaseLib.h>\r
	38	#include <Library/BaseMemoryLib.h>\r
	39	#include <Library/DebugLib.h>\r
	40	#include <Library/MemoryAllocationLib.h>\r
	41	#include <Library/PcdLib.h>\r
	42	#include <Library/ShellCommandLib.h>\r
	43	#include <Library/ShellLib.h>\r
	44	#include <Library/UefiLib.h>\r
	45	#include <Library/UefiRuntimeServicesTableLib.h>\r
	46	#include <Library/UefiBootServicesTableLib.h>\r
	47	#include <Library/HiiLib.h>\r
	48	#include <Library/SortLib.h>\r
	49	#include <Library/FileHandleLib.h>\r
ab94587a	50	#include <Library/PathLib.h>\r
a405b86d	51	\r
	52	extern CONST CHAR16 mFileName[];\r
	53	extern EFI_HANDLE gShellLevel2HiiHandle;\r
a405b86d	54	\r
	55	/**\r
	56	Function for 'attrib' command.\r
	57	\r
	58	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
	59	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
	60	**/\r
	61	SHELL_STATUS\r
	62	EFIAPI\r
	63	ShellCommandRunAttrib (\r
	64	IN EFI_HANDLE ImageHandle,\r
	65	IN EFI_SYSTEM_TABLE *SystemTable\r
	66	);\r
	67	\r
	68	/**\r
	69	Function for 'date' command.\r
	70	\r
	71	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
	72	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
	73	**/\r
	74	SHELL_STATUS\r
	75	EFIAPI\r
	76	ShellCommandRunDate (\r
	77	IN EFI_HANDLE ImageHandle,\r
	78	IN EFI_SYSTEM_TABLE *SystemTable\r
	79	);\r
	80	\r
	81	/**\r
	82	Function for 'time' command.\r
	83	\r
	84	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
	85	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
	86	**/\r
	87	SHELL_STATUS\r
	88	EFIAPI\r
	89	ShellCommandRunTime (\r
	90	IN EFI_HANDLE ImageHandle,\r
	91	IN EFI_SYSTEM_TABLE *SystemTable\r
	92	);\r
	93	\r
	94	/**\r
	95	Function for 'load' command.\r
	96	\r
	97	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
	98	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
	99	**/\r
	100	SHELL_STATUS\r
	101	EFIAPI\r
	102	ShellCommandRunLoad (\r
	103	IN EFI_HANDLE ImageHandle,\r
	104	IN EFI_SYSTEM_TABLE *SystemTable\r
	105	);\r
	106	\r
	107	/**\r
	108	Function for 'ls' command.\r
	109	\r
	110	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
	111	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
	112	**/\r
	113	SHELL_STATUS\r
	114	EFIAPI\r
	115	ShellCommandRunLs (\r
	116	IN EFI_HANDLE ImageHandle,\r
	117	IN EFI_SYSTEM_TABLE *SystemTable\r
118	);\r
119	\r
120	/**\r
121	Function for 'map' command.\r
122	\r
123	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
124	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
125	**/\r
126	SHELL_STATUS\r
127	EFIAPI\r
128	ShellCommandRunMap (\r
129	IN EFI_HANDLE ImageHandle,\r
130	IN EFI_SYSTEM_TABLE *SystemTable\r
131	);\r
132	\r
133	/**\r
134	Function for 'reset' command.\r
135	\r
136	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
137	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
138	**/\r
139	SHELL_STATUS\r
140	EFIAPI\r
141	ShellCommandRunReset (\r
142	IN EFI_HANDLE ImageHandle,\r
143	IN EFI_SYSTEM_TABLE *SystemTable\r
144	);\r
145	\r
146	/**\r
147	Function for 'timezone' command.\r
148	\r
149	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
150	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
151	**/\r
152	SHELL_STATUS\r
153	EFIAPI\r
154	ShellCommandRunTimeZone (\r
155	IN EFI_HANDLE ImageHandle,\r
156	IN EFI_SYSTEM_TABLE *SystemTable\r
157	);\r
158	\r
159	/**\r
160	Function for 'set' command.\r
161	\r
162	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
163	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
164	**/\r
165	SHELL_STATUS\r
166	EFIAPI\r
167	ShellCommandRunSet (\r
168	IN EFI_HANDLE ImageHandle,\r
169	IN EFI_SYSTEM_TABLE *SystemTable\r
170	);\r
171	\r
172	/**\r
173	Function for 'mkdir' command.\r
174	\r
175	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
176	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
177	**/\r
178	SHELL_STATUS\r
179	EFIAPI\r
180	ShellCommandRunMkDir (\r
181	IN EFI_HANDLE ImageHandle,\r
182	IN EFI_SYSTEM_TABLE *SystemTable\r
183	);\r
184	\r
185	/**\r
186	Function for 'cd' command.\r
187	\r
188	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
189	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
190	**/\r
191	SHELL_STATUS\r
192	EFIAPI\r
193	ShellCommandRunCd (\r
194	IN EFI_HANDLE ImageHandle,\r
195	IN EFI_SYSTEM_TABLE *SystemTable\r
196	);\r
197	\r
198	/**\r
199	Function for 'cp' command.\r
200	\r
201	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
202	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
203	**/\r
204	SHELL_STATUS\r
205	EFIAPI\r
206	ShellCommandRunCp (\r
207	IN EFI_HANDLE ImageHandle,\r
208	IN EFI_SYSTEM_TABLE *SystemTable\r
209	);\r
210	\r
211	/**\r
212	Function for 'parse' command.\r
213	\r
214	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
215	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
216	**/\r
217	SHELL_STATUS\r
218	EFIAPI\r
219	ShellCommandRunParse (\r
220	IN EFI_HANDLE ImageHandle,\r
221	IN EFI_SYSTEM_TABLE *SystemTable\r
222	);\r
223	\r
224	/**\r
225	Function for 'rm' command.\r
226	\r
227	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
228	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
229	**/\r
230	SHELL_STATUS\r
231	EFIAPI\r
232	ShellCommandRunRm (\r
233	IN EFI_HANDLE ImageHandle,\r
234	IN EFI_SYSTEM_TABLE *SystemTable\r
235	);\r
236	\r
237	/**\r
238	Function for 'mv' command.\r
239	\r
240	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
241	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
242	**/\r
243	SHELL_STATUS\r
244	EFIAPI\r
245	ShellCommandRunMv (\r
246	IN EFI_HANDLE ImageHandle,\r
247	IN EFI_SYSTEM_TABLE *SystemTable\r
248	);\r
249	\r
250	/**\r
251	returns a fully qualified directory (contains a map drive at the begining)\r
252	path from a unknown directory path.\r
253	\r
254	If Path is already fully qualified this will return a duplicat otherwise this\r
255	will use get the current directory and use that to build the fully qualified\r
256	version.\r
257	\r
258	if the return value is not NULL it must be caller freed.\r
259	\r
260	@param[in] Path The unknown Path Value\r
261	\r
262	@retval NULL A memory allocation failed\r
263	@retval NULL a fully qualified path could not be discovered.\r
264	@retval other pointer to a fuly qualified path.\r
265	**/\r
266	CHAR16*\r
267	EFIAPI\r
268	GetFullyQualifiedPath(\r
269	IN CONST CHAR16* Path\r
270	);\r
271	\r
272	/**\r
273	Function to verify all intermediate directories in the path.\r
274	\r
275	@param[in] Path The pointer to the path to fix.\r
276	\r
277	@retval EFI_SUCCESS The operation was successful.\r
278	**/\r
279	EFI_STATUS\r
280	EFIAPI\r
281	VerifyIntermediateDirectories (\r
282	IN CONST CHAR16 *Path\r
283	);\r
284	\r
285	/**\r
286	CaseInsensitive length limited string comparison.\r
287	\r
288	@param[in] Source Pointer to first string.\r
289	@param[in] Target Pointer to second string.\r
290	@param[in] Count Number of characters to compare.\r
291	\r
292	@retval 0 The strings are the same.\r
293	@return non-zero if the strings are different.\r
294	**/\r
295	CONST CHAR16*\r
296	EFIAPI\r
297	StrniCmp(\r
298	IN CONST CHAR16 *Source,\r
299	IN CONST CHAR16 *Target,\r
300	IN CONST UINTN Count\r
301	);\r
b54fd049	302	\r
	303	/**\r
	304	Function for 'Vol' command.\r
	305	\r
	306	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
	307	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
	308	**/\r
	309	SHELL_STATUS\r
	310	EFIAPI\r
	311	ShellCommandRunVol (\r
	312	IN EFI_HANDLE ImageHandle,\r
	313	IN EFI_SYSTEM_TABLE *SystemTable\r
	314	);\r
	315	\r
	316	#endif\r
	317	\r