| 94b17fa1 |
1 | /** @file\r |
| 941b3569 |
2 | EFI Shell protocol as defined in the UEFI Shell 2.0 specification including errata.\r |
| 94b17fa1 |
3 | \r |
| 4 | Copyright (c) 2006 - 2009, Intel Corporation \r |
| 5 | All rights reserved. This program and the accompanying materials \r |
| 6 | are licensed and made available under the terms and conditions of the BSD License \r |
| 7 | which accompanies this 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 | \r |
| 15 | #ifndef __EFI_SHELL_PROTOCOL__\r |
| 16 | #define __EFI_SHELL_PROTOCOL__\r |
| 17 | \r |
| 18 | #include <Protocol/SimpleFileSystem.h>\r |
| 19 | #include <Guid/FileInfo.h>\r |
| 20 | \r |
| 21 | #define EFI_SHELL_PROTOCOL_GUID \\r |
| 22 | { \\r |
| 23 | 0x6302d008, 0x7f9b, 0x4f30, { 0x87, 0xac, 0x60, 0xc9, 0xfe, 0xf5, 0xda, 0x4e } \\r |
| 24 | }\r |
| 25 | \r |
| d2b4564b |
26 | // replaced EFI_LIST_ENTRY with LIST_ENTRY for simplicity.\r |
| 27 | // they are identical outside of the name.\r |
| 94b17fa1 |
28 | typedef struct {\r |
| a31bd33c |
29 | LIST_ENTRY Link; ///< Linked list members.\r |
| 30 | EFI_STATUS Status; ///< Status of opening the file. Valid only if Handle != NULL.\r |
| 31 | CONST CHAR16 *FullName; ///< Fully qualified filename.\r |
| 32 | CONST CHAR16 *FileName; ///< name of this file.\r |
| 33 | EFI_FILE_HANDLE Handle; ///< Handle for interacting with the opened file or NULL if closed.\r |
| 34 | EFI_FILE_INFO *Info; ///< Pointer to the FileInfo struct for this file or NULL.\r |
| 94b17fa1 |
35 | } EFI_SHELL_FILE_INFO;\r |
| a31bd33c |
36 | \r |
| 94b17fa1 |
37 | /**\r |
| 38 | Returns whether any script files are currently being processed.\r |
| 39 | \r |
| 40 | @retval TRUE There is at least one script file active.\r |
| 41 | @retval FALSE No script files are active now.\r |
| 42 | \r |
| 43 | **/\r |
| 44 | typedef\r |
| 45 | BOOLEAN\r |
| 46 | (EFIAPI *EFI_SHELL_BATCH_IS_ACTIVE) (\r |
| 47 | VOID\r |
| 48 | );\r |
| 49 | \r |
| 50 | /**\r |
| 51 | Closes the file handle.\r |
| 52 | \r |
| 53 | This function closes a specified file handle. All 'dirty' cached file data is \r |
| 54 | flushed to the device, and the file is closed. In all cases, the handle is \r |
| 55 | closed.\r |
| 56 | \r |
| a31bd33c |
57 | @param[in] FileHandle The file handle to be closed\r |
| 94b17fa1 |
58 | \r |
| a31bd33c |
59 | @retval EFI_SUCCESS The file closed sucessfully.\r |
| 94b17fa1 |
60 | **/\r |
| 61 | typedef\r |
| 62 | EFI_STATUS\r |
| 63 | (EFIAPI *EFI_SHELL_CLOSE_FILE)(\r |
| 64 | IN EFI_FILE_HANDLE FileHandle\r |
| 65 | );\r |
| 66 | \r |
| 67 | /**\r |
| 68 | Creates a file or directory by name.\r |
| 69 | \r |
| 70 | This function creates an empty new file or directory with the specified attributes and\r |
| 71 | returns the new file's handle. If the file already exists and is read-only, then\r |
| 72 | EFI_INVALID_PARAMETER will be returned.\r |
| 73 | \r |
| 74 | If the file already existed, it is truncated and its attributes updated. If the file is\r |
| 75 | created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.\r |
| 76 | \r |
| 77 | If the file name begins with >v, then the file handle which is returned refers to the\r |
| 78 | shell environment variable with the specified name. If the shell environment variable\r |
| 79 | already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.\r |
| 80 | \r |
| a31bd33c |
81 | @param[in] FileName Pointer to null-terminated file path.\r |
| 82 | @param[in] FileAttribs The new file's attrbiutes. the different attributes are\r |
| 83 | described in EFI_FILE_PROTOCOL.Open().\r |
| 84 | @param[out] FileHandle On return, points to the created file handle or directory's handle\r |
| 94b17fa1 |
85 | \r |
| a31bd33c |
86 | @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.\r |
| 94b17fa1 |
87 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r |
| a31bd33c |
88 | @retval EFI_UNSUPPORTED could not open the file path\r |
| 89 | @retval EFI_NOT_FOUND The specified file could not be found on the device, or could not\r |
| 90 | file the file system on the device.\r |
| 91 | @retval EFI_NO_MEDIA The device has no medium.\r |
| 92 | @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no\r |
| 93 | longer supported.\r |
| 94 | @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according\r |
| 95 | the DirName.\r |
| 96 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r |
| 97 | @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write\r |
| 98 | when the media is write-protected.\r |
| 99 | @retval EFI_ACCESS_DENIED The service denied access to the file.\r |
| 100 | @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.\r |
| 101 | @retval EFI_VOLUME_FULL The volume is full.\r |
| 94b17fa1 |
102 | **/\r |
| 103 | typedef\r |
| 104 | EFI_STATUS\r |
| 105 | (EFIAPI *EFI_SHELL_CREATE_FILE)(\r |
| 106 | IN CONST CHAR16 *FileName,\r |
| 107 | IN UINT64 FileAttribs,\r |
| 108 | OUT EFI_FILE_HANDLE *FileHandle\r |
| 109 | );\r |
| 110 | \r |
| 111 | /**\r |
| 112 | Deletes the file specified by the file handle.\r |
| 113 | \r |
| 114 | This function closes and deletes a file. In all cases, the file handle is closed. If the file\r |
| 115 | cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is returned, but the\r |
| 116 | handle is still closed.\r |
| 117 | \r |
| 941b3569 |
118 | @param[in] FileHandle The file handle to delete.\r |
| 94b17fa1 |
119 | \r |
| a31bd33c |
120 | @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.\r |
| 94b17fa1 |
121 | @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.\r |
| 122 | **/\r |
| 123 | typedef\r |
| 124 | EFI_STATUS\r |
| 125 | (EFIAPI *EFI_SHELL_DELETE_FILE)(\r |
| 126 | IN EFI_FILE_HANDLE FileHandle\r |
| 127 | );\r |
| 128 | \r |
| 129 | /**\r |
| 130 | Deletes the file specified by the file name.\r |
| 131 | \r |
| 132 | This function deletes a file.\r |
| 133 | \r |
| 941b3569 |
134 | @param[in] FileName Points to the null-terminated file name.\r |
| 94b17fa1 |
135 | \r |
| 941b3569 |
136 | @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.\r |
| 94b17fa1 |
137 | @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.\r |
| 138 | **/\r |
| 139 | typedef\r |
| 140 | EFI_STATUS\r |
| 141 | (EFIAPI *EFI_SHELL_DELETE_FILE_BY_NAME)(\r |
| 142 | IN CONST CHAR16 *FileName\r |
| 143 | );\r |
| 144 | \r |
| 145 | /**\r |
| 146 | Disables the page break output mode.\r |
| 147 | **/\r |
| 148 | typedef\r |
| 149 | VOID\r |
| 150 | (EFIAPI *EFI_SHELL_DISABLE_PAGE_BREAK) (\r |
| 151 | VOID\r |
| 152 | );\r |
| 153 | \r |
| 154 | /**\r |
| 155 | Enables the page break output mode.\r |
| 156 | **/\r |
| 157 | typedef\r |
| 158 | VOID\r |
| 159 | (EFIAPI *EFI_SHELL_ENABLE_PAGE_BREAK) (\r |
| 160 | VOID\r |
| 161 | );\r |
| 162 | \r |
| 163 | /**\r |
| 164 | Execute the command line.\r |
| 165 | \r |
| 166 | This function creates a nested instance of the shell and executes the specified\r |
| 167 | command (CommandLine) with the specified environment (Environment). Upon return,\r |
| 168 | the status code returned by the specified command is placed in StatusCode.\r |
| 169 | \r |
| 170 | If Environment is NULL, then the current environment is used and all changes made\r |
| 171 | by the commands executed will be reflected in the current environment. If the\r |
| 172 | Environment is non-NULL, then the changes made will be discarded.\r |
| 173 | \r |
| 174 | The CommandLine is executed from the current working directory on the current\r |
| 175 | device.\r |
| 176 | \r |
| 941b3569 |
177 | @param[in] ParentImageHandle A handle of the image that is executing the specified \r |
| 178 | command line. \r |
| 179 | @param[in] CommandLine Points to the null-terminated UCS-2 encoded string \r |
| 180 | containing the command line. If NULL then the command-\r |
| 181 | line will be empty.\r |
| 182 | @param[in] Environment Points to a null-terminated array of environment \r |
| 183 | variables with the format 'x=y', where x is the \r |
| 184 | environment variable name and y is the value. If this\r |
| 185 | is NULL, then the current shell environment is used.\r |
| 186 | @param[out] ErrorCode Points to the status code returned by the command.\r |
| 187 | \r |
| 188 | @retval EFI_SUCCESS The command executed successfully. The status code \r |
| 189 | returned by the command is pointed to by StatusCode.\r |
| 94b17fa1 |
190 | @retval EFI_INVALID_PARAMETER The parameters are invalid.\r |
| 941b3569 |
191 | @retval EFI_OUT_OF_RESOURCES Out of resources.\r |
| 192 | @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.\r |
| 94b17fa1 |
193 | **/\r |
| 194 | typedef\r |
| 195 | EFI_STATUS\r |
| 196 | (EFIAPI *EFI_SHELL_EXECUTE) (\r |
| 197 | IN EFI_HANDLE *ParentImageHandle,\r |
| 198 | IN CHAR16 *CommandLine OPTIONAL,\r |
| 199 | IN CHAR16 **Environment OPTIONAL,\r |
| 200 | OUT EFI_STATUS *StatusCode OPTIONAL\r |
| 201 | );\r |
| 202 | \r |
| 203 | /**\r |
| 204 | Find files that match a specified pattern.\r |
| 205 | \r |
| 206 | This function searches for all files and directories that match the specified\r |
| 207 | FilePattern. The FilePattern can contain wild-card characters. The resulting file\r |
| 208 | information is placed in the file list FileList.\r |
| 209 | \r |
| 210 | The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo\r |
| 211 | field is set to NULL.\r |
| 212 | \r |
| 941b3569 |
213 | @param[in] FilePattern Points to a null-terminated shell file path, including wildcards.\r |
| 214 | @param[out] FileList On return, points to the start of a file list containing the names \r |
| 215 | of all matching files or else points to NULL if no matching files \r |
| 216 | were found.\r |
| 94b17fa1 |
217 | \r |
| 941b3569 |
218 | @retval EFI_SUCCESS Files found.\r |
| 219 | @retval EFI_NOT_FOUND No files found.\r |
| a31bd33c |
220 | @retval EFI_NO_MEDIA The device has no media.\r |
| 221 | @retval EFI_DEVICE_ERROR The device reported an error.\r |
| 222 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r |
| 94b17fa1 |
223 | **/\r |
| 224 | typedef\r |
| 225 | EFI_STATUS\r |
| 226 | (EFIAPI *EFI_SHELL_FIND_FILES)(\r |
| 227 | IN CONST CHAR16 *FilePattern,\r |
| 228 | OUT EFI_SHELL_FILE_INFO **FileList\r |
| 229 | );\r |
| 230 | \r |
| 231 | /**\r |
| 232 | Find all files in a specified directory.\r |
| 233 | \r |
| 941b3569 |
234 | @param[in] FileDirHandle Handle of the directory to search.\r |
| 235 | @param[out] FileList On return, points to the list of files in the directory \r |
| 236 | or NULL if there are no files in the directory.\r |
| 94b17fa1 |
237 | \r |
| 941b3569 |
238 | @retval EFI_SUCCESS File information was returned successfully.\r |
| 239 | @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.\r |
| 240 | @retval EFI_DEVICE_ERROR The device reported an error.\r |
| 241 | @retval EFI_NO_MEDIA The device media is not present.\r |
| 94b17fa1 |
242 | **/\r |
| 243 | typedef\r |
| 244 | EFI_STATUS\r |
| 245 | (EFIAPI *EFI_SHELL_FIND_FILES_IN_DIR)(\r |
| 246 | IN EFI_FILE_HANDLE FileDirHandle,\r |
| 247 | OUT EFI_SHELL_FILE_INFO **FileList\r |
| 248 | );\r |
| 249 | \r |
| 250 | /**\r |
| a31bd33c |
251 | Flushes data back to a device.\r |
| 94b17fa1 |
252 | \r |
| 253 | This function flushes all modified data associated with a file to a device.\r |
| 254 | \r |
| a31bd33c |
255 | @param[in] FileHandle The handle of the file to flush\r |
| 94b17fa1 |
256 | \r |
| 257 | @retval EFI_SUCCESS The data was flushed.\r |
| 258 | @retval EFI_NO_MEDIA The device has no medium.\r |
| 259 | @retval EFI_DEVICE_ERROR The device reported an error.\r |
| 260 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r |
| 261 | @retval EFI_WRITE_PROTECTED The file or medium is write-protected.\r |
| 262 | @retval EFI_ACCESS_DENIED The file was opened read-only.\r |
| 263 | @retval EFI_VOLUME_FULL The volume is full.\r |
| 264 | **/\r |
| 265 | typedef\r |
| 266 | EFI_STATUS\r |
| 267 | (EFIAPI *EFI_SHELL_FLUSH_FILE)(\r |
| 268 | IN EFI_FILE_HANDLE FileHandle\r |
| 269 | );\r |
| 270 | \r |
| 271 | /**\r |
| 272 | Frees the file list.\r |
| 273 | \r |
| 274 | This function cleans up the file list and any related data structures. It has no\r |
| 275 | impact on the files themselves.\r |
| 276 | \r |
| a31bd33c |
277 | @param[in] FileList The file list to free. Type EFI_SHELL_FILE_INFO is \r |
| 94b17fa1 |
278 | defined in OpenFileList()\r |
| 279 | \r |
| 280 | @retval EFI_SUCCESS Free the file list successfully.\r |
| 281 | **/\r |
| 282 | typedef\r |
| 283 | EFI_STATUS\r |
| 284 | (EFIAPI *EFI_SHELL_FREE_FILE_LIST) (\r |
| 285 | IN EFI_SHELL_FILE_INFO **FileList\r |
| 286 | );\r |
| 287 | \r |
| 288 | /**\r |
| 289 | Returns the current directory on the specified device.\r |
| 290 | \r |
| 291 | If FileSystemMapping is NULL, it returns the current working directory. If the\r |
| 292 | FileSystemMapping is not NULL, it returns the current directory associated with the\r |
| 293 | FileSystemMapping. In both cases, the returned name includes the file system\r |
| 294 | mapping (i.e. fs0:\current-dir).\r |
| 295 | \r |
| a31bd33c |
296 | @param[in] FileSystemMapping A pointer to the file system mapping. If NULL, \r |
| 94b17fa1 |
297 | then the current working directory is returned.\r |
| 298 | \r |
| 299 | @retval !=NULL The current directory.\r |
| 300 | @retval NULL Current directory does not exist.\r |
| 301 | **/\r |
| 302 | typedef\r |
| 303 | CONST CHAR16 *\r |
| 304 | (EFIAPI *EFI_SHELL_GET_CUR_DIR) (\r |
| 305 | IN CONST CHAR16 *FileSystemMapping OPTIONAL\r |
| 306 | );\r |
| 307 | \r |
| 308 | typedef UINT32 EFI_SHELL_DEVICE_NAME_FLAGS;\r |
| 309 | #define EFI_DEVICE_NAME_USE_COMPONENT_NAME 0x00000001\r |
| 310 | #define EFI_DEVICE_NAME_USE_DEVICE_PATH 0x00000002\r |
| a31bd33c |
311 | \r |
| 94b17fa1 |
312 | /**\r |
| 313 | Gets the name of the device specified by the device handle.\r |
| 314 | \r |
| 315 | This function gets the user-readable name of the device specified by the device\r |
| 316 | handle. If no user-readable name could be generated, then *BestDeviceName will be\r |
| 317 | NULL and EFI_NOT_FOUND will be returned.\r |
| 318 | \r |
| d2b4564b |
319 | If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the\r |
| 69817bf8 |
320 | device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on\r |
| d2b4564b |
321 | DeviceHandle.\r |
| 322 | \r |
| 323 | If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the\r |
| 69817bf8 |
324 | device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.\r |
| d2b4564b |
325 | If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and\r |
| 326 | EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then\r |
| 327 | EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.\r |
| 328 | \r |
| 941b3569 |
329 | @param[in] DeviceHandle The handle of the device.\r |
| 330 | @param[in] Flags Determines the possible sources of component names. \r |
| 331 | @param[in] Language A pointer to the language specified for the device \r |
| 94b17fa1 |
332 | name, in the same format as described in the UEFI \r |
| a31bd33c |
333 | specification, Appendix M.\r |
| 941b3569 |
334 | @param[out] BestDeviceName On return, points to the callee-allocated null-\r |
| 94b17fa1 |
335 | terminated name of the device. If no device name \r |
| 336 | could be found, points to NULL. The name must be \r |
| 337 | freed by the caller...\r |
| 338 | \r |
| 339 | @retval EFI_SUCCESS Get the name successfully.\r |
| 340 | @retval EFI_NOT_FOUND Fail to get the device name.\r |
| 341 | **/\r |
| 342 | typedef\r |
| 343 | EFI_STATUS\r |
| 344 | (*EFI_SHELL_GET_DEVICE_NAME) (\r |
| 345 | IN EFI_HANDLE DeviceHandle,\r |
| 346 | IN EFI_SHELL_DEVICE_NAME_FLAGS Flags,\r |
| 347 | IN CHAR8 *Language,\r |
| 348 | OUT CHAR16 **BestDeviceName\r |
| 349 | );\r |
| 350 | \r |
| 351 | /**\r |
| 352 | Gets the device path from the mapping.\r |
| 353 | \r |
| 354 | This function gets the device path associated with a mapping.\r |
| 355 | \r |
| 941b3569 |
356 | @param[in] Mapping A pointer to the mapping\r |
| 94b17fa1 |
357 | \r |
| 358 | @retval !=NULL Pointer to the device path that corresponds to the \r |
| 359 | device mapping. The returned pointer does not need \r |
| 360 | to be freed.\r |
| 361 | @retval NULL There is no device path associated with the \r |
| 362 | specified mapping.\r |
| 363 | **/\r |
| 364 | typedef\r |
| 365 | CONST EFI_DEVICE_PATH_PROTOCOL *\r |
| 366 | (EFIAPI *EFI_SHELL_GET_DEVICE_PATH_FROM_MAP) (\r |
| 367 | IN CONST CHAR16 *Mapping\r |
| 368 | );\r |
| 369 | \r |
| 370 | /**\r |
| 371 | Converts a file system style name to a device path.\r |
| 372 | \r |
| 373 | This function converts a file system style name to a device path, by replacing any\r |
| 374 | mapping references to the associated device path.\r |
| 375 | \r |
| a31bd33c |
376 | @param[in] Path The pointer to the path.\r |
| 94b17fa1 |
377 | \r |
| a31bd33c |
378 | @return The pointer of the file path. The file path is callee \r |
| 94b17fa1 |
379 | allocated and should be freed by the caller.\r |
| 380 | **/\r |
| 381 | typedef\r |
| 382 | EFI_DEVICE_PATH_PROTOCOL *\r |
| 383 | (EFIAPI *EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH) (\r |
| 384 | IN CONST CHAR16 *Path\r |
| 385 | );\r |
| 386 | \r |
| 387 | /**\r |
| 941b3569 |
388 | This function updated with errata.\r |
| 389 | \r |
| 390 | Gets either a single or list of environment variables.\r |
| 391 | \r |
| 392 | If name is not NULL then this function returns the current value of the specified \r |
| 393 | environment variable.\r |
| 94b17fa1 |
394 | \r |
| 941b3569 |
395 | If Name is NULL than a list of all environment variable names is returned. Each a \r |
| 396 | NULL terminated string with a double NULL terminating the list.\r |
| 94b17fa1 |
397 | \r |
| a31bd33c |
398 | @param[in] Name A pointer to the environment variable name. If \r |
| 941b3569 |
399 | Name is NULL, then the function will return all \r |
| 400 | of the defined shell environment variables. In \r |
| 401 | the case where multiple environment variables are \r |
| 402 | being returned, each variable will be terminated by \r |
| 403 | a NULL, and the list will be terminated by a double \r |
| 404 | NULL.\r |
| 94b17fa1 |
405 | \r |
| 941b3569 |
406 | @return !=NULL A pointer to the returned string.\r |
| 407 | The returned pointer does not need to be freed by the caller.\r |
| 408 | \r |
| 409 | @retval NULL The environment variable doesn't exist or there are \r |
| 410 | no environment variables.\r |
| 94b17fa1 |
411 | **/\r |
| 412 | typedef\r |
| 413 | CONST CHAR16 *\r |
| 414 | (EFIAPI *EFI_SHELL_GET_ENV) (\r |
| 941b3569 |
415 | IN CONST CHAR16 *Name OPTIONAL\r |
| 94b17fa1 |
416 | );\r |
| 417 | \r |
| 418 | /**\r |
| 419 | Gets the file information from an open file handle.\r |
| 420 | \r |
| 421 | This function allocates a buffer to store the file's information. It's the caller's\r |
| 422 | responsibility to free the buffer.\r |
| 423 | \r |
| a31bd33c |
424 | @param[in] FileHandle A File Handle.\r |
| 94b17fa1 |
425 | \r |
| 426 | @return !=NULL Cannot get the file info.\r |
| 427 | @return NULL A pointer to a buffer with file information.\r |
| 428 | **/\r |
| 429 | typedef\r |
| 430 | EFI_FILE_INFO *\r |
| 431 | (EFIAPI *EFI_SHELL_GET_FILE_INFO)(\r |
| 432 | IN EFI_FILE_HANDLE FileHandle\r |
| 433 | );\r |
| 434 | \r |
| 435 | /**\r |
| 436 | Converts a device path to a file system-style path.\r |
| 437 | \r |
| 438 | This function converts a device path to a file system path by replacing part, or all, of\r |
| 439 | the device path with the file-system mapping. If there are more than one application\r |
| 440 | file system mappings, the one that most closely matches Path will be used.\r |
| 441 | \r |
| a31bd33c |
442 | @param[in] Path The pointer to the device path\r |
| 94b17fa1 |
443 | \r |
| 444 | @return all The pointer of the null-terminated file path. The path \r |
| 445 | is callee-allocated and should be freed by the caller.\r |
| 446 | **/\r |
| 447 | typedef\r |
| 448 | CHAR16 *\r |
| 449 | (EFIAPI *EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH) (\r |
| 450 | IN CONST EFI_DEVICE_PATH_PROTOCOL *Path\r |
| 451 | );\r |
| 452 | \r |
| 453 | /**\r |
| a31bd33c |
454 | Gets a file's current position.\r |
| 94b17fa1 |
455 | \r |
| 456 | This function returns the current file position for the file handle. For directories, the\r |
| 457 | current file position has no meaning outside of the file system driver and as such, the\r |
| 458 | operation is not supported.\r |
| 459 | \r |
| 941b3569 |
460 | @param[in] FileHandle The file handle on which to get the current position.\r |
| a31bd33c |
461 | @paramp[out] Position Byte position from the start of the file.\r |
| 94b17fa1 |
462 | \r |
| 463 | @retval EFI_SUCCESS Data was accessed.\r |
| 464 | @retval EFI_UNSUPPORTED The request is not valid on open directories.\r |
| 465 | **/\r |
| 466 | typedef\r |
| 467 | EFI_STATUS\r |
| 468 | (EFIAPI *EFI_SHELL_GET_FILE_POSITION)(\r |
| 469 | IN EFI_FILE_HANDLE FileHandle,\r |
| 470 | OUT UINT64 *Position\r |
| 471 | );\r |
| 472 | \r |
| 473 | /**\r |
| 474 | Gets the size of a file.\r |
| 475 | \r |
| 476 | This function returns the size of the file specified by FileHandle.\r |
| 477 | \r |
| 941b3569 |
478 | @param[in] FileHandle The handle of the file.\r |
| 479 | @param[out] Size The size of this file.\r |
| 94b17fa1 |
480 | \r |
| 481 | @retval EFI_SUCCESS Get the file's size.\r |
| 482 | @retval EFI_DEVICE_ERROR Can't access the file.\r |
| 483 | **/\r |
| 484 | typedef\r |
| 485 | EFI_STATUS\r |
| 486 | (EFIAPI *EFI_SHELL_GET_FILE_SIZE)(\r |
| 487 | IN EFI_FILE_HANDLE FileHandle,\r |
| 488 | OUT UINT64 *Size\r |
| 489 | );\r |
| 490 | \r |
| 491 | /**\r |
| 492 | Return help information about a specific command.\r |
| 493 | \r |
| 494 | This function returns the help information for the specified command. The help text\r |
| 495 | can be internal to the shell or can be from a UEFI Shell manual page.\r |
| 496 | \r |
| 497 | If Sections is specified, then each section name listed will be compared in a casesensitive\r |
| 498 | manner, to the section names described in Appendix B. If the section exists,\r |
| 499 | it will be appended to the returned help text. If the section does not exist, no\r |
| 500 | information will be returned. If Sections is NULL, then all help text information\r |
| 501 | available will be returned.\r |
| 502 | \r |
| 941b3569 |
503 | @param[in] Command Points to the null-terminated UEFI Shell command name.\r |
| 504 | @param[in] Sections Points to the null-terminated comma-delimited \r |
| 94b17fa1 |
505 | section names to return. If NULL, then all \r |
| 506 | sections will be returned.\r |
| 941b3569 |
507 | @param[out] HelpText On return, points to a callee-allocated buffer \r |
| 94b17fa1 |
508 | containing all specified help text.\r |
| 509 | \r |
| 510 | @retval EFI_SUCCESS The help text was returned.\r |
| 511 | @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the \r |
| 512 | returned help text.\r |
| a31bd33c |
513 | @retval EFI_INVALID_PARAMETER HelpText is NULL.\r |
| 94b17fa1 |
514 | @retval EFI_NOT_FOUND There is no help text available for Command.\r |
| 515 | **/\r |
| 516 | typedef\r |
| 517 | EFI_STATUS\r |
| 518 | (EFIAPI *EFI_SHELL_GET_HELP_TEXT) (\r |
| 519 | IN CONST CHAR16 *Command,\r |
| b1f95a06 |
520 | IN CONST CHAR16 *Sections OPTIONAL,\r |
| 94b17fa1 |
521 | OUT CHAR16 **HelpText\r |
| 522 | );\r |
| 523 | \r |
| 524 | /**\r |
| 941b3569 |
525 | This funciton is updated with Errata.\r |
| 526 | \r |
| 527 | Gets the mapping(s) that most closely matches the device path.\r |
| 94b17fa1 |
528 | \r |
| 529 | This function gets the mapping which corresponds to the device path *DevicePath. If\r |
| 530 | there is no exact match, then the mapping which most closely matches *DevicePath\r |
| 531 | is returned, and *DevicePath is updated to point to the remaining portion of the\r |
| 532 | device path. If there is an exact match, the mapping is returned and *DevicePath\r |
| 533 | points to the end-of-device-path node.\r |
| 534 | \r |
| 941b3569 |
535 | If there are multiple map names they will be semi-colon seperated in the \r |
| 536 | NULL-terminated string.\r |
| 537 | \r |
| 538 | @param[in,out] DevicePath On entry, points to a device path pointer. On \r |
| 94b17fa1 |
539 | exit, updates the pointer to point to the \r |
| 540 | portion of the device path after the mapping.\r |
| 541 | \r |
| 542 | @retval NULL No mapping was found.\r |
| a31bd33c |
543 | @retval !=NULL Pointer to null-terminated mapping. The buffer \r |
| 94b17fa1 |
544 | is callee allocated and should be freed by the caller.\r |
| 545 | **/\r |
| 546 | typedef\r |
| 547 | CONST CHAR16 *\r |
| 548 | (EFIAPI *EFI_SHELL_GET_MAP_FROM_DEVICE_PATH) (\r |
| 549 | IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath\r |
| 550 | );\r |
| 551 | \r |
| 552 | /**\r |
| 553 | Gets the enable status of the page break output mode.\r |
| 554 | \r |
| 555 | User can use this function to determine current page break mode.\r |
| 556 | \r |
| a31bd33c |
557 | @retval TRUE The page break output mode is enabled.\r |
| 558 | @retval FALSE The page break output mode is disabled.\r |
| 94b17fa1 |
559 | **/\r |
| 560 | typedef\r |
| 561 | BOOLEAN\r |
| 562 | (EFIAPI *EFI_SHELL_GET_PAGE_BREAK) (\r |
| 563 | VOID\r |
| 564 | );\r |
| 565 | \r |
| 566 | /**\r |
| 567 | Judges whether the active shell is the root shell.\r |
| 568 | \r |
| 569 | This function makes the user to know that whether the active Shell is the root shell.\r |
| 570 | \r |
| 571 | @retval TRUE The active Shell is the root Shell.\r |
| 572 | @retval FALSE The active Shell is NOT the root Shell.\r |
| 573 | **/\r |
| 574 | typedef\r |
| 575 | BOOLEAN\r |
| 576 | (EFIAPI *EFI_SHELL_IS_ROOT_SHELL) (\r |
| 577 | VOID\r |
| 578 | );\r |
| 579 | \r |
| 580 | /**\r |
| 581 | Opens a file or a directory by file name.\r |
| 582 | \r |
| 583 | This function opens the specified file in the specified OpenMode and returns a file\r |
| 584 | handle.\r |
| 585 | If the file name begins with >v, then the file handle which is returned refers to the\r |
| 586 | shell environment variable with the specified name. If the shell environment variable\r |
| 587 | exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then\r |
| 588 | EFI_INVALID_PARAMETER is returned.\r |
| 589 | \r |
| 590 | If the file name is >i, then the file handle which is returned refers to the standard\r |
| 591 | input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER\r |
| 592 | is returned.\r |
| 593 | \r |
| 594 | If the file name is >o, then the file handle which is returned refers to the standard\r |
| 595 | output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER\r |
| 596 | is returned.\r |
| 597 | \r |
| 598 | If the file name is >e, then the file handle which is returned refers to the standard\r |
| 599 | error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER\r |
| 600 | is returned.\r |
| 601 | \r |
| 602 | If the file name is NUL, then the file handle that is returned refers to the standard NUL\r |
| 603 | file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is\r |
| 604 | returned.\r |
| 605 | \r |
| 606 | If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the\r |
| 607 | FileHandle is NULL.\r |
| 608 | \r |
| 941b3569 |
609 | @param[in] FileName Points to the null-terminated UCS-2 encoded file name.\r |
| 610 | @param[out] FileHandle On return, points to the file handle.\r |
| 611 | @param[in] OpenMode File open mode. Either EFI_FILE_MODE_READ or \r |
| 94b17fa1 |
612 | EFI_FILE_MODE_WRITE from section 12.4 of the UEFI \r |
| 613 | Specification.\r |
| 614 | @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.\r |
| 615 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.\r |
| 616 | @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.\r |
| 617 | @retval EFI_NOT_FOUND The specified file could not be found on the device or the file\r |
| 618 | system could not be found on the device. FileHandle is NULL.\r |
| 619 | @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.\r |
| 620 | @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no\r |
| 621 | longer supported. FileHandle is NULL.\r |
| 622 | @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according\r |
| 623 | the FileName. FileHandle is NULL.\r |
| 624 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.\r |
| 625 | @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write\r |
| 626 | when the media is write-protected. FileHandle is NULL.\r |
| 627 | @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.\r |
| 628 | @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle\r |
| 629 | is NULL.\r |
| 630 | @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.\r |
| 631 | **/\r |
| 632 | typedef\r |
| 633 | EFI_STATUS\r |
| 634 | (EFIAPI *EFI_SHELL_OPEN_FILE_BY_NAME) (\r |
| 635 | IN CONST CHAR16 *FileName,\r |
| 636 | OUT EFI_FILE_HANDLE *FileHandle,\r |
| 637 | IN UINT64 OpenMode\r |
| 638 | );\r |
| 639 | \r |
| 640 | /**\r |
| 641 | Opens the files that match the path specified.\r |
| 642 | \r |
| 643 | This function opens all of the files specified by Path. Wildcards are processed\r |
| 644 | according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each \r |
| 645 | matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.\r |
| 646 | \r |
| 941b3569 |
647 | @param[in] Path A pointer to the path string.\r |
| 648 | @param[in] OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or\r |
| 94b17fa1 |
649 | EFI_FILE_MODE_WRITE.\r |
| 941b3569 |
650 | @param[in,out] FileList Points to the start of a list of files opened.\r |
| 94b17fa1 |
651 | \r |
| 652 | @retval EFI_SUCCESS Create the file list successfully.\r |
| a31bd33c |
653 | @return Can't create the file list.\r |
| 94b17fa1 |
654 | **/\r |
| 655 | typedef\r |
| 656 | EFI_STATUS\r |
| 657 | (EFIAPI *EFI_SHELL_OPEN_FILE_LIST) (\r |
| 658 | IN CHAR16 *Path,\r |
| 659 | IN UINT64 OpenMode,\r |
| 660 | IN OUT EFI_SHELL_FILE_INFO **FileList\r |
| 661 | );\r |
| 662 | \r |
| 663 | /**\r |
| 664 | Opens the root directory of a device.\r |
| 665 | \r |
| 666 | This function opens the root directory of a device and returns a file handle to it.\r |
| 667 | \r |
| 941b3569 |
668 | @param[in] DevicePath Points to the device path corresponding to the device where the\r |
| 94b17fa1 |
669 | EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.\r |
| 941b3569 |
670 | @param[out] FileHandle On exit, points to the file handle corresponding to the root directory on the\r |
| 94b17fa1 |
671 | device.\r |
| 672 | \r |
| 673 | @retval EFI_SUCCESS Root opened successfully.\r |
| 674 | @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory\r |
| 675 | could not be opened.\r |
| 676 | @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.\r |
| a31bd33c |
677 | @retval EFI_DEVICE_ERROR The device had an error.\r |
| 94b17fa1 |
678 | **/\r |
| 679 | typedef\r |
| 680 | EFI_STATUS\r |
| 681 | (EFIAPI *EFI_SHELL_OPEN_ROOT)(\r |
| 682 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r |
| 683 | OUT EFI_FILE_HANDLE *FileHandle\r |
| 684 | );\r |
| 685 | \r |
| 686 | /**\r |
| a31bd33c |
687 | Opens the root directory of a device on a handle.\r |
| 94b17fa1 |
688 | \r |
| 689 | This function opens the root directory of a device and returns a file handle to it.\r |
| 690 | \r |
| 941b3569 |
691 | @param[in] DeviceHandle The handle of the device that contains the volume.\r |
| 692 | @param[out] FileHandle On exit, points to the file handle corresponding to the root directory on the\r |
| 94b17fa1 |
693 | device.\r |
| 694 | \r |
| 695 | @retval EFI_SUCCESS Root opened successfully.\r |
| 696 | @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory\r |
| 697 | could not be opened.\r |
| 698 | @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.\r |
| a31bd33c |
699 | @retval EFI_DEVICE_ERROR The device had an error.\r |
| 94b17fa1 |
700 | **/\r |
| 701 | typedef\r |
| 702 | EFI_STATUS\r |
| 703 | (EFIAPI *EFI_SHELL_OPEN_ROOT_BY_HANDLE)(\r |
| 704 | IN EFI_HANDLE DeviceHandle,\r |
| 705 | OUT EFI_FILE_HANDLE *FileHandle\r |
| 706 | );\r |
| 707 | \r |
| 708 | /**\r |
| 709 | Reads data from the file.\r |
| 710 | \r |
| 711 | If FileHandle is not a directory, the function reads the requested number of bytes\r |
| 712 | from the file at the file's current position and returns them in Buffer. If the read goes\r |
| 713 | beyond the end of the file, the read length is truncated to the end of the file. The file's\r |
| 714 | current position is increased by the number of bytes returned.\r |
| 715 | If FileHandle is a directory, then an error is returned.\r |
| 716 | \r |
| a31bd33c |
717 | @param[in] FileHandle The opened file handle for read.\r |
| 941b3569 |
718 | @param[in] ReadSize On input, the size of Buffer, in bytes. On output, the amount of data read.\r |
| 719 | @param[in,out] Buffer The buffer in which data is read.\r |
| 94b17fa1 |
720 | \r |
| 721 | @retval EFI_SUCCESS Data was read.\r |
| a31bd33c |
722 | @retval EFI_NO_MEDIA The device has no media.\r |
| 723 | @retval EFI_DEVICE_ERROR The device reported an error.\r |
| 724 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r |
| 725 | @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required size.\r |
| 94b17fa1 |
726 | **/\r |
| 727 | typedef\r |
| 728 | EFI_STATUS\r |
| 729 | (EFIAPI *EFI_SHELL_READ_FILE) (\r |
| 730 | IN EFI_FILE_HANDLE FileHandle,\r |
| 731 | IN OUT UINTN *ReadSize,\r |
| 941b3569 |
732 | IN OUT VOID *Buffer\r |
| 94b17fa1 |
733 | );\r |
| 734 | \r |
| 735 | /**\r |
| 736 | Deletes the duplicate file names files in the given file list.\r |
| 737 | \r |
| 941b3569 |
738 | @param[in] FileList A pointer to the first entry in the file list.\r |
| 94b17fa1 |
739 | \r |
| 740 | @retval EFI_SUCCESS Always success.\r |
| 741 | **/\r |
| 742 | typedef\r |
| 743 | EFI_STATUS\r |
| 744 | (EFIAPI *EFI_SHELL_REMOVE_DUP_IN_FILE_LIST) (\r |
| 745 | IN EFI_SHELL_FILE_INFO **FileList\r |
| 746 | );\r |
| 747 | \r |
| 941b3569 |
748 | //\r |
| 749 | // The SetAlias and GetAlias functions were affected by errata. \r |
| 750 | // They are not UEFI Shell 2.0 (no errata) compliant.\r |
| 751 | //\r |
| 752 | \r |
| 94b17fa1 |
753 | /**\r |
| 754 | Changes a shell command alias.\r |
| 755 | \r |
| 756 | This function creates an alias for a shell command.\r |
| 757 | \r |
| 941b3569 |
758 | @param[in] Command Points to the null-terminated shell command or existing alias.\r |
| 759 | @param[in] Alias Points to the null-terminated alias for the shell command. If this is NULL, and\r |
| 94b17fa1 |
760 | Command refers to an alias, that alias will be deleted.\r |
| 941b3569 |
761 | @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If\r |
| 94b17fa1 |
762 | FALSE and the alias already exists, then the existing alias is unchanged and\r |
| 763 | EFI_ACCESS_DENIED is returned.\r |
| 941b3569 |
764 | @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the \r |
| 765 | Alias being set will be stored in a non-volatile fashion.\r |
| 94b17fa1 |
766 | \r |
| 767 | @retval EFI_SUCCESS Alias created or deleted successfully.\r |
| 768 | @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to\r |
| 769 | FALSE.\r |
| 770 | **/\r |
| 771 | typedef\r |
| 772 | EFI_STATUS\r |
| 773 | (EFIAPI *EFI_SHELL_SET_ALIAS)(\r |
| 774 | IN CONST CHAR16 *Command,\r |
| 775 | IN CONST CHAR16 *Alias,\r |
| 941b3569 |
776 | IN BOOLEAN Replace,\r |
| 777 | IN BOOLEAN Volatile\r |
| 778 | );\r |
| 779 | \r |
| 780 | /**\r |
| 369d5f2e |
781 | This function returns the command associated with a alias or a list of all\r |
| 782 | alias'.\r |
| 941b3569 |
783 | \r |
| 369d5f2e |
784 | @param[in] Alias Points to the null-terminated shell alias. \r |
| 785 | If this parameter is NULL, then all \r |
| 941b3569 |
786 | aliases will be returned in ReturnedData.\r |
| a31bd33c |
787 | @param[out] Volatile Upon return of a single command if TRUE indicates\r |
| 369d5f2e |
788 | this is stored in a volatile fashion. FALSE otherwise.\r |
| 789 | @return If Alias is not NULL, it will return a pointer to \r |
| 790 | the null-terminated command for that alias. \r |
| 791 | Content-type: text/html
]>
git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Include/Protocol/EfiShell.h
500 - Internal Server Error
Malformed UTF-8 character (fatal) at (eval 6) line 1, <$fd> line 1658.
projects / mirror_edk2.git / blame