/*++ @file\r
Produce Simple File System abstractions for directories on your PC using Posix APIs.\r
- The configuration of what devices to mount or emulate comes from UNIX \r
- environment variables. The variables must be visible to the Microsoft* \r
+ The configuration of what devices to mount or emulate comes from UNIX\r
+ environment variables. The variables must be visible to the Microsoft*\r
Developer Studio for them to work.\r
\r
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
}\r
\r
gBS->RestoreTPL (OldTpl);\r
- \r
+\r
return Status;\r
}\r
\r
Close and delete the file handle.\r
\r
@param This Protocol instance pointer.\r
- \r
+\r
@retval EFI_SUCCESS The file was closed and deleted.\r
@retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.\r
\r
}\r
\r
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
- \r
+\r
PrivateFile = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);\r
\r
Status = PrivateFile->Io->Delete (PrivateFile->Io);\r
if (This == NULL || BufferSize == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- \r
+\r
if ((*BufferSize != 0) && (Buffer == NULL)) {\r
// Buffer can be NULL if *BufferSize is zero\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
- \r
+\r
PrivateFile = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);\r
\r
Status = PrivateFile->Io->Read (PrivateFile->Io, BufferSize, Buffer);\r
\r
\r
/**\r
- Set a files current position\r
+ Get a file's current position\r
\r
@param This Protocol instance pointer.\r
@param Position Byte position from the start of the file.\r
- \r
+\r
@retval EFI_SUCCESS Position was updated.\r
@retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.\r
\r
}\r
\r
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
- \r
+\r
PrivateFile = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);\r
\r
Status = PrivateFile->Io->GetPosition (PrivateFile->Io, Position);\r
\r
\r
/**\r
- Get a file's current position\r
+ Set file's current position\r
\r
@param This Protocol instance pointer.\r
@param Position Byte position from the start of the file.\r
- \r
+\r
@retval EFI_SUCCESS Position was updated.\r
@retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open..\r
\r
}\r
\r
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
- \r
+\r
PrivateFile = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);\r
\r
Status = PrivateFile->Io->SetPosition (PrivateFile->Io, Position);\r
}\r
\r
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
- \r
+\r
PrivateFile = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);\r
\r
Status = PrivateFile->Io->GetInfo (PrivateFile->Io, InformationType, BufferSize, Buffer);\r
}\r
\r
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
- \r
+\r
PrivateFile = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);\r
\r
Status = PrivateFile->Io->SetInfo (PrivateFile->Io, InformationType, BufferSize, Buffer);\r
\r
- gBS->RestoreTPL (OldTpl); \r
+ gBS->RestoreTPL (OldTpl);\r
return Status;\r
}\r
\r
}\r
\r
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
- \r
+\r
PrivateFile = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);\r
\r
Status = PrivateFile->Io->Flush (PrivateFile->Io);\r
\r
PrivateFile = AllocatePool (sizeof (EMU_EFI_FILE_PRIVATE));\r
if (PrivateFile == NULL) {\r
+ Status = EFI_OUT_OF_RESOURCES;\r
goto Done;\r
}\r
- \r
+\r
PrivateFile->Signature = EMU_EFI_FILE_PRIVATE_SIGNATURE;\r
PrivateFile->IoThunk = Private->IoThunk;\r
PrivateFile->SimpleFileSystem = This;\r
if (EFI_ERROR (Status)) {\r
goto Done;\r
}\r
- \r
+\r
AddUnicodeString2 (\r
"eng",\r
gEmuSimpleFileSystemComponentName.SupportedLanguages,\r
if (PrivateFile) {\r
gBS->FreePool (PrivateFile);\r
}\r
- \r
+\r
*Root = NULL;\r
}\r
\r
}\r
\r
/**\r
- Tests to see if this driver supports a given controller. If a child device is provided, \r
+ Tests to see if this driver supports a given controller. If a child device is provided,\r
it further tests to see if this driver supports creating a handle for the specified child device.\r
\r
- This function checks to see if the driver specified by This supports the device specified by \r
- ControllerHandle. Drivers will typically use the device path attached to \r
- ControllerHandle and/or the services from the bus I/O abstraction attached to \r
- ControllerHandle to determine if the driver supports ControllerHandle. This function \r
- may be called many times during platform initialization. In order to reduce boot times, the tests \r
- performed by this function must be very small, and take as little time as possible to execute. This \r
- function must not change the state of any hardware devices, and this function must be aware that the \r
- device specified by ControllerHandle may already be managed by the same driver or a \r
- different driver. This function must match its calls to AllocatePages() with FreePages(), \r
- AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). \r
- Because ControllerHandle may have been previously started by the same driver, if a protocol is \r
- already in the opened state, then it must not be closed with CloseProtocol(). This is required \r
+ This function checks to see if the driver specified by This supports the device specified by\r
+ ControllerHandle. Drivers will typically use the device path attached to\r
+ ControllerHandle and/or the services from the bus I/O abstraction attached to\r
+ ControllerHandle to determine if the driver supports ControllerHandle. This function\r
+ may be called many times during platform initialization. In order to reduce boot times, the tests\r
+ performed by this function must be very small, and take as little time as possible to execute. This\r
+ function must not change the state of any hardware devices, and this function must be aware that the\r
+ device specified by ControllerHandle may already be managed by the same driver or a\r
+ different driver. This function must match its calls to AllocatePages() with FreePages(),\r
+ AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().\r
+ Because ControllerHandle may have been previously started by the same driver, if a protocol is\r
+ already in the opened state, then it must not be closed with CloseProtocol(). This is required\r
to guarantee the state of ControllerHandle is not modified by this function.\r
\r
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle The handle of the controller to test. This handle \r
- must support a protocol interface that supplies \r
+ @param[in] ControllerHandle The handle of the controller to test. This handle\r
+ must support a protocol interface that supplies\r
an I/O abstraction to the driver.\r
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This \r
- parameter is ignored by device drivers, and is optional for bus \r
- drivers. For bus drivers, if this parameter is not NULL, then \r
- the bus driver must determine if the bus controller specified \r
- by ControllerHandle and the child controller specified \r
- by RemainingDevicePath are both supported by this \r
+ @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This\r
+ parameter is ignored by device drivers, and is optional for bus\r
+ drivers. For bus drivers, if this parameter is not NULL, then\r
+ the bus driver must determine if the bus controller specified\r
+ by ControllerHandle and the child controller specified\r
+ by RemainingDevicePath are both supported by this\r
bus driver.\r
\r
@retval EFI_SUCCESS The device specified by ControllerHandle and\r
Starts a device controller or a bus controller.\r
\r
The Start() function is designed to be invoked from the EFI boot service ConnectController().\r
- As a result, much of the error checking on the parameters to Start() has been moved into this \r
- common boot service. It is legal to call Start() from other locations, \r
+ As a result, much of the error checking on the parameters to Start() has been moved into this\r
+ common boot service. It is legal to call Start() from other locations,\r
but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
1. ControllerHandle must be a valid EFI_HANDLE.\r
2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
EFI_DEVICE_PATH_PROTOCOL.\r
3. Prior to calling Start(), the Supported() function for the driver specified by This must\r
- have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS. \r
+ have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.\r
\r
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle The handle of the controller to start. This handle \r
- must support a protocol interface that supplies \r
+ @param[in] ControllerHandle The handle of the controller to start. This handle\r
+ must support a protocol interface that supplies\r
an I/O abstraction to the driver.\r
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This \r
- parameter is ignored by device drivers, and is optional for bus \r
- drivers. For a bus driver, if this parameter is NULL, then handles \r
- for all the children of Controller are created by this driver. \r
- If this parameter is not NULL and the first Device Path Node is \r
- not the End of Device Path Node, then only the handle for the \r
- child device specified by the first Device Path Node of \r
+ @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This\r
+ parameter is ignored by device drivers, and is optional for bus\r
+ drivers. For a bus driver, if this parameter is NULL, then handles\r
+ for all the children of Controller are created by this driver.\r
+ If this parameter is not NULL and the first Device Path Node is\r
+ not the End of Device Path Node, then only the handle for the\r
+ child device specified by the first Device Path Node of\r
RemainingDevicePath is created by this driver.\r
- If the first Device Path Node of RemainingDevicePath is \r
+ If the first Device Path Node of RemainingDevicePath is\r
the End of Device Path Node, no child handle is created by this\r
driver.\r
\r
\r
Private = AllocateZeroPool (sizeof (EMU_SIMPLE_FILE_SYSTEM_PRIVATE));\r
if (Private == NULL) {\r
+ Status = EFI_OUT_OF_RESOURCES;\r
goto Done;\r
}\r
\r
Private->Signature = EMU_SIMPLE_FILE_SYSTEM_PRIVATE_SIGNATURE;\r
Private->IoThunk = EmuIoThunk;\r
Private->Io = EmuIoThunk->Interface;\r
- \r
+\r
Private->SimpleFileSystem.Revision = EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION;\r
Private->SimpleFileSystem.OpenVolume = EmuSimpleFileSystemOpenVolume;\r
\r
EmuIoThunk->ConfigString,\r
TRUE\r
);\r
- \r
+\r
AddUnicodeString2 (\r
"en",\r
gEmuSimpleFileSystemComponentName2.SupportedLanguages,\r
if (Private->ControllerNameTable != NULL) {\r
FreeUnicodeStringTable (Private->ControllerNameTable);\r
}\r
- \r
+\r
gBS->FreePool (Private);\r
- \r
+\r
}\r
\r
gBS->CloseProtocol (\r
\r
/**\r
Stops a device controller or a bus controller.\r
- \r
- The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). \r
- As a result, much of the error checking on the parameters to Stop() has been moved \r
- into this common boot service. It is legal to call Stop() from other locations, \r
+\r
+ The Stop() function is designed to be invoked from the EFI boot service DisconnectController().\r
+ As a result, much of the error checking on the parameters to Stop() has been moved\r
+ into this common boot service. It is legal to call Stop() from other locations,\r
but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
same driver's Start() function.\r
EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
Start() function, and the Start() function must have called OpenProtocol() on\r
ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r
- \r
+\r
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle A handle to the device being stopped. The handle must \r
- support a bus specific I/O protocol for the driver \r
+ @param[in] ControllerHandle A handle to the device being stopped. The handle must\r
+ support a bus specific I/O protocol for the driver\r
to use to stop the device.\r
@param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.\r
- @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL \r
+ @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL\r
if NumberOfChildren is 0.\r
\r
@retval EFI_SUCCESS The device was stopped.\r
/**\r
The user Entry Point for module EmuSimpleFileSystem. The user code starts with this function.\r
\r
- @param[in] ImageHandle The firmware allocated handle for the EFI image. \r
+ @param[in] ImageHandle The firmware allocated handle for the EFI image.\r
@param[in] SystemTable A pointer to the EFI System Table.\r
- \r
+\r
@retval EFI_SUCCESS The entry point is executed successfully.\r
@retval other Some error occurs when executing this entry point.\r
\r
projects / mirror_edk2.git / blobdiff