EmulatorPkg/EmuSimpleFileSystemDxe/EmuSimpleFileSystem.c

   1 /*++ @file
   2   Produce Simple File System abstractions for directories on your PC using Posix APIs.
   3   The configuration of what devices to mount or emulate comes from UNIX
   4   environment variables. The variables must be visible to the Microsoft*
   5   Developer Studio for them to work.
   6
   7 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
   8 Portions copyright (c) 2011, Apple Inc. All rights reserved.
   9 This program and the accompanying materials
  10 are licensed and made available under the terms and conditions of the BSD License
  11 which accompanies this distribution.  The full text of the license may be found at
  12 http://opensource.org/licenses/bsd-license.php
  13
  14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  16
  17 **/
  18
  19 #include "EmuSimpleFileSystem.h"
  20
  21
  22
  23
  24 /**
  25   Opens a new file relative to the source file's location.
  26
  27   @param  This       The protocol instance pointer.
  28   @param  NewHandle  Returns File Handle for FileName.
  29   @param  FileName   Null terminated string. "\", ".", and ".." are supported.
  30   @param  OpenMode   Open mode for file.
  31   @param  Attributes Only used for EFI_FILE_MODE_CREATE.
  32
  33   @retval EFI_SUCCESS          The device was opened.
  34   @retval EFI_NOT_FOUND        The specified file could not be found on the device.
  35   @retval EFI_NO_MEDIA         The device has no media.
  36   @retval EFI_MEDIA_CHANGED    The media has changed.
  37   @retval EFI_DEVICE_ERROR     The device reported an error.
  38   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
  39   @retval EFI_ACCESS_DENIED    The service denied access to the file.
  40   @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources.
  41   @retval EFI_VOLUME_FULL      The volume is full.
  42
  43 **/
  44 EFI_STATUS
  45 EFIAPI
  46 EmuSimpleFileSystemOpen (
  47   IN  EFI_FILE_PROTOCOL   *This,
  48   OUT EFI_FILE_PROTOCOL   **NewHandle,
  49   IN  CHAR16              *FileName,
  50   IN  UINT64              OpenMode,
  51   IN  UINT64              Attributes
  52   )
  53 {
  54   EMU_EFI_FILE_PRIVATE              *PrivateFile;
  55
  56   //
  57   // Check for obvious invalid parameters.
  58   //
  59   if (This == NULL || NewHandle == NULL || FileName == NULL) {
  60     return EFI_INVALID_PARAMETER;
  61   }
  62
  63   switch (OpenMode) {
  64   case EFI_FILE_MODE_CREATE | EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE:
  65     if (Attributes &~EFI_FILE_VALID_ATTR) {
  66       return EFI_INVALID_PARAMETER;
  67     }
  68
  69     if (Attributes & EFI_FILE_READ_ONLY) {
  70       return EFI_INVALID_PARAMETER;
  71     }
  72
  73   //
  74   // fall through
  75   //
  76   case EFI_FILE_MODE_READ:
  77   case EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE:
  78     break;
  79
  80   default:
  81     return EFI_INVALID_PARAMETER;
  82   }
  83
  84   PrivateFile     = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);
  85
  86   return PrivateFile->Io->Open (PrivateFile->Io, NewHandle, FileName, OpenMode, Attributes);
  87 }
  88
  89
  90
  91 /**
  92   Close the file handle
  93
  94   @param  This          Protocol instance pointer.
  95
  96   @retval EFI_SUCCESS   The file was closed.
  97
  98 **/
  99 EFI_STATUS
 100 EFIAPI
 101 EmuSimpleFileSystemClose (
 102   IN EFI_FILE_PROTOCOL  *This
 103   )
 104 {
 105   EFI_STATUS              Status;
 106   EMU_EFI_FILE_PRIVATE    *PrivateFile;
 107   EFI_TPL                 OldTpl;
 108
 109   if (This == NULL) {
 110     return EFI_INVALID_PARAMETER;
 111   }
 112
 113   PrivateFile = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);
 114
 115   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 116
 117   Status = PrivateFile->Io->Close (PrivateFile->Io);
 118   if (!EFI_ERROR (Status)) {
 119     gBS->FreePool (PrivateFile);
 120   }
 121
 122   gBS->RestoreTPL (OldTpl);
 123
 124   return Status;
 125 }
 126
 127
 128 /**
 129   Close and delete the file handle.
 130
 131   @param  This                     Protocol instance pointer.
 132
 133   @retval EFI_SUCCESS              The file was closed and deleted.
 134   @retval EFI_WARN_DELETE_FAILURE  The handle was closed but the file was not deleted.
 135
 136 **/
 137 EFI_STATUS
 138 EFIAPI
 139 EmuSimpleFileSystemDelete (
 140   IN EFI_FILE_PROTOCOL  *This
 141   )
 142 {
 143   EFI_STATUS              Status;
 144   EMU_EFI_FILE_PRIVATE    *PrivateFile;
 145   EFI_TPL                 OldTpl;
 146
 147   if (This == NULL) {
 148     return EFI_INVALID_PARAMETER;
 149   }
 150
 151   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 152
 153   PrivateFile = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);
 154
 155   Status = PrivateFile->Io->Delete (PrivateFile->Io);
 156   if (!EFI_ERROR (Status)) {
 157     gBS->FreePool (PrivateFile);
 158   }
 159
 160   gBS->RestoreTPL (OldTpl);
 161
 162   return Status;
 163 }
 164
 165
 166 /**
 167   Read data from the file.
 168
 169   @param  This       Protocol instance pointer.
 170   @param  BufferSize On input size of buffer, on output amount of data in buffer.
 171   @param  Buffer     The buffer in which data is read.
 172
 173   @retval EFI_SUCCESS          Data was read.
 174   @retval EFI_NO_MEDIA         The device has no media.
 175   @retval EFI_DEVICE_ERROR     The device reported an error.
 176   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
 177   @retval EFI_BUFFER_TO_SMALL  BufferSize is too small. BufferSize contains required size.
 178
 179 **/
 180 EFI_STATUS
 181 EFIAPI
 182 EmuSimpleFileSystemRead (
 183   IN     EFI_FILE_PROTOCOL  *This,
 184   IN OUT UINTN              *BufferSize,
 185   OUT    VOID               *Buffer
 186   )
 187 {
 188   EFI_STATUS              Status;
 189   EMU_EFI_FILE_PRIVATE    *PrivateFile;
 190   EFI_TPL                 OldTpl;
 191
 192   if (This == NULL || BufferSize == NULL) {
 193     return EFI_INVALID_PARAMETER;
 194   }
 195
 196   if ((*BufferSize != 0) && (Buffer == NULL)) {
 197     // Buffer can be NULL  if *BufferSize is zero
 198     return EFI_INVALID_PARAMETER;
 199   }
 200
 201   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 202
 203   PrivateFile = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);
 204
 205   Status = PrivateFile->Io->Read (PrivateFile->Io, BufferSize, Buffer);
 206
 207   gBS->RestoreTPL (OldTpl);
 208   return Status;
 209 }
 210
 211
 212 /**
 213   Write data to a file.
 214
 215   @param  This       Protocol instance pointer.
 216   @param  BufferSize On input size of buffer, on output amount of data in buffer.
 217   @param  Buffer     The buffer in which data to write.
 218
 219   @retval EFI_SUCCESS          Data was written.
 220   @retval EFI_UNSUPPORTED      Writes to Open directory are not supported.
 221   @retval EFI_NO_MEDIA         The device has no media.
 222   @retval EFI_DEVICE_ERROR     The device reported an error.
 223   @retval EFI_DEVICE_ERROR     An attempt was made to write to a deleted file.
 224   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
 225   @retval EFI_WRITE_PROTECTED  The device is write protected.
 226   @retval EFI_ACCESS_DENIED    The file was open for read only.
 227   @retval EFI_VOLUME_FULL      The volume is full.
 228
 229 **/
 230 EFI_STATUS
 231 EFIAPI
 232 EmuSimpleFileSystemWrite (
 233   IN     EFI_FILE_PROTOCOL  *This,
 234   IN OUT UINTN              *BufferSize,
 235   IN     VOID               *Buffer
 236   )
 237 {
 238   EFI_STATUS            Status;
 239   EMU_EFI_FILE_PRIVATE *PrivateFile;
 240   EFI_TPL               OldTpl;
 241
 242   if (This == NULL || BufferSize == NULL || Buffer == NULL) {
 243     return EFI_INVALID_PARAMETER;
 244   }
 245
 246   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 247
 248   PrivateFile = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);
 249
 250   Status = PrivateFile->Io->Write (PrivateFile->Io, BufferSize, Buffer);
 251
 252   gBS->RestoreTPL (OldTpl);
 253   return Status;
 254 }
 255
 256
 257 /**
 258   Get a file's current position
 259
 260   @param  This            Protocol instance pointer.
 261   @param  Position        Byte position from the start of the file.
 262
 263   @retval EFI_SUCCESS     Position was updated.
 264   @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.
 265
 266 **/
 267 EFI_STATUS
 268 EFIAPI
 269 EmuSimpleFileSystemGetPosition (
 270   IN  EFI_FILE_PROTOCOL   *This,
 271   OUT UINT64              *Position
 272   )
 273 {
 274   EFI_STATUS            Status;
 275   EMU_EFI_FILE_PRIVATE *PrivateFile;
 276   EFI_TPL               OldTpl;
 277
 278   if (This == NULL || Position == NULL) {
 279     return EFI_INVALID_PARAMETER;
 280   }
 281
 282   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 283
 284   PrivateFile   = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);
 285
 286   Status = PrivateFile->Io->GetPosition (PrivateFile->Io, Position);
 287
 288   gBS->RestoreTPL (OldTpl);
 289   return Status;
 290 }
 291
 292
 293
 294 /**
 295   Set file's current position
 296
 297   @param  This            Protocol instance pointer.
 298   @param  Position        Byte position from the start of the file.
 299
 300   @retval EFI_SUCCESS     Position was updated.
 301   @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open..
 302
 303 **/
 304 EFI_STATUS
 305 EFIAPI
 306 EmuSimpleFileSystemSetPosition (
 307   IN EFI_FILE_PROTOCOL  *This,
 308   IN UINT64             Position
 309   )
 310 {
 311   EFI_STATUS              Status;
 312   EMU_EFI_FILE_PRIVATE    *PrivateFile;
 313   EFI_TPL                 OldTpl;
 314
 315   if (This == NULL) {
 316     return EFI_INVALID_PARAMETER;
 317   }
 318
 319   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 320
 321   PrivateFile = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);
 322
 323   Status = PrivateFile->Io->SetPosition (PrivateFile->Io, Position);
 324
 325   gBS->RestoreTPL (OldTpl);
 326   return Status;
 327 }
 328
 329
 330 /**
 331   Get information about a file.
 332
 333   @param  This            Protocol instance pointer.
 334   @param  InformationType Type of information to return in Buffer.
 335   @param  BufferSize      On input size of buffer, on output amount of data in buffer.
 336   @param  Buffer          The buffer to return data.
 337
 338   @retval EFI_SUCCESS          Data was returned.
 339   @retval EFI_UNSUPPORTED      InformationType is not supported.
 340   @retval EFI_NO_MEDIA         The device has no media.
 341   @retval EFI_DEVICE_ERROR     The device reported an error.
 342   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
 343   @retval EFI_WRITE_PROTECTED  The device is write protected.
 344   @retval EFI_ACCESS_DENIED    The file was open for read only.
 345   @retval EFI_BUFFER_TOO_SMALL Buffer was too small; required size returned in BufferSize.
 346
 347 **/
 348 EFI_STATUS
 349 EFIAPI
 350 EmuSimpleFileSystemGetInfo (
 351   IN     EFI_FILE_PROTOCOL  *This,
 352   IN     EFI_GUID           *InformationType,
 353   IN OUT UINTN              *BufferSize,
 354   OUT    VOID               *Buffer
 355   )
 356 {
 357   EFI_STATUS                        Status;
 358   EMU_EFI_FILE_PRIVATE              *PrivateFile;
 359   EFI_TPL                           OldTpl;
 360
 361   if (This == NULL || InformationType == NULL || BufferSize == NULL) {
 362     return EFI_INVALID_PARAMETER;
 363   }
 364
 365   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 366
 367   PrivateFile = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);
 368
 369   Status = PrivateFile->Io->GetInfo (PrivateFile->Io, InformationType, BufferSize, Buffer);
 370
 371   gBS->RestoreTPL (OldTpl);
 372   return Status;
 373 }
 374
 375
 376 /**
 377   Set information about a file
 378
 379   @param  File            Protocol instance pointer.
 380   @param  InformationType Type of information in Buffer.
 381   @param  BufferSize      Size of buffer.
 382   @param  Buffer          The data to write.
 383
 384   @retval EFI_SUCCESS          Data was set.
 385   @retval EFI_UNSUPPORTED      InformationType is not supported.
 386   @retval EFI_NO_MEDIA         The device has no media.
 387   @retval EFI_DEVICE_ERROR     The device reported an error.
 388   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
 389   @retval EFI_WRITE_PROTECTED  The device is write protected.
 390   @retval EFI_ACCESS_DENIED    The file was open for read only.
 391
 392 **/
 393 EFI_STATUS
 394 EFIAPI
 395 EmuSimpleFileSystemSetInfo (
 396   IN EFI_FILE_PROTOCOL*This,
 397   IN EFI_GUID         *InformationType,
 398   IN UINTN            BufferSize,
 399   IN VOID             *Buffer
 400   )
 401 {
 402   EFI_STATUS                        Status;
 403   EMU_EFI_FILE_PRIVATE              *PrivateFile;
 404   EFI_TPL                           OldTpl;
 405
 406   //
 407   // Check for invalid parameters.
 408   //
 409   if (This == NULL || InformationType == NULL || BufferSize == 0 || Buffer == NULL) {
 410     return EFI_INVALID_PARAMETER;
 411   }
 412
 413   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 414
 415   PrivateFile               = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);
 416
 417   Status = PrivateFile->Io->SetInfo (PrivateFile->Io, InformationType, BufferSize, Buffer);
 418
 419   gBS->RestoreTPL (OldTpl);
 420   return Status;
 421 }
 422
 423
 424 /**
 425   Flush data back for the file handle.
 426
 427   @param  This Protocol instance pointer.
 428
 429   @retval EFI_SUCCESS          Data was flushed.
 430   @retval EFI_UNSUPPORTED      Writes to Open directory are not supported.
 431   @retval EFI_NO_MEDIA         The device has no media.
 432   @retval EFI_DEVICE_ERROR     The device reported an error.
 433   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
 434   @retval EFI_WRITE_PROTECTED  The device is write protected.
 435   @retval EFI_ACCESS_DENIED    The file was open for read only.
 436   @retval EFI_VOLUME_FULL      The volume is full.
 437
 438 **/
 439 EFI_STATUS
 440 EFIAPI
 441 EmuSimpleFileSystemFlush (
 442   IN EFI_FILE_PROTOCOL  *This
 443   )
 444 {
 445   EFI_STATUS                Status;
 446   EMU_EFI_FILE_PRIVATE      *PrivateFile;
 447   EFI_TPL                   OldTpl;
 448
 449   if (This == NULL) {
 450     return EFI_INVALID_PARAMETER;
 451   }
 452
 453   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 454
 455   PrivateFile = EMU_EFI_FILE_PRIVATE_DATA_FROM_THIS (This);
 456
 457   Status = PrivateFile->Io->Flush (PrivateFile->Io);
 458
 459   gBS->RestoreTPL (OldTpl);
 460   return Status;
 461 }
 462
 463
 464
 465 /**
 466   Open the root directory on a volume.
 467
 468   @param  This Protocol instance pointer.
 469   @param  Root Returns an Open file handle for the root directory
 470
 471   @retval EFI_SUCCESS          The device was opened.
 472   @retval EFI_UNSUPPORTED      This volume does not support the file system.
 473   @retval EFI_NO_MEDIA         The device has no media.
 474   @retval EFI_DEVICE_ERROR     The device reported an error.
 475   @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
 476   @retval EFI_ACCESS_DENIED    The service denied access to the file.
 477   @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources.
 478
 479 **/
 480 EFI_STATUS
 481 EFIAPI
 482 EmuSimpleFileSystemOpenVolume (
 483   IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL  *This,
 484   OUT EFI_FILE_PROTOCOL               **Root
 485   )
 486 {
 487   EFI_STATUS                        Status;
 488   EMU_SIMPLE_FILE_SYSTEM_PRIVATE    *Private;
 489   EMU_EFI_FILE_PRIVATE              *PrivateFile;
 490   EFI_TPL                           OldTpl;
 491
 492   Status = EFI_UNSUPPORTED;
 493
 494   if (This == NULL || Root == NULL) {
 495     return EFI_INVALID_PARAMETER;
 496   }
 497
 498   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 499
 500   Private = EMU_SIMPLE_FILE_SYSTEM_PRIVATE_DATA_FROM_THIS (This);
 501
 502   PrivateFile = AllocatePool (sizeof (EMU_EFI_FILE_PRIVATE));
 503   if (PrivateFile == NULL) {
 504     goto Done;
 505   }
 506
 507   PrivateFile->Signature            = EMU_EFI_FILE_PRIVATE_SIGNATURE;
 508   PrivateFile->IoThunk              = Private->IoThunk;
 509   PrivateFile->SimpleFileSystem     = This;
 510   PrivateFile->EfiFile.Revision     = EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION;
 511   PrivateFile->EfiFile.Open         = EmuSimpleFileSystemOpen;
 512   PrivateFile->EfiFile.Close        = EmuSimpleFileSystemClose;
 513   PrivateFile->EfiFile.Delete       = EmuSimpleFileSystemDelete;
 514   PrivateFile->EfiFile.Read         = EmuSimpleFileSystemRead;
 515   PrivateFile->EfiFile.Write        = EmuSimpleFileSystemWrite;
 516   PrivateFile->EfiFile.GetPosition  = EmuSimpleFileSystemGetPosition;
 517   PrivateFile->EfiFile.SetPosition  = EmuSimpleFileSystemSetPosition;
 518   PrivateFile->EfiFile.GetInfo      = EmuSimpleFileSystemGetInfo;
 519   PrivateFile->EfiFile.SetInfo      = EmuSimpleFileSystemSetInfo;
 520   PrivateFile->EfiFile.Flush        = EmuSimpleFileSystemFlush;
 521
 522   *Root = &PrivateFile->EfiFile;
 523
 524   Status = Private->Io->OpenVolume (Private->Io, &PrivateFile->Io);
 525   if (EFI_ERROR (Status)) {
 526     goto Done;
 527   }
 528
 529   AddUnicodeString2 (
 530     "eng",
 531     gEmuSimpleFileSystemComponentName.SupportedLanguages,
 532     &Private->ControllerNameTable,
 533     Private->IoThunk->ConfigString,
 534     TRUE
 535     );
 536
 537   AddUnicodeString2 (
 538     "en",
 539     gEmuSimpleFileSystemComponentName.SupportedLanguages,
 540     &Private->ControllerNameTable,
 541     Private->IoThunk->ConfigString,
 542     FALSE
 543     );
 544
 545
 546 Done:
 547   if (EFI_ERROR (Status)) {
 548     if (PrivateFile) {
 549       gBS->FreePool (PrivateFile);
 550     }
 551
 552     *Root = NULL;
 553   }
 554
 555   gBS->RestoreTPL (OldTpl);
 556
 557   return Status;
 558 }
 559
 560 /**
 561   Tests to see if this driver supports a given controller. If a child device is provided,
 562   it further tests to see if this driver supports creating a handle for the specified child device.
 563
 564   This function checks to see if the driver specified by This supports the device specified by
 565   ControllerHandle. Drivers will typically use the device path attached to
 566   ControllerHandle and/or the services from the bus I/O abstraction attached to
 567   ControllerHandle to determine if the driver supports ControllerHandle. This function
 568   may be called many times during platform initialization. In order to reduce boot times, the tests
 569   performed by this function must be very small, and take as little time as possible to execute. This
 570   function must not change the state of any hardware devices, and this function must be aware that the
 571   device specified by ControllerHandle may already be managed by the same driver or a
 572   different driver. This function must match its calls to AllocatePages() with FreePages(),
 573   AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().
 574   Because ControllerHandle may have been previously started by the same driver, if a protocol is
 575   already in the opened state, then it must not be closed with CloseProtocol(). This is required
 576   to guarantee the state of ControllerHandle is not modified by this function.
 577
 578   @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
 579   @param[in]  ControllerHandle     The handle of the controller to test. This handle
 580                                    must support a protocol interface that supplies
 581                                    an I/O abstraction to the driver.
 582   @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This
 583                                    parameter is ignored by device drivers, and is optional for bus
 584                                    drivers. For bus drivers, if this parameter is not NULL, then
 585                                    the bus driver must determine if the bus controller specified
 586                                    by ControllerHandle and the child controller specified
 587                                    by RemainingDevicePath are both supported by this
 588                                    bus driver.
 589
 590   @retval EFI_SUCCESS              The device specified by ControllerHandle and
 591                                    RemainingDevicePath is supported by the driver specified by This.
 592   @retval EFI_ALREADY_STARTED      The device specified by ControllerHandle and
 593                                    RemainingDevicePath is already being managed by the driver
 594                                    specified by This.
 595   @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and
 596                                    RemainingDevicePath is already being managed by a different
 597                                    driver or an application that requires exclusive access.
 598                                    Currently not implemented.
 599   @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and
 600                                    RemainingDevicePath is not supported by the driver specified by This.
 601 **/
 602 EFI_STATUS
 603 EFIAPI
 604 EmuSimpleFileSystemDriverBindingSupported (
 605   IN  EFI_DRIVER_BINDING_PROTOCOL  *This,
 606   IN  EFI_HANDLE                   ControllerHandle,
 607   IN  EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
 608   )
 609 {
 610   EFI_STATUS              Status;
 611   EMU_IO_THUNK_PROTOCOL  *EmuIoThunk;
 612
 613   //
 614   // Open the IO Abstraction(s) needed to perform the supported test
 615   //
 616   Status = gBS->OpenProtocol (
 617                   ControllerHandle,
 618                   &gEmuIoThunkProtocolGuid,
 619                   (VOID **)&EmuIoThunk,
 620                   This->DriverBindingHandle,
 621                   ControllerHandle,
 622                   EFI_OPEN_PROTOCOL_BY_DRIVER
 623                   );
 624   if (EFI_ERROR (Status)) {
 625     return Status;
 626   }
 627
 628   //
 629   // Make sure GUID is for a File System handle.
 630   //
 631   Status = EFI_UNSUPPORTED;
 632   if (CompareGuid (EmuIoThunk->Protocol, &gEfiSimpleFileSystemProtocolGuid)) {
 633     Status = EFI_SUCCESS;
 634   }
 635
 636   //
 637   // Close the I/O Abstraction(s) used to perform the supported test
 638   //
 639   gBS->CloseProtocol (
 640         ControllerHandle,
 641         &gEmuIoThunkProtocolGuid,
 642         This->DriverBindingHandle,
 643         ControllerHandle
 644         );
 645
 646   return Status;
 647 }
 648
 649
 650
 651 /**
 652   Starts a device controller or a bus controller.
 653
 654   The Start() function is designed to be invoked from the EFI boot service ConnectController().
 655   As a result, much of the error checking on the parameters to Start() has been moved into this
 656   common boot service. It is legal to call Start() from other locations,
 657   but the following calling restrictions must be followed, or the system behavior will not be deterministic.
 658   1. ControllerHandle must be a valid EFI_HANDLE.
 659   2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
 660      EFI_DEVICE_PATH_PROTOCOL.
 661   3. Prior to calling Start(), the Supported() function for the driver specified by This must
 662      have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.
 663
 664   @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
 665   @param[in]  ControllerHandle     The handle of the controller to start. This handle
 666                                    must support a protocol interface that supplies
 667                                    an I/O abstraction to the driver.
 668   @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This
 669                                    parameter is ignored by device drivers, and is optional for bus
 670                                    drivers. For a bus driver, if this parameter is NULL, then handles
 671                                    for all the children of Controller are created by this driver.
 672                                    If this parameter is not NULL and the first Device Path Node is
 673                                    not the End of Device Path Node, then only the handle for the
 674                                    child device specified by the first Device Path Node of
 675                                    RemainingDevicePath is created by this driver.
 676                                    If the first Device Path Node of RemainingDevicePath is
 677                                    the End of Device Path Node, no child handle is created by this
 678                                    driver.
 679
 680   @retval EFI_SUCCESS              The device was started.
 681   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.
 682   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.
 683   @retval Others                   The driver failded to start the device.
 684
 685 **/
 686 EFI_STATUS
 687 EFIAPI
 688 EmuSimpleFileSystemDriverBindingStart (
 689   IN  EFI_DRIVER_BINDING_PROTOCOL   *This,
 690   IN  EFI_HANDLE                    ControllerHandle,
 691   IN  EFI_DEVICE_PATH_PROTOCOL      *RemainingDevicePath
 692   )
 693 {
 694   EFI_STATUS                        Status;
 695   EMU_IO_THUNK_PROTOCOL             *EmuIoThunk;
 696   EMU_SIMPLE_FILE_SYSTEM_PRIVATE    *Private;
 697
 698   Private = NULL;
 699
 700   //
 701   // Open the IO Abstraction(s) needed
 702   //
 703   Status = gBS->OpenProtocol (
 704                   ControllerHandle,
 705                   &gEmuIoThunkProtocolGuid,
 706                   (VOID **)&EmuIoThunk,
 707                   This->DriverBindingHandle,
 708                   ControllerHandle,
 709                   EFI_OPEN_PROTOCOL_BY_DRIVER
 710                   );
 711   if (EFI_ERROR (Status)) {
 712     return Status;
 713   }
 714
 715   //
 716   // Validate GUID
 717   //
 718   if (!CompareGuid (EmuIoThunk->Protocol, &gEfiSimpleFileSystemProtocolGuid)) {
 719     Status = EFI_UNSUPPORTED;
 720     goto Done;
 721   }
 722
 723   Private = AllocateZeroPool (sizeof (EMU_SIMPLE_FILE_SYSTEM_PRIVATE));
 724   if (Private == NULL) {
 725     goto Done;
 726   }
 727
 728   Status = EmuIoThunk->Open (EmuIoThunk);
 729   if (EFI_ERROR (Status)) {
 730     goto Done;
 731   }
 732
 733   Private->Signature = EMU_SIMPLE_FILE_SYSTEM_PRIVATE_SIGNATURE;
 734   Private->IoThunk   = EmuIoThunk;
 735   Private->Io        = EmuIoThunk->Interface;
 736
 737   Private->SimpleFileSystem.Revision    = EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION;
 738   Private->SimpleFileSystem.OpenVolume  = EmuSimpleFileSystemOpenVolume;
 739
 740   Private->ControllerNameTable = NULL;
 741
 742   AddUnicodeString2 (
 743     "eng",
 744     gEmuSimpleFileSystemComponentName.SupportedLanguages,
 745     &Private->ControllerNameTable,
 746     EmuIoThunk->ConfigString,
 747     TRUE
 748     );
 749
 750   AddUnicodeString2 (
 751     "en",
 752     gEmuSimpleFileSystemComponentName2.SupportedLanguages,
 753     &Private->ControllerNameTable,
 754     EmuIoThunk->ConfigString,
 755     FALSE
 756     );
 757
 758   Status = gBS->InstallMultipleProtocolInterfaces (
 759                   &ControllerHandle,
 760                   &gEfiSimpleFileSystemProtocolGuid,  &Private->SimpleFileSystem,
 761                   NULL
 762                   );
 763
 764 Done:
 765   if (EFI_ERROR (Status)) {
 766     if (Private != NULL) {
 767       if (Private->ControllerNameTable != NULL) {
 768         FreeUnicodeStringTable (Private->ControllerNameTable);
 769       }
 770
 771       gBS->FreePool (Private);
 772
 773     }
 774
 775     gBS->CloseProtocol (
 776           ControllerHandle,
 777           &gEmuIoThunkProtocolGuid,
 778           This->DriverBindingHandle,
 779           ControllerHandle
 780           );
 781   }
 782
 783   return Status;
 784 }
 785
 786
 787 /**
 788   Stops a device controller or a bus controller.
 789
 790   The Stop() function is designed to be invoked from the EFI boot service DisconnectController().
 791   As a result, much of the error checking on the parameters to Stop() has been moved
 792   into this common boot service. It is legal to call Stop() from other locations,
 793   but the following calling restrictions must be followed, or the system behavior will not be deterministic.
 794   1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this
 795      same driver's Start() function.
 796   2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid
 797      EFI_HANDLE. In addition, all of these handles must have been created in this driver's
 798      Start() function, and the Start() function must have called OpenProtocol() on
 799      ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
 800
 801   @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
 802   @param[in]  ControllerHandle  A handle to the device being stopped. The handle must
 803                                 support a bus specific I/O protocol for the driver
 804                                 to use to stop the device.
 805   @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.
 806   @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL
 807                                 if NumberOfChildren is 0.
 808
 809   @retval EFI_SUCCESS           The device was stopped.
 810   @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.
 811
 812 **/
 813 EFI_STATUS
 814 EFIAPI
 815 EmuSimpleFileSystemDriverBindingStop (
 816   IN  EFI_DRIVER_BINDING_PROTOCOL  *This,
 817   IN  EFI_HANDLE                   ControllerHandle,
 818   IN  UINTN                        NumberOfChildren,
 819   IN  EFI_HANDLE                   *ChildHandleBuffer
 820   )
 821 {
 822   EFI_STATUS                        Status;
 823   EFI_SIMPLE_FILE_SYSTEM_PROTOCOL   *SimpleFileSystem;
 824   EMU_SIMPLE_FILE_SYSTEM_PRIVATE    *Private;
 825
 826   //
 827   // Get our context back
 828   //
 829   Status = gBS->OpenProtocol (
 830                   ControllerHandle,
 831                   &gEfiSimpleFileSystemProtocolGuid,
 832                   (VOID **)&SimpleFileSystem,
 833                   This->DriverBindingHandle,
 834                   ControllerHandle,
 835                   EFI_OPEN_PROTOCOL_GET_PROTOCOL
 836                   );
 837   if (EFI_ERROR (Status)) {
 838     return EFI_UNSUPPORTED;
 839   }
 840
 841   Private = EMU_SIMPLE_FILE_SYSTEM_PRIVATE_DATA_FROM_THIS (SimpleFileSystem);
 842   Status = Private->IoThunk->Close (Private->IoThunk);
 843
 844   //
 845   // Uninstall the Simple File System Protocol from ControllerHandle
 846   //
 847   Status = gBS->UninstallMultipleProtocolInterfaces (
 848                   ControllerHandle,
 849                   &gEfiSimpleFileSystemProtocolGuid,  &Private->SimpleFileSystem,
 850                   NULL
 851                   );
 852   if (!EFI_ERROR (Status)) {
 853     Status = gBS->CloseProtocol (
 854                     ControllerHandle,
 855                     &gEmuIoThunkProtocolGuid,
 856                     This->DriverBindingHandle,
 857                     ControllerHandle
 858                     );
 859   }
 860
 861   if (!EFI_ERROR (Status)) {
 862     //
 863     // Free our instance data
 864     //
 865     FreeUnicodeStringTable (Private->ControllerNameTable);
 866     gBS->FreePool (Private);
 867   }
 868
 869   return Status;
 870 }
 871
 872
 873 EFI_DRIVER_BINDING_PROTOCOL gEmuSimpleFileSystemDriverBinding = {
 874   EmuSimpleFileSystemDriverBindingSupported,
 875   EmuSimpleFileSystemDriverBindingStart,
 876   EmuSimpleFileSystemDriverBindingStop,
 877   0xa,
 878   NULL,
 879   NULL
 880 };
 881
 882
 883
 884
 885 /**
 886   The user Entry Point for module EmuSimpleFileSystem. The user code starts with this function.
 887
 888   @param[in] ImageHandle    The firmware allocated handle for the EFI image.
 889   @param[in] SystemTable    A pointer to the EFI System Table.
 890
 891   @retval EFI_SUCCESS       The entry point is executed successfully.
 892   @retval other             Some error occurs when executing this entry point.
 893
 894 **/
 895 EFI_STATUS
 896 EFIAPI
 897 InitializeEmuSimpleFileSystem(
 898   IN EFI_HANDLE           ImageHandle,
 899   IN EFI_SYSTEM_TABLE     *SystemTable
 900   )
 901 {
 902   EFI_STATUS              Status;
 903
 904   Status = EfiLibInstallDriverBindingComponentName2 (
 905              ImageHandle,
 906              SystemTable,
 907              &gEmuSimpleFileSystemDriverBinding,
 908              ImageHandle,
 909              &gEmuSimpleFileSystemComponentName,
 910              &gEmuSimpleFileSystemComponentName2
 911              );
 912   ASSERT_EFI_ERROR (Status);
 913
 914   return Status;
 915 }