EmbeddedPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / EmbeddedPkg / Include / Library / RealTimeClockLib.h

/** @file\r
  Implement EFI RealTimeClock runtime services via Lib.\r
\r
  Currently this driver does not support runtime virtual calling.\r
\r
  Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __REAL_TIME_CLOCK_LIB__\r
#define __REAL_TIME_CLOCK_LIB__\r
\r
\r
/**\r
  Returns the current time and date information, and the time-keeping capabilities\r
  of the hardware platform.\r
\r
  @param  Time                  A pointer to storage to receive a snapshot of the current time.\r
  @param  Capabilities          An optional pointer to a buffer to receive the real time clock\r
                                device's capabilities.\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER Time is NULL.\r
  @retval EFI_DEVICE_ERROR      The time could not be retrieved due to hardware error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LibGetTime (\r
  OUT EFI_TIME                *Time,\r
  OUT  EFI_TIME_CAPABILITIES  *Capabilities\r
  );\r
\r
\r
/**\r
  Sets the current local time and date information.\r
\r
  @param  Time                  A pointer to the current time.\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER A time field is out of range.\r
  @retval EFI_DEVICE_ERROR      The time could not be set due due to hardware error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LibSetTime (\r
  IN EFI_TIME                *Time\r
  );\r
\r
\r
/**\r
  Returns the current wakeup alarm clock setting.\r
\r
  @param  Enabled               Indicates if the alarm is currently enabled or disabled.\r
  @param  Pending               Indicates if the alarm signal is pending and requires acknowledgement.\r
  @param  Time                  The current alarm setting.\r
\r
  @retval EFI_SUCCESS           The alarm settings were returned.\r
  @retval EFI_INVALID_PARAMETER Any parameter is NULL.\r
  @retval EFI_DEVICE_ERROR      The wakeup time could not be retrieved due to a hardware error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LibGetWakeupTime (\r
  OUT BOOLEAN     *Enabled,\r
  OUT BOOLEAN     *Pending,\r
  OUT EFI_TIME    *Time\r
  );\r
\r
\r
/**\r
  Sets the system wakeup alarm clock time.\r
\r
  @param  Enabled               Enable or disable the wakeup alarm.\r
  @param  Time                  If Enable is TRUE, the time to set the wakeup alarm for.\r
\r
  @retval EFI_SUCCESS           If Enable is TRUE, then the wakeup alarm was enabled. If\r
                                Enable is FALSE, then the wakeup alarm was disabled.\r
  @retval EFI_INVALID_PARAMETER A time field is out of range.\r
  @retval EFI_DEVICE_ERROR      The wakeup time could not be set due to a hardware error.\r
  @retval EFI_UNSUPPORTED       A wakeup timer is not supported on this platform.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LibSetWakeupTime (\r
  IN BOOLEAN      Enabled,\r
  OUT EFI_TIME    *Time\r
  );\r
\r
\r
\r
/**\r
  This is the declaration of an EFI image entry point. This can be the entry point to an application\r
  written to this specification, an EFI boot service driver, or an EFI runtime driver.\r
\r
  @param  ImageHandle           Handle that identifies the loaded image.\r
  @param  SystemTable           System Table for this image.\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LibRtcInitialize (\r
  IN EFI_HANDLE                            ImageHandle,\r
  IN EFI_SYSTEM_TABLE                      *SystemTable\r
  );\r
\r
\r
/**\r
  Fixup internal data so that EFI can be call in virtual mode.\r
  Call the passed in Child Notify event and convert any pointers in\r
  lib to virtual mode.\r
\r
  @param[in]    Event   The Event that is being processed\r
  @param[in]    Context Event Context\r
**/\r
VOID\r
EFIAPI\r
LibRtcVirtualNotifyEvent (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  );\r
\r
\r
#endif\r
\r