ArmPkg/CompilerIntrinsicsLib: Add uread, uwrite GCC assembly sources

[mirror_edk2.git] / Vlv2TbltDevicePkg / PlatformDxe / Observable / Observable.h

/*++\r
\r
  Copyright (c) 2004  - 2014, Intel Corporation. All rights reserved.<BR>\r
                                                                                   \r\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
                                                                                   \r\r
\r
Module Name:\r
\r
  Observable.h\r
\r
Abstract:\r
\r
  Prototypes for Observable protocol implementation\r
--*/\r
\r
#ifndef _OBSERVABLE_H_\r
#define _OBSERVABLE_H_\r
#include "PlatformDxe.h"\r
#include "Protocol/Observable.h"\r
\r
//\r
// Prototypes\r
//\r
\r
/** Install observable protocol.\r
 *\r
 * Install interface and initialize the observable protocol.\r
 *\r
 * @param   VOID          No parameters.\r
 *\r
 * @return  EFI_SUCCESS   Successfully installed and initialized the protocol.\r
 **/\r
EFI_STATUS\r
InitializeObservableProtocol(\r
  VOID\r
  );\r
\r
/** Remove all observables.\r
 *\r
 * Remove all observable guids and all interfaces subscribed to them.\r
 *\r
 * @param   VOID          No parameters.\r
 *\r
 * @return  EFI_SUCCESS   Successfully removed all observables and subscribed interfaces.\r
 **/\r
EFI_STATUS\r
EFIAPI\r
RemoveAllObservables(\r
  VOID\r
  );\r
\r
/** Subscribe an interface with an observable guid.\r
 *\r
 * Use this to register a callback function with a guid. The function provided by CallbackInterface will be executed\r
 * whenever the appropriate observable instance specified by ReferenceGuid calls Publish.\r
 *\r
 * @param   EFI_GUID              ReferenceGuid       The observable guid that the callback interface will subscribe to.\r
 *          OBS_CALLBACK          CallbackInterface   A pointer to the function that is subscribing to the observable.\r
 *\r
 * @return  EFI_SUCCESS           Successfully subscribed the interface to the observable guid.\r
 *          EFI_NOT_FOUND         No match could be found between the provided guid and existing observables.\r
 *          EFI_OUT_OF_RESOURCES  Could not subscribe to this observer due to resource limitations.\r
 *          EFI_INVALID_PARAMETER Interface is already subscribed to this observer.\r
 **/\r
EFI_STATUS\r
EFIAPI\r
Subscribe (\r
  IN      EFI_GUID        ReferenceGuid,\r
  IN      OBS_CALLBACK    CallbackInterface\r
  );\r
\r
/** Unsubscribe an interface with an observable guid.\r
 *\r
 * Use this to remove an interface from the callback list associated with an observable guid.\r
 *\r
 * @param   EFI_GUID              ReferenceGuid      The observable guid to unsubscribe the interface from.\r
 *          OBS_CALLBACK          CallbackInterface  A pointer to the interface that is being unsubscribed.\r
 *\r
 * @return  EFI_SUCCESS           Successfully unsubscribed the interface from the observable guid.\r
 **/\r
EFI_STATUS\r
EFIAPI\r
Unsubscribe (\r
  IN      EFI_GUID            ReferenceGuid,\r
  IN      OBS_CALLBACK    CallbackInterface\r
  );\r
\r
/** Notify observing functions.\r
 *\r
 * Use this to notify all functions who are subscribed to the guid specified by ReferenceGuid.\r
 *\r
 * @param   EFI_GUID          ReferenceGuid   The observable guid that contains the list of interfaces to be notified.\r
 *          VOID*             Data            Parameter context to be passed to the subscribed function.\r
 *\r
 * @return  EFI_SUCCESS       Successfully notified all observers listening to this guid.\r
 *          EFI_NOT_FOUND     No match could be found between the provided guid and existing observables.\r
 **/\r
EFI_STATUS\r
EFIAPI\r
Publish (\r
  IN      EFI_GUID        ReferenceGuid,\r
  IN  OUT VOID*           Data\r
  );\r
\r
/** Creates a new observable.\r
 *\r
 * Create a new observable that can be observed with the use of Subscribe function.\r
 *\r
 * @param   EFI_GUID              ReferenceGuid   The observable guid to add.\r
 *\r
 * @return  EFI_SUCCESS           Successfully added observable.\r
 *          EFI_INVALID_PARAMETER Observable already exists.\r
 **/\r
EFI_STATUS\r
EFIAPI\r
AddObservable (\r
  IN      EFI_GUID        ReferenceGuid\r
  );\r
\r
/** Remove an observable.\r
 *\r
 * Remove an observable so that it can no longer be subscribed to. In addition, unsubscribe any functions\r
 * that are subscribed to this guid.\r
 *\r
 * @param   EFI_GUID              ReferenceGuid   The observable guid to remove.\r
 *\r
 * @return  EFI_SUCCESS           Successfully removed observable.\r
 **/\r
EFI_STATUS\r
EFIAPI\r
RemoveObservable (\r
  IN      EFI_GUID        ReferenceGuid\r
  );\r
\r
#endif\r