Update the copyright notice format

[mirror_edk2.git] / UnixPkg / UnixThunkDxe / UnixThunk.c

/*++\r
\r
Copyright (c) 2006, 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
Module Name:\r
\r
  UnixThunk.c\r
\r
Abstract:\r
\r
  Produce UnixThunk protocol and it's associated device path and controller \r
  state protocols. UnixThunk is to the emulation environment as \r
  PCI_ROOT_BRIGE is to real hardware. The UnixBusDriver is the child of this\r
  driver.\r
\r
  Since we are a root hardware abstraction we do not install a Driver Binding\r
  protocol on this handle. This driver can only support one one UnixThunk protocol\r
  in the system, since the device path is hard coded.\r
\r
--*/\r
#include "PiDxe.h"\r
#include "UnixDxe.h"\r
#include "UnixThunk.h"\r
#include <Protocol/DevicePath.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UnixLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DevicePathLib.h>\r
\r
//\r
// WinNtThunk Device Path Protocol Instance\r
//\r
UNIX_THUNK_DEVICE_PATH mUnixThunkDevicePath = {\r
  {\r
    {\r
      HARDWARE_DEVICE_PATH,\r
      HW_VENDOR_DP,\r
      {\r
        (UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r
        (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
      }\r
    },\r
    EFI_UNIX_THUNK_PROTOCOL_GUID,\r
  },\r
  {\r
    END_DEVICE_PATH_TYPE,\r
    END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
    {\r
      END_DEVICE_PATH_LENGTH,\r
      0\r
    }\r
  }\r
};\r
\r
\r
EFI_STATUS\r
EFIAPI\r
InitializeUnixThunk (\r
  IN EFI_HANDLE                            ImageHandle,\r
  IN EFI_SYSTEM_TABLE                      *SystemTable\r
  )\r
/*++\r
\r
Routine Description:\r
  Install UnixThunk Protocol and it's associated Device Path protocol\r
\r
Arguments:\r
  (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)\r
\r
Returns:\r
  EFI_SUCEESS - UnixThunk protocol is added or error status from \r
                gBS->InstallMultiProtocolInterfaces().\r
\r
--*/\r
// TODO:    ImageHandle - add argument and description to function comment\r
// TODO:    SystemTable - add argument and description to function comment\r
{\r
  EFI_STATUS  Status;\r
  EFI_HANDLE  ControllerHandle;\r
\r
  ControllerHandle = NULL;\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &ControllerHandle,\r
                  &gEfiUnixThunkProtocolGuid,\r
                  gUnix,\r
                  &gEfiDevicePathProtocolGuid,\r
                  &mUnixThunkDevicePath,\r
                  NULL\r
                  );\r
\r
  return Status;\r
}\r